Citrix Licensing data collection programs

The following data collection programs are designed to improve your product experience, drive adoption, and gather basic licensing information:

Citrix handles your data in accordance with the terms of your contract with Citrix, and protects it as specified in the Citrix Services Security Exhibit available on the Citrix Trust Center.

For information about configuring a proxy server, see Configure a proxy server manually in the Get started article.

For information about command-line installation, see Use the Windows command line to install licensing.

Citrix Licensing Call Home

Call Home is voluntary. Call Home does a periodic collection of system and product configuration and usage data including user or device data. Providing this data and registering your License Server with Citrix Cloud helps you and Citrix to understand your license usage over time. This information is transmitted to Citrix once a day, based on the service start time.

Important

The Citrix Service Provider program requires Call Home. When the License Server detects Citrix Service Provider licenses, it enforces daily uploads.

If you want to register your License server with Citrix Cloud or remove your registration, see Register and remove registration with Citrix Cloud in Usage and statistics.

You can change your participation in the programs at any time by using the Citrix Licensing Manager. For more information, see “Share usage statistics” under Usage and statistics.

Data collected Description What we use it for
License usage data Information about the Citrix licenses installed on the License Server, including product ID, license type, quantity, user, and device data, in addition to license usage information. We use this data to drive adoption and helps you to understand your license usage over time.
License Server deployment and configuration data Information about the License Server and how it was deployed, including license server version, operating system version, and configuration states. We use this data to inform further development of Citrix products and to improve the customer experience.

For the list of Call Home data elements, see Citrix Licensing Call Home data elements.

Citrix Licensing Customer Experience Improvement Program

CEIP is voluntary. CEIP does a periodic collection of system and product configuration and non-identifiable usage data. Providing this data helps Citrix to improve customer experience. This information is transmitted to Citrix once a day, based on the service start time.

You can change your participation in the programs at any time by using the Citrix Licensing Manager. For more information, see “Share usage statistics” under Usage and statistics.

Data collected Description What we use it for
License usage data Information about the Citrix licenses installed on the License Server, including product ID, license type, and quantity, in addition to license usage information. We use this data to track how licenses are consumed and track customer population.
License Server deployment and configuration data Information about the License Server and how it was deployed, including license server version, operating system version, and configuration states. We use this data to inform further development of Citrix products and to improve the customer experience.

For the list of CEIP data elements, see Citrix Licensing CEIP data elements.

Citrix License Server Event data

The following table displays data that is collected from the License Server and used for the following:

  • Display information in customer facing dashboards
  • Provide alerts and notifications about license expiry, license renewals, and supplemental grace period.

This functionality is available only when the License Server is registered with the Citrix Cloud.

Data collected Description What we use it for
License usage data Information about the Citrix licenses installed on the License Server, including product ID, license type, and quantity, in addition to license usage information. We use this data to enable alerts and notification about license expiry, license renewals, etc.
License server system information Information about the license server (such as Hardware ID). We use this data to identify the License Server in the customer’s environment.

For information on how to enable or disable this functionality, see the Share usage statistics section.

Citrix Licensing Telemetry

Citrix Licensing Telemetry is required, and installing the License Server enables you to send this information to Citrix.

Data Collected Description What we use it for
License usage data Information about the Citrix licenses installed on the License Server, including product ID, license type, and quantity, user, and device data, in addition to license usage information. We use this data for our legitmate interests, including license compliance.
License server system information Information about the license server (such as Hardware ID) We use this data to identify the License Server in the customer’s environment.

For the list of Licensing Telemetry data elements, see Citrix Licensing Telemetry data elements.

Reporting options

The License Management Service uses product telemetry, built into the License Server, to electronically send data to Citrix periodically. The first upload occurs approximately five minutes after the License Server first starts, or restarts, and subsequent uploads occur once a day thereafter. The schedule resets if you reinstall the License Server. If an upload fails, another attempt is made in 24 hours until either the upload succeeds or the License Management Service is disabled.

You can opt for manually reporting this data by disabling the License Management Service. For more information, see Use the command line to enable or disable the License Management Service.

For information on manual upload, see CTX472950.

The upload_compliance*.zip files are retained in the License Server locally to enable manual upload of this Licensing Telemetry data.

