Exit XICTENF

Exit XICTENF is invoked by the interval control program when the terminal that an EXEC CICS® START command requires is unknown in this system.

When invoked
By the interval control program when the terminal that an EXEC CICS START command requires is unknown in this system. The exit program is expected to give a return code indicating whether the terminal exists on another connected CICS system and, if so, on which one.
Exit-specific parameters
UEPICEVT
Address of 2 bytes containing the type of request. The equated values of the types are:
UEPICESD
START command with data
UEPICES
START command without data.
UEPICTR
Address of 1 byte containing an indication of whether the task issuing the START command was started by transaction routing. The equated values are:
UEPICTY
A START command was being processed and the task issuing the command was transaction routed to.
UEPICTN
A START command was not being processed or a START command was being processed but the task issuing the command was not transaction routed to.
UEPICFS
Address of 1 byte containing an indication of whether the START command was function shipped. The equated values are:
UEPICFY
A START command was being processed and the START was function shipped.
UEPICFN
A START command was not being processed or a START was being processed but it was not function shipped.
UEPICTRN
Address of 4 bytes containing the name of the transaction to be run.
UEPICRTR
Address of 4 bytes containing the name of the terminal on which the transaction should run.
UEPICCTR
Address of 4 bytes containing, for START commands, the name of the current terminal if the command was transaction routed, or the name of the session if the command was function shipped.

For other START commands, the field pointed to contains blanks.

UEPICNTI
Address of 8 bytes containing, for function-shipped START commands, the netname of the last system from which the request came.

For START commands issued in this system by transaction routing to a task, the netname of the last system from which the task was routed.

For other START command situations, the field pointed to contains blanks.

UEPICSYI
Address of 4 bytes containing, if UEPICNTI contains a netname, the corresponding SYSID.

If UEPICNTI does not contain a netname, the field pointed to is blank.

UEPICNTO
Address of 8 bytes containing the contents of UEPICNTI.

If it sets a return code of ‘UERCNETN', your exit program must place in this field the netname of the system to which the ATI request should be sent.

UEPICSYO
Address of 4 bytes containing the contents of UEPICSYI.

If it sets a return code of ‘UERCSYSI', your exit program must place in this field the sysid of the system to which the ATI request should be sent.

UEPICNNI
Address of a 4-byte input field containing the netname of the terminal on which the transaction is to run, if this is known to CICS. If CICS does not know the netname, the addressed field contains blanks.
UEPICNNO
Address of a 4-byte input/output field containing, on invocation, the contents of UEPICNNI. Your exit program can use this field to supply the netname of the terminal on which the transaction is to run. It is important that your exit program supply a terminal netname if the TOR to which it directs the ATI request is a member of a z/OS® Communications Server generic resource.
Return codes
UERCTEUN
Terminal unknown, reject request.
UERCNETN
Terminal known, netname returned in UEPICNTO.
UERCSYSI
Terminal known, sysid returned in UEPICSYO.
UERCPURG
Task purged during XPI call.
XPI calls
The following must not be used:
  • ADD_SUSPEND
  • DELETE_SUSPEND
  • DEQUEUE
  • ENQUEUE
  • RESUME
  • SUSPEND
  • WAIT_MVS.