Install and Uninstall

You can install the Citrix Workspace app either by:

• Downloading the CitrixWorkspaceApp.exe installation package from the Download page or
• From your company’s download page (if available).

You can install the package using the following steps:

• 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:

Note:

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 %temp%\CTXReceiverInstallLogs*.logs.

1. Launch the CitrixWorkspaceApp.exe file and click Start.
2. Read and accept the EULA and continue with the installation.
3. When installing on a domain-joined machine with administrator privileges, a single sign-on dialog appears. See Domain pass-through authentication for more information.
4. 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

Common parameters

• /? Or /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.
• /rcu - The /rcu switch is effective only when upgrading from an unsupported version of the software. Indicates that Citrix Workspace app install or upgrade is done by uninstalling the existing version. The /rcu switch also cleans up existing or older settings.

  Note:

  The /rcu switch is deprecated as of 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. Use this switch in the following scenarios:

  • Upgrading from an unsupported version of Citrix Workspace app version.
  • The installation or upgrade is unsuccessful.

Install parameters

/AutoUpdateCheck

Indicates that Citrix Workspace app detects when an update is available.

Note:

The /AutoUpdateCheck is a mandatory parameter that you must set to configure other parameters like /AutoUpdateStream, /DeferUpdateCount, /AURolloutPriority.

• Auto (default) - You’re notified when an update is available. Example, CitrixWorkspaceApp.exe /AutoUpdateCheck=auto.
• Manual - You aren’t notified when an update is available. Check for updates manually. Example, CitrixWorkspaceApp.exe /AutoUpdateCheck=manual.
• Disabled - Disables auto-updates. Example, CitrixWorkspaceApp.exe /AutoUpdateCheck=disabled.

/AutoUpdateStream

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, CitrixWorkspaceApp.exe /AutoUpdateStream=LTSR.
• Current - Auto-updates to the latest version of Citrix Workspace app. Example, CitrixWorkspaceApp.exe /AutoUpdateStream=Current.

/DeferUpdateCount

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, CitrixWorkspaceApp.exe /DeferUpdateCount=-1.
• 0 - Indicates that you receive one notification (only) for every available update. Doesn’t remind you again about the update. Example, CitrixWorkspaceApp.exe /DeferUpdateCount=0.
• Any other number ‘n’ - Allows deferring notifications ‘n’ number of times. The Remind me later option is displayed in the ‘n’ count. Example, CitrixWorkspaceApp.exe /DeferUpdateCount=<n>.

/AURolloutPriority

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, CitrixWorkspaceApp.exe /AURolloutPriority=Auto.
• Fast - You receive the updates at the beginning of the delivery period. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Fast.
• Medium - You receive the updates at the mid-delivery period. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Medium.
• Slow - You receive the updates at the end of the delivery period. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Slow.

/includeappprotection

Provides enhanced security by restricting the ability of clients to be compromised by keylogging and screen-capturing malware.

• CitrixWorkspaceApp.exe /includeappprotection

See App Protection for more information.

/InstallEmbeddedBrowser

Excludes the Citrix Enterprise Browser binaries. Run the /InstallEmbeddedBrowser=N switch to exclude the Citrix Enterprise Browser feature.

INSTALLDIR

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.

ADDLOCAL

Installs one or more of the specified components. For example, CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,AM,SSON,SELFSERVICE,DesktopViewer,WebHelper,WorkspaceHub,USB,AppProtection.

Note:

By default, ReceiverInside, ICA_Client, and AM are installed when installing the Citrix Workspace app.

The ADDLOCAL installs one or more of the specified components.

ReceiverInside, ICA_Client, and AM are prerequisites and are installed by default when installing the Citrix Workspace app.

• ReceiverInside – Installs the Citrix Workspace app experience (required), functionality of sys tray and auto-update.
• ICA_Client – Installs the HDX components.
• AM – Installs Authentication Manager components.

You can also install the following modules depending on your requirement and environment:

• SSON – Installs components required for single sign-on.
• SELFSERVICE – Installs the self-service plug-in. This allows you to access virtual desktops and applications from the Citrix Workspace app window or from a command line. If SELFSERVICE is not installed, you can access the applications and desktops via the web (Receiver for Web).
• DesktopViewer – Installs Desktop Viewer for viewing virtual apps and desktops.
• WebHelper: Installs the WebHelper component. This component retrieves the ICA file from StoreFront and passes it to the HDX Engine. It also verifies the environment parameters and shares them with StoreFront. This component is used during session launch via browser.
• WorkspaceHub: Citrix Ready workspace hub component that enables Citrix Casting.
• USB – Installs USB support.
• AppProtection: Install App Protection component.

HDX features parameters

ALLOW_BIDIRCONTENTREDIRECTION

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, CitrixWorkspaceApp.exe ALLOW_BIDIRCONTENTREDIRECTION=0.
• 1 - Indicates that the bidirectional content redirection is enabled. Example, CitrixWorkspaceApp.exe ALLOW_BIDIRCONTENTREDIRECTION=1.

FORCE_LAA

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.

LEGACYFTAICONS

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, CitrixWorkspaceApp.exe LEGACYFTAICONS=False.
• True - Doesn’t display icons for documents or files that have file type associations with subscribed applications. Example, CitrixWorkspaceApp.exe LEGACYFTAICONS=True.

