Monitoring domain’s specific gates

Table 72 summarizes the monitoring domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 72. Monitoring domain’s specific gates
Gate Trace Function XPI
MNMN
MN 0201
MN 0202
EXCEPTION_DATA_PUT
PERFORMANCE_DATA_PUT
INQUIRE_MONITORING_DATA
MONITOR
INQUIRE_RESOURCE_DATA
NO
NO
YES*
YES
NO
MNSR
MN 0301
MN 0302
SET_MCT_SUFFIX
SET_MONITORING
INQ_MONITORING
NO
NO
NO
MNXM
MN 0A01
MN 0A02
TRANSACTION_INITIALIZATION
TRANSACTION_TERMINATION
NO
NO
NO

* In a modified form, without a transaction number or current data buffer.

MNMN gate, EXCEPTION_DATA_PUT function

The EXCEPTION_DATA_PUT function of the MNMN gate is used to produce an exception record at the completion of an EXCEPTION condition.

Input parameters

EXCEPTION_START
is the start time of the exception in stored clock (STCK) format.
EXCEPTION_STOP
is the stop time of the exception in STCK format.
RESOURCE_TYPE
is the type of resource for which the exception data is to be recorded.
RESOURCE_ID
is the identifier of the resource for which the exception data is to be recorded.
EXCEPTION_TYPE
is the type of exception to be recorded.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
INVALID_MONITORING_TOKEN
LOOP

MNMN gate, PERFORMANCE_DATA_PUT function

The PERFORMANCE_DATA_PUT function of the MNMN gate is used to produce a performance record and reset task monitoring information for a conversational task or a syncpoint.

Input parameters

RECORD_TYPE
is the reason for the record to be output.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
INVALID_MONITORING_TOKEN
LOOP

MNMN gate, INQUIRE_MONITORING_DATA function

The INQUIRE_MONITORING_DATA function of the MNMN gate is used to access a transaction’s monitoring information.

Input parameters

[TRANSACTION_NUMBER]
is the transaction number for which monitoring data is required.
DATA_BUFFER
specifies the address and length of a buffer for the monitoring data.
[CURRENT_DATA_BUFFER]
specifies the address and length of a buffer for the current monitoring data.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
MONITOR_DATA_UNAVAILABLE
LENGTH_ERROR

MNMN gate, MONITOR function

The MONITOR function of the MNMN gate is called to process a user event-monitoring point (EMP).

Input parameters

POINT
is a value in the range 0 through 255 corresponding to a monitoring point identifier defined in the monitoring control table (MCT).
[ENTRYNAME]
is an ID qualifier, 1 through 8 bytes, corresponding to an entry name specified in the MCT.
[DATA1]
supplies 4 bytes of data to be used in the operations performed by this user’s EMP.
[DATA2]
supplies 4 bytes of data to be used in the operations performed by this user’s EMP.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
INVALID_MONITORING_TOKEN
LOOP
EXCEPTION
POINT_NOT_DEFINED
DATA1_NOT_SPECIFIED
DATA2_NOT_SPECIFIED
INVALID_DATA1_VALUE
INVALID_DATA2_VALUE

MNMN gate, INQUIRE_RESOURCE_DATA function

The INQUIRE_RESOURCE_DATA function of the MNMN gate is used to access a transaction’s resource data when transaction resource monitoring is active.

Input parameters

[TRANSACTION_NUMBER]
is the transaction number for which transactoin resource data is required.
RESOURCE_DATA_BUFFER
specifies the address and length of a buffer for the transaction resource data.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
RESOURCE_DATA_UNAVAILABLE
LENGTH_ERROR

MNMN gate, ACCUMULATE_RMI_TIME function

The ACCUMULATE_RMI_TIME function of the MNMN gate is used to accumulate all of the appropriate performance class DFHRMI timing fields.

Input parameters

[TRUE_NAME]
is the name of the CICS resource manager being used by your transaction.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER ABEND, LOOP
EXCEPTION INVALID_MONITORING_TOKEN

MNSR gate, SET_MCT_SUFFIX function

The SET_MCT_SUFFIX function of the MNSR gate is used to identify to the monitoring domain the suffix of the monitoring control table (MCT).

Input parameters

SUFFIX
is the 2-character MCT suffix.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION MCT_NOT_FOUND

MNSR gate, SET_MONITORING function

The SET_MONITORING function of the MNSR gate is used to set the monitoring classes on or off and to change the monitoring options.

Input parameters

