Batch Submit Exit › Batch Submit Exit in CICS

Batch Submit Exit in CICS

Operation

If you use a Batch Submit Exit, CA Dataquery invokes your user-written Batch Submit Exit program whenever a job stream is submitted to the system. For CICS, this user exit must be a command-level or macro-level CICS program. Information is passed to the user exit in an 80-byte CICS temporary storage record. The user exit reads the temporary storage record. The following is the format for the 8-character name of the temporary storage record:

DQnnnnSX

where nnnn is the CICS terminal ID.

The information passed consists of the 80-byte area as follows:

    USRDSECT  DSECT       User Batch Submit Exit Parameter DSECT
    USRCURL   DS    F     Number of Lines of JCL
    USRMAXL   DS    F     Maximum Number of Lines Allowed
    USRRETCD  DS    F     Return Code to CA Dataquery
    USRJCLAD  DS    F     Address of JCL
    USRNAME   DS    CL32  Name of Submitting User
    USRPASS   DS    CL9   User's Password (encrypted)
    USREXPNM  DS    CL15  Name of export set, if any
    USROTEXT  DS    XL4   Address of query text
    USREXPTP  DS    CL1   Type (V-Variable, F-Fixed, Blank-Not Export)
              DS    CL(80-(*-USRDSECT))

Procedure

Use the SUBEXIT= parameter in the DQOPTLST macro to specify a name for an exit called by the submit processor before the JCL for a batch job is submitted to the internal reader. If you specify blanks for SUBEXIT=, it means you want no exit. Blanks is the default value.

The user exit can update the JCL in place as needed. The exit can also do any CICS monitor calls except that it cannot do a write to the terminal or create a transaction boundary. After performing any functions required, the exit needs to:

1. Place a return code in the USRRETCD field of the temporary storage record.
2. Update the temporary storage record.
3. Return control to CA Dataquery.

The updated JCL is at the address passed to the exit in the USRJCLAD field. Any return code except zero causes cancellation of the job submission.

Sample

For samples, see the CA Datacom website.