Localisation Keys

Localisation keys are the different values in a localisation set.

A unique localisation key is assigned to specific items in On Key, which is then linked to a localisation set. Each localisation set can therefore have many localisation keys.

You have the ability to create translations for each localisation key, as needed, based on the languages that have been added to the system. A localisation key, such as the phrase "Replace Bearing", for example, can be translated into each language you've configured in the master data. Each localisation key can therefore have multiple translations.

You can configure a table of localisation keys that can be used to translate phrases, messages, UI elements and value lists into the languages that are used by your organisation.

By default, On Key has localisation keys for certain phrases already in the database, with translations. You can add more translations to these localisation keys in the languages required.

Refer to Languages and Localisation Sets for more information.

Configuring Translations

Translations are set up the localisations master data. The process is as follows:

1. If your first language is not in On Key's predefined list of languages, then add additional languages that will be used to create your own translations.
2. Define the Text to be translated, which is the localisation key, and link it to a localisation set.
3. Create translations for each localisation key, as needed, based on the languages that have been added to the system.

Translation Implementation in On Key

The user will see On Key in the language that's set as the default language. You can change the default language and view On Key in a translated version by clicking in the menu bar. Then, click Language and select the applicable language. When the language is changed, you will be prompted to reload the screen in order to see the translated version. Translations must be configured in the localisations master data before the translated version can be displayed in On Key.

The translations functionality is available for UI and phrases localisation sets. Where translations are applied for UI localisation sets, the UI labels and titles within a specific module will be changed to your custom translation.

Where translations are applied for phrases localisation sets, the Description and Notes fields will be greyed out and the Translate toggle switch above these fields will be active. This indicates that a translated version is being displayed, in which case the text in those fields are in a translated, read-only state and cannot be edited. To edit the text in these fields, switch to an untranslated version by toggling the Translate switch to an inactive state, where it no longer displays blue. You are then able to add more text to the fields.

The text in the braces { } is the localisation key that is included in the translation. If the text inside the braces is updated, then the translation might not work since the localisation key no longer matches what was defined in the master data. If you want the additional detail that was added to be translated as well, then the associated localisation keys and translations must be set up in the master data first before it can be applied in the system.