Dump domain’s specific gates

Table 49 summarizes the dump domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 49. Dump domain’s specific gates
Gate Trace Function XPI
DUDT
DU 0500
DU 0501
ADD_TRAN_DUMPCODE
DELETE_TRAN_DUMPCODE
INQUIRE_TRAN_DUMPCODE
SET_TRAN_DUMPCODE
STARTBR_TRAN_DUMPCODE
GETNEXT_TRAN_DUMPCODE
ENDBR_TRAN_DUMPCODE
ADD_SYSTEM_DUMPCODE
DELETE_SYSTEM_DUMPCODE
INQUIRE_SYSTEM_DUMPCODE
SET_SYSTEM_DUMPCODE
STARTBR_SYSTEM_DUMPCODE
GETNEXT_SYSTEM_DUMPCODE
ENDBR_SYSTEM_DUMPCODE
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
DUDU
DU 0101
DU 0102
TRANSACTION_DUMP
SYSTEM_DUMP
YES
YES
DUSR
DU 0301
DU 0302
DUMPDS_OPEN
DUMPDS_CLOSE
DUMPDS_SWITCH
INQUIRE_CURRENT_DUMPDS
INQUIRE_DUMPDS_OPEN_STATUS
INQUIRE_DUMPDS_AUTOSWITCH
SET_DUMPDS_AUTOSWITCH
SET_DUMPTABLE_DEFAULTS
INQUIRE_INITIAL_DUMPDS
SET_INITIAL_DUMPDS
INQUIRE_SYSTEM_DUMP
SET_SYSTEM_DUMP
INQUIRE_RETRY_TIME
SET_RETRY_TIME
SET_CONNECT_TOKEN
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO

DUDT gate, ADD_TRAN_DUMPCODE function

The ADD_TRAN_DUMPCODE function of the DUDT gate is invoked to add a new dump code to the transaction dump table.

Input parameters

DUMPSCOPE
indicates whether an SDUMP request is to be sent to all MVS™ images in the sysplex which are running CICS® systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
TRANSACTION_DUMPCODE
is the transaction dump code.
TRANSACTION_DUMP
states whether a transaction dump is required for this dump code. It can have either of these values:
YES|NO
SYSTEM_DUMP
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
TERMINATE_CICS
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
MAXIMUM_DUMPS
is the maximum number of times the dump code action can be taken.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUPLICATE_DUMPCODE
INVALID_DUMPCODE
CATALOG_FULL
INSUFFICIENT_STORAGE
IO_ERROR

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT ADD_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Validate the dump code to be added. Transaction dump codes are 4 bytes and must not contain leading or embedded blanks. If the dump code is not valid, return to the caller indicating the exception.
  2. Scan the transaction dump table to find the correct place to insert the dump code in collating sequence. If an entry already exists for that dump code, return to the caller indicating duplicate dump code. If the entry is about to use the last available entry in the dump table block, obtain a new block and initialize it with null values. Create a dump table entry in the next available entry, indicated by TDTFREEHEAD pointer in the anchor block, using the parameter values passed by the caller. Set up the NEXT and PREV pointers of the new entry and higher and lower entries to include the new entry in the correct sequence in the table.
  3. Write the dump code information to the global catalog.

DUDT gate, DELETE_TRAN_DUMPCODE function

The DELETE_TRAN_DUMPCODE function of the DUDT gate is invoked to delete an existing dump code from the transaction dump table.

Input parameters

TRANSACTION_DUMPCODE
is the transaction dump code.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUMPCODE_NOT_FOUND
IO_ERROR

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT DELETE_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Locate the dump code in the transaction dump table. If it cannot be found, return to the caller indicating DUMPCODE_NOT_FOUND exception.
  2. Adjust the NEXT and PREV of the higher and lower entries in the table to bypass this entry, and set its NEXT and PREV pointers to 0.
  3. Delete the information for the dump code from the global catalog. If the attempt to delete from the catalog indicates that the record is not found, it is assumed that the dump code was present on the dump table as a result of a LOCATE_TRAN_DUMPCODE subroutine call that does not update the catalog.

DUDT LOCATE_TRAN_DUMPCODE process flow

  1. Validate the dump code for which a dump has been requested (see ADD_TRAN_DUMPCODE).
  2. Search the transaction dump table for the dump code. If it is found, set up the return DUDT parameters to indicate whether CICS is to be terminated, and whether a system or transaction dump is to be taken, using values taken from the dump table entry.

    If the dump code does not exist on the dump table, an entry is added, using default values (see the CICS Problem Determination Guide) and the DUDT return parameters are set up dependent on these default values. (This default entry is not added to the global catalog.)

DUDT gate, INQUIRE_TRAN_DUMPCODE function

The INQUIRE_TRAN_DUMPCODE function of the DUDT gate is invoked to inquire on a dump code in the transaction dump table.

Input parameters

TRANSACTION_DUMPCODE
is the transaction dump code.

