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

Note:

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.

  1. Launch the CitrixWorkspaceApp.exe file and click Start.
  2. Read and accept the End User License Agreement and proceed with the installation.
  3. 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.
  4. 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

  • /? Or /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.

Install parameters

/AutoUpdateCheck

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

Options Description
Auto (default) You are notified when an update is available.
Manual You are not notified when an update is available. Check for updates manually.
Disabled Disabled auto updates

Example, CitrixWorkspaceApp.exe /AutoUpdateCheck=auto | manual | disabled.

/AutoUpdateStream

If you have enabled auto-update, you can choose the release track you would like to update to. See Lifecycle Milestones for more information.

Options Description
LTSR Indicates that the Auto-update to Long Term Service Release cumulative updates only.
Current Indicates that the release is the latest version of Citrix Workspace app.

Example, CitrixWorkspaceApp.exe /AutoUpdateStream=Current | LTSR.

/DeferUpdateCount

Indicates the number of times that you can defer the update notification when an update is available. See Citrix Workspace Updates for more information.

  • -1 (default)- Allows deferring notification any number of times. Example, CitrixWorkspaceApp.exe /DeferUpdateCount=-1.
  • 0 – Indicates that you will receive one notification (only) for every available update. The Remind me later option is disabled. Example, CitrixWorkspaceApp.exe /DeferUpdateCount=0.
  • 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, CitrixWorkspaceApp.exe /DeferUpdateCount=<n>.

/AURolloutPriority

Indicates the period when you can stage the rollout.

  • Auto (default) - Updates are rolled out during the delivery period as configured by the administrator. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Auto.
  • Fast – Updates are rolled out at the beginning of the delivery period. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Fast.
  • Medium- Updates are rolled out at the mid-delivery period. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Medium.
  • Slow – Updates are rolled out at the end of the delivery period. Example, CitrixWorkspaceApp.exe /AURolloutPriority=Slow.

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. Example, CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,AM,SELFSERVICE,DesktopViewer,Flash,Vd3d,WebHelper,BrowserEngine, WorkspaceHub.

HDX features parameters

ALLOW_BIDIRCONTENTREDIRECTION

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, 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-end local app access component. See the Local App Access section in Citrix Virtual Apps and Desktops documentation for more information.

  • 2-0 (default)- Indicates that local app access component is not installed. Example, CitrixWorkspaceApp.exe FORCE_LAA =2.
  • 3-1 - Indicates that the client-end local app access component is installed. Example, CitrixWorkspaceApp.exe FORCE_LAA =1.

LEGACYFTAICONS

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, CitrixWorkspaceApp.exe LEGACYFTAICONS=False.
  • True- Indicates that the application icons are not displayed 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 PNAgent 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 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. Example, CitrixWorkspaceApp.exe DESKTOPDIR=\Office.

SELFSERVICEMODE

Controls access to the self-service Workspace app user interface. See Session Management in Fast Connect 3 Credential Insertion API documentation.

  • True - Indicates that the user has access to 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 Reconnect option in the Advanced Preferences sheet. Example, CitrixWorkspaceApp.exe DisableSetting=1.
  • 2 – Displays only 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%.

ENABLE_DYNAMIC_CLIENT_NAME

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, CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME=Yes.
  • No- Does not allow the client name to be the same as the computer name. You must 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 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. 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, CitrixWorkspaceApp.exe ENABLE_KERBEROS=Yes.
  • No - Indicates that the HDX engine will not 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 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 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.

Note:

  • The Citrix Gateway store URL configured using this method does not support the PNA Services Sites that are using Citrix Gateway.
  • While configuring multiple stores, Citrix Gateway store URL should be first in the list.

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

Uninstall

Using Windows-based uninstaller:

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

Note:

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:

CitrixWorkspaceApp.exe /uninstall

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

CitrixWorkspaceApp.exe /silent /uninstall

Note:

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

Troubleshooting

If there is a problem with the installation, search in the user’s %TEMP%/CTXWorkspaceInstallLogs directory for the logs with the prefix CtxInstall- or TrolleyExpress-. For example,

CtxInstall-ICAWebWrapper-20141114-134516.log

TrolleyExpress-20090807-123456.log