The CICS dump exit parameters

This topic provides the syntax and descriptions of the CICS® dump exit parameters.

In this information, the assumed release level for all examples is CICS TS beta, so the verb name specified is CICS760.

Syntax

[JOB={jobname|CURRENT}]
[UPPERCASE]
 
[,DEF={0|1|2|3}]
[,keyword [=levelnumber]]

Descriptions

JOB={jobname|CURRENT} (optional)

Specifies which job in the dump is to be formatted (when there is more than one job in the dump). You should specify this parameter only if you know that the dump that you are processing contains more than one job. If the dump was taken by CICS using the SDUMP macro for a dump code which is defined as RELATED, the dump may contain more than one CICS job, so you should specify the JOB parameter. If the dump code is defined as LOCAL, the dump contains only one CICS job, so you can omit the JOB parameter and still process only that one dump.

jobname: Formats the job identified by jobname.
CURRENT: Formats all the CICS jobs in the dump data set.

If you omit the JOB parameter, all the CICS jobs found in the dump data are formatted.

UPPERCASE (optional)

Specifies that you want the dump data output in uppercase only. If you want output in mixed case (the default), do not code this parameter.

DEF={0|1|2|3}

Specifies a default level for the formatting of data from the dump data set. The DEF parameter is effective only for those components that are not included in a list of dump component keywords.

The possible levels that you can specify are described in details in Table 1.

If you omit the DEF parameter, the result depends on whether any component keywords are specified; see Effects of omitting the DEF parameter.

The dump summary and the error message index are outside the scope of the DEF parameter; see Exceptions to the scope of the DEF parameter. For details of the dump summary and the error message index, see The dump summary and error index.

keyword

Specifies the CICS component ID. See CICS system dump formatting component keywords and levels.

levelnumber

Specifies the level of data to be output, either to a terminal or to a printer. See CICS system dump formatting component keywords and levels.

The following examples demonstrate the use of level numbers.

Example 1:

VERBEXIT CICS760 'JOB=CURRENT,KE=1,DS'

This statement prints a summary of the kernel domain data, and all available information for the dispatcher domain.

Example 2:

VERBEXIT CICS760 'JOB=CURRENT,DEF=2,KE=1,DS=0'

This statement prints a summary of the kernel domain data, and the control blocks for all other components except for the dispatcher domain, which is suppressed.

Example 3:

VERBEXIT CICS760

Without any parameters, this statement produces summary and control block output for all the CICS components in the dump.

The default SDUMP formatting levels

Table 1. Possible levels for the default level
Level	Meaning	Description
0	Suppress	For those components not in a specified list of keywords, suppress all component formatting. If you specify DEF=0, but do not specify any component keywords, you still get the dump summary and, if appropriate, the error message index.
1	Summary	For those components not in a specified list of keywords, and where applicable, produce only a formatted summary from the control blocks. (A summary is not available for all components; see CICS system dump formatting component keywords and levels for the level numbers available for the individual keywords for which a summary of dump information is available.)
2	Full	For those components not in a specified list of keywords, format all the control block information in full.
3	Summary and full	For those components not in a specified list of keywords, format all control blocks and (where applicable) the summary information.

Effects of omitting the DEF parameter

If you omit the DEF parameter and do not specify any component keywords, the result is as if you specified DEF=3.
Example:
```
VERBEXIT CICS760 ‘JOB=CURRENT’
```
This statement formats all the available summary and control block information for the currently dispatched jobs. For the trace (TR) component, both the abbreviated and full trace are produced. The control block index is produced (see the IND component keyword) and, if appropriate, an error message index.
If you omit the DEF parameter and specify one or more component keywords, the result is as if you specified DEF=0.
Example:
```
VERBEXIT CICS760 ‘KE=1’
```
This statement produces a summary of the kernel dump data, plus the dump summary and, if appropriate, and error message index, but suppresses formatting of data for all other dump components.

Exceptions to the scope of the DEF parameter

The following two parts of a CICS system dump are not governed by component keywords, and are therefore outside the scope of the DEF parameter.

The dump summary
The error message index

The dump summary is always formatted, even if you specify DEF=0 and no component keywords. The error message index is produced only if an error or information message is output while the CICS dump exit is formatting the dump data, even if you specify DEF=0 and no component keywords.

Example:

VERBEXIT CICS760 ‘DEF=2,DS=0’

This statement suppresses formatting of the dispatcher (DS) domain; the dump summary is formatted, and all other components are formatted for level 2 only. The error message index is only produced if an error or information message is output while the CICS dump exit is formatting the dump data.