Output parameters

[DUMPSCOPE]
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
[TRANSACTION_DUMP]
states whether a transaction dump is required for this dump code. It can have either of these values:
YES|NO
[SYSTEM_DUMP]
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
[TERMINATE_CICS]
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
[MAXIMUM_DUMPS]
is the maximum number of times the dump code action can be taken.
[COUNT]
is the number of times the dump code action has been taken.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
DUMPCODE_NOT_FOUND

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT INQUIRE_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Locate the dump code in the transaction dump code table. If it cannot be found, return to the caller indicating DUMPCODE_NOT_FOUND exception.
  2. Return the dump code table entry information to the caller in the DUDT parameters.

DUDT gate, SET_TRAN_DUMPCODE function

The SET_TRAN_DUMPCODE function of the DUDT gate is invoked to set options for a dump code in the transaction dump table.

Input parameters

[DUMPSCOPE]
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
TRANSACTION_DUMPCODE
is the transaction dump code.
[TRANSACTION_DUMP]
states whether a transaction dump is required for this dump code. It can have either of these values:
YES|NO
[SYSTEM_DUMP]
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
[TERMINATE_CICS]
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
[MAXIMUM_DUMPS]
is the maximum number of times the dump code action can be taken.
[RESET_COUNT]
states whether COUNT is to be reset to zero. It can have either of these values:
YES|NO

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUMPCODE_NOT_FOUND
CATALOG_FULL
IO_ERROR

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT SET_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Locate the dump code in the transaction dump code table. If it cannot be found, return to the caller indicating DUMPCODE_NOT_FOUND exception.
  2. Change the values on the dump code table entry for any passed in the DUDT parameter list (some or all may be changed). If the RESET_COUNT parameter is present, set the count of the number of dumps taken for this dump code to zero.
  3. Make the same changes to the dump code information about the global catalog. If the attempt to delete from the catalog indicates that the record is not found, it is assumed that the dump code was present on the dump table as a result of a LOCATE_TRAN_DUMPCODE subroutine call that does not update the catalog. See DUDT LOCATE_TRAN_DUMPCODE process flow for a description of the process flow of this function.

DUDT gate, STARTBR_TRAN_DUMPCODE function

The STARTBR_TRAN_DUMPCODE function of the DUDT gate is invoked to start a browse session on the transaction dump table.

Input parameters

None.

Output parameters

BROWSE_TOKEN
is the token identifying the browse session.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
INSUFFICIENT_STORAGE

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT STARTBR_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Add a new browse token to the end of the browse token table. Set the value of the last dump code used to null in the browse token table entry.
  2. Return the browse token to the caller.

DUDT gate, GETNEXT_TRAN_DUMPCODE function

The GETNEXT_TRAN_DUMPCODE function of the DUDT gate is invoked in a browse session to get the next entry in the transaction dump table.

Input parameters

BROWSE_TOKEN
is the token identifying the browse session.

Output parameters

[DUMPSCOPE]
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
[TRANSACTION_DUMPCODE]
is the transaction dump code.
[TRANSACTION_DUMP]
states whether a transaction dump is required for this dump code. It can have either of these values:
YES|NO
[SYSTEM_DUMP]
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
[TERMINATE_CICS]
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
[MAXIMUM_DUMPS]
is the maximum number of times the dump code action can be taken.
[COUNT]
is the number of times the dump code action has been taken.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION END_BROWSE
INVALID INVALID_BROWSE_TOKEN

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT GETNEXT_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Search the browse token table for the browse token passed in the DUDT parameters. If the browse token cannot be found, perform error handling (exception trace, message, and dump) and return to the caller.
  2. Obtain the value of the last dump code read by this browse session from the browse token table entry, and scan the dump table for a higher dump code entry. If there are no more entries, return END_BROWSE exception to the call; otherwise return the details of the dump code table entry in the parameters and save the value of the dump code in the browse token table entry.

DUDT gate, ENDBR_TRAN_DUMPCODE function

The ENDBR_TRAN_DUMPCODE function of the DUDT gate is invoked to end a browse session on the transaction dump table.

Input parameters

BROWSE_TOKEN
is the token identifying the browse session.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. It has this value:
INVALID_BROWSE_TOKEN

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT ENDBR_TRAN_DUMPCODE call to DFHDUTM.
  3. Issue LMLM UNLOCK for DUTABLE lock.

DFHDUTM process flow

  1. Search the browse token table for the browse token passed in the DUDT parameters. If the browse token cannot be found, perform error handling (exception trace, message, and dump) and return to the caller.
  2. Set the browse token table entry to nulls and adjust the NEXT and PREV pointers to bypass the entry.

DUDT gate, ADD_SYSTEM_DUMPCODE function

The ADD_SYSTEM_DUMPCODE function of the DUDT gate is invoked to add a new dump code to the system dump table.

Input parameters

