Product Documentation

Citrix Virtual Apps and Desktops data source

Citrix Virtual Apps and Desktops is available in two offerings: service and perpetual or on-premises. Citrix Analytics supports both and discovers these data sources automatically. This article walks you through the prerequisites and the procedures to enable Analytics on both the offerings.

Enable Analytics on Virtual Apps and Desktops service

You must subscribe to Citrix Virtual Apps and Desktops service offered on Citrix Cloud. To learn how to get started with Virtual Apps and Desktops service, see Install and configure.

Before you begin onboarding the Virtual Apps and Desktops service to Citrix Analytics, review the System Requirements section, and ensure that you have completed the required tasks.

When you click Get Started on the Analytics Welcome page or navigate to Settings > Data Sources, Citrix Analytics automatically discovers Virtual Apps and Desktops data source associated with your Citrix Cloud account.

A site card appears on the Data Sources page. Click Enable Analytics and follow the prompts to allow Citrix Analytics to begin processing data for this data source. You can now start viewing processed data on the Analytics dashboards.

Linked data source

Note: The Enable Analytics button is displayed only when the data source is discovered for the first time. However, you can turn on or off data processing anytime you want.

The status of the Virtual Apps and Desktops data source on the site card changes to Data Processing On.

Linked data source

Turn on or turn off data processing

To turn off data processing, flip the site card and click Turn off data processing. This stops Citrix Analytics from processing data for this data source.

You can turn on data processing again by flipping the site card and clicking Turn on data processing.

Enable Analytics on Virtual Apps and Desktops Sites

If your Virtual Apps and Desktops Site is added to Workspace, Citrix Analytics automatically discovers the Site. You have to, then, enable Analytics on the Site. For advanced features such as Actions, you have to install and configure an agent on the Delivery Controller. However, if your Site is connected to the Smart Tools service using the Citrix Smart Tools agent, you won’t have to install this agent again from Citrix Analytics.

Before you begin onboarding the on-premises Virtual Apps and Desktops Sites to Citrix Analytics, review the System Requirements and Prerequisites sections, and ensure that you have completed the required tasks.

Prerequisites

  • Delivery Controller version 7.16 and later

  • Director version 7.16 and later

  • Receiver for Windows version 4.11 and 4.12

  • Citrix Workspace app 1808 and 1809 for Windows

  • Receiver for Mac version 12.9.1

  • Citrix Workspace app 1808 and 1809 for Mac

    Note: Citrix Workspace app for Mac is supported on Virtual Apps and Desktops through only account logon. Hence, access from new device risk indicator is only supported at this time.

  • Citrix Workspace app 1809 for HTML5

  • Citrix Workspace app 1809 for Chrome

  • Citrix Workspace app 1809 for Android

    Note: Citrix Workspace app for Android does not support the App.Start and the App.End events. Hence, Unusual App Usage indicator is not supported.

  • Subscription to Citrix Workspace. You must have a Citrix Workspace subscription. Citrix Workspace is included with new subscriptions of Virtual Apps and Desktops after December 2017, as either a trial or as a purchased service.

    Note that Virtual Apps and Desktops Essentials is not supported on Citrix Analytics.

    To purchase a Citrix Workspace subscription, visit https://www.citrix.com/products/citrix-workspace/get-started.html and contact a Citrix Workspace expert who can help you.

  • Site(s) added to Workspace. Citrix Analytics automatically discovers the Sites added to Citrix Workspace. You must add your Sites to Citrix Workspace before proceeding with onboarding on Citrix Analytics. This process is known as Site aggregation.

    Site aggregation requires you to install Cloud Connector, configure NetScaler Gateway STA servers for internal and external connectivity to Workspace resources, and then add the Sites to Workspace. For detailed instructions on Site aggregation, see Add an on-premises Site to Citrix Workspace

    • Site credentials for Citrix Analytics. While configuring your Site for the Actions feature of Citrix Analytics, you have to provide the Citrix administrator credentials for your on-premises Site. These credentials should have the following permissions:

      1. Citrix administrator role: Full Administrator

      2. Active Directory: Domain Users

  • Server URL for Citrix Director. Using this information, Citrix Analytics accesses the real-time data available to provide in-depth analysis of user behavior in your Site.

  • Delivery Controller. During the process of configuring your Site for advanced Citrix Analytics features such as Actions, you have to install the Virtual Apps and Desktops agent on a Delivery Controller in your on-premises Site. This agent enables your Site to communicate with Citrix Analytics on port 443 (HTTPS).

    Note: If your Site is connected to the Smart Tools service using the Citrix Smart Tools agent, you won’t have to install this agent again.

    Ensure that the Delivery Controller hosting the agent meets the following requirements:

    • Supports PowerShell 3.0 or later.

    • Outbound connections on TCP port 443 (HTTPS) are allowed.

  • Launch applications through only native receiver. After you have added sites to Citrix Workspace, you must use the native receiver client to access the Workspace URL and launch the applications. Citrix Analytics collects data only when applications are launched through the native receiver client.

