The text displayed in Kyvos Reporting portal components comes from language bundle files. These files contain a key-value pair for each text element, such as captions, combo box options, error messages, 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