DAEOPTION
states whether a dump produced for this dumpcode is eligible for suppression by the MVS Dump Analysis and Elimination (DAE) component. It can have either of these values:
YES|NO
DUMPSCOPE
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
SYSTEM_DUMPCODE
is the system dump code.
SYSTEM_DUMP
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
TERMINATE_CICS
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
MAXIMUM_DUMPS
is the maximum number of times the dump code action can be taken.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUPLICATE_DUMPCODE
INVALID_DUMPCODE
CATALOG_FULL
INSUFFICIENT_STORAGE
IO_ERROR

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT ADD_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Validate the dump code to be added. System dump codes are 4 bytes and must not contain leading or embedded blanks. If the dump code is not valid, return to the caller indicating the exception.
  2. Scan the system dump table to find the correct place to insert the dump code in collating sequence. If an entry already exists for that dump code, return to the caller indicating duplicate dump code. If the entry is about to use the last available entry in the dump table block, obtain a new block and initialize it with null values. Create a dump table entry in the next available entry, indicated by TDTFREEHEAD pointer in the anchor block, using the parameter values passed by the caller. Set up the NEXT and PREV pointers of the new entry and higher and lower entries to include the new entry in the correct sequence in the table.
  3. Write the dump code information to the global catalog.

DUDT gate, DELETE_SYSTEM_DUMPCODE function

The DELETE_SYSTEM_DUMPCODE function of the DUDT gate is invoked to delete an existing dump code from the system dump table.

Input parameters

SYSTEM_DUMPCODE
is the system dump code.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUMPCODE_NOT_FOUND
IO_ERROR

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT DELETE_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Locate the dump code in the system dump table. If it cannot be found, return to the caller indicating DUMPCODE_NOT_FOUND exception.
  2. Adjust the NEXT and PREV of the higher and lower entries in the table to bypass this entry, and set its NEXT and PREV pointers to 0.
  3. Delete the information for the dump table from the global catalog. If the attempt to delete from the catalog indicates that the record is not found, it is assumed that the dump code was present on the dump table as a result of a LOCATE_SYSTEM_DUMPCODE subroutine call that does not update the catalog.

DUDT LOCATE_SYSTEM_DUMPCODE process flow

  1. Validate the dump code for which a dump has been requested (see ADD_SYSTEM_DUMPCODE).
  2. Search the system dump table for the dump code. If it is found, set up the return DUDT parameters to indicate whether CICS is to be terminated, and whether a system dump is to be taken, using values taken from the dump table entry.

    If the dump code does not exist on the dump table, an entry is added, using default values (see the CICS Problem Determination Guide) and the DUDT return parameters are set up dependent on these default values. (This default entry is not added to the global catalog.)

DUDT gate, INQUIRE_SYSTEM_DUMPCODE function

The INQUIRE_SYSTEM_DUMPCODE function of the DUDT gate is invoked to inquire on a dump code in the system dump table.

Input parameters

SYSTEM_DUMPCODE
is the system dump code.

Output parameters

DAEOPTION
states whether a dump produced for this dumpcode is eligible for suppression by the MVS Dump Analysis and Elimination (DAE) component. It can have either of these values:
YES|NO
DUMPSCOPE
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
[SYSTEM_DUMP]
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
[TERMINATE_CICS]
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
[MAXIMUM_DUMPS]
is the maximum number of times the dump code action can be taken.
[COUNT]
is the number of times the dump code action has been taken.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
DUMPCODE_NOT_FOUND

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT INQUIRE_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Locate the dump code in the system dump code table. If it cannot be found, return to the caller indicating DUMPCODE_NOT_FOUND exception.
  2. Return the dump code table entry information to the caller in the DUDT parameters.

DUDT gate, SET_SYSTEM_DUMPCODE function

The SET_SYSTEM_DUMPCODE function of the DUDT gate is invoked to set options for a dump code in the system dump table.

Input parameters

[DAEOPTION]
states whether a dump produced for this dumpcode is eligible for suppression by the MVS Dump Analysis and Elimination (DAE) component. It can have either of these values:
YES|NO
[DUMPSCOPE]
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
SYSTEM_DUMPCODE
is the system dump code.
[SYSTEM_DUMP]
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
[TERMINATE_CICS]
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
[MAXIMUM_DUMPS]
is the maximum number of times the dump code action can be taken.
[RESET_COUNT]
states whether COUNT is to be reset to zero. It can have either of these values:
YES|NO

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUMPCODE_NOT_FOUND
CATALOG_FULL
IO_ERROR

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT SET_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Locate the dump code in the system dump code table. If it cannot be found, return to the caller indicating DUMPCODE_NOT_FOUND exception.
  2. Change the values on the dump code table entry for any passed in the DUDT parameter list (some or all may be changed). If the RESET_COUNT parameter is present, set the count of the number of dumps taken for this dump code to zero.
  3. Make the same changes to the dump code information about the global catalog. If the attempt to delete from the catalog indicates that the record is not found, it is assumed that the dump code was present on the dump table as a result of a LOCATE_SYSTEM_DUMPCODE subroutine call that does not update the catalog. See DUDT LOCATE_SYSTEM_DUMPCODE process flow for a description of the process flow of this function.

