Localization and multi-language support

Contents[Hide]

1. Overview

Dundas BI provides support for multiple languages through the use of XML localization (translation) files on the server that determine all user interface text, and through culture-sensitive formatting of numbers and dates.

Text that appears in the various user interface screens, dialogs, and toolbars can be customized by editing the localization XML files and replacing whatever text you require, or by using overrides, which can help with application branding. Currently, Dundas BI does not ship with alternate language translations, but this could be added in a future release, or it can be accomplished by third parties or your own organization.

For information about localizing tokens including the system-defined attribute and basic tokens see Managing tokens.

2. Right-to-left support

Dundas BI lets you use right-to-left languages such as Arabic and Hebrew when entering text for display purposes in the dashboard designer.

As an example, create a new dashboard in Dundas BI and add a Label component to the canvas.

Go to your Windows Language bar and change the input langauge to one that flows right-to-left (e.g., Hebrew).

Change the input language in Windows
Change the input language in Windows

Select the label component and click Edit Label Text from the toolbar (or the right-click menu).

Click Edit Label Text
Click Edit Label Text

Press CTRL+SHIFT on the right side of your keyboard. This will ensure the cursor position is correct for right-to-left text entry. You can now begin typing the label text in a right-to-left manner.

Enter right-to-left text directly on a label component
Enter right-to-left text directly on a label component

Similarly, when entering text in the Properties window for a data visualization control (e.g., Title property for a chart axis), press CTRL+SHIFT and then begin typing right-to-left text.

Enter right-to-left text for the title of a chart axis
Enter right-to-left text for the title of a chart axis

3. Culture settings

A locale or culture is a collection of settings that defines a user's language, country and preferences for viewing specific kinds of information in a user interface, such as numbers, dates, times, and currency. Numbers and dates will automatically display according to each user's current culture without any other configuration.

A culture is represented in Dundas BI as a culture name, typically consisting of two parts: 

  1. A lowercase culture code associated with a language.
  2. An uppercase subculture code associated with a country or region.

Below are some examples of culture names:

Culture NameLanguage (Country/Region)
en-US English (United States)
en-CA English (Canada)
fr-FR French (France)
fr-CA French (Canada)
de-DE German (Germany)

An extensive list of culture names (or 'language tags') is available here and can apply to Dundas BI whether its server is running on Windows or Linux.

3.1. Default culture

The Dundas BI application is installed with a default culture using the default culture of the server, but this can be changed by an administrator via a configuration setting.

To change the default culture for Dundas BI, click Admin from the main menu, expand Setup, and then click Config. In the Configuration settings, click the Edit Default Culture button in order to modify the Default Culture setting.

Default Culture configuration setting
Default Culture configuration setting

3.2. User account and group culture

A culture setting can also be applied directly to a user account or group by an administrator to assign them different cultures. This setting takes precedence over the application's default culture for each user.

Set the culture for a new user account
Set the culture for a new user account

3.3. Session culture

The culture can also be set for a user just for their current logon session. This culture takes precedence over their account and server culture settings described above.

The session's culture can be automatically determined by the language settings from the user's browser if the Enable Accept-Language Header Culture application configuration setting is enabled. 

It is also possible to specify directly the culture you want to use for your logon session by navigating to the Dundas BI Log On screen with the cultureName query string parameter.

Here is an example URL for specifying a French (France) culture:

http://myserver:8000/LogOn?cultureName=fr-FR

After logging on, you can confirm the culture associated with your logon session by clicking on Profile in the left menu, and finding the Culture field.

Profile dialog shows the culture associated with your logon session
Profile dialog shows the culture associated with your logon session

Various places in the application will display numbers and dates formatted accordingly as well.

Log times are now displayed using the current session culture
Log times are now displayed using the current session culture

The culture for a user's logon session is determined from these settings (in order from highest to lowest priority):

  1. The culture as specified via the cultureName query string parameter.
  2. The culture specified in the browser's language settings (Accept-Language header) if enabled in the config settings.
  3. The culture assigned to the user's account.
  4. The culture assigned to a group that contains the user.
  5. The default culture as specified in the application configuration.

4. Localizing for a specific culture

Most text displayed in Dundas BI (other than numbers, dates, and data from data sources) comes from localization files. To change this text for different cultures, additional files are needed providing the translated text for each required language and/or country.

4.1. Web.xml file

The Web.xml file contains the localization strings pertaining to the user interface of Dundas BI (for a specific language).

4.2. XML file format

A language localization file is an XML document with the following basic structure:

<?xml version="1.0" encoding="utf-8"?>
<localization>
  <group>
    <string></string>
    ... more strings ...
    ... more groups ...
  </group>
  ... more groups ...
</localization>

4.2.1. Element: localization

The localization element specifies the culture of the localization file. Only one localization element is permitted per localization file.

Example:

<localization xmlns="http://dundas.com/schemas/BI/localization.xsd"
              culture="en"
              moduleId="EC04F56F-AAD2-4395-BCB3-35F5B1D0C8F1">
    ... one or more groups ...
</localization>

4.2.2. Element: group

The group element is used to group related translation strings. Groups can be nested within another group.

Example:

<group name="LogOnView">
    ... one or more strings ...
    <group name="PasswordReset" tags="client">
    ...
    </group>
</group>

4.2.3. Element: string

The string element is used to specify the translated text for a string that appears in the application's user interface. The key attribute uniquely identifies the string and must not be changed. The actual translated text appears between the start and end tags of the string element.

Example:

<string key="GS_LogOn_Title">Log on to Dundas BI</string>

4.3. Example: Localizing the Log Off button

This example shows how to add support for the French (France) culture by localizing the text of the Log Off button in the main menu.

  1. From the main menu, click Admin, expand Setup and then click Localization
  2. Select the Web override file from the list of files and then click Details on the toolbar.
  3. Click Download localization to save the localization file as an XML file.
  4. In the localization file, change the value of the string element with the key = GS_MainMenu_LogOff from Log Off to Déconnexion and save the changes.
  5. Select the Web override file from the list of files and then click Copy on the toolbar.
  6. Set the Target Culture to fr-FR and click Submit.
  7. From the list of localization files, select the fr-FR culture version of the Web override file and then click Details on the toolbar.
  8. Click Choose File and select the edited Web override file that you had created earlier.
  9. You may need to recycle the Dundas BI application pool for the changes to take effect.
  10. Navigate to <DundasBI website>/LogOn?cultureName=fr-FR and log on.
  11. Expand the main menu to see the localized text for the Log Off button.

Log Off button with text localized to fr-FR culture
Log Off button with text localized to fr-FR culture

5. Override mechanism

For the purposes of branding or white labeling, you typically want to modify a few localization strings (e.g., related to product name) instead of adding support for a whole new language. In this case, you can use the override mechanism to replace a subset of localization strings for an existing culture. This override mechanism also helps to ensure that localization changes you make are not overwritten when upgrading to a new version of Dundas BI.

See White labeling the application for an example of this procedure.

6. 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:
Phone: 9am-6pm, ET, Mon-Fri
Email: 7am-6pm, ET, Mon-Fri