10. MODIFICATION › 10.2 Standard User Exits › 10.2.5 Output Exits

10.2.5 Output Exits

 
 This section provides an in-depth description of the standard
 user exits that are invoked during phase 3 of the daily
 update processing flow. The exits are organized
 alphabetically.
 
 Each exit description includes the user exit name and title,
 a description of its purpose, when it is invoked, and whether
 it has an interface to CA MICS Accounting and Chargeback. The 
 description also shows what data elements are available and 
 any special considerations.

 +---------------+
 | U S R S A T P | - APPC/MVS Transaction File Exit
 +---------------+
 
 DESCRIPTION:  USRSATP allows access to the data elements
 used to build the records in the APPC/MVS Transaction File
 (BATATP).
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the APPC/MVS Transaction File.
 
 ACCOUNTING INTERFACE:  This exit is used if APPC/MVS
 transaction billing has been specified.
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the APPC/MVS Transaction
 File.
 
     ACTFLD1-ACTFLD5 - Account fields, 20 characters each
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S A V L | - Systems Availability File Exit
 +---------------+
 
 DESCRIPTION:  USRSAVL allows access to the data elements used
 to build the records in the Operations Availability File.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Systems Availability File.
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add or change data elements in
 type 90 subtype 8 record, which is used to build the record
 for the Operations Availability File.
 
 ELEMENTS AVAILABLE:  Source record type 90 subtype 8.
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S C O N | - Operations Configuration File Exit
 +---------------+
 
 DESCRIPTION:  USRSCON allows access to the data elements
 used to build the records in the Operations Configuration
 File.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Operations Configuration File
 (OPSCON).
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add or change data elements in
 type 8, 9, 10, 11, and 22 records, which are used to build
 the Operations Configuration File.
 
 ELEMENTS AVAILABLE:  Source record types 8, 9, 10, 11, and
 22.
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S I N T | - Batch Job Initiation Exit
 +---------------+
 
 DESCRIPTION:  USRSINT is designed to allow the initialization
 of user-defined job-level data elements.
 
 INVOCATION:  This exit gains control in the code that
 initiates the accumulation of program data elements to the
 job level.
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to initialize accumulated job-level
 user-defined data elements.
 
 ELEMENTS AVAILABLE:  Elements in the Batch User Job Activity
 File (BATJOB).
 
     ACTFLD1-ACTFLD5 - Account fields, 20 characters each
     NUMACT - Number of Account fields
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  CA MICS allows you to add data elements to
 the SMF files for program-level and job-level retention.  You
 can accumulate program data up to the job level by adding the
 program data element into a job-level data element.  With
 existing program-level exit facilities, there is no
 convenient way to reset a job-level data accumulator at the
 beginning  of program data accumulation for the job.  This
 exit is executed at the time the standard CA MICS BATJOB file
 data elements and user counters are reset at the beginning of
 job data accumulation.  If you do not use a CA MICS user
 counter element to contain the added accumulated information,
 the accumulator must be reset in this exit.
 
 Typical implementation of the exit is:
 
            MACRO _USRSINT
              USRJOBD1 = 0;
            %
 

 +---------------+
 | U S R S J O B | - Output Job File Exit (BAT, TSO, STC, and
 +---------------+   APPC)
 
 DESCRIPTION:  USRSJOB allows access to the interim SMF job
 file to enable the user to add or change data elements on the
 BATJOB file.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Batch User Job Activity File
 (BATJOB) or Batch User Job Suspend File (BAT_JS).  All
 records for the merge of the job file have been processed and
 the last records from each file are available:  job, step,
 writer, initiator, type 25, and purge.
 
 ACCOUNTING INTERFACE:  This exit is used if job costing has
 been specified.
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the Batch User Job Activity
 File (BATJOB).
 
     ACTFLD1-ACTFLD5 - Account fields, 20 characters each
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S M U A | - Measured Usage Address Space File Exit
 +---------------+
 
 DESCRIPTION:  USRSMUA allows access to the interim Measured
 Usage Address Space file to enable the user to add or change
 data elements on the BATMUA file.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Measured Usage Address Space File
 (BATMUA).
 
 ACCOUNTING INTERFACE:  This exit is used if measured usage
 costing has been specified.
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the Measured Usage Address
 Space File (BATMUA).
 
     MUPROD   - Software Product Name
     MUVER    - Software Product Version
     MUACPUTM - Address Space MU TCB+SRB CPU Time
     MUASRBTM - Address Space MU SRB CPU Time
     MUATCBTM - Address Space MU TCB CPU Time
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None

 +---------------+
 | U S R S M U G | - Output Measured Usage Global File Exit
 +---------------+
 
 DESCRIPTION:  USRSMUG allows access to the interim Measured
 Usage Global File to enable the user to add or change data
 elements on the BATMUG file.
 
 INVOCATION:  This exit gains control immediately before the
 output of the interim BATMUG00 file.
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Source 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 prevents 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 a service-unit factor
 for each machine that supports measured usage license
 charging.  These factors, which are used for each system (SYSID)
 encountered, are listed in the IFAURP report program.
 

 +---------------+
 | U S R S O E P | - Open Edition/MVS Process Activity File
 +---------------+   Exit
 
 DESCRIPTION:  USRSOEP allows access to the Open Edition/MVS
 Process Activity file to enable the user to add or change
 data elements on the BATOEP file.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Open Edition/MVS Process Activity
 File (BATOEP).
 
 ACCOUNTING INTERFACE:  None
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the Open Edition/MVS Process
 Activity File (BATOEP).
 
     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
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None

 +---------------+
 | U S R S O P I | - Operations Incident File Exit
 +---------------+
 
 DESCRIPTION:  USRSOPI allows access to the data elements
 used to build the records in the Operations Incident File.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Operations Incident File (OPSOPI).
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add or change data elements in
 type 0, 7, 23, 31, 43, 45, and 90 records, which are used to
 build the record for the Operations Incident File.
 
 ELEMENTS AVAILABLE:  Source record types 0, 7, 23, 31, 43,
 45, and 90.
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S P G M | - Output Program File Exit (BAT, TSO, STC,
 +---------------+   APPC, Open Edition (UNIX), and System
                     Address Spaces)
 
 DESCRIPTION:  USRSPGM allows access to the interim SMF step
 file to enable the user to add or change data elements on the
 BATPGM and parallel step/interval files.
 
 INVOCATION:  This exit gains control immediately before  the
 output of a record to the Batch User Program Activity File
 (BATPGM), System Task Program Activity File (BAT_ST), SMF
 User TSO Activity File (BAT_TS), APPC/MVS TP Activity File
 (BAT_TP), Open Edition/MVS Program File (BAT_OE), or System
 Address Space Activity (BAT_SA) File.
 
 ACCOUNTING INTERFACE:  This exit is used if step costing has
 been specified.
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the BATPGM file.
 
     PROGRAM           - Program Name
   * SACTFLD1-SACTFLD5 - Step Account fields, 20 characters
                         each
 
   * Not available for the BAT_SA file
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S R E N | - Multisystem Enclave Activity File Exit
 +---------------+
 
 DESCRIPTION:  USRSREN allows access to the Multisystem
 Enclave Activity file to enable the user to add or change
 data elements on the BATREN file.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Multisystem Enclave Activity File
 (BATREN).
 
 ACCOUNTING INTERFACE:  None
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the Multisystem Enclave
 Activity File (BATREN).
 
     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
     RENLSYID - Using Address Space SYSID
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  None
 

 +---------------+
 | U S R S S P L | - Output Spool File Exit
 +---------------+
 
 DESCRIPTION:  USRSSPL allows access to the interim SMF work
 files and all their variables to enable the user to add or
 change data elements that are to be processed by CA MICS.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Batch User Spool Activity File
 (BATSPL).
 
 ACCOUNTING INTERFACE:  This exit is used if spool costing has
 been specified.
 
 USES:  This exit is used to add or change data elements in
 the record.
 
 ELEMENTS AVAILABLE:  Elements in the Batch Spool Activity
 File.  In addition, elements from other record types can be
 available for testing while in this exit.  The element
 SPLMASK shows you which other record types are associated
 with the SMF type 6 output writer record that is being
 processed in the USRSSPL exit.  The following element list
 represents a few of the data elements that are available
 in the USRSSPL exit.  
