Variables Cheatsheet

Download as PDF

What are Variables?

A Variable is useful information about a user such as role, access level, department, email or user ID that is stored on a web page.

How does WalkMe use Variables?

Segmentation Center: Variables are particularly useful in identifying user attributes such as Roles, Salesforce Admin Access, and Department. This information can be used to Segment the WalkMe assets you build to ensure that only content relevant to that user type is visible.

Individual User Reports: Variables can also store information unique to the user such as an email or ID number. With this information we can create Analytics reports about individual users to monitor their usage of WalkMe and completion of important businesses processes.

How do I create a Variable?

The best resource for creating these variables is your Development or IT Team. In order to effectively communicate to the relevant team, outline what your variable is supposed to measure (the different values) and the name of the variable you’d like created.

For example, you could have a variable called User_Profile that contains values such as Admin, Sales, Marketing, Management, etc. Other commonly used variables are ones that identify a unique user ID, permission level, or the date the user signed up for the platform. A Global Variable is attached to the window object and can be read by WalkMe at any time.

Once you have identified or created a variable, we can configure WalkMe to track or segment by this information.

Configuring Variables with WalkMe

Once the variables have been created, you will need to configure WalkMe to look for them. This configuration applies only to variables that are being used for Analytics purposes or for the Onboarding app. No configuration is necessary if the variables are being used solely for Segmentation. Note that any variables configured in this manner will still be available for use in the Segmentation Center.

1. Click Settings in the Admin Bar.
   
2. Click General
   
3. Type in the name of your variable.
   

Using Variables for Segmentation

Variables are commonly used to Segment your WalkMe assets. To use your variable in a Segment.

1. 1. Open the Segmentation Center.
      
   2. Create a new Segment or Edit an existing one.
      
   3. Click on the pencil icon to create rules for the segment
      
   4. Click Add Rule
   5. Select User Data from the Rule Type, then select Variable. Type in your Variable Name. Select an operator and enter the Variable value you are trying to Segment by

Uses

WalkMe Points to Variables in order to read information about the user type, roles in the organization, and access level. WalkMe uses the information to segment WalkMe assets in order to target specific user groups. WalkMe does not change or alter any information on your site.

Requirements

Any variable which is accessible from the global window scope can be read by WalkMe. Variables that WalkMe points to must be:

• Accessible within the web browser console/on the page level
• Must be on every page

Creating a Variable

Variables already in your system can be easily adapted so that WalkMe can point to them. In order for WalkMe to read a variable, it must be attached to the window object.

Variable Example

var userRole = user.getUserRole()

In this example, a new variable called user role is declared using the object name and a function to call the relevant data. The object can relate to any data you already store about your user.

Attaching a Variable to the Window Object

window.userRole = userRole

Once the variable has been defined, we can use the template above to attach the var to the window object.