Localizing Legacy Reports
In general, pages that relate to listing or executing reports will use the end user's locale, and pages that relate to the properties of a report design will use the system default locale.
"Static" text in report pages will always appear in the end user's locale. Static text includes things like the tab titles, block titles, labels of pushbuttons, labels of data fields, etc. But the data for an individual report is localized according to the rules below.
End user locale will be used for these pages:
- Report list
- Report execution
- Previously executed reports in Recent Items list
System default locale will be used for these pages:
- Report properties (whether editing or viewing)
- Report folder properties
- Previously edited report designs in Recent Items list
In order to localize report properties such as data series names, column headers, etc., there must exist an i18n key for each property. All "out-of-the-box" properties in TeamConnect already have such keys assigned to them. But since you can design brand-new reports that didn't exist in the out- of-the-box design, you need a way to assign such keys to the new report's properties.
This need is addressed by the Unique Key fields that are found in the various report design pages. If you do not plan to localize a report, you may leave these fields empty. But if you need to localize the report, each of these fields in the report must have a value. Each Unique Key field accepts characters A-Z, a-z, and/or 0-9. Spaces are not permitted. The values entered in these fields are later used to construct i18n keys that become associated with the report.
The Unique Key properties in the report design pages influence the creation of i18n keys as shown in the following example.
|
Tab |
Description |
|---|---|
|
General |
The value entered in Unique Key becomes part of the i18n key. If you enter "TaskDueDate", the resulting i18n key becomes "report.TaskDueDate.name". The Unique Key value cannot be one that has been used by any other report. |
|
Data |
If you enter a data series' Unique Key value of "Task1", the resulting i18n key becomes "report.TaskDueDate.dataSeries.Task1.name". Note the use of the report name's key as part of the data series' key. The Unique Key value cannot be one that has been used by any other data series within this report. Each field in the result display can have its own Unique Key. If a field in the result display has a field name of "Description" and a Unique Key value of "Descr", the resulting i18n key becomes "report.TaskDueDate.dataSeries.Task1.resultDisplay.Descr.label". The Unique Key value cannot be one that has been used by any other result field within this data series. Note that only result display fields that have an entry for their Unique Key property will not be exported for localization. Fields with that property empty will use the localized value of the default field label at runtime. Parameters are automatically exported for localization, and you do not have the opportunity to manually enter a Unique Key for a parameter. Instead the i18n key is constructed automatically. For a parameter of name "start" the i18n key would be "report.TaskDueDate.parameter.start.label". |