These files are present at c:\Program Files (x86)\Citrix\Licensing\LS\resource\usage. You can save all the upload_compliance*.zip files into a single .zip file. You can upload this .zip file using the Citrix Insight Service (CIS).

After the upload is success, you can delete all upload_compliance*.zip files from the license server. Failure to delete the .zip files might result in the License Server running out of disk space.

Citrix Licensing Call Home data elements

Metadata fields

Field Description Example
ClientTool This field isn’t in use. Not applicable
UploadUser This field isn’t in use. Not applicable
UTCDate Report generation time in UTC format. 2022-10-10T06:11:14Z
Date Report generation time in local time format. 10/10/2022 02:11:14
Product Name of the upload. LicenseServerCompliance
ProductVersion The version of the upload. 2.0
ProductUTCDeployDate Denotes the time when the License Server is installed. 2022-08-16T00:00:00Z
SiteID This field isn’t in use. Not applicable
SiteName This field isn’t in use. Not applicable
Component This field isn’t in use. Not applicable

License Server feature usage data

Field Description Example
prod Product reporting V6.Licensing
DateSampleStartUTC Start time of the sample being collected. 1970-01-01T00:00:00Z
DateSampleStopUTC Latest sample time of license usage which ideally is the same as when the report was generated. The sample start isn’t specified because that varies between license types and therefore isn’t a global property. 1970-01-01T00:00:00Z
CLM-WSLUsage Count for individual API calls within Citrix Licensing Manager interface for Citrix Web Services for Licensing service. 10
POSH-WSLUsage Count for individual API calls within PowerShell interface for Citrix Web Services for Licensing service. 2
type Type of data. V6.WSLUsage
ver Version of the data. 1.0
LSVersion The version of the License Server. 11.17.2.0 build 40000

License Server and License Usage information