DUDT gate, STARTBR_SYSTEM_DUMPCODE function

The STARTBR_SYSTEM_DUMPCODE function of the DUDT gate is invoked to start a browse session on the system dump table.

Input parameters

None.

Output parameters

BROWSE_TOKEN
is the token identifying the browse session.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
INSUFFICIENT_STORAGE

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT STARTBR_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Add a new browse token to the end of the browse token table. Set the value of the last dump code used to null in the browse token table entry.
  2. Return the browse token to the caller.

DUDT gate, GETNEXT_SYSTEM_DUMPCODE function

The GETNEXT_SYSTEM_DUMPCODE function of the DUDT gate is invoked in a browse session to get the next entry in the system dump table.

Input parameters

BROWSE_TOKEN
is the token identifying the browse session.

Output parameters

[DAEOPTION]
states whether a dump produced for this dumpcode is eligible for suppression by the MVS Dump Analysis and Elimination (DAE) component. It can have either of these values:
YES|NO
[DUMPSCOPE]
indicates whether an SDUMP request is to be sent to all MVS images in the sysplex which are running CICS systems connected via XCF/MRO to the system on which the command is issued. It can have either of the following values:
LOCAL|RELATED
LOCAL
indicates that the SDUMP request is not sent to MVS images in the sysplex which are running XCF/MRO connected CICS systems
RELATED
indicates that, when an SDUMP is initiated for the dump code, the request is sent to all MVS images in the sysplex which are running one or more CICS systems connected via XCF/MRO to the CICS on which the SDUMP is initiated.
[SYSTEM_DUMPCODE]
is the system dump code.
[SYSTEM_DUMP]
states whether a system dump is required for this dump code. It can have either of these values:
YES|NO
[TERMINATE_CICS]
states whether CICS is to be terminated for this dump code. It can have either of these values:
YES|NO
[MAXIMUM_DUMPS]
is the maximum number of times the dump code action can be taken.
[COUNT]
is the number of times the dump code action has been taken.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION END_BROWSE
INVALID INVALID_BROWSE_TOKEN

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT GETNEXT_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Search the browse token table for the browse token passed in the DUDT parameters. If the browse token cannot be found, perform error handling (exception trace, message, and dump) and return to the caller.
  2. Obtain the value of the last dump code read by this browse session from the browse token table entry, and scan the dump table for a higher dump code entry. If there are no more entries, return END_BROWSE exception to the call; otherwise return the details of the dump code table entry in the parameters and save the value of the dump code in the browse token table entry.

DUDT gate, ENDBR_SYSTEM_DUMPCODE function

The ENDBR_SYSTEM_DUMPCODE function of the DUDT gate is invoked to end a browse on the system dump table.

Input parameters

BROWSE_TOKEN
is the token identifying the browse session.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. It has this value:
INVALID_BROWSE_TOKEN

Process flow

  1. Acquire KE system dump lock.
  2. Issue DUDT ENDBR_SYSTEM_DUMPCODE call to DFHDUTM.
  3. Release KE system dump lock.

DFHDUTM process flow

  1. Search the browse token table for the browse token passed in the DUDT parameters. If the browse token cannot be found, perform error handling (exception trace, message, and dump) and return to the caller.
  2. Set the browse token table entry to nulls and adjust the NEXT and PREV pointers to bypass the entry.

DUDU gate, TRANSACTION_DUMP function

The TRANSACTION_DUMP function of the DUDU gate is invoked to take a transaction dump.

Input parameters

Note:
The [SEGMENT] and [SEGMENT_LIST] parameters are mutually exclusive.
TRANSACTION_DUMPCODE
is a 4-character identifier for this dump request, used to index the transaction dump table to determine the options to be used.
The following set of optional input parameters indicates which parts of storage are to be included in the transaction dump. Each parameter can have either of these values: YES|NO.
[CSA]
- common system area
[TCA]
- task control area
[PROGRAM]
- program storage
[TRT]
- internal trace table
[TERMINAL]
- terminal-related storage areas
[TRANSACTION]
- transaction-related storage areas
[SIT]
- system initialization table
[PPT]
- processing program table
[PCT]
- program control table
[TCT]
- terminal control table
[FCT]
- file control table
[DCT]
- destination control table.
[SEGMENT]
specifies the address and length of a single block of storage to be dumped.
[SEGMENT_LIST]
specifies the address and length of a list of length-address pairs of storage blocks to be dumped. SEGMENT and SEGMENT_LIST may not be specified together.
[INDIRECT_CALL]
states whether the call is indirect, that is, whether the actual requester of the dump is not the immediate caller of the dump domain. It can have either of these values:
YES|NO

Output parameters

