Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0 12.1
View PDF

Data governance (For NetScaler ADM 14.1 4.42 or earlier builds)

February 9, 2024
Contributed by: 
R C

If your NetScaler ADM is 14.1 4.x or lower version, you can create a Customer Identity on Citrix Cloud to send important statistics about ADM health, status, and other metrics from on-prem deployment to Citrix Cloud account. Citrix collects statistics to understand the usage of NetScaler ADM.

  • Create a customer identity on Citrix Cloud - To send important statistics about ADM health, status, and other metrics from ADM on-prem deployment to Citrix Cloud account.

    After you create a customer identity, the “Cloud Connect” establishes the connection between ADM on-prem and NetScaler Console service by creating a Citrix Cloud account. See, Configure customer identity.

  • Configure maintenance scripts - To optimize the database. The database optimization might create tables, alter columns, and more. The same “Cloud Connect” feature is used to configure maintenance scripts. See Database optimization using maintenance scripts.

  • Customer User Experience Improvement Program (CUXIP) - This program is enabled by default. It collects the usage-data from NetScaler ADM. This data allows optimizing the ADM experience through guided workflows, search articles, product notifications, feedback, surveys, and so on. See, Customer User Experience Improvement Program.

Configure customer identity

NetScaler Console requires that you authenticate yourself on the ADM GUI before you begin accessing the information. It is a requirement that you must register yourself on Citrix Cloud services before you authenticate yourself on ADM. Provide the Citrix Cloud user credentials on the ADM GUI. For more information, see Sign up for Citrix Cloud.

There are different ways to authenticate yourself on NetScaler ADM. The following sections describe the workflows if you are a new user or an existing user on ADM.

Workflow 1 - If you are a new user

  1. Complete the installation of NetScaler ADM on the selected hypervisor.

  2. Configure the various required IP addresses.

  3. In a web browser, type the IP address of the NetScaler ADM.

  4. In the User Name and Password fields, enter the administrator credentials.

    The Configure Customer Identity page opens where you must identify yourself with your Citrix Cloud credentials.

    If you haven’t created an account on Citrix Cloud, click Citrix Cloud to register.

  5. Click Authenticate and provide your email address which you have used to register on Citrix Cloud.

  6. Select the checkbox next to I agree to share data for telemetry and click Submit.

Workflow 2 - if you are an existing user upgrading to the latest ADM version

  1. After upgrading NetScaler ADM to the latest version, in a web browser, type the IP address of the NetScaler ADM.

  2. In the User Name and Password fields, enter the administrator credentials.

  3. The Configure Customer Identity page opens where you must identify yourself with your Citrix Cloud credentials.

    If you haven’t created an account on Citrix Cloud, click Citrix Cloud to register.

  4. Click Authenticate and provide your email address which you have used to register on Citrix Cloud.

  5. Select the checkbox next to “I agree to share data for telemetry” and click Submit.

As an existing user, you can also configure your identity on ADM later in one of the following two ways:

  • Navigate to Settings > System Administration, and click Authentication.
  • Click the cloud symbol at the top right side of the ADM GUI. After successful authentication, the X turns into a green colored check mark.

Note

Ensure that the following domains are whitelisted:

  • *.citrixnetworkapi.net
  • *.blob.core.windows.net

By uploading your data to NetScaler ADM and using NetScaler ADM features, you agree and consent that Citrix may collect, store, transmit, maintain, process and use technical, user, or related information about your NetScaler products and services.

Information received by Citrix is always treated in accordance with Citrix.com Privacy Policy.

Diagnostics and data collection

