./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:Message Data - WAS 6.x ./Message_Data.html: ./Message_Data.html:

./Message_Data.html: ./Message_Data.html:

 

./Message_Data.html: ./Message_Data.html:

Message Data

./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

All problem determination Common Base Events must provide human ./Message_Data.html:readable text describing the specific event being reported within the msg ./Message_Data.html:field of the Common Base Event. The text associated with events representing ./Message_Data.html:actual messages or log entries is expected to be internationalized (in other ./Message_Data.html:words, translated and localized). We strongly recommend including the msgDataElement ./Message_Data.html:element in the Common Base Event whenever internationalized text is provided ./Message_Data.html:in the event. This element provides information about how the message text ./Message_Data.html:was created and how it should be interpreted, and is particularly invaluable ./Message_Data.html:when trying to interpret the event programmatically or when trying to interpret ./Message_Data.html:the message independent of the locale or language used to format the message ./Message_Data.html:text. ./Message_Data.html:

Note: Readers of this section of the document should be familiar with ./Message_Data.html:the concepts associated with creating internationalized messages (in other ./Message_Data.html:words, messages that are translated and localized). A good source of education ./Message_Data.html:on these concepts is provided by the documentation associated with internationalization ./Message_Data.html:of Java information and the usage of resource bundles within the Java language. ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

The ./Message_Data.html:msgDataElement element in the Common Base Event includes the following information ./Message_Data.html:about the text (i.e. the value of the msg field) provided with an event: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

    ./Message_Data.html: ./Message_Data.html:

  • The locale of the supplied message text, which identifies how the locale-independent ./Message_Data.html:fields within the message were formatted, as well as the language of the message ./Message_Data.html:(msgLocale). ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

  • A locale-independent identifier associated with the message that can be ./Message_Data.html:used to interpret the message independent of the message language, message ./Message_Data.html:locale, and how the message was formatted (msgId and msgIdType). ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

  • Information on how a translated message was created, including: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

      ./Message_Data.html: ./Message_Data.html:

    • The identifier used to retrieve the message template (msgCatalogId). ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

    • The name and type of message catalog used to retrieve the message template ./Message_Data.html:(msgCatalog and msgCatalogType). ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

    • Any locale-independent information that was inserted into the message ./Message_Data.html:template to create the final message (msgCatalogTokens). ./Message_Data.html: ./Message_Data.html:

    ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

./Message_Data.html:The Common Base Event specification [CBE101] provides information on ./Message_Data.html:the required format of these fields and the Common Base Event Developer’s ./Message_Data.html:Guide [CBEBASE] provides general usage guidelines. This section will provide ./Message_Data.html:additional information about how to format and use these fields for problem ./Message_Data.html:determination events, which should be used to clarify and extend the information ./Message_Data.html:provided in the other documents. ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

msg
./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

All message, log, and trace events must provide a human-readable message ./Message_Data.html:in the msg field of the Common Base Event. The msg field is required for ./Message_Data.html:problem determination events (both log events and diagnostic events). This ./Message_Data.html:is more restrictive than the base specification for the Common Base Event, ./Message_Data.html:which lists this as an optional field; because effective and efficient problem ./Message_Data.html:determination requires the ability to quickly identify the condition being ./Message_Data.html:reported by the event. The format and usage of this message is component-specific, ./Message_Data.html:but the following general guidelines should be followed: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

    ./Message_Data.html: ./Message_Data.html:

  • The message text supplied with messages and log events is expected to ./Message_Data.html:be internationalized. ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

  • The locale of the supplied message text should be provided using the msgLocale ./Message_Data.html:field in the msgDataElement element of the Common Base Event. ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

  • Additional information regarding the format and construction of internationalized ./Message_Data.html:messages should be provided whenever possible, using the msgDataElement element ./Message_Data.html:of the Common Base Event. ./Message_Data.html: ./Message_Data.html:

./Message_Data.html:

./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

msgLocale
./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

The message locale should be provided whenever message text is provided ./Message_Data.html:within the Common Base Event (as is the case with all problem determination ./Message_Data.html:events). The msgLocale field is listed as an optional value within the Common ./Message_Data.html:Base Event specification, but it should be provided within problem determination ./Message_Data.html:events whenever it is available. The only reason this is not a required field ./Message_Data.html:for problem determination events is there are instances where the locale information ./Message_Data.html:is not provided or available when formatting the Common Base Event.
./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

