zOS-SYSLOG-Console-Annotate annotations

This reference describes the fields that are annotated by zOS-SYSLOG-Console-Annotate.

Table 1 includes the following information about each field:
  • The field name, which corresponds to a field in the IBM® Operations Analytics - Log Analysis Search workspace
  • The description of what the annotation represents
  • The primary index configuration attributes that are assigned to the field, such as the data type and the indication of whether the field can be sorted, filtered, or searched.
Table 1. Log record fields that are annotated by zOS-SYSLOG-Console-Annotate
Field Description Data type Sortable Filterable Searchable
ApplID The application identifier Text ✓ ✓ ✓
ASID The address space identifier Text ✓ ✓ ✓
CommandPrefix The command prefix Text ✓ ✓ ✓
Component The component identifier, which shows the domain or component that issues the message Text ✓ ✓ ✓
ConsoleName The console name Text ✓ ✓ ✓
datasourceHostname The host name that is specified in the IBM Operations Analytics - Log Analysis data source Text   ✓ ✓
JobName The 8-character name of the job on the z/OS® system Text ✓ ✓ ✓
logRecord The log record Text     ✓
MessageID The message identifier

Also, see Message IDs.

 Text ✓ ✓ ✓
MessagePrefix The first 3 characters of the message identifier. If no value is detected for MessageID, MessagePrefix has no value. Text   ✓ ✓
MessageText The message text. If a value is detected for MessageID, MessageText contains only the part of the message after the MessageID. Text     ✓
MessageType The one-character message type that is specified in the MessageID value. Valid values are A, I, E, W, D or S.

If no value is detected for MessageID, or if the MessageID value does not contain a message type, MessageType has no value.

 Text   ✓ ✓
RouteCodes The route codes Text     ✓
SystemName The system name Text ✓ ✓ ✓
Task The job identifier for the task that issued the message Text     ✓
timestamp The time stamp of the log record Date ✓ ✓ ✓
UserExitFlags The user exit flags Text     ✓

Message IDs

A string is detected as a message ID if it matches one of the following formats:
aaxxxn
aaxxxnt
aaxxxxn
aaxxxxnt
aaxxxxxn
aaxxxxxnt
aaxxxxxxn
aaxxxxxxnt
$HASPnnn
$HASPnnnn
DFHaann
DFHaannn
DFHaannnn
DFHnn
DFHnnt
DFHnnn
DFHnnnn
EYUaann
EYUaannn
EYUaannnn
EYUnn
EYUnnt
EYUnnn
EYUnnnn
where:
  • a represents an uppercase alphabetic character (A - Z).
  • n represents a numeric character (0 - 9).
  • x represents an uppercase alphabetic character or a numeric character.
  • t represents a type character (A, I, E, W, D, or S). If the first 3 characters of the message ID are DFH or EYU, U is also a valid type character.

Sometimes, a string that is not a message ID, but matches one of the preceding formats, might show in the MessageID field.

Parent topic: zOS-SYSLOG-Console