Field Description Example
License Server Information    
Feature    
GUID A unique identifier created during install and preserved during upgrades. This field is used to identify which uploads are from the same server. a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
DateSampleStopUTC This field is the latest sample time of license usage which ideally is the same as when the report was generated. The sample start is not specified because that varies between license types and therefore isn’t a global property. 2019-11-09T00:57:14Z
DateSampleStop The latest sample time of license usage which ideally is the same as when the report was generated. License Server local time. 11/8/2019 19:57
PortLACHTTP HTTP port that the License Administration Console is configured for. 0
PortLACHTTPS HTTPS port that the License Administration Console is configured for (0 for builds with Citrix Licensing Manager only). 8082
PortLACRedirect Administration Console HTTP to HTTPS port. The value can be either true or false. You can set the value to false only for builds with the Citrix Licensing Manager.  
PortLS Citrix Licensing Service (lmgrd.exe) port configuration. 27000
PortVD CITRIX vendor daemon (CITRIX.exe) port configuration. 7279
CustomerID The Customer ID received during the registration. citrix780933
OrgID The organization ID received during the registration. int1d91480f
PortWSL Citrix Web Services for Licensing port configuration. 8083
UDUseDomain If the value is 1, don’t strip the domain from the users name. (user@domain.com). If the value is 0, strip the domain from the users name. 1
OptFileNoLogStatus If the value is 0, log both checkins and checkouts. If the value is 0x1 bit set, checkins are not logged (no log in). If the value is 0x2 bit set, checkouts aren’t logged (no log out). 3
OptFileComplianceConfig This value can be “enabled” or “disabled”. enabled
UDUserNameCase The License Server configuration that denotes how the UserID case-folding is set for User/Device licensing. The values are: 0=nochange; 1=tolower; 2=toupper. 1
UDDeviceNameCase The License Server configuration that denotes how the DeviceID case-folding is set for User/Device licensing. The values are: 0=nochange; 1=tolower; 2=toupper 1
SARenewalCheckOption The values can be “Install”, “Notify”, or “Manual”. Notify
EncoreSamplingPeriod License usage sampling period in minutes. 15
EncoreRetentionTime Historical use data retention in days. 180
EncoreEnabled The option is either true or false. TRUE
SLSProxy The proxy chosen from various sources in the order of priority. (1) WinAutoURL using “citrix.com”. (2) WinIE = Internet Explorer settings which require the licensing service to run under a user account rather than local service. (3) WinDefault = The old method that relies on a setting in the windows registry. (4) SimpleLicenseServiceConfig.xml. If the upload is anonymous, this parameter value is either “1” or “0”. If diagnostic (not anonymous), this parameter is the proxy server string and port, or empty. 0
SLSProxyWinAutoURL If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinIE If the upload is anonymous, this field value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinDefault If the upload is anonymous, this field value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty.  
SLSProxySlsConfig If the upload is anonymous, this field value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty.  
OS Information about the server machine and operating system that the License Server is installed on. 6.3.9600.17031
WindowsBuildLabEx Information about the server machine and operating system that the License Server is installed on. 9600.17041.x86fre.winblue_gdr.140305-1710
WindowsEditionID Information about the server machine and operating system that the License Server is installed on. Enterprise
WindowsInstallationType Information about the server machine and operating system that the License Server is installed on. Client
WindowsProductName Information about the server machine and operating system that the License Server is installed on. Windows 8.1 Enterprise
WindowsDomainMember Information about the server machine and operating system that the License Server is installed on. N
OSBits Information about the server machine and operating system that the License Server is installed on. 32
OSLocale Information about the server machine and operating system that the License Server is installed on. en-US
VM Information about the server machine and operating system that the License Server is installed on. Y
VMIDString Information about the server machine and operating system that the License Server is installed on. Microsoft Hv
VMHVIDString Information about the server machine and operating system that the License Server is installed on. Hv#1
HardwareId Information about the server machine and operating system that the License Server is installed on. E824249098A96BF0
FQDN License server machine and domain name. This value is sent to help identify license servers in the reporting experience. Used to pair a license server calling home to a license allocation record in the back office. CITRIX-12T5MRV4
PrivacySetting Denotes if the customer has chosen to scramble PII (user names and device names). On: Scrambled and Off: Unscrambled Off
InstallUTC This value denotes the time when the License Server is installed. 2016-10-12T00:00:00Z
ProductVersion The current version of the License Server. 11.14.0.1 build 18000
UpgradeFrom The previous version of the License Server if the current install was an upgrade.  
SetupCluster Indicates whether a License Server cluster is set up or not. 0
SGPClockErrorCode Error code indicating why the License Server entered the supplemental grace period. 0
SGPMaxDays Maximum days remaining in the Supplemental Grace Period. 15
SupplementalGracePeriod Grace Periods that Citrix provides when you run out of licenses or the product is unable to contact the License Server. This grace period helps the product continues to operate.  
Feature    
FeatureID The tag of the feature.  
UDBinFileCreatedUTC User/Device Only – not applicable for Concurrent usage 2016-11-09T00:55:56Z
UDReportGenerationUTC User/Device Only – not applicable for Concurrent usage 2016-11-09T00:55:56Z
EventLog User/Device Only – not applicable for Concurrent usage <FirstCreation t=”timestamp”/>
UDAdminUsersReleased Count of users released by udadmin. 3
UDAdminDevicesReleased Count of devices released by udadmin. 3
SADate    
DateSampleStartUTC Start time of the sample being collected. 2016-11-08T01:08:13Z
DateSampleStopUTC End time of the sample being collected. 2016-11-09T00:55:56Z
CountUsedMax The maximum number of licenses used. 3
Active If the value is ‘1’, it’s in the current inventory. If the value is ‘0’, it appears only in historical records and is no longer part of the current inventory either because it is removed or expired. 1
Licensees    
CountInstalled The number of licenses installed. 1203
Pool    
CountTotal The total number of licenses in use at the time the sample was taken. Total number is the sum of users and devices. 3
Users Specific users where a user license is assigned, contributing to the total count. Scrambled: 1EC4ED037766AA18, Unscrambled: user@domain.com or user
Devices Specific devices where a device license is assigned contributing to the total count. Scrambled: C648FE671A44B3F7 Unscrambled: C39A925064A3
Usage Samples    
Serial Serial number for the license entitlements in the pool. OR10:13
DateExpiration Most recent expiration date that impacts the license count in the pool. 1-Dec-20
DateIssued The date that the license file was issued. The date issued of the license file that expires first. 1-Dec-03
VendorStr Representation of licensing information that informs products of what edition and mode that they must operate in. <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>
CountInstalled Number of licenses installed among the pools for a given feature. 100
CountOverdraft Number of licenses used above the installed quantity. 0
Sample    
Timestamp Timestamp of the sample collection. 2016-11-09T00:55:56Z
CountInUse Number of licenses in use at the specific time stamp. 3
OverDraft Number of licenses used above the installed quantity. 0
Installed Number of licenses installed at the specific time stamp. 100
StartupCounts    
LPE ID Information provided to the License Policy Engine - Interface to the license server. <ID><![CDATA[XDT_PLT_2020.1201]]></ID>
SerialNumbers    
Serial The unique identifier in Citrix back office and license files for a given license allocation and files downloaded for that allocation.  
ID The feature code ID that represents a specific product entitlements (edition and license mode). Such as: Citrix Virtual Apps – Premium – User Device XDT_PLT_UD
SADate Subscription Advantage Date. This date represents the termination date of the CSS entitlement. 2020.1201
SN Serial number for the license entitlements in the pool. OR10:13

