Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

A Variable connection is configured using the Variable connector, establishing access to either a project variable or an in-memory global variable. Once a connection is established, you can configure one or more Variable activities associated with that connection to be used either as a source to provide data to an operation or as a target to consume data in an operation.

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

Creating or Editing a Variable Connection

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

To configure a new Variable connection, use the Show dropdown to filter on Connectors, and then click the Variable connector block:

To configure an existing Variable connection, use the Show dropdown to filter on Endpoints, and then double-click the Variable connection block:

These open the configuration screen for the Variable connection, covered next.

Configuring a Variable Connection

Configuration of a Variable connection includes these fields:

  • Endpoint Name: Enter a name to use to identify the Variable connection. The name must be unique for each Variable connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Variable endpoint, which refers to both a specific connection and its activities.

  • Variable Name: Enter the name you want to use for a new in-memory global variable, or enter an existing global variable or project variable name. To see a list of existing global and project variables, begin either by typing an open square bracket [ into the field or by clicking the variable icon  to display a list of the existing variables to choose from.

    Variable names can be composed of these characters: letters (a-z, A-Z), numbers (0-9), periods, and underscores. Other characters are not recommended and may cause issues. It is a good idea to use periods or underscores to prefix variables so that they are easy to look up later. For example, a variable named org.account.filename is first prefixed with org, then account, etc. to effectively organize it in a list among other variables. However, note that for variables that might be used in JavaScript later, it is recommended to use underscores instead of periods. Further information is provided in Global Variables and Project Variables.

  • Save Changes: Click to save and close the connection configuration. If editing an existing Variable connection to use a different Variable Name, a confirmation message asks you to choose if the variable name should be updated on all instances where it is used throughout the project:

    • Yes: Click to modify the name of the variable that the endpoint accesses and also change any other usages of that variable in the project.

    • No: Click to modify the name of the variable that the endpoint accesses and leave any other usages of that variable in the project unchanged.

    • Cancel: Click for no changes to be made and to return to the Variable connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps

After configuring a Variable connection, you can configure one or more Variable activities associated with that connection to be used either as a source (to provide data within an operation) or as a target
target (to consume data within an operation).

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:

For more information, see these activities:

  • Read: Reads data from a Variable endpoint and is intended to be used as a source in an operation.
  • Write: Writes data to a Variable endpoint and is intended to be used as a target in an operation.
Panel
borderColor#65379B
titleColor#FFFFFF
titleBGColor#65379B
titleOn This Page
Table of Content Zone

Table of Contents
maxLevel3
minLevel2

Panel
borderColor#FF7C4C
titleColor#FFFFFF
titleBGColor#FF7C4C
titleRelated Articles
Panel
borderColor#00B886
titleColor#FFFFFF
titleBGColor#00B886
titleRelated Topics

HideElements
metastrue

Last updated: 

Lastmodifieddate