From the Language Setting page, you can add a new language for Kyvos Manager and Kyvos that gives you support for language selection at different levels like browser session, user preference, system default, and default in code. There will be different levels of language selection available:
Login page: This is applicable for the current browser session
User preference: This is applicable if the language is not set in the browser and for REST interaction.
System Default: This applies to all users if no preferred language is selected from Preference.
en_US (English): This language is set when the above levels are not set for language.
The "Use default” option indicates that you have not explicitly selected any language for the current browser session.
In that case, the user’s preference language will be used after login. If you have not saved any language preference, then the language set at the system level is used. Lastly, if no language at the system level is set, then the default English (en_US) will be used.
You can upload/download/delete any language without the need to access the node/machines and the internal folder structure of any Kyvos component like Kyvos Web Portal, BI server, commons, or Kyvos Manager.
Structure of the language file bundle (tar file) to be uploaded/downloaded
The same structure must be downloaded for any existing language file bundle.
One language bundle(tar) file can be uploaded/downloaded at a time.
Name of each language file should be in predefined format within its respected folder. The convention used for naming file must be locale_Country.json. For example, en_US.json, en_GB.json, fr_FR.json etc.
During the upgrade of Kyvos and Kyvos Manager application, the additional language files will not be preserved and must be updated manually after the application upgrade.
Adding a new language
To add a new language, perform the following steps.
Click Utilities > Language Settings on the navigation pane.
The Language Settings page is displayed.
Click Add New Language. The Add New Language dialogue is displayed.
Select the required language from the Language list.
Select the file from your local machine and Upload it.
After uploading the language tar file, you must restart Kyvos Manager and Kyvos applications.
Select the Kyvos Manager and Kyvos checkboxes to restart the application.
Enter your Kyvos Manager password.
Click Add. The new language has been added. The language that you added will be reflect on the login page and user’s preference.
Modifying the added language
You can modify the TAR file of the language at any point in time.
To modify the added language, perform the following steps.
On the Language Settings page, in the Supported Language section, hover the language and click the three dots action menu (…).
Click Update Language.
The Update Language dialog is displayed.
Select the TAR file from your local machine and Upload it.
After uploading the language tar file, you must restart Kyvos Manager and Kyvos applications.
Select the Kyvos Manager and Kyvos checkboxes to restart the application.
Enter your Kyvos Manager password.
Click Update. The new language has been added. The language settings have been updated.
Deleting the added language
You can delete the added language at any point in time other than the system default language, which is English.
To modify the added language, perform the following steps.
On the Language Settings page, in the Supported Language section, hover the language and click the three dots action menu (…).
Click Delete Language.
The Delete Language dialog is displayed.
Enter your Kyvos Manager password and click Delete. The language has been deleted. You must restart Kyvos Manager and Kyvos to come in effect.
The process of updating the additional language file should be
Before the upgrade, customer /Kyvos-support should take the backup of additional language bundle files (By downloading the same from Kyvos Manager UI). There should be a note in KM upgrade screen to remind user of this.
During the upgrade process, the additional language bundle files are not preserved.
After the upgrade, customer/Kyvos-support should download the English language bundle file from Kyvos Manager UI
Use the English bundle files as source, find the changes (addition/deletion/modifications of key/value pair) in each file and translate them in their own language files
Upload the updated language bundle zip from Kyvos Manager.
In case the user forgets to perform this action, there will be an on-screen notification generated in KM application to remind upload of language bundle to user.
Single language bundle (tar file) uploaded/downloaded must contain language files for all the Kyvos components, i.e., web UI, BI server, commons, and Kyvos Manager.
You must ensure the correctness of uploaded files.
Since the language bundle files are loaded by the components at the time of bootup and then they are cached, so adding/deleting/updating language needs the components to restart.