Citrix Licensing CEIP data elements

Metadata fields

Field Description Example
ClientTool This field isn’t in use. Not applicable
UploadUser This field isn’t in use. Not applicable
UTCDate Report generation time in UTC format. 2022-10-10T06:11:14Z
Date Report generation time in local time format. 10/10/2022 02:11:14
Product Name of the upload. LicenseServerCompliance
ProductVersion The version of the upload. 2.0
ProductUTCDeployDate Denotes the time when the License Server is installed. 2022-08-16T00:00:00Z
SiteID This field isn’t in use. Not applicable
SiteName This field isn’t in use. Not applicable
Component This field isn’t in use. Not applicable

License Server feature usage data

Field Description Example
prod Product reporting V6.Licensing
DateSampleStartUTC Start time of the sample being collected. 1970-01-01T00:00:00Z
DateSampleStopUTC Latest sample time of license usage which ideally is the same as when the report was generated. The sample start isn’t specified because that varies between license types and therefore isn’t a global property. 1970-01-01T00:00:00Z
CLM-WSLUsage Count for individual API calls within Citrix Licensing Manager interface for Citrix Web Services for Licensing service. 10
POSH-WSLUsage Count for individual API calls within PowerShell interface for Citrix Web Services for Licensing service. 2
type Type of data. V6.WSLUsage
ver Version of the data. 1.0
LSVersion The version of the License Server. 11.17.2.0 build 40000

License Server and License Usage information

