Localisation : Translation of Orchestra Business Intelligence
  

Translation of Orchestra Business Intelligence

Orchestra Business Intelligence is based on the third party product Pentaho Business Analytics.
The sections below describe which properties files that need to be updated, in the different parts of the system, in order to manually introduce a new language to the Business Intelligence application.
In short, the steps are as follows:
1. Copy the businessintelligence.war file to a suitable location, where you can work with it, without interrupting the running Orchestra system.
2. Locate and copy a number of properties files, described in the sections below.
3. Rename the files so that the file name includes your language’s language code, for example message_es.properties, for a Spanish file.
4. Translate all the parameters (text strings), in the file that you created, to your language, making sure that you use Unicode, where needed, for example \u00e9 for é. Save the file.
5. Open the corresponding *_supported_languages.properties file, located in the same folder as the property file that you updated in the previous steps, and add an entry for your language in the file. Save the file.
6. When all parts described below are translated, zip the updated businessintelligence.war file and redeploy the businessintelligence.war application. See “Redeploying Applications” .
7. Restart the Qmatic Platform service. Log in as superadmin and open the Business Intelligence application. You should find a new menu entry for your language in the View->Languages menu.

Translating the BI Console

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property files, in:
<temporary_directory>\businessintelligence\mantle\messages:
• filechooser_messages_xx.properties
• MantleLoginMessages_xx.properties
• mantleMessages_xx.properties
• WidgetsMessages_xx.properties
2. Add an entry for your language to the following property files, in:
<temporary_directory>\businessintelligence\mantle\messages:
• WidgetsMessages_supported_languages.properties
• mantleMessages_supported_languages.properties
• MantleLoginMessages_supported_languages.properties
• filechooser_messages_supported_languages.properties
Example, adding Spanish:
en=English
fr=Fran\u00E7ais
de=Deutsch
ja=\u65E5\u672C\u8A9E
es=Espa\u00f1ol
 
Special characters must be entered in Unicode.
 
3. Locate, copy, rename (with your language code) and translate the following property file, in:
<temporary_directory>\businessintelligence\mantle\browser:
• messages_xx.properties
 
4. Add an entry for your language to the following property file, in:
<temporary_directory>\businessintelligence\mantle\browser:
• messages_supported_languages.properties
 
5. Locate, copy, rename (with your language code) and translate the following property file, in:
<temporary_directory>\businessintelligence.war\mantle\home\properties:
• messages_xx.properties
 
6. Add an entry for your language to the following property file, in:
<temporary_directory>\businessintelligence.war\mantle\home\properties:
• messages_supported_languages.properties
7. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\default-plugin\resources\messages:
• messages_xx.properties
 
8. Add an entry for your language to the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\default-plugin\resources\messages:
• messages_supported_languages.properties
 

Translate Admin Plugin Parameters

This section concerns translation of the phrases found in the Administration page.
In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\admin-plugin\resources\messages:
• messages_xx.properties
 
2. Add an entry for your language to the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\admin-plugin\resources\messages:
• messages_supported_languages.properties
 
3. Add supported language entry (xx : true) to the following file in:
<orchestra_installation_directory>\pentaho-solutions\system\admin-plugin\resources\nls:
• messages.js
Make sure that you separate each new language with a comma (,).
Example of what it may look like in the messages.js file:
en : true,
de : true,
fr : true,
ja : true
 
 
4. Create a folder named xx in the <orchestra_installation_directory>\pentaho-solutions\system\admin-plugin\resources\nls folder.
5. Copy the messages.js file from the <orchestra_installation_directory>\pentaho-solutions\system\admin-plugin\resources\nls\en folder to the folder you just created and translate the contents of the file to the language in question.

Translating Analyzer Parameters

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\analyzer\resources:
• messages_xx.properties
 
2. Add an entry for your language to the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\analyzer\resources:
• messages_supported_languages.properties
 
3. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\analyzer\scripts\filechooser\messages:
• filechooser_messages_xx.properties
• WidgetsMessages_xx.properties
 
4. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\analyzer\scripts\filechooser\messages:
• filechooser_messages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
 
5. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\analyzer\scripts\schedulingdialogs\messages:
• filechooser_messages_xx.properties
• WidgetsMessages_xx.properties
• mantleMessages_xx.properties
 
6. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\analyzer\scripts\schedulingdialogs\messages:
• filechooser_messages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
• mantleMessages_supported_languages.properties

Analyzer data from databases

