Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To get enable multiple language support in Intellicus you need to make sure Intellicus (Kyvos Reporting, ensure that both the Kyvos Reporting server and portal ) runs run in UTF-8 mode.

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

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

Language Bundle

...

File on Report Server

Intellicus Kyvos Reporting Report Server refers to this the language bundle file for conversion information when a report’s source data of the report 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 tries attempts to find the matching “value” (key-value pair) in the language bundle file. SoTherefore, the language bundle file on the Report Server needs to have must contain all the possible keys (data values that may come from the database) and their corresponding values to be used for the selected language.Figure 13:

Tabs on

...

the Language Bundle File on Report Server

...

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

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

  • CategoryName (the actual category name): This sheet contains translation information (key-value pair) that needs to be applied to the pairs) for reports in a specific category (folder) identified by the sheet having respective category name. For example, to translate reports deployed in the “EmpReps” category, specify sheet name as “EmpReps” and specify name the sheet "EmpReps" and include the key-value pairs on for that sheetcategory.

  • CategoryName_ReportName (the actual category name+underscore+actual report name): This sheet contains translation information (key-value pair) that needs to be applied to the “ReportName” deployed under “CategoryName”pairs) for a specific report within a category. For example, to translate the “SalaryRep” deployed under report in the “Finance” category, create a sheet with name “Finance_SalaryRep” name the sheet "Finance_SalaryRep" and specify the key-value pairs on for that sheetreport.

For In all the above of these sheets, key is specified in column A and value is specified in Column B. Key contains the keys, and column B contains the corresponding values. The key is the phrase that will be found on report. As specified above, appears in the report, and the value is the string with which the phrase will be replaced with.

Location

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

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

Intellicus 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.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

Information in the language bundle file is cached

...

when the Report Server starts. Restart the Report Server when you add a new language resource bundle file

...

.

Setting

...

the "Text Output Encoding" Property in Report Server

...

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

Intellicus Kyvos Reporting supports output generation in various formats, including CSV, Text, and Raw-Text. Programs that may be used to If programs that open such files may do not support UTF-8 encoding. If that is the case and you are aware that encoding those programs are configured to read, you can override the value set encoding specified by the FILE_ENCODING in the run.bat file.

To change the encoding for report reports generated in any of the text-based output types formats (Text, CSV, or RAWTEXTRAW-TEXT), set the value of the Report Server property Text Output Encoding (Navigate to > Administration > Configure > Server > Rendering) to the one you need.

Figure 14: Setting value of Text Output Encoding

...

desired encoding.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

This property is hot

...

-deployed, meaning you do not need to restart the Report Server to

...

apply the

...

new setting.

Info

Important

...

To

...

ensure these configurations remain intact

...

during an upgrade

...

:

...

  • Do not allow the configuration files

...

  • to be overwritten during version

...

  • upgrades or

...

  • patch

...

  • applications.

...

  • Keep a backup of the configuration files

...

  • in case the upgrade instructions require

...

  • overwriting, so you can

...

  • merge your custom entries into the new files.

Report

...

Report getting localized data from database

Report data comes from the database. If this database already has localized content (content in script other than English), then you need to do following to make sure Intellicus Report Server generates such reports in that language.

...

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, you will not need report server the language bundle file for the Report Server is not required.

To localize labels on report

...

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 such these static text controls, you need to follow the steps below steps.:

  • 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 also will need to create a language bundle file having containing key-value pair pairs for all static text controls used in the report. This file will be placed on the Report Server.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

Restart the report server and portal after making configuration

...

changes

...

.

Localized Report

...

Data (English

...

Data, Localized Output)

If the report data comes from a database having with English values in English, Intellicus report server , Kyvos Reporting Report Server can generate output of such a report in any of the language configured in Intellicuslanguages.

To localize the output of such a report, you need to follow the below steps.

If text-editor you use to open a report generated in text-based output types like (Text, CSV or RAW-TEXT) uses an encoding other than UTF-8, specify the required encoding by setting value of Report Server property Text Output Encoding (Navigate > Administration > Configure > Server > Rendering).

During report design, use fonts that support Unicode fonts, like Arial Unicode MS. For ad hoc reports, make sure all the templates use fonts that support Unicode fonts, like Arial Unicode MS.

Applyi18forDataFields – Report level property in Studio. Set value of this property to True.  By default this property is set to FALSE.

...

True: Based on the language user has selected at the time of login, Report server translate report data from English to respective language and that way generates the report output in selected language. For translation it uses the language bundle file placed on Report Server machine.

...

:

  • 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 having key-value pair for all possible values that may appear on the report. This file will be placed on the Report Server.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

Restart the report server and portal after making configuration

...

changes.

...

Changes will

...

only take effect after a server restart.

...

You can translate

...

the report title,

...

name,

...

header,

...

grouping details, and

...

output

...

To localize email messages

, as well as label captions on controls like charts and matrices.

Localizing Email Messages

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

<Intellicus installation path>IntellicusReportEngineConfigmessagesmails

Keep the translated messages text files under the above folder <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 Encodingencoding.