Install, Uninstall and Update

You can install the Citrix Workspace App using any of the following methods:

  • You can download the CitrixWorkspaceApp.exe installation package from the Citrix Workspace app 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
  • Use Active Directory and sample startup scripts to deploy the Citrix Workspace app for Windows. For information about Active Directory, see Using Active Directory and sample startup scripts
  • Deploy Citrix Workspace app for Windows using Workspace for Web to ensure that the users have installed the Workspace app for Windows before launching an application from a browser. For more information, see Using Workspace for Web
  • Use an Electronic Software Distribution (ESD) tool like the Microsoft System Center Configuration Manager 2012 R2. For more information, see Using System Center Configuration Manager 2012 R2

Note:

Citrix Workspace app for Windows is digitally-signed. The digital signature is time-stamped. So, the certificate is valid even after the certificate is expired.

Installation with administrator and non-administrator privileges:

The following differences exist between installations of Citrix Workspace app for Windows performed by an administrator and those performed by a (non-administrator) 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

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.

Install manually

You can install Citrix Workspace app for Windows from the installation media, a network share, Windows Explorer, or a command line by manually running the CitrixWorkspaceApp.exe installer package. For command line installation parameters and space requirements, see Using command-line parameters.

Using command-line parameters

Customize Citrix Workspace app installer by specifying command line options. The installer package self-extracts to the user’s temp directory before launching the setup program. The space requirement includes program files, user data, and temp directories after launching several applications.

For more information about system requirements, see System requirements.

To install Citrix Workspace app for Windows from a command prompt, use the syntax:

**CitrixWorkspaceApp.exe \[Options\]**

Workspace Updates:

Option /AutoUpdateCheck = auto/manual/disabled
Description Indicates that Citrix Workspace app detects when an update is available. Auto – You are notified when an update is available (default).; Manual –You are not notified when updates are available. Check for updates manually.; Disabled – Disable auto-update
Sample usage CitrixWorkspaceApp.exe /AutoUpdateCheck = auto ; CitrixWorkspaceApp.exe /AutoUpdateCheck = manual ; CitrixWorkspaceApp.exe /AutoUpdateCheck = disabled
Option /AutoUpdateStream= LTSR/Current
Description Indicates the release of Citrix Workspace app. LTSR – indicates that the release is a Long Term Service Release ; Current – indicates that the release is the latest version of Citrix Workspace app
Sample usage CitrixWorkspaceApp.exe /AutoUpdateStream= LTSR ; CitrixWorkspaceApp.exe /AutoUpdateStream= Current
Option /DeferUpdateCount
Description Indicates the release of Citrix Workspace app. -1 – indicates that you can defer the notifications any number of times (default value=-1) ; 0 – indicates that the Remind me later option is not displayed. Any other number – indicates that the Remind me later option is displayed in that count. For example, if you set the value to 10, the Remind me later option is displayed 10 times.
Sample usage CitrixWorkspaceApp.exe /DeferUpdateCount=-1 ; CitrixWorkspaceApp.exe /DeferUpdateCount=-0 ; CitrixWorkspaceApp.exe /DeferUpdateCount=any other number
Option /AURolloutPriority
Description Indicates the period when you can stage the rollout. Fast – Update rollout happens at the beginning of the delivery period. Medium – Update rollout happens at the mid-delivery period. Slow – Update rollout happens at the end of the delivery period.
Sample usage CitrixWorkspaceApp.exe /AURolloutPriority=Fast ; CitrixWorkspaceApp.exe /AURolloutPriority=Medium ; CitrixWorkspaceApp.exe /AURolloutPriority=Slow

Enable bidirectional content redirection:

Note:

By default, Citrix Workspace app does not install the bidirectional content redirection components if they are already installed on the server. If you are using Citrix Virtual Apps and Desktops as a client machine, you must install Citrix Workspace app by using the /FORCE_LAA switch to install the bidirectional content redirection components. The feature, however, must be configured both on the server and the client.

Option ALLOW_BIDIRCONTENTREDIRECTION=1
Description Indicates that the bidirectional content redirection between client to host and host to the client is Enabled.
Sample usage CitrixWorkspaceApp.exe /ALLOW_BIDIRCONTENTREDIRECTION=1

Hide Settings Option:

   
Option /DisableSetting
Description Suppresses Shortcuts and Reconnect option to be displayed in the Advanced Preferences sheet.
Sample usage CitrixWorkspaceApp.exe /DisableSetting=3
   
If you want both Application Display and Reconnect Options to be displayed in the Shortcuts and Reconnect Option. Enter CitrixWorkspaceApp.exe /DisableSetting=0
If you want Shortcuts and Reconnect option to be hidden in the Advanced Preferences sheet Enter CitrixWorkspaceApp.exe /DisableSetting=3
If you want Shortcuts and Reconnect option to display only Application Display Enter CitrixWorkspaceApp.exe /DisableSetting=2
If you want Shortcuts and Reconnect option to display only Reconnect Options Enter CitrixWorkspaceApp.exe /DisableSetting=1

Enable Local App Access:

Option FORCE_LAA=1
Description By default, Citrix Workspace app does not install the client-end Local App Access components if the components are already installed on the server. To force the client side Local App Access components on the Citrix Workspace, use FORCE_LAA command line switch. Administrator-level privileges are required to perform these steps. For more information on Local App Access, see Local App Access in Citrix Virtual Apps and Desktops documentation.
Sample usage CitrixWorkspaceApp.exe /FORCE_LAA =1

Display usage information:

Option /? or /help
Description Indicates usage information
Sample usage CitrixWorkspaceApp.exe /? ; CitrixWorkspaceApp.exe /help

Suppress reboot during UI installation:

Option /noreboot
Description Suppresses reboot during UI installations. This option is not necessary for silent installs. If you suppress reboot prompts, the USB devices that are in suspended state when Citrix Workspace app installs is not recognized by Citrix Workspace until after the user device is restarted.
Sample usage CitrixWorkspaceApp.exe /noreboot

Silent installation:

Option /silent
Description Disables the error and progress dialogs to run a completely silent installation.
Sample usage CitrixWorkspaceApp.exe /silent

Enable single sign on authentication:

Option /includeSSON
Description Indicates that the Citrix Workspace app will be installed with the single sign-on component. The related option, ENABLE_SSON, is enabled when /includeSSON is on the command line. If you use ADDLOCAL= to specify features and you want to install the single sign on, you must also specify the value SSON. To enable pass-through authentication for a user device, you must install Citrix Workspace app with local administrator rights from a command line that has the option /includeSSON. For more information, see How to Manually Install and Configure Citrix Workspace for Pass-Through Authentication. Note: Smart card, Kerberos and Local user name and password policies are inter-dependent. The order of configuration is important. We recommend to first disable unwanted policies, and then enable the policies you require. Carefully validate the result.
Sample usage CitrixWorkspaceApp.exe /includeSSON

Enable single sign on when /includeSSON is specified:

Option ENABLE_SSON={Yes, No}
Description Enable Single sign-on when /includeSSON is specified. The default value is Yes. This property is required for smart card Single sign-on. Users must log off and log in to their devices after installing with Single sign-on authentication enabled. Requires administrator rights.
Sample usage CitrixWorkspaceApp.exe ENABLE_SSON=Yes

Always-on tracing:

Option /EnableTracing={true, false}
Description By default, this feature is set to true. Use this property to enable or disable the always-on tracing feature. Always-on tracing helps to collect critical logs around the connection time. These logs can prove useful when troubleshooting intermittent connectivity issues. The Always On tracing policy overrides this setting.
Sample usage CitrixWorkspaceApp.exe /EnableTracing=true

Using the CEIP:

Option EnableCEIP={true , false }
Description When you enable participation in the Citrix Customer Experience Improvement Program (CEIP), anonymous statistics and usage information are sent to Citrix to help Citrix improve the quality and performance of its products.
Sample usage CitrixWorkspaceApp.exe EnableCEIP=true

Specify the installation directory:

Option INSTALLDIR=Installation Directory
Description Specifies the installation path where most of the Citrix Workspace app is installed. The default value is C:\Program Files\Citrix\Workspace. The following Citrix Workspace components are installed in the C:\Program Files\Citrix path: Authentication Manager ; Citrix Workspace ; Self-Service plug-in. If you use this option and specify an Installation directory, you must install RIInstaller.msi file in the \Workspace directory and the other .msi files in the installation directory.
Sample usage CitrixWorkspaceApp.exe INSTALLDIR=c:\Citrix\Test

Identify a user device:

Option CLIENT_NAME=ClientName
Description Specifies the client name, where ClientName is the name used to identify the user device to the server. The default value is %COMPUTERNAME%
Sample usage CitrixWorkspaceApp.exe CLIENT_NAME=%COMPUTERNAME%.

Dynamic client name:

Option ENABLE_CLIENT_NAME=Yes, No
Description The dynamic client name feature allows the client name to be the same as the computer name. When users change their computer name, the client name changes to match. Defaults to Yes. To disable dynamic client name support, set this property to No and specify a value for the CLIENT_NAME property.
Sample usage CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME =Yes

Install specified components:

Option ADDLOCAL=
Description alt_text
Sample usage CitrixWorkspaceapp.exe ADDLOCAL=ReceiverInside,ICA_Client,AM,SELFSERVICE,DesktopViewer,Flash,Vd3d,WebHelper,BrowserEngine, WorkspaceHub

Configure Workspace for Windows to manually add Stores:

Option ENABLE_CLIENT_NAME=Yes, No
Description The dynamic client name feature allows the client name to be the same as the computer name. When users change their computer name, the client name changes to match. Defaults to Yes. To disable dynamic client name support, set this property to No and specify a value for the CLIENT_NAME property.
Sample usage CitrixWorkspaceApp.exe ENABLE_DYNAMIC_CLIENT_NAME =Yes

Save credentials for stores locally using PNAgent protocol:

Option ALLOWSAVEPWD={N, S, A}
Description The default is the value specified by the PNAgent server at runtime. Specifies whether users can save the credentials for stores locally on their computers and apply only to stores using the PNAgent protocol. Defaults to S. Options include: N – Never allow users to save their passwords. S - Allow users to save passwords for both secure stores (HTTPS) and non-secure stores (HTTPS) and non-secure stores (HTTP). You can also control this feature by updating the registry key HKEY_LOCAL_MACHINE\Software[Wow6432Node]\Citrix\Dazzle\AllowSavePwd. Note: The following registry key must be added manually if AllowSavePwd does not work: 1 Key for 32 bit OS client: HKEY_LOCAL_MACHINE\Software\Citrix\AuthManager 2 Key for 64 bit OS client: HKEY_LOCAL_MACHINE\Software\wow6432node\Citrix\AuthManager 3 Type: REG_SZ 4 Value: never - never allow users to save their passwords. secureonly - allow users to save passwords for secure stores only (configured with HTTPS). always - allow users to save passwords for both secure stores (HTTPS) and non-secure stores (HTTP).
Sample usage CitrixWorkspaceApp.exe ALLOWADDSTORE=N /S / A

Select certificate:

Option AM_CERTIFICATESELECTIONMODE={Prompt, SmartCardDefault, LatestExpriry }
Description alt_text
Sample usage CitrixWorkspaceApp.exe AM_CERTIFICATESELECTIONMODE=Prompt

Use CSP components to manage Smart Card PIN entry:

Option AM_SMARTCARDPINENTRY=CSP
Description Use CSP components to manage Smart Card PIN entry. By default, the PIN prompts presented to users are provided by Citrix Workspace app rather than the smart card Cryptographic Service Provider (CSP). Citrix Workspace app prompts users to type a PIN when required and then passes the PIN to the smart card CSP. Specify this property to use the CSP components to manage the PIN entry, including the prompt for a PIN.
Sample usage CitrixWorkspaceApp.exe AM_SMARTCARDPINENTRY=CSP

Using Kerberos:

Option ENABLE_KERBEROS={Yes , No}
Description The default value is No. Specifies whether the HDX engine should use Kerberos authentication and applies only when single sign-on (pass-through) authentication is enabled. For more information, see Configure domain pass-through authentication with Kerberos.
Sample usage CitrixWorkspaceApp.exe ENABLE_KERBEROS=No

Displaying legacy FTA icons:

Option LEGACYFTAICONS={False, True}
Description Use this option to display Legacy FTA icons. The default value is False. Specifies whether or not application icons are displayed for documents that have file type associations with subscribed applications. When the argument is set to false, Windows generates icons for documents that do not have a specific icon assigned to them. The icons generated by Windows consist of a generic document icon overlaid with a smaller version of the application icon. Citrix recommends enabling this option if you plan to deliver Microsoft Office applications to users running Windows 7.
Sample usage CitrixWorkspaceApp.exe LEGACYFTAICONS=False

Enabling pre-launch:

Option ENABLEPRELAUNCH={False, True}
Description The default value is False. For information about session pre-launch, see Reduce application launch time.
Sample usage CitrixWorkspaceApp.exe ENABLEPRELAUNCH=False

Specifying the directory for Start Menu shortcuts:

Option STARTMENUDIR={Directory Name}
Description 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. You can change or move the folder at any time.You can also control this feature using a registry key: Create the entry REG_SZ for StartMenuDir and give it the value “\RelativePath” Location: HKEY_LOCAL_MACHINE\Software[Wow6432Node]Citrix\Dazzle , HKEY_CURRENT_USER\Software\Citrix\Dazzle. For applications published through Citrix Virtual Apps with a Client applications folder (also referred to as a Program Neighborhood folder) specified, you can specify that the client applications folder is to be appended to the shortcuts path as follows: Create the entry REG_SZ for UseCategoryAsStartMenuPath and give it the value “true.” Use the same registry locations as noted above.Note: Windows 8/8.1 does not allow you to create nested folders within the Start menu. Applications are displayed individually or inside the root folder and not within defined Category sub folders. Examples: 1 If client application folder is \office, UseCategoryAsStartMenuPath is true, and no StartMenuDiris specified, shortcuts are placed under Start > All Programs > Office. 2 If Client applications folder is \Office, UseCategoryAsStartMenuPath is true, and StartMenuDir is \Workspace, shortcuts are placed under Start > All Programs > Workspace > Office. Changes made to these settings have no impact on shortcuts that are already created. To move shortcuts, you must uninstall and reinstall the applications
Sample usage CitrixWorkspaceApp.exe STARTMENUDIR=\Office

