Adding Multi-lingual Prompts to Input Controls

This documentation is an older version of JasperReports Server User Guide. View the latest documentation.

This section describes how to create an Ad Hoc report that prompts for input in multiple languages. The tasks are:

•

Set the base name of the resource bundles in the JRXML Topic.

•

Create resource bundles that contain translations for the prompts.

•

Create an Ad Hoc report based on the JRXML Topic.

•

Edit an input control to make prompts multi-lingual.

•

Upload the resource bundles.

•

Run the report and use the localized input control.

The order of these tasks is important: Set the base name of the resource bundle in the JRXML Topic first, then create the Ad Hoc report. If you open the JRXML Topic after creating an Ad Hoc report, Jaspersoft Studio removes grouping or sorting of data if there is any.

To set the base name of the resource bundles in the JRXML Topic:

Start Jaspersoft Studio. In Jaspersoft Studio, click Window >JasperReports Server Repository. The Repository Navigator appears. This is where you set up a connection to the server.

Navigate to Ad Hoc Components > Topics and right-click the JRXML topic for this report: Parametrized Report.

Select Copy.

Navigate to the Reports folder, right-click and select Paste. The Parametrized Report topic appears in Reports.

To open the topic in the Designer tab, expand the Parametrized Report folder and double-click its main JRXML: ParametersJRXML_label. The Shipping Report appears in the Designer tab.

Click Window > Report Inspector.

In the Report Inspector, right-click the root node: ParamMany and choose Properties. In the main JRXML, ParamMany is the report name.

In “Selecting Properties of the ParamMany report”, you can see the ParamMany root node and Properties context menu.

Selecting Properties of the ParamMany report

In the ParamMany Properties dialog, set the base name of the resource bundle to freight:

Scroll down to the Resource bundle property.

Click

Enter freight and click OK .

In “Setting the Base Name of the Resource Bundle”, you can see the properties of the ParamMany report.

Setting the Base Name of the Resource Bundle

Click Close.

10.

Click File > Save to save the resource bundle name to the JRXML.

11.

In the Repository Navigator, right-click ParametersJRXML_label and choose Replace with Current Document.

Saving the Current Document in iReport to the Repository

The modified JRXML with a base resource bundle name overwrites the Parametrized Report Topic in the repository.

To create resource bundles that contain translations for prompts:

In a text editor, create a new file for English translations.

Enter these name-value pairs in the file:

Save the file as freight.properties.

The file name of the default (English) resource bundle consists of the base name of the resource bundle and the properties extension.

In a text editor, create a new file for French translations and enter these name-value pairs in the file:

Save the file as freight_fr.properties.

The file name of a localized resource bundle follows this Java naming convention:

<default_file_name>_<locale>.properties

•

<default_file_name> is the base name of the resource bundle

•

<locale> is a Java-compliant locale identifier

To create an Ad Hoc View based on the JRXML Topic:

Log into the server as administrator, and choose Create > Ad Hoc View.

In the Select Data wizard, click

Click Table. The Parametrized Report topic (a blank report) opens in the Ad Hoc Editor.

In the Measures list, double-click these fields:

•

Order ID

•

Freight

In the Fields list, right-click Customer Id and select Add as Group.

Click Click to add a title and enter Multi-lingual Input Prompts View.

Creating an Ad Hoc View

Click

•

Data View Name: Multi-lingual Input Prompts View

•

Data View Description: A report that prompts for input in French and English.

•

Report Name: Multi-lingual Input Prompts View Report

Browse to a location to save both the view and report.

Click Default Report Template.

10.

Click Save.

To edit an input control to make prompts multi-lingual:

In the server, click View > Repository.

Locate the Multi-lingual Input Prompts View Report, right-click it, and choose Edit. The JasperReport wizard appears.

Click Controls & Resources. The Controls & Resources page lists these input controls:

•

Country

•

RequestDate

•

OrderID

Click the Country input control.

On the Locate Input Control page, click Next to define an input control in the next step.

On the Create Input Control page, change the prompt text from Country to this expression:

$R{BundleCountry}

In “Entering a $R Expression in the Prompt Text Field” this expression is entered in the prompt text field.

Entering a $R Expression in the Prompt Text Field

Click Next.

Accept the default settings on subsequent pages by clicking Next and Save:

On the Locate Query page, click Next.

On the Name the Query page, click Next.

On the Link a Data Source to the Query page, click Next.

On the Define the Query page, click Save.

On the Set Parameter Values page, click Submit.

The Controls & Resources page now shows the $R{BundleCountry} expression instead of Country at the top of the list of input controls.

Input Controls Include One Multi-lingual Input Control

10.

Change the prompt text of the other input controls in a similar manner:

Repeat step 6 to change the RequestDate and OrderID input controls to these expressions:

RequestDate: $R{BundleDate}

OrderID: $R{BundleOrder}

Accept the default settings on subsequent pages of the JasperReport wizard by clicking Next and Save. The Controls & Resources page now shows the $R expressions for all three input controls.

To upload the resource bundles:

On the Controls & Resources page, click Add Resource. The Locate File Resource page appears.

Select Upload a Local File.

Click Browse, select the freight.properties file, and click Open.

On the Locate File Resource page, click Next.

On the Add a Report Resource page, freight.properties appears as the Selected Resource, indicating that the server automatically detected it as a resource bundle.

On the Add a Report Resource page, enter these properties:

•

Name – freight.properties

•

Resource ID – freight.properties

•

Description – Default English resource bundle

Click Next. The list of resources on the Controls & Resources page now includes the resource bundle freight.properties.

On Controls & Resources, click Add Resource again, but this time upload the French resource bundle:

On the Controls & Resources page, click Add Resource again.

Select Upload a Local File, click Browse, select the freight_fr.properties file you created, and click Open.

In Locate File Resource click Next. The Add a Report Resource page appears.

Enter the following information:

•

Name – freight_fr.properties

•

Resource ID – freight_fr.properties

•

Description – French resource bundle

Click Next. The Controls & Resources page shows the English and French resource bundles in the resources list.

Click Submit.

To run the report and use the localized input control:

Click Log Out.

On the Login page click Show locale & time zone.

Select the en_US-English (United States) locale and log into the server as an administrator.

Run the Multi-lingual Input Prompts Report. The report appears in the report viewer.

Viewing the Report in English

Click Options.

The input controls appear with English prompts.

Click Log Out.

On the Login page, click Show locale & time zone.

Select the fr - French locale, and log in as administrator.

Run the report again and click Options.

In “Input Control Prompts in English and French”, you can see the input controls that with English and French prompts.

Input Control Prompts in English and French

resources: bundles

Followers 0

Go to documents

User Feedback

0 Comments

Recommended Comments

There are no comments to display.

This is now closed for further comments

Sign In

User Feedback

Recommended Comments

Activity

Products

Explore