Note: ACTFLD1-ACTFLD5 are only
 available if the output writer record is associated with
 either an SMF type 30 job initiation record, SMF type 30 job
 end record, BATSFH file observation, or an SMF type 26 purge
 record.  
Refer to the data dictionary entry for SPLMASK to
 determine how to interpret the data element contents.
 
     ACTFLD1-ACTFLD5 - Account fields, 20 characters each
     SPLWTRTS        - Spool writer start timestamp
     WENDTS          - End of Writer timestamp
     SMF6UIF         - execution timestamp
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  Setting FLUSHJOB=ONE deletes this job from
 the BATJOB but not from the BATPGM, BATSPL, or BATWDA files.
 
 If your site uses SMF6UIF records in its ACCTRTE, 
 reset the values of the ACCTNOx variables using this exit.
 At the time ACCTRTE is entered, you only have access to the
 first of what could be many output records for a job.
 
 SAMPLE USER EXIT:  This exit can be used to calculate
 individual print queue times.  In this example, file
 tailoring has been used to add the element SPLENQTM to the
 Batch User Spool Activity File.
 
 MACRO _USRSSPL
 /********************************************/
 /* Calculate Print Queue Time */
 /********************************************/
 IF IN_JOB THEN DO;
 SPLENQTM = SPLWTRTS - JOBENDTS;
 IF SPLENQTM LT 0 THEN SPLENQTM = 0;
 /* NOTE - IF FREE=CLOSE USED THEN
 SYSOUT COULD PRINT PRIOR TO JOB END */
 END;
 %

 +---------------+
 | U S R S W D A | - Batch WDA File Exit - DAYS timespan
 +---------------+
 
 DESCRIPTION:  USRSWDA allows access to the SMF type 30
 subtype 2, 3, or 4 EXCP sections to enable the user to input
 or derive additional data elements that are to be processed
 by CA MICS in the DAYS timespan only.
 
 INVOCATION:  This exit gains control immediately before the
 output of a record to the Batch Workload Device Activity
 File (BATWDA).
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add new data elements from
 variables in these records.
 
 ELEMENTS AVAILABLE:  Source record type 30 subtypes 2, 3, or
 4.  Elements in the BATWDA file.
 
     ACTFLD1-ACTFLD5 - Account fields, 20 characters each
     NUMACT - Number of Account fields
     PGMTYPE - Program Type Field
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  Setting SKIP_REC = ONE will drop the record
 from the Batch Workload Device Activity File.  The totals
 from the records, however, are still added to the step and
 job records.
 
 SAMPLE USER EXIT:  This exit can be used to delete unit
 record and graphics devices.
 
 MACRO _USRSWDA;
 /*******************************************/
 /* Delete unit record and graphics         */
 /* devices from BATWDA file in DAYS        */
 /*******************************************/
 IF DEVCLASS='GRAPHICS' OR DEVCLASS='UNIT-REC'
 THEN SKIP_REC=ONE;
 %

 +---------------+
 | U S R X W D A | - Batch WDA File Exit - DETAIL timespan
 +---------------+
 
 DESCRIPTION:  USRXWDA allows access to the SMF type 30
 subtype 2, 3, or 4 EXCP sections to enable the user to input
 or derive additional data elements that are to be processed
 by CA MICS.  The USRXWDA exit, however, only impacts the
 DETAIL timespan BATWDA file.  You cAN restrict DETAIL BATWDA
 timespan reporting to include only specific devices or device
 types without any effect on higher BATWDA timespan files.
 
 INVOCATION:  This exit is invoked during the initial output
 to the Batch Workload Device Activity File (BATWDA).
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add new data elements from
 variables in these records.
 
 ELEMENTS AVAILABLE:  Source record type 30 subtypes 2, 3, or
 4.  Elements in the BATWDA file.
 
     DEVCLASS - Device Class
     DEVADDR  - Device Address
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  Setting SKIP_REC = ONE dropS the record
 from the Batch Workload Device Activity File.  The totals
 from the records, however, are still added to the step and
 job records.
 
 SAMPLE USER EXIT:  This exit can be used to delete unit
 record and graphics devices.
 
 MACRO _USRXWDA;
 /*******************************************/
 /* Delete unit record and graphics         */
 /* devices from BATWDA file in DETAIL      */
 /*******************************************/
 IF DEVCLASS='GRAPHICS' OR DEVCLASS='UNIT-REC'
 THEN SKIP_REC=ONE;
 %

 +---------------+
 | U S R D W D A | - Batch WDA File Exit - DAYS timespan
 +---------------+
 
 DESCRIPTION:  USRDWDA allows access to the SMF type 30
 subtype 2, 3, or 4 EXCP sections to enable the user to input
 or derive additional data elements that are to be processed
 by CA MICS.  The USRDWDA exit, however, only impacts the DAYS
 timespan BATWDA file.  You CAN restrict DAYS BATWDA timespan
 reporting to only include specific devices or device types
 without any effect on higher BATWDA timespan files.
 
 INVOCATION:  This exit is invoked during the initial output
 to the Batch Workload Device Activity File (BATWDA) in the
 DAYS timespan.
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  This exit is used to add new data elements from
 variables in these records.
 
 ELEMENTS AVAILABLE:  Source record type 30 subtypes 2, 3, or
 4.  Elements in the BATWDA file.
 
     DEVCLASS - Device Class
     DEVADDR  - Device Address
 
 CODING RESTRICTIONS:  None
 
 SPECIAL NOTES:  Setting SKIP_REC = ONE dropS the record
 from the Batch Workload Device Activity File.  The totals
 from the records, however, are still added to the step and
 job records.
 
 SAMPLE USER EXIT:  This exit can be used to delete unit
 record and graphics devices.
 
 MACRO _USRDWDA;
 /*******************************************/
 /* Delete unit record and graphics         */
 /* devices from BATWDA file in DAYS        */
 /*******************************************/
 IF DEVCLASS='GRAPHICS' OR DEVCLASS='UNIT-REC'
 THEN SKIP_REC=ONE;
 %

 +---------------+
 | U S R U J B J | - Accounting Job File Exit (BAT, TSO, STC,
 +---------------+   and APPC)
 
 DESCRIPTION:  USRUJBJ is used by CA MICS Accounting and
 Chargeback and is not typically available to the user.
 
 
 +---------------+
 | U S R U J B M | - Accounting Measured Usage Charging File
 +---------------+   Exit
 
 DESCRIPTION:  USRUJBM is used by CA MICS Accounting and
 Chargeback and is not typically available to the user.
 
 
 +---------------+
 | U S R U J B P | - Accounting Program File Exit (BAT, TSO,
 +---------------+   STC, and APPC, OE (UNIX), and System
                     Address Spaces)
 
 DESCRIPTION:  USRUJBP is used by CA MICS Accounting and
 Chargeback and is not typically available to the user.
 
 
 +---------------+
 | U S R U J B S | - Accounting Spool File Exit
 +---------------+
 
 DESCRIPTION:  USRUJBS is used by CA MICS Accounting and
 Chargeback.
 
 
 +---------------+
 | U S R U J T P | - Accounting APPC/MVS Transaction Exit
 +---------------+
 
 DESCRIPTION:  USRUJTP is used by CA MICS Accounting and
 Chargeback.
 
 +---------------+
 | U S R T f f f |  DETAIL Tape Data Selection Exit
 +---------------+
 
 DESCRIPTION:  The USRTfff exits provide access to DETAIL file
 records before their output to DETAIL tape data sets.  See
 Chapter 7 [Winst081]of this guide for information about DETAIL tape
 processing and a list of eligible component files.
 
 INVOCATION:  The USRTfff exit is invoked before output to
 DETAIL tape files.
 
 ACCOUNTING INTERFACE:  No interface is provided.
 
 USES:  Use this exit to limit the amount of data that is
 written to DETAIL tape files, or to modify the contents of
 data elements written to DETAIL tape files.  
