ECB-controlled program user exits

Table 1 lists the user exits that are available for ECB-controlled programs. Note which user exits are allocated through SIP before you load your online system.

Table 1. User exits for ECB-controlled programs
System function User exit source Last updated
Add diagnostic information to the record that is being released with the RELFC macro (mrd_user_data_user_exit) umr0.cpp Added for PUT05.
Add diagnostic information to the record that was just obtained with the GETFC macro (gfi_user_data_user_exit) umr0.cpp Added for PUT05.
Business event processing format errors (ubev_dataFormatErrors_user_exit) ubev.cpp Added for PUT09.
Business event processing transmit errors (ubev_dataTransmitErrors_user_exit) ubev.cpp Added for PUT09.
Business event processing Common Base Event data (ubev_cbeData_user_exit) ubev.cpp Added for PUT09.
Capture keypoint processing ubxl.asm Added for PUT04.
Capture tape label processing ubxt.asm Added for PUT04.
TLS certificate expiration monitor ucmp.cpp Added in 2021.
Check OLDR loader input file uelr.c  
Clock global update exit: Initialize calendar fields gcalx.mac  
Clock global update exit: Update global calendar fields gdatx.mac  
Clock global update exit: Update global clock fields gclkx.mac  
Command manager ueld.c  
Common symbol table ucst.asm  
Communications source common ucs1.asm  
Continuous data collection (CDC) relational database table partition cdcb.c
  • Changed for PUT06.
  • Changed for PUT02.
Continuous data collection (CDC) predefined user data collection cdcc.c Added for PUT06.
Continuous data collection (CDC) user data collection cdca.c
  • Replaced by cdcc.c for PUT06.
  • Changed for PUT02.
Core resident load throttle control ulib.asm Obsoleted for PUT00.
Core resident program area (CRPA) sweeper uswp.c Added for PUT07.
CP-CP session activation uacp.asm  
CTKA user switch ulh4.c Added for PUT07.
Custom index for z/TPF support for MongoDB ucad.cpp Added for PUT13.
Customize the size of mymalloc ECB heap buffers (mymallocUserExit) umymalloc.c Added for PUT12.
Cycle down processing usc5.asm Added for PUT04.
DASD subsystem ID (SSID) monitoring uss0.c Added for PUT06.
Database reorganization ubdb.asm  
Data event ECB exit ude2.cpp Added for PUT11.
Daylight saving time (DST) utim.asm Added for PUT05.
Deactivate phase I selective activate uelw.c  
Deactivate phase II selective activate uelf.c  
Deadlock detection clud.c  
DEARRANGE CTK9 upx1.asm  
Debug dump capture area (UDDC_debuggerDumpCaptureUserExit) cdbaux.cpp
  • Changed for PUT13.
  • Added for PUT05.
