Event base event class

The Event (or EVENT) event class is the base class, which is the parent of all event classes.

The hidden slots are internal slots and cannot be changed.

Important

For the event slots that have the string or list of string data types, the character limit of the slot value is 32766. If the value goes above this limit, the value is trimmed, which results in data loss.

EVENT base class slots

Slot nameSlot display nameTypeDescriptionHidden?
_arrival_timeArrived

Long (Epoch milliseconds)


Time when the event is received by the Event Processing Service.

If you do not specify a value for this slot, the current time is considered. This value can never be zero.

No
_ci_idHost IDString

CI id maintained for the association.

Used for looking up topology information in the equivalent field external_ids in BMC Helix Dynamic Service Modeling .

No
_entropyEntropy ValueStringThis slot is unused.No

_errors

ErrorsList of stringInternal slotNo
_identifierIDString

Unique ID of an event generated and stored internally.

A combination of only alpha-numeric characters, an underscore (_), a hyphen (-), and, a period (.) are allowed for this slot.

No
_modified_timeModified

Long (Epoch milliseconds)


Updated timestamp of the last modification of particular slots.No
_node_idNode IDList of string

Internal slot

Represents the list of host IDs present in BMC Helix Dynamic Service Modeling .

This slot associates the node and service details from  BMC Discovery to an event.

No
_node_keyNode KeyList of string

Internal slot

Represents the list of host keys present in BMC Helix Dynamic Service Modeling .

This slot associates the node and service details from  BMC Discovery to an event.

No
_node_service_mappingNode Service MappingList of string

Internal slot

Represents the list of node ID(s) associated with the service(s) in BMC Helix Dynamic Service Modeling .

No
_node_service_key_mappingNode Service Key MappingList of string

Internal slot

Represents the list of node keys associated with the service(s) in BMC Helix Dynamic Service Modeling

No
_notesNotes

List of string


List of free text annotations (notes) added to the event.

Yes
_operationsOperation History

List of string


Internally updated based on event policies that were run.


Yes
_relationships



Relationships

Object

Contains information about correlated events such as the primary event count, secondary event count, and the relationship ID between the primary and secondary event.

No
_repeat_countRepeatedInteger

Internal slot.

If you update this slot by using one of the following methods, the event processing is impacted.

  • Modify Event UI operation
  • REST APIs
  • Event policy
No
_service_idService IDList of string

Internal slot

Represents the list of service IDs present in BMC Helix Dynamic Service Modeling .

This slot associates the node and service details from  BMC Discovery to an event.

No
_service_keyService KeyList of string

Internal slot

Represents the list of service keys present in BMC Helix Dynamic Service Modeling .

This slot associates the node and service details from  BMC Discovery to an event.

No
_service_nameService NameList of string

Internal slot

Represents the list of services associated to nodes in BMC Helix Dynamic Service Modeling .

No
_signatureSignatureStringUnique identifier according to the event message and entity or host.No
_tenant_idOrganization IDString

Tenant ID stored internally.

No
_tenant_nameOrganizationString

Tenant name; same as the tenant ID.

No
_unmapped_dataUnmapped DataObjectHolds the map of the key values for _badslot_names and _badslot_values. Also holds the key values that are not defined in class mapping and are from the UNKNOWN class.No
aliasAliasList of string

Alias of the component that is related to the event.

The alias value is enriched with a default value in the following format before the policy phases in event processing start.

Default value:

[BMC_ComputerSystem:<source_hostname>]

To learn about event policy phases, see Event policy types and evaluation order.

You can change the default value by using advanced enrichment policies. To learn about advanced enrichment policies, see Advanced, time-based, and dynamic enrichment policies.

No
categoryCategory

Enum (Category)

Default: OPERATIONS_MANAGEMENT

High-level normalized category of the object that the event represents. This is based on appropriate Information and Technology Infrastructure Library (ITIL) core process.

Possible categories are:

  • SLA_MANAGEMENT
  • CAPACITY_MANAGEMENT
  • SERVICE_CONTINUITY_MANAGEMENT
  • AVAILABILITY_MANAGEMENT
  • INCIDENT_MANAGEMENT
  • CONFIGURATION_MANAGEMENT
  • RELEASE_MANAGEMENT
  • PROBLEM_MANAGEMENT
  • CHANGE_MANAGEMENT
  • OPERATIONS_MANAGEMENT
  • SECURITY_MANAGEMENT
  • FINANCIAL_MANAGEMENT
  • SERVICE_DESK_MANAGEMENT

