All Collections
Settings
Installation & Setup
Testing UserGuiding installation
Testing UserGuiding installation

Alternative methods to test UserGuiding’s installation.

Efehan avatar
Written by Efehan
Updated over a week ago

Overview

When you embed the UserGuiding container code to your web application’s source code, you should see a blue checkmark under the Code Embedding status on the Containers page.

However, in some cases:

  • You may see the blue checkmark but also notice that the active onboarding content is not visible on certain pages of your web platform.

  • Or, you may see the grey cross under the Code Embedding status.

This article will suggest two alternative methods to check if UserGuiding is correctly installed on your web application.

Checking with the Troubleshooter

With the Troubleshooter, you can quickly test if UserGuiding is installed on your web application or not, given that you have the UserGuiding's Chrome Extension installed.

⚠️ Because some AdBlockers can block third-party tool scripts, ensure you've disabled any active AdBlocker you have on Chrome.

UserGuiding's Troubleshooter can only launch on a page where a container code is successfully embedded.

  • Access one of your platform pages where you expect UserGuiding to be installed.

  • Right-click on the UserGuiding Chrome Extension icon and click on Run Troubleshooter on this Page. Alternatively, just add "?_ug_troubleshoot=true" at the end of the current page URL and press "Enter."

  • If UserGuiding is installed on that specific page, you should see the Troubleshooter on the left side of the page. In addition, you can click on the “Container Information” tab on Troubleshooter to see your container’s name.

Checking with the Developer Console

  • Access one of your platform pages where you expect UserGuiding to be installed. Then, open the context menu on that page and click on "Inspect."

  • Open the Console.

  • Paste the command "userGuiding.activateTroubleshooter()" and click "Enter."

If UserGuiding is installed on that specific page, you should see the Troubleshooter on the left side of the page. If not, you will get the following error:

Alternatively, you can use the Chrome DevTools Sources panel to view your JS Files to check if UserGuiding's container code (a JS file) is listed.

  • Access one of your platform pages where you expect UserGuiding to be installed.

  • Open the context menu on that page and click on "Inspect".

  • Click on the “Sources” tab.

  • Use the “Page” pane to view all of the resources that the page has loaded.

  • Check if "static.userguiding.com" is there.

Did this answer your question?