NetScaler ADM collects the following telemetry using customer identity:

  • Actions performed in ADM:
    • Actions performed using the NetScaler ADM UI/API interface.
    • Actions performed using the NetScaler ADM SDK interface.
    • Count of operations in a single day. This count includes any Non-GET request from API or UI.
    • Count of NetScaler upgrades done by ADM.

  • NetScaler ADM license information: Count of entitled virtual servers.

  • Key statistics:
    • Total count of event rules.
    • Total count of and user defined StyleBooks.
    • Count of managed and custom applications.
    • Count of registered agents.
    • Overall throughput across the NetScaler (Rx+Tx).
    • Count of managed instances. This count also includes admin partitions.
    • Count of admins using NetScaler ADM SaaS.

  • Geo-location of NetScaler ADM

  • Deployment information: This information includes deployment types such as high-availability, disaster recovery, and ADM agents.

Why data is collected?

The collected telemetry data helps to:

  • Recommend correct NetScaler ADM sizing and deployment.
  • Proactively troubleshoot issues on ADM on-prem deployments.

Who can use this data?

Citrix is the sole owner of the information collected. Citrix has access to/collect information that you voluntarily give us. We do not sell or rent this information to anyone. We do not share your information with any third party outside of our organization, other than as necessary to fulfill your request. Example: To ship an order or to proactively resolve issues.

How long we keep your data?

Typically, we store Personal/Usage data until the user is using our Services. Or, we have another purpose to do so. Afterwards, the data is no longer stored than it is required or permitted by law or necessary for internal reporting and reconciliation purposes.

All telemetry data is stored for a period no longer than 13 months or 396 days.

Database optimization using maintenance scripts

Maintenance scripts are used to resolve database-related issues on ADM on-premises deployments. The ADM software automatically downloads the database maintenance scripts from ADM service, providing faster resolution for database related issues. Earlier, these issues were resolved by manually running the scripts.

With this feature, ADM on-prem deployment periodically downloads the database maintenance scripts from ADM Service. To do so, ensure to configure customer identity.

Maintenance scripts run daily and weekly. Also, the scripts might create tables or add or remove columns to improve database performance.

Customer User Experience Improvement Program

At Citrix Systems, our aim is to provide our users with an engaging product experience. Customer User Experience Improvement Program (CUXIP) uses Pendo to guide users through some common, yet detailed tasks by giving search articles, in-app guides and so on. We also help our users remain abreast of all the recent announcements.

What usage-data is collected over CUXIP?

Usage-data is all about user actions. Also called event-level data, usage data includes everything from the pages our users visit on a website to the number of clicks a certain feature. Usage-data is valuable information about how users move in our applications. This data allows optimizing our user’s experience.

The following are some of the usage-data we collect:

  • Details of page views, time spent on every page.

  • Visitor id is a unique anonymized identifier to help identify the number of unique visitors on a page.

  • Survey statistics – score, views, number of submissions and so on.

How CUXIP helps you?

We use usage-data to improve your experience with ADM. The following are some of the ways in which we intend to enhance customer user experience:

  • In-app guided workflows and ability to search relevant articles.
  • Participate in a survey from within the app to help improve the product.
  • Stay informed about recent announcements and other notifications.
  • Post a question or feedback to the product team.

How CUXIP works?

The NetScaler ADM appliance can be in the internal network. The browser must have internet connectivity to get the benefits of the guided assistance on CUXIP.

How can I disable CUXIP on my ADM?

To disable CUXIP, do the following in the ADM GUI:

  1. Navigate to Settings > System Administration.
  2. In CUXIP Settings, and disable CUXIP.

Changes to our Privacy Policy

We may update our Privacy Policy from time to time. We will notify you of the changes by posting the new Privacy Policy on this page. We will let you know via email and/or a prominent notice on our Service, prior to the change becoming effective and update the “effective date” at the top of this Privacy Policy.

You are advised to review this Privacy Policy periodically for any changes. Changes to this Privacy Policy are effective when they are posted on Citrix Privacy policy page.

References

Citrix Privacy Policy: https://www.citrix.com/about/legal/privacy/

Data governance (For NetScaler ADM 14.1 4.42 or earlier builds)
February 9, 2024
Contributed by: 
R C
February 9, 2024
Contributed by: 
R C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.