Audit Application Program Interface › $NMAUAPI OPT=REGISTER-COUNTER—Register Counter for Utilization Statistics

$NMAUAPI OPT=REGISTER-COUNTER—Register Counter for Utilization Statistics

The $NMAUAPI OPT=REGISTER-COUNTER API option creates a counter for the activities to be audited. The counter enables statistics to be gathered for those activities through the ADJUST-COUNTER option.

This API option has the following format:

$NMAUAPI OPT=REGISTER-COUNTER
         OBJCLASS=#class
        [OBJNAME=object_name]
         ACTION=action_type
        [SPROC=procedure_name]
        [TRACE={NO | YES}]

OPT=REGISTER-COUNTER

Specifies that a counter be created for activities that match the other parameters.

OBJCLASS=#class

Specifies the class (user-defined) of the objects to be audited. The class name must start with # (for example, #CLASS01).

Limits: Eight characters, including #

OBJNAME=object_name

(Optional) Identifies the object for which the counter is registered.

Limits: 232 characters

ACTION=action_type

Specifies the performed action. The API provides the following predefined actions:

In SMF, actions are represented in hexadecimal values.

If you specify your own action, it will be recorded in SMF as X'FFFF' (USER-DEFINED) with the TEXT field as action_type:action_text. If you want to assign a specific hexadecimal ID to a user action not in the list, you can define it through Common Application Services (CAS).

Limits: 12 characters

SPROC=procedure_name

(Optional) Specifies the procedure that services this counter:

• For OPT=REGISTER-COUNTER, it sets the initial value of the counter.
• For OPT=ADJUST-COUNTER, it calculates the value of the counter.
• For OPT=RESET-COUNTER, it resets the counter.

The procedure uses &$NM$name variables to share information between the options.

A sample procedure is provided in the MSSAMP($NMAUSP2) data set member.

TRACE

Specifies whether to trace each invocation of the API by writing NMAU0001 messages to the activity log.

TRACE=NO has effect only if the &GLBL$NMAUTRC global variable is not set to YES or Y.

Default: NO