Multilingual choice fields

Applies to version: 2019.1.x and above; author: Jacek Język, Lily Adamowicz

Introduction

The WEBCON BPS platform is designed to support business processes in international, multilingual environments. Each form instance has been built with localization in mind, allowing designers to provide translations into any language used by their end users during the workflow design phase.

Complementing the multilingual form capabilities is the introduction of multilingual choice fields, added in version 2019.1.2. This feature enables the definition of choice dictionaries so that the displayed text aligns with the language currently presented to the user in the form.

Data sources for multilingual choice fields

Multilingual support in form fields requires prior preparation of the Data source used to populate the field. The source must return multilingual values—texts that are already translated into the languages supported by the form.

To enable support for multilingual choice fields, you need to choose one of two data preparation methods:

• Use a predefined data format that allows you to define a default name along with its translations for specific languages.
• Add extra columns with translated values to your Data source and map them accordingly in the form field Advanced configuration.

METHOD 1 – Data format

The Data source intended for use in a Choice field must be structured in the following format:

DEFAULT_NAME$$LANG_CODE$$LANG_NAME$$ LANG_CODE$$LANG_NAME …

• $$ – a separator used to split individual parameters
• DEFAULT_NAME – the default label displayed on the form if it’s rendered in a language that has no defined translation in the Data source
• LANG_CODE – a two-letter language code (as per ISO 639-1) indicating the language for which a translation is provided in the next parameter (e.g., PL, EN, DE, IT)
• LANG_NAME – the translated value corresponding to the specified language

You can define any number of translations—the only limitation is the size of the database column used to store the translatable values.

EXAMPLE: A Data source of type Fixed values list has been configured with multilingual values for a form field. The default values are English color names. Translations have been also added for three additional languages: Polish, German, and Italian.

EXAMPLE 2: Multilingual values can be defined in a similar way for a Data source based on a Dictionary process.

METHOD 2 – Additional column

Another way to provide translations for Choice field values is to include them in additional columns within the Data source.

EXAMPLE 1: In a Fixed values list data source, English names are set as default. A column named Description contains Polish translations. In the choice field’s Advanced configuration, this column will later be designated as the source for translations (see later in this article).

EXAMPLE 2: In a Dictionary data source, English is also set as the default language, with additional translations provided in Polish, German, and Italian:

Form field configuration

Multilingual name support has been introduced for the Choice field as well as for Item list columns of the following types: Choice field, Choice field (picker), and Autocomplete.

For the feature to work correctly, the Data source feeding the form field must be properly prepared (as described earlier) and return translated phrases.

An essential step is enabling the Support multi language names option in the form field Advanced configuration. This activates the functionality and ensures the appropriate translations are displayed on the form according to the current presentation language.

When using METHOD 1, it is sufficient to specify the source column that contains data in the predefined format.

If METHOD 2 is selected, you need to specify the source column containing the default values. Then, go to the language settings by clicking the icon that becomes available after enabling the Support multi language names option.

In the window that opens, you need to select the Data source columns that contain translations for each language:

Regardless of the chosen method, the end result on the form will be the same. Depending on the presentation language, the user will see the Choice field values in the corresponding language. If their language is not defined in the Data source, the default values will be displayed instead.

Storing values in the database

Values chosen in form fields that handle multilingual names are saved in the database. Values are stored as text in the ID#NAME standard format, however the NAME includes translations of all languages returned by the data source at the time of saving the form. This approach allows values on the form to always be displayed accordingly with the presentation language.

It also has some consequences which are important to remember while using multilingual functionality:

• Limitations of the size of the data stored in the base – values of fields and choice columns saved in the database can be 1000 characters long. This limits the phrase length and the number of the translations themselves which together cannot be longer than 1000 characters.
• Translation changes in the Data source are not considered for the saved value until the form is saved with the new translation.