ZIP File V2

Discover more about the ZIP File V2 connector and how to use it on the Digibee Integration Platform.

ZIP File V2 compresses files into .zip format, optionally reducing their size.

Parameters

Take a look at the configuration parameters for the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
ZIP Operation	Define the type of operation (Compress, Multiple Compress, or Decompress).	Compress	String
Compression Method	The compression method to be used. Options are: Store: Doesn’t compress the file. Recommended for files that are already compressed or don’t require compression. Faster processing. Deflate: Compresses the file. Suitable for most data types, especially text and files with repeated patterns. Slower processing.	Store	String
ZIP Encryption Method	The ZIP encryption method to be used. Options are: Zip Standard: Basic encryption method compatible with most ZIP tools. Offers lower security. AES: Advanced Encryption Standard. Provides stronger security but may not be supported by all ZIP tools.	Zip Standard	String
ZIP AES Key Strength	Defines the strength of the encryption key when using AES as ZIP Encryption Method. Options are: Key Strength 128 and Key Strength 256.	Key Strength 128	String
File Name (DB)	Name or full path of the file to be compressed (for example, tmp/processed/file.txt). In the Multiple Compress operation, this field is also available when you click Add in the Files parameter.	data.csv	String
Output File Name (DB)	Name of the ZIP file to be generated.	data.zip	String
Fail On Error	If enabled, interrupts the pipeline execution when an error occurs. If disabled, execution continues, but the "success" property will be set to false.	False	Boolean

Advanced tab

Parameter	Description	Default value	Data type
Set password	When enabled, will set a password protection to the ZIP file.	False	Boolean
Account	The account used by the connector. It is only available if the Use Dynamic Account parameter is inactive.	N/A	Account
Use Dynamic Account	When active, the connector will use the account dynamically. Otherwise, it will use the account statically.	False	Boolean
Scoped	When enabled the stored account is isolated to other sub-process. In that case, sub-processes will see their own version of the stored account data. It's not supported for accounts used in headers or body. It is only available if the Use Dynamic Account parameter is active.	False	Boolean
Account Name	The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Use Dynamic Account parameter is active.	N/A	String

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Optional field to describe the connector configuration and any relevant business rules.	N/A	String

Messages flow

Input

The connector accepts any entry message, which can be referenced using Double Braces ({{ }}).

Output

On success:

{
    "fileName": "data.csv",
    "success": true
}

On error:

{
    "success": false,
    "message": "File data.csv already exists.",
    "exception": "com.digibee.pipelineengine.exception.PipelineEngineRuntimeException"
}

ZIP File V2 in action

Successful response

{
    "success": true,
    "outputFileName": "data.zip"
}

• outputFileName: Name of the generated ZIP file.

• success: true if the operation was successful; otherwise, false.

Error response

{
    "exception": "java.io.FileNotFoundException: /tmp/pipeline-engine/3b3755ad-4256-429a-8898-2f7eea80f7db/data1.csv (No such file or directory)",
    "message": "Encountered an I/O error while executing ZipFileConnector",
    "success": false
}

• success: false when the operation fails.

• message: Description of the error.

• exception: Technical details about the error.

File handling in the pipeline

The pipeline uses a temporary, local workspace for file operations, which is isolated and only accessible during execution.

This means file access works like a virtual file system. File names may include valid characters, extensions, and relative paths, such as:

• data.csv

• processing/data.csv

Any attempt to access absolute paths is blocked during pipeline execution.