Batch Processing & Reporting › CA PMA Chargeback Processing › The User Exit for CAKRLOAD

The User Exit for CAKRLOAD

The following information describes the detail linkage conventions for interfacing to CA PMA Chargeback's user exit.

To accommodate installation accounting and reporting requirements not supported by CA PMA Chargeback standard features, a user exit routine is provided to augment or modify the actions normally taken. This user exit should be written in Assembler Language, although any language with standard IBM linkage is acceptable, such as COBOL.

The exit routine must reside in a LNKLST library or in the library in which CA PMA Chargeback resides, as indicated by the STEPLIB DD statement, or in a library concatenated to the STEPLIB DD statement.

It is not necessary to link edit an exit routine with any part of CA PMA Chargeback. The exit routines are compiled and linked independently of CA PMA Chargeback. CA PMA Chargeback uses a late binding technique of exit name specification.

The user exits use standard IBM linkage conventions. Upon entry from CA PMA Chargeback, the registers are as follows:

             Register     Description
               15         Address of exit routine's entry point
               14         Return address
               13         Address of register save area
                1         Address of parameter list as defined
                          on the next page

• Each call to any exit point by CA PMA Chargeback is identical, except the case of EOF on input. That is, there is no first time flag or signal to the exit.
• Please note that these exits do not have to be reentrant (RENT) nor reusable (REUS).
• The name of the exit's load module is up to you. The name you choose is specified in the CAKRLOAD_EXIT parameter in the CAIKSPAR file.
• A dummy load module with the default name of CA$KRLD is supplied in the CAJRLOAD library. If no name is specified in the CAKRLOAD_EXIT parameter, this dummy module will be called.
• A default CA$KRLD exit source module is provided, but we recommend that this source be used only as a sample in the creation of your own exit, and that you provide your own unique source and load module name.

This sample user exit is provided as member name CA$KRLD in the CAJRSAMP library.

CA$KRLD  CSECT
*
**********************************************************************
*
*       CA$KRLD - DUMMY EXIT ROUTINE FOR CAKRLOAD
*
*  THIS ROUTINE SHOULD BE REPLACED BY THE USER IF AN EXIT ROUTINE IS
*  NEEDED. IT MUST FOLLOW STANDARD IBM LINKAGE CONVENTIONS. THIS
*  ROUTINE TAKES ONE PARAMETER WHICH IS A POINTER TO THE E15 PROCESS
*  DATA BUFFER.
*
*  THIS DUMMY ROUTINE RETURNS WITH A RETURN CODE OF ZERO.
*
*  THE USER WRITTEN ROUTINE SHOULD:
*
*           RETURN ZERO MEANING WRITE, DO NOT CALL AGAIN
*                  FOUR         WRITE, CALL AGAIN
*                  EIGHT        DO NOT WRITE, DONE WITH EXIT PROCESSING
*
*       ANY OTHER RETURN CODE WILL CAUSE CAKRLOAD TO TERMINATE
*
*    FIELD             LENGTH   PARMAMETER      TYPE
*                               LIST +
*
*   VERSION               8         0          CHARACTER
*   ORDID                 3         8          CHARACTER
*   STRUCTURE 1          16        11          CHARACTER
*   STRUCTURE 2          16        27          CHARACTER
*   STRUCTURE 3          16        43          CHARACTER
*   STRUCTURE 4          16        59          CHARACTER
*   STRUCTURE 5          16        75          CHARACTER
*   PERIOD NUMBER         4        91          BINARY
*   ELEMENT              16        95          CHARACTER
*   QUALIFIER            16       111          CHARACTER
*   MODIFIER             16       127          CHARACTER
*   RATE                  8       143          PACKED
*   SPLIT FLAG            1       151          CHARACTER
*   MODIFIED FLAG         1       152          CHARACTER
*
*                      END OF THE SORT KEY
*
*   COUNT                 4       153          BINARY
*   PERIODBILLED          4       157          BINARY
*   UNITS                 8       161          PACKED
*   CHARGE                8       169          PACKED
*
*
*
**********************************************************************

*
R1       EQU   1
R2       EQU   2
R3       EQU   3
R4       EQU   4
R5       EQU   5
R6       EQU   6
R7       EQU   7
R8       EQU   8
R9       EQU   9
R10      EQU   10
R11      EQU   11
R12      EQU   12
R13      EQU   13
R14      EQU   14
R15      EQU   15
*
         USING *,R15                ESTABLISH BASE REGISTER
         L     2,0(1)               LOAD REG WITH CALLER'S PARM LIST
*
**********************************************************************
*
*        EXIT CODE GOES HERE
*
**********************************************************************
*
         SLR   R15,R15              RETURN CODE ZERO FOR THIS STUB
         BR    R14
         LTORG
         END