Citrix Workspace Download Msi

Posted on  by admin

Hi all, Ive tried to install a new version of Citrix to access remotely to my company. Somehow it did not work. I then tried to uninstall the Citrix workspace app, rebooted the PC and tried again to install it.

The citrix workspace app can be deployed as a line of business application with microsoft intune. The workspace app download comes as an installer package (inside an apple disk image) that can be converted into suitable file format with the microsoft intune app wrapping tool, ready to deploy with intune. The citrix workspace app disk image. Click here to view our downloads page. Click here to view our downloads page. VDI client features. Click here for an overview of VDI client features. VDI client registry settings. Click here to view the VDI client registry settings. For additional configuration, the VDI client also responds MSI switches, except for the AutoUpdate.

-->

This article describes the requirements and limitations for using Microsoft Teams in a virtualized environment.

What is VDI?

Virtual Desktop Infrastructure (VDI) is virtualization technology that hosts a desktop operating system and applications on a centralized server in a data center. This enables a fully personalized desktop experience to users with a fully secured and compliant centralized source.

Microsoft Teams in a virtualized environment supports chat and collaboration. And with the Windows Virtual Desktop, Citrix, and VMware platforms, calling and meeting functionality is also supported.

Teams in a virtualized environment supports multiple configurations. These include VDI, dedicated, shared, persistent, and non-persistent modes. Features are in continuous development and are added on a regular basis, and functionality will expand in the coming months and years.

Using Teams in a virtualized environment might be somewhat different from using Teams in a non-virtualized environment. For example, some advanced features might not be available in a virtualized environment, and video resolution might differ.

To ensure an optimal user experience, follow the guidance in this article.

Note

For details about Teams VDI on different platforms, see Teams features by platform.

Teams on VDI components

Using Teams in a virtualized environment requires the following components.

  • Virtualization broker: The resource and connection manager to the virtualization provider, such as Azure
  • Virtual desktop: The Virtual Machine (VM) stack that runs Microsoft Teams
  • Thin client: The endpoint that the user physically interfaces with
  • Teams desktop app: The Teams desktop client app

Teams on VDI requirements

Virtualization provider requirements

The Teams desktop app was validated with leading virtualization solution providers. With multiple market providers, we recommend that you consult your virtualization solution provider to ensure that you meet the minimum requirements.

Currently, Teams on VDI with audio/video (AV) optimization is certified with Windows Virtual Desktop, Citrix, and VMware. Review the information in this section to ensure that you meet all requirements for proper functionality.

Platforms certified for Teams

Citrix Workspace Download Msi

The following platforms have virtual desktop infrastructure solutions for Teams.

PlatformSolution
Windows Virtual Desktop
Citrix Virtual Apps and Desktops
VMware Horizon

Windows Virtual Desktop

Windows Virtual Desktop provides AV optimization for Teams on VDI. To learn more and requirements and installation, see Use Teams on Windows Virtual Desktop.

Citrix Virtual Apps and Desktops requirements

Citrix Virtual Apps and Desktops (formerly known as XenApp and XenDesktop) provides AV optimization for Teams on VDI. With Citrix Virtual Apps and Desktops, Teams on VDI supports calling and meeting functionality in addition to chat and collaboration.