Debug dump viewer data scrubbing (CDBX_ScrubDataUserExit) cdbxds.asm Added for PUT09.
Debug file management uelj.c Added for PUT00.
Debug registration cdbpux.c  
Define user ECB labels (Assembler) ueqce1.cpy Added for PUT00.
Define user ECB labels (C/C++ language) tpf/c_ueqce1.h Added for PUT00.
Define user ECB page 3 labels (Assembler) ueqce3.cpy Added for PUT06.
Define user ECB page 3 labels (C/C++ language) tpf/c_ueqce3.h Added for PUT06.
Define user specific errno values custer.c Added for PUT00.
Detect selective activate support uel1.c  
Determine whether a file address should be released (mrd_release_fa_user_exit) umr0.cpp Added for PUT05.
DFDL user exit function definitions dfdl_ufn.cpp Added for PUT15.
Display uelg.c  
DNS select an IP address udns.cpp  
Dump data cpsu.asm Changed for PUT06.
Dynamic LU cdly.asm  
ECB display ude0.asm  
Encrypt passwords for file system security processing ufve.c Added for PUT03.
Enhanced HTTP client request/reply for logging uhcr.c Added in 2019.
E-type loader recycle interface user Internet server programs UERA Added for PUT07.
E-type loader recycle interface user libraries UERL Added for PUT07.
Extra program record report ueli.asm  
File pool section keypoint table (CY2KT) upx7.asm  
File short-term common control record (STCCR) upx3.asm  
Find pool section keypoint table (CY2KT) upx6.asm  
Find short-term common control record (STCCR) upx2.asm  
Format-2 global alter ugla.cpp Added for PUT00.
Format-2 global alter data uglz.cpp Added for PUT00.
Format-2 global define ugld.cpp Added for PUT00.
Format-2 global delete uglt.cpp Added for PUT00.
Format-2 global initialization ugli.cpp Added for PUT00.
Format-2 global keypoint uglk.cpp Added for PUT00.
Format-2 global load ugll.cpp Added for PUT00.
Format-2 global migration uglm.cpp Added for PUT00.
Format-2 global restart uglr.cpp Added for PUT00.
Format-2 global synchronization ugls.cpp Added for PUT00.
Format-2 global undo uglu.cpp Added for PUT00.
FTP client and server compliance port selection user exit ufpg.cpp Added in 2022.
Get global environment lists uenv.c Changed for PUT00.
Global restart ugo0.asm Added for PUT07.
HTTP client daemon select process (uhsp_httpDaemonSelectProc) uhcdsp.c Added for PUT07.
HTTP client handle initialization uhhinit.c Added for PUT04.
HTTP client post-request processing uhpostreq.c Added for PUT04.
HTTP client pre-request processing uhprereq.c Added for PUT04.
HTTP request timeout uhtx.c Added for PUT09.
HTTP server connection uhtc.c Added for PUT11.
HTTP server request/reply for logging uhsr.c Added in 2019.
IBM MQ assign LNIATA cuiw.cpp  
IBM MQ channel message cuit.cpp  
IBM MQ channel message retry cuit.cpp  
IBM MQ channel security cuit.cpp  
IBM MQ convert to object handle cuiv.cpp  
IBM MQ queue trigger cuir.cpp  
IBM MQ queue message cuin.cpp Added in 2021.
IBM MQ start queue manager cuia.cpp  
Image loader file support uelk.c Added for PUT05.
Include a specific ECB in a ZDECB summary display (include_ecb_user_exit) uvxs.c Added for PUT02.
InetD SSL user exit processing ussl.c Added for PUT10.
JAM cluster post-recycle user exit (ujam_recycle_postHook) ujam.c Added in 2023.
JAM cluster pre-recycle user exit (ujam_recycle_preHook) ujam.c Added in 2023.
JAM cluster pre-shutdown user exit (ujam_stop_preHook) ujam.c Added in 2023.
JAM JVM startup user exit (ujam_user_exit) ujam.c Added for PUT14.
JVM dump agent completed (ujvm_dumpagent_finished_hook) ujvm.cpp Added in 2021.
JVM post-dump user exit (ujvm_dumpagent_postHook) ujvm.cpp Added in 2022.
JVM pre-dump user exit (ujvm_dumpagent_preHook) ujvm.cpp Added in 2022.
JVM shutdown user exit (ujvm_jvm_shutdown_hook) ujvm.cpp Added in 2022.
JVM startup (ujvm_jvm_startup_hook) ujvm.cpp Added in 2021.
JVM thread shutdown user exit (ujvm_thread_shutdown_hook) ujvm.cpp Added in 2022.
JVM thread startup (ujvm_thread_startup_hook) ujvm.cpp Added in 2021.
Loadset history uell.c Changed for PUT06.
LODIC resource priority class also known as names (Assembler) ulodeq.mac Added for PUT05.
LODIC resource priority class also known as names (C/C++ language) tpf/c_ulodeq.h Added for PUT05.
Log ECB trace (macro and function trace) information utlg.c Added for PUT00.
Log recovery error processing cl99.asm  
Long message transmitter (LMT) error recovery xera.asm  
LU registration uarg.asm  
LU 6.2 cmw0.asm  
MATIP ASCU list umatas.cpp  
MATIP assign LNIATA umatal.cpp  
MATIP flow ID umatfi.cpp  
MATIP host name umatch.cpp  
MATIP log processing umatlp.cpp  
MATIP router umatro.cpp  
MATIP security umatse.cpp  
MATIP session start umatss.cpp  
MATIP translation umattr.cpp  
Message Queue Interface (MQI) channel exits See cmqxc.h.  
Message router cobc.asm  
Message switching error recovery xzaa.asm  
Midnight processing calendar updates udt1.asm Added for PUT00.
Midnight processing GDATX macro udt2.asm Added for PUT00.
Midnight processing post calendar updates udt3.asm Added for PUT00.
Module copy selection/validation ucpy.asm  
Multiple release detection (MRD) bypass (bypass_mrd_user_exit) umr0.cpp Added for PUT08.
MongoDB authentication (UATH_mongodb_plain and UATH_mongodb_cr) uath.cpp Added for PUT13.
MongoDB filtered collection access control (UATH_filteredCollection) uath.cpp Added for PUT14.
MongoDB post-request user exit (UMON_post_request) umon.cpp Added for PUT14.
MongoDB pre-request user exit (UMON_pre_request) umon.cpp Added for PUT14.
Nonsocket activation clcq.c Obsoleted for PUT00.
Nonsocket connect clcu.c Obsoleted for PUT00.
Nonsocket deactivation clcm.c Obsoleted for PUT00.
Nonsocket message cla4.c Obsoleted for PUT00.
Output message filtering uop1.asm  
Output message reformatting uop2.asm  
Pool directory update (PDU) processing upd0.asm Added for PUT06.
Pre-recoup multiple release analysis ure0.asm Added for PUT04.
Private key usage uskp.c Added for PUT06.
Process pseudo-file system (PROCFS) user target table implementation uprc.mak Added for PUT04.
Program event recording (PER) uper.asm  
Program history uelm.c  
Provide a copy of the input message of the ECB to the ZDECB command (get_input_msg_user_exit) uvxs.c Added for PUT02.
Provide a seed to generate random numbers by using the tpf_random function urnd.c Added in 2019.
Provide enhanced HTTP client proxy credentials for the proxy authorization header uhcp.c Added in 2023.
REARRANGE CTK9 upx0.asm  
Recoup command bru1.asm  
Recoup phase 1 bkb0.asm  
Recoup phase 1 start, restart, and end bru2.asm Changed for PUT04.
Release chain processing for 4-byte file addresses (RLCHA HDR=4) urc4.asm
  • Changed for PUT07.
  • Added for PUT03.
