Exit programs

Top  Previous  Next

Some aspects of the configuration as well as some run-time behaviour of XCICS/TS may be influenced and/or driven by user exit programs.

An exit program is a C language routine, written by the user and declared at configuration time.

XCICS/TS supports the following type of exit programs

type

description

odcs_ts

the routine is invoked by XCICS/TS to convert the temporary storage records, whenever a TS queue is accessed on or by remote EBCDIC systems.

This routine must conform to the rules defined by the XCICS/TS Online Data Conversion System (ODCS)

snt_loader

the routine is invoke by XCICS/TS at configuration time (startup and reconfigure) to feed the SNT tables.

User may provide this routine whenever he need to define users programmatically (i.e. users are red from a DB and automatically defined)

user_signon

the routine is invoked by XCICS/TS when the operator tries to SIGNON (CESN transaction or EXEC CICS SIGNON command). The routine receives the USERID and the PASSWORD entered by the operator and decide if the operator is authorized to sign on.

user_signoff

the routine is invoked by XCICS/TS when user signs off (CESF or EXEC CICS SIGNOFF).

user_chpasswd

the routine is invoked by XCICS/TS when the operator tries to change his password (CESN transaction or EXEC CICS SIGNON NEWPASSWORD command). The routine receive the USERID and the PASSWORDs entered by the operator.

dfhaid

the routine is invoked by XCICS/TS when the operator enters an AID, and has the capability to alter the transaction startup, i.e changing the behaviour of the AID or the RETURN TRANSID.

For further information about exit programs creation and usage please refer to the "Customization Guide".

Exit programs are declared with the define exit_program directive

define exit_program

Syntax

define exit_program
type=(odcs_ts|snt_loader|user_signon|user_signoff|user_chpasswd|dfhaid),
function=<value>,
[library="<value>"];

 

type

This is the type of exit program being defined.

function

The name of the routine.

library

The name shared library containing the routine. If the library is not in the linker loading path (LD_LIBRARY_PATH, SHLIB_PATH, LIBPATH) the absolute path must be provided. If the library parameter is omitted, the function is searched in the libraries previously loaded with the "load library" directive.

Example

define exit_program type=user_signon,   function=dfhep_signon,   library=libuserid.so;
define exit_program type=user_signoff,  function=dfhep_signoff,  library=$HOME/lib/libsignoff.so;