Choose an installation method

Updated
  • Updated On Apr 7, 2026
  • Published on May 6, 2024
  • 5 minute(s) read
Prev Next

Note:

  • To install Whatfix OS Player, end users need to choose between the data centers, either US or EU, and then install the Player.

  • The Player is installed either at a user level or system level based on the requirements of the end users.

Installation methods

There are two methods of installation for the Whatfix OS Player.

1. Installer

The Whatfix Player is installed either at a system level or user level on a machine. This method of installation is the most used one.

2. 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 the user if it gets uninstalled. Administrator privileges are required for this installation method.
The installation happens at the local user level.

Auto-update of the Player

Whatfix provides the capability to automatically update the Player whenever there is a new version. Auto-updates are available for the User Level Installation and System Level Distributor (only at the user level) Installation methods.

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 OS

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 (only at the user level)

Your browser does not support Svg.click here to download

       

Download the installer

Here's the link to download the installer.

Installer

System Level Distributor

US

US

EU

EU

Install the Player

The Player is installed in two ways:

  • Use the Installation Wizard: Only User Level and System Level installation are done this way.

  • Use the command prompt: All installation methods, including virtual machine installation, are done this way.

Use the Installation Wizard

  1. Open the downloaded installer file to launch the installation wizard.

  2. Click Next to continue the installation.
    installation 1.png

  3. Choose whether to install the Player for yourself or for all users of the machine.
    Installation scope of Whatfix Player on Desktop

Note:

  • If you choose to install it only for yourself, the default location is C:\Users\ \AppData\Local\

  • If you choose to install it for all users, the default location is C:\Program Files (x86)\Whatfix\

  1. In the Destination Folder window, click Next to install the file in the default location or click Change... to choose a different location.
    dest_player_change.png

  2. In the Player Arguments window, enter your ORG ID, and then click Next.
    Installation 3.png

Note:

  • To get the ORG ID, contact your Whatfix Representative.

  • ORG ID is case-sensitive.

  1. On the Ready to install Whatfix Player dialog box, click Install to finish the installation.
    Installation 4.png

  2. On the Whatfix Player Setup window, click Finish
    Installation 5.png

Use the Command Prompt

  1. Open Windows Command Prompt and use the following command to change the current directory to the downloaded folder:
    cd {Path to downloads directory}
    cmd-downloadfolder DT

  2. Depending on the installation method you choose, run the following command to install Whafix Player:

User Level Installation 

msiexec.exe /i {FILE_NAME} SCOPE="per-user" 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. Omit those that are not mandatory and use their default values. 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 OS. By default, it is in your local application 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 OS.

No

System Level Installation / Virtual Machine Installation

System Level Installation

msiexec.exe /i {FILE_NAME} SCOPE="per-machine" ORG="{ORG_ID}"  HP="{HOSTED_PATH}" DD="{DEV_DOMAIN}" PORT="{PORT_NUMBER}" INSTALLPATH="{INSTALL_PATH}" /q

Virtual OS 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 preferred port number.

No

INSTALLPATH

This is the location where the Player is installed on your OS. By default, it is in your local application 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 OS.

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 is 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 OS.

No

/l*v

These are the installer logs.

No

  1. Press the Enter key.

Note:

If there is no error message, the installation is successful.
playe_install.png

  1. When the installation is complete, open the OS application to view Whatfix content.
     ms_teams_preview.png

Validate the installation

After you have finished the Player installation process, check whether it is installed in your system in the following ways:

  • Use file location: This method is used to validate the Player's installation for all installation methods

  • Use the registry: This method is used to validate the Player's installation for all methods.

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 is installed, even if they do not have access to end-user registry. This method does not require accessing the user's profile.

  1. Go to your computer's Registry Editor.

  2. Under HKEY_LOCAL_MACHINE, click SOFTWARE.
     Snag_275a18.png

  3. 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.
reggit_sli.png

System Level Distributor

  1. The PlayerBulkManager file is present under a folder titled Whatfix.
    Snag_27b037.png

  2. Double-click PlayerBulkManager to see the Registry Entry of the Player.
    Snag_675f80.png

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

Privacy Policy | Whatfix Glossary | Whatfix Platform Status
Copyright © 2024 WHATFIX TM. All rights reserved.