Field Description Example
License Server Information    
Feature    
GUID A unique identifier created during install and preserved during upgrades. This field is used to identify which uploads are from the same server. a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
DateSampleStopUTC This field is the latest sample time of license usage which ideally is the same as when the report was generated. The sample start is not specified because that varies between license types and therefore isn’t a global property. 2019-11-09T00:57:14Z
DateSampleStop The latest sample time of license usage which ideally is the same as when the report was generated. License Server local time. 11/8/2019 19:57
PortLACHTTP HTTP port that the License Administration Console is configured for. 0
PortLACHTTPS HTTPS port that the License Administration Console is configured for (0 for builds with Citrix Licensing Manager only). 8082
PortLACRedirect Redirect License Administration Console HTTP to HTTPS port. The value can be either true or false. You can set the value to false only for builds with the Citrix Licensing Manager.  
PortLS Citrix Licensing Service (lmgrd.exe) port configuration. 27000
PortVD CITRIX vendor daemon (CITRIX.exe) port configuration. 7279
PortWSL Citrix Web Services for Licensing port configuration. 8083
UDUseDomain If the value is 1, don’t strip the domain from the users name. (user@domain.com). If the value is 0, strip the domain from the users name. 1
OptFileNoLogStatus If the value is 0, log both checkins and checkouts. If the value is 0x1 bit set, checkins are not logged (no log in). If the value is 0x2 bit set, checkouts aren’t logged (no log out). 3
OptFileComplianceConfig This value can be “enabled” or “disabled”. enabled
UDUserNameCase The License Server configuration that denotes how the UserID case-folding is set for User/Device licensing. The values are: 0=nochange; 1=tolower; 2=toupper. 1
UDDeviceNameCase The License Server configuration that denotes how the DeviceID case-folding is set for User/Device licensing. The values are: 0=nochange; 1=tolower; 2=toupper 1
SARenewalCheckOption The values can be “Install”, “Notify”, or “Manual”. Notify
EncoreSamplingPeriod License usage sampling period in minutes. 15
EncoreRetentionTime Historical use data retention in days. 180
EncoreEnabled The option is either true or false. TRUE
SLSProxy The proxy chosen from various sources in order of priority. (1) WinAutoURL using “citrix.com”. (2) WinIE = Internet Explorer settings which require the licensing service to run under a user account rather than local service. (3) WinDefault = The old method that relies on a setting in the windows registry. (4) SimpleLicenseServiceConfig.xml. If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinAutoURL If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinIE If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxyWinDefault If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
SLSProxySlsConfig If the upload is anonymous, this value is either “1” or “0”. If diagnostic (not anonymous), this value is the proxy server string and port, or empty. 0
OS Information about the server machine and operating system that the license server is installed on. 6.3.9600.17031
WindowsBuildLabEx Information about the server machine and operating system that the license server is installed on. 9600.17041.x86fre.winblue_gdr.140305-1710
WindowsEditionID Information about the server machine and operating system that the license server is installed on. Enterprise
WindowsInstallationType Information about the server machine and operating system that the license server is installed on. Client
WindowsProductName Information about the server machine and operating system that the license server is installed on. Windows 8.1 Enterprise
WindowsDomainMember Information about the server machine and operating system that the license server is installed on. N
OSBits Information about the server machine and operating system that the license server is installed on. 32
OSLocale Information about the server machine and operating system that the license server is installed on. en-US
VM Information about the server machine and operating system that the License Server is installed on. Y
VMIDString Information about the server machine and operating system that the License Server is installed on. Microsoft Hv
VMHVIDString Information about the server machine and operating system that the License Server is installed on. Hv#1
HardwareId Information about the server machine and operating system that the license server is installed on. E824249098A96BF0
FQDN License Server machine and domain name. This value is sent to help identify license servers in the reporting experience. Used to pair a License Server calling home to a license allocation record in the back office. CITRIX-12T5MRV4
PrivacySetting Denotes if the customer has chosen to scramble PII (user names and device names). On: Scrambled and Off: Unscrambled Off
InstallUTC This value denotes the time when the License Server is installed. 2016-10-12T00:00:00Z
ProductVersion This value is the current version of the License Server. 11.14.0.1 build 18000
UpgradeFrom The previous version of the License Server if the current install was an upgrade.  
SetupCluster Indicates whether a License Server cluster is set up or not. 0
SGPClockErrorCode Error code indicating why the License Server entered the supplemental grace period. 0
SGPMaxDays Maximum days remaining in the Supplemental Grace Period. 15
SupplementalGracePeriod Grace Periods that Citrix provides when you run out of licenses or the product is unable to contact the License Server. This grace period helps the product continues to operate.  
Feature    
FeatureID The tag of the feature.  
UDBinFileCreatedUTC User/Device Only – not applicable for Concurrent usage 2016-11-09T00:55:56Z
UDReportGenerationUTC User/Device Only – not applicable for Concurrent usage 2016-11-09T00:55:56Z
EventLog User/Device Only – not applicable for Concurrent usage <FirstCreation t=”timestamp”/>
UDAdminUsersReleased Count of users released by udadmin. 3
UDAdminDevicesReleased Count of devices released by udadmin. 3
SADate    
DateSampleStartUTC Start time of the sample being collected. 2016-11-08T01:08:13Z
DateSampleStopUTC End time of the sample being collected. 2016-11-09T00:55:56Z
CountUsedMax The maximum number of licenses used. 3
Active If the value is ‘1’, it’s in the current inventory. If the value is ‘0’, it appears only in historical records and is no longer part of the current inventory either because it is removed or expired. 1
Licensees    
CountInstalled The number of licenses installed. 1203
Pool    
CountTotal The total number of licenses in use at the time the sample was taken. Total number is the sum of users and devices. 3
Devices Specific devices where a device license is assigned contributing to the total count. Scrambled: C648FE671A44B3F7 Unscrambled: C39A925064A3
Usage Samples    
Serial Serial number for the license entitlements in the pool. OR10:13
DateExpiration Most recent expiration date that impacts the license count in the pool. 1-Dec-20
DateIssued The date that the license file was issued. The date issued of the license file that expires first. 1-Dec-03
VendorStr Representation of licensing information that informs products of what edition and mode that they must operate in. <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>
CountInstalled Number of licenses installed among the pools for a given feature. 100
CountOverdraft Number of licenses used above the installed quantity. 0
Sample    
Timestamp Timestamp of the sample collection. 2016-11-09T00:55:56Z
CountInUse Number of licenses in use at this specific time stamp. 3
OverDraft Number of licenses used above the installed quantity. 0
Installed Number of licenses installed at this specific time stamp. 100
Users Specific users where a user license is assigned, contributing to the total count. Scrambled: 1EC4ED037766AA18, Unscrambled: user@domain.com or user
StartupCounts    
LPE ID Information provided to the License Policy Engine - Interface to the license server. <ID><![CDATA[XDT_PLT_2020.1201]]></ID>
SerialNumbers    
Serial The unique identifier in Citrix back office and license files for a given license allocation and files downloaded for that allocation.  
ID The feature code ID that represents a specific product entitlements (edition and license mode). Such as, Citrix Virtual Apps – Premium – User Device XDT_PLT_UD
SADate Subscription Advantage Date. This date represents the termination date of the CSS entitlement. 2020.1201
SN Serial number for the license entitlements in the pool. OR10:13

