Zip Connector

Version 21.0.7964

Zip Connector

Version 21.0.7964

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


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


Settings related to the core operation of the connector.

  • Connector Id The static name of the connector. All connector-specific files are held in a folder by the same name within the Data Directory.
  • Connector Description An optional field to provide free-form description of the connector and its role in the flow.
  • Operation Whether the connector is compressing or decompressing incoming files. Attempting to decompress files that are not compressed in a supported format will result in an error.

Archive Options

Settings related to the archive being processed or created.

  • Archive Format The expected format of the input archive (when decompressing), and the format of the archive that will be created (when compressing).
  • Overwrite Whether output files should overwrite pre-existing files of the same name.
  • Compression Method The specific algorithm to use when compressing.
  • Compression Level The level of compression to apply when compressing.


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

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


Settings related to the automatic processing of files by the connector.

  • Send Whether messages arriving at the connector will automatically be 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, and will result in an error if this setting is enabled: Bzip, Gzip, Zcompress.
  • Send Interval The interval at which to compress all available input files into the same archive, if Scheduled Send is enabled.

Advanced Tab

Local Folders

Settings that determine the folder on disk that files will be processed from, and where they will be placed after processing.

  • Input Folder (Send) The connector can process files placed in this folder. If Send Automation is enabled, the connector will automatically poll this location for files to process.
  • Output Folder (Receive) After the connector finishes processing a file, the result will be placed in this folder. If the connector is connected to another connector in the flow, files will not remain here and will instead be passed along to the Input/Send folder for the connected connector.
  • Processed Folder (Sent) After processing a file, the connector will place a copy of the processed file in this folder if Save to Sent Folder is enabled. This copy of the file will not be passed along to the next connector in the flow.


Settings related to the allocation of resources to the connector.

  • Max Workers The maximum number of worker threads that will be consumed from the threadpool to process files on this connector. If set, overrides the default setting from the Profile tab.
  • Max Files The maximum number of files that will be processed by the connector each time worker threads are assigned to the connector. If set, overrides the default setting from the Profile tab.

Other Settings

Settings not included in the previous categories.

  • Send Filter A glob pattern filter that determines which files in the Send directory should be processed by the connector. Patterns will exclude matching files if the pattern is preceded by a minus sign:
    Multiple patterns can be specified, comma-delimited, with later filters taking priority.
  • Extract To Folder The folder where the connector should place files extracted from an archive.
  • Local File Scheme A filemask for determining local file names as they are downloaded by the connector. The following macros may be used to reference contextual information:
    %ConnectorId%, %Filename%, %FilenameNoExt%, %Ext%, %ShortDate%, %LongDate%, %RegexFilename:%, %DateFormat:%.
    As an example: %FilenameNoExt%_%ShortDate%%Ext%
  • Log Subfolder Scheme By default, logs for transactions processed by the connector will be stored in the Logs subfolder for the connector. For connectors that process many transactions, it may be desirable to further divide the logs based on the datetime they were generated. When this setting is set to Daily, logs generated on the same day will be grouped in a subfolder;; when this setting is set to Weekly, logs generated in the same week will be grouped in a subfolder; and so on.
  • Log Messages Whether the log entry for a processed file will include a copy of the file itself.
  • Save to Sent Folder Whether files processed by the connector should be copied to the Sent folder for the connector.


Settings for specific use cases.

  • Other Settings Allows configuration of hidden connector settings in a semicolon-separated list, like setting1=value1;setting2=value2. Normal connector use cases and functionality should not require use of these settings.