As a leading remote access solution, Citrix Workspace app allows users to access virtual applications and desktops from anywhere. This guide provides a comprehensive walkthrough on how to install and uninstall Citrix Workspace app on Windows, ensuring a smooth and efficient process.
Understanding Citrix Workspace App Installation
Citrix Workspace app can be installed using a user-friendly wizard or via command-line for more advanced configurations. Before you begin, ensure your system meets the necessary system requirements for optimal performance.
Installation Methods
You can download the Citrix Workspace app installer from the official Citrix Downloads page or your organization’s designated download location. Installation can be performed in two primary ways:
- Interactive Wizard: A graphical user interface guides you through the installation steps.
- Command-Line Interface: Allows for automated and customized installations using specific commands and properties. For detailed command-line options, refer to Using command-line parameters.
Note: Administrator privileges are required for certain features like pass-through authentication, single sign-on, App Protection, and Microsoft Teams VDI plug-in.
Installation Types: Administrator vs. User
The installation behavior differs based on whether you have administrator privileges:
Feature | Administrator Installation | User Installation |
---|---|---|
Installation Folder | 64-bit: C:Program Files (x86)CitrixICA Client 32-bit: C:Program FilesCitrixICA Client |
%USERPROFILE%AppDataLocalCitrixICA Client |
Installation Type | Per-system installation | Per-user installation |
Note: Administrators can overwrite user installations to ensure consistent deployment across systems.
Streamlined Installation with /CleanInstall
Command
For a fresh and error-free installation, utilize the /CleanInstall
command. This command effectively removes any remnants of previous installations, including files and registry entries, before installing the new version.
Example:
CitrixWorkspaceApp.exe /CleanInstall
Limitation: When App Protection is enabled, uninstall Citrix Workspace app, reboot your machine, and then run the /CleanInstall
command for a clean installation.
Note: The
/CleanInstall
command provides a more thorough cleanup compared to/forceinstall
. While/forceinstall
is used for upgrades from unsupported versions or failed installations,/CleanInstall
ensures a clean slate for every installation or upgrade.
Step-by-Step User Interface Installation
The most common method is installing Citrix Workspace app using the interactive wizard:
-
Run the Installer: Locate and launch the
CitrixWorkspaceApp.exe
file. The installer will automatically check and install any missing prerequisites.Alt Text: Citrix Workspace app installer checking for and installing necessary prerequisites.
-
Welcome Screen: Click Continue on the Welcome to Citrix Workspace Installer screen.
-
License Agreement: Review and accept the Citrix License Agreement, then proceed with the installation.
-
Add-ons (Administrator Privileges): If installing as an administrator, you can select optional add-ons:
- Start App Protection after installation: Enhances security against keylogging and screen capturing.
- Enable single sign-on: Simplifies login process within a domain environment.
- Install Microsoft Teams VDI Plugin: Optimizes Microsoft Teams performance in virtualized environments.
Alt Text: Animation showing the Citrix Workspace installer add-ons page with single sign-on and other options.
-
Completion: Follow the on-screen prompts to complete the installation. Citrix Workspace app will be successfully installed.
Important: Starting with Citrix Workspace app for Windows version 2311.1, installation logs are named
CWAInstaller-
instead ofTrolleyExpress
. Logs can be found atC:Program Files (x86)CitrixLogs
.
Installation via Windows Store
For a simplified installation, you can also use the Microsoft Store:
-
Open Microsoft Store: Navigate to the Microsoft Store on your Windows device.
-
Search for Citrix Workspace: Type “Citrix Workspace” in the search bar.
Alt Text: Citrix Workspace app search result in the Microsoft Store.
-
Install: Click Get to download and install Citrix Workspace app directly from the Microsoft Store.
Advanced Command-Line Installation
Command-line installation offers granular control over the installation process. Open Command Prompt as administrator and use the following syntax:
CitrixWorkspaceApp.exe [commands] [properties]
Common Command-Line Parameters
Command | Description |
---|---|
? or help |
Displays all available commands and properties. |
/silent |
Runs the installation without any user interface prompts. |
noreboot |
Suppresses reboot prompts after installation. (Caution: USB devices may not function correctly until reboot) |
/forceinstall |
Forces installation even if unsupported versions are detected or installation failures occur. |
Note:
/forceinstall
replaces the deprecatedrcu
switch.
Auto-Update Configuration Parameters
Control how Citrix Workspace app handles updates using these parameters:
AutoUpdateCheck
Determines if and how auto-updates are checked.
Value | Description | Example |
---|---|---|
Auto (default) |
Notifies users when updates are available. | CitrixWorkspaceApp.exe AutoUpdateCheck=auto |
Manual |
Users must manually check for updates. | CitrixWorkspaceApp.exe AutoUpdateCheck=manual |
Disabled |
Disables auto-updates entirely. | CitrixWorkspaceApp.exe AutoUpdateCheck=disabled |
Note:
AutoUpdateCheck
is mandatory for configuring other auto-update parameters.
AutoUpdateStream
Specifies the update channel (LTSR or Current).
Value | Description | Example |
---|---|---|
LTSR |
Updates only to Long Term Service Release cumulative updates. | CitrixWorkspaceApp.exe AutoUpdateStream=LTSR |
Current |
Updates to the latest version of Citrix Workspace app. | CitrixWorkspaceApp.exe AutoUpdateStream=Current |
DeferUpdateCount
(Not applicable for versions 2207 and later) Specifies the number of times users can defer update notifications.
AURolloutPriority
Controls when updates are received during the rollout period.
Value | Description | Example |
---|---|---|
Auto (default) |
Updates are received as configured by Citrix. | CitrixWorkspaceApp.exe AURolloutPriority=Auto |
Fast |
Updates are received at the beginning of the rollout period. | CitrixWorkspaceApp.exe AURolloutPriority=Fast |
Medium |
Updates are received in the middle of the rollout period. | CitrixWorkspaceApp.exe AURolloutPriority=Medium |
Slow |
Updates are received at the end of the rollout period. | CitrixWorkspaceApp.exe AURolloutPriority=Slow |
Store Configuration Parameters
Configure access to stores using these parameters:
ALLOWADDSTORE
Manages the types of stores (HTTP/HTTPS) users can add.
Value | Description | Example |
---|---|---|
S (default) |
Allows adding only secure stores (HTTPS). | CitrixWorkspaceApp.exe ALLOWADDSTORE=S |
A |
Allows adding both secure (HTTPS) and non-secure (HTTP) stores (Not for per-user installs). | CitrixWorkspaceApp.exe ALLOWADDSTORE=A |
N |
Prevents users from adding or removing stores. | CitrixWorkspaceApp.exe ALLOWADDSTORE=N |
ALLOWSAVEPWD
Controls whether store credentials can be saved locally.
Value | Description | Example |
---|---|---|
S (default) |
Allows saving passwords for secure stores (HTTPS) only. | CitrixWorkspaceApp.exe ALLOWSAVEPWD=S |
N |
Disallows saving passwords. | CitrixWorkspaceApp.exe ALLOWSAVEPWD=N |
A |
Allows saving passwords for both secure (HTTPS) and non-secure (HTTP) stores. | CitrixWorkspaceApp.exe ALLOWSAVEPWD=A |
Store Configuration Examples
StoreFront Store URL:
CitrixWorkspaceApp.exe /silent STORE0="AppStore;https://testserver.net/Citrix/MyStore/discovery;on;HR App Store"
Citrix Gateway Store URL:
CitrixWorkspaceApp.exe STORE0=HRStore;https://ag.mycompany.com#Storename;On;Store
Multiple Stores:
CitrixWorkspaceApp.exe STORE0="StoreFront Store;https://testserver.net/Citrix/MyBackupStore/discovery;on; StoreFrontStore" STORE1="NetScaler Store;https://ag.mycompany.com#Storename;On;NetScaler Store"
Installation Feature Parameters
Customize installed components using these parameters:
startAppProtection
Enables App Protection for enhanced security.
CitrixWorkspaceApp.exe startAppProtection
Exclude Citrix Enterprise Browser
Excludes Citrix Enterprise Browser binaries during installation.
CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,BCR_Client,USB,DesktopViewer,AM,SSON,SelfService,WebHelper
INSTALLDIR
Specifies a custom installation directory.
CitrixWorkspaceApp.exe INSTALLDIR=C:custom pathCitrix
ADDLOCAL
Installs specific components.
Value | Component Name | Description |
---|---|---|
ReceiverInside |
Receiver | Workspace SDK services. |
ICA_Client |
HDX Engine | Session launch process. |
BCR_Client |
BCR client | Browser content redirection. |
USB |
USB Client | USB redirection. |
DesktopViewer |
Desktop Viewer Client | Virtual desktop UI. |
AM |
AuthManager | Authentication Manager. |
SSON |
SSON | Single sign-on component. |
SELFSERVICE |
Self-service | Native launch plug-in. |
WebHelper |
Web Helper | Browser-native workspace app connection. |
CitrixEnterpriseBrowser |
Browser | Secure native browser. |
Example:
CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,BCR_Client,USB,DesktopViewer,AM,SSON,SelfService,WebHelper,CitrixEnterpriseBrowser
IncludeCitrixCasting
(Deprecated in LTSR 2402 and later) Installs Citrix Casting.
HDX Feature Parameters
Configure HDX features with these parameters:
ALLOW_BIDIRCONTENTREDIRECTION
Enables bidirectional content redirection.
Value | Description | Example |
---|---|---|
0 (default) |
Disabled. | CitrixWorkspaceApp.exe ALLOW_BIDIRCONTENTREDIRECTION=0 |
1 |
Enabled. | CitrixWorkspaceApp.exe ALLOW_BIDIRCONTENTREDIRECTION=1 |
FORCE_LAA
Installs Local App Access client-side component.
Value | Description | Example |
---|---|---|
0 (default) |
Not installed. | CitrixWorkspaceApp.exe FORCE_LAA =0 |
1 |
Installed. | CitrixWorkspaceApp.exe FORCE_LAA =1 |
ALLOW_CLIENTHOSTEDAPPSURL
Enables URL redirection on user devices.
Value | Description | Example |
---|---|---|
0 (default) |
Disabled. | CitrixWorkspaceApp.exe ALLOW_CLIENTHOSTEDAPPSURL=0 |
1 |
Enabled. | CitrixWorkspaceApp.exe ALLOW_CLIENTHOSTEDAPPSURL=1 |
LEGACYFTAICONS
Controls display of icons for documents associated with subscribed applications.
Value | Description | Example |
---|---|---|
False (default) |
Displays icons. | CitrixWorkspaceApp.exe LEGACYFTAICONS=False |
True |
Does not display icons. | CitrixWorkspaceApp.exe LEGACYFTAICONS=True |
Preference and User Interface Parameters
Customize user interface and preferences using these parameters:
STARTMENUDIR and DESKTOPDIR
Specify shortcut directories.
Command | Description | Directory Example |
---|---|---|
CitrixWorkspaceApp.exe STARTMENUDIR |
Start menu shortcuts directory. | STARTMENUDIR=Workspace (Start > All Programs > Workspace) |
CitrixWorkspaceApp.exe DESKTOPDIR |
Desktop shortcuts directory. | DESKTOPDIR=Workspace (Desktop > Workspace) |
SELFSERVICEMODE
Controls access to the self-service UI.
Value | Description | Example |
---|---|---|
True |
User access enabled. | CitrixWorkspaceApp.exe SELFSERVICEMODE=True |
False |
User access disabled. | CitrixWorkspaceApp.exe SELFSERVICEMODE=False |
ENABLEPRELAUNCH
Enables session pre-launch.
Value | Description | Example |
---|---|---|
True |
Enabled. | CitrixWorkspaceApp.exe ENABLEPRELAUNCH=True |
False |
Disabled. | CitrixWorkspaceApp.exe ENABLEPRELAUNCH=False |
DisableSetting
Hides Shortcuts and Reconnect options in Advanced Preferences.
Value | Description | Example |
---|---|---|
0 (default) |
Both options displayed. | CitrixWorkspaceApp.exe DisableSetting=0 |
1 |
Only Reconnect displayed. | CitrixWorkspaceApp.exe DisableSetting=1 |
2 |
Only Shortcuts displayed. | CitrixWorkspaceApp.exe DisableSetting=2 |
3 |
Both options hidden. | CitrixWorkspaceApp.exe DisableSetting=3 |
EnableCEIP
Enables Customer Experience Improvement Program.
Value | Description | Example |
---|---|---|
True (default) |
Opt-in to CEIP. | CitrixWorkspaceApp.exe EnableCEIP=True |
False |
Opt-out of CEIP. | CitrixWorkspaceApp.exe EnableCEIP=False |
EnableTracing
Enables always-on tracing.
Value | Description | Example |
---|---|---|
True (default) |
Enabled. | CitrixWorkspaceApp.exe EnableTracing=true |
False |
Disabled. | CitrixWorkspaceApp.exe EnableTracing=false |
CLIENT_NAME
Specifies the client device name.
CitrixReceiver.exe CLIENT_NAME=%COMPUTERNAME%
ENABLE_DYNAMIC_CLIENT_NAME
Dynamically sets client name to computer name.
Value | Description | Example |
---|---|---|
Yes (default) |
Enabled. | CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=Yes |
No |
Disabled (use CLIENT_NAME ). |
CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=No |
Authentication Parameters
Configure authentication related features:
/includeSSON
Installs single sign-on component (Administrator install required).
CitrixWorkspaceApp.exe /includeSSON
ENABLE_SSON
Enables single sign-on (requires /includeSSON
).
Value | Description | Example |
---|---|---|
Yes (default) |
Enabled. | CitrixWorkspaceApp.exe ENABLE_SSON=Yes |
No |
Disabled. | CitrixWorkspaceApp.exe ENABLE_SSON=No |
Uninstalling Citrix Workspace App
Windows Uninstaller
The simplest way to uninstall Citrix Workspace app is through the Windows Control Panel:
- Open Control Panel and navigate to Programs and Features or Uninstall a program.
- Locate Citrix Workspace in the list of installed programs.
- Right-click and select Uninstall.
- Follow the on-screen instructions to complete the uninstallation.
Note: During uninstallation, you might be prompted to uninstall Citrix HDX RTME package. Click OK to proceed.
Command-Line Uninstallation
For silent or automated uninstallation, use the command line:
Uninstall Command:
CitrixWorkspaceApp.exe /uninstall
Silent Uninstall Command:
CitrixWorkspaceApp.exe /silent /uninstall
Note: Group Policy Object (GPO) registry keys are not removed during uninstallation and need to be updated or deleted manually using
gpedit
.
Troubleshooting and Resetting
Error Codes
Refer to Citrix documentation for specific error codes encountered during installation or uninstallation.
Installer Logs
Installation logs are crucial for troubleshooting. Find them at:
Installation Type | Log Folder |
---|---|
Administrator | 64-bit: C:Program Files (x86)CitrixLogs 32-bit: C:Program FilesCitrixICA Client |
User | %USERPROFILE%AppDataLocalCitrixLogs |
Note: Log file names start with
CWAInstaller-
from version 2311.1 onwards.
Reset Citrix Workspace App
To restore Citrix Workspace app to its default settings, use the reset command. This will remove configured accounts, stores, cached data, and per-user settings.
Reset Command:
"C:Program Files (x86)CitrixICA ClientSelfServicePluginCleanUp.exe" -cleanUser
Silent Reset Command:
"C:Program Files (x86)CitrixICA ClientSelfServicePluginCleanUp.exe" /silent -cleanUser
Note: Resetting does not affect the Citrix Workspace app installation itself, per-machine ICA lockdown settings, or GPO configurations.
This comprehensive guide provides all the necessary information for installing and uninstalling Citrix Workspace app on Windows. By following these instructions, users can effectively deploy and manage Citrix Workspace app within their environments.