Zip Connector

The Zip connector supports automatic compression and decompression of archives in various formats.

Key Capabilities

File compression and extraction with support for multiple archive formats (7zip, Bzip2, Gzip, and Tar)
Password protection and encryption capabilities for secure archives
Scheduled Send functionality to combine multiple files into single archives
Configurable compression methods and levels for optimized file sizes and processing speed

Overview

Zip connectors automatically compress or decompress incoming files depending on the Operation setting of the connector. In Compress mode, each file is zipped independently, so the number of output Zip archives is equal to the number of input files. In Decompress mode, all files are extracted from input archives and output as an individual file; folder structure is ignored. Zip connectors can be configured to compress and decompress archives in a variety of formats, including 7zip, Bzip2, Gzip, and Tar.

Connector Configuration

This section contains all of the configurable connector properties.

Settings Tab

Configuration

Settings related to the core operation of the connector.

Setting	Description
Connector Id	The static, unique identifier for the connector.
Connector Type	Displays the connector name and a description of what it does.
Connector Description	An optional field to provide a free-form description of the connector and its role in the flow.
Operation	Whether the connector is compressing or decompressing incoming files. Trying to decompress files that are not compressed in a supported format results in an error.

Archive Options

Settings related to the archive being processed or created.

Setting	Description
Archive Format	The expected format of the input archive (when decompressing), or the format of the archive that is created (when compressing).
Compression Method	The specific algorithm to use when compressing.
Compression Level	The level of compression to apply when compressing. Higher values allow better compression; lower values allow faster compression. A value of 0 stores the file without compression.

Encryption

Settings related to encrypting archives during compression, if allowed by the archive format.

Setting	Description
Encryption Algorithm	The algorithm to use when encrypting.
Password	The password required to decrypt the archive.

Advanced Tab

Advanced Settings

Settings not included in the previous categories.

Setting	Description
Extract To Folder	The folder where the connector should place files extracted from an archive.
Local File Scheme	A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros.

Logging

Other Settings

Setting	Description
Processing Delay	The amount of time (in seconds) by which the processing of files placed in the Transactions tab is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting.

Miscellaneous

Automation Tab

Automation Settings

Settings related to the automatic processing of files by the connector. By default, the Enable automation checkbox is checked. If you uncheck it, you cannot use the other automation settings.

Setting	Description
Send	Whether messages arriving at the connector are automatically processed.
Scheduled Send	Whether to process incoming messages at a scheduled interval. This allows multiple files to accumulate in the input folder, then all be zipped together in the same archive. Note: The following archive formats do not support compressing multiple files: Bzip, Gzip, and Zcompress. An error is generated if this setting is enabled on those archive formats.
Send Interval	The interval at which to compress all available input files into the same archive. Only available if Scheduled Send is enabled.
Minutes Past the Hour	The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly.
Time	The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly.
Day	The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly.
Minutes	The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute.
Cron Expression	A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced.

Performance

Alerts Tab

SLAs Tab

Subfolder Headers

The Zip connector makes use of the Subfolder header for reading from and writing to compressed files. A Subfolder header is added any time there are subfolders in the zip structure.

When compressing files, the Subfolder header is only used when you set Scheduled Send on the Automation tab.

For example, this image from the Message Details page for a log entry shows the path to the subfolder in the Other Headers section.

When decompressing a file:

The message for each file that is in a subfolder in the compressed file contains a Subfolder header in its metadata.
This header displays the path to the subfolder in the zip folder structure.
This subfolder header is supported by other connectors that support a subfolder header in Send operations.

When compressing files, the connector looks for a Subfolder header on messages that it processes to determine where to place the files inside the compressed structure.

Getting Started

Flows

EDI Trading Partner Management Console

Connectors

Mapping

APIs and Automation

How-To Guides

Scripting

Software License and Third-Party Copyrights

Key Capabilities

Overview

Connector Configuration

Settings Tab

Configuration

Archive Options

Encryption

Advanced Tab

Advanced Settings

Logging

Other Settings

Miscellaneous

Automation Tab

Automation Settings

Performance

Alerts Tab

SLAs Tab

Subfolder Headers

Macros

Examples

​Key Capabilities

​Overview

​Connector Configuration

​Settings Tab

​Configuration

​Archive Options

​Encryption

​Advanced Tab

​Advanced Settings

​Logging

​Other Settings

​Miscellaneous

​Automation Tab

​Automation Settings

​Performance

​Alerts Tab

​SLAs Tab

​Subfolder Headers

​Macros

​Examples

Key Capabilities

Overview

Connector Configuration

Settings Tab

Configuration

Archive Options

Encryption

Advanced Tab

Advanced Settings

Logging

Other Settings

Miscellaneous

Automation Tab

Automation Settings

Performance

Alerts Tab

SLAs Tab

Subfolder Headers

Macros

Examples