Sign-on/off Exit › Batch Signon/off Exit

Batch Signon/off Exit

In batch, the name you specify in the SXBEXIT= parameter is the name of the exit you want DQBATCH to call at signon and signoff time. See DQOPTLST Parameters for information about the valid entries and default value of the SXBEXIT= parameter.

Upon entry to the Batch Signon/off Exit:

Register 1

A one word parameter list that is the address of an 80-byte parameter area formatted as follows:

  USRFUNC   DS   CL3    Function:  SON=signon
                                   SOF=signoff
                                   EOJ=end of job
  USROPID   DS   CL32   User's DQ user ID
  USRPASS   DS   CL9    User's DQ password
  USRDATE   DS   CL8    Date signed on(off), MM/DD/YY
  USRSOTIM  DS   XL4    Signon time in seconds
  USRSFTIM  DS   XL4    Signoff (or EOJ) time in seconds
  USRRETCD  DS   X      Return code:  0 if signon valid
                                      <>0 to deny signon
            DS   CL(80-*-USRDSECT)    FFU

Register 13

Contains the address of a register SAVE area which you must use to save and restore CA Dataquery's registers according to standard linkage conventions. The exit saves the calling program's registers at offset 12 from the address in register 13.

Register 14

Contains the return address within CA Dataquery.

Register 15

Contains the address of the entry point of the exit.

CA Dataquery Batch calls the user Signon/off Exit one time for every signon statement in signon mode. If there is only one signon statement, the exit is called one time for signon, one time for signoff, and one time for end of job. For multiple signon statements, the exit is called one time for signon and one time for signoff for every signon statement, and one additional time for end of job.

For jobs submitted from online DQ by the SUBMIT function, processing is the same as for one signon statement. Deferred batch is treated as multiple signon statements if there are multiple jobs ready to be run.

Signon can be denied by the user exit by putting any nonzero return code in the parameter field USRRETCD. If signon is denied, the query that was submitted will not be executed. The return code in USRRETCD is ignored for all functions except signon.

Sample

For samples, see the CA Datacom website.