DUMPID
is a character string of the form "rrrr/cccc" giving a unique identification to this dump request. "rrrr" is the run number of this CICS instance. Leading zeros are removed. The run number is incremented every time CICS is initialized. "cccc" is the count of this dump request within this CICS run.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It can have any one of these values:
FESTAE_FAILED
The MVS FESTAE macro failed to set up a functional recovery routine during the processing of the system dump request.
IWMWQWRK_FAILED
An MVS IWMWQWRK macro call to Workload Manager returned a warning or error response during the processing of the system dump request.
INVALID_SVC_CALL
DFHDUSVC received a request for an invalid function.
INVALID_PROBDESC
The MVS PROBDESC parameters, which CICS creates and passes to MVS on an SDUMP call, contained invalid data.
OPEN_ERROR
Failed to open the CICS dump data set during an autoswitch.
NOT_OPEN
The dump data set is currently closed.
INVALID_DUMPCODE
The transaction dump code failed validation.
PARTIAL_TRANSACTION_DUMP
There was insufficient space in the current dump data set for this dump. Autoswitching had not been requested.
SUPPRESSED_BY_DUMPOPTION
A system dump requested through the dump table for this transaction dump code was suppressed because the DUMP=NO system initialization parameter had been specified.
SUPPRESSED_BY_DUMPTABLE
The dump table specified that no dump was required for this dump code.
SUPPRESSED_BY_USEREXIT
The XDUREQ user exit requested suppression of this dump.
PARTIAL_SYSTEM_DUMP
A system dump requested through the dump table for this transaction dump code was incomplete because of insufficient space on the SYS1.DUMP data set.
SDUMP_FAILED
A system dump requested through the dump table for this transaction dump code failed because of an MVS or I/O failure.
SDUMP_BUSY
Start of changeA system dump requested through the dump table for this system dump code failed because another address space was in the process of taking an SDUMP or the task was cancelled using the KILL option.End of change
SDUMP_NOT_AUTHORIZED
A system dump requested through the dump table for this transaction dump code failed because the CICS authorized function control block (AFCB) indicates that CICS use of SDUMP is not authorized.
INSUFFICIENT_STORAGE
A system dump requested through the dump table for this transaction dump code failed because CICS failed to acquire the necessary storage to build the SDUMP parameter list.
NO_DATASET
A system dump requested through the dump table for this transaction dump code failed because there were no SYS1.DUMP data sets available.

Process flow

  1. Issue LMLM LOCK for DUTABLE lock.
  2. Issue DUDT LOCATE_TRAN_DUMPCODE call to DFHDUTM. If the dump table is not available, CICS takes a system dump and terminates.
  3. Issue LMLM UNLOCK for DUTABLE lock.
  4. If XDUREQ exit active, issue APEX INVOKE_USER_EXIT.
  5. If XDUREQ exit not active or it was active and the return code was zero:
  6. If XDUREQC exit active, issue APEX INVOKE_USER_EXIT.
  7. Issue LMLM LOCK for DUTABLE lock.
  8. Issue DUDT COMMIT_TRAN_DUMPCODE call to DFHDUTM.
  9. Issue LMLM UNLOCK for DUTABLE lock.
  10. Issue KEDD PERFORM_SYSTEM_ACTION to terminate CICS if the dump table indicated that termination was required for this dump code.

DUDD TAKE_DUMP process flow

In DFHDUXD:

  1. If dump data set is closed or is a dummy data set, and the XDUOUT exit is not active, return to caller.
  2. Issue LMLM LOCK for dump data set lock.
  3. Invoke transaction dump formatting routines (DFHxxXDF), with DUXF FORMAT function, in turn to dump required areas to the transaction dump data set. If, at any point, the DUXF FORMAT function returns a response of EXCEPTION and a reason of RESTART, an autoswitch has occurred and the DUXF FORMAT calls have to be issued again.
  4. Issue LMLM UNLOCK for dump data set lock.
  5. If DFHDUXD is terminating with a DISASTER response and XDUOUT is active, issue APEX INVOKE_USER_EXIT for XDUOUT, passing the abnormal termination indication.

DUDT COMMIT_TRAN_DUMPCODE process flow

The DUDT COMMIT_TRAN_DUMPCODE function updates statistics for the dump code, according to whether or not the dump domain took the requested dumps.

  1. Locate the entry on the transaction dump table. Return to the caller, indicating exception if the entry is not found.
  2. Increment the global system dump statistics in the DUA and the system dump statistics on the dump table entry, for either dump-taken or dump-suppressed depending on the input system-dump parameter.
  3. Increment the global transaction dump statistics in the DUA and the transaction dump statistics for either dump-taken or dump-suppressed depending on the input transaction-dump parameter.

DUDU gate, SYSTEM_DUMP function

The SYSTEM_DUMP function of the DUDU gate is invoked to take a system dump.

Input parameters

