Safeguard Management Programming Manual (G06.24+, H06.03+)

Glossary
Safeguard Management Programming Manual—422086-012
Glossary-15
SPI definitions
codes for SSPUT are examples of SPI control codes. An SPI control code is a kind of
special operation. See special operation.
SPI definitions. See SPI standard definitions.
SPI error number. A number that indicates whether a call to an SPI procedure completed
successfully and why it failed if it did. This number is returned in the status parameter
on calls to the SPI procedures. The SPI error number does not reflect the success or
failure of a command. It applies only to errors in the building and decoding of a
message in an SPI buffer.
SPI message. A message specially formatted by the SPI procedures for communication
between a management application and a subsystem or between one subsystem and
another. An SPI message consists of a collection of tokens. To retrieve a token from
the message, the application passes a token code to SPI, which scans for the
appropriate token and returns its value to the application. An SPI message is a single
block of information sent at one time as one interprocess message. There are two
types of SPI messages, distinguished by two different SPI message header types: 1)
command and response messages, and 2) event messages. See header type.
SPI message header. The initial part of an SPI message. The first word of this header
always contains the value -28. The remainder of the header contains descriptive
information about the SPI message, most of which is accessible as header tokens. The
tokens in an SPI message header differ according to the header type. The header of a
message that contains a command or response differs somewhat from the header of
an event message. An application can use SSGET or EMSGET calls to retrieve the
values of header tokens and can use SSPUT calls to change the values of some.
However, there are basic differences between header tokens and other tokens. See
header token.
SPI procedures. The set of procedures used to build and decode buffers for use in system
and network management and in certain other applications. These procedures are
SSINIT, SSNULL, SSPUT, SSPUTTKN, SSGET, SSGETTKN, SSMOVE, and
SSMOVETKN.
SPI standard definitions. The set of declarations available for use with the SPI procedures
regardless of the subsystem. There is also a set of subsystem-specific declarations for
each subsystem, and some sets of declarations apply to multiple subsystems. An
application using SPI needs the SPI standard definitions and also the subsystem
definitions for all subsystems with which it communicates. Names of SPI standard
definitions start with ZSPI. See also definition and definition files, EMS standard
definitions, data communications standard definitions, and subsystem definitions.
statistics token. A response token providing performance data about an object. A statistics
token is a kind of information token.
status item. A measurable condition in a system or network. Each such item is separately
chosen and configured for display by use of the Status Item Configuration screen.