Troubleshooting
Debugging
Whatfix enables you to debug issues with your Whatfix content and widgets using debugging commands in your browser’s Developer Tools.
Debugging articles
For information about debugging specific issues, see the following articles:
- Identify an element’s CSS selector
- Debug Pop-up issues
- Get tags loaded on a page
- Debug a Flow failure
Common debugging commands
For information about common Whatfix debugging commands, see the following table:
| Command | Description | When to use |
|---|---|---|
| General commands | ||
| ___embed; | Checks if the Whatfix Embed script is injected on an application. - Returns True if the Whatfix Embed script is present. - Returns False if the Whatfix Embed script is not present. | When no Whatfix content is visible on your application. |
| _wfx_****settings.debug_mode=true; | - Enables Whatfix debug mode. - Shows real-time logs of Whatfix content on the console. | When you want to debug issues with Whatfix content, for e.g.: - Debug a Flow failure - Get tags loaded on a page > [!WARNING] > Note > > After using this command, ensure to use the _wfx_refresh(); command |
| _wfx_refresh(); | Refreshes all the active content and widgets. | - When Whatfix content is not behaving as expected - After changing a _wfx_settings variable value, for e.g. _wfx_settings.debug_mode |
| wfxdebug_finder(); | Prints the debug logs for all content and widgets loaded on the page. | When you want to debug issues with Whatfix content or widget segments, for e.g.: - Debug Pop-up issues |
| Flow commands | ||
| wfxrun(‘<flow_id>’); | Runs the Flow with the provided Flow ID. | When you want to run a Flow without triggering it using a widget. |
| wfxis_live(); | Checks whether a Flow is currently running on the page. - Returns True if there is a running Flow - Returns False if there are no Flows currently running. | When a Flow is not visible or not loading on the desired pages. |
| wfxplay_state(); | Identifies the play state for a running Flow. Returns the Flow ID and step number of the Flow. | When additional information regarding the currently running flow is required like ID or the Step number. |
| Smart Tip Commands | ||
| wfxrefresh_tips(); | Refreshes the Smart Tip segments active on the page. | When your Smart Tips are not behaving as expected. |