SYSTEM_DUMPCODE
is an 8-character identifier for this dump request, used to index the system dump table to determine the options to be used.
[MESSAGE_TEXT]
specifies the address and length of the message text associated with this system dump.
[TITLE]
specifies the address and length of a title to be associated with this dump.
[CALLER]
specifies the address and length of a character string to appear as the caller of this dump.
[SYMPTOM_RECORD]
specifies the address and length of the symptom record associated with this dump.
[SYMPTOM_STRING]
specifies the address and length of the symptom string associated with this dump.
[TERMINATE_CICS]
states whether CICS is to be terminated after the dump if there is no entry in the dump table for this dump code; that is, it overrides the termination default of NO. It can have either of these values:
YES|NO
[INDIRECT_CALL]
states whether the call is indirect, that is, whether the actual requester of the dump is not the immediate caller of the dump domain. It can have either of these values:
YES|NO

Output parameters

DUMPID
is a character string of the form "rrrr/cccc" giving a unique identification to this dump request. "rrrr" is the run number of this CICS instance. Leading zeros are removed. The run number is incremented every time CICS is initialized. "cccc" is the count of this dump request within this CICS run.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It can have any one of these values:
INVALID_DUMPCODE
The system dump code failed validation.
SUPPRESSED_BY_DUMPOPTION
A system dump requested through the dump table for this system dump code was suppressed because the DUMP=NO system initialization parameter had been specified.
SUPPRESSED_BY_DUMPTABLE
The dump table specified that no dump was required for this dump code.
SUPPRESSED_BY_USEREXIT
The XDUREQ user exit requested suppression of this dump.
PARTIAL_SYSTEM_DUMP
A system dump requested through the dump table for this system dump code was incomplete because of insufficient space on the SYS1.DUMP data set.
SDUMP_FAILED
A system dump requested through the dump table for this system dump code failed because of an MVS or I/O failure.
SDUMP_BUSY
Start of changeA system dump requested through the dump table for this system dump code failed because another address space was in the process of taking an SDUMP or the task was cancelled using the KILL option.End of change
SDUMP_NOT_AUTHORIZED
A system dump requested through the dump table for this system dump code failed because the CICS authorized function control block (AFCB) indicates that CICS use of SDUMP is not authorized.
INSUFFICIENT_STORAGE
A system dump requested through the dump table for this system dump code failed because CICS failed to acquire the necessary storage to build the SDUMP parameter list.
NO_DATASET
A system dump requested through the dump table for this system dump code failed because there were no SYS1.DUMP data sets available.

Process flow

  1. Acquire KE system dump lock.
  2. If the DUMP=YES system initialization parameter was specified:
  3. Issue DUDT COMMIT_SYSTEM_DUMPCODE call to DFHDUTM.
  4. Release KE system dump lock.
  5. Issue KEDD PERFORM_SYSTEM_ACTION to terminate CICS if the dump table indicated that termination was required for this dump code.

DUDT COMMIT_SYSTEM_DUMPCODE process flow

The COMMIT_SYSTEM_DUMPCODE function of the DUDT gate updates statistics for the dump code, according to whether or not the dump domain took the requested dumps.

DUSR gate, CROSS_SYSTEM_DUMP_AVAIL function

The CROSS_SYSTEM_DUMP_AVAIL function of the DUSR gate is used to inform the dump domain about the DUMP_AVAIL token which links CICS with the MVS workload manager.

Input parameters

CROSS_SYSTEM_DUMP_AVAIL
is the CICS to MVS workload manager token.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED

Process flow

DUSR gate, DUMPDS_OPEN function

The DUMPDS_OPEN function of the DUSR gate is invoked to open the CICS dump data set.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
OPEN_ERROR
which indicates that the MVS OPEN of the dump data set failed.

Process flow

  1. Issue LMLM LOCK for dump data set lock.
  2. Call DUSU OPEN function.
  3. Issue LMLM UNLOCK for dump data set lock.

DUSR gate, DUMPDS_CLOSE function

The DUMPDS_CLOSE function of the DUSR gate is invoked to close the CICS dump data set.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

Process flow

  1. Issue LMLM LOCK for dump data set lock.
  2. Call DUSU CLOSE function.
  3. Issue LMLM UNLOCK for dump data set lock.

DUSR gate, DUMPDS_SWITCH function

The DUMPDS_SWITCH function of the DUSR gate is invoked to switch to the alternate CICS dump data set.

Input parameters

None.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. It has this value:
OPEN_ERROR
which indicates that the MVS OPEN of the dump data set failed.

Process flow

  1. Issue LMLM LOCK for dump data set lock.
  2. Call DUSU SWITCH function.
  3. Issue LMLM UNLOCK for dump data set lock.

DUSU SWITCH process flow

  1. Process as for DUSU CLOSE.
  2. Switch current data set name in the DUA.
  3. Process as for DUSU OPEN.

DUSU OPEN process flow

  1. Return if the DUA indicates already open.
  2. Call DUIO OPEN function.
  3. Update status on catalog.

