Multi-Language

Updated on June 11, 2019
Download PDF

The Multi-Language feature lets you translate a Walk-Thru you have created in different languages without having to rebuild it. This enables you to engage your user in their language.

The Short Version

Multi-Language allows you to add translations to WalkMe Items you’ve created so you can support a global audience. Users either select the language from a toggle in the Player Menu, or you can configure WalkMe to change the language automatically. Translations are done from the ACCOUNT tab which is accessed from Insights.

WalkMe does not translate text you create, though we do allow you to export either an .XLIFF file, which is used by popular localization services, or an .XLSX Excel file, which is better suited to human translation.

Additionally, should you desire to only translate a portion of a WalkMe item’s text, you now have the option to export and import specific items’ text, as opposed to all text at once.

Use Cases

  • Translate Walk-Thrus, Shuttles, ShoutOuts, etc., into alternative language(s);
  • Help non-English speaking users complete processes without changing the native language of your application.

How It Works

After building a Walk-Thru, ShoutOut, Survey, Launcher, etc., you can use the Multi-Language feature to create translations of their text. The first language used in the Editor will become the default language for all your WalkMe items, the Player Menu, and General Setting sections.

Once WalkMe items have been created in the Editor, sign into insights.walkme.com and click on the ACCOUNT tab. From here, you can access the Multi-Language feature to enter your translations.

You can opt to export for translation either XLIFF (best for outsourcing translation and localization) or Excel files of .XLSX file format (best for when you are translating content yourself).

Once your translations are complete, import the files and publish every WalkMe item for which translations were imported in the appropriate environment.

Your end-users will now have the option to select a language from the toggle menu in the Player Menu, or you can configure WalkMe to automatically change the language in the Player Menu based on a language variable in your website’s JavaScript.

Toggle

The Toggle is the default Multi-Language language-selection method for your end-users, allowing them to select a language from a drop-down menu within the Player Menu. Once an end-user switches the language, WalkMe remembers this information using a cookie. When the Player Menu is re-opened, text will appear in the language previously selected by the end-user.

Auto-Toggle is our recommended (and the most widely used) method of implementing Multi-Language. Auto-Toggle will automatically change the language in the Player Menu based on the current language variable on your website. This method is best for performance optimization, and is strongly recommended for WalkMe solutions for Salesforce, Workday and SuccessFactors. Click here to learn how to enable Auto-Toggle.

When Auto-Toggle is enabled, WalkMe looks for a function called walkme_get_language, which your dev team needs to implement on your website. This function should return the Language Short Name you specified in the ACCOUNT tab’s Text & Multi language section in insights.walkme.com during your initial language setup (see the Adding a Language section below).

Note: The walkme_get_language function needs to be available on every page on which WalkMe has been implemented to ensure the translation always occurs. If a user manually selects a language, the Auto-Toggle will be overridden. WalkMe will remember the user’s language choice and continue to display text their chosen language.

Auto-Toggle is not available on pages in which changing the language does not trigger a page refresh, such as Single-Page Applications. If you have a Single-Page Application, use the Toggle or Language Push (API) method. If you are using WalkMe on a platform on which you cannot implement a function, such as Salesforce, contact your customer success manager or the WalkMe Support team at support@walkme.com.

Language Push (API)

When a website does not automatically refresh after a language is selected, you may opt to use the Language Push (API) method. The Website will change the Player Menu to the correct language using an API call.

First, a function call named walkme_ready() that checks whether WalkMe is fully loaded should be implemented on your website. Once the function has loaded, WalkMe knows that it has completed loading, at which time the API call for a new language can occur. At this point, the API call WalkMeAPI.changeLanguage (‘language-short-name’) will push the new language into the Player Menu.

What Does an XLIFF XML File Contain?

XLIFF (v1.2) XML File
The XML file is comprised of trans-units that contain text to be translated into your desired language. Each Trans-unit has a Type, ID and Text Field Name. WalkMe uses this information during the import process, but you can use this information to help understand what is being translated. The trans-unit type designates the object type being translated.

For example, in the image below we are looking at steps in a Walk-Thru, so the trans-unit type is “Step”. Each step has its own unique ID which WalkMe uses to identify it and each step has two translatable text fields, the “StepTitle” and “StepText”.  Here we see that the top two trans-units have the same ID but different text field names. One display text from the StepTitle and the next is the text from the StepText.

Trans-units are organized into groups with parent IDs that WalkMe uses to identify which App and specific item the trans-units belong to. For example, the group ID for a Walk-Thru would first identify the App and then the following group ID would identify the specific Walk-Thru that the trans-units belong to. Each trans-unit would then represent the different parts of a step that can be translated.  Group IDs are used by WalkMe during the import and should not be translated or removed from the XLIFF file.

