Skip to content
CA View® - 12.2
Documentation powered by DocOps

Metrics

Last update March 13, 2018

The Metrics option gives you the ability to measure the activity and usage of a CA View database. The Metrics option provides measurement information. Because this metric data is generated for unique activity to report data, it also provides audit trail information, related accounting information, and useful statistics. These measurements provide information that you can use to tailor Expanded Retention Parameters, Expanded Access Server for Tape/Robotic options, and database use. Measurements are recorded for mainframe, as well as WebViewer and MTC-Content Viewer activities.  

CA View provides many facilities for storage, access, and retention of reports based on initialization parameters, option parameter specifications, or program parameter specifications. These parameters provide you with the ability to customize the product to your environment. Customization of certain parameters, however, can require an intimate knowledge of the reports that are retained and accessed in the CA View database. Because this knowledge might not be known or might vary based on user activity, methods for measuring the use of CA View are needed.

The metric data is recorded as System Management Facility (SMF) records. These records provide a detailed account of the following activities:

  • Users logging on
  • Users logging off
  • Users viewing reports
  • Users reprinting reports
  • Users loading reports
  • Users deleting reports
  • Users changing a report archival date
  • Users adding or changing user profiles
  • Users report actions in MTC-Content Viewer - (email, export, save)

You can generate an optional data set from the Metrics report program that contains the SMF records used to produce the reports. These records can then be used with a report writer allowing you to generate customized reports based on Metrics according to your needs.

Contents

How to Use Metrics

All SMF records for a specific CA View database are generated with the same SMF record type. This SMF record type is based on the specification of the SMFTYPE initialization parameter, which may range from 128 to 255.

Note: For more information about the SMFTYPE parameter, see Initialization Parameters.

To use Metrics, you must set the SMFTYPE Initialization parameter to an unused SMF value from 128 to 255. This identifies a unique SMF record type to the system management facility.

To locate an unused SMF record type, review the contents of SYS1.PARMLIB(SMFPRMxx). This system parameter is expected to contain a list of used SMF records types. In this example, type 129 is not defined and is available for use:

SYS(TYPE(128,132,140:144,....),

INTERVAL(SMF,NOSYNC),

NODETAIL,

EXITS(IEFU83))

To find the SMFPRMxx member name, review the contents of SYS1.PARMLIB(IEASYSxx normally IEASYS00) which contains the SMFPRMxx member qualifier. For example, SMFPRM03:

SMF=03

Note: Setting the SMFTYPE Initialization parameter to 0(zero) disables CA View SMF Metrics recording.

You can also review IBM's Initialization and Tuning Reference operating system guide in the "SMFPRMxx (system management facilities (SMF) parameters)" and other methods to determine an unused SMF record type.

Record SMF Records Under TSO and ISPF

To write SMF records using IBM's SMFWTR macro, the issuing program must be in supervisor state key zero.

Since the native TSO and ISPF interfaces are not sufficiently authorized to establish supervisor state, SMF records cannot be written directly under these interfaces. Merely adding these interfaces to the TSO authorization table is not sufficient for the ISPF interface.

ISPF, specifically, does not allow dialog service support from authorized programs. To provide a consistent interface for both the native TSO and ISPF interfaces, a separate program, SARSMFT, is provided. SARSMFT must be added to the TSO authorization table.

The online interfaces can then use the TSO service routine, IKJEFTSI, to execute the SARSMFT program to write the SMF record. Authorized TSO programs are normally defined in the IKJTSOxx member of SYS1.PARMLIB. For simplicity, only the updates to the IKJTSOxx member are discussed.

The AUTHTSF Section

The IKJTSOxx member provides four sections to use to define the following:

  • Authorized commands
  • Authorized program
  • Authorized program called from the TSO service facility
  • Commands not supported in background.

These sections are AUTHCMD, AUTHPGM, AUTHTSF, and NOTBKGND, respectively.

The SARSMFT must be added to the AUTHTSF section.

Syntax:

The format and syntax of the AUTHTSF section of the IKJTSOxx member are:

AUTHTSF NAMES( /* PROGRAMS TO BE AUTHORIZED   */ +                

                  /* WHEN CALLED THROUGH THE TSO */ +                

                  /* SERVICE FACILITY.           */ +                

        IEBCOPY   /*                             */ +                

        IKJEFF76) /*                             */                  

Enclose the names of the authorized programs in parentheses after the NAMES keyword. The program names are separated from other program names in the previous example.

The following example shows the change:

   AUTHTSF NAMES( /* PROGRAMS TO BE AUTHORIZED   */ +                

                  /* WHEN CALLED THROUGH THE TSO */ +             

                  /* SERVICE FACILITY.           */ +             

        IEBCOPY   /*                             */ +             

        IKJEFF76  /*                             */ +             

        SARSMFT)  /* SAR SMF WRITER ROUTINE      */

Record Subtype Number

The record subtype is a uniquely defined number indicating the record that is being recorded. These record subtypes (located in bytes 26 - 27 of the SMF record) are listed below:

Record Subtype Type of SMF Record
20 Online user logging onto the online retrieval facility
21 Online user logging off from the online retrieval facility
30 Online user viewing a report
31 Batch or online reprinting of a report, batch load of a report to a data set
32 Report being loaded into the database
33 Batch or online deletion of a report
34 Batch or online deletion of a report from disk database

35

Batch report archival date change

36 Report actions in MTC-Content Viewer (email, export, save)
40 Add/change a user profile record

The SARSMFUX user exit is called before the SMF record is written to allow modification and/or suppression of the SMF record. All SMF records can be suppressed automatically by setting the SMFTYPE initialization parameter to zero.

Was this helpful?

Please log in to post comments.