The VM Interface › User Exit Routines › Exit #1

Exit #1

This exit provides you with control immediately following the grouping feature logic and prior to the application of the accounting algorithm for each accounting record being processed. This lets you to test or apply a unique algorithm to any record reaching this phase of processing.

Historical data is passed to the user exit routine prior to all old account records.

The parameter list for this exit is as follows:

All these tables are described on the following pages. For VM data, the RATE, PRIORITY, and RJERATE statement information tables contain binary zeros, since these three statement types are not used under CMS.

The RATE statement information table consists of a variable number of entries, with the last valid entry being followed by an entry containing low-values (x'00'). Each entry is basically in the same format as the RATE statement as shown on the following page.

RATE Statement:

The VMRATE statement information table consists of a variable number of entries with the last entry being followed by an entry containing low-values (x'00'). Each entry is basically in the same format as the VMRATE statement as follows. All data is in EBCDIC format.

VMRATE Statement:

The PRIORITY statement information table consists of a variable number of entries with the last entry being followed by an entry containing low-values (x'00'). Each entry is basically in the same format as the PRIORITY statement as follows:

PRIORITY Statement:

The FORMRATE statement information table consists of a variable number of entries with the last entry being followed by an entry containing low-values (x'00'). Each entry is in a format similar to the FORMRATE statement with numeric fields converted to packed decimal as follows:

FORMRATE Statement:

The RJERATE statement information table consists of a variable number of entries with the last entry being followed by an entry containing low-values (x'00'). Each entry is in a format similar to the RJERATE statement with numeric fields converted to packed decimal as follows:

RJERATE Statement:

When the record being processed is a summary record from the historical database, the working storage area contains the time and charge values accumulated into that record when it was created.

Only the RATE, VMRATE, FORMRATE, RJERATE, and PRIORITY statements required to generate a given report are present in their respective tables during this execution phase. Table entries are in the same order as the statements were read by the Report Writer.

The working storage area referenced in the parameter list contains the following fields:

The Charge Suffix indicates that the Total Charge field contains one of the following values:

Each accounting record and all pertinent billing parameters are made available through the parameter list. You can modify information in the accounting record and calculate the various time and charge fields related to the record.

Upon entry to the user exit routine, the time and charge fields in working storage are initialized and available for calculations. When the record being processed is a summary record from the historical database, the working storage area contains the time and charge values accumulated into that record when it was created.

The one-byte EBCDIC disposition indicator, as referenced through the parameter list, is blank upon entry to the user exit routine. A hex 'FF' (high values) upon entry indicates that an end-of-file condition has occurred and no further record processing is to be performed.

You should take this opportunity to prepare totals, generate user-formatted reports, close any files you opened, etc. You can optionally set the one-byte EBCDIC disposition indicator to specify the following action to be taken upon each return to the Report Writer: