Previous Topic: Exit #2

Next Topic: Sample Reports

The VM Interface › User Exit Routines › Exit #3

Exit #3

This exit provides you with control during the output phase while generating the user-defined reports. This gives you the capability of modifying print line information or using summarized data for reporting purposes unique to their installation. The parameter list for this exit is as follows:

Word

Description

1

Address of Set Code for report currently being generated

2

Address of print line identification code

3

Address of record type indicators

4

Address of Output Data Elements Table

The print line identification code referenced in the parameter list defines the type of print line currently being developed by the Report Writer. This code is a one-byte binary number defining the type of information currently stored in the Output Data Elements Table:

Print Line ID

Meaning

X'01'

Top line of output data element titles available for display.

X'02'

Bottom line of output data element titles available for display.

X'03'

Output data elements available for display at detail level (that is, job and job step records).

X'04'

Output data elements available for display at final summarization level.

X'05'

Output data elements available for display at summarization level 1.

X'06'

Output data elements available for display at summarization level 2.

X'07'

Output data elements available for display at summarization level 3.

X'08'

Output data elements available for display at summarization level 4.

X'09'

Output data elements available for display at summarization level 5.

X'50'

Output data elements available for display as level 1 header information.

X'60'

Output data elements available for display as level 2 header information.

X'70'

Output data elements available for display as level 3 header information.

X'80'

Output data elements available for display as level 4 header information.

X'90'

Output data elements available for display as level 5 header information.

X'FF'

End-of-file condition has occurred and no further record processing is to be performed. Previous entry should have been with identification code X'04' for final totals.

If the print line identification code is equal to X'03', then the record type indicator defines which type of record is currently being processed to develop the detail print line. The record type indicator has no meaning when the print line identification code is a value other than X'03'. This indicator is a two-byte EBCDIC field containing one of the following values:

Record Type Indicator

Meaning

1

Output Data Elements Table contains job step level information.

1

Output Data Elements Table contains job level information.

11

Output Data Elements Table contains information for a one-step job. Data created by the VM Interface is always treated as a one-step job.

The Output Data Elements Table referenced in the parameter list contains the output data elements available for display. The Tbl Dsp column defines the displacement, relative to zero, into the table for each output data element. The Len column defines the field length, and the Notes column indicates the field format after editing but prior to printing. The information in this table is available to users for verification and modification purposes. By changing the table information, you can effectively control the information that is eventually selected for display based on the DISPLAY statement.

Additionally, this information could be referenced to develop special reports and user records formatted for output by the user exit routine.

Note that only those Output Data Elements specified on a DISPLAY or EDIT statement contains valid information in the Output Data Elements Table. If the logic of an exit requires access to a data element that is not displayed, an EDIT statement can be used to force the editing of the data element and make it available. It is not recommended that numeric operations be performed on numeric output data elements since their formats may change due to dynamic re-editing to avoid high order digit truncation.