Download as PDF
Follow these quick and easy steps to get started using WalkMe.
WalkMe Compass offers in-app, step-by-step guidance to help you on this subject. Click on the links throughout the article to be redirected to the WalkMe Editor. You must be logged in to your editor in order for the guidance to launch.
→ View the Getting Started Overview Guide
1. Install the Editor
The WalkMe Editor is used for building, managing, and publishing Smart Walk-Thrus and other WalkMe Apps. The Editor is a desktop application that allows you to build on your platform through your browser.
To begin, view the editor download page.
2. Set Up a Builder Chrome Profile
While building with the WalkMe Editor, all of the WalkMe content on your page will be temporarily replaced by the content that you’re building and testing.
For this reason, we recommend using a separate Chrome Profile for building with WalkMe, so that your Published WalkMe content will still be visible from your default Chrome Profile.
To begin, view the Chrome Profile Setup Guide.
3. Install the WalkMe Extension
The WalkMe Editor Extension connects the WalkMe Editor to your browser, allowing you to build WalkMe content on your own platform. Be sure to install this extension on your WalkMe Builder Chrome Profile.
To begin, view the editor extension download page.
4. Install the WalkMe Snippet on your platform
Copy the snippet from your WalkMe Editor:
- Click the Menu button.
- Copy the snippet from the Snippet tab.
- Once you have your snippets, contact your IT team to have these snippets installed on your platform in the correct environments. Give your IT team the WalkMe Deployment Guide so that they are able to install this snippet into your platform.
- To test your snippet, run the command “ _walkMe.getEnvId() “ in your console.
- This command will return a value indicating which environment loaded:
0=Production
1=Preview
2=Play
3=Test - If the command does not return a value, or returns the wrong value, your snippet is not installed correctly.
5. Set up your Unique User Identifier
To distinguish between different users, you will need to expose a Unique User ID on your platform.
Click here for a guide explaining how to set up variables on your platform.​
You may also choose to include additional variables in this object, such as user role, location, segmentation information, etc.
6. Implement Unique User Identifier Settings
- To access the WalkMe ID settings, click the settings tab in the main editor window.
- In the general tab of the WalkMe settings, change the WalkMe Identifier to a variable from its default. Add the UUID set up by your IT team to the text box.
