Using the token designer

Contents[Hide]

1. Overview

Tokens are used in Dundas BI to provide options for setting filters besides choosing specific data source values.

On a dashboard, you can access a filter's token menu and select options such as All 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 included with the application or create new tokens for other users to use.

Custom token last 40 days
Custom token last 40 days

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 DundasScript, allowing unlimited flexibility return TimeZoneInfo.ConvertTimeFromUtc(DateTime.UtcNow, currentSession.TimeZone);

You can create custom Named Set, Relative Time, or Script tokens, while Attribute and Basic tokens are defined by the system but have options that can be set.

Note
Attribute tokens are available for use only when editing data cubes.

3. Creating and managing tokens

To create and manage tokens as an administrator, click the Tokens button in the Administration's Setup area.

The Tokens setup screen
The Tokens setup screen

Creating tokens as an administrator is the same as for other users except that you can create script and relative time tokens from this screen. You can also create and manage tokens for other users of the system.

Administrators can access additional options for tokens:

  • Symbol: Optionally set a symbol to use when including this token as part of a URL query string.
    Add caption and symbol
    Add caption and symbol
  • Token Association: When creating a token as an administrator, this will be Global by default and available for all users. If you want to have a tenant-specific or account/group-specific token, select the desired token association from the dropdown list, and then choose the tenant or account.
    Token association
    Token association

See Creating custom tokens for details on creating each type of token.

4. Rename or localize a token

You can specify different captions for a token to be displayed depending on the language/culture of the user who is logged in. This applies to all types of tokens, including the system-defined attribute and basic tokens.

Locate the token from the list in the Tokens setup screen and click the Edit action button.

Click the Edit action button
Click the Edit action button

Click the caption link at the top of the edit dialog.

To rename the token for all users, change the text under Default; otherwise, click Add localized caption.

Add localized caption
Add localized caption

For a localized caption, enter the IETF language tag in the Culture field, and fill in the Caption field.

Provide the culture and caption
Provide the culture and caption

5. 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