Using the License Reporting Tool

You can use the License Reporting Tool (LRT) to run different queries and create various reports. You can use it to gather usage data from different Automation Engine versions, such as test and production systems. For more information about compatibility, visit the compatibility matrix.

Important! The License Reporting Tool is provided for legacy license reporting only. Telemetry is the default way of reporting usage data back to Broadcom.

For more information about reporting usage data, please refer to the Telemetry section in the Automic Automation documentation at docs.automic.com.

Query Commands

The following commands are available:

List all queries/reports for my license mode java -jar lrt.jar reports-list

• Options:

  • -i <path_to_lrt>.ini

    Uses the settings of the INI file linked.

  • lrt.ini report_mode="usage_based" allows you to print or create usage based reports only

  • lrt.ini report_mode="task_based" allows you to print or create task based reports only

  • lrt.ini report_mode="both" allows you to print or create all reports

  The report_mode parameter also controls the creation of the reports. For example, you cannot create a task-based report when the report_mode is set to usage_based.

Run all queries for my license mode java -jar lrt.jar reports-create

• Options:

  • -d dry run

    Writes queries and system information to the log, but does not execute them.

    Default: false

    This option can be used to inspect the SQL for the reports in the log file without actually generating them.

  Note:

  To avoid accidental overwriting, reports are written to a timestamped subfolder of the output folder that you have configure. For example, C:\Automic\Tools\LRT\cli\windows\output\2019-03-29_11-40-50.

Run selected queries for my license mode java -jar lrt.jar reports-create reportName1 reportName2

• Options:

  • -d dry run

    Writes queries and system information to the log, but does not execute them.

    Default: false

  • -e

    Excludes the mentioned reports. For example, generates all reports except the mentioned ones.

    Default: false

  • -f <YYYY-MM-DD> final date of report

    Default: current system date

  • -i <path_to_lrt>.ini

    Uses the settings of the INI file linked.

  • -s <YYYY-MM-DD>start date of report

    Default: 01-01-(CURRENT_YEAR - 3)

  Internally, the tool uses 00:00:00 for the time portion in the start and final date/time. Thus, to query all executions for the year 2018, one has to use the options -s 2018-01-01 -f 2019-01-01.

  Note:

  You can only use report names that are available in your current report_mode. Use the reports-list command to learn about them.

Verify the created reports in output dirjava -jar lrt.jar reports-verify

• Options:

  • -i <path_to_lrt>.ini

    Uses the settings of the INI file linked.

  • -o

    Specifies the output path of reports and overrides the settings of the INI file.

    lrt.jar inspects the files and all subfolders in this folder for report files and validate their content against their checksums.

  Important!

  The verification does not cover neither a plausibility check for the usage numbers in the reports nor whether reports are missing for the desired usage period. You have to do these checks manually.

Show the LRT version java -jar lrt.jar version

Shows the version information.

Query Commands - Telemetry

The following commands are specific to the telemetry usage data:

Calculate Telemetry data java -jar lrt.jar telemetry-usage

• Options:

  • -d dry run 

    Writes queries and system information to log, but does not execute them.

    Default: false

  • -i <path_to_lrt>.ini

    Uses the settings in the linked INI file.

When you calculate the telemetry usage data, you get two reports:

• the regular report (<DB_Name>_PLA_Calculation.csv) listing all data cumulatively, and

• an additional report (<DB_Name>_PLA_Individual_Nodes_Calculation.csv) that lists in detail the individual elements that make up the technology nodes, application nodes, mainframe nodes, or orchestrated systems in your environment.

Command Line Usage Screen

When you run the LRT without parameters (java -jar lrt.jar), you get the list of commands and command options you can use from the command line.

Example

>java -jar lrt.jar
License Usage Reporting Tool v5.0
create and verify CSV reports on Automic product usage

Usage: lrt [command] [command options]
  Commands:
    reports-list      list all report names of current report_mode (lrt.ini)
      Usage: reports-list [options]
        Options:
          -i
            path to ini file whose settings will be used

    reports-create      create all or specific reports in current report_mode
            (lrt.ini)
      Usage: reports-create [options] [report1 report2 ... ]
        Options:
          -d
            dry run: write queries and system information to log, but does not
            execute queries
            Default: false
          -e
            create all reports except the given ones
            Default: false
          -f
            <YYYY-MM-DD> final date of report - exclude usage data after that
            date, 00:00 hs. Default: current system date
          -i
            path to ini file whose settings will be used
          -s
            <YYYY-MM-DD> start date of report - exclude usage data before that
            date, 00:00 hs. Default: (current_year-3)-01-01

    reports-verify      verify the reports in output_path (lrt.ini)
      Usage: reports-verify [options]
        Options:
          -i
            path to ini file whose settings will be used
          -o
            output-directory of reports (overrides lrt.ini setting)

    version      show version information
      Usage: version

    telemetry-usage      Calculates telemetry data on a snapshot-basis that
            would be used for Portfolio License Agreement (PLA)
      Usage: telemetry-usage [options]
        Options:
          -d
            dry run: write queries and system information to log, but does not
            execute queries
            Default: false
          -i
            path to ini file whose settings will be used

