Previous Topic: 10.2.1 Available User ExitsNext Topic: 10.2.3 General Exits


10.2.2 Additional Fields Available to Exits


The data elements available for use by the user exits vary
according to the processing phase and the particular user
exit.  Special data elements that are used in the product
update process but are not stored in the CA MICS data base
are described below.  The individual user exit descriptions
list which of these elements are available for the user exit
routine.

SMFxxUIF - SMF User Information Field

Most of the SMF records contain a user information field of
eight characters.  These fields are normally blank unless an
installation has added user code to fill in the fields.
CA MICS reads the field, but does not store it on the data
base.  It is available for use by a user exit.  A common
example can be found in installations that use ACF2 instead
of RACF.  User exit USRSSFI allows CA MICS to retrieve the
ACF2 userid from the SMF20UIF field and override use of the
RACFUSID field.

This field is available only to the general exits and product
input exits.

ACTFLD1-5 - SMF Job Accounting Fields

Record types 30 (subtypes 1 and 5) and 33 contain a string of
information from the accounting field on the job card.
CA MICS parses this data into five account fields, ACTFLD1
through ACTFLD5, for access by some of the user exits.  These
fields are each 20 characters long and are blank if an
account code is missing.

These fields are available only at designated product input
exits and all of the product output, special, and parameter-
related exits.

PGMTYPE - Program Type Indicator

Whenever possible, the program type field, PGMTYPE, is set
for access by the user exits.  At some points during
processing, however, it is not possible to determine if a
step is from a batch job or a started task.  PGMTYPE of 1
indicates Batch Job, PGMTYPE of 2 indicates TSO, PGMTYPE of
3 indicates a System Task, PGMTYPE of 4 indicates an APPC/MVS
ASCH scheduled transaction program (TP), and PGMTYPE of 5
indicates an Open Edition/MVS address space.

This field is available only at designated product input,
special, and parameter-related exits, and at all of the
product output exits.

SKIP_REC - Skip (delete) Record Indicator

During phase 1, the Input Raw SMF Data Phase, the product
input exits can be used to determine that a record is to be
dropped from processing.  When a record is to be dropped, the
exit should set SKIP_REC to ONE.  The record will be bypassed
and a count of deleted records will be kept on the Input
History Log file, as well as shown in the DAY030 statistics.

This field is used only for the product input exits.

FLUSHJOB - Flush Job Indicator

During the Job Merge, phase 3, jobs may be dropped from the
BATJOB and BAT_JS (job suspend) files.  This also causes the
job to bypass the standard accounting exit for the BATJOB
file.  This flag can be set to ONE in any of the exits during
the Job Merge.  Obviously, you should take great care with
this flag.

This field is used only for the product output exits.

AGEFLAG - Aging Flag

During the Batch Information Area Processing Phase, phase 3,
a job record can be put into the BATJOB or BAT_JS (job
suspend) file, depending upon its completeness.  If the
essential records are not there, the job record is put into
the BAT_JS file.  This field, AGEFLAG, will be set to ONE if
the job is to be suspended (put in the BATJOB file).  This
field can be used to determine if the job record is to be
suspended.

This field is used only for the product output exits and
SHOULD NOT BE ALTERED BY ANY EXIT.

IN_JOB - Interim Job Termination File (SMFJOB) flag

During the job merge subphase of the Batch Information Area
Processing Phase, phase 3, this field indicates the presence
or absence of a record from the SMFJOB file (type 30 subtype
5) for the job being constructed.  When the record is
present, this field is set to ONE.  This flag field is used
to construct the JOBMASK field.  This field can be used to
determine whether there is a record from the SMFJOB file for
the job being constructed.

This field is used only for the product output exits.

IN_STEP - Interim Step Termination File (SMFSTEP) flag

During the job merge subphase of the Batch Information Area
Processing Phase, phase 3, this field indicates the presence
or absence of a record from the SMFSTEP file (type 30
subtypes 2, 3, or 4) for the job being constructed.  When the
record is present, this field is set to ONE.  This flag field
is used to construct the JOBMASK field.  This field can be
used to determine whether there is a record from the SMFSTEP
file for the job being constructed.

This field is used only for the product output exits.

IN_WTR - Interim Sysout Writer File (SMFWTR) flag

During the job merge subphase of the Batch Information Area
Processing Phase, phase 3, this field indicates the presence
or absence of a record from the SMFWTR file (type 6) for the
job being constructed.  When the record is present, this
field is set to ONE.  This flag field is used to construct
the JOBMASK field.  This field can be used to determine
whether there is a record from the SMFWTR file for the job
being constructed.

This field is used only for the product output exits.

IN_PURG - Interim Job Purge File (SMFPURG) flag

During the job merge subphase of the Batch Information Area
Processing Phase, phase 3, this field indicates the presence
or absence of a record from the SMFPURG file (type 26) for
the job being constructed.  When the record is present, this
field is set to ONE.  This flag field is used to construct
the JOBMASK field.  This field can be used to determine
whether there is a record from the SMFPURG file for the job
being constructed.

This field is used only for the product output exits.

IN_INIT - Interim Initiation File (SMFINIT) Flag

During the job merge subphase of the Batch Information Area
Processing Phase, phase 3, this field indicates the presence
or absence of a record from the SMFINIT file (type 30 subtype
1) for the job being constructed.  When the record is
present, this field is set to ONE.  This flag field is used
to construct the JOBMASK field.  This field can be used to
determine whether there is a record from the SMFINIT file for
the job being constructed.

This field is used only for the product output exits.