- 01 Sep 2022
- 5 Minutes To Read
Manage Extensions on the Whatfix Dashboard
- Updated On 01 Sep 2022
- 5 Minutes To Read
Use Whatfix extensions to display content to your end users when you don't have access to the application source code. Extensions enable display of Whatfix content as an overlay on your application.
The Whatfix Dashboard enables you to generate extensions across different browsers.
Using Manage Extensions in your Whatfix Dashboard, you can configure, generate, view, and update extensions.
You have to enable extensions to see the Manage Extensions option in your Whatfix Dashboard. Contact [email protected] to enable it.
What has changed?
For Chrome and Edge browsers, Whatfix now enables you to select the extension you want to download - the Whatfix Store extension, the Chrome Store extension, and the ZIP File and shows only the extension you select on the browser card.
The ZIP file, the Chrome Store extension, and the Whatfix Store extension are now separated, which means that you receive email notifications only for the extension you select.
Example: If you select only the Whatfix Store extension, then you receive an email notification only for that particular extension.
Email notifications are sent only for the Whatfix Store extension and the ZIP file and not for the Chrome Store extension.
For Chrome and Edge (Chromium) browsers, you can configure and download the PowerShell Script for the Chrome Store and the Whatfix Store extensions directly from the Whatfix Dashboard.
You can now see the extension ID, the VERSION number of the extension, and the date the extension is Updated On only for the extension you select.
The latest Version of the ZIP file is not displayed.
Use the following steps to set up the Manage Extensions page,
Navigate to the Whatfix Dashboard.
Click the Settings icon.
Click Manage Extensions.
Navigate to the Configurations tab.
Use the following details and complete the information on the form to generate an extension.
The following fields need to be filled to create the extension:
i) Extension Name - Click the Edit icon and enter a name for your extension. A best practice is to use Whatfix for Enterprise/Application name. Eg: Whatfix For Salesforce Lightning.
ii) Extension Description - Click the Edit icon and enter a short description of the extension. Eg: Whatfix provides in-app interactive guides and Flows to Ease User Onboarding, Reduce Training, and Improve Support.
iii) Extension Icon - Click the Choose button to customize the extension with a logo of your choice. The icon you upload is what your users see on their extension once they download the extension on their browsers.
Only .png format is supported for icons. The maximum dimensions supported are 128 x 128 pixel. Upto 1 MB size is supported.
iv) Other Browsers - Choose all the browsers you want to build the extension for.
Click the corresponding link to see more information about each browser extension.
- The Chrome browser is selected as the default browser.
- By default, the Whatfix Store extension and the ZIP are already selected. You can select any one of the extensions or all of them.
Enable the Chrome and Edge (Chromium) toggle.
On the pop-up, click Enable.
Select the extension checkbox you want to download - Whatfix Store, Chrome Store, or ZIP.
Navigate to the Extensions tab to download your extension.
- The first time you generate the extension, there's a Generate button. Subsequently, you can see an Update button.
- The extension can be hosted either on the Chrome Web Store or the Whatfix Store.
- On the Chrome Web Store, the content may take up to 24 hours before it gets approved and updated. While the Whatfix Store takes approximately 30 minutes to update content.
- Once the extension is generated,
For Chrome Store- Click the link to see the URL. The Extension ID is the last part of the URL. This ID is used by your IT team during mass deployment of the extension.
For Whatfix Store- Download the PowerShell script. This script is run by your IT team in all domain-joined machines to deploy the extension.
- If the Chrome Store takes more than 24 hours to approve your extension, Whatfix notifies you with a failure email. Contact [email protected] to review and resolve the issue.
- Click Details.
Enable the Internet Explorer toggle.
On the pop-up, click Enable.
- Navigate to the Extensions tab and download the Internet Explorer extension.
- The first time you generate the extension, there's a Generate button that you can use to get an installer file for the extension. Your IT team can use this file to install the extension on all end user browsers
- Subsequently, for each update, IE users see only an Update button.
- Clicking the Update button ensures that it updates all the content on all end user browsers
- Click Details.
In the Configurations tab, you can disable the browser toggle. Disabling the browser stops showing content to your end users.
When you clear the extension type checkbox, end users can only see the content that has been updated last before clearing the checkbox. If you want to update the content, you have to enable the extension again and click Update, for your end users to see the latest content.
- If you want to understand which deployment method is the best option for you, contact [email protected].
- The Integration tab on the Dashboard is not displayed once extensions are enabled.
You can see the Extension ID, the VERSION number of the extension, and the date the extension is Updated On for the extension you have selected. Under Actions, you can also download the extension.
For more information on the Firefox extensions, contact your Whatfix representative.
You cannot select the downloadable files for IE.
You can see the VERSION number of the extension and the date the extension is Updated On for the Internet Explorer extension. Under Actions, you can also download the extension.
By default, the Extension ID is not displayed for IE.
If you use the Edge (Legacy) browser, contact [email protected] to generate and enable extensions on this browser.
If you use the Safari browser, contact [email protected] to generate and enable extensions on this browser.
The system sends an email that includes a link to download the respective extension file to the registered email associated with the account.
Depending on the browser that your end users are using, the following timelines may be applicable when you generate and publish browser extensions,
|Browser||Extension Update Time|
|Google Chrome and Edge (Whatfix Store)||30 minutes. No approval time|
|Google Chrome and Edge (Chrome Store)||Generates in 10 minutes. Takes 48-72 hrs to get approved|
|Internet Explorer||10 minutes. No approval time|
|Legacy Edge||48 -72 hours|
|Safari||48 -72 hours|