Specifying the Store Name:

Option STOREx=”storename;http[s]://servername.domain/IISLocation/discovery;[On, Off] ; [storedescription] “[STOREy=”–”]
Description Use this option to specify the Store name. Specifies up to 10 stores to use with Workspace for Windows. Values: x and y – Integers 0 through 9.; storename – Defaults to store. This 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 StoreFront provisioning files. The store URLs are of the form “/Citrix/store/discovery.” To obtain the URL, export a provisioning file from StoreFront, open it in notepad and copy the URL from the Address element.; On, Off - The optional Off configuration setting 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.Note: In this release, it is important to include “/discovery” in the store URL for successful pass-through authentication.
Sample usage CitrixWorkspaceApp.exe STORE0=”Store;https://test.xx.com/Citrix/Store/Discovery

Enabling URL Redirection on user devices:

Option ALLOW_CLIENTHOSTEDAPPSURL=1
Description Enables the URL redirection feature on user devices. Requires administrator rights. Requires that Workspace for Windows is installed for All Users. For information about URL redirection, see Local App Access and its subtopics in the Citrix Virtual Apps and Desktops documentation.
Sample usage CitrixWorkspaceApp.exe ALLOW_CLIENTHOSTEDAPPSURL=1

Enabling self-service mode:

Option SELFSERVICEMODE={False , True}
Description The default value is True. When the administrator sets the SelfServiceMode flag to false, the user no longer has access to the self-service Workspace for Windows user interface. Instead, they can access subscribed apps from the Start menu and via desktop shortcuts - known as “shortcut-only mode”.
Sample usage CitrixWorkspaceApp.exe SELFSERVICEMODE=False

Specifying the directory for Desktop Shortcuts:

Option DESKTOPDIR=Directory Name
Description Brings all shortcuts into a single folder. Category Path is supported for desktop shortcuts. Note: When using the DESKTOPDIR option, set the PutShortcutsOnDesktop key to True.
Sample usage CitrixWorkspaceApp.exe DESKTOPDIR=\Office

Upgrading from an unsupported Citrix Workspace app version

Note:

When you upgrade Citrix Workspace app Version 13.x Enterprise or 12.x to Citrix Workspacd app Version 4.4 and later using the graphical user interface, the installer runs the Receiver cleanup utility by default.

However, the utility does not run by default when you upgrade from the command line. To upgrade from the command line, run the following command:

CitrixWorkspaceApp.exe /rcu /silent

When you upgrade Citrix Receiver for Windows from 13.x (non-Enterprise) or 4.1 to Version 4.2 or later, the /rcu switch is unnecessary and ignored.

Option /rcu
Description Allows you to upgrade from an unsupported version to the latest version of Citrix Workspace.
Sample usage CitrixWorkspaceApp.exe /rcu

Troubleshooting the installation

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

Examples of a command line installation

To specify the Citrix Gateway store URL:

CitrixWorkspaceApp.exe STORE0="\<StoreFriendlyName\>;[testserver](https://testserver.com) <StoreName\>;\<On/Off\>;\<StoreDescription\>"]

Note:

The Citrix Gateway store URL must be the first entry in the list of configured store URLs.

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"

To specify single sign-on (pass-through authentication) and add a store that points to a XenApp Services URL:

CitrixWorkspaceApp.exe / INCLUDESSON
/STORE0="PNAgent;https://testserver.net/Citrix/PNAgent/config.xml;on;MyPNAgent Site"

Using Active Directory and sample startup scripts

You can use Active Directory Group Policy scripts to pre-deploy Citrix Workspace app for Windows on systems based on your Active Directory organizational structure. Citrix recommends using the scripts rather than extracting the .msi files. Use the Scripts setting in the Group Policy Management Console (GPMC) under Computer Configuration or User Configuration. For general information about startup scripts, see Microsoft documentation.

To use the startup scripts with Active Directory:

  1. Create the Organizational Unit (OU) for each script.
  2. Create a Group Policy Object (GPO) for the newly created OU.

Edit sample scripts

Edit the scripts with the following parameters in the header section of each file:

  • Current Version of package- The specified version number is validated and if it is not present the deployment proceeds. For example, set DesiredVersion= 3.3.0.XXXX to exactly match the version specified. If you specify a partial version, for example, 3.3.0, it matches any version with that prefix (3.3.0.1111, 3.3.0.7777, and so on).
  • Package Location/Deployment directory- This specifies the network share containing the packages and is not authenticated by the script. The shared folder must have Read permission set to EVERYONE.
  • Script Logging Directory- This specifies the network share where the install logs are copied and is not authenticated by the script. The shared folder must have Read and Write permissions for EVERYONE.
  • Package Installer Command Line Options- These command line options are passed to the installer. For the command line syntax, see Using command-line parameters.

