Variables
With variables, you can enter a value once and reuse it within the process without maintaining it in multiple places. Imagine you want to use the same centrally maintained value (e.g. a url or a responsible person) in an email and in a document. Instead of entering the value in both places, you define it once as a variable and reference it there. Each execution of the process (each running process) continues to use the value the process currently holds via the variable.
Variables Panel
You can open the variables panel in the process designer using the following button in the top toolbar:
The panel then opens, where you can manage the variables of the process.
Add a variable
To add a variable, proceed as follows:
- Click Add variable in the variables panel.
- Enter a Name for the variable. The name must be unique within the process and later serves as the label of the placeholder.
- Select the Data type the variable accepts. The following options are available:
- Text
- Number
- Person
- Date
- File
- Table
- Enter a Value that is assigned to the variable when the process starts. The value is entered according to the selected data type (e.g. via a date picker or the people picker). No default values can be maintained for the data type File.
- Confirm using Confirm to apply the variables. Using the delete icon at the end of a row (), you can remove a variable again.
A new variable is only available as a placeholder after saving the process.
Table Variables
With a table variable, you can manage a larger amount of related data as a table with named columns in a single process variable. Each entry (row) in the table consists of the values for the defined columns.
When you select the data type Table for a variable, the variables panel is extended in the value area with the Table columns:
- Click Add column.
- Enter a display name for the column. The display name later serves as the label of the column's placeholder.
- Select the Data type of the column. The following options are available:
- Text
- Number
- Person
- Date
- File
- Repeat these steps for additional columns. You can delete a defined column using the delete icon at the end of the column row.
If at least one column is defined, you can use the Edit default values button to maintain default values for the table. In the Table default values editor, you insert rows using Add row, enter the respective value for each column, and delete rows using the delete icon at the end of the row. When the process starts, the variable receives these default rows as its value.
To process entries in the table, the four Table Variable actions are available:
- Insert table variable entry: Inserts a new entry at the end of the table.
- Delete table variable entries: Deletes entries that fulfill the filter from the table.
- Update table variable entries: Updates the configured column values of entries that fulfill the filter.
- Load table variable entries: Loads entries according to the filter and makes their column values available as placeholders.
When one of these actions is executed, the value of the respective process instance is changed - the columns in the process definition remain unchanged.
You can also reference the column values of a table variable directly as placeholders: In the placeholder selection, you find each defined column in the group Process Variable under the name of the variable. The placeholder resolves the current values of the column for all rows; multiple values are separated by a comma. A table variable can additionally be processed as a loop: Inside the loop, the column placeholders resolve the value of the respective current row.
Reference variables
Within the process, you reference a variable as a placeholder. In the placeholder selection, you find the variables of the process in the group Process Variable under the name of the respective variable. When the process is executed, the placeholder is replaced by the current value of the variable.
Set variable value
You can change the value of a variable during the course of the process. For this purpose, the action Set variables value is available. When this action is executed, the value of the respective process instance is set to the new value - the variable in the process definition remains unchanged.
Display values in dashboards
Variable values that are filled or changed during the course of the process can also be displayed in dashboards. There, you reference the variable via the same placeholder and display the current value of the process.