SPI Common Extensions Manual

Glossary
SPI Common Extensions Manual—427508-001
Glossary-4
error list
error list. A grouping of tokens used within a response record to provide error and warning
information. An error list begins with ZSPI-TKN-ERRLIST, ends with ZSPI-TKN-
ENDLIST, and contains an error token and other tokens explaining the error. Error lists
can be nested within other error lists. The return token cannot be included in an error
list. See return token.
error number. A value that can be assigned to a return token, or to the last field of an error
token, to identify an error that occurred. SPI defines a small set of error numbers, the
SPI extensions define many more, and subsystems define others.
error token. A response token, ZSPI-TKN-ERROR, that identifies an error that occurred
during command processing. Every error list contains an error token. Its value is a
structure consisting of the subsystem ID and an error number identifying the error. See
error list, error number, and return token.
event. A significant change in some condition in the system or network. Events can be
operational errors, notifications of limits exceeded, requests for action needed, and so
on.
event management. The reporting and logging of important events that occur in a system
or network, the distribution and retrieval of information concerning those events, and
the actions taken by operations personnel or software in response to the events.
Compare with control and inquiry.
Event Management System (EMS). A software facility that provides event-message
collection, logging, and distribution facilities for the operating system (implemented as
a major enhancement of the operator process, $0). It provides for different descriptions
of events for people and for programs, lets an operator or application select
conveniently from event-message data, and allows for flexible distribution of event
messages within a system or network. It has programmatic interfaces based on SPI for
both event reporting and event retrieval. See event message.
event message. A special kind of SPI message that describes an event occurring in the
system or network.
extensible structured token. A token with a value that can be extended by appending new
fields in later releases. Such structures are typically used to indicate the attributes of
an object being operated on and to return status and statistics information in
responses. The token is accessed through reference to a token map that contains field
version and null-value information that allows SPI to provide compatibility between
different versions of the structure. Compare with simple token; see also structure,
structured token, and token map.
flush. With reference to an SPI buffer, to erase all tokens, including tokens in lists, starting
at the current position and continuing to the end of the buffer. To flush a buffer, call
SSPUT with the token ZSPI-TKN-DATA-FLUSH.