10. MODIFICATION › 10.2 Standard User Exits › 10.2.4 Input Exits
10.2.4 Input Exits
The CA MICS Batch and Operations Analyzer standard user exits
are invoked during phase 1 of the daily update processing
flow. They have access to the entire SMF record.
Each exit description includes the name and title, a
statement of its purpose, when it is invoked, and whether it
has an interface to CA MICS Accounting and Chargeback. It
also shows which data elements are available and any special
considerations. The list of exits is organized
alphabetically.
+---------------+
| U S R S M U G | - Input SMF type 89 Usage Data Records
+---------------+
DESCRIPTION: USRSMUG allows access to the SMF type 89 Usage
Data record to enable a user to input or derive additional
data elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim BATMUG00 file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is normally used to add new data elements
from variables in this record.
ELEMENTS AVAILABLE: SMF input record type 89.
CPUMODL - CPU Model Identification
CPUSERAL - CPU Serial Number
CPUVERSN - CPU Version Number
MUPROD - Software Product Name
MUVER - Software Product Version
MUGCPUTM - Product CPU (TCB+SRB) Time
MUGSRBTM - Product SRB CPU Time
MUGTCBTM - Product TCB CPU Time
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim BATMUG00 file.
The USRSMUG exit serves as both an input exit for the SMF
type 89 Usage Data record and the output exit for the
Measured Usage Global (BATMUG) file.
You can use this exit to compute a service unit data element
from MUGCPUTM. IBM's IFAURP usage report program contains an
internal table that lists a CPU-time to service-unit factor
for each machine that supports measured usage license
charging. These factors, used for each system (SYSID)
encountered, are listed in the IFAURP report program.
+---------------+
| U S R S S F A | - Input SMF type 25 JES3 Allocation Records
+---------------+
DESCRIPTION: USRSSFA allows access to the SMF type 25
record to enable a user to input or derive additional data
elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim SMFT25 file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is normally used to add new data elements
from variables in this record.
ELEMENTS AVAILABLE: SMF input record type 25.
SMF25UIF - User Information Field, eight characters
CODING RESTRICTIONS: Only applicable to JES3 environments.
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFT25 file.
+---------------+
| U S R S S F I | - Input SMF type 30 subtype 1 Initiation
+---------------+ Records
DESCRIPTION: USRSSFI allows access to the type 30 subtype 1
record to enable a user to input or derive additional data
elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim SMFINIT file.
ACCOUNTING INTERFACE: No interface is provided.
USES: Normally this exit is used to access the SMF20UIF
field. The most common usage is found when an installation
has a security package other than RACF. The security package
may place the user ID in the SMF20UIF field. This exit can
be used to place that field in the RACFUSID field.
ELEMENTS AVAILABLE: SMF input records type 30 subtype 1.
SMF20UIF - User Information Field, eight characters
ACTFLD1-ACTFLD5 - Account fields, 20 characters each
NUMACT - Number of Account fields
CODING RESTRICTIONS: None.
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFINIT file.
SAMPLE USER EXIT: ACF2 is used instead of RACF, and the user
wants to input the SMF20UIF field and place it in RACFUSID.
This assumes that the user has specified RACF in the SMF DB
Cluster definitions (or else RACFUSID would not be saved in
the database).
MACRO _USRSSFI
/******************************************/
/* Move ACF2 User ID into RACFUSID field */
/******************************************/
RACFUSID = SMF20UIF;
%
+---------------+
| U S R S S F J | - Input SMF type 30 subtype 5 Job
+---------------+ Termination Records
DESCRIPTION: USRSSFJ allows access to the SMF type 30
subtype 5 record to enable a user to input or derive
additional data elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to
output of the interim SMFJOB file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to input additional variables.
ELEMENTS AVAILABLE: SMF input records type 30 subtype 5.
ACTFLD1-ACTFLD5 - Account fields, 20 characters each
NUMACT - Number of Account fields
SMF5UIF - User Information Field, eight characters
PGMTYPE - Program type field
CODING RESTRICTIONS: None.
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFJOB file.
+---------------+
| U S R S S F M | - Input SMF type 30 subtypes 2, 3, and 4
+---------------+ Usage Data Segments
DESCRIPTION: USRSSFM allows access to Usage Data segments of
SMF type 30 subtypes 2 and 3 interval records and SMF type 30
subtype 4 step end records. This exit enables a user to
input or derive additional data elements that are to be
processed by CA MICS.
INVOCATION: This exit gains control immediately prior to
output of the interim SMFMUX file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to input additional variables,
normalize CPU time measurements, or prevent output of Usage
Data segments for specific products.
ELEMENTS AVAILABLE: Source record Usage Data segments from
SMF type 30 subtypes 2, 3, and 4.
MUPROD - Software Product Name
MUVER - Software Product Version
MUACPUTM - Product CPU (TCB+SRB) Time
MUASRBTM - Product SRB CPU Time
MUATCBTM - Product TCB CPU Time
PGMTYPE - Program type field
CODING RESTRICTIONS: None.
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFMUX file.
SAMPLE USER EXIT: To delete Usage Data segments if the
product measured is TSO/E or if the CPU time measures are
zero, code the following:
MACRO _USRSSFM
/******************************************/
/* Delete segment if 0 CPU time */
/* Delete segment if product is TSO/E */
/******************************************/
IF MUACPUTM=0 OR MUPROD='TSO/E' THEN SKIP_REC=1 ;
%
+---------------+
| U S R S S F O | - Input SMF type 30 subtypes 2, 3, and 4
+---------------+ Open Edition/MVS Process Segments
DESCRIPTION: USRSSFO allows access to Open Edition/MVS
process segments of SMF type 30 subtypes 2 and 3 interval
records and SMF type 30 subtype 4 step end records. This
exit enables a user to input or derive additional data
elements that are to be processed by CA MICS, or to delete
unwanted segments preventing output to the BATOEP file
and preventing summarization of the process metrics to the
step and job level.
INVOCATION: This exit gains control immediately prior to
output of the interim SMFOEX file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to input additional variables,
modify data elements, or prevent output of Open Edition/MVS
process segments.
ELEMENTS AVAILABLE: Source record Usage Data segments from
SMF type 30 subtypes 2, 3, and 4.
OEPGID - OE/MVS Process Group ID
OEPPID - OE/MVS Process ID
OEPPPID - OE/MVS Parent Process ID
OEPSID - OE/MVS Process Session ID
OEPUGID - OE/MVS Process User Group ID
OEPUID - OE/MVS Process User ID
PGMTYPE - Program type field
CODING RESTRICTIONS: None.
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFOEX file.
SAMPLE USER EXIT: To delete Usage Data segments if the
Open Edition/MVS process ID is 12345, code the following:
MACRO _USRSSFO
/******************************************/
/* Delete segment if process ID is 12345 */
/******************************************/
IF OEPPID=12345 THEN SKIP_REC=1 ;
%
+---------------+
| U S R S S R E | - Input SMF type 30 subtypes 2, 3, and 4
+---------------+ Multisystem Enclave Remote System Data
Segments
DESCRIPTION: USRSSRE allows access to Multisystem Enclave
Remote System Data activity segments of SMF type 30 subtypes
2 and 3 interval records and SMF type 30 subtype 4 step end
records. This exit enables a user to input or derive
additional data elements that are to be processed by CA MICS,
or to delete unwanted segments preventing output to the
BATREN file and preventing summarization of the activity
metrics to the step and job level.
INVOCATION: This exit gains control immediately prior to
output of the interim BATREX file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit MUST be used to assign a value to temporary
data element SYSIDRE. SYSIDRE later becomes the SYSID data
element in the Multisystem Enclave Activity (BATREN) file.
This exit can also be used to input additional variables,
modify data elements, or prevent output of Multisystem
Enclave Remote System activity segments.
This exit must be used to assign the logical SYSID value for
the system where the multisystem enclave executed. IBM does
not provide the ORGSYSID for multisystem enclave activity.
Instead, the system name for the multisystem enclave is
provided. You must provide SAS code in this exit that maps
the system name to the SYSID value that you want to appear in
the BATREN file. Also, you must store this logical SYSID
name in temporary data element SYSIDRE. See section
5.2.16.3, BATREN Usage Considerations, for information and
guidance on how to perform this mapping.
If you do not assign a value to SYSIDRE in this exit, CA MICS
assigns a value of UNKN (unknown), and this UNKN will be
the value that appears for SYSID in the BATREN file.
ELEMENTS AVAILABLE: Source record Usage Data segments from
SMF type 30 subtypes 2, 3, and 4.
RENRECNT - Multisystem Enclave Count
RENSYSNM - Using Address Space System Name
RENREDSU - Multisystem Dep Enclave Serv Units
RENREISU - Multisystem Ind Enclave Serv Units
RENCPDTM - Multisystem Dep Enclave CPU Time
RENCPITM - Multisystem Ind Enclave CPU Time
SYSIDRE - SYSID On Which Multisystem Enclave Executed
CODING RESTRICTIONS: None.
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim BATREX file.
SAMPLE USER EXIT: To delete Multisystem Enclave segments if
the multisystem enclave system name is missing.
MACRO _USRSSRE
/*******************************************/
/* Delete segment if system name is missing*/
/*******************************************/
IF RENSYSNM=. THEN SKIP_REC=1 ;
%
+---------------+
| U S R S S F P | - Input SMF type 26 JES2/JES3 Purge Records
+---------------+
DESCRIPTION: USRSSFP allows access to the SMF type 26
record to enable a user to input or derive additional data
elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim SMFPURG file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is normally used to add new data elements
from variables in this record.
ELEMENTS AVAILABLE: SMF input record type 26.
SMF26UIF - User Information Field, eight characters
SUBSYSID - Sub-system Identifier (JES2 or JES3)
SMF26JAF - Job Accounting field (JES3 only)
PGMTYPE - Program type field
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFPURG file.
+---------------+
| U S R S S F 4 | - Input SMF type 30 subtype 4 Step End
+---------------+ Records During Short Cut Processing
DESCRIPTION: USRSSF4 allows access to the data elements
listed below during DAY030 short-cut processing of SMF type
30 subtype 4 step end records. When both interval (subtypes
2 and/or 3) and step-end (subtype 4) records are present in
the raw SMF data, CA MICS always uses the interval records to
populate the database files. Certain step-level data
elements are only available from the subtype 4 step end
record, however, so all three record subtypes are processed
during the input phase.
When CA MICS encounters a subtype 4 step end record, a check
is made to see if the interval records for the step were
previously processed. If so, the subtype 4 record is
short-cut processed to extract only those fields unique to
the step-end record. A later data step merges this
information with the last subtype 3 record for the step.
- PGMSYSIN (Card Images Read By Reader)
- PGMICPNI (Number Of Initiator Instructions)
- PGMICPTM (Initiator CPU Time)
- PGMISRTM (Step Initiator SRB Time)
- PGMITCTM (Step Initiator TCB Time)
- PGMDSV (Data Space Storage Used)
INVOCATION: This exit gains control immediately prior to the
output of the interim SMFTP4 file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to access the elements listed.
ELEMENTS AVAILABLE: SMF input records type 30 subtype 4.
CODING RESTRICTIONS: None
SPECIAL NOTES: The same data elements listed above are
available in the USRSSFS exit when the SMF type 30 subtype
4 record undergoes normal rather than short cut processing.
+---------------+
| U S R S S F S | - Input SMF type 30 subtypes 2 and 3
+---------------+ Interval and SMF type 30 subtype 4 Step
Termination Records
DESCRIPTION: USRSSFS allows access to the SMF type 30
subtypes 2, 3, and 4 records to enable a user to input or
derive additional data elements that are to be processed by
CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim SMFSTEP or SMFSTEPC file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to access step record accounting
fields.
ELEMENTS AVAILABLE: SMF input records type 30 subtypes 2, 3,
and 4.
SACTFLD1-SACTFLD5 - Account fields, 20 characters each
NUMACT - Number of Account fields
SMF4UIF - User Information Field, eight characters
PGMTYPE - Program type field
PGMINTVL - Interval record type
(when PGMINTVL = SE22 indicates type 30 subtype 2
PGMINTVL = SE23 indicates type 30 subtype 3
PGMINTVL = SE24 indicates type 30 subtype 4
NUMDD - Number of DD records
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFSTEP file.
+---------------+
| U S R S S T 6 | - Input SMF type 30 subtype 6 system
+---------------+ address space cumulative interval records
DESCRIPTION: USRSST6 allows access to the SMF type 30
subtype 6 record to enable a user to input or derive
additional data elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim WORK.BATSFT00 file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to delete specific system
address spaces during input, or to modify or input addition
fields from the raw SMF type 30 subtype 6 record.
ELEMENTS AVAILABLE: SMF input records type 30 subtype 6
PGMTYPE - Program type field (always 6)
PGMINTVL - Interval record type (always SE26)
Job - Job Name
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFSTEP file.
+---------------+
| U S R S S F T | - Input SMF type 33 APPC/MVS TP Accounting
+---------------+ Records
DESCRIPTION: USRSSFT allows access to the SMF type 33
APPC/MVS TP accounting records and enables a user to input or
derive additional data elements that are to be processed by
CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim BATSFT file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit can be used to access all fields found in
the SMF type 33 APPC/MVS TP accounting record.
ELEMENTS AVAILABLE: SMF input record type 33
ACTFLD1-ACTFLD5 - Account fields, 20 characters each
NUMACT - Number of Account fields
ATPTYPE- TP Type (STP/MTP/MSH)
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim BATSFT file.
+---------------+
| U S R S S F W | - Input SMF type 6 Sysout Records
+---------------+
DESCRIPTION: USRSSFW allows access to the SMF type 6 record
to enable a user to input or derive additional data elements
that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim SMFWTR file.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is normally used to add elements from the
type 6 record, such as microfiche counts and additional
routing information.
ELEMENTS AVAILABLE: SMF input record type 6.
SMF6UIF - User Information Field, eight characters
SUBSYSID - Subsystem Identification (JES2, JES3, or PSF)
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim SMFWTR file.
+---------------+
| U S R D M A P | - Input SMF type 30 SMF Records
+---------------+
DESCRIPTION: USRDMAP allows access to the SMF type 30 record
EXCP segments to enable a user to input or derive additional
data elements that are to be processed by CA MICS.
INVOCATION: This exit gains control immediately prior to the
output of the interim BATXCP and SMFWDC files.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is normally used to add elements from the
type 30 record, EXCP segment such as DDNAME and block size
information.
ELEMENTS AVAILABLE: SMF input record type 30 EXCP segment
DCLASS - Device class
DEVNAME - Device address
DDNAME - DDNAME in JCL
CODING RESTRICTIONS: None
SPECIAL NOTES: Setting SKIP_REC = ONE will prevent the
observation from being output to the interim BATXCP and
SMFWDC files, which will impact the BATWDA in the DETAIL
and DAYS timespan.
Copyright © 2014 CA.
All rights reserved.
|
|