Release chain processing for 8-byte file addresses (RLCHA HDR=8) urc8.asm
  • Changed for PUT07.
  • Added for PUT03.
Remote debug information shared object name processing (CDBX_getSharedObjectNameForRemoteDebugInfoUserExit) cudbux.c Added for PUT09.
Secure symmetric key creation uskb.c Added for PUT04.
Secure symmetric key import uskc.c Added for PUT06.
Secure symmetric key usage uska.c Added for PUT04.
Secure Sockets Layer (SSL) application configuration file (tpf_SSL_getConfig) uscf.c Added for PUT03.
Select a host uapn.asm Changed for PUT04.
Select ALS to adjacent APPN node uals.asm  
Select an RTP connect urtp.asm  
Select TCP/IP support usok.c Obsoleted for PUT00.
Selective activate message router uelh.c  
Selective activate restart uelu.c  
Selective activate structure initialization uelx.c  
Selective activate structure update ueln.c  
Selective core resident load uclb.asm  
Selective recoup bru3.asm  
Set socket options for TCP listener and UDP server sockets usoc.c  
Shared memory ushmm.c Added for PUT04.
SLC communication source cim2.asm Obsoleted for PUT00.
SNA communication route selection csjv.asm  
SNA message recovery cmvu.asm  
SNMP enterprise-specific MIB retrieval umib.cpp  
SNMP manager validation ucom.cpp  
SOAP application handler (tpf_soap_appl_handler) cso4.c Changed for PUT04 (information only; no code change).
SOAP consumer initialize handle (tpf_soapInitHandleExit) cwsiue.c Added for PUT06.
SOAP consumer end session (tpf_soapEndExit) cwseue.c Added for PUT06.
SOAP consumer translation (tpf_soapTranslationExit) cwstue.c Added for PUT06.
SOAP handler exit (tpf_soap_handler_exit) cso2.c Changed for PUT09 (information only; no code change).
SOAP handler response user exit (tpf_soap_handler_response_exit) csos.c Added for PUT10
SOAP WS-Security client system identification (tpf_soapGetClientId) cwscue.c Added for PUT07
SOAP WS-Security key mapping (tpf_soapMapKey)) cso9.c Added for PUT07
Socket accept c542.c Obsoleted for PUT00.
Socket activation clch.c Obsoleted for PUT00.
Socket connect clcs.c Obsoleted for PUT00.
Socket cycle-up clcv.c  
Socket deactivation clci.c Obsoleted for PUT00.
Socket monitor usmo.c Added for PUT08.
Socket system error clcx.c Obsoleted for PUT00.
System error message cpsd.asm  
System error terminal response message upsa.asm Added for PUT00.
System pseudo-file system (SYSFS) user target table implementation usys.mak Added for PUT04.
System restart urs0.asm  
System restart urs1.asm  
System restart for vendors urs3.asm Added for PUT08.
System restart schedule urs2.asm  
System state change: Cycle down usc1.asm  
System state change: Cycle up usc2.asm  
System state change: Cycle down usc3.asm  
System state change: Cycle up usc4.asm  
System test driver cvzz.asm  
Tape label processing uxtk.asm Added for PUT04.
Tape display setup uxtd.asm  
Tape library coru.asm Changed for PUT08.
TCP/IP native stack support accept connection uacc.c  
TCP/IP native stack support socket close uclo.c
  • Changed for PUT08.
  • Changed for PUT06.
  • Added for PUT04.