Citrix License Server Event data elements

Field Description Example
Header    
tenant_id The Customer ID received during the registration. citrix780933
dvc (unique GUID generated by LS) A unique identifier created during install and preserved during upgrades. This field is used to identify which uploads are from the same server. a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
type Type of event. LicenseServer.Inventory
prod Type of product. License Server
id Information about the server machine and operating system that the License Server is installed on. E824249098A96BF0
st Timestamp of the event. 2021-08-27T04:22:56.745631Z
ver Version of the payload. 1
prodVer Version of the License Server. 11.16.6.0 build 35000
$schema Schema for the event Header. https://cas.citrix.com/schemas/event.json
     
Payload    
FQDN License server machine and domain name. This value is sent to help identify license servers in the reporting experience. Used to pair a license server calling home to a license allocation record in the back office. CITRIX-12T5MRV4
DateSampleStartUTC Start time of the sample being collected. 2016-11-08T01:08:13Z
DateSampleStopUTC End time of the sample being collected. 2016-11-09T00:55:56Z
     
Feature    
SADate This field represents the CSS date for which the supplemental grace period was triggered. 2019.1201
PEM The tag of the feature. CEHV_ENT_CCS
Notice NOTICE field from the license file. This is populated with Company Name. Citrix Systems Inc
FriendlyName Friendly name of license XenDesktop Enterprise User/Device
CountInstalled The number of licenses installed. 1203
CountOverdraft Number of licenses used above the installed quantity. 0
CountUsedMax The maximum number of licenses used. 3
DateExpiration Most recent expiration date that impacts the license count in the pool. 12/1/2020.
DateIssued The date that the license file was issued. The date issued of the license file that expires first. 1-Dec-03
DateStart Date from which licenses are valid on. 31-Dec-2014
Serial This information allows Citrix to identify who the product is entitled to. OR10:13
VendorStr Representation of licensing information that informs products of what edition and mode that they must operate in. <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>

Citrix Licensing Telemetry data elements

Metadata fields

Field Description Example
ClientTool This field isn’t in use. Not applicable
UploadUser This field isn’t in use. Not applicable
UTCDate Report generation time in UTC format. 2022-10-10T06:11:14Z
Date Report generation time in local time format. 10/10/2022 02:11:14
Product Name of the upload. LicenseServerCompliance
ProductVersion This is the version of the upload. 2.0
ProductUTCDeployDate Denotes the time when the License Server is installed. 2022-08-16T00:00:00Z
SiteID This field isn’t in use. Not applicable
SiteName This field isn’t in use. Not applicable
Component This field isn’t in use. Not applicable
UI This field ensures the integrity of the uploaded file. 8826d6ac8e1c8e68e471ae90c2bacbe1854f8281a6f5ae40cc7b74114e026abc

License Server and License Usage information

Field name Description Example value
License Server information    
GUID A unique identifier created during install and preserved during upgrades. This field is used to identify which uploads are from the same server. a5ae17c9-8a4a-4318-938f-a8c6da2aa2ef
HardwareId This field is a unique identifier for the License Server instance. E824249098A96BF0
FQDN License server machine and domain name. This value is sent to help identify license servers in the reporting experience. Used to pair a license server calling home to a license allocation record in the back office. CITRIX-12T5MRV4
InstallUTC This value denotes the time when the License Server is installed. 2016-10-12T00:00:00Z
ProductVersion Identifies the License Server version. 11.16.6.0. build 35000
SGPClockErrorCode Error code indicating why the License Server entered the supplemental grace period. 0
SGPMaxDays Maximum days remaining in the Supplemental Grace Period. 15
     
