Gzip Compress Activity¶
Introduction¶
A Gzip Compress activity compresses a string of content into a Base64-encoded string of Gzip-compressed data in a Gzip endpoint and is intended to be used as a target to consume data in an operation. After configuring a Gzip connection, you can configure as many Gzip activities as you like for each Gzip connection.
Create a Gzip Activity¶
An instance of an activity is created from a connection using an activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.
An existing activity can be edited from these locations:
- The design canvas (see Component Actions Menu in Design Canvas).
- The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
Configure a Gzip Compress Activity¶
Follow these steps to configure a Gzip Compress activity:
Step 1: Enter a Name¶
-
Name: Enter a name to use to identify the Gzip Compress activity. The name must be unique for each Gzip Compress activity and must not contain forward slashes (
/) or colons (:). -
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Review the Data Schemas¶
-
Data Schema: The request and response data schemas for Gzip are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.
-
Request:
Request Schema Field/Node Description requests One or more requests content String of uncompressed and unencoded data -
Response:
Response Schema Field/Node Description response Zero or more responses, one for each request CompressedData Base64-encoded string of Gzip-compressed data
-
-
Refresh: Click the refresh icon
or the word Refresh to regenerate schemas from the Gzip endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation. -
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Finished: Click to save the configuration for all steps and close the activity configuration.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Next Steps¶
After configuring a Gzip Compress activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.
After a Gzip activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.
Gzip Compress activities can be used as a target with these operation patterns:
- Transformation Pattern
- Two-transformation Pattern (as the first or second target)
Other patterns are not valid using Gzip Compress activities. See the validation patterns on the Operation Validity page.
A typical use case is to use a Gzip Compress activity in the Two-transformation Pattern. In this example, the first transformation (Gzip Compress Request) creates a request structure that is passed to the Gzip Compress activity. The second transformation (Gzip Compress Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Gzip Compress Response) and a message is then logged by the Write to Operation Log script:
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.