Configure Telemetry

 includes the capability to store your usage information, and (in the case of customers who use TDM under the terms of a Broadcom Portfolio Licensing Agreement) to send this information to Broadcom.
tdm481
HID_telemetry
 
Test Data Management
 includes the capability to store your usage information, and (in the case of customers who use TDM under the terms of a Broadcom Portfolio Licensing Agreement) to send this information to Broadcom.
 If you use TDM under the terms of a Broadcom Portfolio Licensing Agreement (PLA), this telemetry information is necessary for TDM to function. For more information, see Activate Test Data Manager.
The following sections of this page detail how you can configure the Telemetry service:
 
 
Configure Telemetry at product installation or upgrade
After you install or upgrade TDM Portal, the first time you log in as an Administrator, the 
Activate Product
 dialog opens. On the 
Telemetry Configuration
 page of this dialog, enter the following information:
  • (PLA customers only)
     Company Domain
    The last part of your company's e-mail address (e.g.
     broadcom.com
    ).
  •  
    Enterprise Site ID
    This is a 4 to 9 digit number. You can find this on your License Agreement or on the CA Support Portal.
     
     If you do not use TDM under the terms of a PLA, this value is automatically populated, based on your License Key.
     
     
  • (Optional) 
    Internal Identifier
    TDM reports some metrics per instance. You can set this value for your own reference, to track your organization's usage of TDM by instance.
For more information, see Activate TDM and Configure Telemetry.
Configure Telemetry in TDM Portal
To make changes to how TDM reports your Telemetry data, follow these steps:
  1. Open the TDM Portal.
  2. Click 
    Configuration
    , then click 
    Telemetry
    .
    The 
    Telemetry Configuration
     page opens.
  3. Amend your 
    Company Domain
     (PLA customers only),
     Enterprise Site ID
     and
     Internal Identifier
     as necessary.
  4. Click 
    Save
    .
    TDM saves your new Telemetry preferences.
Export Telemetry Data
TDM always collects telemetry data, even if it does not send it to Broadcom (in the case of customers who do not use TDM under the terms of a PLA). TDM stores this telemetry data locally.
You can download all the usage information data that TDM collects, as a CSV file.
Follow these steps:
  1. Open TDM Portal.
  2. Click 
    Configuration
    , then click 
    Telemetry
    .
    The 
    Telemetry Configuration
     page opens.
  3. Click 
    Export Metrics
    .
    TDM downloads your Telemetry Data as a JSON file.
Usage metrics that TDM collects
TDM Portal reports the following usage metrics:
  •  
    Data Profiling, PII Data Discovery and Masking 
     
    • Number of user sessions involved in PII Data Discovery and Profiling activities per day.
    • Number of user sessions involved in creation or editing masking definitions, transformation maps and masking configuration options, per day.
    • Number of user sessions involved in running masking jobs per day.
  •  
    Subsetting
     
    • Number of user sessions involved in creation or editing subset definitions per day.
    • Number of user sessions involved in generating subset scripts per day.
  •  
    Synthetic Data Generation
     
    • Number of user sessions involved in creation or editing data generation definitions and data pools per day.
    • Number of user sessions involved in running data generation (publish) jobs per day.
  •  
    Find & Reserve
     
    • Number of user sessions involved in creation or editing of Find & Reserve model per day.
    • Number of user sessions involved in running Find & Reserve search per day.
  •  
    Test Match
     
    • Number of user sessions involved in creation or editing Test Match definitions per day.
    • Number of user sessions involved in Test Match execution per day.
  •  
    Data sources
     
    • Number of database instances and data source types in use in Masking, Subsetting, Synthetic Data Generation, Find & Reserve and Test Match functionalities, per day.
    • Information whether flat files are used as source or target in the TDM functionalities above.
(PLA customers only) Set up an HTTP Proxy for Telemetry
If you are unable to successfully send data, it may be because you need an HTTP proxy. You can define an HTTP proxy for telemetry in the 
application.properties
 file.
 In a default installation, TDM saves 
application.properties
 in the folder 
C:\Program Files\CA\CA Test Data Manager Portal\conf
.
The lines in 
application.properties
 that define the HTTP proxy are the following:
# Proxy settings
# tdmweb.proxy.type:
# DIRECT - Represents a direct connection, or the absence of a proxy.
# HTTP - Represents proxy for high level protocols such as HTTP or FTP.
# SOCKS - Represents a SOCKS (V4 or V5) proxy.
tdmweb.proxy.type
=
DIRECT
tdmweb.proxy.hostname
=
localhost
tdmweb.proxy.port
=
8000
tdmweb.proxy.username
=
tdmweb.proxy.password
=
Notes on HTTP Proxy setup
  • If
    tdmweb.proxy.type=DIRECT
    (i.e. no HTTP proxy is active), the values of properties
    tdmweb.proxy.hostname
    and
    tdmweb.proxy.port
    are not used. However, these properties must be present, and they must have values associated.  
  • The password (
    tdmweb.proxy.password
    ) that you enter for the HTTP proxy can be either:
  • Changes that you make to the
    application.properties
    file do not take effect until you restart TDM Portal.
Reporting Telemetry in Fast Data Masker and GT Subset
Fast Data Masker (FDM) and GT Subset send Telemetry data to the TDM Portal service, which aggregates Telemetry data from individual TDM components. If FDM or GT Subset are unable to connect to the TDM Portal service at startup, a warning message displays.
To set up this connection to the TDM Portal service successfully, it is necessary to define the operating system environment variable 
TDM_PORTAL_URL
 on the machine where FDM or GT Subset is installed. You should define this variable as the URL where you access the Portal.
 
Example:
 
TDM_PORTAL_URL
=
https://TDM_Portal_Host:<port_number>
If TDM Portal is unavailable (e.g. it is an earlier version than FDM, or the service is inactive)
you may experience a delay at startup.
For information on how to disable this connection, see Disable Fast Data Masker's connection to TDM Portal.