Adding A Language

  1. Click ACCOUNT in the top bar;
    • Your account page will appear.
  2. Click Text and Multi-language, from the side menu;
  3. Click Add Language:
  4. Configure the language details;
    • The Short Name is used in the Auto-Toggle and Language Push (API) methods;
      • IMPORTANT: The Short Name may only contain alphanumeric characters (i.e., letters or numbers) and hyphens.
    • The Display Name is what appears to the end-user in the Player Menu;
    • Show In Player gives the option to either show or hide a translation from the end-user in the Player Menu;
    • Copy From allows you to copy a translation from another language.
  5. Click Save.

Translation Methods

Add a Manual Translation

Note: This method is best used when you are translating one or two languages internally. With any more, we advise using the export to Excel or export to XLIFF methods, depending on your preferred translation method.

  1. From the Multi-language tab, select a WalkMe item from the drop-down menu;
  2. Enter Translated text in right columns;
    • Each language displays as a different column to the right of the default language. As you type your work is saved:
  3. IMPORTANT: Once complete, open the WalkMe Editor and publish all newly translated WalkMe Items.

Exporting And Importing Translations

Walk-Thrus and/or Smart Walk-Thrus, SmartTips, Surveys, ShoutOuts, and Launchers may be exported as an .XLIFF (V1.2) XML file

Note: The export to XLIFF method is recommended when you are translating multiple languages and outsourcing your translation needs to a translation/localization company such as POEditor or Crowdin.

Walk-Thrus and/or Smart Walk-Thrus, SmartTips, Surveys, ShoutOuts, and Launchers may be also be exported as an Excel file of .XLSX file format

Note: The export to Excel method is recommended when you are translating multiple languages yourself, as the Excel UX is more friendly for human interpreters.

As mentioned earlier, should you desire to export only a specific items’ texts for translation, you may now export specific items as opposed to all items at once.

How To Export and Import an .XLIFF File

The export and import feature is not available for your default language. You must add additional languages to use this feature. (see the Adding a Language section above).

  1. Go to insights.walkme.com;
  2. Click ACCOUNT from the top bar.;
    • The account page will appear.
  3. Click Text and Multi-language from the side menu;
  4. In the Languages panel click the Export icon next to the language you wish to translate. To export all languages at once, click the Export All Languages button:
  5. Toggle the radio button to XLIFF in the popup that appears;
  6. Uncheck any items that you don’t want to export;
  7. Click EXPORT;
  8. After having the file’s text translated, import the file back by clicking the import icon next to the relevant language;
  9. IMPORTANT: After importing your translations, be sure to publish all newly translated WalkMe items in the appropriate environment in order for the new translations to be available to your end-users.

How to Export and Import an Excel .XLSX File

  1. Go to insights.walkme.com;
  2. Click ACCOUNT from the top bar;
    • The account page will appear.
  3. Click Text and Multi-language from side menu;
  4. In the Languages panel, click the export icon of language whose file you wish to export;
  5. Toggle the radio button to Excel in the popup that appears;
  6. Click EXPORT;
  7. Open the file and enter your translations into the Language column;
  8. After translating the file’s text, import the file back by clicking the import icon next to the relevant language;
  9. IMPORTANT: Be sure to publish all newly translated WalkMe items in the appropriate environment in order for the new translations to be available to your end-users.

How to Export Specific Items

  1. Follow instructions in the tutorials above until you’ve reached the portion where you determine which content to export;
  2. Click/check checkboxes of items you wish to include in the exported file and proceed to download by clicking Export.

Best Practices

General Best Practices

  • Make sure that that you / your translating company does not translate BBcode (anything between the brackets […]);
  • For Excel files, keep the exported file in the exact same format vis a vis name, tabs, columns, etc. Work only on the language column;
  • We recommend only exporting files once the solution is final and that no changes be made prior to importing the files back in;
  • Avoid using text images in WalkMe items and the Zembezi Widget, since these cannot be translated by Multi-Language;
  • During text translation, we recommend against making additional changes in the Editor. If additional items are created, a new .XLIFF or .XLSX file should be exported to include all updates. When an .XLIFF or Excel .XLSX file is imported, an import log file is generated and may be downloaded to obtain details about the translation status.

Multi-Language For Walk-Thrus

  • Your Walk-Thru should be built to ignore text, and within the Rule engine avoid using “Text is” since this will change depending on the language selected. Ask your CSM to enable a feature that will make all steps “ignore text’ by default;
  • Check the balloon size and position in different languages. The positioning may need to be adjusted because the length of the text will vary from language to language;
  • If one of your translations include a Right to Left language change, be sure to test this translation thoroughly.

Multi-Language For Launchers

  • Text within a Launcher image is not translated. If a Launcher is meant to work in two languages, it is recommended to use a Launcher with no text;
  • Use the Customize Launcher Tab to create your Launcher. No Launchers with images, or Launcher from the Gallery.

Was this article helpful?

Related Articles