Citrix Virtual Apps and Desktops data source

This article describes the steps to connect your on-premises Citrix Virtual Apps and Desktops sites to Citrix Analytics using StoreFront. The onboarding steps mentioned in this article are applicable for both the offerings: Citrix Analytics for Performance (Performance Analytics) and Citrix Analytics for Security (Security Analytics).

For the onboarding steps specific to each offering, see the following articles:

Onboard Citrix Virtual Apps and Desktops on-premises sites using StoreFront

If your organization uses an on-premises StoreFront deployment, you must configure your StoreFront servers to enable Citrix Workspace app to send events to Citrix Analytics. The events are processed by Citrix Analytics to provide actionable insights into the performance of your Citrix IT infrastructure and your users’ behavior.

For more information on how to configure a StoreFront deployment for Citrix Analytics, see the Citrix Analytics service article in the StoreFront documentation.

Prerequisites

Before you begin, ensure the following:

  • Your StoreFront version must be 1906 or later.

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

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

  • If the StoreFront deployment is hosted on a webserver that uses a web proxy to connect to the internet, the proxy for each store must be manually configured to allow outbound traffic. StoreFront does not automatically use the proxy setting of the host webserver. For more information, see Configure a StoreFront deployment hosted on a webserver that uses HTTP proxy.

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

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

      Note

      If you are an HTML5 user, Citrix Virtual Apps and Desktops can launch events when certain configurations are enabled on StoreFront. For information about the configuration steps, see the Install article in the Citrix Workspace app for HTML5 documentation. For print-related events, extra policies must be configured on StoreFront. For more information, see the PDF Printing article in the Citrix Workspace app for HTML5 documentation.

    • Citrix Workspace app 1907 for Windows or later.

    • Citrix Workspace app 2006 for Linux or later.

    • Citrix Workspace app 2006 for Mac or later

  • If you are using Citrix Virtual Apps and Desktops 7 1912 LTSR, the supported StoreFront version is 1912.

Connect to a StoreFront deployment

  1. If you are using the Security Analytics offering, select Settings > Data Sources > Security.

    • On the Apps and Desktops- Workspace app site card, click the vertical ellipsis (⋮) and then select Connect StoreFront deployment.

      Connect stores security

      Note

      The Connect StoreFront deployment option is disabled if you do not have a site already discovered by Analytics. Add your on-premises sites to Workspace to enable this option.

  2. If you are using the Performance Analytics offering, select Settings > Data Sources > Performance.

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

      Connect stores performance

  3. On the Connect StoreFront Deployment page, review the checklist and select all the mandatory requirements. If you do not select a mandatory requirement, the Download File option is disabled.

    StoreFront-checklist

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

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

  6. 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"
    
  7. Run the following command to verify the imported configuration settings:

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

    Publish-STFServerGroupConfiguration
    
  9. After configuration is successful, go to Citrix Analytics to view the connected StoreFront deployment. Click Turn On Data Processing to allow Citrix Analytics to process the data.

After configuring your StoreFront deployment, if you don’t see the StoreFront servers on Citrix Analytics, perform the troubleshooting steps to identify and resolve the issue.

View connected StoreFront deployments

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

  • If you are using the Performance Analytics offering, you see the following information on the Apps and Desktops- Monitoring site card:

    Performance Analytics View store

  • If you are using the Security Analytics offering, you see the following information on the Workspace app site card:

    View stores

Click the number of StoreFront deployments on the site card to view the server groups.

Each StoreFront deployment is represented by a base URL and a ServerGroupID.

StoreFront group

If you are using the Security Analytics offering, the site card also displays the following information about the received events:

  • The events received from the StoreFront deployments for the last one hour, which is the default time selection. You can also select 1 week (1 W) and view the data. Click the number of received events to view the events on the self-service search page.

    Security Analytics received events

  • After you have enabled data processing, the site card might display the No data received status. This status appears for two reasons:

    1. If you have turned on data processing for the first time, 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. If the status does not change after some time, refresh the Data Sources page.

    2. Citrix Analytics has not received any events from the data source in the last one hour.

      No data virtual apps

Watch the onboarding video

The following video shows the steps to configure a StoreFront deployment:

Add or remove StoreFront deployments

To add a StoreFront deployment, click Connect to StoreFront Deployments on the StoreFront deployments section. 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 StoreFront deployments section. Click the vertical ellipsis (⋮) and select Remove StoreFront deployments from Analytics.

    Remove store

    Note

    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.

Configure a StoreFront deployment hosted on a webserver that uses HTTP proxy

If a StoreFront is hosted on a webserver that uses a web proxy to connect to the internet, the store must be manually configured to register with Citrix Analytics. This configuration requires you to add a <system.net> section to the store web.config file. You must configure every store on the StoreFront deployment that sends events to Citrix Analytics.

There are two methods by which you can add the <system.net> section to the store web.config file:

  • Set the store proxy configuration via PowerShell for one or more stores (recommended method).

  • Manually add a <system.net> section to the store web.config file.

For more information on these methods, see the Configure StoreFront to use a web proxy to contact Citrix Cloud and register with Citrix Analytics article in the StoreFront documentation.