Dump domain exits XDUREQ, XDUREQC, XDUCLSE, and XDUOUT

There are four exits in the dump domain.

Exit XDUREQ

When invoked
Immediately before a system or transaction dump is taken.
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name, or nulls if there is no current application.
UEPDUMPC
Address of copy of the 8-byte dump code.
UEPABCDE
Address of a copy of the 8-byte Kernel error code in the format xxx/yyyy. xxx denotes the 3-digit hexadecimal MVS™ completion code (for example 0C1 or D37). If an MVS completion code is not applicable, xxx is three hyphens. The 4-digit code yyyy is a user abend code produced either by CICS® or by another product on your system. UEPABCDE is completed only for abend codes corresponding to the following dump codes:
  • AP0001
  • SR0001
  • ASRA
  • ASRB
  • ASRD

Otherwise this field contains null characters.

UEPDUMPT
Address of the 1-byte dump-type identifier, which contains one of the following values:
UEPDTRAN
A transaction dump was requested.
UEPDSYST
A system dump was requested.
Note:
The dump-type identifier indicates the type of dump request that was passed to the dump domain. It does not reflect any modification that may have been made to the original request by a user entry in the dump table.
UEPXDSCP
Address of a 1-byte field indicating the current dump table DUMPSCOPE setting. It contains one of the following values:
UEPXDLOC
A system dump will be taken on the local MVS image only.
UEPXDREL
System dumps will be taken on both the local MVS image, and on related MVS images within the sysplex.

This field may be modified by the exit to update the dump table DUMPSCOPE setting.

UEPXDTXN
Address of a 1-byte field indicating the current dump table TRANDUMP setting. It contains one of the following values:
UEPXDYES
A transaction dump will be taken.
UEPXDNO
A transaction dump will not be taken.

This field may be modified by the exit to update the dump table TRANDUMP setting.

Note:
This field is only valid if UEPDUMPT contains the value UEPDTRAN.
UEPXDSYS
Address of a 1-byte field indicating the current dump table SYSDUMP setting. It contains one of the following values:
UEPXDYES
A system dump will be taken.
UEPXDNO
A system dump will not be taken.

This field may be modified by the exit to update the dump table SYSDUMP setting.

UEPXDTRM
Address of a 1-byte field indicating the current dump table SHUTDOWN setting. It contains one of the following values:
UEPXDYES
The CICS system is to shutdown.
UEPXDNO
The CICS system is not to shutdown.

This field may be modified by the exit to update the dump table SHUTDOWN setting.

UEPXDMAX
Address of a 4-byte field which contains the current dump table MAXIMUM setting. This field may be modified by the exit to change the current dump table MAXIMUM setting. A change to the MAXIMUM setting will not suppress this dump request. A return code of UERCBYP may be used to suppress the current dump request.
UEPDXDCNT
Address of a 4-byte field which contains the current dump table CURRENT setting.
UEPXDTST
Address of a 16-byte field which contains the current dump table statistics for this dump code. The addressed field consists of four 4-byte fields containing binary integers:
  • Number of transaction dumps taken
  • Number of transaction dumps suppressed
  • Number of system dumps taken
  • Number of system dumps suppressed
Note:
Statistics for transaction dumps are valid only if UEPDUMPT contains the value UEPDTRAN.
UEPXDDAE
Address of a 1-byte field which represents the current dump table DAEOPTION setting. It contains one of the following values:
UEPXDYES
The dump is eligible for DAE suppression.
UEPXDNO
The dump will not be suppressed by DAE.

This field may be modified by the exit to update the dump table DAEOPTION setting.

UEPDMPID
Address of a 9-character field in the format xxxx/xxxx, containing the dump identifier. The dump ID is the same as that output by the corresponding dump message.
UEPFMOD
Address of an 8-byte area containing, if the dump code is AP0001, the name of the failing module; otherwise null characters.

Note that field UEPPROG always addresses the name of the current application, regardless of where the failure occurred. UEPFMOD addresses the name of the module where the failure occurred, if known.

If the dump code is AP0001, there are three possibilities:

  1. The field addressed by UEPFMOD contains the same name as the field addressed by UEPPROG--the failure occured in application code.
  2. The field addressed by UEPFMOD contains a different name from the field addressed by UEPPROG--the failure occurred in non-application code.
  3. The field addressed by UEPFMOD contains '????????'--the failure was not in application code, but CICS was unable to determine the name of the failing module.
Return codes
UERCNORM
Continue processing.
UERCBYP
Suppress dump.
UERCPURG
Task purged during XPI call.
XPI calls
WAIT_MVS can be used only when a UEPDUMPT indicates that a transaction dump is being taken. Do not use any other calls.

The sample program for the XDUREQ exit, DFH$XDRQ

CICS supplies a sample program for the XDUREQ exit. The sample shows you how to manipulate the dump table entry, and how to permit or suppress the dump.

Exit XDUREQC

