NLS at Application Level
In Logi Report Server, a folder "resources" is added in the installation root directory for holding language resources. The resources are classified into two types, language packages and resources for Logi Report Engine. To make Logi Report Server display in your desired language completely, you need to create the language files for these two types of resources respectively.
When creating a WAR/EAR file to include a Logi Report Server, the languages.jar which packs all language resources in the
<server_install_root>\resources directory will be generated and included for the multiple language support. The languages.jar makes sure the server UI text is displayed correctly after deploying the WAR/EAR to other application servers.
Below is a list of the sections covered in this topic:
- Creating Language Packages
- Creating the Logi Report Engine Language Resource Files
The language packages hold almost all the UI text and messages available in Logi Report Server (including Logi Report Server console, Page Report Studio, Web Report Studio, JDashboard and Visual Analysis). When a language package is applied, the UI will be displayed in the language specified in the language package. When there are more than one language packages, you can select the one you are familiar with for your own convenience as the Logi Report Server environment language. For example, if you are a German you may be glad to apply the German language package.
Currently Logi Report provides only the English language packages "en" and "en-us" for the English version. However, Logi Report accepts user-customized language packages and can recognize and load them if they are correctly specified.
In each language package, there are three property files which together contain all UI text and messages in Logi Report Server:
This property file stores some common UI text all over Logi Report Server (including Logi Report Server console, Page Report Studio, Web Report Studio, JDashboard and Visual Analysis) in the specific language.
This property file stores UI text and messages referred by Page Report Studio, Web Report Studio, JDashboard and Visual Analysis in the specific language.
This property file stores UI text and messages referred by Logi Report Server console in the specific language.
The language package is stored in the
The structure is:
Note: One additional property file can be translated for users of Logi Report Monitor. The file is monitor.properties in the
To add a language package, follow the steps below:
- Browse to the
- Create a folder named for the new language. The folder name should keep to ISO language and country code naming criterion.
- Copy the properties folder in the existing
<server_install_root>\resources\server\languages\endirectory to the new folder.
- Modify the three property files: common.properties, dhtml.properties, and server.properties in the new folder by translating all the text and messages after "=" to the new language.
- Save these property files with UTF-8 encoding.
- Convert the contents in the three property files into Unicode using native2ascii.exe in the
<jdk_install_root>\bindirectory by running the following line in the Command Console:
C:\jdk1.8.0\bin>native2ascii -encoding utf-8 common.properties >newcommon.properties
C:\jdk1.8.0\bin>native2ascii -encoding utf-8 dhtml.properties >newdhtml.properties
C:\jdk1.8.0\bin>native2ascii -encoding utf-8 server.properties >newserver.properties
Note: When you convert your property files to the same directory as the original ones you need give them new names instead of replacing the original in order to avoid problems.
- Rename the original property files, you may want to modify them more at a later time.
- Change the names of the generated property files back to the same names as the original property files: newcommon.properties to common.properties, newdhtml.properties to dhtml.properties, and newserver.properties to server.properties.
- Restart Logi Report Server.
The folder name should be lower-case codes.
The language argument is a valid ISO Language Code as defined by ISO-639. You can find a full list of these codes at a number of sites, for example: http://www.loc.gov/standards/iso639-2/php/code_list.php.
The country argument is a valid ISO Country Code as defined by ISO-3166. You can find a full list of these codes at a number of sites, for example: http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html.
The variant argument is a vendor or browser-specific code. For example, use win for Windows, mac for Macintosh, and posix for POSIX. Where there are two variants, separate them with an underscore, and put the more important one first.
When the language packages are created, you can specify which of them will be applied to your server. There are two ways to specify the default language package:
There is an option Specify Default Language in the server profile for you to switch the language. The available language list depends on the language packages in
To specify the language in the server console:
Make a choice according to your user account:
- Any one can configure for himself: go to the My Profile > Customize Server Preferences > Advanced tab and set a language.
- Administrators can configure for all users: go to the Administration > Server Profile > Customize Server Preferences > Advanced tab and set the default language for all users.
You can also control the UI language by the property jrs.language when accessing the Logi Report Server console or Page Report Studio via URLs.
Note: The specified language by URL property has higher priority than that specified by UI option; however, it takes effect only in the current user session.
The Logi Report Engine language resources are saved in the following files in the
<server_install_root>\resources\common\resource directory: JRError.properties, JRMessage.properties, JVMessage.properties and JVMisc.properties. To create the files in a specified language, follow the steps below:
- Save the files with new names which contain the ISO language and country code suffix in the same directory (for more information, see the above naming criterion). For example, if you want to create the French language files, save them as JRError_fr_FR.properties, JRMessage_fr_FR.properties, JVMessage_fr_FR.properties and JVMisc_fr_FR.properties.
- Translate all the text after "=" in the newly saved files to French.
- Save the files with UTF-8 encoding.
- Convert the contents in the files into Unicode and rename them to the original ones with the language and country suffix.
- Restart Logi Report Server.
Which language resource files will be applied depends on the language and locale settings of your system.