Per-computer configuration using startup scripts

Citrix includes sample per-computer startup scripts to install and uninstall CitrixWorkspaceApp.exe. The scripts are located on the Citrix Workspace app for Windows Download page.

  • CheckAndDeployWorkspacePerMachineStartupScript.bat
  • CheckAndRemoveWorkspacePerMachineStartupScript.bat

To add the per-computer startup scripts:

  1. Open the Group Policy Management Console.
  2. Select Computer Configuration > Policies > Windows Settings > Scripts (Startup/Shutdown).
  3. In the right pane of the Group Policy Management Console, select Startup.
  4. In the Properties menu, click Show Files, copy the appropriate script to the folder displayed, and close the dialog.
  5. In the Properties menu, click Add and select Browse to add the newly created script.

To deploy Citrix Workspace app for Windows per-computer:

  1. Move the user devices designated to receive this deployment to the OU you created.
  2. Reboot the user device and log on.
  3. Verify that the newly installed package is listed in the Program and Features.

To remove Citrix Workspace app for Windows per-computer:

  1. Move the user devices designated for the removal to the OU you created.
  2. Reboot the user device and log on as any user.
  3. Verify that the newly installed package is not listed in the Program and Features.

Per-computer configuration using startup scripts

Citrix recommends using per-computer startup scripts. For Windows per-user deployments, the following two Citrix Workspace app for Windows per-user scripts are included on the Citrix Virtual Apps and Desktops media in the Citrix Workspace for Windows and Plug-ins\Windows\Workspace\Startup_Logon_Scripts folder.

  • CheckAndDeployWorkspacePerUserLogonScript.bat
  • CheckAndRemoveWorkspacePerUserLogonScript.bat

To add the per-user startup scripts:

  1. Open the Group Policy Management Console.
  2. Select User Configuration > Policies > Windows Settings > Scripts.
  3. In the right-hand pane of the Group Policy Management Console, select log on
  4. In the Logon Properties menu, click Show Files, copy the appropriate script to the folder displayed, and then close the window.
  5. In the Logon Properties menu, click Add and use Browse to find and add the newly created script.

To deploy Citrix Workspace app for Windows per-user:

  1. Move the users designated to receive this deployment to the OU you created.
  2. Reboot the user device and log on as the specified user.
  3. Verify that Program and Features (Add or Remove Programs in previous OS versions) contain the newly installed package.

To remove Citrix Workspace app for Windows per-user:

  1. Move the users designated for the removal to the OU you created.
  2. Reboot the user device and log on as the specified user.
  3. Verify that Program and Features (Add or Remove Programs in previous OS versions) removed the previously installed package.

Using Workspace for Web

You can deploy Citrix Workspace app for Windows from Workspace for Web to ensure that you have installed the Citrix Workspace app for Windows before connecting to an application from a browser. Workspace for Web site enable you to access StoreFront stores through a web page. If the Workspace for Web site detects that a user does not have a compatible version of Citrix Workspace app for Windows, you are prompted to download and install Citrix Workspace app for Windows.

Email-based account discovery is not supported when Citrix Workspace app for Windows is deployed using Workspace for Web. If email-based account discovery is configured and a first-time user installs Citrix Workspace app for Windows from Citrix.com, Citrix Workspace app for Windows prompts the user for an email or server address. Entering an email address results in the error message “Your email cannot be used to add an account.”

Use the following configuration to prompt for the server address only.

  1. Download CitrixWorkspaceApp.exe to your local computer.
  2. Rename CitrixWorkspaceApp.exeto CitrixWorkspaceWeb.exe.
  3. Deploy the renamed executable using your regular deployment method. If you use StoreFront, see Configure Workspace for Web sites using the configuration files in the StoreFront documentation.

Using System Center Configuration Manager 2012 R2

You can use Microsoft System Center Configuration Manager (SCCM) to deploy Citrix Workspace app.

Note:

Only Citrix Receiver for Windows Version 4.5 and later supports SCCM deployment.

There are four parts to completing the deployment of Citrix Workspace app for Windows using SCCM:

  1. Adding Citrix Workspace app to the SCCM deployment
  2. Adding distribution points
  3. Deploying the Citrix Workspace app to the software center
  4. Creating Device Collections

