Manage Extensions on the Whatfix Dashboard
- 18 Sep 2024
- 8 Minutes To Read
-
Print
-
DarkLight
-
PDF
Manage Extensions on the Whatfix Dashboard
- Updated On 18 Sep 2024
- 8 Minutes To Read
-
Print
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Use Whatfix extensions to display content to your end users when you don't have access to the application source code. Extensions enable the display of Whatfix content as an overlay on your application.
The Whatfix Dashboard enables you to generate extensions across different browsers.
Note
Only an Account Manager can perform the following task. For more information about available roles, see Whatfix User Roles.
Use Manage Extensions in your Whatfix Dashboard to configure, generate, and view extensions.
your title goes here
You have to enable extensions to see the Manage Extensions option in your Whatfix Dashboard. To enable it, contact support@whatfix.com.
Configure Whatfix Extension
Set up the Manage Extensions page
Use the following steps to set up the Manage Extensions page:
-
On the Whatfix Guidance dashboard, click Settings.
-
Click Content deployment.
-
Go 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 in to create the extension:a) Extension Name - Click the Edit icon and enter a name for your extension. A best practice is to use Whatfix for Enterprise/Application name. For example: Whatfix For Salesforce Lightning.
b) Extension Description - Click the Edit icon and enter a short description of the extension. For example: Whatfix provides in-app interactive guides and Flows to Ease User Onboarding, Reduce Training, and Improve Support.
c) Extension Icon - Click the Choose 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.
your title goes hereOnly the .png format is supported for icons. The maximum dimensions supported are 128 x 128 pixels. Up to 1 MB size is supported.
d) Other Browsers - Choose all the browsers you want to build the extension for.
your title goes here
-
In the Configurations tab, 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, select the extension you want, and then push the content and widgets back to Production. The extension gets updated automatically and your end users can see the updated content.
The system sends an email that includes a link to download the respective extension file to the registered email associated with the account. The information on the last generated version of the extension is also displayed (only for all extensions that were updated).
Depending on the browser that your 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. |
| Google Chrome and Edge (Chrome Store) | Generates in 10 minutes. Takes 48-72 hours to get approved. |
| Google Chrome and Edge (Edge Store) | Generates in less than 10 minutes. Takes up to 7 days to get approved. |
| Internet Explorer | 10 minutes. |
| Legacy Edge | 48-72 hours |
| Safari (Apple Store) | Generates in 48-72 hours. Takes up to 7 days to get approved |
Download Whatfix Extension for various browsers
- For the Chrome and Edge browsers, Whatfix enables you to select the extension you want to download: the Whatfix Store extension, the Chrome Store extension, the Edge Store extension, and the ZIP File and shows only the extension you select on the browser card.
your title goes here
To configure the Edge Store extension, contact support@whatfix.com
- The ZIP file, the Chrome Store extension, the Edge Store extension, and the Whatfix Store extension, are 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.
-
For the Chrome and Edge (Chromium) browsers, configure and download the PowerShell Script for the Whatfix Store extension directly from the Whatfix Dashboard.
-
See the Extension ID, the VERSION number of the extension, and the date the extension is Updated On only for the extension you select.
your title goes here
The latest version of the ZIP file is not displayed.
Enable Chrome and Edge (Chromium) extension
Note
- The Chrome browser is selected as the default browser.
- By default, the Whatfix Store extension and the ZIP are already selected. Select any one of the extensions or all of them.
-
In the Configurations page, 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, Edge Store, or ZIP.
your title goes here
To configure the Edge Store extension, contact support@whatfix.com.
- Go to the Extensions tab to download your extension.
your title goes here
- The first time you generate the extension, there's a Generate button.
- You don't have to manually update your extension every time you update your Whatfix content. When you push your Whatfix content and widgets to the Production stage, your extension is automatically updated. For more information on how to push Whatfix content and widgets to Production, see Push Whatfix content and widgets to Production. You will receive an email once your extension is updated.
- For any configuration update such as updating a global setting or AC code, the Chrome browser extension needs to be generated again. In this case, contact support@whatfix.com to update the extension.
- The extension can be hosted either on the Chrome Web Store, the Edge Store, or the Whatfix Store.
- On the Chrome Web Store, the time required to get content approved is subject to Chrome's approval policies and timelines. We have noticed that the content may take anywhere between 1-3 working days before it gets approved and updated. (tentatively).
- On the Edge Store, the content may take up to 7 business days 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 the mass deployment of the extension.
For Edge 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 the 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.
- Click Details.
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, download the PowerShell Script for the Whatfix Store extension and the ZIP file.
Enable Firefox Extension
your title goes here
For more information on the Firefox extensions, contact support@whatfix.com.
Enable IE Extension
-
Enable the Internet Explorer toggle.
-
On the pop-up, click Enable.
your title goes here
You cannot select the downloadable files for IE.
- Go to the Extensions tab and download the Internet Explorer extension.
your title goes here
- The first time you generate the extension, there's a Generate button that enables you to 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.
- You don't have to manually update your extension, every time you update your Whatfix content. When you push your Whatfix content and widgets to the Production stage, your extension is automatically updated. For more information on how to push Whatfix content and widgets to Production, see Push Whatfix content and widgets to Production. You will receive an email once your extension is updated.
- For any configuration update such as updating a global setting or AC code, the IE browser extension needs to be generated again. In this case, contact support@whatfix.com to update the extension.
- Click Details.
See the VERSION number of the extension and the date the extension is Updated On for the Internet Explorer extension. Under Actions, download the extension.
your title goes here
By default, the Extension ID is not displayed for IE.
Enable Safari Extension
your title goes here
If you're unable to see the Safari extension on your dashboard, go to the Content Deployment page on the Whatfix Guidance Dashboard and add _v2 to the URL.
-
Enable the Safari toggle.
-
On the pop-up, click Enable.
your title goes here
Select the Apple Store checkbox if you want to download the extension using Apple store.
By default, the .zip download files for iOS App (IPA) and macOS App (APP) are enabled. Download the extension file for iOS or macOS based on which device's browser you want to show Whatfix content.
- Go to the Extensions tab and download the Safari extension.
your title goes here
-
The first time you generate the extension, there's a Generate button that enables you to get an installer file for the extension.
-
If you're generating the Safari extension for the first time, some additional configuration is required. Contact support@whatfix.com to generate and enable extensions on Safari browser for the first time.
-
You don't have to manually update your extension, every time you update your Whatfix content. When you push your Whatfix content and widgets to the Production stage, your extension is automatically updated. For more information on how to push Whatfix content and widgets to Production, see Push Whatfix content and widgets to Production. You will receive an email once your extension is updated.
-
For any configuration update such as updating a global setting or AC code, the Safari browser extension needs to be generated again. In this case, contact support@whatfix.com to update the extension.
-
On the Apple Store, the time required to get content approved is subject to Apple's approval policies and timelines. We have noticed that the content may take anywhere between 3-7 working days before it gets approved and updated. (tentatively).
- Click Details.
See the VERSION number of the extension and the date the extension is Updated On for the Safari extension. Under Actions, download the extension.
your title goes here
By default, the Extension ID is not displayed for Safari.
your title goes here
- If you want to understand which deployment method is the best option for you, contact support@whatfix.com.
- The Integration tab on the Dashboard is not displayed once extensions are enabled.
Was this article helpful?