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 to allow Citrix Analytics to begin processing data for this data source.

Linked data source

After you have enabled data processing, the site card might display the No data received status. This happens when the events take some time to reach the event hub in Citrix Analytics. When Citrix Analytics receives the events, the status changes to Data processing on.

Note

If the status does not change after some time, refresh the Data Sources page.

The site card displays the number of Virtual Apps and Desktops users, discovered Sites, and the received events based on the selected time period- 1 hour (1H) or 1 week (1W). Click the number of users and Sites to view them. Click the number of received events to view the events on corresponding the self-service search page. For more information, see Self-Service search for Virtual Apps and Desktops.

Linked data source

If no events are received for the last one hour, the Data processing on status changes to No data received. Although there might be some events received for the last one week.

No data CVAD

Turn on or 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

Use one of the following methods to onboard your on-premises Virtual Apps and Desktops Sites to Citrix Analytics:

Prerequisites

Before you begin the onboarding, ensure that you meet the System Requirements and the following 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. If you want to use Citrix Workspace to add your Sites, you need to have a 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. 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.

  • StoreFront version. If you are using a StoreFront deployment for your Sites, ensure that the StoreFront version is 1906 or later.

  • 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 an agent on a Delivery Controller in your on-premises Site. This agent enables your Site to communicate with Citrix Analytics on port 443 (HTTPS).

    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.

Onboard Virtual Apps and Desktops Sites using Workspace

If your Virtual Apps and Desktops Site is added to Workspace, Citrix Analytics automatically discovers the Site. Then, you need to enable Analytics on the Site. For using the Actions feature of Citrix Analytics, you have to install and configure an agent on the Delivery Controller.

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.

    Note

    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 view 0 discovered sites on the site card. For more information, see 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 the Workspace.

  3. You get a success message when Analytics is successfully enabled on all your Sites.

    Enable Analytics Success

After you have enabled data processing, the site card might display the No data received status. This happens when the events take some time to reach the event hub in Citrix Analytics. When Citrix Analytics receives the events, the status changes to Data processing on.

Note

If the status does not change after some time, refresh the Data Sources page.

The site card displays the number of users, discovered Sites, and the received events based on the selected time period- 1 hour (1H) or 1 week (1W). Click the number of users and Sites to view them. Click the number of received events to view the events on corresponding the self-service search page. For more information, see Self-Service search for Virtual Apps and Desktops.

If no events are received for the last one hour, the Data processing on status changes to No data received. Although there might be some events received for the last one week.

No data CVAD

Configure an agent to use the action feature

To use the actions feature of Citrix Analytics on your Site, you have to install and configure an agent on the Delivery Controller.

  1. Click either the Sites or Configuration incomplete labels on the site card to view to the Discovered Sites page to install the agent.

    Continue setup

  2. Click the Site that is not yet configured. The Configuration incomplete label is shown for the Site. For high availability and reliability, Citrix recommends that you install multiple agents in each Site.

    Discovered agent

  3. Click Install and Configure Agent. The Install and Configure Agent wizard appears.

    Install Agent

  4. Click Download Agent and save the agent package. Install the 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

  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.

    Controller Credential

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

    Provide Director URL

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

    Review Summary

The Citrix Virtual Apps and Desktops Site setup is completed successfully.

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.

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

Onboard Virtual Apps and Desktops Sites using StoreFront

StoreFront aggregates applications and desktops from Citrix Virtual Apps and Desktops Sites into a single store for users. Users access the desktops and applications available on the store using Citrix Workspace app on their devices and endpoints. If your organization uses an on-premises StoreFront deployment, you can configure your StoreFront servers to enable Citrix Workspace app to send user events to Citrix Analytics. The user events are processed by Citrix Analytics to provide actionable insights into user behaviors. For more information on how to configure a StoreFront deployment, see Citrix Analytics service in the StoreFront documentation.

Prerequisites

