Internationalize Web Dashboard

You can internationalize Web Dashboard to display field labels translated into the language specified for the user. This allows users to have access to the application in their assigned or preferred language. For a language to be associated with a user, you must activate it from the Language menu.

The steps for internationalization include:

  1. Make languages available
  2. Provide translations on the Internationalization tab for each object you want to internationalize.
  3. Specify a language for the user
Note   When you specify a language, the menu labels, report and dashboard titles and all the descriptions are translated into that language.

Make languages available

For a language to be available for internationalization, it must exist on the Language tab. See Languages in Web Dashboard.

In addition, you must make a language active for it to be available. If you change the active status of a language, you must restart the web server to make the change effective. By default, English and French are active.

Provide internationalization values

You provide internationalization values (translations) for Web Dashboard field labels using the Internationalization tab. Primarily, these will be descriptions that users see when they use Web Dashboard. There are, however, other fields for some Web Dashboard object that you can internationalize. See Additional fields for internationalization.

The Internationalization tab will display a set of fields for each language that you have activated. It is here that you provide translations to be displayed in the user's language.

Note   Internationalized labels can contain special characters supported by UTF-8 encoding.
  1. Go to the tab for the object for which you want to internationalize text, for example, Data management > Data dictionary, and click the Internationalization tab.
  2. For each active language, the Internationalization tab displays a list of fields for which you can specify translations.
  3. Enter values for the fields you want to display as translated.
  4. Click Save.

Additional fields for internationalization

The following table lists some additional labels specific to certain Web Dashboard objects that can be internationalized:

Web Dashboard Object Internationalization fields
Data dictionary

Description

Comment

Table name

Fields name

Dashboard

Description

Filters

Template description

External component

Description

Description parameters (Filters)

Form

Description of the form

Description of the fields used

Report

Description of the report

Comment

Filters

Fields (columns) displayed in the report

Label of calculus line cells

Text

Description of the text object and the body text

Control

Description of the control object

Comment (Thresholds)

Message Subject and Body

Metric

Description of the metric object

Message Subject and Body

Task

Description of the task object

Comment

Message

Select a user language

You can either assign languages on a per-user basis or the user can specify a language in his Preferences options. When a user selects a language, all descriptions in reports, dashboards, and other objects are immediately displayed in the selected language. However, menu labels are displayed in the new selected language only if user refreshes the page manually in the web browser, or logs out and logs in again.

To select a user language, do the following:

  1. Go to User management > User and select the user for which you want to assign a language.
  2. Select a value from the Language field.
  3. Click Save.

Best practice for language management

You should consider adding languages in the early stages of Web Dashboard configuration and development to avoid having to repeat internationalization procedures unnecessarily.

Before you design reports and dashboards, consider the following activities.

  1. Add and activate all necessary language.
  2. Create data dictionaries and complete internationalization for every selected field. Column fields translation will be automatically used in reports.
  3. Create a first report:
    • For every calculated field and every filter, complete the internationalization.
    • For every column name you change, change the translation too.
  4. Duplicate reports. If you use same columns, filters, and calculated fields, you will not have to rewrite translations.
  5. Create your dashboards and other objects based on reports. Complete internationalization for each object.

Related Links