Administration → Configuring SRC → Configuring SRC → Localizing SRC Strings → Translating Strings → Translating Strings Using XML

Translating Strings Using XML

Use the Export tab in Application Administrator to first create an XML file that contains the default English strings. You can then import this file after strings are translated. Note that you must select the Allow translation for MLS Runtime Objects and Design Objects check box on the Settings page before you promote or deploy the process apps in order to create the default locale strings.

Translating SLS Design Object Strings Using XML

Review the following section to learn about exporting SLS and user defined object strings to XML for translation.

Each SLS / Design string is composed of the following elements in the XML:
  • Key

    Container for each string, including values and tags for all locales.

  • Name

    The key name for each string.

  • Locale

    The locale for each key value.

  • Key Value

    If no override is applied, the text that is shown to users for the specified locale.

  • Override

    A way to customize a string and maintain the provided value. Overrides, if provided, are always shown to users.

  • Tag

    Customizable label for each key value.

Important: Do not modify the structure of the XML file. Instead, provide translations in the KeyValue tags.

To translate SLS and user defined object strings using XML:

  1. In the Localization | Settings tab, select Allow translation for MLS Runtime Objects and Design Objects if it is not selected already.
  2. Select the Export tab.
  3. Select the SLS / Design type.
  4. Select the locale you want to export.
  5. Select the category of strings to export (Request Center) or Request Center (User Defined Objects).
  6. Click Export and save the file.
  7. Open the file of exported strings in an XML or text editor.
  8. Use search and replace to change the <Locale> value for each key.

    Note the following:

    • When you replace the <Locale> values, you must use the proper abbreviation for the locale. For example, to designate French, you must specify: <Locale>fr</Locale>.
    • If you added the desired locale to the Predefined Locales page before installing or upgrading SSM, you can export the strings to XML in the desired locale without having to use search and replace.
  9. Translate the <Value> for each key as needed. If an override is used, edit the <Override> value to update the translation that appears in SRC.
    Important: For on-demand customers, you must use the <Override> element to override or translate an existing key. You cannot import new keys, and if you attempt an import and you specify a new value for a key, it will be ignored.
  10. In Application Administrator, select the Import tab, and then import the file.

Translating MLS Runtime Object Strings Using XML

Review the following section to learn about exporting SRC MLS runtime object strings to XML for translation.

Each string in the XML is a separate runtime object that is identified by uuid, with strings for each locale that you selected at the time of the export.

There are two types of MLS Runtime strings that you can translate in SRC:

  • KM Categories: Name
  • KM Visibility Group: Title

The values in both of these fields are available for export to XML if the Allow translation for value display in relational fields check box is selected on each field in the Options tab in SBM Composer and the process app is either promoted after a new SSM install or when the Knowledge Management process app is re-deployed after an upgrade.

Important: If you are upgrading to SSM 5.2.2 or later, you must manually select this option in SBM Composer and re-deploy the process app.

The following XML shows the KM Categories: Name field after it has been exported using the French locale:

<Table dbname="TSM_CATEGORIES" name="KM Categories" 
uuid="e8af206b-c333-48b2-ba40-f17b2ec68550">
<Field dbname="TITLE" name="Name" 
uuid="0c6d9e0e-16e3-49f9-a44d-67f72e4852ee">
<Obj Iden="0" uuid="b48b705f-ee74-468a-a356-b072445ab8bb">
<Str Loc="fr_FR">Hardware</Str>
</Obj>
<Obj Iden="0" uuid="d7a64711-c26d-41a9-8fe7-3485fc8e073a">
<Str Loc="fr_FR">Access and Directory</Str>
</Obj>
<Obj Iden="0" uuid="d6de174f-0863-4b12-bbe8-1214fa96da73">
<Str Loc="fr_FR">Telephone and Network</Str>
</Obj>
<Obj Iden="0" uuid="0306583a-67ac-44da-8758-10d619f3a12b">
<Str Loc="fr_FR">Facilities</Str>
</Obj>
<Obj Iden="0" uuid="617c8640-ea43-4e02-9084-6dd9326d4d55">
<Str Loc="fr_FR">Enterprise Applications</Str>
</Obj>
<Obj Iden="0" uuid="29ea3235-a3f0-4720-996b-afdbddc6b8ca">
<Str Loc="fr_FR">Data and Backup</Str>
</Obj>
<Obj Iden="0" uuid="d88a0a1c-4d99-4927-b630-972615674437">
<Str Loc="fr_FR">Email Management</Str>
</Obj>
<Obj Iden="0" uuid="ec403323-35e4-46dc-a3bc-00e55e760c3d">
<Str Loc="fr_FR">Software</Str>
</Obj>
<Obj Iden="0" uuid="cfb48687-a423-42b7-a96a-59b031d9a3f3">
<Str Loc="fr_FR">Other</Str>
</Obj>
</Field></Table>

To translate these strings into French, simply modify the English value that appears after <Str Loc="fr_FR"> for each string. The steps below walk you through the process of exporting, translating, and then importing the XML back into Application Administrator.

To translate SRC MLS runtime object strings using XML:

  1. In the Localization | Settings tab, select Allow translation for MLS Runtime Objects and Design Objects if it is not selected already.
  2. Select the Export tab.
  3. Select the MLS / Runtime type.
  4. Select the locale you want to export.
    Important: You cannot change the "Root" value by importing modified XML—translated values for the root locale are ignored when you import the XML. You can only change root values directly in the object itself. In other words, to change the root values for the KM Categories, you must edit each category name in the KM Categories auxiliary table via Manage Auxiliary Data in Application Administrator. This applies to the root values for the KM Visibility Groups as well.
  5. Select the values to export (KM Categories: Name) or KM Visibility Group: Title.
  6. Click Export and save the file.
  7. Open the file of exported strings in an XML or text editor.
  8. Change the Str value for each string you want to translate.
  9. Save your changes to the XML file.
  10. In Application Administrator, select the Import tab, and then import the file.

Copyright © 2012–2017 Serena Software, Inc., a Micro Focus company. All rights reserved.