TS/MP 2.5 Management Programming Manual

Table 32 Error List Tokens
DescriptionToken
Tokens Always Present
This token marks the beginning of an error list. It identifies an error list containing
additional information about an error reported in ZSPI-TKN-RETCODE.
ZSPI-TKN-ERRLIST
This token marks the end of an error list.ZSPI-TKN-ENDLIST
This token contains the Pathway subsystem ID and an error number. Error numbers
are represented by symbolic names of the form ZPWY-ERR-objecttype-
ZSPI-TKN-ERROR
message, where objecttype is the object type affected, and message names
the error.
This token identifies the command from the request. If the command is unavailable,
this token contains the value ZSPI-VAL-NULL-COMMAND.
ZPWY-TKN-REQCOMMAND
This token identifies the object type from the request. If the object type is
unavailable, this token contains the value token ZSPI-VAL-NULL-OBJECT-TYPE.
ZPWY-TKN-REQOBJECTTYPE
Tokens Sometimes Present
This token identifies all object names from the corresponding object-selector token.
If the name is unavailable or the object does not require a selector (for example,
the PATHMON or PATHWAY object), this token is absent.
ZPWY-TKN-REQ nnnNAME
This token contains the code of the token in error and the offset to the field in
error. ZSPI-TKN-PARM-ERR is used for field validation and identifying required
ZSPI-TKN-PARM-ERR
fields that are missing. Information about this token appears in the DSM
Programming Manual.
This token identifies the command that caused the error. If the command is
unavailable, this token contains the value ZSPI-VAL-NULL-COMMAND.
ZPWY-TKN-ERRCOMMAND
This token identifies the object type that caused the error; this token is often the
same as ZPWY-TKN-REQOBJECTTYPE.
ZPWY-TKN-ERROBJECTTYPE
This token identifies the name of the Pathway subsystem object that is the subject
of the error message. nnn represents the Pathway subsystem object type received
in the request.
ZPWY-TKN-nnnNAME
This token contains additional information about the error. ZPWY-TKN-ERRINFO
has the token number ZPWY-TNM-ERRINFO and the token type ZSPI-TYP-INT.
ZPWY-TKN-ERRINFO
This token also contains additional information about the error.
ZPWY-TKN-ERRINFO2 has the token number ZPWY-TNM-ERRINFO2 and the
token type ZSPI-TYP-ERRINFO2.
ZPWY-TKN-ERRINFO2
The information in the error list becomes accessible when your program calls the SPI SSGET
procedure. SSGET extracts a token from the buffer after the PATHMON process has processed a
command and returned a response message. SSGET does not return tokens that are outside the
error list until you select the ZSPI-TKN-ENDLIST token.
Example Error Lists
These scenarios produce two different response messages from the PATHMON process.
Scenario 1
Your management application issues a START SC command for CLASS-A, but CLASS-A has already
been started. The response message your program receives contains:
• The message header, including the command (ZPWY-CMD-START), the object type
(ZPWY-OBJ-SC), the version of the PATHMON process, and the subsystem ID
• ZSPI-TKN-RETCODE, containing the value ZPWY-ERR-PM-ALREADYSTARTED
• ZSPI-TKN-ERRLIST
172 Event Management