Flow variables


If your process flow includes a connection shape that's configured for an endpoint where a variable can be entered, you'll probably be used to entering a static value to be applied for that step - for example:

You might also be familiar with obtaining variable values dynamically, from a payload. However, flow variables provide another level of flexibility.

Flow variables provide the ability to define variables at the process flow level, and then reference these values throughout the entire process flow. You set a flow variable once, and it is applied throughout the entire process flow, wherever it is referenced.

When flow variables are modified - either manually or via a script - those updates are applied anywhere in the process flow where they are referenced, automatically.

You can also reference flow variables in custom scripts (which means you can manipulate these values however you need) and also in field mapping transformations.

Need to know

Before you start working with flow variables, there are a couple of important points to understand regarding process flow versions and update persistence.

Process flow versions

Flow variables are version-specific. For example, if you add flow variables to the current draft version and later restore an inactive version to draft, any defined flow variables won't be present. So, make sure you're updating the correct version of a process flow. For more information, please see our Process flow versioning page.

Update persistence

If you update a flow variable via a script, those updates persist for the duration of the flow run. Once the process flow has been completed, default values are restored.

Using flow variables

Please see the following pages:

When defining variables you can 'mix and match' payload, metadata and flow variables. For example:

Last updated