...

The terms and phrases displayed by a client application based on the framework library such as our yuuvis® client as reference implementation can be localized for custom languages according to the corresponding needs. ThereforeFor this purpose, each individual technical term used in the background can be mapped to a user-friendly localized term or phrase that will be displayed in the browser UI client application wherever the technical term would be present. The built with our libraries allows for the localization of control elements (e.g., buttons or error messages). Furthermore, labels used in forms can be localized easily during runtime.

Localization of Control Elements

The localization of control elements is realized directly during the building process of the client. JSON files are used as configuration files for the translations.
>> Framework Library Installation and Configuration

Localization of Form Labels ...

The labels displayed in forms (e.g., object metadata forms) are localized by means of JSON configuration files as well. A distinction is made between tenant-specific labels available only within one tenant and global labels available in all tenants. The tenant-specific localization files are managed by users with the role YUUVIS_TENANT_ADMIN. Their changes are applied only to their own tenant. Users with the role YUUVIS_SYSTEM_INTEGRATOR are allowed to manage the global localization files available in all tenants.

Whenever a new tenant is created and provided with its own tenant-specific resources like, e.g., a tenant schema, also a tenant-specific localization file needs to be created. Otherwise the technical terms defined in the technical resource files will be displayed in the forms.

In order to retrieve or import localization files, the corresponding endpoints of the Web-API Gateway (API-WEB) can be used. Alternatively, the administrative graphical user interface of yuuvis® architect allows for a comfortable localization handling.

... via Web-API Gateway

The endpoints for the management of localization files provided by the Web-API Gateway (API-WEB) are available only for users with specific administrative roles. Furthermore, the endpoints require the specification of the language for which the localization file should be retrieved/updated. The language has to be specified in ISO norm (e.g., de, en, es, fr, ...) in the request header for GET endpoints and in the request URL for the POST endpoints:

The endpoints can be called via Swagger-UI.
>> Web-API Gateway Endpoints

Alternatively, they can be called using cURL as shown in the following examples:

# For the system:

# GET e.g. the English language setting via 
curl -X GET "https://mydomain/api-web/api/admin/resources/text" -H "accept: application/json" -H "Accept-Language: en" for getting a JSON-based response.

# POST e.g. a Japanese language setting via 
curl -X POST "https://mydomain/api-web/api/admin/resources/text/ja" -H "accept: */*" -H "Content-Type: application/json" -d "{all keys that are give}"

# For a specific tenant the user is logged in for.

# GET e.g. the English language setting via 
curl -X GET "https://mydomain/api-web/api/admin/resources/text" -H "accept: application/json" -H "Accept-Language: en" for getting a JSON-based response.

#POST e.g. a Japanese language setting via 
curl -X POST "https://mydomain/api-web/api/admin/resources/text/ja" -H "accept: */*" -H "Content-Type: application/json" -d "{all keys that are give}"

... via yuuvis® architect

yuuvis® architect provides a support tool with a graphical user interface for client administrators. Based on the framework library, metadata forms of their client's graphical user interface can be modeled. Furthermore, users can be added or removed from the respective tenant and language settings can be customized.

The Localization tile is available on the dashboard for users with the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR roles.
>> Localization

...

These configurations are defined in different JSON files. There are two global localization configuration files that are available in all tenants: one for the localization of control elements provided by the framework library (e.g., buttons or error messages) and one for the localization of terms introduced via a global schema (e.g., labels for administrative fields in object forms). Additionally, each tenant has an own localization configuration file for terms introduced via its specific tenant schema (e.g., labels for metadata fields in object forms). This article describes how to define and apply all three localization configuration files to a client.

...