DUSU CLOSE process flow

  1. If data set is open:
  2. Call DUIO CLOSE function.
  3. If XDUCLSE exit is active, call APEX INVOKE_USER_EXIT.
  4. Set status in the DUA to closed.
  5. Free DYNALLOC parameter list if necessary.

DUIO OPEN process flow

  1. Return if the DUA indicates transaction dump data set is already open.
  2. Issue MVS GETMAIN for DU Open Block if it is not yet allocated.
  3. Issue MVS OPEN.
  4. Set status to open in the DUA.
  5. Write end-of-data record.

DUIO uses the DCB OPEN exit to complete the DCB with block size and LRECL, and to determine the size of the buffer to be used by CICS. The DCB abend exit and the SYNAD routine are also activated to detect any errors that may occur during OPEN.

DUIO CLOSE process flow

  1. Return if already closed.
  2. Issue MVS CLOSE.
  3. Issue MVS FREEPOOL to release buffers.
  4. If this close is not for a switch, free the DU open block.
  5. Set status to closed in the DUA.

DUIO ALLOC_STG process flow

  1. Issue MVS GETMAIN for requested storage.
  2. Clear acquired area to hexadecimal zeros.

DUSR gate, INQUIRE_CURRENT_DUMPDS function

The INQUIRE_CURRENT_DUMPDS function of the DUSR gate returns the name of the current dump data set.

Input parameters

None.

Output parameters

CURRENT_DUMPDS
is the name of the current dump data set. It can have either of these values:
DFHDMPA|DFHDMPB
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DUSR gate, INQUIRE_DUMPDS_OPEN_STATUS function

The INQUIRE_DUMPDS_OPEN_STATUS function of the DUSR gate returns an indication of whether the current dump data set is open or closed.

Input parameters

None.

Output parameters

OPEN_STATUS
is the open status of the current dump data set. It can have either of these values:
OPEN|CLOSED
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DUSR gate, INQUIRE_DUMPDS_AUTOSWITCH function

The INQUIRE_DUMPDS_AUTOSWITCH function of the DUSR gate returns an indication of whether autoswitching is active or not.

Input parameters

None.

Output parameters

AUTOSWITCH
is the dump data set autoswitch status. It can have either of these values:
ON|OFF
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DUSR gate, SET_DUMPDS_AUTOSWITCH function

The SET_DUMPDS_AUTOSWITCH function of the DUSR gate is used to set autoswitching on or off.

Input parameters

AUTOSWITCH
is the dump data set autoswitch status. It can have either of these values:
ON|OFF

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

Process flow

  1. Set new autoswitch value in the DUA.
  2. Call DUSU UPDATE_CATALOGUE function, to write the DU state record to local catalog, using the current status from the DUA.

DUSR gate, INQUIRE_INITIAL_DUMPDS function

The INQUIRE_INITIAL_DUMPDS function of the DUSR gate returns the setting of the initial dump data set.

Input parameters

None.

Output parameters

INITIAL_DUMPDS
is the initial dump data set. It can have any one of these values:
DFHDMPA
Open DFHDMPA first when CICS is next initialized.
DFHDMPB
Open DFHDMPB first when CICS is next initialized.
AUTO
When CICS is next initialized, open the extent that was not active when CICS last terminated.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DUSR gate, SET_INITIAL_DUMPDS function

The SET_INITIAL_DUMPDS function of the DUSR gate is used to change the setting of the initial dump data set.

Input parameters

INITIAL_DUMPDS
is the initial dump data set. It can have any one of these values:
DFHDMPA
Open DFHDMPA first when CICS is next initialized.
DFHDMPB
Open DFHDMPB first when CICS is next initialized.
AUTO
When CICS is next initialized, open the extent that was not active when CICS last terminated.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

Process flow

  1. Set new initial dump data set value in the DUA.
  2. Call DUSU UPDATE_CATALOGUE function, to write the DU state record to local catalog, using the current status from the DUA.

DUSR gate, SET_DUMPTABLE_DEFAULTS function

The SET_DUMPTABLE_DEFAULTS function of the DUSR gate is invoked during system initialization tp update the DUA with the DAE option specified in a SIT or as a SIT override.

Input parameters

DAE_DEFAULT
indicates whether temporary dump table entries added by CICS will indicate DAE (dump eligible for DAE suppression) of NODAE (dump will not be suppressed by DAE). It can have either of the values:
DAE|NODAE
SYDUMAX_DEFAULT
is taken from system initialization parameter (SIT=SYDUMAX), which specifies the maximum number of system dumps which can be taken per dump table entry.
TRDUMAX_DEFAULT
is taken from system initialization parameter (SIT=TRDUMAX), which specifies the maximum number of transaction dumps which can be taken per dump table entry.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED

Process flow

  1. Set DAE_DEFAULT flag value in the DUA. 1 indicates DAE, 0 indicates NODAE.
  2. Call DUSU UPDATE_CATALOGUE function, to write the DU state record to local catalog, using the current status from the DUA.