Adding Citrix Workspace app to the SCCM deployment

  1. Copy the downloaded Citrix Workspace app installation folder to a folder on the Configuration Manager server and launch the Configuration Manager console.

  2. Select Software Library > Application Management. Right-click Application and click Create Application. The Create Application wizard appears.

    localized image

  3. In the General pane, select Manually specify the application information and click Next.

  4. In the General Information pane, specify information about the application such as Name, Manufacturer, Software version, and so on.

  5. In the Application Catalog wizard, specify additional information such as Language, Application name, User category and so on and click Next.

    Note:

    Users can see the information you specify here.

  6. In the Deployment Type pane, click Add to configure the deployment type for Citrix Workspace app setup.

    The Create Deployment Type wizard appears.

    localized image

  7. In the General pane: Set the deployment type to Windows Installer (*.msi file), select Manually specify the deployment type information and click Next.
  8. In the General Information pane: Specify deployment type details (For example: Workspace Deployment) and click Next.
  9. In the Content pane:

    1. Provide the path where the Citrix Workspace app setup file is present. For example: Tools on SCCM server.
    2. Specify Installation program as one of the following:
      • CitrixWorkspaceApp.exe /silent for default silent installation.
      • CitrixWorkspaceApp.exe /silent /includeSSON to enable domain pass-through.
      • CitrixWorkspaceApp.exe /silent SELFSERVICEMODE=false to install Citrix Workspace app in Non-Self Service Mode.
    3. Specify Uninstall program as CitrixWorkspaceApp.exe /uninstall (to enable uninstallation through SCCM).

    localized image

  10. In the Detection Method pane: Select Configure rules to detect the presence of this deployment type and click Add Clause. The Detection Rule dialog appears.

    localized image

    • Set Setting Type to File System.
    • Under Specify the file or folder to detect the application, set the following:
      • Type – From the drop-down menu, select File.
      • Path – %ProgramFiles (x86)%\Citrix\ICA Client\Workspace\
      • File or folder name – CitrixWorkspaceApp.exe
      • Property – From the drop-down menu, select Version
      • Operator – From the drop-down menu, select Greater than or equal to
      • Value – Type 4.3.0.65534

    Note

    This rule combination applies to Citrix Workspace app for Windows upgrades as well.

  11. In the User Experience pane, set:

    • Installation behavior - Install for system
    • Logon requirement - Whether or not a user is logged on
    • Installation program visibility - Normal. Click Next.

    Note

    Do not specify any requirements and dependencies for this deployment type.

  12. In the Summary pane, verify the settings for this deployment type. Click Next.

    A success message appears.

  13. In the Completion pane, a new deployment type (Workspace Deployment) is listed under the Deployment types.

  14. Click Next and click Close.

Add distribution points

  1. Right-click Citrix Workspace app in the Configuration Manager console and select Distribute Content.

    The Distribute Content wizard appears.

    localized image

  2. In the Content Distribution pane, click Add > Distribution Points.

    The Add Distribution Points dialog appears.

  3. Browse to the SCCM server where the content is available and click OK.

    In the Completion pane, a success message appears

  4. Click Close

Deploy Citrix Workspace app to the software center

  1. Right-click Citrix Workspace app in the Configuration Manager console select Deploy.

    The Deploy Software wizard appears.

  2. Select Browse against Collection (can be Device Collection or User Collection) where the application is to be deployed and click Next.

    localized image

  3. In the Deployment Settings pane, set Action to Install and Purpose to Required (enables unattended installation). Click Next.

  4. In the Scheduling pane, specify the schedule to deploy the software on target devices.

  5. In the User Experience pane, set the User notifications behavior; select Commit changes at deadline or during a maintenance window (requires restart) and click Next to complete the Deploy Software wizard.

In the Completion pane, a success message appears.

Reboot the target endpoint devices (required only to start installation immediately).

On endpoint devices, Citrix Workspace app is visible in the Software Center under Available Software. Installation is triggered automatically based on the schedule you configure. Alternatively, you can also schedule or install on demand. The installation status is displayed in the Software Center after the installation starts.

Creating device collections

  1. Launch the Configuration Manager console, click Assets and Compliance> Overview> Devices.

    localized image

  2. Right-click Device Collections and select Create Device Collection.

    The Create Device Collection wizard appears.

  3. In the General pane, type the Name for the device and click Browse for Limiting collection.

    This determines the scope of devices, which can be one the default Device Collections created by SCCM. Click Next.

  4. In the Membership Rules pane, click Add Rule for filtering the devices.

    The Create Direct Membership Rule wizard appears.

    • In the Search for Resources pane, select the Attribute name based on the devices you want to filter and provide the Value for Attribute name to select the devices.
  5. Click Next. In the Select Resources pane, select the devices that are required to be part of device collection.

    In the Completion pane a success message appears.

  6. Click Close.

  7. In the Membership rules pane, a new rule is listed under Click Next.

  8. In the Completion pane, a success message appears. Click Close to complete the Create Device Collection wizard.

    The new device collection is listed in Device Collections. The new device collection is a part of Device Collections while browsing in Deploy Software wizard.

Note:

When you set the MSIRESTARTMANAGERCONTROL attribute to False, deploying Citrix Workspace app for Windows using SCCM might not be successful. As per our analysis, Citrix Workspace app for Windows is not the cause of this failure. Also, retrying might yield successful deployment.

Uninstall

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.

