- 10 Mar 2025
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Troubleshoot Task Lists using Whatfix Diagnostics
- Updated On 10 Mar 2025
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Note:
Whatfix Diagnostics is a Beta feature. To enable this, contact support@whatfix.com.
Consider that you have created a Task List widget on your application. When you preview the segment, it doesn’t appear as expected. You try to debug it but are unsure what went wrong or how to fix it. With the Whatfix Diagnostics Panel, identify issues with the Task List widget, understand why they aren’t working, and follow actionable insights to resolve them.
Use the following steps to access the Whatfix Diagnostics panel:
Go to the page where you want to troubleshoot your content and launch Studio.
Click Preview Mode.
Click Enter and then refresh the browser.
Note:If the content you want to preview is in the Draft stage, then select the Include Draft content and widgets. checkbox.To enable the Whatfix Diagnostics Panel, press Option+ Shift+ D (on Mac OS) or Alt+ Shift+ D (on Windows OS) on your keyboard.
Once enabled, Whatfix Diagnostics Panel helps you view all the relevant content and widgets for that page.
Info:
Consider that you have created multiple pieces of content across your application. When testing this content on different pages, you expect it to appear on the correct page or section.
To help you identify the content that is applicable to appear on a specific page, the Diagnostics panel categorizes content into two sections:
On this page: Lists content and widgets that are configured to appear on the current page. This includes content that has a valid URL or page tag condition that matches the current page.
Not on this page: Lists content and widgets that doesn’t appear on the current page. This can be due to a condition mismatch, such as an incorrect URL, an invalid page tag, or incorrect widget visibility rules.
These sections act as a built-in filter, helping you identify missing content and troubleshoot issues more efficiently.
Use the Search bar to find specific content or widgets.
Expand the Task Lists accordion and click Diagnose on the Task List widget you want to troubleshoot.
Info:
Whatfix evaluates Task List widgets on the page and displays the status as Displayed or Not Displayed.
Info:
Whatfix Diagnostics uses different statuses to describe the current state of each step or content.
Expand the accordion to understand the workflow in the Diagnostics Panel.
Understand the workflow in Whatfix Diagnostics Panel
When you enable the Diagnostics Panel, Whatfix begins evaluating the content and widgets configured for the page.
As you interact with the content, Whatfix updates the status at each step, helping you understand what is working and what is not.
Success path: When content or step works as expected
Status
What does this mean?
Displayed
Whatfix displays the Task List, provided all conditions are met.
Not Found path: When content does not appear
Status
What does this mean?
Not Displayed
Whatfix does not display the Task List widget. This happens due to reasons such as Visibility rules failure or low precedence.
If a Task List shows the status Not Displayed, the Diagnostics panel displays the issue and the reason for the failure as shown below. Troubleshoot the issue, by following the suggested resolution steps in the panel.
Click the following accordion to view the widget status, error message, their meanings, and the steps to resolve the issue.
Error message, their meanings, and steps to resolve them
Status | Error Message | What does this mean? | What can you do? |
---|---|---|---|
Not Displayed | Visibility rule mismatch or failure | Whatfix cannot display the widget because some of the Visibility rule conditions aren’t met. | Review the Visibility rule conditions and make any necessary modifications. If the issue persists, contact support@whatfix.com. |
Precedence issue | Whatfix cannot display the widget because another widget took priority during evaluation. | Go to the Whatfix dashboard and ensure that only one widget is live on the page. | |
Occurrence exhausted | Whatfix cannot display the widget as it has already been displayed for the set number of times. | Increase the set occurrence for the widget and try again. |
Resolve the issue using the error message.
Once resolved, the status updates to Displayed, and the Task List appears as intended.