DUSR gate, INQUIRE_SYSTEM_DUMP function

The INQUIRE_SYSTEM_DUMP function of the DUSR gate returns the setting of the system dump suppression flag.

Input parameters

None.

Output parameters

SYSTEM_DUMP
is the system dump option, indicating whether or not SDUMPs are to be taken by this CICS system. It can have either of these values:
YES|NO
where NO means that SDUMPs are not taken by this CICS system.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DUSR gate, SET_SYSTEM_DUMP function

The SET_SYSTEM_DUMP function of the DUSR gate is used to change the setting of the system dump suppression flag.

Input parameters

SYSTEM_DUMP
is the system dump option, indicating whether or not SDUMPs are to be taken by this CICS system. It can have either of these values:
YES|NO
where NO means that SDUMPs are not taken by this CICS system.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

Process flow

DUSR gate, INQUIRE_RETRY_TIME function

The INQUIRE_RETRY_TIME function of the DUSR gate returns the value of the SDUMP retry time.

Input parameters

None.

Output parameters

RETRY_TIME
is the value in seconds of the time interval for which CICS should retry SDUMP requests that fail because another SDUMP is in progress within the MVS system. The SDUMP is retried at intervals of five seconds for the specified total time.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

DUSR gate, SET_RETRY_TIME function

The SET_RETRY_TIME function of the DUSR gate is invoked to set the SDUMP retry time.

Input parameters

RETRY_TIME
is the value in seconds of the time interval for which CICS should retry SDUMP requests that fail because another SDUMP is in progress within the MVS system. The SDUMP is retried at intervals of five seconds for the specified total time.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

Process flow

  1. Set new SDUMP retry time in the DUA.
  2. Call DUSU UPDATE_CATALOGUE function, to write the DU state record to local catalog, using the current status from the DUA.

Miscellaneous process flows

DUIO format, WRITE function

  1. If the first record in the block to be written is a dump header:
  2. Issue MVS WRITE.
  3. Issue DSSR WAIT_MVS on the I/O ECB.
  4. Issue MVS CHECK for I/O completion. This drives the DCB abend exit if an error or end-of-extent is encountered and results in an error or END_OF_EXTENT response from DUIO.

DUSU format, WRITE function

  1. Call DUIO WRITE function if the dump data set is open and is not a dummy.
  2. If an end-of-extent occurred:

DUXF format, FORMAT function

This is the format of the parameter list passed to the transaction dump formatting routines (DFHxxXDF). There is a SUB_FUNCTION parameter which indicates the areas to be dumped. Each formatting routine is responsible for handling a subset of the subfunctions. The subfunctions and corresponding formatting modules are listed below in the order of the subfunction invocation from DFHDUXD.

Module Subfunction
DFHXDXDF DUXF_FORMAT_DUMP_HEADER
DFHXDXDF DUXF_FORMAT_SHORT_SYMPTOM_STRIN
DFHXDXDF DUXF_FORMAT_CICS_SERVICE_LEVEL
DFHXDXDF DUXF_FORMAT_PSW_REGISTERS
DFHSAXDF DUXF_FORMAT_TCA
DFHPCXDF DUXF_FORMAT_LIFO
DFHSAXDF DUXF_FORMAT_COMM_AREAS
DFHSAXDF DUXF_FORMAT_CSA
DFHTRXDF DUXF_FORMAT_TRT
DFHXDXDF DUXF_FORMAT_SEGMENT
DFHXDXDF DUXF_FORMAT_SEGMENT_LIST
DFHSAXDF DUXF_FORMAT_TRANSACTION_STORAGE
DFHSAXDF DUXF_FORMAT_FCA
DFHTCXDF DUXF_FORMAT_TCTTE
DFHPCXDF DUXF_FORMAT_PROGRAM
DFHSAXDF DUXF_FORMAT_DCT
DFHFCXDF DUXF_FORMAT_FCT
DFHTCXDF DUXF_FORMAT_TCT
DFHXRXDF DUXF_FORMAT_XRF
DFHPCXDF DUXF_FORMAT_PCT
DFHPCXDF DUXF_FORMAT_PPT
DFHSAXDF DUXF_FORMAT_SIT
DFHDLXDF DUXF_FORMAT_DLI
DFHPCXDF DUXF_FORMAT_MODULE_INDEX
DFHXDXDF DUXF_FORMAT_DUMP_TRAILER

DUXW format, HEX function

  1. Construct record in buffer indicating that this data should be formatted as hexadecimal.
  2. If buffer is full, call DUSU WRITE to output it.
  3. If XDUOUT exit is active, call APEX INVOKE_USER_EXIT.

DUXW format, NON_HEX function

  1. Construct record in buffer indicating that this data should be printed as-is; that is, it is already a character string.
  2. If buffer is full, call DUSU WRITE to output it.
  3. If XDUOUT exit is active, call APEX INVOKE_USER_EXIT.
[[ Contents Previous Page | Next Page Index ]]