ctmruninf

You can use the following utilities to display (and delete) statistical data:

  • The ctmruninf utility displays and deletes data from the Statistical Details table of the Control-M/Server database. An option is available to delete data from this table. The jobs scanned for both options can be limited to a range of dates as described below.

  • Statistical data is only accumulated when the ControlM/Server system parameter Statistics is set to Y.

  • The ctmstats utility displays and deletes data from the Statistical Summary table. For more information about the ctmstats utility, see ctmruninf.

Both utilities can be filtered according to date and job information.

The ctmruninf utility displays runtime data from the Statistical Details table of the Control‑M/Server database.

Running the ctmruninf Utility

This procedure describes how to run the ctmruninf utility, which enables you to display runtime data from the Statistical Details table of the Control‑M/Server database.

Begin

  1. Do one of the following:

    • UNIX: Log in to a Control-M/Server account

    • Windows: Open a command prompt window where Control-M/Server is installed.

  2. Type one of the following commands:

    ctmruninf -list <fromDate> <toDate> [<filter>] [-total]

    ctmruninf -list "*" [<filter>] [-total]

    ctmruninf -delete <fromDate> <toDate>

    ctmruninf -PURGE

ctmruninf Utility Parameters

The following table describes the ctmruninf utility parameters:

Parameter

Description

‑list

Displays data from the Statistical Details table within the dates specified in the From Date and To Date parameters. The data listed can be limited by using the Filter subparameter described in this table.

‑delete

Deletes data from the Statistical Details table in the range specified in the From Date and To Date parameters.

<From Date>

Determines the start date of statistical data to be displayed or deleted.

Format: yyyymmddhhmmss

<To Date>

End date of statistical data to be displayed or deleted.

Format: yyyymmddhhmmss

"*"

Specifies that the utility should list all statistical data currently available, without regard to date.

<Filter>

Specify one of the following options and its associated subparameter or leave blank to display the statistics for all jobs in the range.

  • JOBNAME <jobName>: Identify the job by the first 10 characters in its Job Name parameter.

  • FILE_NAME <file name>: Identify the job by its file name parameter.

  • FILE_PATH <path>: Identify jobs by their file path parameter specifications.

  • HOSTID <hostid>: Identify jobs by their Host ID parameter (Agent computer).

  • -ORDERID <orderid>: Identify jobs by their Order ID parameter.

Each of the sub parameters in the filter can include the following wildcard characters:

* represents any number of characters (including none). Any parameter including * should be enclosed in quotation marks (see the third example below).

? represents any single character

‑total

Displays the total CPU and elapsed times for the jobs selected.

-purge

Purges data from the Statistical Details table based on the number of job executions.

Running the ctmruninf utility with the -PURGE option performs the statistics clean up as if it was done during New Day with the RUNINF_PURGE_MODE set to 0.

Default: 0

The Statistics algorithm (JOBNAME or MEMNAME) and the RUNINF_PURGE_LIMIT parameter are taken from the config.dat table, if configured.

You can speed up the New Day procedure by specifying N for the STATISTICS_CLEANUP_IN_NEWDAY parameter and running ctmruninf -PURGE in a job that is run daily. Only the last n run information records of a job are kept, where n is the value of RUNINF_PURGE_LIMIT (default 20).

ctmruninf Utility Example

The following example describes command displays runtime data for the period January 21, 2021 through January 25, 2021, assuming that this data is available:

ctmruninf -list 20210121000000 20210125235959

The following command deletes the statistical data for January 31, 2021:

ctmruninf -delete 20210131000000 20210131235959

The following command causes the utility to display and total runtime data for all jobs on Agent computer Diana.

ctmruninf -list "*" -HOSTID "Diana" -total

A report similar to the following is displayed:

Copy 
TIMESTAMP   JOBNAME  ORDERID  RUN# HOST     FILE_NAME    FILE_PATH        CPU   ELAPSED 
 ------------- ---------- -------- ---- ------------ ---------- -------------- ----- -------
2021012160524 acct12     00000007    1 Diana        pgmacct    prod.acct.pgm   0.19  233.15
2021012161205 gen786     0000000b    1 Diana        genx       prod.general    0.12    6.12
2021012162311 acct14     00000011    1 Diana        pgmacct    prod.acct.pgm   0.05  170.45
2021012164512 acct15     00000012    1 Diana        pgmacct    prod.acct.pgm   0.14  145.23 
 ------------- ---------- -------- ---- ------------ ---------- -------------- ----- ------- 
Total records printed : 4                                                      0.50  555.35