10.3 Input Exits


This section provides a description of the user exits that
are invoked during the first phase of the CA MICS Web
Analyzer 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 CA MICS Accounting and Chargeback.  In
addition, 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 by the CA MICS Web Analyzer input format routine.
 
INVOCATION:  The exit gains control after a detail input
record has been read.
 
ACCOUNTING INTERFACE:  No interface to CA MICS Accounting and
Chargeback.
 
USES:  This exit can be used to exclude records from being
processed by the CA MICS Web Analyzer during the daily input
step.  To exclude a record, set SKIP_REC to one.  Refer to
the example later in this section for help on coding.
 
ELEMENTS AVAILABLE:
 
  ROUTINE - The name of the routine that invoked this exit.
 
    To use this exit in the CA MICS Web Analyzer process,
    test for ROUTINE = 'DYWEBFMT'.
 
  SMFRTYPE - The record type of the input record:
 
    103 - HTTP Server Performance Statistics
    120 - WebSphere Application Server Statistics
 
  ORGSYSID - Original SYSID from SMF record.
 
  ENDTS - End Timestamp
 
    In all files except the MQBMFA file, ENDTS is set to the
    value in the SMF header that tells the time and date the
    record was written to the SMF buffer, for example
    SM116DTE and SM116TME.
 
    In the MQBMFA file, ENDTS is set to the interval end date
    and time values found in the message flow accounting
    record fields IMFLENDT and IMFLENTM.
 
  COMPT - Component ID
 
    The 8-character value representing CA MICS Web Analyzer
    product ID, either 'WEB SMF ' for SMF data or 'WEB WLG '
    for HTTP Web Server Log data.  It identifies the product
    data source.
 
CODING RESTRICTIONS:  Refer to the CA MICS System
  Modification Guide, section 4.3.2.1.
 
SPECIAL NOTES:
 
  1. This exit is part of the CA MICS Base component 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 CA MICS
     System Modification Guide, section 4.3.2.1, Standard
     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.
 
SAMPLE USER EXIT:
 
  In this exit, the data logged by WebSphere Web Server CSQ2
  is dropped from further processing.  This data may be
  coming from a test system that does not need to be kept in
  the production database.
 
  MACRO _USRSEL
 
  IF ROUTINE = 'DYWEBFMT' THEN DO;
    IF SYSID = 'CSQ2' THEN
       SKIP_REC = 1;
  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 in the input format routine.
 
INVOCATION:  This exit is referenced in code that passes the
DETAIL timespan checkpoint SAS file.  The 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.
 
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 the
SMF or WLE log file is provided.  However, it may be critical
that data from at least one specific system is provided for a
successful update.  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 Web
Analyzer DAILY step could be terminated with an ABORT ABEND
statement.
 
ELEMENTS AVAILABLE:
 
  All elements in the ADMIHL File
 
CODING RESTRICTIONS:  Refer to the CA MICS System
  Modification Guide, section 4.3.2.1.
 
SPECIAL NOTES:
 
  1. This exit is part of the CA MICS Base component and is
     located in sharedprefix.MICS.SOURCE(#BASEXIT).  However,
     it is highly recommended that the user modify
     prefix.MICS.USER.SOURCE(#BASEXIT).  A more detailed
     description of this routine is provided in the CA MICS
     System Modification Guide, section 4.3.2.1, Standard
     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.  Refer to the following example.
 
  3. Note that COMPT has a special meaning to the CA MICS Web
     Analyzer, since it not only identifies the product but
     also the source of data (SMF or log data), as follows:
 
       'WEB SMF ' - The data is from SMF
       'WEB WLG ' - The data is from the log file.
 
SAMPLE USER EXIT:
 
In this sample exit, the Input History Log is examined to
determine if input 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 TST1 data was
provided.  If TST1 data was not provided, then further DAILY
processing is aborted and a message is written specifying the
reason for abort.
 
MACRO _USRIHL
 IF ROUTINE = 'DYWEBFMT' THEN DO;
 RETAIN TST1FLAG 0;
 IF SYSID = 'TST1' THEN
    TST1FLAG = 1;
 IF EOF THEN DO;
   IF TST1FLAG THEN GOTO ENDCHECK;
   PUT 'Data from Production System TST1 missing';
   ABORT ABEND;
 END;
 ENDCHECK:
 END;
%
Tell Technical Publications how we can improve this information