Variables are used to store data which can then be used within the workflow for decision-making, informational display, or use within a script. Variables by nature are changeable, and are a core concept of all programming languages, and “code-less” configuration.
Throughout the lifecycle of a workflow, the values stored in the variable can be set, modified, queried, and used in scripts and other workflow objects.
Types of variables
Workflow variables are available in the following data types:
- Number: A number variable is useful for counting and storing number values. Values can either be positive or negative whole numbers
- String: A string variable is used for storing text values. String variables can contain multi-line text
- Date: A date variable is used for storing date values
- Entity: A dual-state variable that stores data about an entity eg. Client, Asset or Site
To create a variable, ensure that the Variables dockable panel is displayed. This is located on the right of the workflow designer. This panel can be “pinned” to stay open and visible.
- Click Add to create a new variable.
- Select from either a number, or a string type variable.
- Give the variable a meaningful name
Renaming and Deleting Variables
Once a variable has been created, it can be renamed, or deleted. Use the options on the dockable variables panel to perform these functions.
Assigning values to variables
Once a variable has been created, you can assign a value to it by a number of different ways, including:
- Explicitly setting the variable to a specific value when it is created, or via a workflow step.
- Prompting the user to input a value
- Running a script (SQL or Powershell) to set the value
- Set the variable from an existing value in a Control Set field
Working with Variables
When a variable is clicked on in the workflow panel, all workflow objects that use that variable will highlight in a different colour. This makes it easy to see which objects are using that variable. Conversely, clicking on a workflow object that contains a variable will highlight the variable in the workflow panel.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.