IBM IVT Information Area Output Exits
This section provides descriptions of the VTS component standard user output exits that are invoked during the output phase of daily update processing for the IBM Virtual Tape Subsystem Information Area (IVT) files.
micsrm140
This section provides descriptions of the VTS component standard user output exits that are invoked during the output phase of daily update processing for the IBM Virtual Tape Subsystem Information Area (IVT) files.
Contents
General Information For Output Exits
Each exit description includes the user exit name and title, a description of its purpose, and when it is invoked. It also shows which data elements are available and any special considerations.
Exit code must not issue either RETURN or DELETE statements since their invocation assumes the entire DATA step will be executed.
Exit code can set SKIP_REC = 1 to prevent the current observation from being written to the output file.
All VTS component output exits use the indirect form of exit invocation. For general information on indirect exits, see Indirect Exit Points.
Output Exits For The IVT Information Area Files
Two types of output exits are available for each IVT Information Area file:
- USRSfff exits
- - invoked before output to WORK.IVTfff
- USRDfff exits
- - invoked before output to DAYS.IVTfff
IVT Information Area USRSfff Exits
All IVT Information Area USRSfff exits are invoked when the raw data record is still in the input buffer. They generally have access to DETAIL timespan data elements for their respective files, regardless of the element activation status (on or off). Data elements turned off in the DETAIL timespan are not kept in the file, but in most cases were populated during the input record parsing. The exception is data elements for IBM VTS data associated with IBM microcode level F/C 4001 and Outboard Policy Management. Refer to the data dictionary entries to determine if an element is dependent on microcode levels or Outboard Policy Management.
For IBM VTS data, the VTS component processing logic selects a representative hour for each VTS from all z/OS systems reporting on the VTS. This is not done, however, until after the initial IVTfff WORK files have been created. If data elements are modified, changed, or added, the USRSfff exit code must not rely on SYSID as a criteria for selecting elements to update.
For example, the following USRSfff exit code would yield unpredictable results because the VTS observation generated by z/OS system 'SYSA' may not be the representative record chosen for VTSID 'VTS01' by the component processing logic:
IF SYSID='SYSA' and VTSID='VTS01' THEN ELEMENT=ELEMENT*2 ;
The next example would work correctly because all observations for VTSID 'VTS01' would be updated without regard to the z/OS system ID. The representative hourly record for VTSID 'VTS01' chosen by the component processing logic would not matter because all records are updated by the exit code:
IF VTSID='VTS01' THEN ELEMENT=ELEMENT*2 ;
To minimize WORK space requirements, derived data elements are not computed prior to output to the WORK files. If USRSfff exit code must examine derived data element values, the %fffDERV(TS=DETAIL) macro can be used to compute the derived data element values within the USRSfff exits. If the %fffDERV macro is invoked, the derived data elements will be computed, but not kept in the WORK file.
All modifications made in the USRSfff exits are propagated from the WORK files to the
MICS
database files.USRSIEX
Exit Prior to Output of WORK.IVTIEX
Description
The USRSIEX exit allows access to the data elements used to create VTS Import/Export Statistics (IVTIEX) WORK file observations. At the point where this exit is invoked, the observation contains the hourly import/export statistics for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTIEX file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTIEX file. In addition, individual IVTIEX observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTIEX file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSPTU
Exit Prior to Output of WORK.IVTPTU
Description
The USRSPTU exit allows access to the data elements used to create VTS Physical Drive Activity (IVTPTU) WORK file observations. At the point where this exit is invoked, the observation contains the hourly physical tape drive statistics for the device type indicated by data element Physical Tape Drive Type (IVTDCI) for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTPTU file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTPTU file. In addition, individual IVTPTU observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTPTU file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSTCA
Exit Prior to Output of WORK.IVTTCA
Description
The USRSTCA exit allows access to the data elements used to create VTS Tape Library Config and Activity (IVTTCA) WORK file observations. At the point where this exit is invoked, the observation contains the hourly physical tape drive statistics for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTTCA file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTTCA file. In addition, individual IVTTCA observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTTCA file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
coding restrictions
None
USRSVCL
Exit Prior to Output of WORK.IVTVCL
Description
The USRSVCL exit allows access to the data elements used to create VTS Composite Library Activity (IVTVCL) WORK file observations. At the point where this exit is invoked, the observation contains the hourly activity statistics for a peer-to-peer composite VTS library.
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTVCL file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTVCL file. In addition, individual IVTVCL observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTVCL file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSVCU
Exit Prior to Output of WORK.IVTVCU
Description
The USRSVCU exit allows access to the data elements used to create VTS Cache Usage Preference Level (IVTVCU) WORK file observations. At the point where this exit is invoked, the observation contains the hourly cache usage statistics for the preference ID represented by data element Cache Usage Preference Level Identifier (IVTCUPL) for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTVCU file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTVCU file. In addition, individual IVTVCU observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTVCU file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSVDL
Exit Prior to Output of WORK.IVTVDL
Description
The USRSVDL exit allows access to the data elements used to create VTS Distributed Library Activity (IVTVDL) WORK file observations. At the point where this exit is invoked, the observation contains statistics for the hourly activity for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTVDL file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTVDL file. In addition, individual IVTVDL observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTVDL file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSVPS
Exit Prior to Output of WORK.IVTVPS
Description
The USRSVPS exit allows access to the data elements used to create VTS Volume Pool Statistics (IVTVPS) WORK file observations. At the point where this exit is invoked, the observation contains the hourly volume pool statistics for the volume pool represented by data element Volume Pool Identifier (IVTVPN) for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTVPS file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTVPS file. In addition, individual IVTVPS observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTVPS file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRSVTC
Exit Prior to Output of WORK.IVTVTC
Description
The USRSVTC exit allows access to the data elements used to create VTS VTC Controller Detail (IVTVTC) WORK file observations. At the point where this exit is invoked, the observation contains the hourly controller statistics for the VTC controller represented by data element VTS VTC Number (IVTVTCNO) for a VTS peer-to-peer composite library.
Invocation
This exit gains control immediately prior to the output of a record to the WORK.IVTVTC file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the WORK.IVTVTC file. In addition, individual IVTVTC observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DETAIL timespan IVTVTC file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
IVT Information Area USRDfff Exits
All IVT Information Area USRDfff exits are invoked prior to output to the DAYS.IVTfff database file. Data elements active (turned on) in the DAYS timespan for the file (fff) are available for exit code manipulation. If derived data elements are kept on the file, they are also available in the exit.
The exception is data elements for IBM VTS data associated with IBM microcode level F/C 4001 and Outboard Policy Management. Refer to the data dictionary entries to determine if an element is dependent on microcode levels or Outboard Policy Management.
For IBM VTS data, the VTS component processing logic selects a representative hour for each VTS from all z/OS systems reporting on the VTS. At the point where the USRDfff exit is invoked, the representative hour has been selected. The SYSID of each observation is either 'SYS1' or the value specified using the VTSSYSID statement in prefix.MICS.PARMS(VTSOPS). For more information, see VTSSYSID Statement.
All modifications made in the USRDfff exits are propagated from the DAYS files to the WEEKS and higher summarization level files.
USRDIEX
Exit Prior to Output of DAYS.IVTIEX
Description
The USRDIEX exit allows access to the data elements used to create VTS Import/Export Statistics (IVTIEX) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with import/export statistics for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTIEX file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTIEX file. In addition, individual IVTIEX observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTIEX file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDPTU
Exit Prior to Output of DAYS.IVTPTU
Description
The USRDPTU exit allows access to the data elements used to create VTS Physical Drive Activity (IVTPTU) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with physical tape drive statistics, for the device type indicated by data element Physical Tape Drive Type (IVTDCI), for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTPTU file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTPTU file. In addition, individual IVTPTU observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTPTU file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDTCA
Exit Prior to Output of DAYS.IVTTCA
Description
The USRDTCA exit allows access to the data elements used to create VTS Tape Library Config and Activity (IVTTCA) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with physical tape drive statistics for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTTCA file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTTCA file. In addition, individual IVTTCA observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTTCA file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDVCL
Exit Prior to Output of DAYS.IVTVCL
Description
The USRDVCL exit allows access to the data elements used to create VTS Composite Library Activity (IVTVCL) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with activity statistics for a peer-to-peer composite VTS library.
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTVCL file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTVCL file. In addition, individual IVTVCL observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTVCL file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDVCU
Exit Prior to Output of DAYS.IVTVCU
Description
The USRDVCU exit allows access to the data elements used to create VTS Cache Usage Preference Level (IVTVCU) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with cache usage statistics, for the preference ID represented by data element Cache Usage Preference Level Identifier (IVTCUPL), for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTVCU file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTVCU file. In addition, individual IVTVCU observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTVCU file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDVDL
Exit Prior to Output of DAYS.IVTVDL
Description
The USRDVDL exit allows access to the data elements used to create VTS Distributed Library Activity (IVTVDL) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with activity statistics for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTVDL file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTVDL file. In addition, individual IVTVDL observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTVDL file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDVPS
Exit Prior to Output of DAYS.IVTVPS
Description
The USRDVPS exit allows access to the data elements used to create VTS Volume Pool Statistics (IVTVPS) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with volume pool statistics, for the volume pool represented by data element Volume Pool Identifier (IVTVPN), for a VTS distributed library (UI, secondary, or standalone).
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTVPS file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTVPS file. In addition, individual IVTVPS observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTVPS file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None
USRDVTC
Exit Prior to Output of DAYS.IVTVTC
Description
The USRDVTC exit allows access to the data elements used to create VTS VTC Controller Detail (IVTVTC) DAYS file observations. At the point where this exit is invoked, the observation is a representative hour with controller statistics, for the VTC controller represented by data element VTS VTC Number (IVTVTCNO), for a VTS peer-to-peer composite library.
Invocation
This exit gains control immediately prior to the output of a record to the DAYS.IVTVTC file.
Uses
This exit can be used to examine, modify, or assign values to data elements prior to output to the DAYS.IVTVTC file. In addition, individual IVTVTC observations can be prevented from output by setting element SKIP_REC=1 ;
Elements Available
All DAYS timespan IVTVTC file data elements specified in sharedprefix.MICS.GENLIB(VTSGENIN).
Coding Restrictions
None