Multi LanguageThe 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.
- Multi Language Use Cases
- How Multi Language Works
- Adding a New Language
- Translating your Steps
- Exporting and Importing .xliff files
- Best Practices
Let's Talk A Bit More
- Translate a Walk-Thru, Shuttles, ShoutOuts etc., into another language
- Help non-English speaking users complete processes without changing the native language of your application
After a Walk-Thru, ShoutOut, Survey, Launcher etc. is initially built, translations of the text is made using the Multi Language Feature. The first language used in the Editor will become the default language for all your Walk-Thrus, Menu, and General Settings. Once WalkMe items are completed 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 the translations. A .XLIFF import and export option is available to translate items using professional localization systems such as Crowdin or POEditor. Once translations are complete, publish all translated WalkMe items and then users will have the option to select a language from the toggle menu in the corner of the Player Menu or WalkMe can automatically change the language in the Player based on the website’s language.
The Toggle is the default option for Multi-Language and allows the user to select a language from a Drop Down box within the Player Menu. Once a user switches the language WalkMe remembers this information using a cookie. When the Player Menu is re-opened, it will appear in the language originally selected by the user.
Auto-Toggle is the recommended and most widely used method to using Multi-Language. This approach will automatically change the language in the Player Menu based on the current language. This method is recommended for performance optimization. WalkMe looks for a function called walkme_get_language, which your team needs to implement on your site. This function should return the Language Short Name you specified in WalkMe Analytics during the Language Setup (see below). 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 in their chosen language.
Auto-Toggle is not available on pages in which changing the language does not trigger a page refresh, for example Single Page Applications. If you have a Single Page Application, use and the Toggle or Language Push API method. If you are using WalkMe on a website in which you cannot implement a function, such as Salesforce, contact your customer success manager or our support team at firstname.lastname@example.org.
Language Push (API)
When a website does not automatically refresh after a language is selected, the Language Push approach must be used. With this method, the Website will change the Player Menu to the correct language using an API call. First, a function call that checks that WalkMe is fully loaded should be implemented on the site. Once the function named walkme_ready() has loaded, WalkMe knows that is has completed loading, at which time the push to a new language can occur. Once WalkMe is loaded the API call WalkMeAPI.changeLanguage('language-short-name') will push the new language into the Player Menu.
Adding A Translation
- Go to insights.walkme.com
- Click Account, from the top bar. Your account page will appear
- Click Text and Multi Language, from the side menu.
- Click Add New Language
- Configure language details
- The Short Name is visible to you through analytics.walkme.com, and is used in the Auto-toggle and Language Push methods.
- 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
- Click Save
Add Manual Translations
- From the Multi-Language tab, select WalkMe App or Feature from upper tabs
- 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.
- Once complete, open the WalkMe Editor and Publish all newly translated WalkMe Items
Exporting And Importing Translations
Walk-Thrus, SmartTips, Surveys, ShoutOuts, and Launchers may be exported as an .XLIFF (V1.2) XML file in order to facilitate the translation process using localization services such as POEditor or Crowdin. While steps are being translated, we recommend no additional changes be made in the editor. If additional items are created, a new .xliff file should be exported to include all updates. When an XLIFF file is imported a import log file is generated and may be downloaded to get details about the translation status.
How to Import or Export .XLIFF file
The export and import feature is not available for your default language. You must add additional languages to use this feature , see Adding a Translation above to learn more.
- Go to insights.walkme.com
- Click Account from the top bar. The account page will appear.
- Click Text and Multi-Language from the side menu
- From the Languages panel click the Import or Export button next to the language you wish to translate. To export all languages at once, click the Export All Languages button.
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. WalMe 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.
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