Using CICS-supplied dump exit routines to format CICS SDUMPs

To use IPCS to format a CICS® SDUMP, specify the CICS dump exit parameters on the VERBEXIT subcommand of IPCS, using the verb name for the CICS release that produced the dump data. (See Figure 29 for the CICS-supplied verb names.)

The syntax of the CICS exit parameters is shown in Figure 30 and described in The CICS dump exit parameters.

For some examples of using IPCS to process CICS SDUMPs, see topic Examples of the use of level numbers.

Figure 30. The CICS dump exit parameters
[JOB={jobname|CURRENT}]
[UPPERCASE]
 
[,DEF={0|1|2|3}]
[,keyword [=levelnumber]]

where

keyword
specifies the CICS component ID. .
levelnumber
specifies the level of data to be output, either to a terminal or to a printer.

The CICS dump exit parameters

The CICS dump exit parameters are as follows:

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 as follows:

Level
Meaning
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 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.

The effects of omitting the DEF parameter are as follows:

Exceptions to the scope of the DEF parameter

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

  1. The dump summary.
  2. 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. For example:

For details of the dump summary and the error message index, see topic The dump summary and error index.

Examples of the use of level numbers

VERBEXIT CICS640 'JOB=CURRENT,KE=1,DS' prints a summary of the kernel domain data, and all available information for the dispatcher domain.

VERBEXIT CICS640 'JOB=CURRENT,DEF=2,KE=1,DS=0' prints a summary of the kernel domain data, and the control blocks for all other components except for the dispatcher domain, which is suppressed.

VERBEXIT CICS640 without any parameters produces summary and control block output for all the CICS components in the dump.

The CICS640 dump exit component keywords

The component keywords specify which functional areas of the CICS dump you want the CICS640 exit to format, and the level number operand specifies the amount of data you want formatted. If you omit all of the component keywords, and provided you have not specified DEF=0, the CICS dump exit formats dump data for all components.

The syntax of the component parameter is as follows:

component-keyword[=0|1|2|3]
Specify the component keyword from the list of available keywords. The level number operand has the same function as the level number on the DEF parameter, but with different default rules, as follows:
0
Suppress all output for the component.
1
Summary only, but available only for certain components. If you code level 1 for a component that does not have a summary, it defaults to level 0 (that is, all formatting is suppressed). Note that level 1 has a special meaning for the trace and index components, as follows:
TR
If you specify level 1 for the TR (trace) component, you get the abbreviated trace only (see the ABBREV keyword on the DFHTU640 utility program for details).
IND
If you specify level 1 for the IND (index) keyword, you get the control block index sorted by address.
2
Full control block formatting. Level 2 has a special meaning for the trace and index components, as follows:
TR
If you specify level 2 for the TR (trace) component, you get full trace output (see the FULL keyword on the DFHTU640 utility program for details).
IND
If you specify level 2 for the IND (index) keyword, you get the control block index sorted by name.
3
Summary and full, that is, both level 2 and (where available) level 1. If you code level 3 for a component that does not have a summary, it defaults to level 2.
Note:
If you omit the level number, it defaults to level 3 for those components that have a summary, and level 2 for those that do not.

For details about the CICS dump component keywords, see the CICS Problem Determination Guide.

The CICS640 dump exit can be used in either a batch job or interactively. For an example of a batch IPCS job, see Figure 33. For information about using IPCS, see the following MVS™ IPCS manuals:

Trace entry selection

The TRS component keyword allows you to exercise much the same choice over the formatting and printing of trace entries written in a trace internal to a system dump as you may exercise over the formatting and printing of trace entries in an auxiliary trace.

Note:
The TRS keyword is effective only if the TR keyword value is 1, 2, or 3.

The trace selection parameters may be any valid trace selection parameters available to DFHTU640 for the formatting of CICS auxiliary trace entries, except the parameters PAGESIZE, ABBREV, SHORT, and FULL. You may, as with DFHTU640, select any number of parameters from those available. (For descriptions of available parameters, see The trace selection parameters for DFHTU640.)

Note:
You must use angled brackets around the parameter, or sequence of parameters, that you specify. The format and default values of parameters used to select trace entries from an internal SDUMP trace, are the same as those that apply when you use DFHTU640 to format auxiliary trace entries.

Related reference
Dump utility program (DFHDU640)
Using IPCS to format and analyze CICS dumps: Overview
Preparing to use IPCS to format CICS SDUMPs
Selecting parts of the CICS internal trace table
The dump summary and error index
Sample jobs to process a CICS SDUMP using the CICS dump exit
[[ Contents Previous Page | Next Page Index ]]