ALLOW_CLIENTHOSTEDAPPSURL

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, CitrixWorkspaceApp.exe ALLOW_CLIENTHOSTEDAPPSURL=0.
• 1- Enables the URL redirection feature on the user devices. Example, CitrixWorkspaceApp.exe ALLOW_CLIENTHOSTEDAPPSURL=1.

Preference and user interface parameters

ALLOWADDSTORE

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, CitrixWorkspaceApp.exe ALLOWADDSTORE=S.
• 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, CitrixWorkspaceApp.exe ALLOWADDSTORE=A.
• N – Never allow users to add or remove their own store. Example, CitrixWorkspaceApp.exe ALLOWADDSTORE=N.

ALLOWSAVEPWD

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, CitrixWorkspaceApp.exe ALLOWSAVEPWD=S.
• N - Does not allow saving the password. Example, CitrixWorkspaceApp.exe ALLOWSAVEPWD=N.
• A - Allows saving the password for both secure stores (HTTPS) and non-secure stores (HTTP). Example, CitrixWorkspaceApp.exe ALLOWSAVEPWD=A.

STARTMENUDIR

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 \Programs folder. For example, to place shortcuts under Start > All Programs > Workspace, specify STARTMENUDIR=\Workspace.

DESKTOPDIR

Specifies the directory for shortcuts on the Desktop.

Note:

When using the DESKTOPDIR option, set the PutShortcutsOnDesktop key to True.

• <Directory Name> - You can specify the relative path of the shortcuts. For example, to place shortcuts under Start > All Programs > Workspace, specify DESKTOPDIR=\Workspace.

SELFSERVICEMODE

Controls access to the self-service Citrix Workspace app user interface.

• True - Indicates that the user has access to the self-service user interface. Example, CitrixWorkspaceApp.exe SELFSERVICEMODE=True.
• False - Indicates that the user does not have access to the self-service user interface. Example, CitrixWorkspaceApp.exe SELFSERVICEMODE=False.

ENABLEPRELAUNCH

Controls session pre-launch. See Application launch time for more information.

• True - Indicates that session pre-launch is enabled. Example, CitrixWorkspaceApp.exe ENABLEPRELAUNCH=True.
• False - Indicates that session pre-launch is disabled. Example, CitrixWorkspaceApp.exe ENABLEPRELAUNCH=False.

DisableSetting

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, CitrixWorkspaceApp.exe DisableSetting=0.
• 1 – Displays only the Reconnect option in the Advanced Preferences sheet. Example, CitrixWorkspaceApp.exe DisableSetting=1.
• 2 – Displays only the Shortcuts option in the Advanced Preferences sheet. Example, CitrixWorkspaceApp.exe DisableSetting=2.
• 3 – Both Shortcuts and Reconnect options are hidden from the Advanced Preferences sheet. Example, CitrixWorkspaceApp.exe DisableSetting=3.

EnableCEIP

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, CitrixWorkspaceApp.exe EnableCEIP=True.
• False - Opt out of the Citrix Customer Improvement Program (CEIP). Example, CitrixWorkspaceApp.exe EnableCEIP=False.

EnableTracing

Controls the Always-on tracing feature.

• True (default)- Enables the Always-on tracing feature. Example. CitrixWorkspaceApp.exe EnableTracing=true.
• False - Disables the Always-on tracing feature. Example, CitrixWorkspaceApp.exe EnableTracing=false.

CLIENT_NAME

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 %COMPUTERNAME%. Example, CitrixReceiver.exe CLIENT_NAME=%COMPUTERNAME%.

ENABLE_DYNAMIC_CLIENT_NAME

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, CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=Yes.
• No - Does not allow the client name to be the same as the computer name. Specify a value for the CLIENT_NAME property. Example, CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=No.

Authentication parameters

ENABLE_SSON

Enables single sign-on when the Citrix 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, CitrixWorkspaceApp.exe ENABLE_SSON=Yes.
• No - Indicates that single sign-on is disabled. Example, CitrixWorkspaceApp.exe ENABLE_SSON=No.

ENABLE_KERBEROS

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, CitrixWorkspaceApp.exe ENABLE_KERBEROS=Yes.
• No - Indicates that the HDX engine doesn’t use Kerberos authentication. Example, CitrixWorkspaceApp.exe ENABLE_KERBEROS=No.

In addition to the above properties, you can also specify the store URL that is used with the Citrix 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]"

Values:

• 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.

Examples of a command-line installation

To specify the Citrix Gateway store URL:

CitrixWorkspaceApp.exe STORE0=HRStore;https://ag.mycompany.com#Storename;On;Store
<!--NeedCopy-->

Where, Storename indicates the name of the store that needs to be configured.

Note:

• The Citrix Gateway store URL configured using this method does not support the PNA Services Sites that are using Citrix Gateway.
• In a multi-store setup, the Citrix Gateway store URL must be first in the list. Only one Citrix Gateway store URL configuration is allowed.

To install all components silently and specify two application stores:

CitrixWorkspaceApp.exe /silent 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"

Note:

• It’s mandatory to include /discovery in 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

Note:

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.

Uninstall

Using Windows-based uninstaller:

You can uninstall Citrix Workspace app using the Windows Programs and Features utility (Add or Remove Programs).

Note:

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:

CitrixWorkspaceApp.exe /uninstall

For silent uninstallation of Citrix Workspace app, run the following switch:

CitrixWorkspaceApp.exe /silent /uninstall

Note:

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 gpedit or delete them manually.