msgId and msgIdType
./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

Several companies include within internationalized message text a locale-independent ./Message_Data.html:identifier that can be used to interpret the condition being described by ./Message_Data.html:the message text, independent of the language of the message. For example, ./Message_Data.html:most messages issued by IBM software look like "IEE890I WTO Buffers in console ./Message_Data.html:backup storage = 1024", where a unique, locale-independent identifier "IEE890I" ./Message_Data.html:precedes the translated message text. This identifier provides a way to uniquely ./Message_Data.html:detect and identify a message independent of the location (and language) where ./Message_Data.html:it was issued, meaning it is invaluable for locale-independent and programmatic ./Message_Data.html:analysis. The msgId field is listed as an optional value within the Common ./Message_Data.html:Base Event specification, but it must be provided within problem determination ./Message_Data.html:events whenever this identifier is included in the message text. Likewise, ./Message_Data.html:the msgIdType field is listed as an optional value within the Common Base ./Message_Data.html:Event specification, but it must be provided within problem determination ./Message_Data.html:events whenever a value is supplied for msgId. These fields should not be ./Message_Data.html:supplied when the message text has not been translated or localized, for example, ./Message_Data.html:for trace events.
./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

msgCatalogId
./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

The msgCatalogId field is listed as an optional value within the Common ./Message_Data.html:Base Event specification, but it should be provided whenever the Common Base ./Message_Data.html:Event includes localized or translated message text, for example when providing ./Message_Data.html:problem determination events representing issued messages or log events. ./Message_Data.html:It is not a required field for problem determination events because not all ./Message_Data.html:problem determination events include translated message text, and there are ./Message_Data.html:cases where the value is not provided or available when formatting the Common ./Message_Data.html:Base Event. This field should not be supplied when the message text has not ./Message_Data.html:been translated or localized, for example, for trace events.
./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

msgCatalogTokens
./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

The msgCatalogTokens field is listed as an optional value within the ./Message_Data.html:Common Base Event specification, but it should be provided whenever the Common ./Message_Data.html:Base Event includes localized or translated message text, for example when ./Message_Data.html:providing problem determination events representing issued messages or log ./Message_Data.html:events. It is not a required field for problem determination events because ./Message_Data.html:not all problem determination events include translated message text, and ./Message_Data.html:there are cases where the value is not provided or available when formatting ./Message_Data.html:the Common Base Event. This value contains the list of locale independent ./Message_Data.html:values (message tokens) inserted into the localized message text when creating ./Message_Data.html:a translated message. It is very difficult to extract these values from a ./Message_Data.html:translated message without having knowledge of the translated message template ./Message_Data.html:used to create the message, meaning having these values separate from the ./Message_Data.html:message text is invaluable for locale-independent and programmatic analysis ./Message_Data.html:of the data supplied in the message text. This field should not be supplied ./Message_Data.html:when the message text has not been translated or localized, e.g. for trace ./Message_Data.html:events. ./Message_Data.html:

Note: The Common Base Event provides several mechanisms for providing ./Message_Data.html:additional data about an event, including this field, extended ./Message_Data.html:data elements, and extensions to the schema. The msgCatalogTokens field should ./Message_Data.html:always be used to supply the list of message tokens included in the message ./Message_Data.html:text associated with an event. These values can also be supplied in other ./Message_Data.html:parts of the Common Base Event as well, but they must be included in this ./Message_Data.html:field.

./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

msgCatalog and msgCatalogType
./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

The msgCatalog and msgCatalogType fields are listed as optional values ./Message_Data.html:within the Common Base Event specification, but they should be provided whenever ./Message_Data.html:the Common Base Event includes localized or translated message text, for example ./Message_Data.html:when providing problem determination events representing issued messages or ./Message_Data.html:log events. They are not required fields for problem determination events ./Message_Data.html:because not all problem determination events include translated message text, ./Message_Data.html:and there are cases where the values are not provided or available when formatting ./Message_Data.html:the Common Base Event. These fields should not be supplied when the message ./Message_Data.html:text has not been translated or localized, for example, for trace events.
./Message_Data.html:

./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html: ./Message_Data.html:

 


./Message_Data.html: ./Message_Data.html:
./Message_Data.html: ./Message_Data.html:

 

./Message_Data.html:

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.