Programmable Interfaces › CA Top Secret CICS Exits › The TSSPGM01 Exit

The TSSPGM01 Exit

The TSSPGM01 exit is enabled by defining the PROGRAM=TSSPGM01 to your CICS environment. CA Top Secret CICS invokes the exit by issuing:

EXEC 	CICS LINK
     	PROGRAM
     	COMMAREA
     	LENGTH
     	RESP

TSSPGM01 can be invoked before CA Top Secret issues any CA Top Secret CICS messages (except password prompts). The exit program must be written in Command‑Level Assembler. The COMM area layout is:

  WPARMLIST 	DS	OH           PARAMETER LIST FOR EXIT
  WMESSAGE  	DS    	XL800        MESSAGE AREA
  WMSGLRC   	DS    	X            RETURN CODE
  $TEXIT    	EQU   	X'00'        EXIT MODULE
  $TWRTTD   	EQU   	X'01'        WRITE MESSAGE TO TD QUEUE
  $TWRITE   	EQU   	X'02'        WRITE MESSAGE TO TERMINAL
  $TABEND   	EQU   	X'FF'        ABEND TASK
  WMSGALN   	EQU   	*‑WPARMLST   PARAMETER LIST LENGTH

Note: If running CICS/ESA, this exit must run AMODE(31).

WMESSAGE

Contains the message to be written to the user's terminal. The message is in a BMS Send TEXT format.

WMSGLRC

Contains a return code the user will enter in the TSSPGM01 exit program.

$TEXIT

Indicates that CA Top Secret messages are not written to the user's terminal.

$TWRTTD

Writes the CA Top Secret message to the CSML Transient Data Queue.

$TWRITE

Writes the CA Top Secret message to the user's terminal.

$TABEND

Is the ABEND transaction (ABEND Code TAZ7).

Note: A sample exit program resides in CAI.CAKOSRC0, and the JCL to assemble and link it resides in CAI.CAKOJCL0.