Uninstall 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

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.

When you reinstall Citrix Workspace app for Windows, these policies might be enforced, possibly causing unexpected behavior. To remove the customizations, delete them manually.

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

CitrixWorkspaceApp.exe\silent\uninstall

Upgrade

Manual Upgrade to Citrix Workspace app for Windows

For deployments with StoreFront:

  • Best practice for BYOD (Bring Your Own Device) users is to configure the latest versions of Citrix Gateway and StoreFront as described in the documentation for those products on the Product Documentation site. Attach the provisioning file created by StoreFront to an email and inform users how to upgrade and to open the provisioning file after installing Citrix Workspace app for Windows.
  • As an alternative to providing a provisioning file, inform users to enter the Citrix Gateway URL. Or, if you configured email-based account discovery as described in the StoreFront documentation, inform users to enter their email address.
  • Another method is to configure Workspace for Web site as described in the StoreFront documentation and complete the configuration described in Using Workspace for Web. Inform users how to upgrade Citrix Workspace app for Windows, access the Workspace for Web site, and download the provisioning file from Workspace for Web (click the user name and click Activate).

Considerations when upgrading:

For information about considerations before upgrading Citrix Workspace app for Windows, see the Knowledge Center article CTX135933.

Upgrading Citrix Workspace app

To upgrade to the latest Citrix Workspace app, do any of the following steps:

  • Download the Citrix Workspace app from the Citrix download page.
  • Upgrade your Citrix Workspace app using your app store.
  • Auto update to Citrix Workspace app from Citrix Receiver using Citrix Workspace Updates.

Citrix Workspace Updates

When you configure Citrix Workspace Updates from Citrix Workspace app, follow the methods below in the order of priority:

  1. Group Policy Object administrative (GPO) template
  2. Command line interface
  3. Advanced Preferences (per-user)

Note:

  • When you upgrade Citrix Workspace app using Citrix Workspace Updates, the log in window does not appear.
  • HDX RTME for Windows is included in Citrix Workspace updates. You are notified of the available HDX RTME update on both the LTSR and the current release versions of Citrix Workspace app.

Limitations:

  1. If you have configured an SSL intercepting outbound proxy, you must add an exception to the Workspace auto-update Signature service https://citrixupdates.cloud.com/ and the download location https://downloadplugins.citrix.com/.
  2. Your system must have access to the internet.
  3. Workspace for Web users cannot download the StoreFront policy automatically.
  4. By default, Citrix Workspace Updates is disabled on the VDA. This includes RDS multi-user server machines, VDI and RemotePC machines.
  5. Citrix Workspace Updates is disabled on machines where Desktop Lock is installed.

Configure Citrix Workspace Updates using the Group Policy Object administrative template

  1. Open the Citrix Workspace app Group Policy Object administrative template by running gpedit.msc.

  2. Under the Computer Configuration node, go to Administrative Templates > Citrix Components > Citrix Workspace > Workspace Updates.

  3. Select the Set the Delay in Checking for Update policy. This policy allows you to stage the rollout for a period.

    localized image

  4. Select Enabled, and from the Delay Group drop-down, select one of the following options:

    • Fast – Update rollout happens at the beginning of the delivery period.
    • Medium – Update rollout happens at the mid-delivery period.
    • Slow – Update rollout happens at the end of the delivery period.
  5. Click Apply and OK to save the Policy.

  6. In the Workspace Updates Templates section, select the Citrix Workspace Updates policy.

    localized image

    Note:

    When you select Disabled, you are not notified of the available updates. This also hides the Workspace Updates option from the Advanced Preferences sheet.

  7. Select Enabled and set the values as required:

    • From the Enable Citrix Workspace Update Policy drop-down, select one of the following options:
      • Auto - You are notified when an update is available (default).
      • Manual - You are not notified when updates are available. Check for updates manually.
    • Select LTSR ONLY to get updates for LTSR only.
    • From the Auto-Update-DeferUpdate-Count drop-down, select a value between -1 and 30, where
      • -1 indicates that you can defer the notifications any number of times (default value=-1).
      • 0 indicates that the Remind me later option is not displayed.
      • Any other number indicates that the Remind me later option is displayed on that count. For example, if you set the value to 10, the Remind me later option is displayed 10 times.
  8. Click Apply and OK to save the policy.

Configure Citrix Workspace Updates using the command line interface

While installing Citrix Workspace app for Windows:

To configure Citrix Workspace Updates settings as an administrator using command-line settings during Citrix Workspace app for Windows installation:

  • /AutoUpdateCheck= auto/manual/disabled
  • /AutoUpdateStream= LTSR/Current. Where, LTSR refers to Long Term Service Release and Current refers to the current release.
  • /DeferUpdateCount= any value between -1 and 30
  • /AURolloutPriority= auto/fast/medium/slow

