Overview
Troubleshooter allows you to inspect all details of your content in UserGuiding and quickly spot the root of a problem so you can get things working again fast.
If you can't see a guide or a hotspot you published on its target page, open Troubleshooter for it and run through all setting variables that content has to detect the issue's source.
Important: If you can't open and run Troubleshooter on a page, it means UserGuiding is not installed on the page. This is the most likely reason why you can't see your live content. Learn more here.
Opening the Troubleshooter from the Panel
Open Troubleshooter by visiting the settings page of guides, hotspots, checklists, and Surveys.
Content Status should be active, and installation should be completed to see its icon.
Click on the Troubleshooter icon to open it on the Redirection (starting) URL of the current content (ex: Guide ID: 25937).
By following this method, the Troubleshooter will open, showing the details of the content. You may need to scroll down to see that particular section.
Important: If you're at the Surveys or Checklist settings page, since there is no Redirection (starting) URL to step in, you must type in the URL of the webpage where you want to run the Troubleshooter.
Opening Troubleshooter from the Chrome Extension
If you're on a URL where your guides or hotspots should be showing, you've already downloaded the Chrome extension and successfully embedded the container code; you can right-click the UserGuiding Chrome Extension icon and click "Run Troubleshooter on this page."
How Troubleshooter Works
There are six main sections in Troubleshooter, starting from Container Information. If the section is showing a plus icon [➕], you can click on it to reveal subsections. When the main section is opened, its icon will be a minus [➖].
Container Information
Here, you can find details about the JS code embedded on the current page.
Container Embed Status: expected to be showing ✅ .
Container Name: name of the Js code on the current page.
Last Update Date: date and time you last click Publish Changes button.
Hint💡: If you can't see the last changes you made over a guide or another content, make sure to click Publish Changes to update the live version of your content.
Current User Information
Here, you can find details about the current user and determine which user segments they meet the conditions of.
If you enable user identification, you'll see three additional rows:
User Identification Enabled: enabled when you successfully add your User Identification code within your source code. Learn more here.
User Identification Completed: enabled when you have correctly assigned a unique ID to the user currently visiting your page.
User ID: If you integrated user IDs in UserGuiding, you'd see the current user's designated ID.
User Segments: the current user is included in which user segments.
User Attributes: the current user has which of the custom attribute values.
You can also see Guide IDs for the guides seen and completed by the current user within that browser session.
How to reveal section details in Troubleshooter:
If the subsection is showing ► icon, click on it to reveal more information and setting details. When a sub-section is already open, its icon will be ▼.
► User Segments:
In this section, you see all user segments (user groups) you created and check whether the current user is included in these segments or not.
Below, for instance, the current user is included in the New Users segment. ✅
2. If you click any "segment name" (ex: French Speaking Users), you see if the current user data matches the segmentation condition you set for the segment.
Condition (OR / AND): When the user segment is created with one property, or the condition set between multiple segment properties is AND, then every property should match. If the property condition is OR >, any property should match.
To learn more about Segmentation, visit here.
▶︎ Properties:
This section shows the segmentation condition set with the selected property and whether the current user meets the condition.
See the example below, the current user's Browser Language is not French (expected value), so they can't be included in the segment.❌
Guides
Here, you can find details related to Active Guides inside the container code embedded on the page where the Troubleshooter is opened.
Important: If you can't see a published guide on the current page, find its name within this section to find why it is not showing up. Learn more here.
1 - Previewing Guide:
If there is a guide playing on the current page, you can know it from its ID and title. Inside this section, you can also see the setting details. See the example below:
Targeting Availability: Current page URL matches the Targeting conditions of the Guide. ✅
Segmentation Availability: Current user matches the Segmentation conditions of the Guide. ✅
The Guide has steps to be displayed. ✅
2 - Other Guides:
This section has all active Guides you've placed into the container code embedded on the current page, except the previewing Guides.
If you click on any Guide on the list, you can see its setting details and check whether it can be played on the current page or not (see availability).
Targeting Availability
The current page URL matches the Targeting conditions of the Guide shows. ✅
The current page URL does not match the Targeting conditions of the Guide shows. ❌
See the example below: since the current page URL complies with the Targeting Rules, the Guide is available based on its Page Targeting.
Segmentation Availability
The current user matches the Segmentation conditions of the Guide, shows ✅
The current user does not match the Segmentation conditions of the Guide, shows ❌
See the example below: the Segmentation Type of the guide is set to All Users, meaning all end-users visiting the current page URL comply with the Guide's Segmentation Availability.
Hotspots
Here, you can find details related to Active Hotspot Groups inside the container code embedded on the page where the Troubleshooter is opened.
Important: If you can't see the published Hotspot on the current page, locate its Group name and details within this section to find why it is not showing up. Learn more here.
1 - Available Hotspot Groups:
If there is an available Hotspot group on the current page, you can see its setting details inside this section. When there is none, you will see "There is no available Hotspot Group."
Targeting and the segmentation conditions of the available Hotspot Group met by the current user and page. ✅
Important: If you can't see the Hotspot(s) of an available Hotspot Group on the current page, be sure that the group has Hotspots inside to be shown.
► Hotspot Details
If your group has Hotspots, click here to see details related to each Hotspot.
If Hotspots have a text component, you can detect it from the written text. If not, you will see the corresponding step number.
Exists on the Current Page: The area you highlighted (HTML element) while creating the Hotspot is present on the current page so does the Hotspot itself.✅
Not Interacted Before: The current user hasn't taken the necessary action to display the Hotspot (ex: click on Beacon).❌
2 - Other Hotspot Groups:
This section has all active Hotspot groups you've placed into the container code embedded on the current page, except available groups.
If you click on any Hotspot Group on the list, you can see its setting details and understand why they can't be played on the current page (see availability).
The Hotspot group's page targeting does not match the current page URL in the sample below, so it is not available. Learn more here.
Checklists
Here, you can find details related to Active Checklists inside the container code embedded on the page where the Troubleshooter is opened.
Important: If you can't see the published Checklist on the current page, click on its name to find why it is not showing up.
1 - Available Checklists:
If there is an available Checklist on the current page, you can see its setting details inside this section. When there is none, you will read, "There is no available Checklist."
The current user and page meet targeting, segmentation, and appearance conditions of the available Checklist. ✅
Format should show Checklist.
Checklist Completion Rate: The fill rate of the Checklist Progress Bar with each completed guide.
► Checklist Guides:
Here, you can find the list of Guides inside the active Checklist.
Click any Guide on the list to see details related to its completion. Remember, Checklist Guides are marked with checkmarks when end-users complete them.
See the example below; the available Checklist on the current page is shown in Troubleshooter. Checklist Completion Rate is 100% percent.
2 - Other Checklists:
This section has all active Checklists you've placed into the container code embedded on the current page, except available ones.
If you click on any Checklist on the list, you can see its setting details and understand why they can't be played on the current page (see availability).
The Checklist's page targeting does not match the current page URL in the sample below, so it is not available. Learn more here.
Surveys
Here, you can find details related to Active Surveys inside the container code embedded on the page where the Troubleshooter is opened.
1 - Available Surveys:
If there is an active Survey displaying on the current page, you can see its setting details inside this section. When there is none, you will read, "There is no available Survey."
Targeting and the segmentation conditions of the available Survey met by the current user and page. ✅
Appearance Settings > Display Conditions
User Last Seen the Survey: the date will be written if the current user has completed interacting with the survey.
Enough Days Passed After Last Seen ✅
Will be Available to User on: the date when the current user will see it again after seeing this survey.
Enough Page Visited: before the current user sees the survey.✅
Sampling: The percentage of the users that will be sampled and the current user inside this sample.✅
Showed Less Than 2 Times in the current browser session.✅
2- Other Surveys:
If there is an active Survey not displaying but placed into the container code embedded on the current page, you can see its setting details inside this section. When there is none, you will read "There is no Other Survey."
Click on Survey to understand why it can't be played on the current page (see availability).
In the sample below, the Survey has a page targeting that does not match the current page URL, so it is not available. Learn more here.
Also, not enough days have passed after the current user had last seen the survey.
Finally, since they have seen the survey at least one time within a single session, the survey won't be showing for the sake of a better UX.
