Whatfix Diagnostics

Note:

• Whatfix Diagnostics is available across all Delivery modes.

• If Whatfix Studio is not available on your windows, launch Diagnostics using Ctrl + alt + ;.

• Whatfix Diagnostics is a beta feature. For more information, contact support@whatfix.com.

Overview

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 you are unsure about what went wrong or how to fix it.

Diagnostics helps you understand why the content doesn’t work as expected. It provides clear, detailed information on what happened and why. Instead of needing technical knowledge or assistance from the support team, you can access simple, actionable insights to resolve the issue on your own.

How does Diagnostics work?

When you open Diagnostics, it monitors your content and widgets in real time as they run on the page. It provides step-by-step feedback, showing what works and what does not, and provides visibility into the cause of the issue.

Note:

Diagnostics works for all types of Whatfix content and widgets. It provides the same detailed information whether you're creating new content or troubleshooting existing content.

Use the following steps to access Diagnostics:

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

   

2. Click the Diagnostics icon.

3. Click Preview Mode.

Note:

If the content you want to preview is in the Draft stage, then select the Include Draft content and widgets checkbox.

4. Click Enter and wait for the page to refresh automatically.

Note:

If you enable Preview Mode from the content creation page, you must manually refresh the page to activate Preview Mode.

5. Once the preview mode is enabled, launch Diagnostics using Ctrl + alt + ;

Once opened, Diagnostics 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 would 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, Diagnostics 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.

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

Here's an orientation video on Diagnostics.

What are the key benefits of using Diagnostics?

• See exactly why a content or widget does not work as expected.

• Get clear information on how to fix the issue.

• Improve your testing process before rolling it out to your end users.

• Find and resolve issues without heavily relying on Whatfix support.

To troubleshoot different types of content and widgets using Diagnostics, see the following articles:

• Troubleshoot Flows using Diagnostics

• Troubleshoot Pop-ups using Whatfix Diagnostics

• Troubleshoot Smart Tips using Diagnostics

• Troubleshoot Beacons using Diagnostics

• Troubleshoot Surveys using Diagnostics

• Troubleshoot Self Help using Diagnostics

• Troubleshoot Task Lists using Whatfix Diagnostics