GZIP V2

Discover more about the GZIP V2 component and how to use it on the Digibee Integration Platform.

GZIP V2 zips a JSON or a text as a string in base64 or file. The component also compresses and decompresses files in gzip format. This version of the component supports Double Braces.

Parameters

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

Parameter	Description	Default value	Data type
Operation	Action to be executed by the component (Compress Fields, Compress Payload, Compress File, Decompress Fields, Decompress Payload, and Decompress File).	Compress Fields	String
JSON Fields	JSON path to be compressed or decompressed, considering the fields must be separated by a comma (e.g., field1, field2).	body.test	String
Preserve Original	If activated, the option preserves the original fields that have a prefix with an underline.	False	Boolean
Binary Content	This option is valid only for the Compress Fields and Compress Payload operations. If activated, the option makes the data to be treated as binary, and a base64 string is expected.	False	Boolean
Payload	This field is valid only for the Compress Payload and Decompress Payload operations and declares what will be compressed/decompressed in the request.	N/A	String
Result As File	This field is valid only for the Compress Payload and Decompress Payload operations. If activated, the option will save the result of the compression or decompression in a file.	False	Boolean
File Name (DB)	Name of the file or full file path (i.e. tmp/processed/file.txt) of the file to be compressed.	N/A	String
GZIP File Name (DB)	Name of the file or full file path (i.e. tmp/processed/file.txt) of the file in gzip format.	N/A	String
Fail On Error	If the option is activated, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Messages flow

Input

For the Compress Fields and Decompress Fields operations, the component is expected to receive a JSON with the fields configured in the JSON Fields property.

Example

With the following configurations:

JSON Fields = field1,field2

The expected JSON must at least have:

{
"field1": "SOMETHING",
"field2": "SOMETHING"
}

For the Compress Payload and Decompress Payload operations, you must configure the Payload field to make the compression/decompression.

Example

With the following configurations:

Payload = {{ message.field1 }}

The JSON must have this value:

{
"field1": "SOMETHING"
}

For the Compress File and Decompress File operations, you must configure the file to be compressed/decompressed and the resulting file of this operation.

Example

File Name = file.csv
GZIP File Name = file.gzip

Output

For the Compress Fields and Decompress Fields operations, the input message is preserved.

For the Compress Payload and Decompress Payload operations, if the output is a file:

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

For the Compress Payload and Decompress Payload operations, if the output is a string:

{
"success": "true",
"result": "SOMETHING COMPRESSED/DECOMPRESSED"
}

For the Compress File and Decompress File operations:

{
"success": "true",
"fileName": "file.csv",
"gzipFileName": "file.csv"
}