No
cdmclassCDM ClassString

The CDM class that is used for incident generation.

Example

cdmclass = BMC_SoftwareServer

Populate this slot with the node kind in BMC Discovery to look up nodes based on the node kind and enrich node details (node and service ids) in the event.

No
change_idChange IDString

Unique identifier of the change request that is raised in change management.

No
classClass

String

Default=CUSTOM

Class identifying the event.No
componentaliasComponent AliasString

The component alias that is used for incident generation.

Example:

componentalias = Oracle Database Server:<hostname>:<domain>:<instancename>

The value of this slot is enriched when the Predefined Enrichment Policy for Incident (out-of-the-box policy) executes. To learn about this policy, see Out-of-the-box event policies and templates.

This slot is useful for the L2 use case. To learn about the L2 use case, see L2 use case - Viewing enriched incident details.

No
creation_timeOccurred

Long (Epoch milliseconds)


Time when the event was created by the event source. The event source can be PATROL Agent, a third-party event provider (event generated via the API), a Situation, or an Alarm.

If creation_time is not set by the source, the event processing service sets it to the current system time which matches the _arrival_time.

No
detailsDetailed MessageString

Detailed information about the event.

Expands the information in the msg slot.

No
incident_idIncident IDStringIncident ID generated/associated with eventNo
incident_companyIncident CompanyString

Incident company, or the tenant name.

Example

"incident_company": "Calbro Services"

No
incident_sysidIncident GUIDString

The system ID of the incident that is associated with the event.

No
instancenameCMDB Instance NameString

The Configuration Management Database (CMDB) instance name that is used for incident generation.

Example

instancename = DB instance name

No
lifecycle_timeLifecycle TimeLongInternal slotNo
locationLocationString

Source of the event.

The event source can be PATROL Agent or a third party event provider (event generated via the API).

No
modelModelStringInternal slotNo
modelnameModel NameString

The model name that is used for incident generation.

Example

modelname = Oracle Database server

No
msgMessageStringEvent summary (text description) in briefNo
priorityPriority

Enum (Priority)

Default=PRIORITY_5

Records the original priority of the event upon insertion. Also, records current priority of the event.

Values:

  • PRIORITY_5 (lowest priority)
  • PRIORITY_4

  • PRIORITY_3

  • PRIORITY_2

  • PRIORITY_1 (highest priority) 


No
severitySeverity

Enum (Severity)

Default=MINOR

Severity value of the event.

Possible values are:

  • UNKNOWN
  • OK
  • INFO
  • WARNING
  • MINOR

  • MAJOR

  • CRITICAL
No
significanceSignificance



No
source_addressHost AddressString

IP address of the event source.

No
source_hostnameHostString

Host name of the event source.

Used for looking up topology information in the equivalent field, name/short_name in BMC Helix Dynamic Service Modeling .

The \ and \t characters are not supported in the host name.

No
source_identifierSource IdentifierString

Unique identifier of the event source. The identifier can differ based on the type of event source.

By default, for PATROL Agents, the event source is added in the format, agentHostName:Port. Furthermore, for alarms, the internally generated alarm ID is added.

No
source_portSource PortIntegerPort of the event provider.No
sourceEntityTypesourceEntityTypeString

Used for categorizing the event source entity. For example, the event source entity could be a network, application, and so on.

No
statusStatus

Enum

Default=OPEN

Status value of the event.

Possible values are:

  • OPEN
  • ACK
  • ASSIGNED
  • CLOSED

  • BLACKOUT

No
sub_categoryMonitor Category

Enum

Default=OTHER

Subcategory of the object the event represents based on the appropriate Information Technology Infrastructure Library (ITIL) core process.

Possible values are:

  • OTHER
  • APPLICATION
  • DATABASE
  • NETWORK
  • SYSTEM
  • USER_TRANSACTIONS

No
tagsTagsList of string

Represents a logical value to identify a group of events of a particular type.


No
user_assignedOwnerStringCurrent user assigned to the event.No

Was this page helpful? Yes No Submitting... Thank you

Comments