Both customers and Nextworld solution development partners may need to translate their metadata:
- Customers—If you have created your own metadata objects, and some or all of your users need to access them in a different language, you need to translate those objects. For example, you may create a new customer defined attribute (CDA) that's used in multiple financials applications. If you support the Spanish language, your Spanish-speaking users may access those applications in Spanish, but your CDA appears in English until you translate its text-based elements.
- Solution development partners—If you have a customer that needs to use your product in another language, you need to translate all the metadata that's a part of your solution into that language. For example, if you have customers in both Mexico and Germany, you need to translate your applications, documentation, and more into both Spanish and German before you deliver your solution to them.
Translation records and language support
Each metadata object is associated with one or more translation records. Every translation record represents a text-based element of an object for a particular language. For example, each data item may have a Spanish translation record for its Label, Short Label, and Help Text.
In order to translate your metadata into a new language, you must first support that language using the Tenant Environment Setup application. Learn more in Support additional languages on the platform.
When you support a language in your environments, this activates all the translation records associated with the metadata in your environments. The translation records for all Base metadata contain translation values that have already been filled out, so if you change your locale, you can view those objects in that language. However, the translation records for all your Owned metadata are empty by default, so you must provide the translated values.
Translate your metadata
After you've supported the language you need to translate your metadata into, you can populate the translation values for all the applicable translation records. Typically, you export the translation records to a CSV file and hire an external vendor to perform the translations. Then, you can import the records back into the system.
Translation applications
The following applications contain the translation records for the various translatable elements of your metadata:
- Translation Workbench application—Contains translation records for data item labels, field-level help text, application settings, list lookups, the translatable elements of your applications, and more.
- Tenant Core Translation Workbench application—Contains translation records for menu entries, dashboard page titles, dashboard card titles, and Nextworld Help topic titles.
- Authored Content Translation Workbench application—Contains translation records for the written content of Nextworld Help topics.
Considerations
Translation records are tied to each metadata object and move automatically when you migrate metadata. This means that you should always perform translations in your development environment, where the metadata is created.
You should only develop new metadata in English. By default, any new metadata you create is considered the English version, regardless of whether you are using a different locale setting. For example, if you have your locale set to Spanish, and you create a data item with a Label of Temperatura, the label is stored as the English translation record. Instead, you should specify a label of Temperature, and then populate the associated Spanish translation value for the object with Temperatura.
Translations should always be performed by product family.
How to translate your metadata
This topic contains the instructions for translating your metadata into a new language.
Prerequisites
Before you can translate your metadata into another language, you must support that language in your environments. Always perform translations in your development environment where you create your metadata. Learn more in Support additional languages on the platform and Metadata translations.
Procedure
- In the Translation Workbench application, use the Reload Translations form action.
- Specify the language and product family of the metadata objects you are translating.
- In the Lifecycle field, specify your tenant default lifecycle. Your tenant default lifecycle is configured in the Tenant Environment Setup application.
- Select Submit.
- After you recieve a notification that the reload is complete, navigate to the Data Export Definitions application.
- Filter for the data export definition relevant to the metadata you are translating. Use the table below as a reference.
- Use the Copy row action to copy the data export definition.
- In your copied data export definition, on the Filters and Sorts page, in the Filter subtable:
- Update the value for the
TranslationLanguagefield with the language you're translating into. - Update the value for the
SystemGroupfield with the product family of your metadata objects. - Update the value for the
Lifecyclefield with your tenant default lifecycle.
- Update the value for the
- Save the data export definition, and select Run Export.
- After the export is complete, download the CSV file from the attachments folder.
- In the CSV file, update the
TranslationValuecolumn with the correct translations. Often, this can be done by an external translation vendor of your choice. Do not modify any other data in the file. - Navigate to the Data Import Definitions application, and filter for the relevant data import definition using the table below.
- Remove any existing attachments to the record.
- Attach the CSV file you exported to the record, complete with the updated
TranslationValuecolumn. - Save the data import definition, and select Run Import.
Data export and data import definition reference
Refer to the following table to ensure you're selecting the correct data export and import definitions for the metadata you are translating:
| Metadata to translate | Data export definition | Data import definitions | Application to view translation records |
|---|---|---|---|
| Data item labels, field-level help text, application settings, list lookups, and the translatable elements of your applications | TranslationWorkbench | TranslationWorkbenchImport | Translation Workbench application |
| Menu entry titles | MenuTranslationsJoin | TenantCoreTranslationsDataImport | Tenant Core Translation Workbench application |
| Dashboard card titles | CardTranslationsJoin | TenantCoreTranslationsDataImport | Tenant Core Translation Workbench application |
| Dashboard page titles | DashboardPagesTranslationsJoin | TenantCoreTranslationsDataImport | Tenant Core Translation Workbench application |
| Nextworld Help content topic titles | DocAuthoredContentTranslationsJoin | TenantCoreTranslationsDataImport | Tenant Core Translation Workbench application |
| Nextworld Help authored content | DocAuthoredContentTranslationsJoin | DocAuthoredContentTranslationImport | Authored Content Translation Workbench application |
Translation Workbench application
Use the Translation Workbench application to manage the translation records associated with the metadata in your environments. The translation records in this application include data item labels, field-level help text, application settings, list lookups, the translatable elements of your applications, and more.
Each translation record represents a text-based element of a metadata object for a particular language. You can identify the object the translation record is associated with using the Object Source field.
When you make changes to existing metadata, the associated translation records are kept in-sync, and the Source Value of the record is automatically updated with the new value. The Translation Value, however, is not updated. Instead, the Dirty checkbox is selected, indicating that you need to update the Translation Value again with the correct translation.
Translation records for new metadata objects are not created automatically, however. When you create new metadata, use the Reload Translations form action to create these records. Specify the language and product family of the objects you need to create translation records for. In the Lifecycle field, specify your tenant default lifecycle, and then select Submit.
Learn more about translating your metadata in Metadata translations.
Tenant Core Translation Workbench application
Use the Tenant Core Translation Workbench application to manage the translation records associated with the metadata in your environments. The translation records in this application include menu entries, dashboard page titles, dashboard card titles, and Nextworld Help topic titles.
Each translation record represents a text-based element of a metadata object for a particular language. You can identify the object the translation record is associated with using the Base Table and Base Table Field fields.
For example, a record with a Base Table of Menus and a Base Table Field of MenuTitle2 is a translation record for a menu entry title.
When you make changes to existing metadata, the associated translation records are kept in-sync, and the Source Value of the record is automatically updated with the new value. The Translated Value, however, is not updated. Instead, the Dirty checkbox is selected, indicating that you need to update the Translated Value again with the correct translation.
Learn more about translating metadata in Metadata translations. Always follow the instructions listed in How to translate your metadata when you translate.