[CONVERSE]
indicates if a transaction performance class record is to be produced for conversational tasks for each pair of terminal control I/O requests. It can have either of these values:
YES|NO
[EXCEPTION_STATUS]
indicates the exception class monitoring setting. It can have either of these values:
ON|OFF
[FREQUENCY]
is the interval for which monitoring automatically produces a transaction performance class record for any long-running transaction. Frequency times are 0, or in the range 000100 through 240000. The default frequency value is 0, which means that frequency monitoring is inactive.
[MONITORING_STATUS]
indicates the monitoring status setting. It can have either of these values:
ON|OFF
[PERFORMANCE_STATUS]
indicates the performance class monitoring setting. It can have either of these values:
ON|OFF
[RESOURCE_STATUS]
indicates the transaction resource class monitoring setting. It can have one of the following values:
ON|OFF
[SUBSYSTEM_ID]
specifies the 4-character subsystem-id to be used in the MVS™ workload activity records. The default is the first four character of the generic applid.
[SYNCPOINT]
indicates if a transaction performance class record is to be produced when a transaction takes an explicit or implicit syncpoint (unit-of-work). It can have either of these values:
YES|NO
[TIME]
indicates whether the monitoring timestamp fields returned on the INQUIRE_MONITORING_DATA function are to be in GMT or Local time. It can have either of these values:
GMT|LOCAL

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION INVALID_FREQUENCY

MNSR gate, INQ_MONITORING function

The INQ_MONITORING function of the MNSR gate is used to enquire on the monitoring classes and the monitoring options.

Input parameters

None.

Output parameters

CONVERSE
indicates if a transaction performance class record is to be produced for conversational tasks for each pair of terminal control I/O requests. It can have either of these values:
YES|NO
EXCEPTION_STATUS
indicates whether exception class monitoring is active. It can have either of these values:
ON|OFF
FREQUENCY
is the interval for which monitoring automatically produces a transaction performance class record for any long-running transaction. Frequency times are 0, or in the range 000100 through 240000. The default frequency value is 0, which means that frequency monitoring is inactive.
MONITORING_STATUS
indicates whether monitoring is active. It can have either of these values:
ON|OFF
PERFORMANCE_STATUS
indicates whether performance class monitoring is active. It can have either of these values:
ON|OFF
RESOURCE_STATUS
indicates whether transaction resource class monitoring is active. It can have one of the the following values:
ON|OFF
SUBSYSTEM_ID
specifies the 4-character subsystem-id to be used in the MVS workload activity records. The default is the first four character of the generic applid. implicit syncpoint (unit-of-work).
SYNCPOINT
indicates if a transaction performance class record is to be produced when a transaction takes an explicit or implicit syncpoint (unit-of-work). It can have either of these values:
YES|NO
TIME
indicates whether the monitoring timestamp fields returned on the INQUIRE_MONITORING_DATA function are to be in GMT or Local time. It can have either of these values:
GMT|LOCAL
APPLICATION_NAMING
indicates whether application naming support is enabled in the CICS region. It can have either of these values:
YES|NO
RMI_STATUS
indicates whether additional monitoring performance class data is required for the resource managers used by your transaction. It can have either of these values:
YES|NO
FILE_LIMIT
specifies the maximum number of files for which you want CICS to perform transaction resource monitoring. It can have a value in the range 1 through 64.
TSQUEUE_LIMIT
specifies the maximum number of temporary storage queues for which you want CICS to perform transaction resource monitoring. It can have a value in the range 1 through 32.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or EXCEPTION. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION SUBSYSTEM_ID_NOT_AVAILABLE

MNXM gate, TRANSACTION_INITIALIZATION function

The TRANSACTION_INITIALIZATION function of the MNXM gate is used to inform the monitoring domain of a transaction attach request so that the monitoring domain can allocate task monitoring storage.

Input parameters

TASK_ATTACH_TIME
is the time when this task was attached.
TCLASS_DELAY_TIME
is the time this task was delayed due to the transaction class (if any) limit for this transaction being reached.
MXT_DELAY_TIME
is the time this task was delayed due to the maximum user task limit (MXT) being reached.
INITIAL_DISPATCH_TIME
is the time when this task was first dispatched after attach.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
INVALID_MONITORING_TOKEN
LOOP

MNXM gate, TRANSACTION_TERMINATION function

The TRANSACTION_TERMINATION function of the MNXM gate is used to inform the monitoring domain of a transaction detach request, so that the monitoring domain can report on task monitoring information and then release the storage.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
INVALID_MONITORING_TOKEN
LOOP
[[ Contents Previous Page | Next Page Index ]]