To enable multiple language support in Kyvos Reporting, ensure that both the Kyvos Reporting server and portal run in UTF-8 mode.

You can configure the Kyvos Reporting server and portal to run in UTF-8 mode as per the instructions in the previous chapter.

This chapter explains the localization configurations required on the Kyvos Reporting Server.

Language Bundle File on Report Server

Kyvos Reporting Report Server refers to the language bundle file for conversion information when a report’s source data is in English, but the report output is required in a selected local language.

The Report Server treats every piece of data coming from the database as a “key” and attempts to find the matching “value” (key-value pair) in the language bundle file. Therefore, the language bundle file on the Report Server must contain all possible keys (data values that may come from the database) and their corresponding values for the selected language.

Tabs on the Language Bundle File on Report Server

Information in the report server language bundle file is distributed across multiple sheets:

• Base: This sheet (which must be called "Base") contains the translation information (key-value pairs) that applies to all reports deployed across all categories.

• CategoryName: This sheet contains translation information (key-value pairs) for reports in a specific category (folder). For example, to translate reports deployed in the “EmpReps” category, name the sheet "EmpReps" and include the key-value pairs for that category.

• CategoryName_ReportName: This sheet contains translation information (key-value pairs) for a specific report within a category. For example, to translate the “SalaryRep” report in the “Finance” category, name the sheet "Finance_SalaryRep" and specify the key-value pairs for that report.

In all of these sheets, column A contains the keys, and column B contains the corresponding values. The key is the phrase that appears in the report, and the value is the string with which the phrase will be replaced.

Location

The language bundle file is placed on the machine running the Report Server at the following path:

<Kyvos Reporting installation path>\kyvosreporting\ReportEngine\resourcebundles

Kyvos Reporting identifies these files by their file names. For example, ja_JP.xls is the language bundle file for key-value pairs in Japanese.

Setting the "Text Output Encoding" Property in Report Server

When Kyvos Reporting is run in multi-language mode, the Kyvos Reporting Server must use UTF-8 file encoding (by setting the FILE_ENCODING in the run.bat file, which is used to launch the Kyvos Reporting Report Server).

Kyvos Reporting supports output generation in various formats, including CSV, Text, and Raw-Text. If programs that open such files do not support UTF-8 encoding, you can override the encoding specified by the FILE_ENCODING in the run.bat file.

To change the encoding for reports generated in text-based formats (Text, CSV, or RAW-TEXT), set the value of the Report Server property Text Output Encoding (Navigate to > Administration > Configure > Server > Rendering) to the desired encoding.

Report Output Localization

Localized Data from Database

If the database already contains localized content (i.e., data in a non-English script), follow these steps to ensure the Kyvos Reporting Report Server generates reports in that language:

• If the text editor used to open a report in text-based formats (Text, CSV, or Raw-Text) does not support UTF-8, specify the required encoding by setting the value of the Text Output Encoding property (Navigate > Administration > Configure > Server > Rendering).

• During report design, use Unicode-compatible fonts, such as Arial Unicode MS. For ad hoc reports, ensure that all templates use Unicode-compatible fonts.

In this case, the language bundle file for the Report Server is not required.

Localizing Labels on Reports

Labels are static text controls in reports. These are typed in during report design and do not come from the database. To localize these static text controls, follow the steps below:

• If the text editor used to open reports in text-based formats does not support UTF-8, set the Text Output Encoding property to the required encoding.

• Use Unicode-compatible fonts like Arial Unicode MS during report design. For ad hoc reports, ensure that all templates use these fonts.

In this case, you will need to create a language bundle file containing key-value pairs for all static text controls used in the report. This file will be placed on the Report Server.

Localized Report Data (English Data, Localized Output)

If the report data comes from a database with English values, Kyvos Reporting Report Server can generate output in any of the configured languages.

To localize the output of such a report:

• Set the Text Output Encoding property as required.

• Use Unicode-compatible fonts like Arial Unicode MS during report design. Ensure that all ad hoc report templates also use these fonts.

Set the Applyi18forDataFields report-level property in Studio to True (by default, this is set to False).

• True: The Report Server translates the report data from English to the selected language based on the user's language setting at login.

• False: The Report Server does not translate report data before generating the report output.

You will also need to create a language bundle file for all possible values that may appear on the report. This file will be placed on the Report Server.

You can translate the report title, name, header, grouping details, and output, as well as label captions on controls like charts and matrices.

Localizing Email Messages

Email message notifications in Kyvos Reporting can be localized by creating a folder with the locale name (for example, zh_CN for Simplified Chinese) under the following path:

<Kyvos Reporting installation path>\Kyvos Reporting\ReportEngine\Config\messages\mails

Store the translated message text files in this folder, ensuring they are saved using UTF-8 encoding.