Customizing messages and text according to locale
Error messages and text for Information Console are encoded in resource files compressed in the <context root>/WEB-INF/lib/resources.jar file. The properties files contain entries for the interface text and error codes Information Console generates.
For reference, the <context root>/WEB-INF/ErrorMessage.txt file lists the default error codes used by Information Console. The \com\actuate\reportcast\resources\ErrorMessages.properties file within the resources.jar archive contains error messages for the default locale. Information Console uses messages from this file if no locale-specific message for the error exists. Not all of the codes exist in the default ErrorMessages.properties because iServer directly generates many of them in the SOAP messages sent to Information Console.
Override iServer and Information Console messages using a locale-specific error messages file. In addition to the default ErrorMessages.properties file, Information Console provides several localized error message files, such as ErrorMessages_de_DE.properties. This file contains the German language messages for the Germany locale. To specify error messages to a certain locale, modify the existing error message file for that locale or create a new file for the locale. By convention, the format of a locale-specific error message file name includes the language and locale codes at the end of the file name separated by underscore characters.
These values for language and locale codes are defined in localemap.xml.
Because alphabets for different languages are dissimilar and Information Console uses ASCII encoding for these files, you must convert new or edited files into ASCII format. To convert the files to ASCII, modify the properties file using an editor that saves to the UTF-8 format and convert the file to ASCII using the Java native2ascii utility using the -encoding UTF-8 switch. The native2ascii utility installs with any Java Developer Kit in the <JDK home>/bin directory. Model the format of new messages after those in the ErrorMessage.properties file.
When your modifications are complete, recompress the resources.jar archive using the Java jar utility, retaining the original directory structure for the archive. Copy the new resources.jar file to the <context root>/WEB-INF/lib directory, restart the Apache Tomcat for Actuate Information Console 11 service, and log in using the locale for the modified messages file. Confirm that the new messages file was loaded by examining the error messages generated by Information Console using that specific locale.
Error messages appear in pop-up windows when an error is encountered. The window is an operating system window, not an HTML frame. If you use a language-specific version of Windows corresponding to the locale you are viewing, the localized message shows up correctly. If you have not loaded the Windows language pack for a language, the text of a message appears as empty squares instead of text.
| (c) Copyright Actuate Corporation 2011 |
|