The text of displayed in Kyvos Reporting portal components comes from respective language bundle file. This file has one “key–value pair” for each piece of information appearing on portal – like caption names, options appearing in combo boxesfiles. These files contain a key-value pair for each text element, such as captions, combo box options, error messages, numbers, dates and months.

Intellicus identifies these files through their file names. For example, en_US.xls is the language bundle file for Key-value in English.

To localize a portal in a language, you need to create such a file for that language.

Portal bundle file has content in two sheets. One sheet needs to have name as “meta”. There is no name related requirement for other sheet of the file.

The sheet having name ‘meta’ contains the language name (that should be displayed in the drop-down) and the associated locale.

Figure 11: “meta” sheet of Portal’s language bundle file

...

Note: Don’t use the first row of the ‘meta’ sheet.

The other sheet (generally Sheet1) contains key-value pairs of text used on Intellicus Portal. When a key is found on the portal page, a corresponding value is searched from this sheet and displayed on the portal.

Figure 12: Sheet1 of a bundle file on Portal

...

Column A of this sheet contains all the keys. Column B of the same row contains respective values of that key-value pair.

Best way to create a language bundle file is:

1. Copy en_US.xls as the new file.

2. Change values in Column B of meta

3. Replace contents of Column B (of sheet having key-value pairs) with translated content.

4. Save the file (with the right file name).

File Name

<locale name>.xls

For example,

• For English to be used in United States, the file name should be en_US.xls

• For Spanish to be used in United States, the file name should be es_US.xls

• For Japanese to be used in Japan, the file name should be ja_JP.xls

Location

Language Bundle files are placed on machine running portal at path:

<Intellicus installation path>

IntellicusJakartawebappsintellicusclientlang

Note: Information in language bundle file is cached at report-server start up time.  Restart the report server when you add a language resource bundle file on the report server.

Points to remember while creating a language bundle file

...

Whichever version of MS Excel you use to create the language bundle file, remember to save the file as .xls file.

...

Each entry is a key-value combination. Key is used inside the program and value is displayed on screen. So, translate the values (entries in column B).

...

Generally, values are same as keys. The only difference is, for value, “_” is replaced by a space. In some cases (like 24hh-mm-ss), key is different than value (24hh:mm:ss).

...

If you encounter single-quote or a double-quote anywhere in the value, prefix it with a “\” .

...

%1, %2, etc. needs to be kept as it is. These are the values that will be replaced by actual values at run time.

...

“\n” in a value, means “next line”. If you notice two sentences separated by a \n, keep them that way, in order to carry the next sentence in the next line. Removing \n will make the next sentence continue on the same line.

...

etc. You need to create a language bundle file to localize the portal in a specific language.

Language Bundle File Structure

1. File Format: Each language bundle file is an .xls file with at least two sheets:

   • A sheet named meta for language metadata.

   • Another sheet (usually named Sheet1) containing key-value pairs for portal text.

2. Key Components:

   • Meta Sheet: Contains the display name of the language (as it will appear in the drop-down menu) and its associated locale.

   • Key-Value Sheet:

     • Column A: Contains the keys used by the program.

     • Column B: Contains the respective values (translated text) that will be displayed on the portal.

Steps to Create a Language Bundle File

1. Copy the existing en_US.xls file as a template.

2. Update the meta sheet:

   • Modify the values in Column B to reflect the new language and locale.

3. Update the key-value sheet:

   • Replace the contents of Column B with the translated values.

4. Save the file with the appropriate name:

   • Format: <locale name>.xls (e.g., ja_JP.xls for Japanese in Japan).

File Naming and Location

• File Name: Use the locale code (e.g., en_US.xls for English in the U.S.).

• Location: Place the language bundle file at the following path:

  <Kyvos Reporting installation path>/Jakarta/webapps/kyvosreporting/client/lang

Guidelines for Translating Key-Value Pairs

1. Key-Value Matching:

   • The program uses the key to identify text elements. The value (Column B) is what appears on the portal.

   • Typically, the value mirrors the key with underscores (_) replaced by spaces.

   • For exceptions (e.g., time formats like 24hh:mm:ss), ensure values align with their intended function.

2. Special Characters:

   • Prefix single quotes (') or double quotes (") with a backslash (\).

   • Keep placeholders like %1, %2 intact, as they are runtime variables.

   • Respect newline characters (\n) for multi-line text.

3. Lists:

   • Keys like DaysOfMonth, DaysOfWeek, etc., have comma-separated values. Ensure translated text maintains the same format and sequence.

Example: Meta Sheet Configuration

Example: Key-Value Sheet