When invoked
Immediately after a system or transaction dump has been taken (or has failed or been suppressed).
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEPDUMPC
Address of copy of the 8-byte dump code.
UEPABCDE
Address of a copy of the 8-byte Kernel error code in the format xxx/yyyy. xxx denotes the 3-digit hexadecimal MVS completion code (for example X'0C1' or X'D37'). If an MVS completion code is not applicable, xxx is three hyphens. The 4-digit code yyyy is a user abend code produced either by CICS or by another product on your system. UEPABCDE is completed only for abend codes corresponding to the following dump codes:
  • AP0001
  • SR0001
  • ASRA
  • ASRB
  • ASRD

Otherwise this field contains null characters.

UEPDUMPT
Address of the 1-byte dump-type identifier, which contains one of the following values:
UEPDTRAN
A transaction dump was requested.
UEPDSYST
A system dump was requested.
Note:
The dump-type identifier indicates the type of dump request that was passed to the dump domain. It does not reflect any modification that may have been made to the original request by a user entry in the dump table.
UEPXDSCP
Address of a 1-byte field indicating the current dump table DUMPSCOPE setting. It contains one of the following values:
UEPXDLOC
A system dump will be taken on the local MVS image only.
UEPXDREL
System dumps will be taken on both the local MVS image, and on related MVS images within the sysplex.

This field may be modified by the exit to update the dump table DUMPSCOPE setting.

UEPXDTXN
Address of a 1-byte field indicating the current dump table TRANDUMP setting. It contains one of the following values:
UEPXDYES
A transaction dump will be taken.
UEPXDNO
A transaction dump will not be taken.

This field may be modified by the exit to update the dump table TRANDUMP setting.

Note:
This field is only valid if UEPDUMPT contains the value UEPDTRAN.
UEPXDSYS
Address of a 1-byte field indicating the current dump table SYSDUMP setting. It contains one of the following values:
UEPXDYES
A system dump will be taken.
UEPXDNO
A system dump will not be taken.

This field may be modified by the exit to update the dump table SYSDUMP setting.

UEPXDTRM
Address of a 1-byte field indicating the current dump table SHUTDOWN setting. It contains one of the following values:
UEPXDYES
The CICS system is to shutdown.
UEPXDNO
The CICS system is not to shutdown.

This field may be modified by the exit to update the dump table SHUTDOWN setting.

UEPXDMAX
Address of a 4-byte field which contains the current dump table MAXIMUM setting. This field may be modified by the exit to change the current dump table MAXIMUM setting.
UEPDXDCNT
Address of a 4-byte field which contains the current dump table CURRENT setting.
UEPXDTST
Address of a 16-byte field which contains the current dump table statistics for this dumpcode. The addressed field consists of four 4-byte fields containing binary integers:
  • Number of transaction dumps taken
  • Number of transaction dumps suppressed
  • Number of system dumps taken
  • Number of system dumps suppressed.
Note:
Statistics for transactions dumps are valid only if UEPDUMPT contains the value UEPDTRAN.
UEPXDDAE
Address of a 1-byte field which represents the current dump table DAEOPTION setting. It contains one of the following values:
UEPXDYES
The dump was suppressed by DAE.
UEPXDNO
The dump was not suppressed by DAE.

This field may be modified by the exit to update the dump table DAEOPTION setting.

UEPDMPID
Address of a 9-character field in the format xxxx/xxxx, containing the dump identifier. The dump ID is the same as that output by the corresponding dump message.
UEPDRESP
Address of the 2-byte dump response code.
UEPDREAS
Address of the 2-byte dump reason code.
Return codes
UERCNORM
Continue processing.
XPI calls
WAIT_MVS can be used only when a UEPDUMPT indicates that a transaction dump is being taken. Do not use any other calls.

Exit XDUCLSE

When invoked
Immediately after a transaction dump data set has been closed.
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEPDMPDD
Address of the 8-byte dump data set ddname.
UEPDMPDSN
Address of the 44-byte dump data set dsname.
Return codes
UERCNORM
Continue processing.
UERCSWCH
The autoswitch flag is set on.
XPI calls
WAIT_MVS can be used. Do not use any other calls.

Exit XDUOUT

When invoked
Before a record is written to the transaction dump data set.
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte terminal ID.
UEPPROG
Address of the 8-byte application program name.
UEPDMPFC
Address of the 1-byte function code. The equated values are:
UEPDMPWR
Buffer is about to be written.
UEPDMPRE
Dump is about to restart after autoswitch.
UEPDMPAB
Abnormal termination of dump.
UEPDMPDY
Buffer is about to be written, and the CICS dump data set is a dummy file or is closed.
UEPDMPBF
Address of the dump buffer, whose length is addressed by the parameter UEPDMPLEN.
UEPDMPLEN
Address of the 2-byte dump-buffer length.
Return codes
UERCNORM
Continue processing.
UERCBYP
Suppress dump record output.
XPI calls
WAIT_MVS can be used. Do not use any other calls.

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
List of global user exit points
The XPI functions
[[ Contents Previous Page | Next Page Index ]]