Skip to main content
Version: 1.21.3

Localization and Multi-language Support

SimpleOne supports multilanguage localization. You can add the language you need and translate the interface elements accordingly. SimpleOne offers two languages out of the box: Russian and English.

You can localize the following elements:

You can upload translations into the system, set up links between the localized version and the original version.

tip

Role required: admin.

Add a language​

To add a new language, follow the steps below:

  1. Navigate to System Localization → Languages.
  2. Click New and fill in the fields.
    • In the Language field, specify the language code of localization. You can write no more than two symbols. Then fill in the Name field.
  3. Click Save or Save and exit.

Now you can refer to the Language (sys_language) table to build your localization. The language will also appear in the Preferences menu.

Localize interface elements​

Before starting the localization, check that all necessary languages are created in the Languages (sys_language) table.

You can localize fields of the Translated Text type in two ways:

  • by creating a record in the System Translations (sys_translation) table.
  • by switching the system language.

To add new translations, complete the steps below:

  1. Open the record for which you need to add a translation.
  2. Navigate to the Related Lists area.
  3. On the Translations tab, click New and fill in the fields.
  4. Click Save or Save and exit to apply the changes.
note

Another way to add localization via the System Translations (sys_translation) table:

  1. Navigate to System Localization → System Translations.
  2. Click New and fill in the fields.
  3. Click Save or Save and exit to apply the changes.

In this case, you should type the record ID manually.

System Translation form fields

FieldMandatoryDescription
ColumnYSpecify the column name containing the field that you need to translate.
LanguageYSpecify the language of the translation. The field references the records stored in the Languages (sys_language) table.
ValueNType the translation of the original value.
RecordYUnique ID number of the record. It is filled in automatically, if you translate via Related Lists of the record. If the ID field is empty, type the ID of the record.

To localize elements by switching the system language, perform the following steps:

  1. Open the record you need to translate.
  2. In the Preferences menu, change the language of the system to the localized one.
  3. Enter a new translation.
    • If the system language is English, type the new value in English.
  4. Click Save or Save and exit to apply the changes.

In the Related Lists area, select the Translations tab to check if the translation is saved correctly.

To add translations to a related list title, perform the following steps:

  1. Open any record form that contains the related list you need to localize.
  2. In the burger menu , select Configure → Related Lists → List Elements.
  3. Open the record you need. You can identify it by the Title field the current value of which is displayed on the form.
  4. Navigate to the Related Lists area.
  5. On the Translations tab, click New and fill in the fields.
  6. Click Save or Save and exit to apply the changes.

Choice list localization​

The localization of choice list options differs from the localization of any field of the Translated Text type. To localize a choice list, complete the steps below:

  1. Navigate to System Settings → Choice Options.
  2. Click New and fill in the fields.
  3. Click Save or Save and exit to apply the changes.

Translated choice option form fields

FieldMandatoryDescription
TableY

Specify the table to which this choice option is related.

Select the same table for the translated version as for the original one.

ColumnY

Specify the column to which this choice option is related.

Select the same column for the translated version as for the original one.

TitleYType the translation of the source option.
LanguageYSpecify the language code (ru, en, and so on). Language records are stored in the Languages (sys_language) table.
ValueY

Type the same value as specified for the source option.

Do not enter the translation in this field. Value can be used in the business logic. It is not displayed in the interface.

OrderYEnter the number to define the option order in the choice list.

Repeat these steps for other choice options.

caution

If some of the choice options were not fully localized, choice lists with untranslated options will display English values by default, regardless of the current user locale.

To avoid such situations, use caution when adding option values to your choice lists.

Localize messages​

To localize such elements as welcome messages, informational or warning messages, other kinds of messages, as well as condition operators, you need two tables:

  • the Source Messages (source_message) table – contains original messages in English.
  • the Messages (message) table – contains localized messages in the user's languages (Russian, German, etc).

Source Message form field

FieldMandatoryDescription
MessageYThe text of the message.

Message form fields

FieldMandatoryDescription
Source MessagesYSelect the record of the source message you need to translate from the Source Messages (source_message) table. This field is populated automatically if you create the message via the related list of a source message.
LanguageYSpecify the language code (ru, en, and so on). Languages records are stored in the Languages (sys_language) table.
TranslationYAdd the message translation.

These two tables are bound by ID. It means that every message in the Source Messages (source_message) table has the same ID as its translated version in the Messages (message) table.

For example, the "Login" record in the Source Messages (source_message) table has ID 15596431050000002, the same as the ID of the "Логин" in the Messages (message) table.

To add new translations of the message via Source Messages, complete the steps below:

  1. Navigate to System Localization → Source Messages.
  2. Open the necessary record.
  3. Open the Messages tab in the Related Lists area.
  4. Click New and fill in the fields.
  5. Click Save or Save and exit to apply the changes.

You can also see the translated variants of any message in the Messages (message) table.

There is another way to localize a message. To do so, complete the following steps:

  1. Navigate to System Localization → Messages.
  2. Click New and fill in the fields.
  3. Click Save or Save and exit to apply the changes.
warning

Do not change the original messages in the Source Messages (source_message) table. It can cause malfunction on the instance. If you need to make changes in any source message, create a copy of it in the Messages (message) table with the necessary text and fill in the Language field with the en value.

Edit translations​

Interface elements​

There are two ways to edit translated elements of the table. To edit any record via the Related Lists area, complete the steps below:

  1. Navigate to the record you need to edit.
  2. In the Related Lists area, select the Translations tab.
  3. Find the translation that needs editing, change the Value field.
  4. Click Save or Save and exit to apply the changes.
note

There is another way to edit the translation via the System Translations (sys_translation) table. To do so, complete the steps below:

  1. Navigate to System Localization → System Translations.
  2. Open the record that requires changes and edit it.
  3. Click Save or Save and exit to apply the changes.

To edit translations for a related list title, perform the following steps:

  1. Open any record form that contains the related list you need to localize.
  2. In the burger menu , select Configure → Related Lists → List Elements.
  3. Open the record you need. You can identify it by the Title field the current value of which is displayed on the form.
  4. Navigate to the Related Lists area.
  5. Use the inline editing to change the Value for the translation record.

Choice options​

The steps for editing the translation of choice options is similar to creating translations.

To edit the translation of choice options, complete the steps below:

  1. Navigate to System Settings → Choice Options.
  2. Open the necessary record and edit the Title field.
  3. Click Save or Save and exit to apply the changes.

Messages​

Since the two tables Source Messages (source_message) and Messages (message) are bound by the same ID, you can edit flash messages and condition operators in either of them.

To make changes via the Messages (message) table, complete the steps below:

  1. Navigate to System Localization → Messages.
  2. Open the necessary message or operator and edit the Translation field value.
  3. Click Save or Save and exit to apply the changes.
note

To edit the translation via the Source Messages (source_message), complete the steps below:

  1. Navigete to System Localization → Source Messages.
  2. Open the necessary message.
  3. In the Related Lists, select the Messages.
  4. Find the translation you need. Edit the Translation field value.
  5. Click Save or Save and exit to apply the changes.