JasperServer and iReport Internationalization Tutorial

The concept of internationalization is the same across JasperServer UI, reports, and Domains. In order to understand the concept of internationalization, first review the concept of bundles, which is a key building block.

• A locale bundle is a text file that contains a key and its value.
  •  Example: ADH_003a_TABLE=Table indicates that the object ADH_003a_TABLE will be displayed as “Table” to the user.
• The name of this file must follow the following format:

Name_Suffix.properties

• Name: Name of your ‘bundle’
  •  Choose a name that describes what the bundle is related to
  • Example:  adhoc_messages
• Suffix: Country code your language uses
  •  How the system will find which translation to choose according to the language the user selects
• .properties: Mandatory extension for bundles

Notes:

• A missing key may cause a failure in the system. You must have ALL keys specified in the bundle file even if not all keys have a value
• A bundle file without a suffix means is used as default in the event that the system does not find a bundle for the specified language

All properties files are organized by application name for easy access.

Example: Edit adhoc_messages_fr.properties file as follows, (located in the folder you downloaded above) and then save it.

Check the result:

a.     Log into JasperServer as jasperadmin / jasperadmin.
Note: Make sure to click the locale and time zone link and specify the appropriate locale.
In this example, we specify French.

b.     Go to Create > Ad Hoc Report

You should see the following: on the left side the original translation, and on the right the modified one

Tip: Internationalization can be used for formatting of dates and numeric values.

Edit the adhoc_masks_XX.propeties file to define additional translations. 

Rename (use Save As) the file to: adhoc_messages_da.properties

Edit the file as follows in the image below:

3

Create a new entry for your language:

a.     Stop JasperServer

b.     Go to the …\jasperserver-pro\WEB-INF directory

c.     Edit the file ApplicationContext-Security.xml

d.     Localize the bean (approx line 176):

<beanid="userLocalesList"class="com.jaspersoft.jasperserver.war.common.LocalesListImpl">

<property name="locales">

<list>

e.      Add your language in the list: 
<value type="java.util.Locale">da</value>

a.     Start JasperServer

b.     Go to the login page select the new language

c.     Click Show locales and timezone to display the list

a.     Log into JasperServer as jasperadmin / jasperadmin

b.     Go to Create > Ad Hoc Report

c.     View the result:

a.     Log into JasperServer as jasperadmin / jasperadmin

b.  Go to View > Repository 

a.     Select the Domain folder

b.     Click the Add Resource > Domain icon

c.     In Data Source section, click Browse, then select Organization  > Analysis Components Analysis Data Sources > Foodmart Data Source

d.     Click OK

e.     In the Properties section, Display Name field, enter: employee_domain

f.      In the Design section, click the Upload tab, then select the provided file (domain_schema.xml)

Launch the Domain Designer

a. Select the Edit tab.

b. Click Launch Domain Designer …

c. In the top-right corner click the Export Bundle Stub icon

The following window appears: check the Autogenerate Key label box to get the labels keys

Optionally, check the Autogenerate Key description box if you wish to generate a description

This will generate all the keys needed to create the bundle.

Download the file and save it to your drive

Best Practice:  Change the name to the Domain’s name

Example: Rename it to: employee_domain.properties

The initial export will serve as the default translation.  Additionally, we will define a French translation.

Example: Translate the bundle into French and save it as employee_domain_fr.properties

Publish the translation to JasperServer:

a.     Log into JasperServer as jasperadmin / jasperadmin

b.     Go to View > Repository

c.     Select the Domain folder and then the Domain “employee_domain”

d.  Right click and choose Edit

a.     On the Local File tab, find the employee_domain.properties and upload it.

b.   Click OK

Check your results:

a.     Log into JasperServer as jasperadmin / jasperadmin

b.     Go to Create > Ad Hoc Report

c.     Create a new Ad Hoc report using your new Domain 

Note: Make sure to specify the appropriate locale.

Create a new empty report.

a.     Add a text field $R{hello}

b.     In the Report Inspector, right click on report name then select Properties.

c.     In resource bundle set Resource Bundle to localereport

• This represents the base name of the local bundle to use; you do not have to add the extension.

d.    Create the localereport.properties file: Hello=Hello word

Translate the text as required, and save it as localereport_fr.properties: Hello=Bonjour a tous

Once the report is published, open the report unit, right click on the Resources folder, then choose Add > Resource Bundle

Complete the Import Resource screen the form as follows; ensure you provide the full name.

>

Repeat this for all languages using the example: localereport_fr.properties