Variables

A variable lets you pass dynamic values into a component's properties, without you needing to manually edit a property each time the pipeline runs.

For example, you could define a variable "table_name", and set the Create Table component to use this variable for its New Table Name property. Each time you run the pipeline containing "table_name", you can set a new value for the variable, allowing you to re-use the same pipeline multiple times to create tables with different names, without editing the component's properties. Another advantage to variables would be if you have multiple components in a pipeline that all reference the same table. To reference a different table, you only need to change the value of the variable in one place, rather than edit the properties of each separate component.

Variables can also be accessed and set or re-set through Python scripts, giving you great flexibility in designing pipelines that are configured dynamically at runtime.

There are two classes of variable: pipeline variables and project variables. These are created, managed, and used in exactly the same way, and any mention of "variable" in this article should be understood to apply equally to both types, unless explicitly stated otherwise. Each type has a different scope, however, as defined in the following section on Variable scope.

Variable scope

The scope of a project variable is the entire project in which it is created. That is, any pipeline in any branch of the current project can use the same variable. A project variable can be given a different default value in different project environments.

The scope of a pipeline variable is the single pipeline in which it is created. No other pipeline in the project will be able to see the variable, though an identically named variable could be created in other pipelines.

A pipeline variable can be given the same name as a project variable. Where this happens, only the pipeline variable will be used within that specific pipeline, not the project variable. For avoidance of confusion, we recommend that you don't use the same names for different variables.

Using variables

Variables can be used to provide property values in many components. The documentation for each component will tell you whether it supports the use of variables in properties.

To use a variable in a string property, type the name of the variable surrounded by { } brackets and prefixed by the dollar symbol, as follows: ${variable}.

For example, if you have defined a variable called "table_name", which will specify the name of a new table to be created by the Create Table component in your pipeline, you will enter ${table_name} for the component's New Table Name property.

To use a variable in a property with a drop-down list of options, the drop-down will include all currently defined variables for you to choose from.

When a pipeline run begins, all of its variables are initialized with the default value that was specified when the variable was created. Variable values can be assigned or reassigned dynamically while the pipeline runs, typically through the use of Python scripts. Values set in this way are valid only for the current run of the pipeline, and for the next run of the pipeline the variable will revert to its default value, or a new value must be assigned.

Creating variables

Open a pipeline on the Designer pipeline canvas.
Click the Manage variable icon, (x), on the control box in the top-right of the canvas. The Manage your variables dialog will open, listing all pipeline and project variables available to the current pipeline. In this dialog, you can edit or delete any existing variables, or create a new variable.
Click Create variable to open the Create a variable dialog.
Select either Project variable or Pipeline variable.
Complete the following fields, and then click Create:
- Variable name: Each variable must have a unique name within its scope. For example, each pipeline variable must be uniquely named in this pipeline, though a variable with the same name can be defined in a different pipeline. A pipeline variable can have the same name as a project variable. Variable names can include letters, digits, and underscores, but can't begin with a digit. For example, my_table_02 and _02_my_table are valid names, but 02_my_table is not. A variable name must not be a JavaScript reserved word (e.g. var or const). If you want to use the variable in a Python or Bash script, it must not have the same name as a reserved word in those scripts.
- Description: A description to inform other users of the purpose of the variable. This is optional, but its use is recommended.
- Type: Select either Text or Number. See Variable type, below, for an explanation of variable typing.
- Visibility: Only used for pipeline variables. Select Public or Private. See Variable visibility, below, for an explanation of variable visibility.
- Default value: Only used for pipeline variables. The value initially assigned to a pipeline variable when a pipeline runs. The variable's value can be re-set by components as the pipeline runs, but it will always begin each new pipeline run with its default value.
- Environment default override: Only used for project variables. The value initially assigned to a project variable when a pipeline runs. The variable's value can be re-set by components as the pipeline runs, but it will always begin each new pipeline run with its default value. This value can different for each different environment in the project.

Variable type

The Type assigned to a variable determines what kind of information it contains. Variables can have one of the following types:

Type	Description
Text	Any text string.
Number	Any integer, with or without decimals.

It is important that the variable type matches the data type of the property you want to use the variable in. For example, the New Table Name property is type string, so it requires a Text variable type. Timeout is type integer, so it requires a Numeric variable type.

Note that while the value of a Text variable might contain digits, for example 1234, its type is still Text, and so it can't be used where a Numeric type is required.

Variable visibility

Setting the correct visibility for a pipeline variable is important when you want to call a pipeline from another pipeline, using the Run Orchestration or Run Transformation components.

A Private pipeline variable is only visible to the pipeline it is defined in. If the pipeline is called from another pipeline, the calling pipeline can't "see" the Private variable and so can't use its value, reset its value, or otherwise interact with it in any way.

A Public pipeline variable is visible outside the pipeline it is defined in, so it can be "seen" and used by any pipeline that calls the pipeline where it is set.

This only applies to pipeline variables. Project variables are automatically visible to every pipeline within the project.

Using variables in scripts

Python scripts

Variables are visible to Python scripts created in the Python Script component, and in those scripts they will act as any other Python variable. For example, to show the value of a pipeline variable myVar you can use the following Python command:

print (myVar)

From the Python script, you can use Python's context object to assign a new value to the variable. For example:

context.updateVariable ('myVar', 'a_new_value')

This new value for the variable will now be used in all subsequent components as the pipeline continues to run. This gives you a powerful tool for creating complex yet flexible pipelines, as some very simple Python scripts can dynamically change the behavior of the pipeline at runtime by manipulating variable values.

Note that you can manipulate the variable in any desired way within the Python script, but the value of the variable within the pipeline itself won't change unless you pass it back with the context object.

Warning

Python will allow you to change the type of a variable, for example by assigning a string to a variable that previously held an integer. When you intend to pass the variable back to the pipeline using the context object, you must take care that you do not change the variable type in your Python script. Doing so will have consequences in your pipeline and will likely cause it to fail.

A full discussion of Python scripting is beyond the scope of this article. Please refer to any good Python reference for further information.

Bash scripts

Variables are visible to Bash scripts created in the Bash Script component. Variables are read-only in Bash scripts; their values can't be updated and passed back to the pipeline.

To use a variable in a Bash script, prefix the variable name with $, as follows:

echo $myVar

Passing variables between pipelines

Variables can be used to pass values between pipelines when you call one pipeline from another using the Run Orchestration and Run Transformation components.

To pass variable values between pipelines, you need to create a pipeline variable in the "parent" pipeline with its visibility set to Public. This allows the variable to be seen by any "child" pipeline that is called by the parent.

The child pipeline will use the value of the variable at the point the Run Orchestration/Transformation component is run. This may be the variable's default value, or it may be a value that has been set by a previous component (such as a Python Script) in the parent pipeline.

You can reset the value of the variable when it's passed to the child by using the Set Scalar Variables property of the Run Orchestration/Transformation component. You can also dynamically reset the value through a component running in the child pipeline. When assigning a new value to a variable passed from parent to child, ensure that the new value is of the correct type.