/
Variables

Variables

Owned by Thomas Staiger
Last updated: Dec 16, 2016

Variables are used to store and retrieve data which may be used globally and/or on multiple positions in a Workflow at the same time. There are two types of Variables:

Variable TypeDescription
Project VariableThis type of Variable can be accessed globally by all Workflows of your Project. Project Variables are defined and modified using the Variables tab in the → Project Panel.
Local VariableThis type of Variable can only be accessed locally inside of a Workflow. Other Workflows cannot access them. They are especially useful if you need to transmit data over long distances and they help avoid drawing Cables which may clutter up the structure of your Workflow.

Variables can contribute much to a well structured Workflow and reduce the usage of Cables. At the same time, overusing them can obfuscate a Workflow. Properly annotate your Workflows when making extensive use of Variables!

Project Variables

  • Project Variables are defined in the Variables tab in the → Project Panel and require at least a name and a data type.
  • The content (or value) of a Variable is initially empty, 0 or false and can either be defined in the Variables tab or via a Variable Setter Unit. 
  • Variable Units are color coded regarding the Unit background, Output/Input Port, and the connections from and to the Port.

Project Variable Getter

  • This Unit is used to get the content of a Project Variable, that means its Output Port provides the content you set for that specific Variable in the Variables tab.
  • When changing the name of the Variable in the Variables tab, the Getter's name is also updated automatically.

Project Variable Setter

  • This Unit is used to set the content of a Project Variable, that means the content of the Variable defined in the Variables tab will be changed accordingly when data is transmitted to the Input Port of this Unit.

Project Variables can be used globally in certain Units (JavaScript, Shell Command). To get the content of a Variable, enclose its name in '$', for example "$myVariable$".

Local Variables

  • Local Variables are created with Units which you can find in the Library (see → Project Panel).

Local Variable Setter

  • This Unit is used to define and set a Local Variable.
  • You need to set a Type and a unique Variable Name.
  • After defining the Variable Name, a new Value Port will appear which can be used to set the Variable content.

Local Variable Getter

  • This Unit is used to retrieve a local Variable.
  • After defining the Variable Name, a new Value Port will appear which can be used to retrieve the Variable content.

When there are multiple instances of a Local Variable Setter with the same name, changing the type on one of them will change the type of all other Setters (with the same name).

Variable Types

Refer to the chapter → Data Types & Color Coding.

Related content