10. MODIFICATION › 10.2 Standard User Exits
10.2 Standard User Exits
At times, additional system customization is needed to tailor
CA MICS to your installation. There are many user exit
points provided within CA MICS. Each of these points
corresponds to a position in the CA MICS logic where user
modification:
o is likely to occur, based on our experience
o presents only a slight possibility of compromising the
CA MICS data base or operational integrity, and
o is relatively easy to document and understand.
Using the CA MICS exit facilities to augment CA MICS
processing logic is the safest method of system modification.
Generally, the CA MICS System Administrator has four methods
by which CA MICS can be augmented, changed, and enhanced by
the user.
o CA MICS standard option and parameter definitions
The diverse installation and definition options provide
most users with adequate provisions for customizing
CA MICS.
o Modification through user exits
Often there may be installation-dependent requirements
that are not adequately addressed through the standard
options and parameters. In these cases, one or more of
the user exits provided with CA MICS may be used to
insert user-written routines that satisfy the
requirements.
o Extension through user-written components
Although most users do not initially consider this a
way of modifying a standard CA MICS component, the
development of user-written components may be the most
advantageous method. For example, often it may be
better to write a user component to handle additional
SMF data than to attempt to modify the logic of the SMF
Component.
o System code modification
Finally, if all else fails, the user may be able to
satisfy the installation's requirements by implementing
a source code change.
The purpose of this section is to introduce and explain the
user exits which are provided with this component. The user
must carefully explore whether or not it is necessary to
develop a user exit routine. To this end, the user should
first ensure that the requirement cannot be satisfied through
one of the standard options or definitions. This process can
be facilitated by discussing the requirement with the CA MICS
Product Support Group.
The design, coding, testing, and implementation of CA MICS
user exit routines should be done carefully since errors may
result and corrupt the data. The user should be meticulous
in the definition and validation of the exit routines to
ensure that system integrity and performance is not adversely
affected.
GENERAL CONSIDERATIONS
The user exits for the CA MICS Analyzer Option for VM/CMS are
identified below.
o General Exits
USRSEL - File Processing Selection
USRIHL - Checkpoint File Inspection
o Analyzer Input Exits
for account data:
VMCUACA - VMCACTFI Data Statement File Definition
VMCUACB - VMCACTFI Format, Lengths, and Labels
VMC0EXIT - VMCACTFI C0 (USER) and Custom Record
Inspection
VMCUACC - VMCACTFI Custom Record Input
for VM monitor data
VMCUMXA - VMCMXAFI Data Statement File Definition
VMCUMXB - VMCMXAFI Format, Lengths, and Labels
VMCUMXC - VMCMXAFI Custom Record Input
VMCAPDAT - VMCMXAFI Domain 10 (APPLDATA) Record
Input (VM only)
o Analyzer Output Exits
VMCACTFI - CP Account Data Processing
USRSCMU - Resource Accounting File Exit
USRSDAC - Device Accounting File Exit
USRSVRA - RSCS Accounting File Exit
USRSNTU - Network Accounting File Exit
USRSNDT - Network Data Transmissions File Exit
VMCMXAFI - VM Monitor Data Processing
USRSSGP - System Global Data File Exit
USRSSCF - System Configuration File Exit
USRSSPP - System Processor Data File Exit
USRSPCF - Processor Configuration File Exit
USRSDCF - Device Configuration File Exit
USRSXDV - Device Activity File Exit
USRSXDS - Device Seeks Data File Exit
USRSACF - CPVOL Configuration File Exit
USRSCPV - CP Owned Volume Data File Exit
USRSVXF - User Data Configuration File Exit
USRSVXU - User Activity Sample Data File Exit
USRS_VU - User Activity Event Data File Exit
USRSVXT - User Transaction Sample Data File Exit
USRS_VT - User Transaction Event Data File Exit
USRSCHC - Channel Path Contention File Exit
USRSBPG - Block Paging Data File Exit
USRSXSF - Shared Storage Configuration File Exit
USRSXSS - Shared Storage Management File Exit
USRSSTP - System Timer Pop File Exit
USRSCDI - DASD Cache Activity File Exit
USRSCDP - Paging Cache Activity File Exit
USRSLPR - Logical Partition Activity File Exit
USRSLCP - Logical Processor Activity File Exit
USRSSCX - Scheduler Parameters File Exit
o Analyzer Parameter-Related Exits
VMCACRT - Account Code Assignment Exit
o Analyzer Special Exits
VMCUACD - VMCACTFU Custom Record Post-Processing
VMCUMXD - VMCMXAFU Custom Record Post-Processing
VMCUPRC - General Exit following Post-Processing
o Linux Only Exits
USRSLXP - Linux Process Activity File Exit
USRXLXP - DETAIL LNXLXP Disk Data Selection Exit
USRDLXP - DAYS LNXLXP Data Selection Exit
LNXACRT - Account Code Assignment Exit for Linux
USRTLXP - DETAIL Tape Data Selection Exit
Note: The USRXLXP and USRXLXP exits do not follow the same
conventions as the other raw exits, where subsetting records
affect not only the DETAIL, but also the higher timespan
files as well. The USRXLXP and USRXLXP exits affect only the
DETAIL timespan files.
ADDITIONAL FIELDS AVAILABLE TO EXITS
Area data elements, which are available for use by the user
exits, vary according to the processing phase and the
particular user exit. Special data elements that are used in
the Analyzer update process but are not stored in the CA MICS
database (and therefore have no corresponding data dictionary
description) are described below. The individual user exit
descriptions list which of these elements are available for
the exit routine.
Utility Elements
Several elements that are used throughout the Analyzer are
retained. These elements are used to set flags or
indicators, or to clear fields. They are:
ONE Numeric, Value 1
YES Numeric, Value 1
ZERO Numeric, Value 0
NO Numeric, Value 0
BLANKS Character, Value Blanks
SKIP_REC - Skip (delete) Record Indicator
During the Input Raw Data Phases, this indicator can be set
to ONE (1) within the USRSEL exit to cause the current input
record to be dropped before it is processed further by the
data input routine.
This indicator can also be set to ONE (1) by the file output
exits (USRSfff) to inhibit output of the current observation
to the database.
ACTSFLAG - Input Routine Indicator
During the Input Raw Data Phases, this indicator is set to
show which input phase is being executed.
ACTSFLAG=1; /* Input Account Data Phase */
ACTSFLAG=2; /* Input VM, z/VM Monitor Data */
This flag is used within the USRSEL exit to determine
execution based on input data type.
Utility Elements Available in VMCACTFI (Account Data)
VRACHK - USER Account (C0) Record is from RSCS
This element is set in user exit VMC0EXIT to indicate that
the current C0 account record was produced by RSCS. VRACHK
must be set to ONE (1) to indicate that the record contains
RSCS data; otherwise, it must be set to ZERO (0).
VRALCLNN - RSCS Local Node Name
This element is set in user exit VMC0EXIT to indicate the
local node name (which is different from userid) of the RSCS
virtual machine that produced the current C0 Account record.
This element may also be set in user exit USRSVRA. This
element is only significant when VRACHK is set to ONE.
TS_READ - Read Standard CP Account Format Date/Time Field
This indicator is set in VMC0EXIT when an Account record not
ordinarily handled by VMC, such as a non-RSCS C0 record, or
other site-defined records must be processed. When TS_READ
is set to ONE (1), the date/timestamp in columns 17-28 of the
record will be read and Check Routine 2 processing invoked.
If the date/timestamp is not in columns 17-28 of the record
or it is not in standard CP account format (MMDDYYHHMMSS),
TS_READ must be set to ZERO (0).
TS_CHK2 - Do Check Routine 2 Processing
This indicator is set in VMC0EXIT when an Account record not
ordinarily handled by VMC, such as a non-RSCS C0 record, or
other site-defined records must be processed. Setting
TS_CHK2 to ONE (1) causes Check Routine 2 to be invoked to
date-range validate the input record. When TS_CHK2 is set to
ONE (1), the code in VMC0EXIT must set the element ENDTS to
the value represented by the timestamp in the record being
processed.
Note: Any record that is not date-range validated may cause
duplicate data to be placed in the database.
Note: Any record that does not go through Check Routine 2
processing will not be dropped if SKIP_REC is set to ONE in
USRSEL.
The following sections identify the user exits available for
processing, provide a general overview of the processing
logic, and describe each of the user exits in detail.
The complete list of sections follows:
1 - General Exits
2 - Analyzer Input Exits
3 - Analyzer Output Exits
4 - Analyzer Parameter-Related Exits
