Report Usage
gateway91flow
Reporting of product usage is a Portfolio Licensing Agreement (PLA) requirement that helps CA gain insights into product usage, your software needs, and which features and platforms you use regularly.
If you have signed a PLA with CA Technologies, a Broadcom company, you must report product usage data. For versions earlier than CA API Gateway 9.4, reporting and collecting data is a manual task. In CA API Gateway 9.4 and later, the telemetry feature that collects data is integrated and allows you to choose between manual or automatic reporting.
Do not provide any personally identifiable information (PII) or sensitive information.
Data to Report
Report the following information:
- PLA or not?Is this product installed or upgraded as part of a portfolio license agreement (PLA).
- Company Domain:Report your company domain name. For example: myCorp.com
- Enterprise Site ID:Enter the assigned numeric ID for your organization. You can find this number on your PLA or on the CA Support site. To locate the number on the Support site:
- Sign in to your Support account.
- Select My Account, Profile.
- Under Support Access Information, refer to the Site ID.
- Internal Identifier:Enter a label that identifies which group is reporting usage. Your company might have different divisions, each with their own product installations. This field enables you to indicate which division is sending data.
- Product SKU and Name:Report the information corresponding to your product.SKUProduct NameUsage MetricAPIAMZ990CA API Gateway Amazon Machine Image (AMI)(RHEL) form factorCount of ApplianceAPNAMZ990CA API Gateway Amazon Machine Image (AMI)(RHEL) form factor non-productionCount of ApplianceAPIENT990CA API Gateway EnterpriseCount of InstanceAPNENT990CA API Gateway Enterprise non-productionCount of InstanceAPIEWN990CA API Gateway Enterprise Workstation non-productionCount of InstanceAPIESS990CA API Gateway Essentials non-productionCount of InstanceAPNESS990CA API Gateway Essentials Workstation non-productionCount of InstanceAPIVRL990CA API Gateway virtual appliance (RHEL) form factorCount of ApplianceAPNVRL990CA API Gateway virtual appliance (RHEL) form factor non-productionCount of ApplianceAPIAPM990CA Precision API Monitoring Module for API GatewayCount of InstanceAPIPSA990CA Precision API Monitoring Module SaaS for API GatewayCount of InstanceAPIRNS990CA Runscope for APIM IntegrationCount of Thousand Request
- System Configuration:Specify the product version including database type and version.
- Product Usage:Enter the number of product instances you are running. Refer to the following document to calculate instances.
- Date:Report the date the product usage was captured.
How to Report Data
A product usage reporter is available for download. For more information about the tool, visit the Product Usage Reporter techdocs site.
Download and run the Product Usage Reporter tool to collect and send data manually. Your PLA requires you to report usage every Quarter.
To install and configure the Product Usage Reporter:
- Download and install the Product Usage Reporter from the support site for Windows or Linux.
- Launch the Product Usage Reporter.
- Create an administrator username and password.
- SelectManual. The API Gateway supports only manual reporting.
- Do you have an entitlements.csv file provided by support? If yes, select the file and click Upload. Your settings are populated. If no, manually complete the required fields in the Company Information section. Your Enterprise site ID can be found at casupport.broadcom.com underMy Account>Profile.
- In the Manual section of the reporter, clickAdd Productand add your product to the list. ClickSave. Your product appears listed on the Manual Collection page.
- Calculate usage data. Refer to the following document to calculate instances.
- After entering usage data, clickSubmit Usage.