IDIRegisterFaultEntry command

The IDIRegisterFaultEntry command can be used to register a fault entry at any time during analysis of an MVS™ dump data set, for example a CICS® system dump. This command allows the early creation of a fault entry in a history file, without the need to first exit interactive reanalysis. An installation can choose to automate the registration fault entry creation by issuing the IDIRegisterFaultEntry command from, for example, an Analysis Control user exit, or, alternatively, users can invoke a Formatting user exit on demand to issue this command during interactive reanalysis.

Note:
  1. This command should not be used to register fault entries in a dump registration Analysis Control or Notification user exit, since doing so could result in extra unwanted fault entries being created. The IDIXTSEL dump registration processing automatically creates a fault entry, even if no user exit is used.
  2. As an alternative to using the IDIRegisterFaultEntry command, the GenerateSavedReport option can be used to create a fault entry in the current history file for an MVS™ dump analyzed in batch. For details, see GenerateSavedReport.
Figure 1. Syntax

1  IDIRegisterFaultEntry
2.1  IDIHIST ( history_file_dsn )
where:
IDIHIST(history_file_dsn)
Specifies the history file in which the registration fault entry should be created. For interactive reanalysis, if this parameter is not specified, or if the user does not have UPDATE access to the specified history file, then a prompt is issued to allow the specification of the history file to be used.

For batch reanalysis, this parameter must be specified, otherwise, RC=4 is issued.

Return codes

The IDIRegisterFaultEntry command provides the following return codes:
0
Successful completion.
4
A fault entry already exists, or request canceled by user via interactive prompt.
12
Command syntax error. An explanation of the error is written to the IDITRACE DDname.

Example

Figure 2. IDIRegisterFaultEntry command example
/* REXX */

/* Create registration fault entry in history file MY.HIST */
ENV.USER_TITLE = 'My fault!'
ENV.USER_NAME  = UserID()
ENV.LOCK_FLAG  = '/'
dsn = 'my.hist'
"IDIRegisterFaultEntry IDIHIST("dsn")"
if rc <> 0 then
  "IDIWTO IDIRegisterFaultEntry failed, rc="rc
exit 0

See Sample Formatting user exits for another example of the IDIRegisterFaultEntry command usage.