You can download the latest version of Citrix Virtual Apps and Desktops at the Citrix downloads site. (You'll need to sign in first.) The necessary components are bundled into the Citrix Workspace app (CWA) and Virtual Delivery Agent (VDA) by default. You don't need to install any additional components or plugins on CWA or the VDA.

For the latest server and client requirements, see this Citrix website.

VMware Horizon Workspace and Desktop requirements

VMware Horizon is a modern platform for secure delivery of virtual desktops and apps across the hybrid cloud. To offer a great end-user experience, VMware Horizon provides media optimization for Teams. This optimization improves overall productivity across virtual desktops and apps, and enhances user experience when calling and meeting using Teams.

You can download the latest version of VMware Horizon from the VMware Downloads page. The required media optimization components are part of the Horizon Agent and Horizon Client by default and there's no need to install any additional plug-in to use the optimization feature for Teams.

To get the latest requirements and instructions on how to configure media optimization for Teams, see this VMware website.

Install or update the Teams desktop app on VDI

You can deploy the Teams desktop app for VDI using a per-machine installation or per-user installation using the MSI package. Deciding on which approach to use depends on whether you use a persistent or non-persistent setup and the associated functionality needs of your organization.

For a dedicated persistent setup, either approach would work. However, for a non-persistent setup, Teams requires a per-machine installation in order to work efficiently. See the Non-persistent setup section.

With per-machine installation, automatic updates is disabled. This means that to update the Teams app, you must uninstall the current version to update to a newer version. With per-user installation, automatic updates is enabled. For most VDI deployments, we recommend you deploy Teams using per-machine installation.

To update to the latest Teams version, start with the uninstall procedure followed by latest Teams version deployment.

For Teams AV optimization in VDI environments to work properly, the thin client endpoint must have access to the internet. If internet access isn't available at the thin client endpoint, optimization startup won't be successful. This means that the user is in a non-optimized media state.

Dedicated persistent setup

In a dedicated persistent setup, users' local operating system changes are retained after users log off. For persistent setup, Teams supports both per-user and per-machine installation.

The following is the recommended minimum VM configuration.

ParameterWorkstation operating systemServer operating system
vCPU2 cores4,6, or 8
It's important to understand the underlying non-uniform memory access (NUMA) configuration and configure your VMs accordingly.
RAM4 GB512 to 1024 MB per user
Storage8 GB40 to 60 GB

Non-persistent setup

In a non-persistent setup, users' local operating system changes are not retained after users log off. Such setups are commonly shared multi-user sessions. VM configuration varies based on the number of users and available physical box resources.

For a non-persistent setup, the Teams desktop app must be installed per-machine to the golden image. (To learn more, see the Install or update the Teams desktop app on VDI section.) This ensures an efficient launch of the Teams app during a user session.

Using Teams in a non-persistent setup also requires a profile-caching manager, for efficient Teams runtime data synchronization. Efficient data synchronization ensures that the appropriate user-specific information (such as a user's data, profile, or settings) is cached during the user's session. Make sure data in these two folders are synched:

  • C:UsersusernameAppDataLocalMicrosoftIdentityCache (%localAppdata%MicrosoftIdentityCache)
  • C:UsersusernameAppDataRoamingMicrosoftTeams (%appdata%MicrosoftTeams)

Note

A roaming folder (or, if you are using folder redirection, a caching manager) is required to ensure that the Teams app has the runtime data and files required to run the application. This is necessary to mitigate network latency issues or network glitches, which would otherwise cause application errors and a slow experience due to unavailable data and files.

There are a variety of caching manager solutions available. For example, FSLogix. Consult your caching manager provider for specific configuration instructions.

Teams cached content exclusion list for non-persistent setup

Exclude the following from the Teams caching folder, %appdata%/Microsoft/Teams. Excluding these items helps reduce the user caching size to further optimize your non-persistent setup.

  • .txt files
  • Media-stack folder
  • meeting-addinCache (%appdata%MicrosoftTeamsmeeting-addinCache)

Microsoft 365 Apps for enterprise considerations

Consider the following when you deploy Teams with Microsoft 365 Apps for enterprise on VDI.

New deployments of Teams through Microsoft 365 Apps for enterprise

Before you deploy Teams through Microsoft 365 Apps for enterprise, you must first uninstall any pre-existing Teams apps if they were deployed using per-machine installation.

Teams through Microsoft 365 Apps for enterprise is installed per-user. To learn more, see the Install or update the Teams desktop app on VDI section.

Teams deployments through Microsoft 365 Apps for enterprise updates

Teams is also being added to existing installations of Microsoft 365 Apps for enterprise. Since Microsoft 365 Apps for enterprise installs Teams per-user only, see the Install or update the Teams desktop app on VDI section.

Using Teams with per-machine installation and Microsoft 365 Apps for enterprise

Microsoft 365 Apps for enterprise doesn't support per-machine installations of Teams. To use per-machine installation, you must exclude Teams from Microsoft 365 Apps for enterprise. See the Deploy the Teams desktop app to the VM and How to exclude Teams deployment through Microsoft 365 Apps for enterprise sections.

How to exclude Teams deployment through Microsoft 365 Apps for enterprise

To learn more about Teams and Microsoft 365 Apps for enterprise, see How to exclude Teams from new installations of Microsoft 365 Apps for enterprise and Use Group Policy to control the installation of Teams.

Deploy the Teams desktop app to the VM

  1. Download the Teams MSI package that matches your VDI VM operating system using one of the following links:

    Note

    For government clouds, see Install Microsoft Teams using Microsoft Endpoint Configuration Manager for the download links to the MSI files.

    The minimum version of the Teams desktop app that's required is version 1.3.00.4461. (PSTN hold isn't supported in earlier versions.)

  2. Install the MSI to the VDI VM by running one of the following commands:

    • Per-user installation (default)

      This process is the default installation, which installs Teams to the %AppData% user folder. At this point, the golden image setup is complete. Teams won't work properly with per-user installation on a non-persistent setup.

    • Per-machine installation

      This process installs Teams to the Program Files (x86) folder on a 64-bit operating system and to the Program Files folder on a 32-bit operating system. At this point, the golden image setup is complete. Installing Teams per-machine is required for non-persistent setups.

      The next interactive logon session starts Teams and asks for credentials.

      Note

      These examples also use the ALLUSERS=1 parameter. When you set this parameter, Teams Machine-Wide Installer appears in Programs and Features in Control Panel and in Apps & features in Windows Settings for all users of the computer. All users can then uninstall Teams if they have admin credentials.It's important to understand the difference between ALLUSERS=1 and ALLUSER=1. The ALLUSERS=1 parameter can be used in non-VDI and VDI environments, while the ALLUSER=1 parameter is used only in VDI environments to specify a per-machine installation.

  3. Uninstall the MSI from the VDI VM. There are two ways to uninstall Teams.

    • PowerShell script: You can use this PowerShell script to uninstall Teams and remove the Teams folder for a user. Run the script for each user profile in which Teams was installed on the computer.

    • Command line: Run the following command.

      This process uninstalls Teams from the Program Files (x86) folder or Program Files folder, depending on the operating system environment.

Teams on VDI performance considerations

There are a variety of virtualized setup configurations, each with a different focus for optimization. For example, a configuration might focus on user density. When planning, consider the following to help optimize your setup based on your organization's workload needs.

  • Minimum requirement: Some workloads might require a setup using resources that are above the minimum requirements. For example, workloads for developers who use applications that demand more computing resources.
  • Dependencies: These include dependencies on infrastructure, workload, and other environmental considerations outside the Teams desktop app.
  • Disabled features on VDI: Teams disables GPU-intensive features for VDI, which can help improve transient CPU utilization. The following features are disabled:
    • Teams CSS animation
    • Giphy auto-start

Teams on VDI with calling and meetings

In addition to chat and collaboration, Teams on VDI with calling and meetings is available with supported virtualization provider platforms. Supported features are based on the WebRTC media stack and virtualization provider implementation. The following diagram provides an overview of the architecture.

Important

If you currently run Teams without AV optimization in VDI and you use features that are not supported yet for optimization (such as Give and take control when app sharing), you have to set virtualization provider policies to turn off Teams redirection. This means that Teams media sessions won't be optimized. For steps on how to set policies to turn off Teams redirection, contact your virtualization provider.

Network requirements

We recommend that you evaluate your environment to identify any risks and requirements that can influence your overall cloud voice and video deployment. Use the Skype for Business Network Assessment Tool to test whether your network is ready for Teams.

To learn more about how to prepare your network for Teams, see Prepare your organization's network for Teams.

Migrate from Skype for Business on VDI to Teams on VDI

If you're migrating from Skype for Business on VDI to Teams on VDI, besides the differences between the two applications, there are some differences when VDI is also implemented. Some capabilities that aren't currently supported in Teams VDI that are in Skype for Business VDI are as follows:

  • Per-platform policy to disable some AV features in VDI
  • Give and take control when app sharing
  • Screen share from chat without audio
  • Simultaneous video and screen sharing send and receive

Teams on Chrome browser versus Teams desktop app for VDI

Teams on Chrome browser doesn't provide a replacement for the Teams desktop app for VDI with AV optimization. The chat and collaboration experience works as expected. When media is needed, there are some experiences that might not meet user expectations on the Chrome browser:

  • The audio and video streaming experience might not be optimal. Users might experiences delays or reduced quality.
  • Device settings aren't available in browser settings.
  • Device management is handled through the browser and requires multiple settings in browser site settings.
  • Device settings might also need to be set in Windows device management.

Teams on VDI with chat and collaboration

If your organization wants to only use chat and collaboration features in Teams, you can set user-level policies to turn off calling and meeting functionality in Teams.

Set policies to turn off calling and meeting functionality

You can set policies by using the Microsoft Teams admin center or PowerShell. It might take some time (a few hours) for the policy changes to propagate. If you don't see changes for a given account immediately, try again in a few hours.

Calling polices: Teams includes the built-in DisallowCalling calling policy, in which all calling features are turned off. Assign the DisallowCalling policy to all users in your organization who use Teams in a virtualized environment.

Meeting policies: Teams includes the built-in AllOff meeting policy, in which all meeting features are turned off. Assign the AllOff policy to all users in your organization who use Teams in a virtualized environment.

Assign policies using the Microsoft Teams admin center

To assign the DisallowCalling calling policy and the AllOff meeting policy to a user:

  1. In the left navigation of the Microsoft Teams admin center, go to Users.
  2. Select the user by clicking to the left of the user name, and then click Edit settings.
  3. Do the following:
    1. Under Calling policy, click DisallowCalling.
    2. Under Meeting policy, click AllOff.
  4. Click Apply.

To assign a policy to multiple users at a time:

  1. In the left navigation of the Microsoft Teams admin center, go to Users, and then search for the users or filter the view to show the users you want.
  2. In the (check mark) column, select the users. To select all users, click the ✓ (check mark) at the top of the table.
  3. Click Edit settings, make the changes that you want, and then click Apply.

Or, you can also do the following:

  1. In the left navigation of the Microsoft Teams admin center, go to the policy you want to assign. For example:
    • Go to Voice > Calling policies, and then click DisallowCalling.
    • Go to Meetings > Meeting policies, and then click AllOff.
  2. Select Manage users.
  3. In the Manage users pane, search for the user by display name or by user name, select the name, and then click Add. Repeat this step for each user that you want to add.
  4. When you're finished adding users, click Save.

Assign policies using PowerShell

The following example shows how to use the Grant-CsTeamsCallingPolicy to assign the DisallowCalling calling policy to a user.

To learn more about using PowerShell to manage calling policies, see Set-CsTeamsCallingPolicy.

The following example shows how to use the Grant-CsTeamsMeetingPolicy to assign the AllOff meeting policy to a user.

To learn more about using PowerShell to manage meeting policies, see Set-CsTeamsMeetingPolicy.

Migrate Teams on VDI with chat and collaboration to optimize Teams with calling and meetings

If you have an existing implementation of Teams on VDI with chat and collaboration in which you had set user-level policies to turn off calling and meeting functionality, and you're migrating to Teams with AV optimization, you must set policies to turn on calling and meeting functionality for those Teams on VDI users.

Set policies to turn on calling and meeting functionality

You can use the Microsoft Teams admin center or PowerShell to set and assign calling and meeting policies to your users. It can take some time (a few hours) for policy changes to propagate. If you don't see changes for a given account immediately, try again after a few hours.

Calling polices: Calling policies in Teams control which calling features are available to users. Teams includes the built-in AllowCalling calling policy, in which all calling features are turned on. To turn on all calling features, assign the AllowCalling policy. Or, create a custom calling policy to turn on the calling features that you want and assign it to users.

Meeting policies: Meeting policies in Teams control the types of meetings that users can create and the features that are available to meeting participants that are scheduled by users in your organization. Teams includes the built-in AllOn meeting policy, in which all meeting features are turned on. To turn on all meeting features, assign the AllOn policy. Or, create a custom meeting policy to turn on the meeting features that you want and assign it users.

Assign policies using the Microsoft Teams admin center

To assign the AllowCalling calling policy and the AllOn meeting policy to a user:

  1. In the left navigation of the Microsoft Teams admin center, go to Users.
  2. Select the user by clicking to the left of the user name, and then click Edit settings.
  3. Do the following:
    1. Under Calling policy, click AllowCalling.
    2. Under Meeting policy, click AllOn.
  4. Click Apply.

Citrix Workspace App For Windows 10

To assign a policy to multiple users at a time:

  1. In the left navigation of the Microsoft Teams admin center, go to Users, and then search for the users or filter the view to show the users you want.
  2. In the (check mark) column, select the users. To select all users, click the (check mark) at the top of the table.
  3. Click Edit settings, make the changes that you want, and then click Apply.

Or, you can also do the following:

  1. In the left navigation of the Microsoft Teams admin center, go to the policy you want to assign. For example:
    • Go to Voice > Calling policies, and then click AllowCalling.
    • Go to Meetings > Meeting policies, and then click AllOn.
  2. Select Manage users.
  3. In the Manage users pane, search for the user by display name or by user name, select the name, and then click Add. Repeat this step for each user that you want to add.
  4. When you're finished adding users, click Save.

Assign policies using PowerShell

The following example shows how to use the Grant-CsTeamsCallingPolicy to assign the AllowCalling calling policy to a user.

Citrix Workspace Download Msi

To learn more about using PowerShell to manage calling policies, see Set-CsTeamsCallingPolicy.

The following example shows how to use the Grant-CsTeamsMeetingPolicy to assign the AllOn meeting policy to a user.

To learn more about using PowerShell to manage meeting policies, see Set-CsTeamsMeetingPolicy.

Control fallback mode in Teams

When users connect from an unsupported endpoint, the users are in fallback mode, in which AV isn't optimized. You can disable or enable fallback mode by setting one of the following registry DWORD values:

  • HKEY_LOCAL_MACHINESOFTWAREMicrosoftTeamsDisableFallback
  • HKEY_CURRENT_USERSOFTWAREMicrosoftOfficeTeamsDisableFallback

To disable fallback mode, set the value to 1. To enable audio only, set the value to 2. If the value isn't present or is set to 0 (zero), fallback mode is enabled.

This feature is available in Teams version 1.3.00.13565 and later.

Known issues and limitations

Client deployment, installation, and setup

  • With per-machine installation, Teams on VDI isn't automatically updated in the way that non-VDI Teams clients are. You have to update the VM image by installing a new MSI as described in the Install or update the Teams desktop app on VDI section. You must uninstall the current version to update to a newer version.
  • In Citrix environments, if the user disconnects from the Virtual Machine while Teams is running, Teams updates can result in the user to be in a non-optimized state for AV when they reconnect. We recommend that users quit Teams before they disconnect from Citrix Virtual Machine to avoid this scenario.
  • Teams should be deployed either per user or per machine. Deployment of Teams for concurrent per user and per machine is not supported. To migrate from either per machine or per user to one of these modes, follow the uninstall procedure and redeploy to either mode.
  • Windows Virtual Desktop and VMware don't support MacOS and Linux-based clients at this time.

Calling and meetings

The following calling and meeting features are not supported:

  • Any multi-window functionality like the new meeting experiences or any functionality that comes with the new meeting experience
  • Enhanced emergency services
  • HID buttons and LED controls between the Teams app and devices
  • Background blur and effects
  • Broadcast and live event producer and presenter roles
  • Location-Based Routing (LBR)
  • Call park
  • Call queue
  • Shared system audio/computer sound
  • Media bypass for Direct Routing
  • Zoom control

Note

We're working on adding calling and meeting features that are currently only available in non-VDI environments. These might include more admin control over quality, additional screen sharing scenarios, and advanced features recently added to Teams. Contact your Teams representative to learn more about upcoming features.

The following are known issues and limitations for calling and meetings:

  • Interoperability with Skype for Business is limited to audio calls; there is no video modality.
  • Only a single incoming video stream is supported in meetings or group calls. When multiple people send video, only the dominant speaker's video is shown at any given time.
  • Incoming and outgoing video stream resolution is limited to 720p resolution. This is a WebRTC limitation.
  • Only one video stream from an incoming camera or screen share stream is supported. When there's an incoming screen share, that screen share is shown, instead of the video of the dominant speaker.
  • Teams doesn't switch to use the last audio device that a user selected, if the device is disconnected, and then reconnected.
  • Outgoing screen sharing:
    • Application sharing is not supported.
  • Give control and take control:
    • Not supported during a screen sharing or application sharing session.
    • Supported during a PowerPoint sharing session.
  • Citrix-only limitations
    • When screen sharing in a multi-monitor setup, only the main monitor is shared.
    • High DPI scaling on CWA is not supported.

For Teams known issues that aren't related to VDI, see Support Teams in your organization.

Troubleshooting

Troubleshoot Citrix components

Teams crashes or the Teams sign in screen is blank

This is a known issue with Citrix VDA versions 1906 and 1909. To work around this issue, add the following registry DWORD value, and set it to 204 (hexadecimal).

HKEY_LOCAL_MACHINESOFTWARECitrixCtxHookAppInit_DllsSfrHookTeams.exe

Then, restart VDA. To learn more, see this Citrix support article, Troubleshooting HDX optimization for Teams.

Related topics

downloadCitrixCQI.zipWhy can't I download this file?

  • Added support for Microsoft Windows Server 2019.

Changes in Earlier Versions

  • Reduced the tool’s CPU usage.
  • Combined all Citrix.CQI.csv files generated per session into one single Citrix.CQI.Data.csv file.
  • Moved the combined Citrix.CQI.Data.csv file from user temp folders to the LocalService temp folder.
  • Reduced the tool’s memory usage.
  • Refactored notification UI elements.
  • Added the writing of busy state events to Windows Events.
  • Addressed the blurry icon issue on some high-DPI Mac displays.
  • Fixed an issue that GPO settings could not control notifications.
  • Added support for uploading CEIP data (application insights) to Google Analytics.
  • Added support for the tool's running on TLS/SSL-enabled VDAs.
  • Added support for configuring the duration of notifications.
  • Added support for uploading CEIP data over TLS 1.2.
  • Added a string to show the protocol type in the options panel that appears when you click the field, upward triangle symbol in the upper right corner of a CQI notification.
  • Provided logging data output as a CSV file.
  • Decreased logging frequency to log only when the connection status changes.
  • Added logging of busy connections and the causes: playing rich content; high CPU load; printing; file redirection.
  • Updated content of idle state message.
  • Limited popup notifications to appear only when connection status is poor.
  • Introduced indication for VDA idle state.
  • Introduced indication for weak performance and for poor performance due to playing rich content.
  • Introduced indication for weak performance and for poor performance due to high CPU load.
  • Introduced indication for weak performance and for poor performance due to printing.
  • Introduced indication for weak performance and for poor performance due to file redirection.
  • Renamed ICA Rdtrp to ICA RTT.
  • Changed default ICA Round Trip collection frequency to 15 seconds.
  • Added more language support:
    • Added support for zh-TW, ko-KR, ru-RU
    • Added support for de-DE, es-ES, fr-FR, ja-JP, zh-CN installer UI and GPO settings
  • Improved Event Logs by using separate EventIDs for different levels of network connections.
  • Introduced a warning message if disk space is less than 100 MB.
  • Added the Customer Experience Improvement Program (CEIP) feature. For more information, see About the Citrix Customer Experience Improvement Program (CEIP)
  • Added GPO settings.
  • Allowed you to customize the default notification position by using the CQI GPO.
  • Allowed you to disable audible notifications by using the CQI GPO.
  • Addressed an issue that might cause the CQI not to work when Seamless Flag is set to 0x20.
  • Allowed you to disable notifications by using the CQI GPO.
  • Allowed you to customize notification messages by using the CQI GPO.
  • Removed the word 'Servers' from Weak and Poor notification messages.
  • Retained the user preference for notification window position.
  • Provided the bandwidth threshold setting in the CQI GPO.
  • Renamed the Bandwidth counter to Available Bandwidth in the Real time data section of the option panel.
  • Improved logging.
  • Addressed an issue that at times, might cause the tool to exit unexpectedly on session startup.
  • Addressed an issue that prevented audible alerts from working on a Server VDA.
  • Addressed an issue that might cause the tool to display an incorrect notification after reconnecting to a session.

Supported Operating Systems

  • Microsoft Windows 10
  • Microsoft Windows 8.1
  • Microsoft Windows 7 with Service Pack 1
  • Microsoft Windows Server 2016
  • Microsoft Windows Server 2012 R2
  • Microsoft Windows Server 2008 R2 with Service Pack 1
  • Microsoft Windows Server 2019

Supported Virtual Delivery Agents

  • Server OS Virtual Delivery Agent 7.6.300 and later
  • Desktop OS Virtual Delivery Agent 7.6.300 and later

Prerequisites

  • Microsoft .NET Framework 4.5.1
  • Citrix Virtual Delivery Agent 7.6.300 or later must be installed.
  • To install or uninstall the tool, the user account must be a member of the local Administrators group on target machines.
  • Installing the tool over an ICA session is not supported but you can install the tool through a remote desktop session by using an administrator account.
  • The installer program complies with Microsoft User Account Control (UAC). If UAC is enabled, you must run the installer program in elevated mode. That is, with administrative privileges enabled. For more information about UAC, see Microsoft TechNet or visit the Microsoft website and search on keyword UAC.

Installing the Connection Quality Indicator

Install the Connection Quality Indicator on a Virtual Delivery Agent (VDA). You can install it by using the MSI package or by using the MSIEXEC command.

Installation by using the MSI package

1. Locate the local copy of the MSI package.

2. Double-click the MSI package to launch the CQI setup wizard.

3. The setup wizard window appears. Review and accept the License Agreement.

4. Click Install.

The setup wizard displays the installation progress.

5. After the wizard completes, click Finish.

The Citrix Customer Experience Improvement Program (CEIP) is enabled by default. To disable the program, clear the Participate in the Customer Experience Improvement Program check box.

The CQI has now been installed on the Virtual Delivery Agent and is ready for use.

Installation by using the MSIEXEC command

1. Open the Windows Command Prompt and navigate to the local copy of the MSI package.

2. Enter the MSIEXEC /i “CitrixCQI.msi” command to launch CQI setup wizard.

3. The setup wizard window appears. Review and accept the License Agreement.

4. Click Install.

The setup wizard displays the installation progress.

5. After the wizard completes, click Finish.

To disable the Citrix Customer Experience Improvement Program(CEIP), Use the “DISABLE_CEIP=1” option with MSIEXEC.

The CQI has now been installed on the Virtual Delivery Agent and is ready for use.

Uninstalling the Connection Quality Indicator

You can uninstall the tool by using Control Panel or by using the MSIEXEC command.

Uninstall by using Control Panel

1. Open the windows Start menu and select Control Panel.

2. Under Programs, click uninstall a program.

3. Locate the Connection Quality Indicator

Citrix Downloads Workspace App Windows

2. Right-click the program and select Uninstall. Follow the prompts to complete the uninstall.

To repair a Connection Quality Indicator installation, select the program and click Repair at the top of the program list.

Uninstall by using the MSIEXEC command

1. Open the Windows Command Prompt and navigate to the local copy of the MSI package.

2. Enter the MSIEXEC /x “CitrixCQI.msi” command to launch the CQI setup wizard.

3. The setup wizard appears. Click Next to continue.

4. Click Remove to begin uninstalling the CQI.

5. The wizard prompts for confirmation. Click Remove to continue.

The setup wizard displays the uninstall progress.

6. After the wizard completes, click Finish.

For more information on available parameters, see Command-Line Options.

Group Policy Configuration

Citrix recommends that you use the Windows Group Policy editor to configure the CQI. The CQI includes administrative template files (CitrixCQI.admx and CitrixCQI.adml) in its installation folder.

Citrix Workspace Download Msi Download

For the location of each group policy template file, see the following table.

File

Location

CitrixCQI.admx

<Installation Folder>Configuration

CitrixCQI.adml

<Installation Folder>Configuration[MUIculture]

CitrixBase.admx

<Installation Folder>Configuration

CitrixBase.adml

<Installation Folder>Configuration[MUIculture]

Note: You can use the .admx and .adml template files to configure the local GPO and domain-based GPOs. For information about managing the .admx files, see Microsoft MSDN article https://msdn.microsoft.com/en-us/library/bb530196.aspx#manageadmxfiles_topic2.

Adding Policy Template Files to the Local GPO

1. After installing the Connection Quality Indicator, copy the .admx and .adml group policy template files.

Copy the .admx files:

From: <Installation folder>ConfigurationCitrixCQI.admx

To: %systemroot%policyDefinitions

From: <Installation folder>ConfigurationCitrixBase.admx

To: %systemroot%policyDefinitions

Copy the .adml files:

From: <Installation folder>Configuration[MUIculture]CitrixCQI.adml

To: %systemroot%policyDefinitions[MUIculture]

From : <Installation folder>Configuration[MUIculture]CitrixBase.adml

To: %systemroot%policyDefinitions[MUIculture]

Note: The CQI template files are available on the local GPO in the Administrative Templates > Citrix Components > Virtual Desktop Agent > CQI folder only when you have added the CitrixBase.admx and CitrixBase.adml files to the policyDefinitions folder.

2. Use the CQI group policy template files to enable or disable the CQI, to do notification display settings (for example, customize notification messages or disable notifications), and to conduct threshold settings.

Note:

  • You can also perform user-level policy settings for the CQI. Computer configuration, if present, always takes precedence.
  • Starting with Version 19.9.0.33, the connection threshold settings are available only in the Computer Configuration section.

Launching CQI on Session Startup

The CQI installer modifies the system to launch the tool automatically on session startup. Depending on the type of VDA, the method of automatically launching the tool can vary:

For Server OS VDAs, append the path to the CQI’s launcher.cmd script to the AppSetup registry value. The registry entry is located at:

HKEY_LOCAL_MACHINESOFTWAREMicrosoftWindows NTCurrentVersionWinlogon

For Desktop OS VDAs, append the path to the CQI’s executable to the Run key. The Run key is located at:

HKEY_LOCAL_MACHINESOFTWAREMicrosoftWindowsCurrentVersionRun

To ensure that sessions are logged off properly, append the CQI’s executable name to the LogoffCheckSysModules registry value. The LogoffCheckSysModules registry entry is located at:

HKEY_LOCAL_MACHINESYSTEMCurrentControlSetControlCitrixwfshellTWI

If the CQI cannot be launched for published apps hosted on Desktop OS VDAs, find a solution in

Using the Connection Quality Indicator

The CQI launches on session startup and continues to run for the life of the session. It notifies the user of changes to network performance and status.

There are several types of notifications that a user can see while the tool is running:

Poor and Weak states:

Busy states:

Excellent state:

Idle state:

User interaction with CQI for published desktops and apps are similar, with the following exceptions:

When using a published desktop, CQI notifications are displayed in the notification area and as standard notifications.

For published apps, CQI notifications appear in the lower right corner of the apps. If more than one published app is in use within the same session, only the foreground app displays notifications.

The option panel, which you can access by clicking the filled, upward triangle symbol in the upper right corner of a CQI notification, can be used to snooze notifications for a predetermined amount of time. When you snooze a notification, the time you choose appears in green. You can also access the latest notification by using the hotkey combination Ctrl+Alt+H for published apps. Notifications you access this way remain visible until you dismiss them explicitly.

Option panel

Notification area

Notifications remain visible for a predefined interval when a degraded user experience is present for a prolonged period of time. Short-lived degraded user experiences, though detected by the tool, do not trigger notifications. This behavior is by design and prevents the tool from overnotifying users.

How CQI Uses Counters

The CQI uses counters to monitor the connection quality between an endpoint and the VDA. Each counter contains a low and a high threshold that the tool uses to determine which type of notification to display. The default values of the thresholds are defined in the <Installation folder>Configuration[MUIculture]CitrixCQI.adml file. The CQI shows the following counters in the “Real time data” section of the option panel.

• ICA RTT – Indicates the time that elapses between the moment you press a key and the moment the keypress becomes visible at the endpoint.

• ICA Latency – Indicates the time a data packet takes to get from the client-side Winstation Driver (WD) to the server-side WD and back.

Note: ICA RTT is different from network latency.

Network latency is the time a data packet takes to get from the source NIC to the destination NIC and back. Network latency contributes to ICA RTT, but ICA RTT is also affected by other factors such as application performance, system performance, printing activity, media rendering, and large file redirection.

ICA RTT affects user experience rather than network connection quality.

Session Metrics in Citrix.CQI.Data.csv

CQI collects metrics of all sessions and saves them to Citrix.CQI.Data.csv, which is present in the %SystemRoot%ServiceProfilesLocalServiceAppDataLocalTempCitrixCQILogsCSV folder.

Logging

The CQI uses two logging options - a plain text file maintained per user session, and a Windows Event log shared across all user sessions running on the VDA.

The plain text log file, Citrix.CQI.log, is stored in the %temp%CitrixCQI folder. The CQI also maintains a single archived log file, Citrix.CQI.{YYYY-MM-DD_HH-MM-SS}.0.log, in the same folder. The log file size limit is 5 MB.

The same logging information is written to the Windows Event log. There are two event log channels, Admin and Debug. To see the Debug channel, ensure that the “Show Analytic and Debug Logs” option is enabled.

The CQI logs can be found in the Application and Services LogsCitrixVDACQI folder within the Event Viewer:

Event logs combine messages from all user sessions on a VDA.

• The Admin channel contains only critical messages, errors, and warnings.

• The Debug channel contains additional information to the Admin channel..

Event log records are categorized by level and provided with separate IDs.

Notification

Event ID

Event Level

Strong Connection

1005

Information

Weak Connection

1006

Warning

Poor Connection

1007

Warning

Busy

1010

Warning

How to show more traces in Citrix.CQI.log

The CQI log file, Citrix.CQI.log, does not show all traces by default. To show more traces, find the Citrix.CQI.exe.config configuration file at C:Program Files (x86)CitrixConnection Quality Indicator and change the “LogToFileLevel” key value from 1 to 16. Only those traces whose priorities are lower than or equal to the configured key value can be output to Citrix.CQI.log.

Known Issues

Citrix Workspace Windows Download

The following table describes the various failure scenarios and the recommended corrective actions.

S/N

Failure Type

Description

Possible Corrective Action

1

Usability

The CQI cannot be accessed through hotkey combination when you roam a published app session from a Windows device to an iOS or Android device.

This is a known issue with the current version of the tool.

2

Usability

If notifications are snoozed in a published desktop, users are unaware of changes in states.

This is caused by Windows functionality. To display CQI notifications in the notification area, set the CQI icon and notification behavior to 'Show icon and notifications'

3

Usability

CQI counters are not updated when a session sits idle.

Counters are updated only when session activity is detected.

4

Usability

Minimizing, maximizing, or resizing a published desktop or app window can cause [MS1] the CQI notification UI to be left behind.

This is a known issue with the current version of the tool.

6

Usability

The CQI fails to start on a Windows device when you roam a published app session from an iOS or Android device.

Citrix provides a registry setting SoftwarePoliciesCitrixVirtualDesktopAgentCQIKeepSleepingInUnsupportedPlatform. The CQI keeps idle instead of exiting if the value is set to 1 with the type of DWORD so that the CQI can continue to serve when roaming to a Windows device. The setting is not available in the .admx and .adml group policy files.

7

Usability

The CQI notification UI overlaps the taskbar when you move the taskbar from one side of the screen to another while a notification is being displayed or has been opened manually.

This is a known issue with the current version of the tool.

8

Usability

If the CQI notification UI is visible and the published app is moved around the screen, the CQI notification UI does not follow.

This is a known issue with the current version of the tool.

9

Counters

When using the option panel, a CQI counter is color coded orange or red but the notification is still showing green.

This is by design to prevent overnotifying users. The CQI does not notify users right away of a change in network status. Instead, it waits to see if the change is prolonged before triggering a notification.

10

Counters

The ICA RTT counter does not update on Android and iOS devices.

This is a known issue with the current version of the tool.

11

Installation

When you repair a CQI installation, related registry entries are not updated by the installer.

This is a known issue with the current version of the tool.

12

Display

On 4K monitors, the CQI notification UI might overlap the taskbar.

This is a known issue with the current version of the tool.

13

Usability

Multiple Citrix component folders are present under Administrative Templates in the Group Policy editor.

This issue happens on systems where Citrix Receiver for Windows 4.5 or earlier is installed. To resolve this issue, upgrade to the latest version of Citrix Receiver or Citrix Workspace app.

Contact Information

Questions? Concerns? Comments? Send feedback to https://podio.com/webforms/17047561/1146185.

Disclaimer

Citrix Workspace Sccm

These software applications are provided to you as is with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.