- 21 Aug 2024
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Offline mode of Whatfix Desktop
- Updated On 21 Aug 2024
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Having constant access to the internet to stream desktop applications and provide unhindered access to their features is something that a lot of organizations sometimes face an issue with. Moreover, many desktop applications are used in remote environments, like ship decks and hospitals, where getting internet connectivity poses a problem. Other applications might also work in areas where network connections, though available, are slow.
In such situations, displaying Whatfix content becomes an issue, since end users require access to the internet to view and interact with Whatfix content. However, with Whatfix Desktop's offline mode feature, your organization can display Whatfix content to anyone, and at any time and place, without a need for network connectivity.
Any content that you wish to display can be packaged and deployed to end users along with the installation of Player on their devices. Thus, you can provide 24/7 support to end users and show contextual help through Flows, Popups, Smart Tips and Beacons, without them being dependent on external factors like location, network, weather conditions, and more.
There are two main steps required to display content offline.
Install the Player and add Hosted Path
Use the following steps to install the Player and add the Hosted Path:
-
Download the Player's installation files using the following addons URL: WhatfixPlayerInstaller.msi.
-
Open Windows Command Prompt and type cd
to change the current directory to the downloaded folder.
-
Run the following command to install the WhatfixPlayerInstaller file.
msiexec.exe /i WhatfixPlayerInstaller.msi ORG="provide the ORG ID here" HP="add the path of the exported package here" /q
- Provide the ORG and HP parameters in the aforementioned code.
- The ORG is the unique ID assigned to your organization.
- HP (hosted path) is the path to your hosting environment. To display content offline, enter orgs as the value for HP.
For example,msiexec.exe /i WhatfixPlayerInstaller.msi ORG="provide the ORG ID here" HP="orgs" /q
There are some more optional parameters you can add while installing the Player, such as Port, Development Domain etc. The following is a demo code you can run, as well as a table explaing each parameter:
msiexec.exe /i WhatfixPlayerInstaller.msi ORG="provide the ORG ID here" HP="provide hosted path here" DD="https://whatfix.com" PORT="49999" INSTALLPATH="C:\Users\User\Desktop\code" /q
Parameter | Description | Mandatory |
---|---|---|
ORG | The ORG is a unique identifier assigned to your organization. To get the value for ORG (i.e., Enterprise ID), contact your Whatfix Representative . | Mandatory value |
HP | The hosted path (HP) parameter is the path to your hosting environment. By default, it will point to where the installer is built, i.e, the CDN URL. | Optional |
DD | The development domain (DD) is the URL of the server where the installer is built. | Optional |
PORT | The port number is used for debugging. By default, it is empty. | Optional |
INSTALLPATH | This is the location where the Player is installed in your desktop. By default, it is in your local app data folder. | Optional |
/q | This parameter ensures that the installation of the Player is done silently on your desktop. | Optional |
- Press Enter. If there is no error message, installation is successful.
In case you are unable to add the Hosted Path of the package while installing the Player on end-users' computers, use the following steps to ensure content is fetched in the offline mode:
-
Go to the Registry Editor.
Under HKEY_LOCAL_MACHINE, click SOFTWARE.
-
Double-click the Whatfix folder to see the Registry Entry of the Player.
-
Double-click the HostedPath parameter.
-
In the popup that appears, under Value data, enter the complete path of the exported package folder that you had noted down in Step 6.
-
Click OK.
-
Once done, restart the Player for the changes to reflect.
Add Whatfix Desktop content inside the Player
Use the following steps to export and package Whatfix content inside the Player:
- Export the content you wish to display offline. For more information, see Enable Multi-format Content Export.
Whatfix Desktop does not package the required content for you. You have to export it by following the steps in the aforementioned article.
-
Once the package is downloaded, unzip the folder and copy the orgs file.
-
Go to where the Whatfix Player is installed on your device and click Whatfix Player.
-
Click src.
-
Paste the exported package's folder inside the src folder.
-
Note down the complete path of the folder you have pasted.