Listing Reports

The reports-list command lists the name of all available LRT reports. These names can later be used in the report-create command to create individual reports:

C:\uc4\LRT\bin>java -jar lrt.jar reports-list
INFO  - Reading INI file 'C:\uc4\LRT\bin\lrt.ini'
Task-based Reports:
    ActiveClients
    DailyEvnt
    DailyJobf
    DailyJobs
    DailyTasksTotal
    DefinedEvnt
    DefinedJobf
    DefinedJobs
    DefinedObjects
    MonthlyEvnt
    MonthlyJobf
    MonthlyJobs
    MonthlyTasksTotal

Usage-based Reports:
    AgentsDB
    AgentsFTP
    AgentsJMX
    AgentsOS
    AgentsRA
    AgentsSAP
    AgentsWS
    SAPSystemCopy
    SystemAdapters

General Reports:
    License

Verifying Reports

By running the reports-verify command, you can verify the authenticity of the CSV reports using the included checksums. The command processes all CSV reports that are stored in the output folder configured in lrt.ini. If the verification is successful, the output reflects it:

gt; java -jar lrt.jar reports-verify
Verifying CSV report checksums in output folder 'C:\Automic\Tools\lrt\output':
 
2017-03-21_14-23-04\AE12_Agents_DB_Usage.csv ... OK
2017-03-21_14-23-04\AE12_Agents_FTP_Usage.csv ... OK
2017-03-21_14-23-04\AE12_Agents_JMX_Usage.csv ... OK
[...]
 
All 19 reports verified successfully

If the verification fails for one or more reports, the status FAILED is printed next to the failed report. An error summary informs the user how many of the reports have failed:

> java -jar lrt.jar reports-verify
Verifying CSV report checksums in output folder 'C:\Automic\Tools\lrt\output':
 
2017-03-21_16-37-55\AE12_Agents_DB_Usage.csv ... OK
2017-03-21_16-37-55\AE12_Agents_FTP_Usage.csv ... OK
2017-03-21_16-37-55\AE12_Agents_JMX_Usage.csv ... FAILED
[...]
 
Error: Verification failed for 1 of 19 reports

Examples

Creating Dry Run Reports

This example uses the -d dry run option to write the SQL queries and connection parameter for the reports to the log file, but not execute them. Use this to learn about the queries that are applied to fetch the report data.

> java -jar lrt.jar reports-create -d

Creating Select Reports

This example only creates the reports "AgentDB" and "AgentsFTP".

> java -jar lrt.jar reports-create AgentDB AgentsFTP

Excluding Select Reports

This example creates all reports for the current reportmode, except for "AgentDB" and "AgentsFTP".

> java -jar lrt.jar reports-create -e AgentDB AgentsFTP

Creating Reports By Date

This example creates all reports, but only considers usage data between March 1st, 2017, 00:00 AM until March 15th, 2017, 00:00 AM. By limiting the usage data to a certain time range, you will likely speed up the runtime of LRT.

> java -jar lrt.jar reports-create -s 2017-03-01 -f 2017-03-15

Creating Reports on Different Automation Engine Systems

This example uses the configuration of the AE108.ini file instead of the default lrt.ini

> java -jar lrt.jar reports-create -i ae108.ini

To define reports on a different Automation Engine system, you can specify the filepath to an alternate INI file file using the -i option. The file path can either be absolute or relative to lrt.jar.

Running a Batch File to Create Reports for Multiple Systems

In the example, a file named multiple_systems.bat is used to create the reports for AE_SYSTEM_1, AE_SYSTEM_2 and AE_SYSTEM_3 at once. The example assumes that the INI files for these systems are located in the same folder than the batch file.

The contents for the multiple_systems.bat are should below.

rem assumes there is an AE_SYSTEM_1.ini, AE_SYSTEM_2.ini etc with the different settings for

rem each AE installation

for /F %%a in ("AE_SYSTEM_1 AE_SYSTEM_2 AE_SYSTEM_3") do (

   java -jar lrt.jar reports-create -i %~dp0%%f.ini

)

See also:

• Installing the License Reporting Tool
• License Usage Reporting Tool INI file