Troubleshoot content and widgets using Whatfix Diagnostics

Note:

Whatfix Diagnostics is a Beta feature. To enable this, contact support@whatfix.com.

Consider that you have created a Flow on your application. When you run the Flow, some steps do not work 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 Flow steps, understand why they aren’t working, and follow actionable insights to resolve them.

Use the following steps to access the Whatfix Diagnostics panel:

1. Go to the page where you want to troubleshoot your content and launch Studio.
   

2. 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 for a specific page in your application. When you preview the page, some content appears as expected, while others do not. This might happen due to reasons such as an incorrect URL, invalid page tag, or mismatched Visibility rules.
   

   To help you identify what is visible and what is not, the Diagnostics panel categorizes content into two sections:

   • On this page: Displays 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: Displays content and widgets that are intended to appear on the current page but don’t display. This could possibly 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.

   Note:

   To troubleshoot Flows, launch them through a widget such as Pop-up or Self Help.

3. Expand the accordion for the content you want to troubleshoot and click Diagnose.
   

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. It categorizes them into On this Page and Not on this page sections based on whether they match the current page conditions.
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?
Searching	Whatfix searches for the target element on the page. It tries to locate the UI component the content or step is linked to.
Found	Whatfix locates the target element, and the step works as intended.
Displayed	Whatfix displays the content if it meets all conditions. For example, a tooltip becomes visible, or a Launcher appears.
Completed	Whatfix marks the step as completed, showing that the content can now be interacted with. For example, clicking a tooltip, completing a Flow step, or clicking a Beacon.

Not Found path: When content does not appear

Status	What does this mean?
Searching	Whatfix starts searching for the target element on the page. It tries to locate the UI component the content or step is linked to.
Not Found	Whatfix does not find the target element. This happens due to reasons such as an incorrect URL or missing page tags.
Not Displayed	Whatfix finds the target element, but the content does not appear on the page. This happens due to reasons such as mismatched Visibility rules.

Note:

• Whatfix evaluates Beacons, Tooltips, Launchers, and Role Tags and displays the status as Evaluated or Not Evaluated based on their conditions.

• Whatfix evaluates Pop-ups, Self Help, Task List, and Surveys and displays the status as Displayed or Not Displayed based on their visibility on the page.

• Whatfix searches for elements in Flow steps and tooltips and displays the status as Found or Not Found based on whether it locates the element.

If a Flow step shows the status Not found, it means Whatfix couldn’t locate the target element on the page. Clicking the status displays a Property Mismatch detected message along with an error code. For example, PROP_001 means that the properties used to identify the element have changed or can no longer be found. To troubleshoot this issue, follow the suggested resolution steps in the panel or manually reselect the element to update its properties.

Click the following accordion to view the error message, their meanings, and the steps to resolve the issue.

4. Resolve the issue using the error message.

5. Once resolved, the status updates to Found, and the step works as intended.