Getting started with internationalization
Who is this article for?
Administrators seeking information on internationalization
An Active Ideagen Support Service Level Agreement (SLA) is required.
Enabling Internationalization
Internationalization and available languages are enabled based on the organization's contract. For additional information or to request pricing please contact us.
The platform is primarily available in English. However, certain aspects are available in other languages and formats. Internationalization also known as localization, translations or multi-language support modifies platform and customer applications displaying them in the user's preferred language and is available in both the Classic and Miramar user interfaces including:
- Login pages
- Desktop user-facing screens such as dashboards, search, and report management
- Commonly used admin screens: Users, Teams, Components, Data Import, Translations, and Admin Audit Trail
- Mobile application
- Mobile Designer
- Numeric Formats
- Date Formats (Requires a subscriber wide setting)
- Reference data
Field Values are NOT Translated
The user interface will be delivered in the user's preferred language, however field values retained in the language entered. For Example, suppose a user signs in with a Spanish language setting they would see the platform, and all module screens delivered in Spanish. Imagine they create an Action record and enter a Title and Description in Spanish, the platform stores the value exactly as entered. A second user signs on with an English language setting and searches for all Action records, they will see the Spanish Title and Description in the English presentation of the module.
Translation Types
Translations are divided into two categories Platform and Subscriber.
Platform Translations
Platform translations are provided by Ideagen for each of the supported languages and include all elements common to the platform such as home screens, search screens, admin screens, etc.
Platform translations can be customized once deployed into the customer area.
Subscriber Translations
Subscriber translations are provided by the customer for each language and are specific to their application modules and reference data.
Subscriber translations are not specific to a single module, instead they use codes from each module that has been enabled for translation.
Missing Translations
Any words or phrases that do not have a matching translation will be displayed in English.
The admin translation screen allows admins to modify translations for each language selected as well as the ability to import and export translation files.
Translation Codes
Translation codes are used throughout the platform whenever words or phrases are displayed in each language. In the module definition codes are wrapped in double curly brackets {{ }} with the code names being written in all uppercase letters and spaces being replaced with an underscore _. For example {{CODE_NAME}}.
When the platform displays a module, admin screen, object data, or any element containing a code in the form {{CODE_NAME}} it replaces the code with the appropriate language translation defaulting to English when no language specific translation is available, and the code when no English translation is available.
Translations are managed by the Miramar Translations admin shortcut.
Reference Data
Reference data such as Reference Data fields such as picklists, locations, organizations, and checklists exists as objects in the system. This data must also be translated by replacing the title or name with a Translation Code.
To create a translation code, create a new reference data object with the name in the format {{CODE_NAME}} using _ between words and wrapping the code value in double curly brackets {{ }}.
Using the Translations admin screen add a new translation for the code (without the curly brackets) for each language required.