A variable connection is configured using the variable connector to establish 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 use as a source or target within an operation.
For more information on using variables in scripts, transformations, and connection/activity configuration screens, see Variables.
Creating or Editing a Variable Connection
To configure a new variable connection, within the Connectors filter, click the variable connector block:
To configure an existing variable connection, within the Endpoints filter, double-click the variable connection block:
This will open a 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 (
:). As a specific connection and its activities are referred to as an endpoint, this name is also used to identify the variable endpoint.
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 typing an open square bracket
[into the field or click the variable icon to display 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 can be 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.filenameis first prefixed with
Save Changes: Click this button to save and close the connection configuration. If editing an existing variable connection to use a different Variable Name, a confirmation message will ask you to choose if the variable name should be updated on all instances where it is used throughout the project:
Yes: Click the Yes button 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 the No button 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 Cancel 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 Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.
- Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal).
After configuring a variable connection, you can configure one or more variable read or write activities associated with that connection to use as a source or target within an operation. For more information, see these activities:
Last updated: Sep 23, 2019
- No labels