Note:   USRTfff exit code only affects the DETAIL tape file content
 for a particular file (fff). This exit has no impact on the normal
 unit database content for the same file (fff).
 
 ELEMENTS AVAILABLE:  All elements in the DETAIL timespan of
 the file.
 
 ACTIVATION:  The USRTfff exits are invoked using the indirect
 exit convention described in section 4.3.1.2 of the System
 Modification Guide.  See this section for a detailed
 discussion of indirect exit coding.
 
 All of the USRTfff indirect exits are activated in
 sharedprefix.MICS.SOURCE($cccEXIT).  In $cccEXIT, you will
 find the following statement for each file (fff) eligible for
 DETAIL tape:
 
     %LET USRTfff = ;
 
 The exit is activated by providing a member name to the right
 of the equal sign:
 
     %LET USRTfff = exitname ;
 
 If you code an exitname, you MUST create a member in each
 unit's prefix.MICS.USER.SOURCE library with that name.
 Provide valid SAS code in the member.  This code is
 invoked before the output of records to the DETAIL tape
 file.
 
 Example:
 
    sharedprefix.MICS.SOURCE(#SMFEXIT):
 
      %LET USRTWDA = WDATEXIT ;
 
    prefix.MICS.USER.SOURCE(WDATEXIT):
 
      IF DEVADDR EQ 'ADE1' THEN SKIP_REC=1 ;
 
 In this example, WDATEXIT was chosen as the name for the
 DETAIL tape exit for the BATWDA file.  Member WDATEXIT was
 created in the unit level prefix.MICS.USER.SOURCE library for
 each unit where DETAIL tape was activated for the BATWDA
 file.
 
 The exit was coded to limit the records that arewritten to the DETAIL
 tape file to where device address is ADE1.
 
 Note:  The exit member name must be identical in each unit's
 prefix.MICS.USER.SOURCE library, but the contents of each
 member can be different (or identical) for each unit.
 
 CODING RESTRICTIONS:  Ensure that you have activated DETAIL
 tape processing for a file, and executed SMFPGEN before
 activating and coding USRTfff exits.
[Winst081]Standard is to use chapter name and not chapter number.