This documentation contains messages and codes issues by SMARTS.
This document covers the following topics:
All SMARTS messages have the following format:
APSsssnnnn - message-id
-where
| sss | identifies the subsystem issuing the message. |
| nnnn | is a sequential message number identifying the message within the subsystem. |
| message-id | identifies the SMARTS address space issuing the message, which is determined from the SMARTS server environment configuration parameter MESSAGE-ID. The value may be a single character in braces (e.g. (X)) or it may contain the installation ID as specified in the SMARTS server environment configuration parameter INSTALLATION. Refer to SMARTS Installation and Operations for more information. |
Messages are documented with the message identifier (excluding the constant `APS' which is always present) in the heading followed by the message text. The message text has the format
This is a test &1 with three (&2) replacement parms `&3'
When displayed or written to the console, the message contains the text as displayed here; however, the placeholders identified by the `&n' construct are replaced by data relevant to the message. If the data to be displayed is X, y and AB, the message appears as
This is a test X with three (y) replacement parms `AB'
Each message has the following subsections:
Description
Describes why the message was issued.
Placeholders
Describes the contents of the placeholders; i.e., the `&n' values in the message. If the message contains no placeholder, this section contains the expression `Not applicable'.
Action
Describes the actions to be taken when the message is issued. A number of actions may be listed in this section, if appropriate. If no action is required, this section contains the expression `Not applicable'.
Additional References
Describes additional sources of information that may help to explain the message. If no additional references are available, this section contains the expression `Not applicable'.
