1.2 Format of message descriptions

This subsection explains the format of the message descriptions used in this manual.


XXXXnnnnn-Y

message-text

explanation-of-variables
Description:
Provides additional information about the message text.
System processing:
Describes the system processing that was underway when the message was output.
Action to take:
Recommends a corrective action for the user to take.

Depending on the message, one or more of explanation-of-variables, Description, and Action to take might be omitted.

The following explains the different components of messages, and the format of the message descriptions that follow messages.

XXXXnnnnn
This component represents the message ID. The message ID is made up of the following elements:
XXXX
Displays the prefix KFSP, which indicates a Stream Data Platform - AF message.
nnnnn
Represents the message number used by Stream Data Platform - AF to manage messages. Each message is associated with a unique, five-digit number.
Y
This component represents the message severity level. The message severity level is expressed as a single alphabetic character.
The characters used to represent the message severity levels and their meanings are given below.
E (Error)
Messages of this type indicate that an error-level problem has occurred.
W (Warning)
Messages of this type indicate that a warning-level problem has occurred.
I (Information)
Messages of this type report a system operation.
The system resumes processing after the message is output.
Q (Question)
Messages of this type require a user response.
After the system outputs a Q-type message, it waits for a response from the user.
message-text
This component represents the actual message text output by Stream Data Platform - AF.
explanation-of-variables
Information in message text that represents variables (placeholder text that is replaced by actual values when the message is output) is explained using the form xx....xx: displayed-information, where xx is a lower-case alphabetic character. The following shows an example of a variable explanation:
Example:
aa....aa: Name of the file
bb....bb: Name of the application
Description:
This section provides additional information about the message, such as details about the possible causes reported by the message or about the Stream Data Platform - AF operation that output the message.
System processing:
Indicates the processing that Stream Data Platform - AF performs in response to the message.
Action to take:
Recommends an appropriate corrective action for the user to take.
Depending on the message, you might need to contact a system administrator. If a system administrator requires more information, we recommend that the system administrator direct inquiries to the customer support contact person listed in the purchase contract.