Usage Data (Telemetry)

{"URL":["/aai/web/v2/settings/product-usage"],"heroDescriptionIdentifier":"ice_description_product_usage","customCards":[{"id":"ice_description_collecting_data","title":"Collecting Data","type":"customize"},{"id":"ice_description_calculating_metrics","title":"How Licensed Metrics Are Calculated","type":"customize"},{"id":"ice_description_reporting_data","title":"How To Report Usage Data","type":"customize"},{"id":"ice_description_Working_w_Tables","title":"Working with Tables","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/_Common/CommonFunctions/CF_Working_with_Tables.htm"}]}

You can configure your product to collect and send telemetry data — product usage and system configuration data — to Broadcom. Use the information on this page to learn how to send usage data to Broadcom.

If you are licensed to use this product under a Portfolio License Agreement (PLA) subscription, you must configure it to collect and send product-specific usage data. If you are licensed to use this product under a standard license, you can consent to having this product collect and send usage data. By default, this product does not collect and send usage data.

For Automic Automation Intelligence, the reporting options are:

What Data We Collect

The usage data information is securely transmitted to Broadcom. The data includes the number of devices that are being monitored. No Personally Identifiable Information (PII, as legally defined) covered under GDPR is transmitted. For more information about how your information is collected and used, read our Privacy Policy. The following table describes some of the usage data that your product may send to Broadcom.

Name Description
Product A description of the product SKU
Instance ID A product-generated unique ID representing a single installation or environment
Date Collected Use the yyyy-MM-dd format
Product Version The product model and version
Site ID The Enterprise Support Site ID of the customer
Usage The maximum meter count which was used during a reporting period
Domain Name The name of the customer domain, that is, broadcom.com
SKU The product SKU based on the entitlement
ChargebackID A customer-provided value to be used for internal purposes
Additional fields Counts of scheduler instance by type

How Licensed Metrics Are Calculated

Automic Automation Intelligence collects and optionally sends system configuration information about the number and type of automation engines that are connected to the Automic Automation Intelligence server. The data metrics differ depending on your system's setup:

  • Automic Automation Intelligence engine

    This refers to the AAI server itself.

    Usage: Always "1" for each server instance, if the server is up.

  • Broadcom distributed automation engine instances

    This refers to AutoSys and Automic instances.

    Usage: "1" for each automation engine connected to the AAI server.

  • Broadcom mainframe automation engine

    This refers to CA7 and ESP instances.

    Usage: "1" for each automation engine connected to the AAI server.

  • Non-Broadcom distributed automation engine instances

    This refers to IWS, Control-M, and Tidal distributed instances.

    Usage: "1" for each automation engine connected to the AAI server.

  • Non-Broadcom mainframe automation engine

    This refers to IWS and Control-M instances.

    Usage: "1" for each automation engine connected to the AAI server.

How to Report Usage Data Automatically

As an administrator, you can configure telemetry during installation or upgrading or after installation/upgrade via the Config Tool.

When you install or upgrade the product, you are prompted to configure telemetry. You can edit these settings later via the Config Tool. Here you can indicate if the planned usage is under a Portfolio License Agreement (PLA). You can also indicate if you want to automatically send the telemetry data to Broadcom and, if so, enter the following information:

  • Company Domain (mandatory)

  • Enterprise Site ID (mandatory)

  • Internal Identifier (optional)

Optionally, you can send usage data via a proxy server. If you select this option, you enter the following:

  • Proxy URL

  • Username

  • Password

When you consent to send telemetry data, Automic Automation Intelligence sends the data at 12:00 am. If Automic Automation Intelligence is not active at 12:00 am, the data is sent in the next day run. The data is collected only once per day.

How to Use the Product Usage Collector

The Product Usage Collector (PUC) is an application for Windows or MacOS that is installed by the customer on a system that can access the product. The PUC alleviates the need for special firewall rules to access product licensed metrics, and does not require a dedicated system in your data center. For complete documentation on the PUC, see Product Usage Collector.

The PUC requires two different credentials:

  • Broadcom Okta credentials

    Your account that has a Subscription Manger role on support.broadcom.com. Use these credentials when you start PUC, to allow it to retrieve your SiteID, entitlements, and a list of product versions supporting PUC.

  • Product access credentials

    The user name and password for each product for which you are reporting usage, see below.

Defining Product-Specific Information

The PUC requires product-specific information to return the relevant data.

As an administrator, you make sure the following requirements are in place:

  1. Make sure that telemetry is configured correctly in Automic Automation Intelligence.

    1. On the Config Tool, define if the instance is subject to a PLA. When you use the PUC you do not have to send telemetry data automatically.

    2. Provide the following data:

      • Company Domain (mandatory)

      • Enterprise Site ID (mandatory)

      • Internal Identifier (optional)

    3. Save your changes.

    The telemetry data for the products that you have added to AAI (licensed metrics) is generated automatically.

  2. Save the credentials of the AAI instance in the configuration file of the PUC. Otherwise, the PUC cannot establish a connection to your environment.

  3. You do not have to create a dedicated AAI user to report your usage data. You only have to make sure that the user reporting the data has permission to access the relevant schedulers.

How to Report Usage Data Manually

You can extract the telemetry data offline by using the Automic Automic Automation Intelligence REST API. It is found by using a date range. For example:

http://{Automic_Automation_Intelligence}:8080/telemetryService/report?fromDate=2020-02-18&toDate=2020-03-18

After you have pulled your data, submit it to Broadcom by using the Usage Reporting Portal.