10. MODIFICATION › 10.2 Standard User Exits › 10.2.1 General Exits

10.2.1 General Exits

General exits are invoked for all products and a full
description of how to use these exits appears in the CA MICS
System Modification Guide.  They are presented here to
identify the special user exits available for the CA MICS
Analyzer Option for VM/CMS.

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 Installation Accounting
Component.  It also shows which data elements are available
and any special considerations that should be taken into
account.

+---------------+
|  U S R S E L  | File Processing Selection Exit
+---------------+

DESCRIPTION:  This exit allows access to each record
processed by any product.  It can be used to select or
exclude specific records.

INVOCATION:  This exit gains control after a DETAIL input
record has been read and before the record formats have been
defined.

ACCOUNTING INTERFACE:  No interface to CA MICS Accounting and
Chargeback is provided at this point.

USES:  This exit may be used to delete records before
processing or to alter the data.

ELEMENTS AVAILABLE:

  ROUTINE -   The name of the routine that invoked this exit.
              To use this routine in the CA MICS Analyzer
              Option for VM/CMS, test for ROUTINE =
              'DYVMCFMT'.
  MRHDRDM  -  VM record Monitor domain
  MRHDRRC  -  VM monitor record code
  VMCRCODE -  CP account record type
  ENDTS    -  End timestamp for the record being processed.
  ORGSYSID -  The original SYSID for the system that
              produced the data being processed.
  SUSPEND  -  FLAG to skip records if Monitor suspend

CODING RESTRICTIONS:

  This exit should not contain code that executes a LINK or
  RETURN statement.  A GOTO statement may only reference a
  label defined within the exit.

SPECIAL NOTES:  Because this exit is used by all products,
the source code is located in #BASEXIT of the appropriate
source libraries.

SAMPLE USER EXIT:  Drop all VM Monitor Device activity
records.

       IF ROUTINE = 'DYVMCFMT' THEN DO;
         /* DROP all Domain 6 records                 */
         IF MRHDRDM EQ 6 THEN SKIP_REC = YES;
         ELSE SKIP_REC = NO;
       END;

+---------------+
|  U S R I H L  | Examine Input History Log
+---------------+

DESCRIPTION:  This exit permits the inspection of the DETAIL
timespan checkpoint file immediately following processing of
all input records in the format routine.

INVOCATION:  This exit is given control by %CKRTN4, which
reads the checkpoint file as an integrity check to verify
that data has been read and that file data input has been
terminated correctly.

ACCOUNTING INTERFACE:  No interface to CA MICS Accounting and
Chargeback is provided at this point.

USES:  This exit may be used to verify that no duplicate VM
Monitor data has been read.  Due to the relative granularity
of the timestamps in the prefix.MICS.CHECKPT.DATA file and
the VM Monitor data when the same data is input to the
CA MICS Analyzer Option for VM/CMS in separate cycles, it is
possible that not all input records are date range deleted,
as they should be, in the second cycle.  This exit can check
for a reasonable number of records kept when date range
deletion has occurred.  This problem does not arise with VM
Account data.

ELEMENTS AVAILABLE:  All elements in the ADMIHL file,
including the following:

  ROUTINE  -  The name of the routine that invoked this exit.
              To use this routine in the CA MICS Analyzer
              Option for VM/CMS, test for ROUTINE =
              'DYVMCFMT'.
  COMPT -     The name of the data input step that provided
              the observation in the file CKPTDATA.  The
              values for this in the CA MICS Analyzer Option
              for VM/CMS are:
                'VMC ACT' for Account data input
                'VMC MXA' for VM Monitor data input
                'VMC VCNA' for Account record type 07
  KEPT -      The number of input records kept from the input
              for this run.
  DATETM_D -  The number of records deleted based on
              date/time criteria.
  RDRSEL_D  - The number of records deleted due to the flag
              SKIP_REC being set to 1 in the _USRSEL exit.
  SHORT_D -   The number of records deleted due to a
              detection of incorrect record length.
  OPTION_D  - The number of records deleted due to the
              detection of an unrecognized input record.
  ORGSYSID -  Original SYSID for the system that produced
              the data being processed.
  SYSID    -  The logical SYSID for the system that produced
              the data being processed.

CODING RESTRICTIONS:

  This exit should not contain code that executes a LINK or
  RETURN statement.  A GOTO statement may only reference a
  label defined within the exit.

SPECIAL NOTES:  Because this exit is used by all products,
the source code is located in #BASEXIT of the appropriate
source libraries.

SAMPLE USER EXIT:

  IF ROUTINE EQ 'DYVMCFMT' AND COMPT EQ :'VMC MON' THEN DO;
    IF DATETM_D GT 0 AND KEPT LT 100 THEN DO;
      LINE = "--- TOO FEW MONITOR RECORD KEPT - ABENDING";
      CALL MICSLOG('VMC99');
      ABORT ABEND 998;
    END;
  END;