SET TRANDUMPCODE

Description

You can use the SET TRANDUMPCODE command to change the transaction dump table entry for a particular dump code, to add a new dump code to the table, or to delete one.

Table updates are recorded in the CICS global catalog and preserved over executions of CICS until an initial or cold start occurs, except for temporary table entries. CICS creates a temporary entry when it receives a dump request with a code for which there is no table entry; these entries, and any changes to them, last only for the current execution of CICS. If you want preserve changes to a temporary entry over restarts, you must remove the dump code from the table and then add it back.

For information about transaction dumps, see The dump code options you can specify.

Valid characters include uppercase characters (A-Z), lowercase characters (a-z), digits (0-9), and the special characters $ @ # / % & ? ! : | ; , ¢ + * ¬ - and _. In some cases, the characters < > . = and " are also valid depending on where you set them. Any lowercase characters you enter are converted to uppercase.

Options

ACTION(cvda)

Specifies the action to be taken for the dump code. CVDA values are as follows:

ADD

An entry for this code is to be added to the table.

REMOVE

The entry for this code is to be removed from the table. No other options can be specified on a REMOVE request.

RESET

The current number of dump requests for this dump code is to be set to zero. (See the CURRENT option of the INQUIRE TRANDUMPCODE command.)

DUMPSCOPE(cvda)

Specifies whether a request for a dump with this dump code should cause CICS to initiate requests for SDUMPs (system dumps) of related CICS regions.

A related CICS region is one in the same sysplex, connected by MRO/XCF and doing work on behalf of the task that caused the dump request - specifically, a region that has a task doing work under the same APPC token as this task.

This propagation of SDUMP requests occurs only when the table entry for this code also specifies a SYSDUMPING value of SYSDUMP, and only in a sysplex environment executing under MVS/ESA Version 5.1 or later and the z/OS® Workload Manager. In other systems, specifying RELATED causes an exception condition.

CVDA values are as follows:

LOCAL

SDUMP requests are not to be sent.

RELATED

SDUMP requests are to be sent.

Note: A setting of DUMPSCOPE(RELATED) results in a single dump being taken for each affected MVS image. This dump contains the output from all the affected CICS regions in the image. For more information, see Automatic dump data capture from related CICS regions.

LOCAL is the default for entries you add, if you do not specify a DUMPSCOPE value.

MAXIMUM(data-value)

Specifies, as a fullword binary value, the maximum number of times CICS should take the set of actions indicated in the dump table entry. After the maximum is reached, CICS counts but otherwise ignores dump requests with this code. The valid range is 0-999. A value of 999 means there is no limit, and is the default used if you omit this option from an ADD request.

SHUTOPTION(cvda)

Specifies whether the CICS system is to be shut down after a request for a dump with this dump code. CVDA values are as follows:

NOSHUTDOWN

The system is not to be shut down.

SHUTDOWN

The system is to be shut down.

If this option is omitted from an ADD request, NOSHUTDOWN is assumed.

SYSDUMPING(cvda)

Specifies whether a system dump (an MVS SDUMP) should be taken when a transaction dump request with this code is received. CVDA values are as follows:

NOSYSDUMP

A system dump is not to be taken.

SYSDUMP

A system dump is to be taken.

Even when SYSDUMP is specified, a dump is produced only if the number of requests for this code is less than the MAXIMUM and system dumps are not suppressed globally (see the DUMPING option of the INQUIRE SYSTEM command).

If this option is omitted from an ADD request, NOSYSDUMP is assumed.

TRANDUMPCODE(data-value)

Specifies the 4-character transaction dump code for which the transaction dump table entry is to be changed. A valid transaction dump code has no leading or imbedded blanks.

Valid characters include uppercase characters (A-Z), lowercase characters (a-z), digits (0-9), and the special characters < > $ @ # / % & ? ! : | = " ; . , ¢ + * ¬ - and _. Any lowercase characters you enter are converted to uppercase.

TRANDUMPING(cvda)

Specifies whether a transaction dump should be taken when a transaction dump request with this code is received. CVDA values are as follows:

NOTRANDUMP

A transaction dump is not to be taken.

TRANDUMP

A transaction dump is to be taken.

Even when TRANDUMP is specified, CICS will dump only when the count of requests for this code is no greater than the MAXIMUM.

If this option is omitted from an ADD request, TRANDUMP is assumed.

Conditions

DUPREC

RESP2 values:

10

ADD is specified for a dump code already in the transaction dump table.

INVREQ

RESP2 values:

2

ACTION has an invalid CVDA value.

3

TRANDUMPING has an invalid CVDA value.

4

SYSDUMPING has an invalid CVDA value.

5

The MAXIMUM value is out of range.

6

SHUTOPTION has an invalid CVDA value.

7

REMOVE is specified with other options.

9

The dump code is invalid.

13

DUMPSCOPE has an invalid CVDA value.

14

RELATED requires MVS/ESA 5.1.

IOERR

RESP2 values:

11

An error occurred updating the CICS catalog. The entry is changed for the current run, but is not recorded for restarts.

NOSPACE

RESP2 values:

12

The CICS catalog is full. The entry is changed for the current run, but is not recorded for restarts.

NOTAUTH

RESP2 values:

100

The user associated with the issuing task is not authorized to use this command.

NOTFND

RESP2 values:

1

The dump code cannot be found.