INQUIRE TRANDUMPCODE
Retrieve information about a transaction dump code.
Syntax
Conditions: END, ILLOGIC, NOTAUTH, NOTFND
NOHANDLE, RESP, and
RESP2 are common options that can be added to all EXEC CICS
commands to process error conditions. They are not explicitly included in the command syntax diagram
and option descriptions. For information about these common options and EXEC CICS
command syntax, see EXEC CICS command format and programming considerations. For more information
about the use of CVDAs, see CICS-value data areas (CVDAs).
Description
You can use the INQUIRE TRANDUMPCODE command to look at some of the information in the transaction dump table entry for a particular transaction dump code.
- Producing a transaction dump.
- Producing a system dump (an MVS SDUMP).
- Forwarding an SDUMP request to related z/OS® images.
- Shutting down CICS.
The table entry also indicates how many times to take this set of actions (the MAXIMUM option). Requests received after the maximum is reached are counted (the CURRENT option), but otherwise ignored.
CICS provides a transaction dump table with default actions for CICS transaction abend codes (those beginning with the letter A). You can change or add actions by using the SET TRANDUMPCODE command or the CEMT transaction. Such changes are preserved over executions of CICS until an initial or cold start occurs.
CICS builds table entries, using default values, when it receives a dump request with a code for which it does not have an entry. You can also add your own entries with the SET TRANDUMPCODE command or with a CEMT transaction.
Entries you add remain over executions of CICS until an initial or cold start occurs, but the entries CICS builds are considered temporary and are discarded at shutdown.
Consequently, if you inquire about a code that is not explicitly defined before it appears in a dump request, you get a not found response.
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.
Browsing
You can also browse through all of the entries in the transaction dump table by using the browse options (START, NEXT, and END) on INQUIRE TRANDUMPCODE commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.
The resource signature
You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Identifying changes to resources (resource signatures). See Summary of the resource signature field values for detailed information about the content of the resource signature fields.
Options
- CHANGEAGENT(cvda)
- Returns a CVDA value that identifies the agent that made the last change to the resource
definition. The possible values are as follows:
- CREATESPI
- The resource definition was last changed by an EXEC CICS CREATE command.
- CSDAPI
- The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.
- CSDBATCH
- The resource definition was last changed by a DFHCSDUP job.
- DYNAMIC
- The resource was last changed by a SET TRANDUMPCODE command.
- OVERRIDE
- The resource definition was last changed by application of an override rule in the resource overrides file.
- SYSTEM
- The resource definition was last changed by CICS.
- CHANGEAGREL(data-area)
- Returns a 4-digit number of the CICS release that was running when the resource definition was last changed: for example, 0760 is the identifier for CICS TS for z/OS, beta.
- CHANGETIME(data-area)
- Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.
- CHANGEUSRID(data-area)
- Returns the 8-character user ID that ran the change agent.
- CURRENT(data-area)
- Returns a fullword binary field that shows the number of dump requests with this dump code made since the count was last reset. (The count is reset automatically at CICS shutdown and can be reset explicitly with a SET SYSDUMPCODE RESET command or its CEMT equivalent.) The count includes requests that do not result in dumps, either because they are suppressed for this code or because the number for this code has reached its maximum.
- DEFINESOURCE(data-area)
- Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.
- DEFINETIME(data-area)
- Returns an ABSTIME value that represents the time stamp when the resource definition was created.
- DUMPSCOPE(cvda)
- Returns
a CVDA value that shows whether a request for a dump with this dump
code should cause an SDUMP (system dump) request to be sent to related z/OS images.
A related image is one which contains a CICS region 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 the task causing the dump.
The sending of SDUMP requests occurs only when the table entry for this code specifies a system dump (that is, the SYSDUMPING value is SYSDUMP), and only in a sysplex environment executing under MVS/ESA Version 5.1 or later and the z/OS Workload Manager.
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 z/OS 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.
- INSTALLAGENT(cvda)
- Returns a CVDA value that identifies the agent that installed the resource. The possible values
are as follows:
- AUTOINSTALL
- The resource was autoinstalled.
- CREATESPI
- The resource was installed by an EXEC CICS CREATE command.
- CSDAPI
- The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.
- DYNAMIC
- The resource was installed by a SET SYSDUMPCODE ADD command.
- GRPLIST
- The resource was installed by GRPLIST INSTALL.
- SYSTEM
- The resource was installed by CICS.
- INSTALLTIME(data-area)
- Returns an ABSTIME value that represents the time stamp when the resource was installed.
- INSTALLUSRID(data-area)
- Returns the 8-character user ID that installed the resource.
- MAXIMUM(data-area)
- Returns a fullword binary field that shows the maximum number of times CICS will take the set of actions indicated in the transaction dump table entry when a dump request with this code is received. A value of 999 means the default of no limit.
- SHUTOPTION(cvda)
- Returns
a CVDA value that shows 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 CICS system is not to shut down.
- SHUTDOWN
- The CICS system is to shut down.
- SYSDUMPING(cvda)
- Returns a CVDA value that shows whether a system dump should be taken
when a transaction dump request with this code is received. However, even when the dump table entry
specifies a system dump, a dump is produced only when the CURRENT value is no
greater than the MAXIMUM, and system dumps are not suppressed system wide (see the
DUMPING option in the INQUIRE SYSTEM command). CVDA values are
as follows:
- NOSYSDUMP
- A system dump is not to be taken.
- SYSDUMP
- A system dump is to be taken.
- TRANDUMPCODE(data-value)
- Specifies the 4-character transaction dump code about which you are inquiring. A valid transaction dump code has no leading or imbedded blanks.
- TRANDUMPING(cvda)
- Returns a CVDA value that shows whether a transaction dump should be
taken when a transaction dump request with this code is received. Even when the dump table entry
specifies a transaction dump, however, one is taken only when the CURRENT value is
no greater than the MAXIMUM. CVDA values are as follows:
- NOTRANDUMP
- The transaction dump is to be suppressed.
- TRANDUMP
- The transaction dump is to be taken.
Conditions
- END
- RESP2 values:
- 2
- There are no more resource definitions of this type.
- ILLOGIC
- RESP2 values:
- 1
- You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.
- 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.