[+]
[+]
[-]
 [+]
  
 [+]
 [+]
  
 [+]
 [+]
 [+]
 [+]
 [+]
 [+]
 [+]
 [+]
 [-]
  [+]
  [+]
  [-]
    
  [+]
   
   
   
   
   
   
   
 [+]
[+]
Updated on 12/10/2019
Workflow Documentation
Translations
Direct link to topic in this publication:

PREVIOUS  |  NEXT

Translations

Quick Links


Each item in a dictionary is called a translation. Translations in custom dictionaries are based on the System dictionary in the selected language. Each translation comprises the following:

  • Message Key: The unique value that identifies the translation. You can use the message key to refer to the translation in document templates, email templates, and columns in table controllers. The message key is generated automatically.
  • Value in Selected Dictionary: The value to which to translate.
  • Value in Referent Dictionary: The value to which the translation refers. 

For example: You want to rename Case ID  in the System dictionary to Reference Number in a Custom Dictionary. The list of translations for the Custom Dictionary will show:

  • Message Key: translations.list.custom.translation
  • Value in Selected Dictionary: Reference Number
  • Value in Referent Dictionary: Case ID

To work with translations:

  • Go to Setup > Administration > Dictionary and click the name of the dictionary you want.

Working with Translations

You can add, edit, and delete translations in custom dictionaries. 

Note: The Value in Referent Dictionary column displays the value in the Default dictionary. To see the value in a different dictionary, select it from the Referent Dictionary list. For example, if your default dictionary is in Spanish, but you want to see the values in English, select English from the Referent Dictionary list.

Create New Translation

[Back to top]

You can manually add a new translation, or Import a file to add multiple translations.

To manually add a new translation:

  1. In the Dictionaries workspace, do one of the following:
  • Click the name of the dictionary you want to edit.
  • Click the  button and select Edit Content.
  1. Click the New Translation link.
  2. Enter a message key. 
    The message key is a unique ID that you can use to refer to the translation in document templates, email templates, and columns in table controllers.
  3. Enter a value to which to translate the corresponding referent dictionary term.
     The value must not exceed 4,000 characters.
  4. Click the Use Default button to replace the value in selected dictionary with the default value from the System dictionary. 
  5. Click Update

Edit Translations

[Back to top]

You can edit translations in several ways:

  • Edit one translation at a time
  • Replace a value in all translations at once
  • Export a dictionary, edit the exported file, then import it back into Workflow
  • Import a file

To edit a single translation

  1. In the Dictionaries workspace, do one of the following:
  • Click the name of the dictionary you want to edit.
  • Click the  button and select Edit Content.
  1. To find the translation, enter keywords in the search field and click Search.
    To search only the selected columns, click the search options link and select the columns you want to search.
  2. Optionally, select a different dictionary from the Referent Dictionary list. 
    The referent dictionary contains the item to translate.
  3. Click the Edit button next to the translation item.
    You cannot edit the Value in Referent Dictionary. 
  4. Click Update.

To replace a value in all translations

  1. Enter the value to replace in the Replace field.
    This field is case-sensitive.
  2. Enter the new value in the With field.
    This field is case-sensitive.
  3. Click Replace All.
    A message at the top of the screen shows the number of replacements that were made.

Delete Translations

[Back to top]

  • To delete individual translations, click the Delete button next to the translation.

To delete a large number of translations at once, we recommend you:

  1. Export the dictionary.
  2. Make your changes in the exported file.
  3. Create a new dictionary and import the edited file into it.
  4. Optionally, delete the original dictionary.

Important: To maintain the integrity of scripts that call the dictionary, use the System ID of the original dictionary for the new one. To do this, modify the System ID of the original dictionary so it remains unique, then replace the System ID of the new dictionary with the unmodified one of the original dictionary.  

Import Translations

[Back to top]

You can import an XLS file to add or modify dictionary translations. Only items in the imported file will be updated in the dictionary, all other existing translations will remain unchanged. You cannot use this feature to delete translation items. 

The import file must include:

  • A heading row, with at least the following two columns:
    • Message Key in column A
    • Value in Selected Dictionary in column B
  • Data in each of the two required columns
  • No more than 1,000 characters in column B

In addition:

  • Optionally, the import file can include a Default Dictionary Value in column C.
    The value in that column will be mapped to the Value in Referent Dictionary column of the dictionary into which the file is imported, but will not update the referent dictionary.
  • Data in all other columns is ignored.

To import a file: 

  1. In the Dictionaries workspace, do one of the following:
  • Click the name of the dictionary you want to edit.
  • Click the  button and select Edit Content.
  1. Click New Dictionary to create a new dictionary.
    For information about creating a dictionary, see Create New Dictionary.
  1. In the Import from Excel section at the bottom of the page, click the Choose File button.
  2. Select the file and click Open.
  3. Click Import.

Workflow displays a message if any errors occur. In such cases, correct the errors and import the file again. 

Export Translations

[Back to top]

You can export a dictionary into an XLS file to easily update, add, and delete translation values, or to backup a dictionary.

To export a file:

  1. In the Dictionaries workspace, do one of the following:
  • Click the name of the dictionary you want to export.
  • Click the  button and select Edit Content.
  1. In the Export section at the bottom of the page, click the Export button.
    The dictionary is exported to your default download location.

Using Translations

[Back to top]

This section provides examples of translating various items.

Note that you cannot translate the following values:

  • Predefined values that are set by a query, such as from a custom table
  • Text that users enter

Document and email templates

$translator.get("message_key")

For example: $translator.get("custom.key.template.greeting_message")

Scripts

resp.getTranslation("message_key");

For example: resp.getTranslation("custom.key.txt.msg.test");

Labels

Use this method for items that display a Translate button, such as custom and standard fields, statuses, priorities, and departments. The Translate button is available through the Edit link, the  button, or the  button. 

  1. Click the Translate button.
  2. Select the custom dictionary from the Translate To list.
    The translation will be added to the selected dictionary. You cannot add a translation to a system dictionary.
  3. Type the translation in the Translation Value field.
  4. Click Save.

Predefined field values

  • To translate predefined values that you set manually, such as pick lists, checkboxes, autocomplete fields, and radio buttons, click Translate when creating or editing the values.
  • To translate values in scripts, use the following syntax:

resp.getTranslation('message_key')

For example: resp.getTranslation('custom.key.tablecontroller1.column1'.value1')

Table controller labels

  • When customizing a table controller, type the message key from the dictionary in the Label column.
    For example, custom.key.tablecontroller1.column1.label
    For more information about customizing a table controller, see Customizing a Table Controller.


Related Articles