Using the Token Designer

Contents[Hide]

1. Overview

Tokens are used in Dundas BI as a means of simplifying user input. On a dashboard, you can access the token menu of a parameter control and use it to select standard filter values such as All Values or Null. For time dimension filters, additional tokens let you select relative date values such as Today, Current week, or Year to date.

Token menu.
Token menu.

Dundas BI administrators and Tenant administrators, when they have the "Create Token" privilege, can modify the built-in tokens which are included with the application, or create new custom tokens such as Last 40 days or Current Quarter.

Custom token last 40 days.
Custom token last 40 days.

From the Administration menu, click the Token Designer button to launch a designer screen that lets you modify built-in tokens or create new ones.

The Token Designer screen.
The Token Designer screen.

2. Token Types

Token CategoryDescriptionExample
Attribute Tokens based on the log-in credentials Current Account Name, Current Session ID
Basic Basic tokens All, Default, Null
Named Set A token defined on a specific dimension hierarchy USA, Canada, Paris
Relative time Time based parameter token definition Current Week, Last 30 days, Beginning of Today
Script A token defined using expressions, allowing unlimited flexibility. return TimeZoneInfo.ConvertTimeFromUtc(DateTime.UtcNow, currentSession.TimeZone);.

3. Creating a new token

3.1. Relative Time Token and Script Token

Use the Token Designer to create a new Script Token or Relative Time Token.

To create a new Relative Time Token (e.g. Last 40 days):

  1. Click the Add token button. For this sample, we need to select the add Relative Time Token button.

    Create new token.
    Create new token.

  2. In the New Relative Time Token Setup wizard, enter a Caption for the token.
  3. Optionally, add a symbol for the token.

    Add caption and symbol.
    Add caption and symbol.

  4. By default, the token association will be global. If you want to have a tenant-specific or account/group-specific token, select the desired token association from the dropdown list.

    Token association.
    Token association.

  5. For a Relative Time token, data type is locked to Date and Time Hierarchy.

    Data Type.
    Data Type.

  6. Select the Display Type. Select the "Range Full" since the Last 40 days token is a full date range time dimension.

    Display Type.
    Display Type.

    To learn more about Token Range types, refer to the Set Date range in a Time Dimension using Tokens example.

  7. Since a full date range is selected, select the start and end member granularity and offset.

    Start member granularity.
    Start member granularity.

    End member granularity.
    End member granularity.

  8. Click the Submit button to create the token and refresh the Token Designer screen.

    Submit button.
    Submit button.

  9. Result:

    Last 40 days token.
    Last 40 days token.

3.2. Named Set Token

To create a new Named Set Token:

  1. Select filter values from the hierarchy filter:

    Select filter values.
    Select filter values.

  2. From the the hierarchy filter controls' token drop down list, select Save Selection as Token.

    Save Selection as Token.
    Save Selection as Token.

  3. Create the Named Set Token. Access can be controlled by setting the Token Association (Global, Tenant, Account). In this example, Global is selected.

    Create the Named Set Token.
    Create the Named Set Token.

  4. Result: User(s) with access to the dashboard and token should be able to see and use the named set token from the hierarchy filter controls' token drop down list.

    Using the Named Set Token.
    Using the Named Set Token.

4. See also

 

Dundas Data Visualization, Inc.
500-250 Ferrand Drive
Toronto, ON, Canada
M3C 3G8

North America: 1.800.463.1492
International: 1.416.467.5100

Dundas Support Hours: 7am-6pm, ET, Mon-Fri