Define Localization Properties for a Site

The Portal can be easily translated into other languages, even languages into which the main CSM product has not been translated. To do so, you must:

  • Translate strings that are used throughout the Portal. This includes error messages and general display items.
  • Translate each Site in the Portal. This includes the text for menu items and other commands.
  • Specify custom options for each language, such as a custom Startup Item.

Use a Site's Localization page to export the Sites and Portal strings to an XML file that can be translated, and then import the translated strings. The XML file will contain referenced values for each string that can be displayed in the particular Portal, for example:

<Property Name="Header_TitleText">IT Self-Service</Property>

If this is edited to be in German:

<Property Name="Header_TitleText">Informationstechnologie</Property>

Then, when the German version of the Site is displayed, the title text for the header will use the German version instead of the English version. Many of the string names in the XML file contain IDs for reference, but the context should be clear from the rest of the name and the current value.

To define Localization properties for a Site:

  1. Open a Site in the Site Editor.

    The Site Editor opens and displays a preview of the Site. The Site Properties window opens within the Site Editor and displays the Site's current properties.

  2. Click the Localization page.

    Site Properties Localization Page

    Note: If you have already defined translation properties for the culture, you can select it in the list and click Export; otherwise move to the next step.
  3. Define translation properties for the culture to which you want to translate:
    1. Click the Add button.

      The Site Localization Properties window opens, alphabetically listing the available cultures (both the language/country and culture code are displayed to make it easy to find the correct culture).

    2. Language/country or culture code: Select a culture to which to translate using either drop-down. The Name field automatically defaults to the language/country.
    3. Flag/icon: The image identifies the culture by flag. This will be displayed next to the language in the Language Selector on the Site Application Bar. Click the icon to change it, if needed.
    4. View: If you have a custom View defined for the language, select the view here. If the option is left as Role-based, then if there is a view associated with a selected view that has an appropriately assigned language, that Role/View will automatically be used:
    5. Site Overrides: Select Startup Site Items for the translated Site if you have a custom-translated item (such as a translated Dashboard or HTML Page). If you do not select anything here, the Startup Item will be the same as for the OOTB Site.
      Note: This is the Site Item that displays when a Customer initially accesses a Site.
      1. Customer startup action: Select the Site Item to display when a Customer initially accesses the Site. The Site Item can be an Action Catalog (special Widget), a Dashboard, a Document Repository, an HTML page, a Report, or a Search Group (used to display a list of records).
      2. Customer login action: Select this check box to display a different Site Item if/when the Customer logs in. Then, select the Site Item to display.
    6. Define login options for the translated Site. If you want to have alternative text or a Privacy Link on the login window, you can enter it by clicking the Login Options button:
    7. Click OK.

      The culture is added to the list and OOTB language options now display in the window.

  4. Export all the Portal strings into an XML file that can be translated:
    1. Select the Localization/culture to export.
    2. Click the Export button.

      The Export window opens.

    3. Click the Browse button to select a destination for the exported strings file (Cherwell Localization Definitions go into files with the .cld extension).
      Note: The following check boxes are only relevant when exporting a previously-translated Localization.
    4. Include all portal strings: Select this check box to delete any strings that were removed from the Site since the last translation (for example, if you have removed items from the Site menu bar, checking this check box would remove them from your Localization file).
    5. Remove strings that are no longer used: Select this check box to delete any strings that were removed from the Portal since the last translation. For example, in the next version of the Portal there might be a couple of messages that are no longer used. Checking this check box would remove them from your Localization file.

      Tip: After the export you will be given a chance to view the file. The first time, you will most likely have to pick a file association before the file can be opened. The export file holds XML so it is best to associate an XML Editor with the .cld extension. You can also use Windows Explorer to set up the file association.

  5. Translate the exported XML file using an XML Editor, your favorite translation tool, or even Notepad.
  6. When you have finished translating the file, click the Import button to import the file back into CSM.
  7. Associate a culture with the default Site: This allows for the default language to display in the Language Selector on the Site Application Bar.
    1. Language name/Language: Select a culture using either drop-down. The Name field automatically defaults to the language/country.
    2. Flag/icon: The image identifies the culture by flag. Click the icon to change it, if needed.
    3. Show language selector on application bar: Select this check box to give Customers a choice to display either the translated or default Site.
  8. Click OK.

© Copyright 2016 Cherwell Software, LLC. All rights reserved.