Troubleshoot Beacons using Whatfix Diagnostics

Note:

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

Consider that you have created a Beacon on your application. When you preview the Beacon, 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 Beacons, understand why they aren’t working, and follow actionable insights to resolve them.

Use the following steps to access the Whatfix Diagnostics panel:

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.

5. Expand the Beacons accordion and click Diagnose on the Beacon segment you want to troubleshoot.

   Info:

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

   

6. Click the Beacons section to view all the Beacons 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 has successfully located the target element and is waiting for interaction to display the associated tooltip
Completed	Whatfix marks the step as completed, showing that the content can now be interacted with. For example, 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.

If a Beacon shows the status Not found, it means Whatfix does not locate the target element on the page. For example, clicking the status displays a CSS selector issue 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 Beacon appears as intended.