Localization Framework integration with Catalog Builder
Summarize
Summary of Localization Framework integration with Catalog Builder
The Localization Framework integration with Catalog Builder allows ServiceNow customers to manage and perform translations of catalog items efficiently. Through the Catalog Builder dashboard, specifically the Translation Status tab, users can view translation progress and translate catalog items using either manual (self-translation) or machine-assisted methods (request translation).
Show less
Prerequisites
To utilize Localization Framework features in Catalog Builder, ensure the following plugins are installed:
- Localization Framework Installer plugin for Service Catalog: Enables core localization capabilities in Service Catalog and Catalog Builder.
- Dynamic Translation plugin: Provides on-the-fly machine translation functionality.
Translation Modes
Translations can be performed using two modes, controlled by the system property glide.sc.catalogbuilder.localization.enablerequesttranslationmode:
- Request Translation Mode (property set to True):
- For new catalog items, a Request Translations step appears in the item creation wizard to select target languages.
- For existing items, the Translation Status tab lists configured languages with their translation states and provides a "Request translations" link to initiate translation tasks.
- When a translation request is confirmed, a localization task is generated, and the translation state updates to "Translations requested."
- Upon task completion, the state updates to "Translated," "Partially translated," or "Not translated" depending on the coverage of translated fields.
- Self-translation (Ad hoc) Mode (property set to False, default):
- Users can edit translations directly via the Translation Status tab by selecting the "Edit translations" link next to a language.
- An interface displays source and target languages side by side, allowing manual comparison and editing of translations.
Translation States
Translation progress per language is indicated with specific states visible in both modes:
- Not available: No Localization Framework Insights record exists for the catalog item and language.
- Not translated: No translations exist for the catalog item and language.
- Translations requested: Active localization tasks are in progress (request translation mode only).
- Partially translated: Some, but not all, catalog item fields are translated.
- Translated: All relevant fields have translations available.
Practical Benefits
This integration enables ServiceNow customers to streamline multilingual catalog item management, improve translation accuracy through side-by-side editing, and automate translation workflows with machine translation support. It ensures transparency of translation progress and flexible translation approaches to fit different organizational needs.
The Translation Status tab in the Catalog items tab on the Catalog Builder dashboard enables you to view the translation status of catalog items, and translate catalog items on the fly using manual or machine translation methods.
Confirm that the following plugins are installed before you start using Localization Framework in Catalog Builder:
- Localization Framework Installer plugin for Service Catalog: The plugin enables the Localization Framework capabilities in Service Catalog and Catalog Builder.
- Dynamic Translation plugin: Enables on-the-fly machine translation capabilities.
Translate catalog items information using one of the following modes:
- Request Translation mode
- Self-translation (ad hoc) mode
Request translation mode for new catalog items
Set the glide.sc.catalog_builder.localization.enable_request_translation_mode property to True, to enable the Request translations mode.
When you create item, the Request translations step appears in the wizard steps region. Select Browse to view and select the languages you want to translate the catalog item information to.
For more information, see Request translations for Service Catalog items.
Request translation mode for existing items
Set the glide.sc.catalog_builder.localization.enable_request_translation_mode property to True, to enable the Request translations mode is enabled.
On the Catalog Items tab, select the existing item that you want translated, then select the Translation status tab on the right pane (next to the Item details tab). You would see the list of languages configured in the system along with the state of that language for the catalog item and a Request translations link to request for a translation.
Select the Request translations link below the language you want the translations for. A dialog appears prompting you to confirm the translation request. When you confirm the translation request on the Translation status tab, a localization task gets generated and its corresponding Localization item record ("LRITMXXXXXXX") shows up in place of the Request translations link. The state for that specific language changes to Translations requested.
When the localization task completes in Localization Framework, the Request translations link comes back which you can use to request for translations again. The state changes to Translated, Partially translated, or Not translated on the Translation status tab, depending on whether the translations occur for all fields, some fields, or no fields in the table.
For more information, see Request translations for Service Catalog items.
Self-translation (ad hoc) mode
Set the glide.sc.catalog_builder.localization.enable_request_translation_mode property to False to enable self-translation mode. The default value for this property is False.
In the Catalog Items tab, select the existing item you want translated, then select the Translation status tab on the right pane (next to the Item Details tab). The list of languages configured in the system is displayed, along with the state of that language for the catalog item and an Edit translations link to edit the translation.
Select the Edit translations link to open another tab that contains two comparison UI regions: The left region is the source language, and the right region is the target or translated language. You can compare the language translation side by side in the page, and make changes if required.
For more information, see Request ad hoc translation for Service Catalog items.
Translation States
| State | Mode | Description |
|---|---|---|
| Not available | Request translation and Self-translation | If the Localization Framework Insights record is not available, the translation state displayed by the system is Not Available, and the state appears near the language name. |
| Not translated | Request translation and Self-translation | If there are no translations in the system for that specific catalog item for that language, the state Not Translated appears near the language name. |
| Translations requested | Request translation | If there is an active LRTIM associated with a language for the item, the state Translations requested appears near the language name. |
| Partially translated | Request translation and Self-translation | If there are partial translations in the system for that specific catalog item for that language, the state Partially Translated appears near the language name. |
| Translated | Request translation and Self-translation | If all translations for that specific catalog item for that language exist in the system, the state Translated appears near the language name. |