List of global user exit points

Table 2 lists the global user exit points in alphabetical order, giving a brief description and a topic reference at which more information about each exit can be found.

Table 2. Alphabetical list of global user exit points
Exit name Module or domain Where or when invoked Page
XAKUSER Activity keypoint program Immediately before the ‘end of keypoint’ record is written. Exit XAKUSER
XALCAID Terminal allocation program Whenever an AID with data is canceled. Exit XALCAID
XALTENF Terminal allocation program When an ATI request from transient data or interval control requires a terminal that is unknown in this system. Exit XALTENF
XBMIN Basic Mapping Support When an input mapping operation completes successfully. Exit XBMIN
XBMOUT Basic Mapping Support When a page of output has been built successfully. Exit XBMOUT
XDLIPOST DL/I interface program On exit from the DL/I interface program. Exit XDLIPOST
XDLIPRE DL/I interface program On entry to the DL/I interface program. Exit XDLIPRE
XDSAWT Dispatcher domain After an operating system wait. Exit XDSAWT
XDSBWT Dispatcher domain Before an operating system wait. Exit XDSBWT
XDTAD Data tables management When a write request is issued to a data table. Exit XDTAD
XDTLC Data tables management At the completion of loading of a data table. Exit XDTLC
XDTRD Data tables management During the loading of a data table, whenever a record is retrieved from the source data set. Exit XDTRD
XDUCLSE Dump domain After the domain closes a transaction dump data set. Exit XDUCLSE
XDUOUT Dump domain Before the domain writes a record to the transaction dump data set. Exit XDUOUT
XDUREQ Dump domain Before the domain takes a system or transaction dump. Exit XDUREQ
XDUREQC Dump domain After a system or transaction dump has been taken (or failed or been suppressed). Exit XDUREQC
XEIIN EXEC interface program Before the execution of any EXEC CICS API or SPI command. Exit XEIIN
XEIOUT EXEC interface program After the execution of any EXEC CICS API or SPI command. Exit XEIOUT
XEISPIN EXEC interface program Before the execution of any EXEC CICS SPI command except EXEC CICS ENABLE, EXEC CICS DISABLE, EXEC CICS EXTRACT EXIT, EXEC CICS PERFORM DUMP, or EXEC CICS RESYNC ENTRYNAME. Exit XEISPIN
XEISPOUT EXEC interface program After the execution of any EXEC CICS SPI command except EXEC CICS ENABLE, EXEC CICS DISABLE, or EXEC CICS EXTRACT EXIT, EXEC CICS PERFORM DUMP, or EXEC CICS RESYNC ENTRYNAME. Exit XEISPOUT
XFAINTU 3270 bridge facility management program When a bridge facility is created or deleted. Exit XFAINTU
XFCAREQ File control EXEC interface program Before CICS® processes a file control SPI request. File control EXEC interface SPI exits XFCAREQ and XFCAREQC
XFCAREQC File control EXEC interface program After a file control SPI request has completed. File control EXEC interface SPI exits XFCAREQ and XFCAREQC
XFCBFAIL File control recovery control program When an error occurs during the backout of a UOW. Exit XFCBFAIL, file control backout failure exit
XFCBOUT File control recovery control program When CICS is about to back out a file update. Exit XFCBOUT, file control backout exit
XFCBOVER File control recovery control program When CICS is about to skip backout of a UOW because a batch program has overridden RLS retained lock protection and opened a data set for batch processing. Exit XFCBOVER, file control backout override exit
XFCFRIN File control domain Before the execution of a file control request. XFCFRIN
XFCFROUT File control domain After the execution of a file control request. XFCFROUT
XFCLDEL File control recovery control program When backing out writes to a VSAM ESDS or a BDAM data set. Exit XFCLDEL, file control logical delete exit
XFCNREC File control open/close program When a mismatch is detected between the backout recovery setting for a file and its associated data set during file open processing. Exit XFCNREC
XFCQUIS File control quiesce send program On completion, successful or failed, of a SET DSNAME QUIESCESTATE command. File control quiesce send exit XFCQUIS
XFCREQ File control EXEC interface program Before CICS processes a file control API request. Exit XFCREQ
XFCREQC File control EXEC interface program After a file control API request has completed. Exit XFCREQC
XFCSREQ File control file state program Before a file OPEN, CLOSE, ENABLE, or DISABLE command is attempted. File control file state program exits XFCSREQ and XFCSREQC
XFCSREQC File control file state program After a file OPEN, CLOSE, CANCEL CLOSE, ENABLE, or DISABLE command has been completed. File control file state program exits XFCSREQ and XFCSREQC
XFCVSDS File control quiesce receive program After RLS has informed CICS that processing is required as a result of a data set-related action occurring in the sysplex. File control quiesce receive exit, XFCVSDS
XGMTEXT "Good morning" message program Before the "good morning" message is sent. "Good morning" message program exit XGMTEXT
XICEREQ Interval control EXEC interface program Before CICS processes an interval control API request. Exit XICEREQ
XICEREQC Interval control EXEC interface program After an interval control API request has completed. Exit XICEREQC
XICERES Interval control EXEC interface program Before CICS processes a non-terminal-related EXEC CICS START request that has been dynamically routed to this region, where the routing region supports the "resource unavailable" (RESUNAVAIL) condition. Exit XICERES
XICEXP Interval control program After expiry of an interval control time interval. Exit XICEXP
XICREQ Interval control program At the start of the interval control program, before request analysis. Exit XICREQ
XICTENF Interval control program When an EXEC CICS START command requires a terminal that is unknown in this system. Exit XICTENF
XISCONA Intersystem communication program When a function shipping or DPL request is about to be queued because no sessions to the remote region are immediately available. Intersystem communication program exits XISCONA and XISLCLQ
XISLCLQ Intersystem communication program After an attempt to allocate a session for a function shipped START NOCHECK request fails because the remote system is not in service, a connection to the remote system cannot be established, or no sessions are immediately available and your XISCONA exit program has specified that the request is not to be queued in the issuing region. The XISLCLQ exit
XLDELETE Loader domain After an instance of a program is released by CICS and just before the program is freed from storage. Exit XLDELETE
XLDLOAD Loader domain After an instance of a program is brought into storage, and before the program is made available for use. Exit XLDLOAD
XLGSTRM Log manager domain After the CICS log manager detects that a log stream does not exist, and before calling the MVS™ system logger to define the log stream. Log manager domain exit XLGSTRM
XMEOUT Message domain Before a message is sent from the message domain to its destination. Exit XMEOUT
XMNOUT Monitoring domain Before a record is either written to SMF or buffered before a write to SMF. Exit XMNOUT
XNQEREQ Enqueue EXEC interface program Before CICS processes an enqueue API request. Exit XNQEREQ
XNQEREQC Enqueue EXEC interface program After an enqueue API request has completed. Exit XNQEREQC
XPCABND Program control program Start of changeAfter a transaction abend and before a dump call is made.End of change Exit XPCABND
XPCERES Program control program Before CICS processes a program link or Link3270 bridge request that has been dynamically routed to this region, where the routing region supports the "resource unavailable" (RESUNAVAIL) condition. Exit XPCERES
XPCFTCH Program control program Before an application program is given control. Exit XPCFTCH
XPCHAIR Program control program Before a HANDLE ABEND routine is given control. Exit XPCHAIR
XPCREQ Program control program Before a LINK request is processed. Exit XPCREQ
XPCREQC Program control program After a LINK request has been completed. Exit XPCREQC
XPCTA Program control program After an abend occurs, and before the environment is modified. Exit XPCTA
XRCINIT User log record recovery program During warm and emergency restart, if user recovery log records are detected in the CICS system log. Exit XRCINIT
XRCINPT User log record recovery program During warm and emergency restart, for each user recovery log record found in the CICS system log. Exit XRCINPT
XRMIIN Resource manager interface program Before execution of an EXEC DLI, EXEC SQL, or RMI command. Exit XRMIIN
XRMIOUT Resource manager interface program After execution of an EXEC DLI, EXEC SQL, or RMI command. Exit XRMIIN
XRSINDI Resource management modules Immediately after a successful install or discard of a resource. Resource management install and discard exit XRSINDI
XSNEX Security manager domain Restore old CICS signon and signoff behavior (pre-CICS TS 2.1) Exit XSNEX
XSNOFF Security manager domain After a terminal user signs off. Exit XSNOFF
XSNON Security manager domain After a terminal user signs on. Exit XSNON
XSRAB System recovery program When the system recovery program finds a match for an MVS abend code in the SRT. Exit XSRAB
XSTERM System termination program During a normal system shutdown, immediately before TD buffers are cleared. Exit XSTERM
XSTOUT Statistics domain Before a statistics record is written to SMF. Exit XSTOUT
XSZARQ Front End Programming Interface After a FEPI request has completed. Front End Programming Interface exits XSZARQ and XSZBRQ
XSZBRQ Front End Programming Interface Before a FEPI request is actioned. Front End Programming Interface exits XSZARQ and XSZBRQ
XTCATT Terminal control program Before task attach. Exit XTCATT
XTCIN Terminal control program After an input event. Exit XTCIN
XTCOUT Terminal control program Before an output event. Exit XTCOUT
XTDEREQ Transient data EXEC interface program Before CICS processes a transient data API request. Exit XTDEREQ
XTDEREQC Transient data EXEC interface program After a transient data API request has completed. Exit XTDEREQC
XTDIN Transient data program After receiving data from QSAM (extrapartition) or VSAM (intrapartition). Exit XTDIN
XTDOUT Transient data program Before passing data to a QSAM (extrapartition) or VSAM (intrapartition) user-defined transient data queue. Exit XTDOUT
XTDREQ Transient data program Before request analysis. Exit XTDREQ
XTSEREQ Temporary storage EXEC interface program Before CICS processes a temporary storage API request. Exit XTSEREQ
XTSEREQC Temporary storage EXEC interface program After a temporary storage API request has completed. Exit XTSEREQC
XTSPTIN Temporary storage domain Before invocation of a TSPT function. Exit XTSPTIN
XTSPTOUT Temporary storage domain After invocation of a TSPT function. Exit XTSPTOUT
XTSQRIN Temporary storage domain Before invocation of a TSQR function. Exit XTSQRIN
XTSQROUT Temporary storage domain After invocation of a TSQR function. Exit XTSQROUT
Start of changeXWBOPENEnd of change Start of changeWeb domainEnd of change Start of changeDuring processing of an EXEC CICS WEB OPEN command.End of change Start of changeHTTP client open and send exits, XWBOPEN and XWBSNDOEnd of change
Start of changeXWBSNDOEnd of change Start of changeWeb domainEnd of change Start of changeDuring processing of an EXEC CICS WEB SEND command.End of change Start of changeHTTP client open and send exits, XWBOPEN and XWBSNDOEnd of change
XXDFA DBCTL interface control program In the active CICS when CICS-DBCTL connection fails. DBCTL interface control program exit XXDFA
XXDFB DBCTL tracking program In the alternate CICS when DBCTL fails. Exit XXDFB
XXDTO DBCTL tracking program In the alternate CICS when active DBCTL fails. Exit XXDTO
XXMATT Transaction manager domain When a user transaction is attached. Exit XXMATT
XXRSTAT XRF request processing program After a VTAM® failure or a predatory takeover. Exit XXRSTAT
XZCATT VTAM terminal management program Before task attach. Exit XZCATT
XZCIN VTAM working set module After an input event. Exit XZCIN
XZCOUT VTAM working set module Before an output event. Exit XZCOUT
XZCOUT1 VTAM working set module Before a message is broken into RUs. Exit XZCOUT1
XZIQUE VTAM working set module
  1. When an allocate request for a session is about to be queued.
  2. When an allocate request succeeds following previous suppression of queuing.
XZIQUE exit for managing intersystem queues

The following sections give detailed information about each of the global user exit points, including:

In the following sections, the exit points are grouped according to their functional relationships. This usually means according to the CICS module or domain in which they occur. However, where exit points in different modules serve a similar function (XALTENF in the terminal allocation program and XICTENF in the interval control program, for example), the exits are grouped under a generic name (for example, "Terminal not known" condition exits). The groups of exits are presented in alphabetical order of module or generic name.

Accessing fields in CICS control blocks

When writing a program to be invoked from any of the global user exit points, note the warning contained in Restrictions on the use of fields as programming interfaces about the use of control block fields as programming interfaces.

Related concepts
Overview -- what is a global user exit?
Overview of the XPI
Global user exit XPI examples, showing the use of storage
Related tasks
Writing global user exit programs
Making an XPI call
Related reference
The XPI functions
[[ Contents Previous Page | Next Page Index ]]