ViewPoint Manual

Customizing ViewPoint
ViewPoint Manual—426801-001
6-39
Message Structures for Status
Commands and Responses
The field Z-RETN-CODE indicates success (Z-ALL-OK-CODE) or an error
(ZERR-STAT-name).
The command-message and response-message fields not previously described are now
described below.
Z-SCALE
This value indicates the number of digits assumed to the right of a decimal point in
status values. The value can be 0, 1 or 2. This value cannot be changed by
configuration; the server should set it in the response to the CHECK-ITEM
command. For most counters, Z-SCALE should be 0. If the item is a busy-timer
item, this value is ignored.
Z-ITEM-INDEX
In SCAN-ITEM and NEXT-ITEM responses, this value is the index of the returned
status item; index values begin at 1.
In NEXT-ITEM commands, this value is the index of the previously scanned item.
The server adds 1 to this value to get the index of the next status item, then returns
this next item.
Z-OBJECT-INDEX
This field exists for compatibility reasons; the server must initialize it to 0 (zero).
definition ZVPT-CHECK-ITEM-REPLY.
02 Z-STATUS-ITEM type ZVPT-STATUS-ITEM.
end.
definition ZVPT-SAMPLE-ITEM-REQUEST.
02 Z-ITEM-NAME type ZVPT-ITEM-NAME.
end.
definition ZVPT-SAMPLE-ITEM-REPLY.
02 Z-STATUS-VALUE type ZVPT-STATUS-VALUE.
02 Z-MAXIMUM-VALUE type ZVPT-STATUS-VALUE.
02 Z-TIMESTAMP type ZVPT-TIMESTAMP.
end.
definition ZVPT-SAMPLE-LIST-REPLY.
02 Z-SAMPLE-COUNT type binary 16.
02 Z-SAMPLE-ITEM occurs 1 to 16 times
depending on Z-SAMPLE-COUNT.
03 Z-RETN CODE type binary 16.
03 Z-RETN-CODE-DETAIL type binary 16.
03 Z-STATUS-VALUE type ZVPT-STATUS-VALUE.
03 Z-MAXIMUM-VALUE type ZVPT-STATUS-VALUE.
03 Z-TIMESTAMP type ZVPT-TIMESTAMP.
end.
Figure 6-11. Status-Server Command and Response Messages (page 2 of 2)