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.

Citrix Analytics automatically discovers Virtual Apps and Desktops data sources associated with your Citrix Cloud account. To view the data sources, do one of the following:

  • Click Get Started on the Analytics Welcome page.

  • Click Settings > Data Sources.

A site card appears on the Data Sources page. Click Turn On Data Processing 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

The status of the Virtual Apps and Desktops data source on the site card changes to Data Processing On. The site card displays the number of Virtual Apps and Desktops users, Sites, and the received events.

Linked data source

Turn on or turn off data processing

To stop data processing, click the vertical ellipsis (⋮) on the site card and then click Turn off data processing. Citrix Analytics stops processing data for this data source.

Linked data source

To enable data processing again, click Turn On Data Processing.

Linked data source

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 the Citrix Smart Tools agent on the Delivery Controller. However, if your Site is connected to the Smart Tools service using the Citrix Smart Tools agent, you do not 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 currently.

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

  • Sites 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 Citrix Smart Tools 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 do not need 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 and displays on the site card.

    Linked data source

    Click the number of sites displayed on the site card to view the discovered Sites.

    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. You can see 0 discovered sites on the site card. For more information, see How to add a Site.

  2. To allow Citrix Analytics to begin processing data for the Sites, click Turn On Data Processing on the Site card and follow the prompts on the screen.

    If you have multiple Sites added to the same workspace, Citrix Analytics processes and stores data for all the Sites in that workspace.

    You 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. To be able to take action on the risk indicators, you must configure Citrix Smart Tools agent 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 the Citrix Smart Tools agent on the Delivery Controller. Click either the Sites or Configuration incomplete labels on the site card to view to the Discovered Sites page to install the agents.

    Continue setup

  4. Click the site for which you want to configure agent. For high availability and reliability, Citrix recommends that you install multiple agents in each Site.

    Discovered agent

  5. Click Install and Configure Agent.

    Install Agent

    The Install and Configure Agent wizard appears.

    Note: If your Site is connected to the Smart Tools service using the Citrix Smart Tools agent, you do not have to install this agent again. Clicking Connect to Installed Agent prompts you to enter the Site administrator credential details similar to step 8 below.

  6. If your Site is not connected to the Smart Tool service, click Download Agent. When prompted, save the agent package. Install the Citrix Smart Tools agent on one of the Delivery Controllers in your Site.

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

    Download Agent

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

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

    Controller Credential

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

    Provide Director URL

  10. Review the configuration summary, verify that your Site is available for Citrix Analytics, and 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.

Turn on or turn off data processing

To stop data processing, click the vertical ellipsis (⋮) on the site card and then click Turn off data processing. Citrix Analytics stops processing data for this data source.

Linked data source

To enable data processing again, click Turn On Data Processing.

Linked data source

How to add a Site?

  • If you have not added any Site to Citrix Workspace, the Site Card displays 0 discovered sites. To add a Site, do the following:

    1. Click + on the site card.

      Data Source

    2. On the Workspace Configuration page, click +Add Site.

      Workspace

    3. Follow the instructions as mentioned in Add an on-premises Site to Citrix Workspace.

  • Or if you want to add multiple Sites, do the following:

    1. On the Site card, click the number of Sites to view the Discovered Sites page.

      Site selection

    2. On the Discovered Sites page, click + Add more Virtual Apps and Desktops Sites to Workspace.

      Multiple sites

    3. On the Workspace Configuration page, click +Add Site.

      Workspace

    4. Follow the instructions as mentioned in Add an on-premises Site to Citrix Workspace.

Citrix Virtual Apps and Desktops data source