Distributed Systems Network Management (DSNM) Subsystem Interface Development Guide

Response Modifiers
4-6
109759—Distributed Systems Network Management (DSNM) Subsystem Interface
Development Guide
DSNM Command Requirements
The Error Modifier (_INPUT.MOD.Z^EMOD)
The error modifier (EMOD) controls how much information to return if a subsystem
error occurs during command processing. EMOD is valid for all DSNM commands
except AGGREGATE; its values have the following meanings:
Any output object that has an error associated with it must contain a ZDSN^ERR code
in the Z^RESULT field (see Appendix B, “DSNM Error Codes”).
If ZDSN^EMOD^BRIEF is in effect (the default if EMOD is omitted or has the
value 0), one line of result text (ZDSN^VTY^RESULTTEXT) describing the
ZDSN^ERR value in the Z^RESULT code field should be appended to the output object
(with _APPEND^OUTPUT). The result text must not duplicate the information of the
result code. To formulate result text, assume that presentation services will substitute
text (listed in Appendix B) for the result code in the error display.
If ZDSN^EMOD^DETAIL is in effect, and if more error information is available from
the subsystem than can fit on one line, additional lines of error text
(ZDSN^VTY^ERRTEXT) should be appended to the structure to describe the error in
detail. (Whether to supply error text depends on the information available from the
subsystem; it should be omitted unless there is useful additional information to
transmit.)
When the BRIEF response gives all the error information from the subsystem, the
DETAIL and BRIEF error responses are identical.
ZDSN^EMOD^BRIEF Append a single line of text
(ZDSN^VTY^RESULTTEXT) to describe the
ZDSN^ERR error code in the Z^RESULT field to
members on the output object list that generate an
error. This is the default.
ZDSN^EMOD^DETAIL Append as much available information about the error
(ZDSN^VTY^ERRTEXT) to members on the output
object list that generate an error, in addition to the
EMOD^BRIEF response.
ZDSN^EMOD^SUPPRESS Suppress the reporting of objects that cause subsystem
errors. If the command returns status, configuration, or
statistical information, do not create an output object
list member for any objects that generate errors.