Global user exit points (by function)
The exit points are grouped according to their functional relationships.
Grouping is generally based on the CICS® module or domain in which the exit points occur. However, where exit points in different modules serve a similar function, the exits are grouped under a generic name. The groups of exits are presented in alphabetical order of module or generic name.
The following information is provided for each global user exit point:
- Exit identifier
- Exit location
- DFHUEPAR parameters, if any, that are unique to the exit
- Valid return codes
- XPI calls that can be invoked.
- Global user exit points (in alphabetical order)
For each exit, this table shows the exit name, the module or domain, where or when the exit is invoked, and includes a link to additional information. - Activity keypoint program exit (XAKUSER)
The XAKUSER exit is invoked during the activity keypointing process. You can use this exit to record, on the system log, user data that must be restored following an emergency restart. - Application association data exit in the AP domain (XAPADMGR)
Use the XAPADMGR exit for distributed transactions. XAPADMGR allows you to add user information to the association data of a task, at the point of origin of the distributed transaction. This information could be used later, for example, as a search key for processing carried out through CICSPlex® SM. - Basic mapping support exits (XBMIN, XBMOUT)
Two basic mapping support exits are provided: XBMIN and XBMOUT. The XBMIN exit allows you to intercept a RECEIVE MAP request after BMS has successfully processed the request. The XBMOUT exit allows you to intercept a SEND MAP request after BMS has successfully processed the request; or, if cumulative mapping is in progress, on completion of each page of output. - Bridge facility exit XFAINTU
The bridge facility exit is called just after a new bridge facility has been built and just before the bridge facility is deleted. - Data tables management exits XDTRD, XDTAD, and XDTLC
Data tables management exits apply to both CICS shared data tables and CICS coupling facility data tables. - DBCTL interface control program exit (XXDFA)
This exit is invoked by an active CICS if its connection to DBCTL fails. - DBCTL tracking program exits (XXDFB, XXDTO)
These exits are invoked if the connection to DBCTL fails, or if CICS performs takeover. - Dispatcher domain exits XDSBWT and XDSAWT
The XDSBWT and XDSAWT exit points are located before and after the operating system wait. You cannot use CICS services in an exit program that is invoked from these exit points. - DL/I interface program exits XDLIPRE and XDLIPOST
The XDLIPRE and XDLIPOST exit points are invoked following the issue of an EXEC DLI command or DL/I call. Exit XDLIPRE is invoked before the request is processed and XDLIPOST is invoked after the request is processed. - Dump domain exits XDUREQ, XDUREQC, XDUCLSE, and XDUOUT
You can use dump domain exits to capture information before and after a transaction dump or system dump. - Enqueue EXEC interface program exits XNQEREQ and XNQEREQC
You can use the XNQEREQ exit to intercept enqueue API requests before any action has been taken on the request. You can use the XNQEREQC exit to intercept the response after an enqueue API request has completed. - Event capture exit XEPCAP
The XEPCAP exit is invoked just before an event is captured by CICS event processing. Use the XEPCAP exit to detect when events are captured. - EXEC interface program exits XEIIN, XEIOUT, XEISPIN, and XEISPOUT
There are four global user exit points in the EXEC interface program that you can use before or after an API or SPI call. - Front End Programming Interface exits XSZARQ and XSZBRQ
If you have installed the Front End Programming Interface (FEPI), you can use global user exits XSZARQ and XSZBRQ before and after FEPI commands. - File control domain exits, XFCFRIN and XFCFROUT
The XFCFRIN exit is invoked on entry to the main file control request gate, FCFR, and the XFCFROUT exit runs after the completion of a file control request. The XFCFRIN and XFCFROUT exits must be coded to threadsafe standards and declared threadsafe to take advantage of threadsafe remote file support. - File control EXEC interface API exits XFCREQ and XFCREQC
The XFCREQ exit allows you to intercept a file control application programming interface (API) request before any action has been taken on it by file control. The XFCREQC exit allows you to intercept a file control API request after file control has completed its processing. - File control EXEC interface SPI exits XFCAREQ and XFCAREQC
The XFCAREQ exit allows you to intercept a file control system programming interface (SPI) request before any action has been taken on it by file control. The XFCAREQC exit allows you to intercept the response after a file control SPI request has completed. - File control file state program exits XFCSREQ and XFCSREQC
Two user exits are provided in the file control state program that you can call before and after a file request. - File control open/close program exit XFCNREC
You can use XFCNREC to suppress the open failure on a non-RLS data set. - File control quiesce receive exit, XFCVSDS
The XFCVSDS exit is invoked when VSAM RLS notifies CICS that processing is required as a result of some data set-related events occurring in the sysplex. - File control quiesce send exit XFCQUIS
The XFCQUIS global user exit is invoked on completion of a VSAM RLS quiesce or unquiesce of a data set that was requested either by a CEMT or EXEC CICS SET DSNAME QUIESCESTATE command. - File control recovery program exits XFCBFAIL, XFCBOUT, XFCBOVER, and XFCLDEL
CICS provides four global user exits that you can use in connection with file control recovery operations. - File control RLS coexistence program exit XFCRLSCO
The XFCRLSCO exit can be called during a request to open a file. Use this exit to allow an application to switch the mode between RLS and read-only non-RLS to access a particular data set. - Good morning message program exit (XGMTEXT)
This exit is invoked before a "good morning" message is sent. - HTTP client open and send exits: XWBAUTH, XWBOPEN and XWBSNDO
Exits XWBAUTH, XWBOPEN and XWBSNDO are invoked during processing of EXEC CICS WEB CONVERSE, EXEC CICS WEB OPEN, EXEC CICS INVOKE SERVICE, and EXEC CICS WEB SEND commands. They are used in making HTTP client requests from CICS as an HTTP client, which is a facility provided by CICS Web support. - Intersystem communication program exits, XISCONA, XISLCLQ, and XISQLCL
The three exits in the intersystem communication program allow you to control the length of intersystem queues. - Interval control program exits XICREQ, XICEXP, and XICTENF
You can use some XPI calls in exit programs invoked from the interval control program. However, when any of these exits are invoked for expiry analysis, any actions that delay the execution of the interval control program can have adverse effects on other transactions that are waiting for intervals to expire. - Interval control EXEC interface program exits (XICEREQ, XICERES, and XICEREQC)
These exits are invoked when interactions with interval control programs occur. - Loader domain exits XLDLOAD and XLDELETE
There are two global user exits in the loader domain. XLDLOAD is invoked when a new instance of a program is loaded into storage, before the program is made available for use. - Log manager domain exit XLGSTRM
There is one exit point, XLGSTRM, in the log manager domain. You can use XLGSTRM to modify a request to MVS™ to create a new log stream. You can change the model log stream name and other parameters before they are passed to the MVS system logger. - Message domain exit XMEOUT
You can use the XMEOUT exit to suppress or reroute CICS and CICSPlex SM messages that use the CICS message domain. - Monitoring domain exit (XMNOUT)
This exit is invoked before monitoring records are written to SMF or to the record buffers. - Pipeline domain exits
Use the pipeline domain exits to customize the processing that occurs for inbound and outbound web services in the pipeline. You can use the pipeline domain exits to access containers on a Web services provider pipeline, a web services requester pipeline, or a web services requester pipeline that contains a security message handler. - Program control program exits (XPCREQ, XPCERES, XPCREQC, XPCFTCH, XPCHAIR, XPCTA, and XPCABND)
These exits are invoked before or after CICS program control operations, including program link requests, a program receiving control, and a transaction abend. - Resource manager interface program exits (XRMIIN, XRMIOUT)
These exits are invoked when RMI API requests are processed. - Resource management installation and discard exit XRSINDI
The XRSINDI global user exit is driven, if it is enabled, immediately after CICS successfully installs or discards a resource definition. - Signon and signoff exits XSNON, XSNOFF, and XSNEX
Exit XSNON is invoked after a terminal user signs on, and exit XSNOFF is invoked after a terminal user signs off (whether the signon or sign-off is successful or not). XSNON and XSNOFF do not make any security decisions; they are merely a means of tracking users logging on and off a CICS system. - Statistics domain exit XSTOUT
On invocation, XSTOUT is passed the address of a buffer containing one or more statistics records. The buffer can contain records for various resource types; for example, connections and modenames. The buffer can also contain both specific and global information; for example, loader statistics for individual programs, and loader statistics for all programs. - System recovery program exit XSRAB
Exit XSRAB is invoked when the system recovery program (DFHSRP) finds a match in the system recovery table (SRT) for an operating system abend code. - System termination program exit XSTERM
The XSTERM exit could be used to output final statistics to your statistics SMF data sets, and to close them. Note that CICS VSAM and BDAM data sets have already been closed by CICS file control before the exit is invoked. - Temporary storage domain exits (XTSQRIN, XTSQROUT, XTSPTIN, XTSPTOUT)
These exits are invoked when temporary storage has to be controlled or monitored. - Temporary storage EXEC interface program exits XTSEREQ and XTSEREQC
The XTSEREQ exit allows you to intercept temporary storage API requests before any action has been taken on the request. The XTSEREQC exit allows you to intercept the response after a temporary storage API request has completed. - Terminal allocation program exit XALCAID
XALCAID is driven when an automatic initiation descriptor (AID) with data is canceled either by the CEMT transaction, running a SET TERMINAL or SET CONNECTION command, or during the reinstallation of a terminal or connection. - Terminal control program exits (XTCIN, XTCOUT, XTCATT)
These exits are invoked before I/O events for sequential devices or before task attaches. - ‘Terminal not known’ condition exits XALTENF and XICTENF
The ‘terminal not known’ condition can occur when intercommunicating CICS regions use both SHIPPABLE terminal definitions and automatic transaction initiation (ATI). The condition is especially likely to arise if autoinstall is used. - Transaction manager domain exit XXMATT
Exit XXMATT is invoked during transaction attach, and is able to change some of the attributes of the transaction that is being attached. - Transient data program exits (XTDREQ, XTDIN, XTDOUT)
The XTDREQ exit intercepts a transient data request before request analysis. The XTDOUT and XTDIN exits are invoked before and after data is exchanged with QSAM or VSAM. - Transient data EXEC interface program exits XTDEREQ and XTDEREQC
The XTDEREQ exit intercepts a transient data request before any action has been taken on it by transient data. The XTDEREQC exit intercepts a transient data request after transient data has completed its processing. - User log record recovery program exits XRCINIT and XRCINPT
At warm and emergency restart, updates made to recoverable CICS resources that were not committed when the system terminated must be backed out. XRCINIT and XRCINPT are invoked from the user log record recovery program, which is used to back out, where necessary, user-written system log entries. - SNA LU management program exit (XZCATT)
This exit is invoked before a task attach for a LU terminal task. - SNA working-set module exits (XZCIN, XZCOUT, XZCOUT1, and XZIQUE)
These exits are invoked after I/O events or before messages are disassembled into request units (RUs). - XISQUE exit for managing IPIC intersystem queues
You can use the XISQUE exit to control queuing on IP interconnectivity (IPIC) connections. - XRF request-processing program exit XXRSTAT
This exit is invoked if a z/OS® Communications Server failure or a z/OS Communications Server predatory takeover occurs.
dfha3_glues_function.html |
Last updated: Monday, 5 June 2017