Trace-by-terminal cdbuxt.c  
Transaction program name table chq0.asm  
Unplanned module down uyen.asm Added for PUT02.
User command: additional validation and authorization of z/TPF commands umex.asm Added for PUT00.
User command processor ume1.asm  
User command table umet.asm  
User data recovery copy support udrs.asm  
User data recovery restore support udrr.asm  
Custom debug registration support cdbxud.c Added for PUT06.
User device uelc.c Replaced by user-defined device drivers for PUT00.
User global symbol table ugst.cpp  
User label routines uxth.asm  
User library function uele.c  
User symbol override table usot.cpp  
VFA delay file cvft.asm Added for PUT00.
VFA restart cvfx.asm  
Virtual IP address processor deactivation uvip.asm  
Virtual reader support without file system uelb.asm
  • Changed for PUT10.
  • Replaced by user-defined device drivers for PUT00.
Web service resource deploy cwsdue.c Added for PUT04.
Web service resource undeploy cwsuue.c Added for PUT04.
WTOPC page control uop3.asm  
Start of changeZCPYS command processingEnd of change Start of changeucsm.cppEnd of change Start of changeAdded in 2024.End of change
ZDSYS command processing ucvz.asm Added for PUT04.
ZFCTB LOAD and ZODBR LOAD command compatibility processing ufct.c
  • Changed for PUT08.
  • Added for PUT03.
ZFCTB command user data relocation processing uftr.cpy Added for PUT03.
ZFCTB and ZODBR command processing uftz.c
  • Changed for PUT08.
  • Added for PUT03.
ZSTAT command display user exit usta.asm Added for PUT00.
z/TPF file system initialization ubot.c  
ZUDFM MLS DSECT exclusion list cdbxdf.c Added for PUT07.
3270 welcome screen cslj.asm  

For more information, see the code comments in each user exit.