Install a translation file for the XC Business Tools

Abstract

How to install a language translation file for the Commerce Business tools that lets you display the business tools in a language other than English.

Sitecore XC Business Tools lets users select a language in which to display the graphical user interface (GUI). By default, the XC Business Tools GUI displays in English. To provide business users the ability to display the XC Business Tools other languages, you must first download and install the translation file into the Sitecore Experience Platform.

The way in which you install a Business Tools translation file depends whether you use one of the translation resource (.dat) files that Sitecore provides for Danish, German, and Japanese, or whether you want to install your own XML translation file.

Note

With each release, Sitecore provides XC Business Tools translation files for Danish, German, and Japanese. Sitecore is configured to support these languages by default. You can download translation resource files for these languages on the Sitecore Downloads site.

For any other language support, you must provide your own translation XML file.

Starting with Sitecore Experience Commerce 10.2, translation Sitecore translation files are provided as items resource files (.dat files).

Install a Sitecore-provided translation resource file

To install one of the Business Tools translation files that Sitecore provides:

  1. On the Sitecore Downloads site, go the Sitecore Experience Commerce release page and, in the Translations section, download the Business Tools translations resource package on your Sitecore server instance.

    Note

    The downloaded ZIP package contains translation files for the Danish, German, and Japanese languages.

  2. Extract the ZIP file, open the Content folder, right-click on the ZIP file corresponding to the desired language, for example Sitecore Commerce Engine Connect (de-DE) *.*.**.zip, and then extract the content to the items folder in the following location in Sitecore: \inetpub\wwwroot\<Sitecore>\sitecore modules\

    Note

    The structure of the items folder included in the ZIP package matches the structure of the items folder in Sitecore. As a result, the translated files are copied to the appropriate location under \inetpub\wwwroot\<Sitecore>\sitecore modules\items\ (in the master/localization, core/localization and web/localization folders).

  3. Open Internet Information Manager (IIS) and restart the IIS service.

  4. To verify that the translation file is available in Sitecore, on the Sitecore Launchpad, click Content Editor, go to Sitecore/Commerce/Commerce Control Panel/Commerce Engine Settings/Commerce Terms/Systems Messages, and click any system message item.

  5. On the ribbon, on the Versions tab, in the Language group, click the language you imported, for example German (Germany). In the Content area, in the Value field, you can see the translated string, as shown in the following example:

    An example of a translated Commerce term item version, in German.
  6. In Postman, run the Sync content path sample request to make the new language added to Sitecore available in the Business Tools.

  7. In Postman, in the SitecoreCommerce_DevOps/Caching, collection, run the ClearAllCaches (Redis only) to flush the Redis cache.

    When you launch Sitecore XC Business Tools and select the language you want to display, for example German, the interface now displays in that language, as shown in the following example:

    BizTool_Deutsch.png

Install a customer-provided translation file

If you do not use one the translation files that Sitecore provides on the Download site, you can install your own translation XML file.

To install a custom translation XML file:

  1. Store the language file you want to import in the following location C:\inetpub\wwwroot\<YourSitecoreServer>. This is where the file must be stored so that you can access it in subsequent steps.

  2. On the Sitecore Launchpad, click Control Panel and in the Localization section, click Import languages.

  3. In the Import Languages dialog box, click Browse. The Open Language File dialog box opens.

  4. Click Browse, select the language file to import (for example, es-ES.xml ), and then click Open.

    Open_Language_File_es.png

    Note

    If you cannot find the required language file in the Open Language File dialog box, make sure that it is stored in C:\inetpub\wwwroot\<YourSitecoreServer>.

  5. In the Import Languages dialog box, click Next, and click Next again to confirm the language to import.

  6. In the Database drop-down list, click Core, and then click Import. A dialog box notifies you when the import operation is complete.

    Note

    Items in the translation file with the database set to "master" override the database selection you make in the Import Language dialog box.

  7. To verify that the translation file is available in Sitecore, on Sitecore Launchpad, click Content Editor, go to Sitecore/Commerce/Commerce Control Panel/Commerce Engine Settings/Commerce Terms/Systems Messages, and click any system message item.

  8. On the ribbon, on the Versions tab, in the Language group, click the language you imported. In the Content area, in the Value field, you can see the translated string, as shown in the following example:

    ES_Language_version.png
  9. Open Internet Information Manager (IIS) and restart the IIS service.

  10. In Postman, run the Sync content path sample request to make the new language added to Sitecore available in the Business Tools.

  11. In Postman, in the SitecoreCommerce_DevOps/Caching, collection, run the ClearAllCaches (Redis only) to flush the Redis cache.

  12. In the Business Tools, when you choose the installed language in the language picker, the user interface is displayed in that language.