Install and Uninstall
You can install the Citrix Workspace app either by:
- Downloading the
CitrixWorkspaceApp.exeinstallation package from the Download page or
- From your company’s download page (if available).
You can install the package by:
- Running an interactive Windows-based installation wizard. Or
- Typing the installer file name, 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:
Both users and administrators can install Citrix Workspace app. Administrator privileges are required only when using pass-through authentication and Citrix Ready workspace hub with Citrix Workspace app for Windows.
The following table describes the differences when Citrix Workspace app is installed as an administrator or a user:
|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|
Administrators can override the user-installed instance of Citrix Workspace app and continue with the installation successfully.
Using a Windows-based installer
You can install Citrix Workspace app for Windows by manually running the
CitrixWorkspaceApp.exe installer package, using the following methods:
- Installation media
- Network share
- Windows Explorer
- Command-line interface
By default, the installer logs are at
- Launch the
CitrixWorkspaceApp.exefile and click Start.
- Read and accept the EULA and continue with the installation.
- When installing on a domain-joined machine with administrator privileges, a single sign-on dialog appears. See Domain pass-through authentication for more information.
- Follow the Windows-based installer to complete the installation.
When the installation is complete, Citrix Workspace app requests that you add an account. For information on how to add an account, see Add accounts or switch servers.
Using command-line parameters
You can customize the Citrix Workspace app installer by specifying different command-line options. The installer package self-extracts to the system temp directory before launching the setup 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 type the following on a single line:
- installer file name,
- installation commands, and
- installation properties
The available installation commands and properties are as follows:
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 during installation. When you suppress the reboot prompt, USB devices that are in a suspended state aren’t recognized. The USB devices are activated only after the 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.
/forceinstall- This switch is effective when cleaning up any existing configuration or entries of Citrix Workspace app in the system. Use this switch in the following scenarios:
- Upgrading from an unsupported version of Citrix Workspace app version.
- The installation or upgrade is unsuccessful.
/forceinstallswitch is the replacement for
/rcuswitch is deprecated as of Version 1909. For more information, see Deprecation.
Indicates that Citrix Workspace app detects when an update is available.
/AutoUpdateCheckis a mandatory parameter that you must set to configure other parameters like
- Auto (default) - You’re notified when an update is available. Example,
- Manual - You aren’t 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 version you want to update. 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 notifications when an update is available. For more information, see Citrix Workspace Updates.
- -1(default) - Allows deferring notifications any number of times. Example,
- 0 - Indicates that you receive one notification (only) for every available update. Doesn’t remind you again about the update. Example,
- Any other number ‘n’ - Allows deferring notifications ‘n’ number of times. The Remind me later option is displayed in the ‘n’ count. Example,
When a new version of the app is available, 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 receive the updates during the delivery period as configured by Citrix. Example,
- Fast - You receive the updates at the beginning of the delivery period. Example,
- Medium - You receive the updates at the mid-delivery period. Example,
- Slow - You receive the updates at the end of the delivery period. Example,
Start App Protection component and provides enhanced security by restricting the ability of clients to be compromised by keylogging and screen-capturing malware.
See App Protection for more information.
/startAppProtectionswitch is the replacement for
/includeAppProtectionswitch is deprecated as of Version 2212. For more information, see Deprecation.
Excludes the Citrix Embedded Browser binaries. Run the
/InstallEmbeddedBrowser=N switch to exclude the embedded browser feature.
You can exclude the Citrix Embedded Browser binaries only in the following cases:
- Fresh install
- Upgrade from a version that doesn’t include the Citrix Embedded Browser binaries.
If your version of Citrix Workspace app includes the Citrix Embedded Browser binaries and you are upgrading to Version 2002, the embedded browser binaries are automatically updated during the upgrade.
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 Citrix Casting during installation.
When you update Citrix Workspace app, the Citrix Casting gets updated automatically. For more information on Citrix Casting, see Citrix Casting.
Installs one or more of the specified components. For example:
CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,USB,DesktopViewer,AM,SSON,SelfService,WebHelper,WorkspaceHub,AppProtection,CitrixEnterpriseBrowser <!--NeedCopy-->
- By default,
AMare installed when installing the Citrix Workspace app.
- To install other components, mention the same in the
Indicates if bidirectional content redirection between the client and the host is enabled. For more information, see the Bidirectional content redirection policy settings section in the Citrix Virtual Apps and Desktops documentation.
- 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-side Local App Access component. Install the workspace app with administrator privileges for this component to work. See the Local App Access section in the Citrix Virtual Apps and Desktops documentation for more information.
- 0 (default)- Indicates that the Local App Access component isn’t 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 you want to display icons for documents or files that have file type association with subscribed applications.
- False (default) - Display icons 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 doesn’t 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 - Doesn’t display icons 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,
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 Citrix Workspace app 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 the 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 the 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 the Reconnect option in the Advanced Preferences sheet. Example,
- 2 – Displays only the 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 the 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. 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, required only when you enable single sign-on authentication. For more information, see Domain pass-through authentication with Kerberos.
- Yes - Indicates that the HDX engine must use Kerberos authentication. Example,
- No - Indicates that the HDX engine doesn’t 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 provision file. The store URL is in the following format
/Citrix/store/discovery. To get 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 lets you deliver disabled stores, giving users the choice of whether they access them. When the store status isn’t specified, the default setting is On.
storedescription - Description of the store, such as
HR App Store.
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 must be first in the list (parameter STORE0).
- In a multi-store setup, only one Citrix Gateway store URL configuration is allowed.
- The Citrix Gateway store URL configured using this method does not support the PNA Services Sites that are using Citrix Gateway.
- The “/Discovery” parameter is not required when specifying a Citrix Gateway store URL.
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’s 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.
Reset Citrix Workspace app
Resetting Citrix Workspace app restores the default settings.
The following items are reset when you reset Citrix Workspace app:
- All the configured accounts and stores.
- Apps delivered by the self-service plug-in, their icons, and registry keys.
- File type associations created by the self-service plug-in.
- Cached files and saved passwords.
- Per-user registry settings.
- Per-machine installations, and their registry settings.
- Citrix Gateway registry settings for Citrix Workspace app.
Run the following command from the command line interface to reset the Citrix Workspace app:
C:\Program Files (x86)\Citrix\ICA Client\SelfServicePlugin\CleanUp.exe" -cleanUser
For silent reset, use the following command:
C:\Program Files (x86)\Citrix\ICA Client\SelfServicePlugin\CleanUp.exe" /silent -cleanUser
Use uppercase U in the parameter.
Resetting Citrix Workspace app does not impact the following:
- Citrix Workspace app or plug-in installation.
- Per-machine ICA lockdown settings.
- Group policy object (GPO) administrative template configurations for Citrix Workspace app.
Using Windows-based uninstaller:
You can uninstall Citrix Workspace app for Windows from the Control Panel. For more information, see the Uninstall Citrix Workspace app for Windows section.
During Citrix Workspace app installation, you get a prompt to uninstall the Citrix HDX RTME package. Click OK to continue the uninstallation.
Using the command-line interface:
You can uninstall Citrix Workspace app, from a command line by typing the following command:
For silent uninstallation of Citrix Workspace app, run the following switch:
CitrixWorkspaceApp.exe /silent /uninstall
Citrix Workspace app installer doesn’t control GPO related registry keys, so they are kept after uninstallation. If you find any entries, update them using
gpeditor delete them manually.