What is UserGuiding Compass?

UserGuiding Compass is a browser extension that is installed manually to each end-user's browser where the UserGuiding onboarding materials are to be displayed.

It is preferred in situations where there is no access to the source code of the web application that the UserGuiding materials are to work on. Each Compass Extension is a unique pack of files created specifically for an account and for a container.

Installing for Chromium Browsers

Go to the Extension Management Page

For Chrome: chrome://extensions
For Edge: edge://extensions

Enable the Developer Mode and then Drag and drop the ZIP file created for you inside the Extension Management Page.

Installing for Firefox

Adding as a temporary Add-on

Go to the related Debugging Page through this link.

Click on Load Temporary Add-On button and choose the ZIP file Firefox created for you.

Add-on signing in Firefox

Learn how to install an external add on permanently inside your Firefox Browser here.

Important Matters

There are some limitations caused by not being able to install UserGuiding inside your application and running the material displays through UserGuiding Compass:

• The Compass Extension ID is matched with a specific container inside your account, this means only the materials in that specific container will be available for display through the Compass Extension. If you need another container, this will require a new Compass Extension to be build from ground up.
• This method is not supported by the Safari Browser.
• For the User Activity Feed, the UserGuiding Material Interaction data will be collected and displayed, but the Page View data is not available for the installations that have been made through the UserGuiding Compass Extension.
• The user ID's will be assigned anonymously for each unique session, if the browser cache or local storage is not deleted the same ID can be kept for that browser.
• It is not possible to send User Attributes through this implementation method, this also blocks the User Identification method.
• Each update you make and publish for the materials inside the container will be live within 2 hours of time. If the extension is pinned to the end-user's browser, it can also update manually by clicking on the extension icon, which will reload the current tab that is open.