Skip to end of metadata
Go to start of metadata

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.

Creating a Gzip Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the Gzip connection block to display activities that are available to be used with a Gzip connection:

Gzip activities

To create an activity that can be configured, drag a Gzip Compress activity from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a Gzip Compress Activity

Follow these steps to configure a Gzip Compress activity:

Step 1: Enter a Name

Gzip Compress Activity Configuration Step 1

  • 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

Gzip Compress Activity Configuration Step 2

  • 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/NodeDescription
      requestsOne or more requests
      contentString of uncompressed and unencoded data
    • Response:

      Response Schema Field/NodeDescription
      responseZero or more responses, one for each request
      CompressedDataBase64-encoded string of Gzip-compressed data
  • Refresh: Click the refresh icon 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:

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:

Gzip Compress operation

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.

On This Page

Last updated:  Dec 02, 2020

  • No labels