Toucan 3.0
YouPrep documentationHelp centerGet a demo
  • Welcome
    • 👋Welcome to Toucan
    • ⚙️Technical resources
      • ⚙️Toucan stack
      • Setup mode
        • Toucan SaaS mode
      • ⚙️Security
        • Application Security
        • Source Code Quality
        • Global Security Practices
        • Security of Docker Images
  • TUTORIALS
    • 📊Getting Started : Embedded Analytics
    • 🤓Advanced tutorials
      • Embedding a story with user attributes
        • Dynamic filter with user attributes
        • Dynamic Tables
        • Dynamic Database
        • Dynamic Host
      • Using the HTTP API connector in advanced use cases
      • Using advanced syntax for SQL queries
      • Merging filters with our tool
      • Deep customization chart (CSS)
        • Homepage customization
        • Chart customization
        • Dashboard customization
  • Data Management
    • 🧮Overview of Data In Toucan
    • 📡Datasources in Toucan
      • 🔌Managing Connectors
        • 🔌Creating, editing and deleting a connector
        • 🔌Set up OAuth2 credentials for your platform
        • 🔌Setting up a connector
          • 🔌Generic Connectors
            • 🔌Setting up an HTTP API connector
            • 🔌Setting up an ODBC Connector
          • 🔌Database and data warehouse Connectors
            • 🔌Setting up an AWS Redshift Connector
            • 🔌Setting up a Snowflake Connector
            • 🔌Setting up a PostgreSQL Connector
            • 🔌Setting up a Google Big Query Connector
            • 🔌Setting up an AWS Athena connector
            • 🔌Setting up a MySQL connector
            • 🔌Setting up a MongoDB connector
            • 🔌Setting up a Microsoft SQL Server connector
            • 🔌Setting up an Azure SQL connector
            • 🔌Setting a Databricks Connector
            • 🔌Setting up a ElasticSearch Connector
            • 🔌Setting up a Clickhouse Connector
          • 🔌Online services connectors
            • 🔌Setting up a Sharepoint Connector
            • 🔌Setting up a Google Sheets Connector
            • 🔌Setting up a Salesforce Connector
            • 🔌Setting up a Hubspot Connector
          • 🔌Setting up an AWS S3 connector
      • 📁Managing Files
        • 📁Adding, editing and deleting local files
        • 📂Using advanced file settings
        • 📁Adding and combining remote files in Toucan
    • 🔢Datasets in Toucan
      • 🔢Stored and Live Datasets
      • 💿Managing datasets
        • 🔢Creating datasets
        • 🔢Editing, Duplicating and Deleting a dataset
        • 🔢Refreshing and Publishing Datasets
        • 📈Optimize data performance
        • 🗂️Adding indexes to stored datasets
        • 👩‍💻Code mode and single mode
      • 🛑Setting permissions on dataset
      • 🗃️Maintaining Data
        • 🗃️Tagging datasets
        • 🗃️Identifying datasets dependencies
        • 🗃️Set validation rules
    • 🧑‍🍳Preparing data
      • Overview of YouPrep™
        • 🎹Column header
          • Rename column
          • Duplicate column
          • Fill null values
          • Replace values
          • Sort values
          • Convert columns data types
        • Add
          • Add text column
          • Add formula column
          • Add conditional column
        • Filter
          • Delete columns
          • Keep columns
          • Filter rows
          • Top N rows
          • ArgMax
          • ArgMin
        • Aggregate
          • Group by
          • Add total rows
          • Hierarchical rollup
          • Get unique groups/values
        • Compute
          • Compute evolution
          • Cumulated sum
          • Percentage of total
          • Rank
          • Moving average
          • Compute statistics
          • Absolute value
        • Text
          • Concatenate
          • Split column
          • Extract substring
          • To lowercase
          • To uppercase
          • Compare text columns
          • Trim spaces
          • Replace text
        • Date
          • Convert text to date
          • Convert date to text
          • Extract date information
          • Add missing dates
          • Compute duration
        • Reshape
          • Pivot
          • Unpivot
          • Waterfall
        • Combine
          • Append datasets
          • Join datasets
        • Geo
          • Geographic dissolve
          • Geographic hierarchy
          • Geographic simplify
          • Prepare geo data (with basemap)
      • YouPrep™ Native SQL
      • Hybrid pipeline
    • ➿Managing variables in Toucan
      • ➿Variables hub
      • ♈Use variables in YouPrep™
      • ➿Easy reference to variables
    • 🧞Using advanced data concepts
      • 🧞Data personnalisation with user attributes
        • Connector setup with a user attribute
        • Database selection with a user attribute
        • YouPrep data filtering with a user attribute
        • Filter data in SQL with a user attribute
      • 🧞Advanced syntax for variables
      • 🧞Data cache
  • Visualizations and Layouts
    • 📺Apps
      • 📺Managing Apps
        • ➕Creating Apps
        • 📄Duplicating Apps
        • 🖨️Publishing Apps
        • 🚮Deleting Apps
        • ✍️Editing within an App
      • 🖌️Customizing Apps
        • Customizing chart color elements
        • Customizing the app's font
        • Adding Assets
        • Adding Glossary
        • Setting up, Managing and testing custom visibilities
        • Customizing the "no data error" message
        • Creating a dynamic background based on an Filter's column
      • 🏠Home
        • Creating the Home
        • Creating Tiles
          • Tile Dynamic Value
          • Tile Leaderboard
          • Tile Line
          • Tile Scorecard
          • Tile Bullet
          • Tile Heatmap
          • Tile PDF
          • Tile Video
          • Tile Image
          • Tile Text
          • Tile HTML
          • Tile Separator
      • ✨Stories
        • Creating a Story
        • KPIs
        • Narrative
        • Crossfilter
      • 📽️Filters
        • Managing Filters
          • Creating, reusing and editing Filters
          • Applying Filters
          • Unpinning and deleting Filters
        • Type of Filters
          • Dropdown
          • Checkboxes
          • Buttons
          • Date Range
          • Hierarchical
          • Slider
        • Templating from Filters' values
        • Dependant Filters
      • 📈PDF Report
      • 🎡Datawall
      • 🏗️Dashboard Builder
        • Create a Dashboard Builder
        • Embed a Dashboard Builder
        • Dashboard export options
      • 🌟MyFavorites
    • 📊Creating Visualizations
      • 🤩Viz Gallery
        • Barchart
        • Barlinechart
        • Bubblechart
        • Bulletchart
        • Circularchart
        • Funnelchart
        • Gantt chart
        • Heatmap
        • HTML
        • Leaderboard
        • Leaderboard Centered Average
        • Linechart
        • Mapchart
          • Configure a drill
        • Mediachart
        • Radarchart
        • Tablechart
        • Timeline
        • Versuschart
        • Waterfallchart
        • Score Card
        • Stacked Barchart
      • 🧠Common Chart Configuration
      • 💅Customizing chart colors
      • 🧞‍♂️Advanced chart configuration
        • Templating from chart's dataset
        • Add units, precisions and sentiments
        • Adding Tutorials
        • Add sparklines
        • Navigate with stories
        • Group informations in your stories
        • Multiple charts in one story
        • Manage dates
        • Customize tiles' sources
        • Add stars to tiles' title
        • Manage data order in your tiles
        • Navigate with tiles
    • 👩‍💻Embedding
      • 🔐Authentication
      • 🖇️Integration
        • Generate and manage embeds
        • Customize embeds
        • Embedding a Toucan App Using iFrames
        • Passing Extra Variables to Your Toucan Embed
      • ⚙️Embed SDK
        • Embed SDK Authentication
      • ❓FAQ
    • 🙋Self-Service
      • Self-Service Dashboard
      • Self-service PDF Report
  • Collaboration
    • ⏰Creating alerts
    • 📧Managing notifications
    • ➕Enriching a story with descriptions
    • 💌Sharing content
    • 💬Adding comments to stories
  • Administration
    • Page
    • ⚙️Instance Management
      • ⚙️Managing operations in SaaS
      • ⚙️Customizing your instance (whitelabel)
    • 👥Managing Users
      • 👥Users
      • 👥Managing user groups
      • 👥Managing user properties
      • 👥Setting up permissions and visibilities
    • 🌐Managing languages in Toucan (internationalisation)
    • 📈Monitoring Engagement with User Analytics
      • 🎛️How to Filter your User Analytics?
      • 🖥️Understanding your User Analytics Dashboards
  • Additional Ressources
    • 📚External documentation
    • 🚁Support for App-builders
    • 🆕Latest releases
      • 🎁2025 Releases
      • 🎁2024 Releases
      • 🎁2023 Releases
    • 🔧Troubleshooting
      • Troubleshoot:: DataHub
      • Cross-Site Cookies
      • How to :: read the inspector error
      • How to :: troubleshoot the toucan way
Powered by GitBook
On this page

Was this helpful?

  1. Data Management
  2. Managing variables in Toucan

Variables hub

Learn how to manage variable in Toucan

Last updated 2 months ago

Was this helpful?

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

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 the EN/US format:

yyyy-MM-dd HH:mm:ss

or you can also use the FR format

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:

2000-11-25 04:00:00

or

25-11-2000 04:00:00

This represents November 25, 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.

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

On the line corresponding to the variable you wish to delete, click on the three-button icon.

A dialog box opens, asking you to confirm that you want to delete the variable. By clicking OK, the dialog box closes and the line with the deleted variable disappears.

➿
➿
filters
A new option in app settings: Variables management
Variable Hub
Search a variable
Add a new variable
Fill the modal form to add new variables to your product
Add new external variables
Modify the staging default value from Asia to Europe
The new staging value is displayed after saving
After delete the variable is no longer see in the varaibles section corresponding
You have access to a menu that lists all the variables existing on your application
The dataset is filtered with the staging default value of the variable
The new default staging value is taken in account to filter the dataset