Distributed Systems Network Management (DSNM) Subsystem Interface Development Guide

The Output Object List
4-10
109759—Distributed Systems Network Management (DSNM) Subsystem Interface
Development Guide
DSNM Command Requirements
The Output Object List
The output object list is built by the command thread. Each member includes a
formatted object structure named FOBJ (defined by ZDSN^DDL^FOBJECT^DEF) that
describes one object to which the command was applied.
Depending on the command, and the hierarchy, state, and error modifiers, a single input
list object may produce many output objects (which may or may not include the original
input list object), or no output objects at all.
With minor exceptions (see detailed command descriptions in this section), the
command thread must always fill the following fields in each output object:
Output Object Variable-Length Items
Depending on specific command details, one or more of the following variable-length
items can be appended to an output object (with _APPEND^OUTPUT):
The maximum length of a text line (RESULTTEXT, TEXT, or ERRTEXT items) that
may be appended is 75 characters (ZDSN^MAX^TEXT).
Z^RESULT Is an INT field containing the result code for the output object. It
can be one of the ZDSN^ERR values (see Appendix B), a
ZDSN^STATE value (for the STATUS command), or null (0 value).
Except for STATUS command responses, ZDSN^ERR^NOERR
(0 value) is used in all responses when no error occurs.
Z^SUBSYS Is a structure (defined by ZDSN^DDL^SUBSYS^DEF) that
identifies the subsystem to which the object belongs.
Z^OBJTYPE Is a structure (defined by ZDSN^DDL^OBJTYPE^DEF) that
specifies the subsystem object type of the object.
Z^OBJNAME Is a structure (defined by ZDSN^DDL^OBJNAME^DEF) that
contains the object name, terminated with a blank or null.
Z^MANAGER Is a structure (defined by ZDSN^DDL^MANAGER^DEF) that
contains the name of the manager process (if any), terminated with a
blank or null. If there is no manager, this field should be blank or
null (0 value).
ZDSN^VTY^RESULTTEXT Interprets the Z^RESULT code, either describing the
subsystem state of the object (for STATUS
commands) or providing error information.
ZDSN^VTY^TEXT Is the response text for STATUS (DETAIL), INFO, or
STATISTICS commands.
ZDSN^VTY^ERRTEXT Is detailed error text.
ZDSN^VTY^COUNTERS Is the state summary counters for the AGGREGATE
command.