Start

The Start block is created by default for all new workflows. It determines the basic functioning of each workflow.

This block contains the definitions of the user and system variables that your workflow needs to function. You can create user variables, update system variables, and assign variables to and use them in other workflow blocks.

User variables

The result variable is created by default. You can assign values directly to this variable, for example, by using the Assign block. The value of result is shown in the workflow log when you run the workflow.

To add and define more variables for your workflow, click + Add variable.

All user variables have a name and a default value. Default values must be contained in quotations.

Variables must also have a type, such as Array, Object, Enum (for expression variables), or Authentication.

Use Authentication when you want to authenticate to external services and pass those authentications as variables between workflows blocks. When you use this type, you choose the specific providers that you want to authenticate with. In the dialog, click Use authentication type to confirm your choices or click Use any authentication type to use any provider.

The following four additional values can be set for all user variables:
  • Input: Click this field to allow the variable's value to be set when the workflow is run.
  • Required: Click this field to ensure that the input variable must have a value before the workflow runs.
  • Output: Click this field to include the variable in the workflow's results.
  • Show in logs: Click this field to store and display the variable's value in the workflow execution logs.

To delete a variable, click the trash icon.

To change the variable order, move them up and down by using the chevrons. To reposition a variable, hover over a variable row and drag the variable to your chosen position.

You can create and edit certain variables in a separate JSON editor window. For example, when you choose enum as the variable type, the edit icon becomes visible. Click the icon and create or update JSON definitions. For example, you might define this three-element array of string values: {"type": "string", "enum": ["apple","orange","pear"]}.

After you save your updates, you can make one array value the default value for the variable. For example, you might set the variable's default value to "orange".

If you try to set a default value that does not exist in the array, an error is shown. For example, if you try to set "pineapple" as the default value, this message is shown: Argument of type '"pineapple"' is not assignable to parameter of type '$<enum_variable_name>'.

When you choose the custom variable type, the JSON editor opens automatically.

Note: The editor supports the ECMAScript 2020 (ES2020) version of JavaScript™. For more information about the supported capabilities of this JavaScript release, see ECMAScript® 2020 Language Specification.
Use the Scope field to specify whether the variable's value is visible at a local, intermediate, or global level. A variable's value is not visible beyond its defined scope. For more information, see the following table and diagram.
Table 1. Variable scopes
Scope Function
Flow

The variable is local for each task. Any change to the local variable is reflected upon all subsequently linked tasks.

Example: Two child blocks of A1 - A2 and A2. In each of them, the X variable changes its value independently from 1 to 2.

Thread

The variable is common for one active process. Two simultaneously active processes have different variables but all parallel tasks within one process have one and the same shared variable.

Example: Two parallel processes (A1, A2, A3 on the start side and A1, A2, A3 on the end side) where the Y variable goes from 1 through 2 to 3.

Worker

The variable is common within the system. Currently, it's visible on a worker level but the variables will be synchronized between workers. Any change from anywhere is reflected on all other active or future processes.

Example: A change in the value of the variable Z somewhere in the flow is taken into account by the next block that makes a new change of its value.

The Z variable goes from 1 to 6.


redundant

Worker group and MET

In the Group field, you can choose which worker group you want to execute and observe the state of the workflow.

Use the MET field to indicate how you want to calculate the manual execution time, that is, the time saved in minutes by running the workflow instead of completing the tasks manually. Click the Auto checkbox to disable automatic MET calculation, then input a manual time in minutes. This value is used to simplify reports on the return on investments (ROI) calculation for your instance.

System variables

Expand the System variables tab to define headers and body variables. Select the Enable checkbox to apply the values in the current workflow. When enabled, the variables appear in the System variables section.