Variables
Define data sources and create a simple configuration with reusable values. Create the variables, and add and enable your dynamic variables to your reusable logic tools.
How to access this feature
Access a list of variables anytime by typing @. This command brings up a list of available variables. You can also click on the @ on the Canvas controls toolbar.
Usage example
Let's say that you have created a reusable logic tool and named it My RL Tool . You added a variable definition called MyFilterText, with Text type, and with a default value of ABC.
Within the My RL Tool, you have a Filter tool. The Filter tool can use a variable associated with the MyFilterText variable as a filter criterion in its configuration.
In your pipe, in the My RL Tool configuration, you can set a value for the MyFilterText:
When Reusable Logic tools expand during calculations, the inner element configurations using variables will receive their associated values assigned to the configuration for the calculation. If the example pipe was built, when My RL Tool gets expanded, the Filter tool will have the MyFilterText variable replaced by the defined value of NewVal. If the user did not define a value in the My RL Tool configuration, the default value of ABC would be used instead.
Creating variables
Simplify your workflow by creating a variable to reuse.
Go to the Pipes module from the side navigation bar.
From the Pipes tab, click an existing pipe to open, or create a new pipe. To create a new pipe, read the Creating a pipe documentation.
In the Pipe builder create a reusable tool with a tool that can use variables.
Open the reusable tool.
Click Open variables
on the Canvas controls tool bar, located in the lower right-hand side of the canvas.Click + Add variable.
In the New variable configuration pane, enter a name for the variable.
Note
The name must be unique and cannot contain spaces.
Under Type, choose the variable type:
Text
Number
Boolean
Date
Drop-down list
Column
Calendar
Under Default Value, enter the value, such as the default string or value.
Under Description, enter the description for how to use the variable in your tool set, and then click Save.
Editing variables
Revise your variables as you need.
Go to the Pipes module from the side navigation bar.
From the Pipes tab, click an existing pipe to open, or create a new pipe. To create a new pipe, read the Creating a pipe documentation.
In your Pipe builder, open the Variables pane.
Search for the variable that you want to update.
Click More options
and then click Edit.Update the variable, and then click Save.
Deleting variables
Delete any variables that you no longer require.
Note
You can restore deleted variables if you revert your reusable tool to a previous version.
Go to the Pipes module from the side navigation bar.
From the Pipes tab, click an existing pipe to open, or create a new pipe. To create a new pipe, read the Creating a pipe documentation.
In your Pipe builder, open the Variables pane and then search for the variable that you want to delete.
Click More options
.Click Delete. The Delete modal appears, informing you that the variable will be deleted immediately.
Click Delete again to finish the deletion.