Tenant Variables

Tenant variables are stored in a database and can be used in all the flows of a tenant. Every tenant has a Tenant Variables page where you can find the tenant variables. The empty list looks like this:

In the quicklink menu (top-right) you can:

• Create variables with
• Manage Tags with
• Export variables with
• Import variables with

tip

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

Table Layout

Below you see an example where a couple of tenant variables have been created. The columns show the Name and Value, when/by who it was Created and Updated, Tags and Actions.

In the table you can:

• Use the tabs to switch between the Test and Production view
• Click the table headers to sort the list (on all columns except Value, Tags & Actions)
• Use to filter the list

The actions you can perform in the list:

• Click on its name or value to edit a variable
• Use to remove a variable
• Use to attach tags to a variable

note

The indicates the value is stored encrypted.

Filter table

You can use the to filter the table view, a small popup appears where you can set your filter(s). When you have filtered your view a button appears in the quicklink menu with a number indicating the size of your selection.

Here you can tag (), remove () or export () the filtered tenant variables.

Create tenant variables

Tenant variables can be created manually or in a flow. When you create a new tenant variable it exists in both the Test and Production environment.

Manually

Click the button in the quicklink menu and a popup will appear.

To create a tenant variable:

• Set the Name (obligatory)
• Enable Encrypt? to store the variable values encrypted
• Set the Values:
  • under Test for the Test environment
  • under Production for the Production environment

note

Created/Updated By will show the user's email address.

In a flow

Use the SetTenantVariable component to create a tenant variable from within a flow.

note

Created/Updated By will show the flowgroup/flowname.

Edit tenant variables

Tenant variables can be edited manually or in a flow.

Manually

Click on a variable name or value to edit it.

The indicates edited fields and two buttons will appear in the quicklink menu with an indication of the number of changes. Now you can:

• Use in the Actions column to save changes per variable
• Use in the quicklink menu to save all changes (indicated by the number)
• Use in the quicklink menu to discard all changes (indicated by the number)

In a flow

Use the SetTenantVariable component to edit the value of a tenant variable from within a flow.

Remove tenant variables

Tenant variables can be removed manually or in a flow.

Manually

Click on the button in the Actions column of a variable to remove it and a popup for confirmation will appear.

In a flow

Use the RemoveTenantVariable component to remove a tenant variable from within a flow.

Manage tags

Click the button in the quicklink menu and a popup will appear. You can add and remove tags.

Add new tags

To add a tag set the Label & Color and save.

Remove tags

To remove a tag click the button.

Attach tags to variables

Click the button in the Actions column of a variable and a popup will appear. You can (de)select tags here.

Alternatively you can filter the list and use the () button to add tags to your filtered selection as described in Filter table.

Export/Import tenant variables

You can export and import tenant variables.

Export

Click the button in the quicklink menu to download the tenant variables for that tenant in a JSON file. See this export example for the variables as seen in the screenshot in the Table Layout section.

Import

Click the button in the quicklink menu and popup will appear to select a file to import.

note

When you import tenant variables the Created/Updated At/By are set with the current date:time and email address of the user.

Remarks

note

Some components use the tenant variables to save data. Created/Updated By will show System in these cases.