Define Custom Label Translations in Multi-Language Omniscripts

Define translations in various languages for custom labels in multi-language Omniscripts. Create localized content so that users see the Omniscripts in the language based on their locale. Create custom labels in English first, followed by translations for other languages.

To avoid duplications and improve querying, use naming conventions when you create custom labels in a Salesforce org with multiple developers. For example, jSmithCustomTextLabel.

Note

In addition to Salesforce custom labels, Omnistudio provides default custom labels with translations. Omnistudio doesn't support Salesforce standard labels.

The Set Values and Set Errors actions don’t support custom labels.

1. Create a multi-language Omniscript.
   1. From the App Launcher, find and select Omniscripts.
   2. On the Omniscripts tab, click New.
   3. Enter a unique name, type, and subtype for your Omniscript.
   4. From the language dropdown list, remove English and select Multi-Language.
   5. Save your changes.
2. Create the Omniscript's basic structure by adding elements and their properties.
3. Add or edit translations for custom labels for elements in the Omniscript.
   • Click .
   • If you're using the designer for a managed package, click Edit Translations.
   The Edit Your Omniscript Translations window opens.
4. Add English translations for the custom labels.
   1. Click and select English (US) from the dropdown list.
      

      Note

      To ensure that the custom label is created properly, always create the English translation first.

   2. For each element that you want to translate, enter a custom label name.
   3. In Custom Label Value in English (US), enter the value that you want for the element in the English Omniscript.
      Merge field syntax is supported in custom label values.

      

      Note

      Custom labels must have values. If a custom label value doesn't exist, an error message appears when you preview the Omniscript.

   4. Click Save as English (US).
5. Create another translation.
   1. Click and select another language.
   2. Add a translation by entering custom label values for the element properties for which you entered English values.
   3. Save the translations.
6. Add other languages as necessary.
7. Preview the Omniscript and test each language.
   Sometimes it takes a few minutes for the custom labels to be created. If the labels don't appear in the preview at first, try again in a few minutes.

   

   Note

   Custom labels don’t render in the design mode. You must preview the Omniscript to render the custom labels correctly.

   If the Save operation is not completed error appears, or if labels don't appear in preview after a few minutes, add the custom labels in Setup. See Create and Edit Custom Labels.

• Access Custom Labels in an Omniscript Custom Lightning Web Component
  Provide custom Lightning web components access to Salesforce custom labels in your Omniscript.
• Translate Tooltip Help Text in Omniscripts
  Display tooltip help text with multiple translations in multi-language Omniscripts. You must use custom labels to add help text in multi-language Omniscripts. If a custom label is not defined for a help text tooltip, an error renders.
• Translate Custom Labels for Date and Time Components
  Define custom label translations for date and time pickers using JSON strings and Omniscript custom labels. For example, if a Spanish translation is defined, the date picker displays Spanish translations for the months and days of the week.
• Create Multi-Language Select Elements
  Populate Select, Multi-select, and Radio elements for a multi-language Omniscript using custom configuration options.
• Omniscript Custom Label Reference
  Review the Omniscript element properties for which you must define custom labels and translations for multi-language Omniscripts. To use a default translation, clear the property.