Configuration steps

Ensure that you have reviewed the System Requirements and Prerequisites sections before you proceed with enabling Analytics on Virtual Apps and Desktops Sites.

  1. When you click Get Started on the Analytics Welcome page or navigate to Settings > Data Sources, Citrix Analytics automatically discovers Virtual Apps and Desktops Sites that are added to Workspace.

    Site cards corresponding to your Sites appear on the Data Sources page. Each Site is represented as an individual card.

    Important: If you are not subscribed to Citrix Workspace and do not have your on-premises Sites added to Citrix Workspace, Citrix Analytics cannot discover and process data from your Sites. Review the Prerequisites section for details.

    Data Source

  2. To allow Citrix Analytics to begin processing data for the Sites, click Enable Analytics on a Site card and follow the prompts on the screen.

    If you have multiple Sites added to the same workspace, clicking Enable Analytics on any one of the Site cards lets Citrix Analytics process and store data for all the Sites in that workspace.

    You should see a success message when Analytics is successfully enabled on all your Sites.

    Enable Analytics Success

    Citrix Analytics now begins processing and storing data for all your Sites.

    You can view the user risk scores and the risk indicators on the dashboards. However, to be able to take action on the risk indicators, you have to configure agents on the Delivery Controller as shown in the next steps.

  3. To use the Actions feature of Citrix Analytics, you have to install and configure agents on the Delivery Controller. Flip the Site card and click Continue setup.

    Continue setup

    You have to do this individually for each Site. For high availability and reliability, Citrix recommends that you install multiple agents in each Site.

    The Configure <SiteName> to Use the Actions Feature of Citrix Analytics wizard appears.

    Note: If your Site is connected to the Smart Tools service using the Citrix Smart Tools agent, you won’t have to install this agent again. Clicking Continue setup will prompt you to enter the Site administrator credential details similar to step 6 below.

  4. Click Download Agent. When prompted, save the agent package. Install the agent on one of the Delivery Controllers in your Site.

    Note: Make sure your browser settings are configured to not block pop-up windows, else the agent might not download to your system.

    Download Agent

  5. After the installation finishes, click Connect to Installed Agent. The agent registers your Site with Citrix Analytics. This process might take a few minutes.

  6. Enter the user name and password for your Site administrator account and then click Next. Citrix Analytics verifies your entries.

    Delivery Controller Credentials

  7. Enter your Site’s Director URL and click Next.

    Provide Director URL

  8. Review the configuration summary and verify that your Site is available for Citrix Analytics and that the Analytics agent is online. Click Done to close the wizard.

    Review Summary

The Citrix Virtual Apps and Desktops Site setup is completed successfully and the Data Sources page appears.

Manage Site card

You can view the Site details and turn off or turn on data processing anytime you want to. You can also remove a Site from Citrix Analytics if you do not want the Site to send data to Citrix Analytics.

Flip a Site card and do one of the following:

Flip site card

  • Turn off data processing for all Sites. This action stops Citrix Analytics from processing new data for your Citrix Virtual Apps and Desktops Sites added from the same workspace. For details about data retention policy, see Data governance.

    To turn on data processing again, on the Data Sources page, flip a Site card and click Turn on data processing. This will turn on data processing for all Sites added from the same workspace.

  • View Site details. You can view the details of the installed agent and the Delivery Controller where it is installed.

    View Site details

  • Remove from Citrix Analytics. After you remove the Site, Citrix Analytics stops collecting data from the Sites, but all the previously processed data is available for the duration of the retention period.

    You can rediscover this Site by clicking Discover More Data Sources on the Data Sources page. You do not have to reinstall the agent; however, you will have to configure the settings to reconnect to the Delivery Controller and Director.

Citrix Virtual Apps and Desktops data source