Flow Tracker

Last Updated November 5, 2024

Download as PDF

Brief Overview

The Flow Tracker is used to test and evaluate WalkMe items, which makes it one of the most important tools used in content integrity testing. Once activated, it appears as a small window on the page showing real-time information on the following:

• Step Tracker (current Smart Walk-Thru step)
• Goals Tracker
• Smart Walk-Thrus
• Launchers
• SmartTips
• ShoutOuts
• Surveys
• Engaged Elements
• Specific alerts
• General system information
• Segments and conditions applied to content and their evaluation
• Auto Play rules and frequency
• CSS added via the Editor

Use Cases

• Verify that Smart Walk-Thrus, Launchers, SmartTips, ShoutOuts, or Surveys are working as expected before publishing

• Verify an Engaged Element's page settings & element within a published environment
• Identify if Smart Walk-Thru step starting points are getting triggered correctly
• Confirm that goals are being tracked at the right place
• Troubleshoot an item that is not playing as expected by checking its associated conditions & segments, and auto-play setup
• Easily reset local Auto Play information for testing - Content that is set to display only Once, or Once a Day & Cancel Auto Play Settings 
• Temporarily reset local Onboarding Tasks progression to ensure they work smoothly

• Reset all locally stored WalkMe data for easier testing

• Check CSS rules on the page before applying them in the Editor

How to Activate

Go to Settings → General tab

Scroll down to WalkMe Flow Tracker Settings

• Activated in Play Mode: Flow Tracker automatically launches when an item is played from the Editor (see limitations)
• Activated in Preview Mode: Flow Tracker automatically launches when items are previewed from the Editor
• Accessible in Published Environment: Flow Tracker is accessible in the Published Environment, but does not start automatically

How to Use

Minimized View

Play or preview your items, and the Flow Tracker will open in a minimized view.

1. Expand button: Opens the Flow Tracker in a full view
2. Mode indicator: Displays the environment the Flow Tracker is currently opened in
3. X button: Closes the Flow Tracker

Maximized View

The Flow Tracker maximized view allows for a more comprehensive view, from displaying real time information on the different items to examining the overall system settings and additional troubleshooting capabilities.

• Step Tracker: Default tab the Flow Tracker will open in. It will track the Smart Walk-Thru as it plays, listing information like steps, triggers, etc.
• Smart Walk-Thrus / Launchers / SmartTips / ShoutOuts / Surveys / Engaged Elements: a list of all items you selected for testing, or all items published to the current environment
• Settings: 
  • General: View general information such as Onboarding, Safe Start, integrations, last publish date, and more
  • Storage: Temporarily reset current user Onboarding Task progress and all stored data used by WalkMe in your browser
  • Alerts: View alerts and explanations when something goes wrong so you can take corrective action
  • Custom CSS: All Custom CSS for the WalkMe system
  • Segments: See the segment rules and their evaluation
  • Clear All: Clears all content from the Flow Tracker 

Step Tracker

When an item is played, the Step Tracker tab displays the step-by-step events. Each line represents a different step.

1. Step types:

• Step
• Split Step 
• Popup Step
• Wait For Rule
• Branch Step
• Error Handling Rule
• Custom Action
• Switch to Frame
• Set WalkMe Data
  • Click 'Data' to see the WalkMe Data value, duration and expiration time.
    • The expiration is updated with each time the prompt is opened
    • 'Reset' will clear this specific WalkMe Data within your current browser
      Did you know?

      This information is also available under the Smart Walk-Thrus tab, for each Smart Walk-Thru that has WalkMe Data steps within your environment.

2. Trigger type:
   - Click - Next - Input - Hover - Multiple Balloon - Delay - Refresh
   - Custom Trigger

When hovering over the icon, a tooltip with a question mark will appear. Clicking on it will take you to the Help Center.

Step triggered: Indicates whether a WalkMe step was triggered. A step trigger is a condition that must be met before a WalkMe step is displayed. In other words, the trigger determines when the step will be displayed. For example, a step can be triggered if a user clicks on an element.

Step played: Indicates whether a WalkMe step has been displayed to the user or not. If a step has been displayed, it is considered "played".

Smart Walk-Thrus 

View your Smart Walk-Thrus, and their detailed step breakdown, with the option to trigger a specific step.

• Conditions: View the evaluation of display conditions and segments, if any were applied 
• Auto Play: View the evaluation of the Auto Play rules, and the set frequency
  • If the item has already played, and is prevented from playing again due to its Auto Play settings, a reset option will be available for ease of testing
• Eye icon: Indicates whether the element your item is attached to is visible on the page
  • Hovering over the eye icon will highlight the captured element on screen for the associated step

Launchers

• Conditions: View the evaluation of display conditions and segments, if any were applied 
• Eye icon: Indicates whether the element your item is attached to is visible on the page
  • Hovering over the eye icon will highlight the captured element on screen for the Launcher 

SmartTips

