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. Text that appears in the various user interface screens, dialogs, and toolbars can be customized on a per-locale/culture basis by copying XML files and replacing only the text you require. The localization system also supports overrides which helps 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 even your own organization.

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.

A culture is represented in Dundas BI as a culture name which consists 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)

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 View or modify configuration screen, click the Edit Default Culture button in order to modify the Default Culture setting.

Default Culture configuration setting
Default Culture configuration setting

For more information about locales and cultures in .NET, see this MSDN article regarding the CultureInfo class.

3.2. User account and group culture

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

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

3.3. Session culture

Each user's logon session in Dundas BI is associated with a culture which is used to format dates and numbers appearing in the application UI.

It is 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. This setting takes precedence over any other culture settings.

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

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

In this example, after logging on, the culture associated with your logon session will be fr-FR or French (France). If you're an administrator, click Admin, expand Account Service, click Sessions, and then select your logon session in the Active Sessions list. Use the Session Details dialog to verify that your session culture is indeed fr-FR.

Session Details dialog shows the culture associated with a logon session
Session Details dialog shows the culture associated with a logon session

Various places in the application will display 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 assigned to the user's account.
  3. The culture assigned to a group that contains the user.
  4. The default culture as specified in the application configuration.

4. Localizing for a specific culture

4.1. Folder structure

Language localization (XML) files are organized under the App_Data\Localization folder of your Dundas BI instance. By default, this folder path is:

C:\Program Files\Dundas Data Visualization Inc\Dundas BI\Instances\{InstanceName}\www\BIWebsite\App_Data\Localization

The Localization folder contains one or more sub-folders, each representing a specific culture name such as en (English) or fr-FR (French-France).

Localization folder structure
Localization folder structure

Within each culture sub-folder are the actual localization XML files which provide text for the various areas of the application.

4.2. Localization XML files

Here is the list of XML files you'll find within the Localization\en folder which is included with the default installation.

  • Dundas.Core.xml
  • Dundas.GoogleAnalyticsProvider.xml
  • Dundas.StandardFunctions.xml
  • Dundas.StandardOlapDataProviders.xml
  • Dundas.StandardRelationalProviders.xml
  • Dundas.StandardTransforms.xml
  • Dundas.TimeDimensionProviders.xml
  • Web.xml

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

4.3. 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.3.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.3.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.3.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.4. 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. First, go to the App_Data\Localization folder and make a copy of the en sub-folder which is included in a default installation. Rename this folder to fr-FR. There should be two sub-folders under Localization now (en and fr-FR).
  2. Edit each of the XML files in the fr-FR folder and go to the start of the localization element. Change the culture attribute from en to fr-FR and save your changes.
  3. Edit the Web.xml file and locate the string element with key = GS_MainMenu_LogOff. Change its value from Log Off to Déconnexion. Then save your changes.
  4. Restart the Dundas BI website (e.g., recycle the Dundas BI app pool, or restart IIS with iisreset).
  5. Log on to Dundas BI and change the default culture to fr-FR in the application configuration.
  6. Log off and log back on to Dundas BI.

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. Localizing the Log On screen

When you navigate to the Dundas BI Log On screen using the cultureName query string parameter, the Log On screen will be formatted according to the specified culture. For example, use the following URL to format the Log On screen for a right-to-left language such as Arabic (Egypt):

http://myserver:8000/LogOn?cultureName=ar-EG

In this example, any localization XML files associated with the ar-EG culture will be used to display the UI text in the Log On screen (using the same procedure as shown in the Log Off button example).

6. 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 sub-folder. This override mechanism also helps to ensure that localization changes you make are not overwritten when upgrading to a new version of Dundas BI.

As an example, to override the en culture:

  1. Create a sub-folder under Localization\en called override. Within this sub-folder, copy the XML files for the en culture containing the strings you want to override. 
  2. Rename each of the copied XML files so that the file extension is override.xml. For example, Web.override.xml.
  3. Edit each override file and delete all of the strings you do not want to replace. Keep only the strings you want to modify but also keep the structure of the parent group elements intact. Save your changes and then restart the Dundas BI website for the changes to take effect.

See Dundas BI White Labeling for an example of this procedure.

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