Troubleshoot Smart Tips using Whatfix Diagnostics

Note:

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

Consider that you have created Smart Tips on your application. When you preview the Smart Tips, 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 Smart Tips, 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. Click Preview Mode.
   

3. 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.
   

4. 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 the content on different pages, you would expect the content 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 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.

5. Expand the Smart-tips accordion and click Diagnose on the Smart Tip segment you want to troubleshoot.

   Info:

   Whatfix evaluates Smart Tip widgets on the page and displays the status as Evaluated or Not Evaluated.

   

6. Click the Smart-tips section to view all the Smart Tips in the collection.
   

   Note:

   Under the Visibility Rules section, expand the accordions for Where, When Start, When End, and Who to troubleshoot any widget Visibility Rule issues.
   
   

   For more information on Advanced Visibility Rules, see Understand Advanced Visibility Rules.

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?
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 successfully locates the target element and is waiting for interaction to display the associated tooltip.
Displayed	Whatfix displays the tooltip when a user interacts with the UI component, provided all conditions are met. For example, a tooltip becomes visible.

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.

If a Smart Tip shows the status Not found, it means Whatfix cannot locate the target element on the page. For example, clicking the status displays a Auto tag error detected message. 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.

7. Resolve the issue using the error message.

8. Once resolved, the status updates to Found, and the Smart Tip works as intended.