ViewPoint Manual

Customizing ViewPoint
ViewPoint Manual—426801-001
6-33
Status-Server Error Codes
implemented by the server, the server should return the error code ZERR-STAT-
END-OF-TYPES.
Z-CHECK-ITEM-CODE
This command provides a status item that has been specified from the Status Item
Configuration screen. The server should check the status item for consistency.
Possible error codes returned are ZERR-STAT-NO-SUCH-TYPE, ZERR-STAT-NO-
SUCH-OBJECT, and ZERR-STAT-CNFG-INCOMPATIBLE.
If no errors are detected, the server should return the status item with changes (if
any) that the server wants to enforce. Two fields that the server should always set
are Z-SCALE and Z-VALUE-TYPE. These fields cannot be changed from the
Status Item Configuration screen.
Z-SAMPLE-ITEM-CODE
This command provides a previously configured status-item display type and object
and expects a response containing the current value, the maximum value, and a
timestamp. Possible errors are ZERR-STAT-OBJECT-UNAVAILABLE, ZERR-
STAT-NO-SUCH-TYPE, and ZERR-STAT-NO-SUCH-OBJECT.
Z-SAMPLE-LIST-CODE
This command provides a list containing configured status items (type and object)
and expects in reply a list containing the current value, maximum value, and
timestamp for each item in the request list. This command allows several items to
be sampled with one request. Each sample in the list can generate an error; the reply
includes an error field for each entry in the list. Possible errors are ZERR-STAT-
OBJECT-UNAVAILABLE, ZERR-STAT-NO-SUCH-TYPE, and ZERR-STAT-NO-
SUCH-OBJECT.
Status-Server Error Codes
The error codes given previously in Figure 6-9 are described below. As shown in Figure
6-9, the nonzero errors correspond to error numbers 206 through 211 that are displayed
by the ViewPoint application. When the server detects one of the errors described, it
assigns the proper code to Z-IPC-RETN-CODE in the response-message header. Z-PW-
REPLY-CODE is assigned a value of 3. Only the response header is included in the
response message.
Z-ALL-OK-CODE
The status server detected no errors.
ZERR-STAT-COLLECT-REQUEST
The command to the status server was unrecognizable (because the command code
was not provided or was invalid).