• View your SmartTip sets, and the SmartTips attached, by clicking on the SmartTip set name.
  • Conditions: View the evaluation of display conditions and segments, if any were applied
  • Eye icon: Indicates whether the element your item is attached to is visible on the page
    • Hovering over the eye icon will highlight the captured element on screen for the SmartTip

ShoutOuts

• Conditions: View the evaluation of display conditions and segments, if any were applied 
• Auto Play: View the evaluation of the Auto Play rules, and the set frequency
  • If the item has already played, and is prevented from playing again due to its Auto Play settings, a reset option will be available for ease of testing

Surveys

• Conditions: View the evaluation of display conditions and segments, if any were applied
• Auto Play: View the evaluation of the Auto Play rules, and the set frequency
  • If the item has already played, and is prevented from playing again due to its Auto Play settings, a reset option will be available for ease of testing

Engaged Elements

• Page settings: View the evaluation of the rules set
• Eye icon: Indicates whether the element your item is attached to is visible on the page
  • Hovering over the eye icon will highlight the captured element on screen for the associated Engaged Element

Goals Tracker

View information on the goals you have set for your item.

• Goal Info: View the goal description 
• Red exclamation mark: Indicates that the goal hasn't been reached yet
• Green checkmark: Indicates that the goal has been reached

Settings

General

Get information about specific system features.

• Enabled/Disabled & Display Conditions
  • Onboarding
  • Widget Display
• Search Integration
• Safe Start
• Live Chat Integration
• Help Desk Integration
• Change language
  • Manually change the currently detected language for testing purposes
    Did you know?

    If the language was changed through this setting, it will override the automatic detection (Auto-toggle). To reset and restore the automatic detection, use the 'Reset all data' option under the Storage tab in the Flow Tracker settings and refresh the page.
    

    Note

    This functionality is not available in quick preview. Please switch to multi-language preview or a published environment.

• Last publish date in the current environment

Storage

• Reset all data: Clear any existing WalkMe data stored within your current browser
• Reset Onboarding Tasks data: Temporarily reset the current user Onboarding Task progression

Custom CSS

See all the CSS that was created on this system, change it, and view the result.

Alerts

The following alerts may be shown:

• Domain Conflict. Your Smart Walk-Thru is attempting to play a step on more than one domain. Please reach out to Support for more information.
• Your browser extension is active on this page. An indication that the WalkMe User Extension is currently loading WalkMe on the current page.

• Protocol Conflict. A content, image, or video loaded by WalkMe doesn't match your site's security policy
• This is a single-page application. WalkMe has detect element(s) on the current 

Segments & Condition evaluations

You can see conditions, segments, their evaluation, and any auto-play rules assigned to the item.

• In the General tab → Segments, you can also see segment's rules
  • To easily see a specific segment rules, click the Arrow icon within the condition window, which will redirect you to the Segments tab and highlight the segment and its rules
• Green frame and checkmark: Indicates the condition is met (true)
• Red frame and an exclamation mark: Indicates the condition isn't met (false)

Auto Play

• View dedicated Auto Play rules and the configured frequency.
  • Specifically for ShoutOuts & Surveys - The button will appear differently depending on what kind of rules are applied.
    • Auto Play & Segments - When we have both Auto Play and Segments applied.
    • Auto Play - For when only Auto Play settings and/or rules are applied.
    • Segments - When only a segment is associated with this type of item.
• When an item has already played or was prevented from Auto Play due to its “cancel Auto Play” settings - an option to appear to reset it locally, allowing it to Auto Play after a page refresh.

Element Highlighter

Easily identify on-screen elements using Flow Tracker

• With the new element highlighter, you can easily identify which on-screen element is attached to each SmartTip and Launcher when hovering over the green eye icon

Tip Tuesday Videos

Introduction to Flow Tracker

Troubleshooting with the Flow Tracker

Technical Notes

• Segment rules aren't visible per item. In order to view them, go to General Tab → Segments evaluation
• Alerts don't get removed once the cause is fixed
• Partial support for cross domain iframes - step tracker progression is not impacted, only the markup of elements & condition evaluation
• In Play mode: Only the Flow + Alerts tabs are triggered
• In Play mode: Conditions & Segments are ignored, but not Auto Play rules
  • The reason is that the Play mode is designed to show the item on the page ignoring the element's behavior
• Walk-Thrus are not supported (only Smart Walk-Thrus)
• Flow Tracker is not supported in self-hosted environments
• Conditions utilizing IDP attributes are expected to show as 'undefined' within the Flow Tracker, but will be evaluated as expected

Supports

• Smart Walk-Thrus
• Start Points
• Launchers
• SmartTips
• ShoutOuts
• Surveys
• Engaged Elements
• ShoutOuts
• Surveys
• Engaged Elements
• CSS that's added in the Editor
• Can be triggered in:
  • Play mode
  • Preview mode
  • Published environment 
• Resetting current user onboarding task progress
• Clearing any existing WalkMe data on the browser