Replacement variables
Introduction
Variables can be defined for an environment and then referenced throughout your process flow, using an environment variable syntax.
Environment variable syntax
Environment variables are referenced using the following syntax:
{{environment.variables.your_variable_name}}
For example:
{{environment.variables.region}}
Where can I reference environment variables?
Environment variables can be referenced throughout process flows - anywhere that you can reference flow variables, you can reference environment variables too.
Defining environment variables
To define an environment variable, follow the steps below.
Edit the configuration for the required virtual environment
If you're not already editing the configuration for your virtual environment, access it now.
Create a new variable
Click the create
button:

Configure the variable
Configure variable settings and click the create
button to confirm:

Options on this page are summarised below:
Name
The name (i.e. the key) to be used when referencing this variable.
Type
Select the expected data type for resolved variable values.
Value
If required, set a default value for this variable.
Fallback
Enter a value to be used if the variable cannot be resolved.
Is this variable a secret?
Toggle this option on
if values entered for this field are sensitive. Secret variables are encrypted. Note that environment variables are never displayed in the dashboard, irrespective of whether or not they are marked as secret.
Last updated