Most names from the databases can currently not be modified using localisation. They are defined in the following files:
• locale_mondrian.properties - for more information about how to locate and modify this file, please see “locale_mondrian.properties” .
• qmatic.mondrian.xml - for more information about how to modify this file, please see “locale_mondrian.properties” .
locale_mondrian.properties
This is the preferred way of modifying or translating names and phrases from the databases.
To locate and then modify this file, please follow these steps:
1. Extract the file <orchestra_home>\system\deploy\businessintelligence.war to a suitable directory.
2. In the folder businessintelligence\WEB-INF\classes, open the file locale_mondrian.properties.
3. Translate, or update (if you just want to change the English wording, for example), the phrases in the file and save it. If you have translated it, add a suffix, such as *_fr (for French) to the file name, in this case locale_mondrian_fr.properties.
4. Make a zip-file of the businessintelligence folder containing the file that you just updated or translated and rename the zip-file businessintelligence.war.
5. Redeploy the Business Intelligence application, see “Redeploying Applications” .
qmatic.mondrian.xml
It is possible to modify and translate the metrics in the qmatic.mondrian.xml.<database> file. However, we recommend that you use the locale_mondrian.properties file for that purpose (see above).
The qmatic.mondrian.xml.<database> file is found here: pentaho-solutions\qmaticbi\platform\. Make sure that you select the one that corresponds to your used database.
This file is used to query the database and should be modified with great caution. Make a backup of the existing file before attempting to localize it.
The localised names should be entered in the caption and description properties of the XML tags for Dimensions, Levels and Measures.
Example:
Locate the wanted text. In this example, the measure Arrived:
<Measure name="arrived" datatype="Numeric" aggregator="count" caption="%{qmatic.measure.visit.arrived.caption}" visible="true" description="%{qmatic.measure.visit.arrived.description}">
And change to, in this example, French:
<Measure name="arrived" datatype="Numeric" aggregator="count" caption="Arrivée" visible="true" description="Arrivée">
 

Translating Dashboard Parameters

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\chartDesigner\messages:
• filechooser_messages_xx.properties
• ChartDesignerMessages_xx.properties
• WidgetsMessages_xx.properties
• LoginMessages_xx.properties
2. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\chartDesigner\messages:
• filechooser_messages_supported_languages.properties
• ChartDesignerMessages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
• LoginMessages_supported_languages.properties
 
3. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\dashboarddesigner\messages:
• filechooser_messages_xx.properties
• filterdialog_xx.properties
• WidgetsMessages_xx.properties
• LoginMessages_xx.properties
• dashboards_xx.properties
 
4. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\dashboarddesigner\messages:
• filechooser_messages_supported_languages.properties
• filterdialog_supported_languages.properties
• WidgetsMessages_supported_languages.properties
• LoginMessages_supported_languages.properties
• dashboards_supported_languages.properties
 
5. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\dashboardviewer\messages:
• filechooser_messages_xx.properties
• WidgetsMessages_xx.properties
• dashboards_xx.properties
 
6. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\dashboardviewer\messages:
• filechooser_messages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
• dashboards_supported_languages.properties
 
7. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\filterdialog\messages:
• filechooser_messages_xx.properties
• filterdialog_xx.properties
• LoginMessages_xx.properties
• WidgetsMessages_xx.properties
 
8. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\filterdialog\messages:
• filechooser_messages_supported_languages.properties
• filterdialog_supported_languages.properties
• LoginMessages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
 
9. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\resourceBundle\messages:
• filechooser_messages_xx.properties
• WidgetsMessages_xx.properties
 
10. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\resourceBundle\messages:
• filechooser_messages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
 
11. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\schedulingdialogs\messages:
• filechooser_messages_xx.properties
• mantleMessages_xx.properties
• WidgetsMessages_xx.properties
 
12. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\gwt\schedulingdialogs\messages:
• filechooser_messages_supported_languages.properties
• mantleMessages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
 
13. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\messages:
• messages_xx.properties
14. Add an entry for your language to the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\dashboards\resources\messages:
• messages_supported_languages.properties
 

Translating Interactive Report Parameters

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\help:
• messages_xx.properties
 
2. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\messages:
• launchermessages_xx.properties
• messages_xx.properties
 
3. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\messages:
• launchermessages_supported_languages.properties
• messages_supported_languages.properties
 
4. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\web\filterdialog\messages:
• filechooser_messages_xx.properties
• filterdialog_xx.properties
• LoginMessages_xx.properties
• WidgetsMessages_xx.properties
 
5. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\web\filterdialog\messages:
• filechooser_messages_supported_languages.properties
• filterdialog_supported_languages.properties
• LoginMessages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
 
6. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\schedulingdialogs\messages:
• filechooser_messages_xx.properties
• mantleMessages_xx.properties
• WidgetsMessages_xx.properties
 
7. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\pentaho-interactive-reporting\resources\schedulingdialogs\messages:
• filechooser_messages_supported_languages.properties
• mantleMessages_supported_languages.properties
• WidgetsMessages_supported_languages.properties

Translating Common UI Properties

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy and rename (with your language code) the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\common-ui\resources\messages:
• messages_xx.properties
The entry in this file should not be localized!
 
2. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\common-ui\resources\web\dataapi\nls\messages:
• messages_xx.properties
 

Translating Data Access Properties

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\data-access\resources\gwt\messages:
• filechooser_messages_xx.properties
• LoginMessages_xx.properties
• WidgetsMessages_xx.properties
 
2. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\data-access\resources\gwt\messages:
• filechooser_messages_supported_languages.properties
• LoginMessages_supported_languages.properties
• WidgetsMessages_supported_languages.properties
 
3. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\data-access\resources\messages:
• messages_xx.properties
 
4. Add an entry for your language to the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\data-access\resources\messages:
• messages_supported_languages.properties
 
5. Locate, copy, rename (with your language code) and translate the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\data-access\resources\gwt:
• biserverconfig_xx.properties
• cubeForms_xx.properties
• databasedialog_xx.properties
• datasourceAdminDialog_xx.properties
• importDialog_xx.properties
• main_wizard_panel_xx.properties
• measuresForm_xx.properties
• datasourceSelectionDialog_xx.properties
• modeler_xx.properties
• publish_xx.properties
• reportingForms_xx.properties
6. Add an entry for your language to the following property files, in:
<orchestra_installation_directory>\pentaho-solutions\system\data-access\resources\gwt:
• databasedialog_supported_languages.properties
• datasourceAdminDialog_supported_languages.properties
• datasourceSelectionDialog_supported_languages.properties
• importDialog_supported_languages.properties
• main_wizard_panel_supported_languages.properties
• modeler_supported_languages.properties
 

Translating General Reporting Folder Properties

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\system\reporting\reportviewer\messages:
• messages_xx.properties
 

Translating Hardware Monitoring Overview Page

In the description below, xx should be replaced by the two letters in your language code, for example es for Spanish.
1. Locate, copy, rename (with your language code) and translate the following property file, in:
<orchestra_installation_directory>\pentaho-solutions\qmaticbi\Orchestra Hardware Content\Dashboards:
• messages_xx.properties
2. Open the Business Intelligence application in Orchestra and select Show Hidden Files in the View menu.
3. Select Browse Files and browse to public\Orchestra Hardware Content\Dashboards.
4. Click Upload and upload the messages_xx.properties file that you created in step 1.
5. Introduce the following JSON property file to <orchestra_installation_directory>\system\pentaho-solutions\system\pentaho-cdf-dd\lang\qmatic folder, to localize Jquery database table labels:
• messagesTable_xx.json
Localization files used in the Overview page will be cached in <orchestra_installation_directory>\system\pentaho-solutions\system\penaho-cdf-dd\tmp\.cache. Delete this after updating the localized text.
Jquery datatable localization files can be downloaded from http://cdn.datatables.net/plug-ins/1.10.7/i18n/.

Canned Reports

The canned reports are translated with a properties file, located in the *.prpt file for the report. You use report designer to translate the report. If you need assistance, please contact Professional Services or the Support organization.
If you want to translate the name of a canned report to a language, such as Arabic, or a language using Cyrillic characters, follow these steps:
1. Download the canned report from Orchestra Business Intelligence.
You will get a zip-file called <report_name>.prpt.zip. This zip-file contains three files:
• <report_name>.prpt
• <report_name>.prpt.locale
• exportManifest.xml
2. Open the file <report_name>.prpt.locale and edit the parameter file.title, as in the following example (this example is for the canned report Service Summary):
#Locale = default
#Thu Dec 10 11:50:45 IST 2015
file.title=\u0645\u0644\u062e\u0635 \u0627\u0644\u062e\u062f\u0645\u0629
title=service_summary
file.description=
Note that the file.title must be written in Unicode! A useful tool for converting your language to Unicode can be found here:
https://www.branah.com/unicode-converter.
3. Zip the files and upload the report to Orchestra Business Intelligence again.

Special Characters when using JBoss

If you are using Application Server JBoss, and are translating to a language that uses special characters, you need to follow these steps:
1. Stop the JBoss Application Server.
2. Locate the following file:
<Orchestra_installation_directory>\system\app\jboss-eap-6.3\standalone\configuration\standalone-full.xml
3. Add the following property to the file:
<system-properties>
<property name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/>
</system-properties>
4. Restart the Jboss Application Server.