Before you begin, ensure the following:

  • Your StoreFront deployment must be StoreFront 1906 or later.

  • The StoreFront deployment must be able to connect to the following address:

  • The StoreFront deployment must have port 443 open for outbound internet connections. Any proxy servers on the network must allow this communication with Citrix Analytics.

  • The StoreFront deployment must be accessed using one of the following clients:

    • Citrix Receiver for Web sites in HTML5-compatible browsers.

    • Citrix Workspace app 1903 for Windows or later.

    • Citrix Workspace app 1901 for Linux or later.

Connect to a StoreFront deployment

  1. On the Virtual Apps and Desktops site card, click the vertical ellipsis (⋮) and then select Connect StoreFront deployment.

    Connect stores

  2. On the Connect StoreFront Deployment page, click Download File to download the StoreFrontConfigurationFile.json file.

    Note

    The file contains sensitive information. Keep the file in a safe and secure location.

    Download config file

  3. Copy the file to your StoreFront deployment. If you are using multi server deployment, copy the file to a server in the StoreFront server group.

  4. On the StoreFront server, open the PowerShell ISE and run the following command to import the configuration settings.

    Import-STFCasConfiguration -Path “configuration file path"

    For example, if the StoreFrontConfigurationFile.json file is on the desktop, specify the command as follows:

    Import-STFCasConfiguration –Path “$Env:UserProfile\Desktop\ StoreFrontConfigurationFile.json”

  5. Run the following command to verify the imported configuration settings.

    Get-STFCasConfiguration

  6. If you are using multi server deployment, you must propagate the configuration settings to all the servers in the server group. Use either StoreFront management console or run the following command to propagate the settings.

    Publish-STFServerGroupConfiguration

  7. After configuration is successful, log back to Citrix Analytics to view the connected StoreFront deployment. Click Turn On Data Processing to allow Citrix Analytics to process the data.

After you have enabled data processing, the site card might display the No data received status. This happens when the events take some time to reach the event hub in Citrix Analytics. When Citrix Analytics receives the events, the status changes to Data processing on.

Note

If the status does not change after some time, refresh the Data Sources page.

The site card displays the number of connected StoreFront deployments and the received events based on the selected time period- 1 hour (1H) or 1 week (1W). Click the number of received events to view the events on corresponding the self-service search page. For more information, see Self-Service search for Virtual Apps and Desktops.

If no events are received for the last one hour, the Data processing on status changes to No data received. Although there might be some events received for the last one week.

No data CVAD

View connected StoreFront deployments

The StoreFront deployments appear on Virtual Apps and Desktops site card only if the configuration is successful. The site card shows how many StoreFront deployments have established connections with Citrix Analytics.

View stores

Click the number of StoreFront deployments on the site card to view the server groups. For example, click 1 StoreFront deployments to view the connected server or server groups. Each StoreFront deployment is represented by a base URL and a ServerGroupID.

StoreFront group

Add or remove StoreFront deployments

To add a StoreFront deployment, click Connect to StoreFront Deployments on the Virtual Apps and Desktop page. Download the configuration file and follow the steps to configure a StoreFront deployment.

Add stores

To stop the event transmission from a configured StoreFront deployment and remove it from Citrix Analytics:

  1. Go to the StoreFront deployment that you want to remove from Citrix Analytics. Run the following command to remove the configuration settings from your StoreFront server.

    Remove-STFCasConfiguration

  2. If you are using multi server deployment, run the following command to propagate the changes and remove the configuration settings from all the servers in the StoreFront server group.

    Publish-STFServerGroupConfiguration

  3. Run the following command to verify that the configuration settings have been successfully removed. The command returns nothing if the settings have been successfully removed.

    Get-STFCasConfiguration

  4. Log back to Citrix Analytics and choose the StoreFront deployment on the Virtual Apps and Desktop page. Click the vertical ellipsis (⋮) and select Remove StoreFront deployments from Analytics.

    Remove store

    Note

    You must run the specified commands on the StoreFront deployment before removing it from Citrix Analytics. If you fail to run the commands, Citrix Analytics continues to receive the events and the StoreFront deployment is added again at the next event pooling cycle.

Turn on or 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