For example - CitrixWorkspaceApp.exe /AutoUpdateCheck=auto /AutoUpdateStream=Current /DeferUpdateCount=-1 /AURolloutPriority=fast*

  • To configure Citrix Workspace Updates settings as a user using command-line settings during Citrix Workspace for Windows installation /AutoUpdateCheck=auto/manual

For example: CitrixWorkspaceApp.exe/AutoUpdateCheck=auto*

Editing Citrix Workspace Updates settings using the Group Policy Object administrative template overrides the settings applied during Citrix Workspace app installation for all users.

After Citrix Workspace app for Windows installation:

Citrix Workspace Updates can be configured after installing Citrix Workspace app for Windows.

To use the command line:

Open Windows Command Prompt and change the directory to where CitrixWorkspaceUpdater.exe is located. Typically, CitrixWorkspaceUpdater.exe is located at CitrixWorkspaceInstallLocation\Citrix\Ica Client\Workspace.

You can also set the Citrix Workspace Updates command-line policy using this binary.

For example, Administrators can use all the four options:

  • CitrixWorkspaceUpdater.exe / AutoUpdateCheck=auto /AutoUpdateStream= Current/DeferUpdateCount=-1 / AURolloutPriority= fast

Configure Citrix Workspace Updates using the graphical user interface

Note:

You can hide all or part of the Advanced Preferences sheet available from the Citrix Workspace app icon in the notification area. For more information, see Hiding the Advanced Preferences sheet.

An individual user can override the Citrix Workspace Updates setting using the Advanced Preferences dialog. This is a per-user configuration and the settings apply only to the current user.

  1. Right-click Citrix Workspace app icon from the notification area.

  2. Select Advanced Preferences and click Workspace Updates.

    localized image

  3. Select one of the following options:

    • Yes, notify me
    • No, don’t notify me
    • Use administrator specified settings
  4. Click Save.

Configure Citrix Workspace Updates using StoreFront

  1. Use a text editor to open the web.config file, which is typically located in the C:\inetpub\wwwroot\Citrix\Roaming directory.

  2. Locate the user account element in the file (Store is the account name of your deployment)

    For example: <account id=... name="Store">

    Before the </account> tag, navigate to the properties of that user account:

    <properties>
           <clear/>
     </properties>
    
  3. Add the auto-update tag after <clear /> tag.

    <account>
    
        <clear />
    
        <account id="d1197d2c-ac82-4f13-9346-2ee14d4b0202" name="F84Store"
    
          description="" published="true" updaterType="Citrix" remoteAccessType="None">
    
          <annotatedServices>
    
            <clear />
    
            <annotatedServiceRecord serviceRef="1__Citrix_F84Store">
    
              <metadata>
    
                <plugins>
    
                  <clear />
    
                </plugins>
    
                <trustSettings>
    
                  <clear />
    
                </trustSettings>
    
                <properties>
    
                  <property name="Auto-Update-Check" value="auto" />
    
                  <property name="Auto-Update-DeferUpdate-Count" value="1" />
    
                          <property name="Auto-Update-LTSR-Only" value="FALSE" />
    
                  <property name="Auto-Update-Rollout-Priority" value="fast" />
    
                        </properties>
    
              </metadata>
    
            </annotatedServiceRecord>
    
          </annotatedServices>
    
          <metadata>
    
            <plugins>
    
              <clear />
    
            </plugins>
    
            <trustSettings>
    
              <clear />
    
            </trustSettings>
    
            <properties>
    
              <clear />
    
            </properties>
    
          </metadata>
    
        </account>
    
    

auto-update-Check

This attribute indicates that Citrix Workspace app detects when an update is available.

Valid values:

  • Auto – You are notified when an update is available (default).
  • Manual –You are not notified when updates are available. Check for updates manually.
  • Disabled – The Citrix Workspace Updates is hidden and you will not be notified when an update is available.

auto-update-LTSR-Only

This attribute indicates that Citrix Workspace app must accept updates only for LTSR.

Valid values:

  • True – Citrix Workspace Updates checks only for LTSR updates of Citrix Workspace app for Windows
  • False – Citrix Workspace Updates checks for non-LTSR updates of Citrix Workspace app for Windows as well.

auto-update-DeferUpdate-Count

This attribute indicates the number of counts you can defer the notifications. The Remind me later option is displayed in the count of the set value.

Valid values:

  • -1 – indicates that you can defer the notifications any number of times (default value=-1).
  • 0 – indicates that the Remind me later option is not displayed.
  • Any other number – indicates that the Remind me later option is displayed in that count. For example, if you set the value to 10, the Remind me later option is displayed 10 times.

auto-update-Rollout-Priority

This attribute indicates the period that you can set for the rollout.

Valid values:

  • Fast – Update rollout happens at the beginning of the delivery period.
  • Medium – Update rollout happens at the mid-delivery period.
  • Slow – Update rollout happens at the end of the delivery period.