10. MODIFICATION › 10.4 Output Exits
10.4 Output Exits
This section provides an in-depth description of the CA MICS
Web Analyzer standard output processing exits that are
invoked during phase 2 of the DAILY update processing flow.
The exits are organized by information area.
Each exit description includes the user exit name, title, a
description of its purpose, when it is invoked, and whether
it has an interface to CA MICS Accounting and Chargeback. It
also shows what data elements are available and any special
considerations to be aware of.
+---------+
| USRSWPR | WebSphere Performance File Exit
+---------+
DESCRIPTION: USRSWPR allows access to the data elements used
to build the records in the WebSphere Performance File.
INVOCATION: This exit gains control immediately prior to the
output of records to the Web Performance File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the WebSphere Performance File.
This file is built from the SMF Type 103 Records (subtype 2).
The location of the self-defining section of the WebSphere
Performance data is found at offset 24 ('18'X).
ELEMENTS AVAILABLE: All elements in the WebSphere
Performance File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSSAF | WAS Server Activity File
+---------+
DESCRIPTION: USRSSAF allows access to the data elements used
to build the records in the WAS Server Activity File.
INVOCATION: This exit gains control immediately prior to the
output of records to the WAS Server Activity File.
ACCOUNTING INTERFACE: The CA MICS Accounting and Chargeback
interface follows the invocation of this user exit in a later
step while creating the WEBSAF file in the DETAIL database.
If you decide to eliminate data, you may affect the content
of the WEBSAF file and the accounting information for your
system.
USES: This exit is used to add or change data elements, or
to delete observations from the WAS Server Activity File.
This file is built from the SMF Type 120 Records (subtype 1).
The location of the self-defining section of the WAS Server
Activity File is found at offset 40 ('28'X).
ELEMENTS AVAILABLE: All elements in the WAS Server Activity
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSSIF | WAS Server Interval File
+---------+
DESCRIPTION: USRSSIF allows access to the data elements used
to build the records in the WAS Server Interval File.
INVOCATION: This exit gains control immediately prior to the
output of records to the WAS Server Interval File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the WAS Server Interval File.
This file is built from the SMF Type 120 Records (subtype 3).
The location of the self-defining section of the WAS Server
Interval File is found at offset 40 ('28'X).
ELEMENTS AVAILABLE: All elements in the WAS Server Interval
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSMIJ | J2EE Method Interval File
+---------+
DESCRIPTION: USRSMIJ allows access to the data elements used
to build the records in the J2EE Method Interval File.
INVOCATION: This exit gains control immediately prior to the
output of records to the J2EE Method Interval File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the J2EE Method Interval File.
This file is built from the SMF Type 120 subtype 6 records.
The location of the self-defining section of the J2EE Method
Interval File is found at offset 40 ('28'X).
ELEMENTS AVAILABLE: All elements in the J2EE Method Interval
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSHTP | HTTP Session Manager Interval File
+---------+
DESCRIPTION: USRSHTP allows access to the data elements used
to build the records in the J2EE Method Interval File.
INVOCATION: This exit gains control immediately prior to the
output of records to the HTTP Session Manager Interval File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the HTTP Session Manager Interval
File. This file is built from the SMF Type 120 subtype 8
records. The location of the self-defining section of the
HttpSessionManager section is found at offset 52 ('28'X).
ELEMENTS AVAILABLE: All elements in the HTTP Session Manager
Interval File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSSRV | WebContainer Servlet Interval File
+---------+
DESCRIPTION: USRSSRV allows access to the data elements used
to build the records in the WebContainer Servlet Interval
File.
INVOCATION: This exit gains control immediately prior to the
output of records to the WebContainer Servlet Interval File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the WebContainer Servlet Interval
File. This file is built from the SMF Type 120 subtype 8
records. The location of the self-defining section of the
Servlet section is found at offset 264 ('108'X) inside the
WebApplication interval section that is found at offset 64
('40'X).
ELEMENTS AVAILABLE: All elements in the WebContainer Servlet
Interval File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSHPI | JVM Heap Interval File
+---------+
DESCRIPTION: USRSHPI allows access to the data elements used
to build the records in the JVM Heap Interval File.
INVOCATION: This exit gains control immediately prior to the
output of records to the JVM Heap Interval File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the JVM Heap Interval File. This
file is built from the SMF Type 120 subtype 3 records. The
location of the self-defining section of the JVM heap section
is found at offset 8 ('8'X) inside the Server region section
that is found at offset 52 ('34'X).
ELEMENTS AVAILABLE: All elements in the WebContainer Servlet
Interval File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSWCB | Web Request Activity File
+---------+
DESCRIPTION: USRSWCB allows access to the data elements used
to build the records in the Web CPU Usage Breakdown (WEBWCB)
file.
INVOCATION: This exit gains control immediately prior to the
output of records to the Web CPU Usage Breakdown File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the Web CPU Usage Breakdown File.
This file is built from the SMF Type 120 subtype 9 records.
ELEMENTS AVAILABLE: All elements in the Web CPU Usage
Breakdown File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSWRA | Web Request Activity File
+---------+
DESCRIPTION: USRSWRA allows access to the data elements used
to build the records in the Web Request Activity (WEBWRA)
file.
INVOCATION: This exit gains control immediately prior to the
output of records to the Web Request Activity File.
ACCOUNTING INTERFACE: The CA MICS Accounting and Chargeback
interface follows the invocation of this user exit in a later
step while creating the WEBWRA file in the DAYS database.
USES: This exit is used to add or change data elements, or
to delete observations from the Web Request Activity File.
This file is built from the SMF Type 120 subtype 9 records.
ELEMENTS AVAILABLE: All elements in the Web Request Activity
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSWUD | Web User Data File
+---------+
DESCRIPTION: USRSWUD allows access to the data elements used
to build the records in the Web User Data (WEBWUD) file.
INVOCATION: This exit gains control immediately prior to the
output of records to the Web User Data File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the Web User Data File. This
file is built from the SMF Type 120 subtype 9 records.
ELEMENTS AVAILABLE: All elements in the Web User Data File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSWAA | Web Asynch Activity File
+---------+
DESCRIPTION: USRSWAA allows access to the data elements used
to build the records in the Web Asynch Activity (WEBWAA)
file.
INVOCATION: This exit gains control immediately prior to the
output of records to the Web Asynch Activity File.
ACCOUNTING INTERFACE: The CA MICS Accounting and Chargeback
interface follows the invocation of this user exit in a later
step while creating the WEBWAA file in the DAYS database.
USES: This exit is used to add or change data elements, or
to delete observations from the Web Asynch Activity File.
This file is built from the SMF Type 120 subtype 9 records.
ELEMENTS AVAILABLE: All elements in the Web Asynch Activity
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSAGL | Agent Log File Exit
+---------+
DESCRIPTION: USRSAGL allows access to the data elements used
to build the records in the Agent Log File.
INVOCATION: This exit gains control immediately prior to the
output of records to the Agent Log File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the Agent Log File Exit. This
file is built from the WebSphere Agent Log data.
ELEMENTS AVAILABLE: All elements in the Agent Log File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSERL | Error Messages Log File Exit
+---------+
DESCRIPTION: USRSERL allows access to the data elements used
to build the records in the Error Messages Log File.
INVOCATION: This exit gains control immediately prior to the
output of records to the Error Messages Log File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the Error Messages Log File
Exit. This file is built from the WebSphere Error Log data.
ELEMENTS AVAILABLE: All elements in the Error Messages Log
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSRFL | Referer Log File Exit
+---------+
DESCRIPTION: USRSRFL allows access to the data elements used
to build the records in the Referer Log File.
INVOCATION: This exit gains control immediately prior to the
output of records to the Referer Log File.
ACCOUNTING INTERFACE: No interface is provided.
USES: This exit is used to add or change data elements, or
to delete observations from the Referer Log File Exit. This
file is built from the WebSphere Referer Log data.
ELEMENTS AVAILABLE: All elements in the Referer Log File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+---------+
| USRSSAL | Server Access Log File Exit
+---------+
DESCRIPTION: USRSSAL allows access to the data elements used
to build the records in the Server Access Log File.
INVOCATION: This exit gains control immediately prior to the
output of records to the Server Access Log File.
ACCOUNTING INTERFACE: The CA MICS Accounting and Chargeback
interface follows the invocation of this user exit in a later
step while creating the WLGSAL file in the DETAIL database.
If you decide to eliminate data, you may affect the content
of the WLGSAL file and the accounting information for your
system.
USES: This exit is used to add or change data elements, or
to delete observations from the Server Access Log File Exit.
This file is built from the WebSphere Server Access Log, FRCA
Access Log, Proxy Access Log, and Proxy (Cache) Log data.
ELEMENTS AVAILABLE: All elements in the Server Access Log
File.
CODING RESTRICTIONS: Refer to the CA MICS System
Modification Guide, Section 4.3.2.2.
+----------------+
| U S R D f f f | DB2 User-written Cost Derivation Exit
+----------------+
DESCRIPTION: The USRDfff exit lets you provide the
derivation of the fffCOST data element. The files available
(fff) are the WEBWRA and WEBWAA files.
INVOCATION: These exits are invoked in the information area
processing phase immediately before output of the file.
ACCOUNTING INTERFACE: No interface is provided.
USES: The exit allows elements to be passed to the routine
computing the value of fffCOST.
ELEMENTS AVAILABLE: All elements in the file are available.
+---------------+
| U S R X f f f | DETAIL Only File Exits
+---------------+
DESCRIPTION: USRXfff exit is available for the Web Request
Activity (WEBWRA), Web CPU Usage Breakdown (WEBWCB), WEB User
Data (WEBWUD), and the Web Asynch Activity (WEBWAA) files.
- The USRXWRA exit is invoked during the final output of the
Web Request Activity (WEBWRA) File.
- The USRXWCB exit is invoked during the final output of the
Web CPU Usage Breakdown (WEBWCB) File.
- The USRXWUD exit is invoked during the final output of the
Web User Data (WEBWUD) File.
- The USRXWAA exit is invoked during the final output of the
Web Asynch Activity (WEBWRA) File.
User code in the USRXWRA, USRXWCB, USRXWUD, and USRXWAA exits
only modifies observations that are output to the DETAIL
timespans for the WEBWRA, WEBWCB, WEBWUD, and WEBWAA files.
These modifications are not propagated to the DAYS and higher
timespans.
For example, using the USRXQAA exit to restrict output of
queue level records, where the queue name begins with
"customer," to the DETAIL MQAQAA01 Queue Activity File has no
impact on the observations summarized in the DAYS and higher
timespan MQAQAA files.
INVOCATION: Exit gains control in the SAS data step that
creates the DETAIL timespan WEBfff00 file in
sharedprefix.MICS.SOURCE(WEB1204).
ACCOUNTING INTERFACE: No interface to CA MICS Accounting and
Chargeback.
USES: The USRXfff exits allow subsetting and data element
modification that is restricted to the DETAIL timespan
WEBWRA, WEBWCB, WEBWUD, and WEBWAA files. Due to data volume
considerations, the WEBWRA, WEBWUD, and WEBWAA files are not
active by default in the DETAIL timespan. Observations can
be excluded by setting SKIP_REC=1.
If you choose to create a DETAIL timespan file for the
WEBWRA, WEBWUD, and WEBWAA files on tape rather than on DASD,
use the USRTfff exit.
ELEMENTS AVAILABLE: All elements in the respective file.
CODING RESTRICTIONS: Refer to the System Modification Guide,
Section 4.3.2.2.
SPECIAL NOTES: To implement this exit at the unit level,
code it in prefix.MICS.USER.SOURCE(#WEBEXIT).
SAMPLE USER EXIT - USRXWRA:
DESCRIPTION: This sample exit lists individual, DETAIL-level
queue segments for all queues associated with the XYZ
application.
/* */
/* Limit output of Detail Web Request Activity to */
/* a particular Websphere Application Server */
/* */
IF WEBSVRNM NE: 'WSVR42X9' THEN SKIP_REC=1 ;
+----------------+
| 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 SMG.
All of the USRTfff indirect exits are activated in
sharedprefix.MICS.SOURCE(#cccEXIT). In #cccEXIT, you will
find the following statement for each file (fff) eligible for
DETAIL tape:
%LET USRTfff = ;
The exit is activated by providing a member name to the right
of the equal sign:
%LET USRTfff = exitname ;
If you code an exitname, you MUST create a member in each
unit's prefix.MICS.USER.SOURCE library with that name.
Provide valid SAS code in the member. This code will be
invoked prior to the output of records to the DETAIL tape
file.
Example:
sharedprefix.MICS.SOURCE(#WEBEXIT):
%LET USRTWRA = WRATEXIT ;
prefix.MICS.USER.SOURCE(WRATEXIT):
IF WEBSRVNM NE 'WSVR42X1' THEN SKIP_REC=1 ;
In this example, WRATEXIT was chosen as the name for the
DETAIL tape exit for the WEBWRA file. Member WRATEXIT was
created in the unit level prefix.MICS.USER.SOURCE library for
each unit where DETAIL tape was activated for the WEBWRA
file.
The exit was coded to limit the records written to the DETAIL
tape file to those from a particular Websphere application
server, WSRV42X1.
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 cccPGEN prior to
activating and coding USRTfff exits.
+----------------+
| U S R U J f f | Accounting & Chargeback Exits
| W E B J f f f |
+----------------+
DESCRIPTION: These exits provide the linkage into CA MICS
Accounting and Chargeback. The files available (fff) are the
WEBWRA and WEBWAA files.
INVOCATION: These exits are invoked in the daily
summarization #fffDSUM routines, where fff is WRA or WAA as
the data is summarized at the DAYS timespan.
ACCOUNTING INTERFACE: These exits provide the interface to
Accounting and Chargeback.
USES: The exit allows elements to be passed to Accounting
and Chargeback.
ELEMENTS AVAILABLE: All elements in the file are available.
CODING RESTRICTIONS: Refer to Section 4.3.1.1 of the SMG.
Copyright © 2014 CA.
All rights reserved.
|
|