Inventory    
Feature    
ID This value represents the product code license usage is associated with CAG_AAC_CCU
UDBinFileCreatedUTC Timestamp of when the file used to track user or device licenses was created. 2016-11-09T00:55:56Z
UDReportGenerationUTC Timestamp of when the user or device report was generated. 2016-11-09T00:55:56Z
UDAdminUsersReleased Count of users released by udadmin. 3
UDAdminDevicesReleased Count of devices released by udadmin. 3
SADate This field is used to build a view of license usage over time. For examples, see SADate in the following section.
SADate    
id Captures the SA Date through the ID attribute of the SADate element. 2022.1231
DateSampleStartUTC Start time of the sample being collected. 2016-11-08T01:08:13Z
DateSampleStopUTC End time of the sample being collected. 2016-11-09T00:55:56Z
CountUsedMax This value represents the maximum number of licenses used by this customer. 6
CCUDevices Lists the device IDs that use the Citrix concurrent licenses. This helps in getting the license usage over time.  
Active If the value is ‘1’, it’s in the current inventory. If the value is ‘0’, it appears only in historical records and is no longer part of the current inventory either because it is removed or expired. 1
Licensees The Licensees field has three sub fields namely CountTotatal, Users, and Devices. For examples, see Licensees in the following section.
CountInstalled The number of licenses installed. 1203
Pool   For examples, see Pool in the following section.
CCUDevices    
DevId Specifies the unique concurrent device identifier. C39A925064A3
Licensees    
CountTotal Total number of licenses in use at the time the sample was taken. Total number is the sum of users and devices. 3
Users   For examples, see Users in the following section.
Devices   For examples, see Devices in the following section.
Users    
timeLastLogin Last login time event from a user. 2022-07-12T10:00:00
ID Specific users where a user license is assigned, contributing to the total count. user@domain.com or user
Devices    
timeLastLogin Last login time event from this device. 2022-07-12T10:00:00
DevId Specifies the unique device identifier where a device license is assigned, contributing to the total count. C39A925064A3
Name Friendly name for the device. User1Desktop
Pool    
Serial This information allows Citrix to identify who the product is entitled to. OR10:13
DateExpiration Most recent expiration date that impacts the license count in the pool. 12/1/2020.
DateIssued The date that the license file was issued. The date issued of the license file that expires first. 1-Dec-03
VendorStr Representation of licensing information that informs products of what edition and mode that they must operate in. <![CDATA[;LT=Retail;GP=2;PSL=10;CL=ENT,ADV,STD,AST;SA=1;ODP=0]]>.
CountInstalled Number of licenses installed among the pools for a given feature. 100
CountOverdraft Number of licenses used above the installed quantity. 0
Usage Samples   For examples, see the Samples in the following section.
DateStart Date from which licenses are valid on. 31-Dec-2014
Samples    
Timestamp Timestamp of the sample collection. 2016-11-09T00:55:56Z
CountInUse Number of licenses in use at the specific time stamp. 3
OverDraft Number of licenses used above the installed quantity. 0
Installed Number of licenses installed at the specific time stamp. 100
     
StartupCounts data elements    
LPE Product, Edition, and version information for each server communicating with the License Server. Example from left - Apps and Desktops Premium - 2012. <ID><![CDATA[XDT_PLT_2020.1201]]></ID>
Count Total number of LPEs connected to the License Server. 2
     
SupplementalGracePeriod    
ID This field represents the product code following the supplemental grace period detail is associated with. XDT_ENT_UD
SADate This field represents the CSS date for which the supplemental grace period was triggered. 2019.1201
SGPErrorCode Error code for which supplemental grace period was triggered. -4
LicCount License count for which supplemental grace period for triggered. 100
DateTriggerUTC UTC date on which supplemental grace period was triggered for ID and SADate. 2022-07-19T14:35:59Z
DateTriggerLocal Local date on which supplemental grace period was triggered for ID and SADate. 2022-07-19T10:35:59