Workflow Variables

Workflow Variables are used to store values within a workflow process

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. 

Throughout the lifecycle of a workflow, the values stored in the variable can be modified, queried, and used in scripts and other workflow objects.

Use

Types of variables

Workflow variables are currently limited to the following types:

  • Number.  A number variable is useful for counting.  Values can either be positive or negative whole numbers
  • String.  A string variable is used for storing text values.  String variables can up to 255 characters in length
  • Date.  A date variables is used for storing date values
  • Entity.  A dual-state variable that stores data about an entity eg.  a Client. 

Creating Variables

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.

  1. Click Add to create a new variable. 
  2. Select from either a number, or a string type variable. 
  3. Give the variable a meaningful name

Create a workflow variable

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.

Assiging values to variables

Once a variable has been created, you can assign a value to it by a number of different ways, including:

  1. Explicitly setting the variable to a specific value
  2. Prompting the user to input a value
  3. Running a script (SQL or Powershell) to set the value

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.

See Also

Set / Modify a variable

Set a variable based on user input

Database scripting with SQL that include variables

Branch workflow based on the value of a variable

Workflow Objects