SPI Programming Manual (G06.24+, H06.03+, J06.03+)

Glossary
SPI Programming Manual—427506-006
Glossary-13
Subsystem Programmatic Interface (SPI)
Subsystem Programmatic Interface (SPI). A set of procedures and associated definition
files and a standard message protocol used to define common message-based
interfaces for communication between management applications and subsystems. It
includes procedures to build and decode specially formatted messages (as described
under SPI message
); definition files in TAL, COBOL, and TACL for inclusion in
programs, macros, and routines using the interface procedures; and definition files in
DDL for programmers writing their own subsystems.
subsystem version number. A 16-bit integer representing the software release version of
a subsystem. The subsystem version number is a field of the subsystem ID. If its value
is null (zero), the subsystem ID refers to any and all versions of the subsystem. See
version number
.
subsystem-control token. A parameter token that influences how a subsystem performs a
command. For instance, in the START PATHWAY programmatic command, the
parameter ZPWY-TKN-DEF-PATHWAY is a subsystem-control token, because it
determines whether a cold start or a cool start is performed. Likewise, the standard SPI
token ZSPI-TKN-ALLOW-TYPE, supported by some subsystems, is a subsystem-
control token; it determines under what conditions the subsystems will continue
command processing on the next object in a sequence if errors or warnings occur.
Compare with response-control token
.
summary state. One of the generally defined possible conditions of an object with respect
to the management of that object. A summary state differs from a state in two ways.
First, a summary state pertains to the management of an object, whereas a state can
convey other kinds of information about the object. Second, the set of summary states
is a common list defined the same way for all extended SPI subsystems, whereas the
set of possible states differs from subsystem to subsystem. The SPI extensions define
a number of summary states, including STARTED, STOPPED, SUSPENDED,
ABORTING, and DEFINED.
syntax token. A token whose function is not to provide information for a command or
response, but to bracket or group other tokens; its use is analogous to that of a
punctuation symbol. The tokens that begin and end lists (the list tokens) are syntax
tokens. Compare with parameter token
.
token. In SPI, a distinguishable unit in an SPI message. Programs place tokens in an SPI
buffer using the SSPUT procedure (except for header tokens, which are a special
case), and retrieve them from the buffer with the SSGET procedure. A token has two
parts: an identifying code—a token code—and a token value. For command and
response messages, a token normally represents a parameter to a command, an item
of information in a response, or control information for the subsystem. For event
messages, a token normally represents an item of information about an event or about
the event message itself. In TACL, an entity recognized by the #ARGUMENT built-in
function when parsing an argument string passed to a routine.
token code. In SPI, a 32-bit value that, as the first part of a token, allows any token to be
identified and located within an SPI message. A token code consists of a token type