Translation

Definition

Translation part is used to:

configure and manage the translations by using internationalization keys.
manage locales parameters.

Types of translations

There are two types of translations:

Built-in: these I18N keys are predefined (system keys).
Configurable: these I18N keys can be created by a user.

User display language

Locale is taken into this principles:

Retrieve identity attribute preferredLanguage
Retrieve browser language
Retrive user preference

You must always define the I18N key in the tenant's default language.

Indeed, if English is the tenant's default language and the I18N key "ui.model.resourceType.application.excerpt" has only been translated into French, then a user with an English profile will have the following anomaly displayed:

Configuration

You can access the Translations configuration :

by clicking on "Customization" → “Translations”
by clicking on "System" → "Configurations" → "Internationalization service" and perform an import/export.

Built-in I18N keys

Built-in keys are not editable on the admin portal, but it is possible to import built-in keys to update the translations.

Configurable I18N keys

	Steps	Preview
1	You access the translation management page. You can: choose the source language by clicking on the drop-down list (English or French). choose the target language by clicking on the drop-down list (English or French). if a target language is selected, you can click on "Only Missing Translations" button to filter keys.
2	When a new language is to be supported, it is needed first to add its locale through the locale management pop-up. When a locale is not active, it is not available to users. By clicking on "Manage Locales" button, you can: add a new language. delete one or several language(s). define the default language. active or deactive language(s). If a locale is deleted, all messages related to it are also removed. It is not possible to delete the system locale.
3	By clicking on "Create New Key" button, you can create a new key translation by indicating the unique identifier (mandatory), an optional description and a translation. The proposed translation language is the default language of the application.
4	It is possible to edit or delete a key by clicking on the "Edit" or "Delete" button on the line of the key. The system keys cannot be deleted and most of them are read only. For each key: on the first line, the key is displayed. on the second line, the translation is displayed. By clicking on this line, you can directly modify the translation.
5	You can filter keys translation by using the search bar. You can modify the search operator (contains or starts with) and select only the editable keys.
6	You can also: by clicking on the first button, delete several keys (toggle batch mode). by clicking on the second button, refresh data. by clicking on the third button, expand view page.

Structure of keys

The system I18N keys respect standard structures:

Type of keys	Description	Examples
tenant."project"."component"."details"."type"	"tenant" is a prefix used for every system key defined in the application.	tenant.feature.audit-report.STATUS.label
	"project" indicates the part of Memority Portal using the keys (adm, usr, feature, notification...)
	"component" indicates the part of the project (toolbar, rights, task...)
	"details" is the specific definition of the key and indicates the element using the key (status, columns, button...)
	"type" indicates the type of label (title, subtitle, label...)
ui."component"."details"."type"	"ui.model" is a prefix used for define keys associated to one configuration model element (attributes, identity...)	ui.features.user-card-read.title
ui.model.attributes."attributeId"."type"	This type of keys is used to define the translation associated to a coded value of an Attribute.	ui.model.attributes.rolecode.name

Special keys

Feature to execute

Type of keys	Description	Preview
ui.features."featureId".error-message.label	Allows to define the error message if the operation has failed.
ui.features."featureId".execute.label	Allows to define the name of the button that is used to execute the action.
ui.features."featureId".info-message.label	Allows to define the info message of the pop-up.
ui.features."featureId".success-message.label	Allows to define the success message if the operation is done.
ui.features."featureId".title.label	Allows to define the title of the pop-up.

Online help for fields

Type of keys	Description
ui.model.attributes.form.fields._encode64_field_"fieldId".placeholder.message	Allows to define a message will be displayed when the user informs the value of a field.
ui.model.attributes.form.fields._encode64_field_"fieldId".help.inline.message	Allows to define a message will be displayed below the value of the field.
ui.model.attributes.form.fields._encode64_field_"fieldId".help.popover.message	Allows to define a message will be visible by the user when the mouse passes overt the question mark.

Name of system requesters

Type of keys	Description
ui.model.systemType.bum.excerpt	Allows to configure a translation when a workflow is launched by the system (instead systel@@bum). By default, the translation is system.
ui.model.systemType.idm.excerpt	Allows to configure a translation
ui.model.systemType.sync.excerpt	Allows to configure a translation

Dimensions

Type of keys	Description
ui.model.dimensions."dimensionId".name	Allows to define a translation for a dimension (on all Role).
ui.model.roles."roleId".dimensions."dimensionId".name	Allows to define a translation for a dimension on a specific Role.
ui.model.dimensions."dimensionId".help.popover.message	Allows to define a help message for a dimension (on all Role).
ui.model.roles."roleId".dimensions."dimensionId".name	Allows to define a help message for a dimension on a specific Role.

Workflow

Type of keys

Description

tenant.(feature|roleAssignment).<feature id|role id>.workflow.<workflowId>.task.<taskId>.confirm.approve.message

tenant.workflow.<workflowId>.task.<taskId>.confirm.approve.message

tenant.workflow.<workflowId>.userTask.confirm.approve.message

Allows to define a translation for the confirmation popup after a workflow validation.

Native fallback system can be used

Role Dimensions

Type of keys	Description
tenant.ui.component.role-dimension.form.fields.key.help.popover.message	Allows to define a help message popover for properties on Role Dimensions widget.
tenant.ui.component.role-dimension.form.fields.tags.help.popover.message
tenant.ui.component.role-dimension.form.fields.detail.help.popover.message
tenant.ui.component.role-dimension.form.fields.order.help.popover.message
tenant.ui.component.role-dimension.form.fields.type.help.popover.message
tenant.ui.component.role-dimension.form.fields.multivalued.help.popover.message
tenant.ui.component.role-dimension.form.fields.mandatory.help.popover.message
tenant.ui.component.role-dimension.form.fields.initRule.help.popover.message
tenant.ui.component.role-dimension.form.fields.displayCondition.help.popover.message
tenant.ui.component.role-dimension.form.fields.choicesRule.help.popover.message
tenant.ui.component.role-dimension.form.fields.normalizeRules.help.popover.message
tenant.ui.component.role-dimension.form.fields.validationRules.help.popover.message
tenant.ui.component.role-dimension.read.comment.message	Allows to define a message at the top of the Role Dimensions widget.
tenant.ui.component.role-dimension.update.comment.message
tenant.ui.component.role-dimension.create.comment.message

Role type

Type of keys	Description
ui.model."objectType"."objectTypeId".name	Allows to define a translation for a Role type when the value is displayed in search result table, display widget, hub.
ui.model.attributes.type.values."objectTypeId".label	Allows to define a translation for a Role type when the value is displayed in a choice list.

Access

Type of keys	Description
tenant.ui.am.login.title	Allows to define a translation for text or button displayed on the login page
tenant.ui.am.login.field.login.label
tenant.ui.am.login.field.login.placeholder
tenant.ui.am.login.field.remember-me.label
tenant.ui.am.auth.button.connection.label
tenant.ui.am.modules.button.change-login.label	Allows to define a translation for text or button displayed on the authentication mechanisms choice page
tenant.ui.am.modules.help.label
tenant.ui.am.modules.no-chain.label
tenant.ui.am.auth-mechanism.”auth-mechanism-id”.name	Allows to define a translation for the authentication mechanism displayed to users on the authentication mechanisms choice page

Footer label

Type of keys	Description	Preview
tenant.common.applications.footer.label	Allows to define a label at the bottom of the page and in the about box before the Memority copyright.