Skip to end of metadata
Go to start of metadata

Introduction

A Variable Write activity writes data to a Variable endpoint and is intended to be used as a target to consume data in an operation. After configuring a Variable connection, you can configure as many Variable activities as you like for each Variable connection.

For more information on using variables in scripts, transformations, and connection/activity configuration screens, see Variables.

Creating a Variable Activity

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

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

To create an activity that can be configured, drag the activity block 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 Variable Write Activity

Follow these steps to configure a Variable Write activity:

Step 1: Enter a Name and Provide a Request Schema

  • Name: Enter a name to use to identify the Variable Write activity. The name must be unique for each Variable Write activity and must not contain forward slashes (/) or colons (:).
  • Provide Request Schema: The request schema defines the structure of data that is used by the Variable Write activity. Whether a request schema is required depends on if the activity is used as the target of a transformation (see When to Use a Schema). For instructions on completing this section of activity configuration, refer to Schemas Defined in an Activity.

  • 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: If provided during activity configuration, the request data schema is 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. You can also define schemas directly in a transformation.

  • Add Plugin(s): Plugins are Jitterbit- or user-provided applications that extend Harmony's native capabilities. To apply a plugin to the activity, click to expand this section and select the checkbox next to the plugin to be used. For additional instructions on using plugins, including details on setting any required variables used by the plugin, see Plugins Added to an Activity.

  • 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 Variable Write 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.

Once a Variable 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.

Variable Write activities can be used as a target with these operation patterns:

Other patterns are not valid using Variable Write activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a Variable Write activity in the Transformation Pattern. In this example, the FTP Read activity (Read Request) provides data to the operation which is then received by the transformation (FTP to Variable). The Variable Write activity (Write Response) is used as a target, receiving data within the operation:

For an additional example, see Completing the Operation in HTTP Activities for an example of an operation chain used to retrieve a REST token and write that response to a global variable, then read from the global variable to use the token in a downstream 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.

  • No labels