Install and Uninstall
You can install the Citrix Workspace app by downloading the
CitrixWorkspaceApp.exe installation package from the Download page or from your company’s download page (if available). The package can be installed by:
- Running an interactive Windows-based installation wizard. Or
- Typing the installer filename, installation commands and installation properties using the command line interface. For information about installing Citrix Workspace app using command line interface, see Using command-line parameters.
Installation with administrator and non-administrator privileges:
Citrix Workspace app can be installed by a user as well as an administrator. Administrator privileges are required only when using pass-through authentication and Citrix Ready workspace hub with Citrix Workspace app for Windows.
The following differences exist between installations of Citrix Workspace app for Windows performed by an administrator and those performed by a user (non-administrator).
|Installation folder||Installation type|
|Administrator||C:\Program Files (x86)\Citrix\ICA Client||Per-system installation|
|User||%USERPROFILE%\AppData\Local\Citrix\ICA Client||Per-user installation|
If a user-installed instance of Citrix Workspace app for Windows exists on the system and an administrator installs Citrix Workspace app for Windows on the same system, there will be a conflict. Citrix recommends that you uninstall all user-installed instances of Citrix Workspace app for Windows before installing Citrix Workspace app for Windows as an administrator.
Using a Windows-based installer
You can install Citrix Workspace app for Windows using the installation media, a network share, Windows Explorer, or a command line by manually running the
CitrixWorkspaceApp.exe installer package.
- Launch the
CitrixWorkspaceApp.exefile and click Start.
- Read and accept the End User License Agreement and proceed with the installation.
- If you are attempting the installation on a domain-joined machine with administrator privileges, an additional dialog appears to enable or disable Single Sign-on. See Domain pass-through authentication for more information.
- Follow the Windows-based installer to complete the installation.
Using command-line parameters
You can install Citrix Workspace app by typing the installer filename, installation commands, and installation properties at the command line interface. You can customize Citrix Workspace app installer by specifying command line options. The installer package self-extracts to the system temp directory before launching the set up program. The space requirement includes program files, user data, and temp directories after launching several applications.
To install the Citrix Workspace app using the Windows command-line, launch the command prompt and then, type the installer filename, installation commands and installation properties on a single line. The available installation commands and properties are listed below:
CitrixWorkspaceApp.exe [commands] [properties]
List of command-line parameters
The parameters are broadly classified as follows:
- Common parameters
- Install parameters
- HDX features parameters
- Preferences and user interface parameters
- Authentication parameters
/help- Lists all the installation commands and properties.
/silent- Disables installation dialogs and prompts during installation.
/noreboot- Suppresses the prompts to reboot dialog during installation. When you suppress the reboot prompt, the USB devices that are in a suspended state are not recognised by Workspace app until after the user device is restarted.
/includeSSON- Requires you to install as an administrator . Indicates that the Citrix Workspace app is installed with the single sign-on component. See Domain pass-through authentication for more information.
/rcu- This switch is effective only when upgrading from an unsupported version of the software. Indicates that Citrix Workspace app will be installed or upgraded by uninstalling existing version. This also cleans up existing or older settings.
/rcuswitch is deprecated from Version 1909. For more information, see Deprecation.
/forceinstall- This switch is effective when cleaning up any existing configuration or entries of Citrix Workspace app in the system in the following scenarios:
- You are upgrading from an unsupported version of Citrix Workspace app version.
- The installation or upgrade is unsuccessful.
Indicates that Citrix Workspace app detects when an update is available.
|Auto (default)||You are notified when an update is available. Example,
|Manual||You are not notified when an update is available. Check for updates manually. Example,
|Disabled||Disables auto updates. Example,
If you have enabled auto-update, you can choose the release track you would like to update to. See Lifecycle Milestones for more information.
|LTSR||Auto-updates to Long Term Service Release cumulative updates only. Example,
|Current||Auto-updates to the latest version of Citrix Workspace app. Example,
Indicates the number of times that you can defer the update notification when an update is available. See Advanced configuration for automatic updates (Citrix Workspace Updates) for more information.
|-1(default)||Allows deferring notification any number of times. Example,
|0||Indicates that you will receive one notification (only) for every available update. You will not be reminded again about the update. Example,
|Any other number ‘n’||Allows deferring the update notification ‘n’ number of times. The Remind me later option is displayed in the ‘n’ count. Example,
When a new version of the app is released, Citrix rolls out the update for a specific delivery period. With this parameter, you can control at what time during the delivery period you can receive the update.
|Auto (default)||You will receive the updates during the delivery period as configured by Citrix. Example,
|Fast||You will receive the updates at the beginning of the delivery period. Example,
|Medium||You will receive the updates at the mid-delivery period. Example,
|Slow||You will receive the updates at the end of the delivery period. Example,
Specifies the custom installation directory for Citrix Workspace app installation. The default path is
C:\Program Files\Citrix. Example,
CitrixWorkspaceApp.exe INSTALLDIR=C:\Program Files\Citrix.
Installs one or more of the specified components. Example,
CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,AM,SELFSERVICE,DesktopViewer,Flash,Vd3d,WebHelper,BrowserEngine, WorkspaceHub.
HDX features parameters
Indicates that the bidirectional content redirection between the client to host and the host to the client is enabled. See the Bidirectional content redirection policy settings section in Citrix Virtual Apps and Desktops documentation for more information.
- 0 (default) – Indicates that the bidirectional content redirection is disabled. Example,
- 1 - Indicates that the bidirectional content redirection is enabled. Example,
Indicates that Citrix Workspace app is installed with the client-end local app access component. You must install the workspace app with administrator privileges for this component to work. See the Local App Access section in Citrix Virtual Apps and Desktops documentation for more information.
- 0 (default)- Indicates that local app access component is not installed. Example,
CitrixWorkspaceApp.exe FORCE_LAA =0.
- 1 - Indicates that the client-end local app access component is installed. Example,
CitrixWorkspaceApp.exe FORCE_LAA =1.
Specifies if application icons are displayed for documents or files that have file type associations with subscribed applications.
- False (default)- Indicates that the application icons are displayed for documents or files that have file type associations with subscribed applications. When set to false, the operation system generates an icon for the document that does not have a specific icon assigned to it. The icon generated by the operation system is a generic icon overlaid with a smaller version of the application icon. Example,
- True- Indicates that the application icons are not displayed for documents or files that have file type associations with subscribed applications. Example,
Enables the URL redirection feature on the user device. See the Local App Access section in the Citrix Virtual Apps and Desktops documentation for more information.
- 0 (default)- Disables the URL redirection feature on the user device. Example,
- 1- Enables the URL redirection feature on the user devices. Example,
Preference and user interface parameters
Allows you to configure the stores (http or https) based on the specified parameter.
- S(default)- Allows you to add or remove secure stores only (configured with HTTPS). Example,
- A – Allows you to add or remove both secure stores (HTTPS) and non-secure stores (HTTP). Not applicable if Citrix Workspace app is per-user installed. Example,
- N – Never allow users to add or remove their own store. Example,
Allows you to save the store credentials locally. This parameter applies only to stores using the PNAgent protocol.
- S(default) - Allows saving the password for secure stores only (configured with HTTPS). Example,
- N - Does not allow saving the password. Example,
- A - Allows saving the password for both secure stores (HTTPS) and non-secure stores (HTTP). Example,
Specifies the directory for the shortcuts in the Start menu.
<Directory Name>- By default, applications appear under Start > All Programs. You can specify the relative path of the shortcuts in the
\Programsfolder. For example, to place shortcuts under Start > All Programs > Workspace, specify
Specifies the directory for shortcuts on Desktop.
When using the DESKTOPDIR option, set the
<Directory Name>- You can specify the relative path of the shortcuts. For example, to place shortcuts under Start > All Programs > Workspace, specify
Controls access to the self-service Workspace app user interface.
- True - Indicates that the user has access to self-service user interface. Example,
- False - Indicates that the user does not have access to the self-service user interface. Example,
Controls session pre-launch. See Application launch time for more information.
- True - Indicates that session pre-launch is enabled. Example,
- False - Indicates that session pre-launch is disabled. Example,
Hides the Shortcuts and Reconnect option from being displayed in the Advanced Preferences sheet. See Hiding specific settings from the Advanced Preferences sheet for more information.
- 0 (default) – Displays both Shortcuts and Reconnect options in the Advanced Preferences sheet. Example,
- 1 – Displays only Reconnect option in the Advanced Preferences sheet. Example,
- 2 – Displays only Shortcuts option in the Advanced Preferences sheet. Example,
- 3 – Both Shortcuts and Reconnect options are hidden from the Advanced Preferences sheet. Example,
Indicates your participation in the Customer Experience Improvement Program. See CEIP for more information.
- True (default)- Opt in to the Citrix Customer Improvement Program (CEIP). Example,
- False - Opt out of the Citrix Customer Improvement Program (CEIP). Example,
Controls the Always-on tracing feature.
- True (default)- Enables the Always-on tracing feature. Example.
- False - Disables the Always-on tracing feature. Example,
Specifies the name used to identify the user device to the server.
<ClientName>- Specifies the name used identify the user device on the server. The default name is
Allows client name to be the same as the computer name. When you change the computer name, the client name changes too.
- Yes (default) – Allows the client name to be the same as the computer name. Example,
- No- Does not allow the client name to be the same as the computer name. You must specify a value for the
Enables single sign on when the Workspace app is installed with the
/includeSSON command. See Domain pass-through authentication for more information.
- Yes (default) - Indicates that single sign-on is enabled. Example,
- No - Indicates that single sign-on is disabled. Example,
Specifies whether the HDX engine must use Kerberos authentication. This applies only when single sign-on authentication is enabled. For more information, see Domain pass-through authentication with Kerberos.
- Yes - Indicates that the HDX engine will use Kerberos authentication. Example,
- No - Indicates that the HDX engine will not use Kerberos authentication. Example,
In addition to the above properties, you can also specify the store URL that is used with the Workspace app. You can add up to 10 stores. Use the following property to do so:
STOREx=”storename;http[s]://servername.domain/IISLocation/discovery;[On, Off]; [storedescription]"
- x - Integers 0 through 9 used to identify a store.
- storename - Name of the store. This value must match the name configured on the StoreFront server.
- servername.domain - The fully qualified domain name of the server hosting the store.
- IISLocation - the path to the store within IIS. The store URL must match the URL in the StoreFront provisioning file. The store URL is in the following format
/Citrix/store/discovery. To obtain the URL, export a provisioning file from StoreFront, launch it in Notepad and copy the URL from the Address element.
- [On, Off] - The Off option enables you to deliver disabled stores, giving users the choice of whether or not they access them. When the store status is not specified, the default setting is On.
- storedescription - An optional description of the store, such as
HR App Store.
Examples of a command line installation
To specify the Citrix Gateway store URL:
CitrixWorkspaceApp.exe STORE0= HRStore;https://ag.mycompany.com#Storename;On;Store
Where, Storename indicates the name of the store that needs to be configured.
- The Citrix Gateway store URL configured using this method does not support the PNA Services Sites that are using Citrix Gateway.
- While configuring more than one store, Citrix Gateway store URL should be first in the list. Only 2 Citrix Gateway store URL configuration is allowed.
To install all components silently and specify two application stores:
STORE0="AppStore;https://testserver.net/Citrix/MyStore/discovery;on;HR App Store"
STORE1="BackUpAppStore;https://testserver.net/Citrix/MyBackupStore/discovery;on;Backup HR App Store"
- It is mandatory to include
/discoveryin the store URL for successful pass-through authentication.
- The Citrix Gateway store URL must be the first entry in the list of configured store URLs.
Using Windows-based uninstaller:
You can uninstall Citrix Workspace app for Windows using the Windows Programs and Features utility (Add/Remove Programs).
You get a prompt to uninstall the Citrix HDX RTME package before continuing with the Citrix Workspace app for Windows installation. Click OK to continue the uninstallation.
Using the command line interface:
You can uninstall Citrix Workspace app for Windows from a command line by typing the following command:
For silent uninstallation of Citrix Workspace app for Windows, run the following switch:
CitrixWorkspaceApp.exe /silent /uninstall
- The registry keys created by receiver.adm/receiver.adml or receiver.admx remain in the Software\Policies\Citrix\ICA Client directory under HKEY_LOCAL_MACHINE and HKEY_LOCAL_USER after uninstallation.
- If you find any entries in the Registry editor after uninstallation, delete them manually.