Distributed Systems Network Management (DSNM) Subsystem Interface Development Guide

Reporting Errors to the Frame
3-52
109759—Distributed Systems Network Management (DSNM) Subsystem Interface
Development Guide
I Process Development Process
•
If appropriate, generate an EMS event (see “Reporting Errors to EMS” for
guidelines).
•
Return to the frame with an appropriate _RC^ABORT error to describe the error.
The _EV^CANCEL event should be handled like an error except that it is a normal
thread termination (return code _RC^STOP is appropriate).
Reporting Errors to the Frame
Errors that do not terminate the command must be associated with some command
object (for instance, an object name unknown by the subsystem). Usually, errors
associated with an object should not terminate the command, although there may be
exceptions for individual subsystems.
Errors that do not terminate the command are reported in the FOBJECT result code field
(Z^RESULT) of the affected output object structure. The result code must be one of the
defined ZDSN^ERR token values (see Appendix B, “DSNM Error Codes”). The
structure must also contain all entries appropriate for the executed command, including
the fully qualified object name.
For errors generated by the subsystem, the result code should be
ZDSN^ERR^SUBSYSTEM^ERR. In addition, one line of result text
(ZDSN^VTY^RESULTTEXT), briefly describing the subsystem error, should be
appended to the output object. The result text must not duplicate the information of the
result code, but add to it. To formulate result text, assume that presentation services will
substitute the text listed in Appendix B, “DSNM Error Codes,” associated with each
ZDSN^ERR code in the error display.
If ZDSN^EMOD^DETAIL is in effect, and if there is more error information available
from the subsystem than can reasonably be given in the one line of result text, one or
more lines of error text (ZDSN^VTY^ERRTEXT) should be appended to the structure.
The decision to supply error text depends upon the information available from the
subsystem: it should be omitted unless there is genuine additional information to be
transmitted.
Errors returned from a subsystem or arising when accessing the subsystem should be
reported using the following ZDSN^ERR values:
•
ZDSN^ERR^FS^ERR
Use this value to report file system errors that occur when accessing the subsystem
(for example, if the manager is not running) or that are passed through from the
subsystem about a subsystem object (for example, a security violation). The
file-system error number should be appended as ZDSN^VTY^RESULTTEXT.
If the file that caused the error is not the same as the object in the object structure,
the error file name should be given in the text also, as “node.$filename.”
Note. ZDSN^EMOD^SUPPRESS allows the user to suppress errors associated with the
subsystem (undefined objects, unreachable managers, and so on); when
ZDSN^EMOD^SUPPRESS is in effect, error objects should be omitted from the output object
list.