Creating and Updating Variables and Variable Groups
Variables store values that activities read at runtime, so a setting that changes between environments lives in one place rather than in every activity that uses it. Variables are organized into groups, which keep related values together and can be exported and imported as a unit.
Create a variable group
- Open the application you want to create variables for.
- Select the Variables icon to open the Variables side panel.
- Select the + icon, then select Create Group.
- Enter a descriptive name for the group and press
Enter.
Group names must be unique, must not be empty, and must start with an alphabetic character.
Add a variable to a group
- Select the variable group you want to add to.
- Select Add Variable. A new row appears in the list.
- Select the Scope icon and choose where the variable applies.
- Select the type control and choose the variable's type. The default is Text.
- Enter a descriptive name in the Name field, such as
userAgeororderTotal. - Enter the variable's value in the Value field.
Changes save automatically as you work. A message reads Changes saved. once they are stored.
Variable scope
| Scope | Where the value applies |
|---|---|
| Application | Available to everyone with access to the application, and referenced by workflows inside it. |
| Deployment | Available during deployment and to workflows triggered afterward. |
| Client | Managed securely by authorized client team members. Workflows reference the variable without exposing its details. |
Data types
| Type | Holds |
|---|---|
| Text | A string value. |
| Number | A decimal number. |
| Integer | A whole number. |
| Boolean | True or False. |
| Secret | A sensitive value. Use Secure with Vault to store it in a vault rather than in plain text. |
For a Secret variable, Secure with Vault stores the value in a vault and shows it as Vault Stored. The Vault Key is the name of the secret as it is stored in the vault; the Secret is the name your application uses to reference it. Vaults are configured in Secret Manager.
To reorder variables, drag the handle at the left of each row.
How you know it worked
The variable appears in the group with its value, and a message reads Changes saved..
When it does not work
| Message | Cause |
|---|---|
| Name must not be empty | The variable has no name. |
| Name must be unique | Another variable in the group uses this name. |
| Name must start with an alphabetic character | The name begins with a number or symbol. |
| Default value must not be empty | The variable has no value. |
| Default value must be a number | The value does not match the Number type. |
| Default value must be a boolean | The value does not match the Boolean type. |
| Failed to make changes to the variable group. | The change could not be saved. Retry, and contact your workspace administrator if it persists. |
Next steps
Read the variable from a workflow. See Using Variables in Activities, and Best Practices for Managing Variables for naming and scoping guidance.