Localization file

The table header in this table uses the same column headers from the localization file. The rows show the possible value types and their format for the translatable content or element.

Category Subcategory Property Path Name 'path' Corresponding 'id' column value / type Description
Visualizer Column Label Catalog folder\...\Report Name <name>.viz.dashlet Column alias Visualizer reports are populated based on the expression used to define it. Expressions will contain the column alias, which when translated will affect all references to the column alias in the visualizer report. This affects custom column labels in a visualizer report.
Designer Element Label Catalog folder\...\Report Name <name>.AdhocReport Text Designer reports are populated based on the expression used to define it. Expressions will contain the column alias, which when translated will affect all references to the column alias in the designer report. This affects custom labels in a designer report.
Report catalog File Folder Name \Catalog folder\...\File or Folder Name catalog either a relative path to folder or file The set of file folders that are in the shared folder of a catalog. Translating these items affects their display in the file browser component of the application.
Report catalog Elements, such as folders, report names, and so on, in the user interface The unit id \Catalog folder\...\File or Folder Name\id catalog id The set of translatable elements in Report Catalog, such as folders, report names, and so on, in the user interface/
Report catalog Collection Name \Catalog folder\...\Collection Name dashboard-collections id The set of translatable page names in a dashboard collection.
Report catalog Dashboard Name Catalog folder\...\Dashboard Name dashboards/{uuid}/pages/{uuid The name of the dashboard.
Dashboard Button, KPI, Reports dashlet, Text, HTML, Embedded filter dashlet, Web Page dashlet Description, Text, Dashlet Title, Title. Catalog folder\...\Dashboard Name dashboards/{uuid}/pages/{uuid uuid of element in PAGE The translatable elements in a dashboard page configuration. These include buttons, kpi, report dashlets, text, HTML.
Dashboard Filter, Filter Group, Native Filter, Native filter Group Name filter filters uuid Names of prompts.
Subject Area Saved Expression Name N/A subject-area SavedExpression('name of expression)' The elements in a single subject area. The specific items that are subject to translation are saved expressions.
Subject Area Main Name N/A subject-area Name of the subject area Elements that are translated in this area specifically relate to the global set of subject areas. The items that are normally translated are subject area names.
Subject Area Global Filter Name N/A Global-filters uuid Elements that are translated in this area specifically relate to the global set of subject areas. The items that are normally translated are subject area names.
Subject Area Custom Set Name N/A Custom-sets uuid Elements that are translated in this area specifically relate to the global set of subject areas. The items that are normally translated are subject area names.

When you download and use the localization file, note that:

  • All translation is contained on a single worksheet (table)
  • The columns in the table are not required to be in a specific order
  • The localization takes place by adding a separate column for each locale (language) in the table. The first row (header) contains the locale designation in an 'xx_xx' format, where 'xx_xx' has to correspond to one of the locales supported by Birst.

    /var/folders/y1/v5nc_nc54tj8ql5j_jrkx85dr7cpnj/T/com.microsoft.Word/Content.MSO/2153656F.tmp

This table shows a description for the possible 'path' and 'id' values in the translation file.

'path' column value Corresponding 'id' column value / type Description
<name>.viz.dashlet column alias Visualizer reports are populated based on the expression used to define it. Expressions will contain the column alias, which when translated will affect all references to the column alias in the visualizer report. This affects custom column labels in a visualizer report.
catalog either a relative path to folder or file Pertains to the set of file folders that are in the shared folder of a catalog. Translating these items affects their display in the file browser component of the application.
dashboard-collections page uuid Pertains to the set of translatable page names in a dashboard collection
dashboards/{uuid}/pages/{uuid} {some uuid of element in page{} Pertains to the translatable elements in a dashboard page configuration. These include buttons, kpi reports, text reports, charts.
filters {some uuid} Names of prompts
subject-area SavedExpression('name of expression)' Pertains to the elements in a single subject area. The specific items that are subject to translation are saved expressions.
subject-areas the name of the subject area Elements that are translated in this area specifically relate to the global set of subject areas. The items that are normally translated are subject area names.