Troubleshoot Visibility Rules at the step level using Diagnostics

Consider that you have created a Beacon on your application. You configured the Visibility Rules and Element Precision Rules using Studio. 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 Whatfix Diagnostics, identify issues at the step level on Studio, understand why the steps aren’t working, and follow actionable insights to resolve them.

Note:

Diagnostics at the step level is currently supported for Flow steps, Launcher steps, and Beacon steps.

Here’s how to troubleshoot and resolve step level issues using Diagnostics:

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

   

   Note:

   Whatfix evaluates the Beacon widgets on the page by checking whether the conditions defined for their visibility are met. Based on this evaluation, it displays the status as Evaluated or Not Evaluated.

6. Click Beacons to view all the Beacons in the collection.
   
   
   

   Note:

   If a Beacon shows the status Not found, it means Whatfix fails to locate the target element on the page.
   

   Info:

   Under the Visibility Rules section, expand the accordion 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 Diagnostics.

   Understand the workflow in Whatfix Diagnostics

   When you enable Diagnostics, 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 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 that the content or step is linked to.
   Not Found	Whatfix fails to find the target element. It happens due to reasons such as an incorrect URL or missing page tags.

7. Click the Beacon to view the error message, explanation, and suggested fix.

   
   

8. Click Element Precision to see how the rules are evaluated.
   
   

   Note:

   You see an error message, for example, the CSS selector configured for the Beacon has failed.
   

9. Review the Element Precision Rules configured in Studio and make the required edits to resolve the issue.  
   
   Once resolved, the status update changes to Found and the Beacon step works as intended.