โžฟVariables hub

Learn how to manage variable in Toucan

This feature is under feature flag, contact your CSM to enable it on your workspace.

To access to the User variables, you have to contact your CSM to enable a User Attribute Management flag.

To manage variables, go in staging mode, in the settings menu of your app, as an app-builder, you have access to a new option: Variables Management.

Variables Hub

In the Variables Hub, you have access to variables listed in variable groups:

  • User Variables

  • External Variables

  • Filter Variables

External variables can be created directly in the Variables Hub. User variables and filter variables are created from the objects, user properties, and filters that you create in Toucan.

Search a Variable

Itโ€™s possible to search for variables by using their name and the search component.

Add a Variable

Adding a variable is possible for the following variable groups:

  • External Variables

To add a new variable, follow these steps:

  1. Create a new Variable:

    • Click on the Create a variable button at the top right of your screen

    • or in the External Variables section, click on the + Add an external variable link within the expanded section.

  2. Fill in the Modal Form:

    • if you click on Create a new variable button A modal window will open where you can choose the variable group where you want to add the new variable. Currently, the available option is "External variable".

    • If you click on + Add an external variable link you will be redirected to the next section of the modal l where you need to fill in the following information:

      • Variable ID: (mandatory) A unique identifier for the variable.

      • Variable Name: (mandatory) The name of the variable.

      • Staging Default Value: (optional) You can provide a default value for staging. The possible types for this field are:

        • String

        • Number

        • Date

        • Boolean

  3. Save the new Variable:

    • After filling in the required fields, click on the "Save" button to add the variable.

    • The modal will close, and you will see the new variable listed in the corresponding variable group.

Example

In the example shown in the image, an external variable named "External variable country" with the variable ID external.country has been created with a default value set to "France".

Edit a Variable

Editing a variable allows you to change the default value for a given variable. This is possible for the following variable groups:

  • External Variables

  • User Variables

You can edit by clicking on the Edit icon on the row corresponding to the variable.

Modify the default staging value and click on Save.

Date format for variable type date

When working with date variables, the expected format for date variables is:

dd-MM-yyyy HH:mm:ss

Format Explanation:

  • dd: Day of the month (two digits)

  • MM: Month (two digits)

  • yyyy: Year (four digits)

  • HH: Hour in 24-hour format (two digits)

  • mm: Minutes (two digits)

  • ss: Seconds (two digits)

Example:

A correctly formatted date would look like this:

02-02-2000 04:00:00

This represents February 2, 2000, at 4:00:00 AM.

Delete a Variable

Deleting a variable allows you to remove a given variable. This is possible for the following variable group:

  • External Variables

To delete a variable:

  1. A new menu appears with the label Delete. Click on this option.

Use a Variable

We will dig an example of how you can now use variables in the product,.

If you go on the Datahub, when you create or edit a dataset,

If you add for example a filter rows step to filter your dataset by clicking on the chip variable to display a menu containing all the variables of your app.

Choose one of the variable, and the dataset will be filtered with the default staging value corresponding to the variable.

If you go to the Variables Hub and change the default staging value of the variable you used to previously filter the dataset, and then return to the dataset by clicking on edit, the dataset will be filtered with the new default staging value.

Last updated