Common Fields

The following fields are common across all events:

Name Description Data type Required
component The unique name of the component associated with this event (if applicable). Component names should be in the format of [componentType]/[name] (for example, "adapter/xyz123"). By definition, a component is a privately-owned/embedded "part of" a server. In contrast, a service is a shared resource used by one or more servers. String No
context The name of the context associated with this event. String No
event

The type of event:

  • Heartbeat
  • ProcEnd
  • ProcStart
  • ProcStatus
  • StepEnd
  • StepStart
  • ServerCommand
  • ServerStatus
  • TransferEnd
  • TransferStart
  • TransferStatus
  • TransferStepEnd
  • TransferStepStart
 String Yes
location The location associated with this event. String No
msgId The unique message ID of the event. Most of the IBM products use a message ID along with message text, which allows the message ID to be used to identify particular events even when the message text has been translated. String Yes
msgText The text associated with the message ID. String No
nodeId

The unique node ID where this event occurred. The first element is a short code that identifies the type of node/server. Remaining elements of the ID can include a forward slash to identify geographical or logical relationships such as engine to adapter, node to cluster, cluster to data center, and so on. Examples:

  • cron/amhurst1701
  • cron/cluster0/amhurst1701
  • cron/North America/East/DC3/amhurst1701
 String Yes
occurred The date and time on which this event occurred. Date Yes
rmtLocation The remote location associated with this event. String No
returnCode Used to ascertain the success or failure for the process or transfer. A value of 0 means success and any other value means failure. Note that this value must be quoted even if the return code is a number. String No
sequence The number of microseconds after the given date that the event occurred (0 - 999). Use this value to chronologically disambiguate two events that occurred at the exact same millisecond. Number Yes
service The unique name of the service associated with this event (if applicable). Service names should be in the format of [serviceType]/[name] (for example, "database/xyz123"). String No
srcLocation The source location associated with this event. String No
type This value must be hard-coded to "event". String Yes