Defining Functions › Function Types, Message Types, and Function Fields › Overall User Source Considerations › EXCUSRSRC Function Example

EXCUSRSRC Function Example

Say you want to define a user-written HLL function called Get customer credit limit into another CA 2E standard function. The EXCUSRSRC function has three parameters:

To specify this function you might do the following:

1. Define the three-parameter fields as fields using the Define Objects panel.
2. Define an EXCUSRSRC function using the Edit Functions panel. The function can be attached to any file with an access path value of *NONE.
3. Specify the three parameters for the EXCUSRSRC function using the Edit Function Parameters panel.
4. From the Edit Function Details panel for the EXCUSRSRC function, change the program name for the function to the name of the source member containing the user-written code.
5. Code the EXCUSRSRC function in the nominated source member.

   Refer to the following examples of RPG and COBOL and then proceed to Step 6.

   The following example shows RPG EXCUSRSRC.

** Get customer credit limit                      ) <- IGNORED
** Company      : Universal Sprocket Co           )
** System       : Widget processing system        )
** Author       : YOU                             )
FUUCUCRLOIF       E    K    DISK                  ) <- OTHER SPECIFICATIONS
 * Customer credit limits                         )

 * Set up parameters                              ) <- INSTANCE CODE
C                  MOVE #ICUCD  UACUNB            )
C                  Z-ADD#ITRQT  UATRQT            )
C                  EXSR UACRLM                    )
C                  Z-ADDUACRLM  #OTRLM            )
CSR UACRLM         BEGSR                          ) <- SUBROUTINE
*================================================ )=============================
* Get credit limit                                )
*================================================ )=============================
C                  MOVEA*IN,60  UWIN  1           ) *Save
* Set of record error indicators.                 )
C      UACUNB      CHAIN @ CUCRQQ              60 )
C      *IN60       IFEQ '0'                       )
C      UATRQT      ADD QQCRLM   UACRLM            )
C      END                                        )
C         _       MOVEA UWIN    *IN,60            ) *Restore
*================================================ )=============================
CSR    UAEXIT      ENDSR                          )

* Initialization for credit test                  )
*================================================ )=============================
C                  Z-ADD*ZERO   UACRLM            ) <- ZZINIT code
*================================================ )=============================

The following example shows COBOL EXCUSRSRC.

+++++ -A 1 B .. ... 2 ... ... 3
  ** Get customer credit limit                             ) <- IGNORED
  ** Company      : Universal Sprocket Co                  )
  ** System       : Widget processing system               )
  ** Author       : FRED                                   )
     INPUT-OUTPUT SECTION.                                 ) <- OTHER
     FILE-CONTROL.                                         )     SPECIFICATIONS
       SELECT UUCUCRL0                                     )
       ASSIGN TO DATABASE-CBABREL1                         )
       ORGANIZATION IS INDEXED                             )
       ACCESS MODE IS DYNAMIC                              )
       RECORD KEY IS EXTERNALLY-DESCRIBED-KEY              )
       FILE STATUS is FILE-STATUS.                         )
  * Customer credit limits                                 )
  FILE-SECTION.                                            )
  FD UUCUCRL0                                              )
     LABEL RECORDS ARE STANDARD.                           )
  01 UUCUCRL0-F.
   COPY DDS-ALL-FORMATS OF UUCUCRL0.

  WORKING-STORAGE SECTION.                                 ) <- NEW VARIABLES
  01 UWIN  PIC X.                                          )

  PROCEDURE-DIVISION.                                      ) <- INSTANCE CODE
  * Set up parameters                                      )
   MOVE USR-PARM-I-CUCD TO UACUNB OF YCUCRQQ               )
   MOVE USR-PARM-I-TRQT TO UATRQT OF YCUCRQQ               )
   PERFORM UACRLM                                          )
   MOVE UACRLM OF YCUCRQQ TO USR-PARM-O-TRLM               )

  * Get credit limit                                       ) <- SUBROUTINE
  UACRLM SECTION.                                          )
   MOVE IND(60) TO UWIN                                    )
  * Set of record error indicators.                        )
   READ UUCUCRL0                                           )
    FORMAT IS ‘YCUCRQQ’                                    )
   END-READ                                                )
   IF C-NO-RECORD                                          )
      MOVE C-IND-ON TO IND(60)                             )
   ELSE                                                    )
      MOVE C-IND-OFF TO IND(60)                            )
   END-IF                                                  )

   IF IND(60) = C-IND-ON                                   )
      ADD UATRQT OF YCUCRQQ, QQCRLM                        )
       GIVING UACRLM OF YCUCRQQ                            )
      END-ADD                                              )
   END-IF                                                  )

1. In the action diagram of the function from which you want to call the Get customer credit limit function, insert an action:

> USER: User defined action
: -
: Get customer credit limit * < < <
'-

Supply the required parameters for the action using the Edit Action Details panel. For example:

The following table shows an example of the code generated for the call. These are the names of the values passed to the parameters.

CA 2E generates the following RPG and COBOL code for the particular call:

UAEXIT.                                           )
 EXIT.                                            )

* ZZINIT code.
USR-INIT SECTION.                                 ) < - ZZINIT CODE
 MOVE ZEROES TO UACRLM OF YCUCRQQ                 )

The following example shows EXCUSRSRC - RPG call.

* Get customer credit details
* Set up parameters
C               MOVE # 1CUCD        UACUNB
C               Z-ADD #2ORQT        UATRQT
C               EXSR UACRLM
C               Z-ADDUACRLM         #1CULM

The following example shows EXCUSRSRC - COBOL Call.

+++ -A 1 B.. ... 2 ... ... 3
   * Get customer credit details
   * Set up parameters
          MOVE Z1CUCD OF ZSFLRCD-WS-O TO UACUNB OF YCUCRQQ
          MOVE Z2ORQT OF ZSFLCTL-WS-O TO UATRQT OF YCUCRQQ
          PERFORM UACRLM
          MOVE UACULM OF YCUCRQQ TO Z1CULM OF ZSFLRCD-WS-O

CA 2E includes the other source code statements for the EXCUSRSRC function into the source of the calling function without modification.