Skip to main content
Version: 4.14.5

SetTenantVariable component

The SetTenantVariable component can be used to set body or header data on a tenant variable. You can chain multiple SetTenantVariable components together to set multiple tenant variables.

Tenant variables are stored in a database and can be used in all the flows of a tenant. They can be retrieved by the GetTenantVariable Component and removed with the RemoveTenantVariable Component.


Read more about using variables in Dovetail on this reference page.


The SetTenantVariable component has the following configuration options:

Tenant variable

The name of the tenant variable you wish to set.

Expression type

The language of the expression. Read more about the different Expression types below.


The value you wish to set on the variable. When installed on Test it sets the test value and when installed on Production the production value.


When the variable contains sensitive information you can choose to store it encrypted.


The current values section shows a preview of the configured tenant variable's Test and Production values


Because tenant variables are stored in a database there is a short time between saving the value of a variable and retrieval. In high-frequency flows, due to parallel processing, retention and retrieval may not occur sequentially, and as a result of the delay, the retrieved value may be older than previously expected.

Expression types

Expressions can be defined using the following expression types:


The Simple Expression Language, which also supports File Expression Language. It only returns plain text, no xml. Mostly used with the body/headers of a message or when Using time.


The XPath 2.0 language. It only returns plain text, no xml. Used to retrieve data from or to do operations on an XML file.


The JsonPath language. Used to retrieve data from or to do operations on a JSON file.


The Groovy language. It only supports one-line expressions. Use the script component for multiline Groovy scripts.


The literal value you set. When using syntax, i.e. ${header.HeaderName}, as (part of) a Constant that literal string will be set as the tenant variable, not it's value.