Precision settings allow you to customize the way WalkMe identifies elements on your website. Using Precision Settings you can see how easily WalkMe identifies a given element on your site and modify the way the WalkMe Algorithm works. Modifying Precision settings optimizes the way that WalkMe’s Algorithm performs on your site and is usually used to resolve issues or to maximize performance.
- What is Precision
- Common uses for changing Precision Settings
- How Precision Works
- Checking Precision
- Understanding Element Grades
- Re-Selecting your Element
- Fine-Tune Precision
- Resolving Common Issues
- Try It Out
Let's Talk A Bit More
Uses for Precision Settings
- Increase the Precision level of the algorithm if WalkMe Items appear on incorrect elements on your site
- Decrease the Precision level of algorithm if WalkMe cannot find your select element
- Ignore the text of your element if it may appear in multiple languages
- Ignore the ID for an element on your website when it changes constantly
- Use a jQuery Selector for Launchers that are Strong Pinned to optimize performance
- Ignore the position of a button that might move on the screen depending on the size of your browser window
Whenever WalkMe plays a Walk-Thru Step, shows a Launcher or displays a set of SmartTips it starts by scanning the page using our proprietary algorithm to try and locate your selected element. The WalkMe Algorithm uses a variety of factors, such as the text of your element, it’s placement on the page and other attributes in the HTML code such as ID and Class. Each element on your site, whether it’s a button, heading, field or link has unique attributes, some of them are more unique than others. To help you understand how unique an element is on your site we give it a precision level, a.k.a. Element Grade. This grade refers to how unique the element is and, how easily WalkMe will be able to find it again.
When an element is difficult to identify, has a low precision score, or when the code and layout of your site changes whenever a page loads or if the screen size changes, WalkMe may have trouble locating your selected element. When this happens WalkMe may misidentify the element on the page or simply not play your WalkMe item. To customize the way that the WalkMe algorithm works on your site you use the Precision tool to modify settings. Some Precision settings are modified globally, to all elements, by our specialists if we know that it’s necessary on your site, so it’s important to check with your CSM if you plan to change precision settings.
WalkMe gives an Element Grade based on how easily WalkMe can identify an element and distinguish it from all other elements on the page. The Element Grade is displayed in the configuration view for a Walk-Thru Step Balloon, Launcher, or SmartTips that appears immediately after selecting an element. It is found in the Precision tab in the Options Menu for the respective item. If you select an element to use as a Rule Type in the Rule Engine, find Precision Options by clicking on the gear icon.
Test an element’s grade by visiting the page on which your WalkMe Item should appear and open the Precision Settings. WalkMe analyzes the current page in the browser and gives the element a grade. If it does not see the element on this page, you will receive message “The element is not available on this page.”
View Element Grade in the Flow Tracker when testing a Walk-Thru to the right of the step. The Flow Tracker displays a “looking for element” magnifying glass icon until it locates the element on the page. Once the element is located, the Element Grade will appear to the left of the step in the Flow Tracker.
For elements used in a Rule, click the Rule in the Flow Tracker. If the element is found on the page then an eyeball with a check mark appears, if the element is not found then an exclamation point appears.
Understanding Element Grades
The Element Grade scale is out of five, where five green bars is the highest score possible.
Generally, we regard three (3) bars or higher as a good score. Elements that less than three (3) bars may still be identified consistently by WalkMe, but it’s recommended that you properly test these WalkMe Items to ensure that they do find your desired element. When using jQuery Selectors Precision does not display an Element Grade because it uses your selector to identify the element. Learn more about jQuery Selectors.
Re-Selecting Your Element
When you initially select your element, you have the options to modify your selection to try and improve the element grade. You can choose to either expand your selection, narrow your selection or simply reselect the element entirely.
After an element is selected use Precision Settings to view the Element Grade and to modify the way the algorithm works. Precision Settings are located in the options menu for your WalkMe items. To re-select your element, click Re-Select Element at the bottom of the options menu.
For Rules that use elements click the Re-select Element icon on your rule statement.
IMG of Rule Statement with Gear and Re-Select Element icon
Fine Tune Precision
Fine-tune the WalkMe algorithm to make sure it identifies your element correctly if necessary in the Precision tab in the Options Menu for steps, Launchers, and SmartTips. Precision can be altered by identifying by type of element, bypassing a selected characteristic, or by a modifying the general Precision Level.
Direct WalkMe to focus on certain attributes:
- Default: WalkMe uses the default settings for the algorithm
- Identify by Text: Identifies the element specifically by its text in the HTML code.This is only valid for elements that actually contain text that is identified in the HTML; some elements with text are images but do not contain text. When this option is selected, the text from the element will autofill in the input field (without spaces, not case-sensitive). Notice that when choosing this option, you can't use any other bypass options.
- jQuery Selector: Using a jQuery selector is the most precise way to identify an element because it allows you to create a custom selector to identify the element. Use a custom jQuery Selector when an element is very difficult for WalkMe to identify. Writing a jQuery Selector can help WalkMe to find elements if you use both multi-language and your website has dynamic IDs (the elements code changes when the page is reloaded).
Direct WalkMe to ignore certain attributes.
- Text: The algorithm ignores any HTML text within the element (number, text, or character). Bypass text for elements that appear in multiple languages or that may use dynamic text.
- ID: The algorithm ignores the element ID in the HTML code. If the Element you selected has a variable or dynamic ID (ID is constantly changing when a page is loaded), configure WalkMe to ignore ID.
- Position: The algorithm ignores the position of the element on screen. Use if an element changes location on screen. This may happen if your user has a different screen size and you site is designed to reformat the layout If you would like to apply one of these bypass options to all elements captured, contact your CSM who can quickly add this feature.
When WalkMe checks the page for an element, it analyzes all elements that match most of the attributes on the page and gives it a numerical score. The algorithm selects the element with the highest score and plays the step.
- High: Use this setting if elements similar to the one that was chosen are being identified by WalkMe (i.e. steps or launchers appear on the wrong element). Setting to High should avoid misidentification.
- Medium: This is the default WalkMe Precision Level and is sufficient in most cases.
- Low: Use this setting in cases where the algorithm has a hard time finding an element because the position of elements is constantly changing. Use this setting if WalkMe cannot find your element on the page.
Resolving Common Issues
My Element Grade is Low
An Element Grade less than 3 bars is not necessarily an issue. Start by testing out your Walk-Thru in Preview mode and even on a Test environment of your website. Your item may not actually have any issue, but if WalkMe cannot find your element or it appears on the wrong element use the steps listed below.
I need to Strong Pin a Launcher or SmartTip
If you want WalkMe to continually look for an element so that when it appears a Launcher or SmartTip will be displayed, then you must add a jQuery Selector in the Precision. jQuery Selectors help WalkMe to identify your element without affecting performance. Using Strong Pin on a Launcher or SmartTip without adding a jQuery Selector may cause performance issues and is not recommended.
Walk-Thru Step, Launcher or SmartTip appears on the wrong element.
Try changing your Precision level to High or re-selecting the element. If the issue persists try using the Identify by Text type or writing a jQuery Selector. If you use Multi-Language avoid Identify by Text and use a jQuery Selector.
Walk-Thru Step, Launcher or SmartTip element cannot be found.
Try changing your Precision level to Low or re-selecting your element. If the issue persists, try using some of the Bypass options. Often ignoring ID can resolve any issues if an element’s ID changes whenever a page is reloaded. If this does not help them use a jQuery Selector.
Try it Out
- Create a Walk-Thru Step. Open your Precision settings and see how the Element Grade changes when you select different Precision Levels and Bypass options.
- For a Rule that uses On Screen Element or Selected Element click the Gear icon and check your Element Grade. When selecting an element try using the Expand Selection and Narrow Selection buttons to see how your selection and element grade changes.