Install the Whatfix Desktop Player
- 09 Oct 2024
- 7 Minutes To Read
-
Print
-
DarkLight
-
PDF
Install the Whatfix Desktop Player
- Updated On 09 Oct 2024
- 7 Minutes To Read
-
Print
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Choose an installer
Whatfix provides distinct installers for the Whatfix Desktop Player based on the following criteria:
Installation methods
There are three methods of installation for the Whatfix Desktop Player.
1. User Level Installation
The Whatfix Player is installed for a particular user on a system. For example, if a system has three different user profiles, only the user who installs it gets the Player. This method is best suited for individuals looking to install the Player themselves, including end users and content creators.
2. System Level Installation
The Whatfix Player is installed for all users currently in the system. This installation method requires administrator privileges and is best suited for when you need to install Player on a virtual machine such as Citrix or Azure Virtual Desktop.
3. System Level Distributor
A distributor file is installed at the system level, triggering the installation of the Whatfix Player after a user in the system logs in, if they don't already have it. This ensures that users added to the system later automatically get the Player. It also ensures that the Player is reinstalled for a user if it gets uninstalled. Administrator privileges are required in this installation method.
Auto-update of the Player
Whatfix provides the capability to automatically update the Player whenever there is a new version. This capability is available for the User Level Installation and the System Level Distributor Installation methods, but not for the System Level Installation method. For more information, see Auto-update of the Whatfix Desktop Player.
Comparison of installation methods
| User Level | System Level | System Level Distributor | |
|---|---|---|---|
| Ideal usage | By individuals such as end users or content creators | By IT admins installing the Player on virtual machines such as Citrix or Azure Virtual Desktop | By IT Admins installing the Player in bulk for all users. |
| Who can use this method? | Anyone | System administrators | System administrators |
| Auto updates | Available | Not available | Available |
Underlying application
Whatfix provides a 64-bit and 32-bit installer for the Whatfix Player. The 64-bit installer is the default installer and can be used on almost all applications.
Only when you are using Whatfix Desktop on a 32-bit SAP application you need to install the 32-bit installer.
Whatfix account region
There are separate installers for Whatfix accounts based in the US and the EU.
Download the installer
Based on the installer criteria, download the required installer from the following tables:
| Default Installer (64-bit Player) | Installer for 32-bit SAP applications (32-bit Player) | |
|---|---|---|
| User Level Installation | US / EU | US / EU |
| System Level Installation | US / EU | US / EU |
| System Level Distributor | US / EU | US / EU |
Install the Player
The Player can be installed in two ways:
- Use the Installation Wizard: Only User Level and System Level installation can be done this way.
- Use the command prompt: All installation methods, including virtual machine installation, can be done this way.
Use the Installation Wizard
-
Open the downloaded installer file to launch the installation wizard.
-
Click Next to continue the installation.
-
In the Destination Folder window, click Next to install the file in the default location or click Change... to choose a different location.
-
In the Player Arguments window, enter your ORG ID, and then click Next.
your title goes here
- To get the ORG ID, contact your Whatfix Representative.
- ORG ID is case-sensitive.
-
On the Ready to install Whatfix Player dialog box, click Install to finish the installation.
-
On the Whatfix Player Setup window, click Finish
Use the Command Prompt
-
Open Windows Command Prompt and use the following command to change the current directory to the downloaded folder:
cd {Path to downloads directory}
-
Depending on the installation method you chose, run the following command to install Whafix Player:
User Level Installation
msiexec.exe /i {FILE_NAME} ORG="{ORG_ID}" HP="{HOSTED_PATH}" DD="{DEV_DOMAIN}" PORT="{PORT_NUMBER}" INSTALLPATH="{INSTALL_PATH}" /q
The following table explains the various parameters and values used in the command. Those that are not mandatory can be omitted and their default values are used. Replace the parameter values within quotes with the necessary values.
| Description | Mandatory? | |
|---|---|---|
{FILE_NAME} |
The file name of the downloaded installer. | Yes |
ORG |
Your Organization ID. Contact your Whatfix Representative to get your Organization ID, then replace {ORG _ID} with it. |
Yes |
HP |
The hosted path (HP) parameter is the URL of your hosting environment. By default, it points to https://cdn.whatfix.com. In case you are using a Self Hosted mode of deployment, replace {HOSTED_PATH} with your own host URL. |
No |
DD |
The development domain (DD) is the URL of the server where the installer is built. By default it is https://whatfix.com. Replace {DEV_DOMAIN} with your own URL. |
No |
PORT |
The port number is used for debugging. By default, it is empty. Replace {PORT_NUMBER} with your preffered port number. |
No |
INSTALLPATH |
This is the location where the Player is installed on your desktop. By default, it is in your local app data folder. Replace {INSTALL_PATH} with your preferred install location. |
No |
/q |
This parameter ensures that the installation of the Player is done silently on your desktop. | No |
System Level Installation / Virtual Machine Installation
System Level Installation
msiexec.exe /i {FILE_NAME} ORG="{ORG_ID}" HP="https://cdn.whatfix.com" DD="https://whatfix.com" PORT="49999" INSTALLPATH="{INSTALL_PATH}" /q
Virtual Desktop Installation
msiexec.exe /i {FILE_NAME} ORG="{ORG_ID}" APP="{PATH_TO_APPLICATION}" ENV="Citrix"
| Description | Mandatory? | |
|---|---|---|
{FILE_NAME} |
The file name of the downloaded installer. | Yes |
ORG |
Your Organization ID. Contact your Whatfix Representative to get your Organization ID, then replace {ORG _ID} with it. |
Yes |
HP |
The hosted path (HP) parameter is the URL of your hosting environment. By default, it points to https://cdn.whatfix.com. In case you are using a Self Hosted mode of deployment, replace {HOSTED_PATH} with your own host URL. |
No |
DD |
The development domain (DD) is the URL of the server where the installer is built. By default it is https://whatfix.com. Replace {DEV_DOMAIN} with your own URL. |
No |
PORT |
The port number is used for debugging. By default, it is empty. Replace {PORT_NUMBER} with your preffered port number. |
No |
INSTALLPATH |
This is the location where the Player is installed on your desktop. By default, it is in your local app data folder. Replace {INSTALL_PATH} with your preferred install location. |
No |
/q |
This parameter ensures that the installation of the Player is done silently on your desktop. | No |
APP |
The APP parameter is the complete path of the required application in the server machine. For example, C:\Program Files\Windows NT\notepad. Replace {PATH_TO_APPLICATION} with the path to your underlying application. |
Yes |
ENV |
The environment (ENV) is the virtual workspace where the Player needs to be deployed. It is Citrix for both Citrix and AVD |
Yes |
System Level Distributor
msiexec.exe /i {FILE_NAME} ORG="{ORG_ID}" /q /l*v out.txt
| Description | Mandatory? | |
|---|---|---|
{FILE_NAME} |
The file name of the downloaded installer. | Yes |
ORG |
Your Organization ID. Contact your Whatfix Representative to get your Organization ID, then replace {ORG _ID} with it. |
Yes |
/q |
This parameter ensures that the installation of the Player is done silently on your desktop. | No |
/l*v |
These are the installer logs. | No |
- Press the Enter key.
Note
If there is no error message, the installation is successful.
- When the installation is complete, open the desktop app to view Whatfix content.
Note
- If the Whatfix Desktop Player was installed in your system prior to March 11, 2021, you must uninstall the older Whatfix Desktop Player. For more information on how to uninstall Whatfix Desktop Player, see Uninstalling Whatfix Desktop Player.
- For User Level and System Level Distributor installation methods, the Whatfix Desktop Player is auto-updated at regular intervals. However, for System Level installation, auto-updates are not applicable. For more information on the Whatfix Desktop Player auto-updates, see Auto-update of Whatfix Desktop Player.
Validate the installation
After you have finished the Player installation process, check whether it has been installed in your system in the following ways:
- Use file location: This method can be used to validate the Player's installation for all installation methods
- Use the registry: This method can be used to validate the Player's installation for all methods except User Level Installation.
Use the registry
This is a standard method of validation wherein IT Admins can use the Windows Registry to check whether the Player's distributor file has been installed, even if they do not have access to end-user registry. This method does not require accessing the user's profile.
- Go to your computer's Registry Editor.
- Under HKEY_LOCAL_MACHINE, click SOFTWARE.
- Depending on the installation method, verify whether the following file exists:
System Level Installer
Double-click the Whatfix folder to see the Registry Entry of the Player.
System Level Distributor
The PlayerBulkManager file is present under a folder titled Whatfix.
Double-click PlayerBulkManager to see the Registry Entry of the Player.
Use file location
Depending on the installation method, verify whether the following folder exists to validate whether the installation was successful:
User Level Installation
AppData > Local > Whatfix Player
System Level Installation
Program Files > Whatfix > Whatfix Player
System Level Distributor
Program Files > Whatfix > Player MSI Manager
Troubleshooting
If you face issues with installation, see Unable to install Whatfix Desktop Studio or Player.
Was this article helpful?