At times, additional system customizing is needed to tailor CA MICS to meet your data center's needs. 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 CA MICS database or operational integrity o Is relatively easy to document and understand Using the CA MICS exit facilities to augment processing logic is the safest method of system modification. Generally, we consider that the System Administrator has four levels or methods by which CA MICS can be augmented, changed, and enhanced: 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 Exit Points There may be site-dependent requirements that are not adequately addressed through the standard options and parameters of CA MICS. In these cases, one or more of the user exit points available to you may be used to code user-written routines that would satisfy these extended requirements. o Extension through Field-Developed Applications Although most users do not at first consider this a way of modifying CA MICS, the development of field-developed applications may be the most advantageous way of addressing the need to modify a CA MICS product. For example, it may be better to write an application to handle additional SMF data than to attempt to modify the logic of the CA MICS Network Analyzer. o System Code Modification As a last resort, you may be able to satisfy your site's requirements by implementing a source code change. This chapter explains the user exit points that are provided with the CA MICS Network Analyzer. You must carefully explore whether it is necessary to develop any user exit routines. To this end, you should first ensure that the requirement cannot be satisfied through one of the standard options or definitions. This process can be greatly facilitated by discussing the requirement with CA Technical Support. WARNING! Before attempting to activate an exit, you should read and fully understand the information contained in Section 4.3 of the System Modification Guide, User Exit Facilities. The following material is intended to supplement, not replace, that discussion. The design, coding, testing, and implementation of CA MICS user exit routines should be approached with caution as errors may result, causing the corruption of the data. You should be meticulous in the definition and validation of the exit routines to ensure that system integrity and performance have not been adversely affected.
This section contains the following topics:
10.2 Exit Routine Considerations
10.5 Implement Incremental Update
There are two types of user exits that can be used to modify
CA MICS logic: general exits and product exits. General
exits apply to all the installed products. Product exits
only apply to the product for which they are provided.
General exits allow user routines to be used for all products
that process the raw SMF data. For more information on
General Exits, see Chapter 4 of the System Modification
Guide.
Product exits are classified according to their purpose and
include input, work file, output, parameter-related, and
accounting exits.
Input Exits are invoked as the raw input records are read.
The CA MICS Network Analyzer provides the general input exit
_USRSEL, which can be used to select or exclude data meeting
special data-center-defined criteria, to add data elements,
or to modify record fields as they are read. In addition,
the general exit, _USRIHL, is provided at the end of input
processing to permit examination of the CA MICS Input History
Log SAS file, so that the user can terminate the DAILY run if
critical data is missing from the run.
Work File Exits are provided for special work files that are
created from raw input data for use in special processing.
For example, they are used to create the DAYS timespan of a
file when no DETAIL timespan is maintained.
Output Exit routines are invoked just before CA MICS writes
an observation to the CA MICS database. Output exits are
provided for each file and can be used to selectively block
the writing of specified records, alter data elements in the
records, or produce additional records for the target file or
a user-defined file.
Parameter-related exits are also user exits, but are defined
as part of the standard CA MICS installation process. They
are normally associated with other parameters or options.
For example, the Account Code Derivation Routine is a user
exit routine for completing values for account codes that
were defined in a separate but related member of
prefix.MICS.PARMS, SNTACRT, the Account Code Definition
parameter member. These exits are identified in this
chapter, but are described in Chapter 7 of this guide.
Accounting Exits are identified in this chapter, but are
described in the Accounting and Chargeback User Guide.
The user exits for the CA MICS Network Analyzer are
identified below:
o Product Input Exits
_USRSEL - File Processing Selection
_USRIHL - Examine Input History Log
_SNTXCON - Configuration Modification Exit
o Product Work File Exits
_USRSNLW - NLDM Session Data Work File Exit
_USRSNNW - NPM Network Components Work File Exit
o Product Output Exits
- Direct exits:
These exits are provided as stub macros in
sharedprefix.MICS.SOURCE. You can update these macros to
manipulate observations before they are written out.
_USRSCAF - NPM Components Activity File Exit
_USRSNCL - NPM/NCP Link File Exit
_USRSNAF - NPM/NCP Activity File Exit
_USRSNEF - NPDA Event File Exit
_USRSNIN - NPM Incident File Exit
_USRSNPL - NPM Link Activity File Exit
_USRSNSF - NPDA Statistical File Exit
_USRSPSU - NPM User Activity File Exit
_USRSPSY - NPM System (PLU) Activity File Exit
_USRSVBS - VTAM Buffer Data File Exit
_USRSVCS - VTAM CSM Data File Exit
_USRSVGB - VTAM Global Data File Exit
_USRSNSV - NLDM Service File Exit
_USRSLSY - NLDM System (PLU) Activity File Exit
_USRSNSA - NLDM Session Accounting File Exit
_USRSNSC - NLDM Session Connectivity File Exit
_USRSNLL - NLDM Link Activity File Exit
_USRSNLP - NCP Line Processor Activity File Exit
_USRSRTE - NLDM Route File Exit
_USRSRTM - NLDM Response Time File Exit
_USRSVBF - NLDM VTAM Bind Failure File Exit
_USRSNSP - NetSpy PLU (Application) File Exit
_USRSNSS - NetSpy SLU (Terminal) File Exit
_USRSNVR - NetSpy Virtual Route Activity File Exit
_USRSNTS - Telnet Server Entry File Exit
_USRXCAF - SNTCAF DETAIL Timespan File Exit
_USRSNAC - NCP Network Accounting File Exit
_USRSLNF - LAN File Exit
_USRSGAF - Generic Alert File Exit
- Indirect exits:
These exits are defined by coding a SAS macro variable to
indicate the name of a user source library member. For
detailed information about coding exit routines, refer to
Section 3.4 of the System Modification Guide.
USRSNTS - Telnet Server Entry File Exit
USRSSTN - Telnet Server File Exit
USRSCTN - Telnet Client File Exit
USRSFSF - FTP Server File Exit
USRSFSF - FTP Client File Exit
USRSAPI - API Calls for Sockets File Exit
USRSFLF - FTP Login Failure File Exit
USRTfff - DETAIL Tape Data Selection Exit
o Product Parameter-Related Exits
SNTACRT - Network Account Code Derivation Exit
SNTCIDRT- Link TP Circuit ID Definition Exit
SNTNIDRT- Network Identifier Definition Exit
SNTPLURT- PLU (Application) Processing Exit
NETGPRT - Network Service Group Definition Exit
o Accounting Exits
_USRJNAC - NCP Network Accounting File Accounting Exit
_USRJPSU - NPM User Activity File Accounting Exit
_USRJNSS - NetSpy User Activity File Accounting Exit
_USRJNTS - Telnet Server Entry File Accounting Exit
_USRUJNC - NLDM Session Connectivity File Acctg Exit
_USRUJNA - NLDM Session Accounting File Acctg Exit
_USRUJRT - NLDM Response Time File Accounting Exit
_USRUJRT - NLDM Response Time File Accounting Exit
There are data elements available for use by the user exits that vary according to the processing phase and the particular user exit point. Special data elements that are used in the CA MICS Network Analyzer update process but are not stored in the CA MICS database (and, therefore, have no corresponding Data Dictionary descriptions) are identified below. The individual user exit descriptions list which of these elements are available for the user exit routine. ROUTINE - Name of the Invoking Routine FILEID - Identifier of the File Being Processed SMFRTYPE - SMF Record Type of the Record Being Processed NPMSYSID - NPM Session Statistics Data System Identifier COMPT - 8-Character Product and Data Source Identifier
This section provides a description of the user exits that
are invoked during the first phase of the CA MICS Network
Analyzer Option DAILY update processing. The exits are
listed alphabetically.
Each exit description includes the name and title, a
description of its purpose, when it is invoked, and whether
it has an interface to the CA MICS Accounting and Chargeback
Option. It also shows which data elements are available, the
special considerations to note, and a sample user exit.
+---------------+
| _ U S R S E L | File Processing Selection Exit
+---------------+
DESCRIPTION: This exit allows access to each record
processed, including SMF type 28, 37, 39, 118, 119, and
user-defined CA NetSpy records.
INVOCATION: The exit gains control after a detail input
record has been read and before the network ID assignment
routine, SNTNIDRT, has been invoked.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit can be used to delete records before
processing or to modify a 4-character ORGSYSID.
ELEMENTS AVAILABLE:
ROUTINE - The name of the routine that invoked this exit.
To use this exit in the CA MICS Network Analyzer Option
process, test for ROUTINE = 'DYSNTFMT'.
SMFRTYPE - The record type of the input record:
28 - NPM Session and Network Data Record
37 - NPDA Report Record
39 - NLDM External Log Record
118 - TCP/IP SMF Record
119 - TCP/IP SMF Record
NSPYRTPE - CA NetSpy Record (user-defined; specified on
the INPUTSOURCE statement in SNTGENIN)
ORGSYSID - Original SYSID from SMF record
ENDTS - Time when record was written to SMF
CODING RESTRICTIONS: Refer to the System Modification Guide,
Section 4.3.2.
SPECIAL NOTES:
1. This exit is part of the CA MICS platform and is located
in sharedprefix.MICS.SOURCE(#BASEXIT). However, it is
recommended that the user modify
prefix.MICS.USER.SOURCE(#BASEXIT). A more detailed
description of this routine is provided in the System
Modification Guide, Section 4.3.2, Types of CA MICS
Exits.
2. Because this exit is used in many places, it is
necessary to qualify all coding in this exit by
examining the name of the routine in which the exit was
invoked. The program variable ROUTINE exists for this
purpose. See the example below.
3. NETWRKID is not set until after this exit has been
processed.
4. No time offset has been applied to ENDTS when this exit
gains control.
SAMPLE USER EXIT:
In this exit, the ORGSYSID value of SYST or SYSX found in
the raw input is translated to TEST.
MACRO _USRSEL
IF ROUTINE = 'INPUTRDR' THEN DO;
/* exit routine code here for INPUTRDR */
END;
IF ROUTINE = 'DYSNTFMT' THEN DO;
IF ORGSYSID = 'SYST' OR ORGSYSID = 'SYSX' THEN
ORGSYSID = 'TEST';
END;
%
+---------------+
| _ U S R I H L | Examine Input History Log Exit
+---------------+
DESCRIPTION: This exit permits inspection of the DETAIL
timespan checkpoint SAS file immediately following
processing of all input records.
INVOCATION: This exit is referenced in code that passes the
DETAIL timespan checkpoint SAS file. This code reads
_ADMX.CKPTDATA as an integrity check on that file, and in the
process allows the user to inspect the file's contents.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit can be used to abort daily update processing
based on an extended checkpoint examination algorithm. For
example, the daily process will end normally if data from one
or more of the sources (NPM/Network, NPM/Session, NLDM/RTM,
NPDA, CA NetSpy, or TCP/IP) is provided. However, it may be
critical that data from at least two of the sources is
provided for a successful update or data from two or more
systems is in the update process. This routine can be used
to examine all entries in _ADMX.CKPTDATA to test for the
required condition. If the appropriate data is not found,
the CA MICS DAILY step could be terminated with an ABORT
abend statement.
ELEMENTS AVAILABLE:
All elements in the ADMIHL File
CODING RESTRICTIONS: Refer to the System Modification Guide
Section 4.3.2.1.
SPECIAL NOTES:
1. This exit is part of the CA MICS platform and is located
in sharedprefix.MICS.SOURCE(#BASEXIT). However, it is
recommended that the user modify
prefix.MICS.USER.SOURCE(#BASEXIT). A more detailed
description of this routine is provided in the System
Modification Guide, Section 4.3.2, Types of CA MICS
Exits.
2. Because this exit is used in many places, it is
necessary to qualify all coding in this exit by
examining the name of the routine in which the exit was
invoked. Use the program variable ROUTINE. See the
example below.
3. Note that COMPT has a special meaning to the CA MICS
Network Analyzer Option, since it not only identifies
the product but also each data source, as follows:
'SNT NPDA' - NetView or CA NetMaster SMF Record Type 37
'SNT NPMN' - NPM Network data SMF Record Type 28
'SNT NPMS' - NPM Session data SMF Record Type 28
'SNT NLDM' - NetView or CA NetMaster SMF Record Type 39
'SNT NSPY' - CA NetSpy User-Defined SMF Record Type
'SNT TCP ' - TCP/IP for z/OS data SMF Record Type
118-119
SAMPLE USER EXIT:
In this sample exit, the Input History Log is examined to
determine if input for NLDM and NPM Session data was received
for the production SYSID 'TST1'. When End of File (EOF) is
reached for the DAILY update run, a check is done to
determine if both input sources were provided. If either
data source was not provided, then further DAILY processing
is aborted and messages are written specifying which data was
not present.
MACRO _USRIHL
IF ROUTINE = 'DYSNTFMT' THEN DO;
RETAIN TST1NLDM TST1NPMS 0;
IF SYSID = 'TST1' THEN DO;
IF COMPT = 'SNT NLDM' THEN TST1NLDM = 1;
IF COMPT = 'SNT NPMS' THEN TST1NPMS = 1;
END;
IF EOF THEN DO;
IF TST1NLDM AND TST1NPMS THEN GOTO ENDCHECK;
IF TST1NLDM THEN DO;
PUT 'NPM SESSION DATA MISSING FROM UPDATE';
END;
ELSE DO;
PUT 'NLDM/RTM DATA MISSING FROM UPDATE';
END;
ABORT ABEND;
END;
ENDCHECK:
END;
%
+-----------------+
| _ S N T X C O N | Configuration Modification Exit
+-----------------+
DESCRIPTION: This exit allows you to modify the
configuration data contained in NPM, CA NetSpy, NetView, and
CA NetMaster data.
INVOCATION: This exit is linked from the SNTNLD3 module for
NetView and CA NetMaster data, from the SNTNSINP module for
CA NetSpy data.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit can be used to modify any of the
configuration data provided in the CA NetSpy, NPM, NetView,
or CA NetMaster data. Generally, there will be no need to
modify the configuration data presented by the network
monitor products supported by CA MICS. However, it is
possible for a particular physical resource to be known by
more than one name over time, such as an NCP whose name is
changed with each regeneration to reflect the generation
level. Because the CA MICS Network Analyzer Option
summarizes information for each resource and session based on
the logical names of the configuration elements, changing the
logical name of an NCP, for example, causes the information
for the specific resource to no longer be summarized into a
single CA MICS Network Analyzer Option observation in the
higher timespans.
This problem can be circumvented by using the _SNTXCON exit
to rename the affected configuration elements back to a
common name.
ELEMENTS AVAILABLE:
All configuration elements. See the individual CA MICS
Network Analyzer Option file descriptions in Chapter 5 for
more information on the available configuration elements.
CODING RESTRICTIONS: Refer to the System Modification Guide
Section 4.3.2.
SPECIAL NOTES:
1. This exit is part of the CA MICS Network Analyzer Option
and is located in sharedprefix.MICS.SOURCE(#SNTEXIT).
However, it is recommended that the user modify
prefix.MICS.USER.SOURCE(#SNTEXIT).
2. Because this exit is used in many places, it is
necessary to qualify all coding in this exit by
examining the name of the routine in which the exit was
invoked. The program variable ROUTINE exists for this
purpose. See the example below.
3. Note that COMPT has a special meaning to the CA MICS
Network Analyzer Option, since it not only identifies
the product but also identifies each data source, as
follows:
'SNT NPDA' - NetView or CA NetMaster SMF Record Type 37
'SNT NPMN' - NPM Network data SMF Record Type 28
'SNT NPMS' - NPM Session data SMF REcord Type 28
'SNT NLDM' - NetView or CA NetMaster SMF Record Type 39
'SNT NSPY' - CA NetSpy User-Defined SMF Record Type
'SNT TCP ' - TCP/IP for z/OS data SMF Record Type
118-119
SAMPLE USER EXIT:
In this sample exit, a site routinely changes the names of
the NCP subarea nodes each time a new NCP gen is run to
reflect the NCP generation version number. For example, for
subarea 29, the NCP name is of the form N29001, N29002,
N29003, and so forth. In order to be able to track activity
related to NCP subarea 29 over time, the following _SNTXCON
exit sample will change any value of the SLUSAPU data element
(SLU subarea name) that begins with N29 to just N29.
MACRO _SNTXCON
IF COMPT EQ 'SNT NPMN' OR COMPT EQ 'SNT NPMS' THEN DO;
IF SLUSAPU EQ :'N29' THEN SLUSAPU='N29';
END;
%
This section provides an in-depth description of the CA MICS
Network Analyzer Option standard output processing exits that
are invoked during phases 1 and 2 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 the CA MICS Accounting and Chargeback
Option. It also shows what data elements are available, any
special considerations, and a sample user exit.
+-----------------+
| _ U S R S C A F | NPM Components Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the observations in the NPM Components Activity
File.
INVOCATION: Exit gains control immediately prior to the
output of the observation to the NPM Components Activity File
in the #CAFDSUM routine.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM Components Activity File.
This file is built from the SMF Type 28 Record or the
user-defined CA NetSpy SMF record.
ELEMENTS AVAILABLE:
All elements in the NPM Components Activity File
All elements in the SMF Type 28 Record
All elements in the user-defined CA NetSpy SMF record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, data produced while testing a new NCP is
blocked from the CA MICS database. If NCPNAME equals NCPTEST,
the variable SKIP_REC is set to ONE and the current
observation is deleted (that is, it is not written to the
CA MICS database).
MACRO _USRSCAF
IF NCPNAME = 'NCPTEST' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S L S Y | NLDM System (PLU) Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM System (PLU) Activity
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM System Activity File in the
#LSYDSUM routine.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NLDM System Activity File.
This file is built from the NLDM session data work file,
which produces both the NLDM System Activity File and the
NLDM Link File.
ELEMENTS AVAILABLE:
All elements in the NLDM System (PLU) Activity File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
To limit DASD requirements for this file, you may want to
eliminate sessions with very small values. In this sample,
any session with less than five total responses or less than
200 bytes of transferred data is deleted because it is not
useful for reporting purposes.
You can use this user exit to provide those filtering
capabilities.
MACRO _USRSLSY
IF LSYTRESC LT 5 OR
SUM(LSYNRTBS,LSYNRTBR,LSYNRCBS,LSYNRCBR) LT 200 THEN
SKIP_REC=ONE;
%
+-----------------+
| _ U S R S N A F | NPM/NCP Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPM/NCP Activity File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPM/NCP Activity File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM/NCP Activity File. This
file is built from the SMF Type 28 Record (NPM Network Log
Record) or the user-defined CA NetSpy SMF record, which can
also be processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NPM/NCP Activity File
All elements in the SMF Type 28 Record
All elements in the user-defined CA NetSpy SMF record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the logical SYSID is TST1 and the
NCPNAME is NCPND01, then SKIP_REC is set to ONE and the
observation is deleted (that is, it is not written to the
CA MICS database).
MACRO _USRSNAF
IF SYSID = 'TST1' THEN
IF NCPNAME = 'NCPND01' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N C L | NPM/NCP Link File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPM/NCP Link File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPM/NCP Link File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM/NCP Link File. This file
is built from the SMF type 28 record or the user-defined
CA NetSpy SMF record, which can also be processed by the exit
routine.
ELEMENTS AVAILABLE:
All elements in the NPM/NCP Link File
All elements in the SMF Type 28 Record
All elements in the user-defined CA NetSpy SMF record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, a check for Link Name LN061239 is
performed. If it is found, LINKSPD is overridden with a new
value. The sending link speed is set equal to LINKSPD and
the receiving link speed is set to 0. The four percent busy
calculations for sending, receiving, retransmission, and
total percent link busy are recalculated using the new speed.
MACRO _USRSNCL
IF NETNAME = 'LN061239' THEN DO;
LINKSPD = 4800;
NCLNRSLS = 4800;
NCLNRRLS = 0;
/* RECALCULATE PERCENT LINK BUSY */
NCLPCLBS=(SUM(OF NCLNRCHR,NCLNRCHS) /
((LINKSPD/8) * DURATION)) * HUN;
/* RECALCULATE PERCENT LINK BUSY SENDING */
NCLPCSLB=((NCLNRCHS) /
((NCLNRSLS/8) * DURATION))*HUN;
/* RECALCULATE PERCENT LINK BUSY RECEIVING */
NCLPCRLB=((NCLNRCHR) /
((NCLNRSLS/8) * DURATION))*HUN;
/* RECALCULATE PERCENT LINK BUSY RETRANSMISSION */
NCLPCELB=((NCLNRRBY) /
((NCLNRSLS/8) * DURATION))*HUN;
END;
%
+-----------------+
| _ U S R S N E F | - NPDA Event File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPDA Event File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPDA Event File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPDA Event File. This file
is built from the SMF Type 37 Record (NPDA Report Record),
which can also be processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NPDA Event File
All elements in the SMF Type 37 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, a check is performed to determine if the
NPM General Event Cause Code is undefined (for example, equal
to 'FF'). If so, SKIP_REC is set to ONE and the observation
is deleted (that is, it is not written to the CA MICS
database).
MACRO _USRSNEF
IF NEFGEVCC = 'FF' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N I N | Network Incident File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the Network Incident File.
INVOCATION: Exit gains control immediately prior to the
output of records to the Network Incident File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the Network Incident File. This
file is built from the SMF Type 28 Record (NPM Network Log
Record) and the CA NetSpy subtype X record (General Alert).
ELEMENTS AVAILABLE:
All elements in the Network Incident File
All elements in the SMF Type 28 Record
All elements in the CA NetSpy Type X Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the exception code is 101, which
indicates that network component traffic has exceeded a
data-center-defined threshold, the low limit criteria value
is examined. This value was accidentally set to 40 during
testing, resulting in the generation of a large number of
meaningless NPM monitor exception records. The user exit
code tests for an exception value of less than 4000,
preventing records from being written to the CA MICS database
when this condition is met.
MACRO _USRSNIN
IF NINCODE = 101 THEN DO;
IF NINNRHIC < 4000 then SKIP_REC = ONE;
END;
+-----------------+
| _ U S R S N L P | NCP Line Processor Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NCP Line Processor Activity
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NCP Line Processor Activity File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NCP Line Processor Activity
File.
ELEMENTS AVAILABLE:
All elements in the NCP Line Processor Activity File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the logical SYSID equals TEST, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSNLP
IF SYSID = 'TEST' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N L L | NLDM Link Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM Link Activity File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM Link Activity File in the
#NLLDSUM routine.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NLDM Link Activity File.
This file is built from the NLDM session data work file.
ELEMENTS AVAILABLE:
All elements in the NLDM Link Activity File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the logical SYSID equals TEST, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSNLL
IF SYSID = 'TEST' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N P L | NPM Link Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPM Link Activity File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPM Link Activity File in the
#NPLDSUM routine.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM Link Activity File. This
file is built from the DETAIL timespan of the NPM User
Activity File. Input record processing for the NPM Session
Statistics DETAIL File can be performed in the _USRSEL exit
or the _USRSPSU exit.
ELEMENTS AVAILABLE:
All elements in the NPM Link Activity File
All elements in the NPM User Activity File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the logical SYSID equals TEST, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSNPL
IF SYSID = 'TEST' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N S A | NLDM Session Accounting File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM Session Accounting
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM Session Accounting File.
ACCOUNTING INTERFACE: This exit contains complex-level code
and is used by the CA MICS Accounting and Chargeback Option.
To use this file exit for user-specified modifications, see
Section 4.3 of the System Modification Guide.
USES: This exit is used to add, change, or delete data
elements or observations from the NLDM Session Accounting
File. This file is built from the SMF Type 39 Record
(NetView or NLDM External Log Record), which can also be
processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NLDM Session Accounting File
All elements in the SMF Type 39 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the total bytes transmitted for any
observation in this session is less than 200, the observation
is deleted.
USER EXIT EXAMPLE #1: The CA MICS Accounting and Chargeback
Option is not installed in the database unit.
MACRO _USRSNSA
IF SUM(NSANRCBS,NSANRCBR,NSANRTBS,NSANRTBR) LT 200 THEN
SKIP_REC = ONE;
%
USER EXIT EXAMPLE #2: The CA MICS Accounting and Chargeback
Option is installed in the database unit.
Note that even the observations deleted by this exit, pass
through the accounting functions/calculations before being
deleted.
MACRO _USRSNSA
_USRUNSA _USRUJNA
IF SUM(NSANRCBS,NSANRCBR,NSANRTBS,NSANRTBR) LT 200 THEN
SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N S C | NLDM Session Connectivity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM Session Connectivity
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM Session Connectivity File.
ACCOUNTING INTERFACE: This exit contains complex-level code
and is used by the CA MICS Accounting and Chargeback Option.
To use this file exit for user-specified modifications, see
Section 4.3 of the System Modification Guide.
USES: This exit is used to add, change, or delete data
elements or observations from the NLDM Session Connectivity
File. This file is built from the SMF Type 39 Record
(NetView or NLDM External Log Record), which can also be
processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NLDM Session Accounting File
All elements in the SMF Type 39 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if PLDOMAIN is equal to TL080134, the
session occurred on the z/OS test system and the observation
can be deleted.
USER EXIT EXAMPLE #1: CA MICS Accounting and Chargeback
Option is not installed in the database unit.
MACRO _USRSNSC
IF PLDOMAIN='TL080134' THEN SKIP_REC=ONE;
%
USER EXIT EXAMPLE #2: CA MICS Accounting and Chargeback
Option is installed in the database unit.
Note that even the observations deleted by this exit, pass
through the accounting functions/calculations before being
deleted.
MACRO _USRSNSC
_USRUNSC _USRUJNC
IF PLDOMAIN='TL080134' THEN SKIP_REC=ONE;
%
+-----------------+
| _ U S R S N S F | NPDA Statistical File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPDA Statistical File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPDA Statistical File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM Statistical File. This
file is built from the SMF Type 37 Record (NPDA Report
Record), which can also be processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NPDA Statistical File
All elements in the SMF Type 37 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this exit, if the failing resource name is CHCAU1, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSNSF
IF NSFFRNAM = 'CHCAU1' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N S P | NetSpy PLU (Application) File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the CA NetSpy PLU (Application)
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the CA NetSpy PLU (Application) File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the CA NetSpy PLU (Application)
File. This file is built from the user-defined CA NetSpy SMF
record type.
ELEMENTS AVAILABLE:
All elements in the CA NetSpy PLU (Application) File
All elements in the user-defined CA NetSpy SMF records
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the first three characters of the PLU
(application) name are not TSO or IMS, then SKIP_REC is set
to ONE and the observation is deleted (that is, it is not
written to the CA MICS database).
MACRO _USRSNSP
TEMPPLU= SUBSTR(PLU,1,3);
IF TEMPPLU NE 'TSO' AND TEMPPLU NE 'IMS'
THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N S S | NetSpy SLU (Terminal) File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the CA NetSpy SLU (Terminal)
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the CA NetSpy SLU (Terminal) File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the CA NetSpy SLU (Terminal)
File. This file is built from the user-defined CA NetSpy SMF
record type.
ELEMENTS AVAILABLE:
All elements in the CA NetSpy SLU (Terminal) File
All elements in the user-defined CA NetSpy SMF records
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, the site has a naming convention that
column 4 of the SLU value uses to identify whether a terminal
is locally attached, the site wants to exclude those devices
from the NSS file. The fourth position of the SLU is checked
and, if it denotes a locally-attached terminal, the
observation is deleted.
MACRO _USRSNSS
IF SUBSTR(4,1) EQ 'L' THEN SKIP_REC=ONE;
%
+-----------------+
| _ U S R S N S V | NLDM Service File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM Service File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM Service File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NLDM Service File. This file
is built from the SMF Type 39 Record (NLDM External Log
Record), which can also be processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NLDM Service File
All elements in the SMF Type 39 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, if the first three characters of the
Performance Class name are not CIC, IMS, or TSO, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSNSV
PERFNM = SUBSTR(NSVPCLSS,1,3);
IF PERFNM NE 'CIC' AND PERFNM NE 'IMS' AND PERFNM NE 'TSO'
THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S N V R | NetSpy Virtual Route Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the CA NetSpy Virtual Route
Activity File.
INVOCATION: Exit gains control immediately prior to the
output of records to the CA NetSpy Virtual Route Activity
File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the CA NetSpy Virtual Route
Activity File. This file is built from the user-defined CA
NetSpy SMF record type.
ELEMENTS AVAILABLE:
All elements in the CA NetSpy Virtual Route Activity File
All elements in the user-defined CA NetSpy SMF Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, the site has been collecting data about
the activity and response times on multiple virtual routes to
satisfy its real-time operational requirements, but it
only wants to keep certain information in its CA MICS
database. The USRSNVR exit is used to filter the information
going into the CA MICS database to include only activity
about the virtual routes to the host system (SYSA) that
contains the production applications.
MACRO _USRSNVR
IF SYSID NE 'SYSA' THEN SKIP_REC=ONE;
%
+-----------------+
| _ U S R S P S U | NPM User Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPM User Activity File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPM User Activity File.
ACCOUNTING INTERFACE: This exit contains complex-level code
and is used by the CA MICS Accounting and Chargeback Option.
To use this file exit for user-specified modifications, see
Section 4.3 of the System Modification Guide.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM User Activity File. This
file is built from the NPM Session Statistics DETAIL Record,
which can also be processed by the exit routine.
ELEMENTS AVAILABLE:
All elements in the NPM User Activity File
All elements in the NPM Session Statistics DETAIL Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, we want to retain certain critical
terminal information to reduce the volume of observations in
the database. If SLU is not a V52E008, V52E014, or V52E021
terminal, then SKIP_REC is set to ONE and the observation is
deleted (that is, it is not written to the CA MICS database).
USER EXIT EXAMPLE #1: CA MICS Accounting and Chargeback
Option is not present in the database unit.
MACRO _USRSPSU
IF SLU NE 'V52E008' AND SLU NE 'V52E014' AND
SLU NE 'V52E021' THEN SKIP_REC = ONE;
%
USER EXIT EXAMPLE #2: CA MICS Accounting and Chargeback
Option is present in the database unit.
Note that in this example, all deleted observations will pass
through the accounting functions (calculations) prior to
being deleted.
MACRO _USRSPSU
_USRUPSU _USRUJPS
IF SLU NE 'V52E008' AND SLU NE 'V52E014' AND
SLU NE 'V52E021' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S P S Y | NPM System (PLU) Activity File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPM System (PLU) Activity
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPM System Activity File in the
#PSYDSUM routine.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPM System (PLU) Activity
File. This file is built from the DETAIL timespan of the NPM
User Activity File. Input record processing for the NPM
Session Statistics DETAIL File can be performed in the
_USRSEL exit or the _USRSPSU exit.
ELEMENTS AVAILABLE:
All elements in the NPM System (PLU) Activity File
All elements in the NPM User Activity File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, observations for application TAFAPL01
are not needed in the database and are deleted (that is,
they are not written to the CA MICS database).
MACRO _USRSPSY
IF PLU = 'TAFAPL01' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S R T E | NLDM Route File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM Route (NVSRTE) File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM Route (NVSRTE) File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NLDM Route File. This file
is built from the SMF Type 39 Record. Input record
processing for the NLDM SMF Type 39 Record can be performed
in the _USRSEL exit or the _USRSRTE exit.
ELEMENTS AVAILABLE:
All elements in the NLDM Route File
All elements in the NLDM SMF Type 39 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, observations for application TAFAPL01
are not needed in the database and are deleted (that is,
they are not written to the CA MICS database).
MACRO _USRSRTE
IF PLU = 'TAFAPL01' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S R T M | NLDM Response Time File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NLDM Response Time File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NLDM Response Time File.
USES: This exit is used to add or change data elements, or
to delete observations from the NLDM Response Time File.
This file is built from the SMF Type 39 Record. Input record
processing for the NLDM SMF Type 39 Record can be performed
in the _USRSEL exit or the _USRSRTM exit.
ELEMENTS AVAILABLE:
All elements in the NLDM Response Time File
All elements in the NLDM SMF Type 39 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTES:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
ACCOUNTING INTERFACE: This exit contains complex-level code
and is used by the CA MICS Accounting and Chargeback Option.
To use this file exit for user-specified modifications, see
Section 4.3 of the System Modification Guide.
SAMPLE USER EXIT:
In this sample exit, you want to retain certain critical
terminal information to reduce the volume of observations in
the database. If the number of responses for this
observation during a session is less than five, the
observation is deleted (that is, it is not written to the
CA MICS database).
USER EXIT EXAMPLE #1: CA MICS Accounting and Chargeback
Option is not present in the database unit.
MACRO _USRSRTM
IF RTMTRESC LT 5 THEN SKIP_REC = ONE;
%
USER EXIT EXAMPLE #2: CA MICS Accounting and Chargeback
Option is present in the database unit.
Note that in this example, all deleted observations will pass
through the accounting functions (calculations) prior to
being deleted.
MACRO _USRSRTM
_USRURTM _USRUJRT
IF RTMTRESC LT 5 THEN SKIP_REC=ONE;
%
+-----------------+
| _ U S R S V B F | NLDM VTAM BIND Failure File Exit
+-----------------+
DESCRIPTION: This exit, as shipped by CA, contains code that
eliminates certain records from the NLDM VTAM BIND Failure
(NVSVBF) File. It allows access to the data elements used to
build the records in the NVSVBF file. To minimize the size
of the NVSVBF file and to prevent it from containing
potentially useless information, the following UNBIND codes
have been excluded.
CODE REASON
---- ----------------------------------------
01 Normal session end
02 BIND forthcoming (normally issued by
a controlling application)
0F Cleanup
11 Gateway node cleanup
The BIND Failure (BINDF) and Cross-domain Session Setup
Failure (CDSESSSF) codes are not present in the NVSVBF file
because the REQUEST-UNIT descriptions for BINDF and CDSESSSF
have been dropped from IBM's documentation. The codes that
correspond to BINDF and CDSESSSF are 80, 40, 20, and 10.
For additional information on the above codes, see IBM's SNA
Reference Summary, which is an earlier version of IBM guide
GA27-3136 (for example, -6).
If you want to keep these records in your data center's
database, remove the code that deletes the BIND failure codes
and selected UNBIND codes from prefix.MICS.SOURCE(#SNTEXIT).
INVOCATION: Exit gains control immediately prior to the
output of observations to the NLDM VTAM BIND Failure File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NLDM VTAM BIND Failure File.
This file is built from the SMF type 39 record. Input record
processing for the NLDM SMF type 39 record can be performed
in the _USRSEL exit.
ELEMENTS AVAILABLE:
All elements in the NLDM VTAM BIND Failure File
All elements in the NLDM SMF Type 39 Record
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTES:
1. To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
2. As described above, this exit is shipped with SAS code
that eliminates certain failure codes from the NVSVBF
file. If you want to retain one or more of these codes
in your data center's database, we recommend that you
recode the logic to delete observations in the
prefix-level USER.SOURCE library.
SAMPLE USER EXIT:
In this sample exit, observations for terminals attached to
control unit (SLUPU) T01CU003 are deleted.
MACRO _USRSVBF
IF SLUPU = 'T01CU003' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R X C A F | SNTCAF DETAIL TimeSpan File Exit
+-----------------+
DESCRIPTION: This exit allows the SNTCAF file to be built at
the DETAIL timespan. By default, the SNTCAF file is not
supported at the DETAIL timespan.
INVOCATION: Exit gains control immediately prior to the data
step in sharedprefix.MICS.SOURCE(#CAFDSUM) that builds the
DAYS timespan SNTCAF file.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: While the SNTCAF file is not supported by default in
the DETAIL timespan, some sites must create it in this
timespan. The _USRXCAF exit provides this capability.
ELEMENTS AVAILABLE:
All elements in the NPM components Activity File (SNTCAF)
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, the site will build a single SNTCAF01
file in the DETAIL timespan.
MACRO _USRXCAF
DATA &SNTX..SNTCAF01 (%%CAFFILE(OP=FILEOPTS,TS=DETAIL)
LABEL='NPM COMPONENTS ACTIVITY FILE');
%%CAFFMT(TS=DETAIL);
%%CAFLEN(TS=DETAIL,TYPE=BOTH);
%%CAFLBL;
SET WORK.SNTCAF00;
%%CAFDERV;
RUN;
%
+-----------------+
| _ U S R S N A C | NCP Network Accounting File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NCP Network Accounting File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NCP Network Accounting File.
ACCOUNTING INTERFACE: This exit contains complex-level code
and is used by the CA MICS Accounting and Chargeback Option.
To use this file exit for user-specified modifications, see
Section 4.3 of the System Modification Guide.
USES: This exit is used to add or change data elements, or
to delete observations from the NCP Network Accounting File.
This file is built from either the CA NetSpy SMF network
session accounting/network gateway accounting subtype C
records (SMF record number is user-defined) or the NPM SMF
type 28 network session accounting/network gateway accounting
records, all of which can be processed by this exit routine.
ELEMENTS AVAILABLE:
All elements in the NCP Network Accounting File
All elements in the CA NetSpy or NPM SMF records listed
under 'USES' above.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, we want to drop all CA NetSpy network
session accounting records that were collected for the PLU
side of the session. We are doing this to eliminate
duplicate network session accounting data: we had tailored
CA NetSpy to collect data on both sides (PLU and SLU) of the
same session. If the Data Collection Point (NACCOLPT) for
the observation is not SLU, then SKIP_REC is set to ONE and
the observation is deleted (that is, it is not written to
the CA MICS database).
The CA MICS Accounting and Chargeback Option is not present
in the database unit.
MACRO _USRSNAC
IF NACCOLPT NE 'SLU' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S L N F | NPDA LAN File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPDA LAN File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPDA LAN File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the LAN File. This file is built
from the NetView Hardware Monitor SMF Type 37 Records.
ELEMENTS AVAILABLE:
All elements in the NPDA LAN File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this sample exit, a check is performed to determine if the
NPDA General Event Cause Code is undefined (for example,
equal to 'FF'). If so, SKIP_REC is set to ONE and the
observation is deleted (that is, it is not written to the
CA MICS database).
MACRO _USRSLNF
IF SNTGEVCC = 'FF' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S G A F | NPDA Generic Alert File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the NPDA Generic Alert File.
INVOCATION: Exit gains control immediately prior to the
output of records to the NPDA Generic Alert File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the NPDA Generic Alert File.
This file is built from the NetView Hardware Monitor SMF Type
37 Records.
ELEMENTS AVAILABLE:
All elements in the NPDA Generic Alert File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this exit, if the failing resource name is CHCAU1, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSGAF
IF SNTFRNAM = 'CHCAU1' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S V B S | VTAM Buffer Data File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the VTAM Buffer Data File.
INVOCATION: Exit gains control immediately prior to the
output of records to the VTAM Buffer Data File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the VTAM Buffer Data File. This
file is built from the NetView Performance Monitor SMF type
28 records.
ELEMENTS AVAILABLE:
All elements in the VTAM Buffer Data File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this exit, if the data is from non-prime shift, then
SKIP_REC is set to ONE and the observation is deleted (that
is, it is not written to the CA MICS database).
MACRO _USRSVBS
IF ZONE NE 2 THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S V C S | VTAM CSM Data File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the VTAM Communication Storage
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the VTAM Communication Storage File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the VTAM Communication Storage
File. This file is built from the NetView Performance
Monitor SMF type 28 records.
ELEMENTS AVAILABLE:
All elements in the VTAM Communication Storage File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this exit, if the data is from STORAGE type, then SKIP_REC
is set to ONE and the observation is deleted (that is, it
is not written to the CA MICS database).
MACRO _USRSVCS
IF VCSVDTYP = 'STORAGE' THEN SKIP_REC = ONE;
%
+-----------------+
| _ U S R S V G B | VTAM Global Data File Exit
+-----------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the VTAM Global Data File.
INVOCATION: Exit gains control immediately prior to the
output of records to the VTAM Global Data File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the VTAM Global Data File. This
file is built from the NetView Performance Monitor SMF type
28 records.
ELEMENTS AVAILABLE:
All elements in the VTAM Global Data File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
SPECIAL NOTE:
To implement this exit at the unit level, code it in
prefix.MICS.USER.SOURCE(#SNTEXIT).
SAMPLE USER EXIT:
In this exit, if the VTAM tuning statistics task record is
displayed at console, then SKIP_REC is set to ONE and the
observation is deleted (that is, it is not written to the CA
MICS database).
MACRO _USRSVGB
IF VGBTNSTA = '...1....' THEN SKIP_REC = ONE;
%
+---------------+
| U S R S N T S | Telnet Server Entry File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the Telnet Server Entry File.
INVOCATION: Exit gains control immediately prior to the
output of records to the Telnet Server Entry File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the Telnet Server Entry File.
This file is built from the CA NetSpy SMF records.
ELEMENTS AVAILABLE:
All elements in the Telnet Server Entry File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S S T N | Telnet Server File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the Telnet Server File.
INVOCATION: Exit gains control immediately prior to the
output of records to the Telnet Server File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the Telnet Server File. This
file is built from the TCP/IP for z/OS SMF Type 118 records
with a value of 'LOGN' or 'LOGF' at offset 21.
ELEMENTS AVAILABLE:
All elements in the Telnet Server File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S C T N | Telnet Client File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the Telnet Client File.
INVOCATION: Exit gains control immediately prior to the
output of records to the Telnet Client File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the Telnet Client File. This
file is built from the TCP/IP for z/OS SMF Type 118 records
with a value of 'LGON' or 'LGOF' at offset 21.
ELEMENTS AVAILABLE:
All elements in the Telnet Client File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S F S F | FTP Server File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the FTP Server File.
INVOCATION: Exit gains control immediately prior to the
output of records to the FTP Server File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the FTP Server File. This file
is built from the TCP/IP for z/OS SMF Type 118 records, a
four-character FTP command at offset 21, and a value of 'S'
at offset 69.
ELEMENTS AVAILABLE:
All elements in the FTP Server File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S F C F | FTP Client File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the FTP Client File.
INVOCATION: Exit gains control immediately prior to the
output of records to the FTP Client File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the FTP Client File. This file
is built from the TCP/IP for z/OS SMF Type 118 records, a
four-character FTP command at offset 21, and a value of 'C'
at offset 69.
ELEMENTS AVAILABLE:
All elements in the FTP Client File
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S A P I | API Calls for Sockets File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the API Calls for Sockets File.
INVOCATION: Exit gains control immediately prior to the
output of records to the API Calls for Sockets File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the API Calls for Sockets File.
This file is built from the TCP/IP for z/OS SMF Type 118
records with a value of 'INIT' or 'TERM' at offset 21.
ELEMENTS AVAILABLE:
All elements in the API Calls for Sockets File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S F L F | FTP Login Failure File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the FTP Login Failure File.
INVOCATION: Exit gains control immediately prior to the
output of records to the FTP Login Failure File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the FTP Login Failure File. This
file is built from the SMF Type 119 subtype 72 records.
ELEMENTS AVAILABLE:
All elements in the FTP Login Failure File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S I P X | IP Protocol Statistics File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the IP Protocol Statistics File.
INVOCATION: Exit gains control immediately prior to the
output of records to the IP Protocol Statistics File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the IP Protocol Statistics File.
This file is built from the SMF Type 119 subtype 5 records.
ELEMENTS AVAILABLE:
All elements in the IP Protocol Statistics File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S I C X | ICMP Protocol Statistics File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the ICMP Protocol Statistics
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the ICMP Protocol Statistics File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the ICMP Protocol Statistics
File. This file is built from the SMF Type 119 subtype 5
records.
ELEMENTS AVAILABLE:
All elements in the ICMP Protocol Statistics File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S T C I | TCP Protocol Statistics File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the TCP Protocol Statistics
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the TCP Protocol Statistics File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the TCP Protocol Statistics File.
This file is built from the SMF Type 119 subtype 5 records.
ELEMENTS AVAILABLE:
All elements in the TCP Protocol Statistics File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R S U D I | UDP Protocol Statistics File Exit
+---------------+
DESCRIPTION: This exit allows access to the data elements
used to build the records in the UDP Protocol Statistics
File.
INVOCATION: Exit gains control immediately prior to the
output of records to the UDP Protocol Statistics File.
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback Option.
USES: This exit is used to add or change data elements, or
to delete observations from the UDP Protocol Statistics File.
This file is built from the SMF Type 119 subtype 5 records.
ELEMENTS AVAILABLE:
All elements in the UDP Protocol Statistics File.
CODING RESTRICTIONS: See the System Modification Guide,
Section 4.3.
+---------------+
| U S R T f f f | DETAIL Tape Data Selection Exit
+---------------+
DESCRIPTION: The USRTfff exits provide access to DETAIL file
records prior to their output to DETAIL tape data sets.
Refer to Chapter 7 of this guide for information about DETAIL
tape processing and a list of eligible component files.
INVOCATION: The USRTfff exit is invoked prior to 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 that
USRTfff exit code only affects the DETAIL tape file content
for a particular file (fff). It 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(#SNTEXIT). In #SNTEXIT, 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 will be
invoked prior to the output of records to the DETAIL tape
file.
Example:
sharedprefix.MICS.SOURCE(#SNTEXIT):
%LET USRTAPI = APITEXIT ;
prefix.MICS.USER.SOURCE(APITEXIT):
IF APIBYTEI = 0 AND APIBYTEO = 0 THEN SKIP_REC=1 ;
In this example, APITEXIT was chosen as the name for the
DETAIL tape exit for the TCPAPI file. Member APITEXIT was
created in the unit level prefix.MICS.USER.SOURCE library for
each unit where DETAIL tape was activated for the TCPAPI
file.
The exit was coded to limit the observation written to the
DETAIL tape file to those where APIBYTEI and APIBYTEO
contained positive non-zero values.
Note that 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 SNTPGEN prior to
activating and coding USRTfff exits.
If you are using the TAPEfff option or USRXfff exits to
collect detail level data, and incremental update is active,
you may need to make a few simple but very important
adjustments to your exits or options to accommodate the way
that incremental update processes data.
This section discusses the following:
o TAPEfff option considerations with incremental update
o USRXfff exit considerations with incremental update
- DETAIL tape files created in USRXfff exits
- DASD files created in USRXfff exits
TAPEfff OPTION CONSIDERATIONS WITH INCREMENTAL UPDATE
The TAPEfff option allows the creation of DETAIL timespan
tape files for certain high volume files.
Without incremental update, a single DETAIL timespan tape
file is created for TAPEfff activated files during the
DAILY run. The general practice is to use GDGs so that the
(+0) tape volume contains yesterday's data, (-1) contains
the prior day's data, and so on.
With incremental update activated, a tape is created with
each execution of an incremental update as well as a final
tape during the DAILY update run. For example, three
incremental updates followed by a final daily update run
result in a total of four tapes created, one for each
TAPEfff activated file. Each tape contains only the detail
data encountered during the individual incremental update
or daily run. If you are employing GDGs you will want to
consider increasing the number of generations to encompass
the desired time range of history. For example, if
previously 7 "daily" generations were maintained and you
run 4 increments per day, you may wish to expand the
generations kept to 28 (7 times 4 updates per day).
The use of fewer tapes in a single update under the
incremental feature expedites processing. In addition, due
to the "special study" nature of the data, separation into
multiple pieces representing period time slices should
allow usage to be more direct. That is, the data is
already subset to the period contained within the update.
You also may consider creating a standalone job to
consolidate these individual tapes into a single one after
the DAILY job completes if you prefer to have a single tape
data set contain all transactions for the time range.
USRXfff EXIT CONSIDERATIONS WITH INCREMENTAL UPDATE
The USRXfff exits allow client supplied code to force the
creation of SAS files containing DETAIL level data. These
exits were provided for specific high volume transaction
based data that are populated at the DAYS and higher
timespans in a summarized form in CA MICS. Due to the high
volume of data involved, these exits may be used to create
tape files, although nothing other than space
considerations precludes creation of files on DASD with
these exits.
Many of the products that provide USRXfff exits have
implemented standardized approaches to collect DETAIL level
data, thus removing the need for USRXfff exit coding. Any
user code employed in USRXfff exits should be examined to
ensure that the data and the approach are still required.
Generally, transaction data at this level is employed for
specific tuning projects or special studies centered on
subsystem or application related issues and is needed only
for occasional and isolated time periods.
If you are using incremental update and find that the
USRXfff exits you have coded are still required for your
operation, be sure to review the considerations below.
DETAIL TAPE FILES CREATED IN USRXfff EXITS
When using the exits to write to tape without incremental
update activated, a single tape file is created from the
user written code in each activated USRXfff exit. The
general practice is to use generation data groups (GDGs)
to retain history. In this case, it is assumed that
CA MICS units are updated once a day with yesterday's
data. Without incremental update the generation 0 (+0)
tape data set would contain data from the previous
CA MICS update (yesterday), (-1) contains the prior run
(two days ago), and so on.
With incremental update, a tape file is again created
from the user written code in each activated USRXfff exit
with each execution of an update. However, rather than
running CA MICS updates once per day, incremental update
implies multiple update runs daily. For example, three
incremental updates followed by a final daily update run
result in a total of four tapes in one day, one created
from each activated USRXfff exit. Each tape contains
only the detail data encountered during the individual
incremental update or daily run. If you are employing
GDGs you will want to evaluate increasing the number of
generations to encompass the desired time range of
history. For example, if previously 7 "daily"
generations were maintained and you ran 4 increments per
day, you may wish to expand the generations kept to 28 (7
times 4 updates per day).
The use of fewer tapes in a single update under the
incremental feature expedites processing. In addition,
in keeping with the "special study" nature of the data,
separation of the data into multiple pieces representing
the narrower period slices should simplify usage. That
is, the data is already subset to the period contained
within the update.
You also may consider creating a standalone job to
consolidate these individual tapes into a single one
after the DAILY job completes if you prefer to have a
single tape data set contain all transactions for the
time range.
DASD FILES CREATED IN USRXfff EXITS
Either of two basic approaches may be employed when using
the exits to write to DASD files. Data can be written to
detail data set(s) of CA MICS units. Or it can be
written to data sets allocated externally to the CA MICS
units (such as a user data set that has been added to the
Daily JCL stream). In either scenario the SAS file
written by the exit will be replaced by new data with
each execution of the update step.
If the exit is writing to the CA MICS Detail data set and
the recommended approach has been taken with the exit
then no change to outputs will occur under incremental
update. The recommended approach employs indirect coding
to reference the database (uses "&iiit" not "DETAIL" in
the data step) and an active detail status (file status
of "Y" at the detail timespan in cccGENIN and cccCGEN has
been executed). When these conditions are in place the
file created by the exit will be treated as other CA MICS
files in incremental update mode and at the conclusion of
the Daily job stream a single file containing data from
all increments will be available in the detail unit
database. If the file status is not active, only data
from the last incremental execution will be present.
An alternative to selective exit coding is to employ a
generation data set (GDG) structure for the external DASD
file. In this scenario GDG entries to cover the
incremental updates would be defined and each incremental
run would write to a new GDG entry which would contain
data for the increment. Each series of incremental runs
followed by a DAILY job execution would create a new
series of GDG data sets. While this approach allows you
to capture all data on an ongoing basis, use of the unit
detail data set as described above is more efficient and
is the recommended approach.
|
Copyright © 2014 CA.
All rights reserved.
|
|