GZIP V1 (Deprecated)

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

The GZIP V1 component is deprecated and no longer updated. Please refer to the document with the most recent version of the feature: GZIP V2.

GZIP V1 zips an entire JSON object as a string.

Parameters

Take a look at the configuration parameters of the component:

ParameterDescriptionDefault valueData type

Operation

Compress and decompress.

N/A

String

JSON Field

JSON path to be zipped.

N/A

String

Preserve Original

If activated, the option preserves original fields that have a prefix with an underscore.

False

Boolean

Binary Content

If activated, the option makes the data to be treated as binary, and base64 is expected.

False

Boolean

Fail On Error

If the option is enabled, 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

Supports any structure, but only if the element to be compressed is specified.

Output

Preserves the input message, with JSON object compressed in the base64 format.

Example:

The steps inside Retry component are executed 3 times until they're successful - "true" should appear in the message:

"start": [
{
"type": "connector",
"name": "gzip-connector",
"stepName": "test-compress",
"params": {
"operation" : "compress",
"failOnError": false,
"jsonField": "body.test",
"preserveOriginal" : false,
"isBinary" : false
}
}
]

Last updated