Event base event class

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

Hidden slots

The hidden slots are internal slots that must not 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 name	Slot display name	Type	Description	Hidden?
`_arrival_time`	Arrived	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_id`	Host ID	String	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
`_identifier`	ID	String	Unique ID of an event generated and stored internally.	No
`_modified_time`	Modified	Long (Epoch milliseconds)	Updated timestamp of the last modification of particular slots.	No
`_notes`	Notes	List of string	List of free text annotations (notes) added to the event.	Yes
`_operations`	Operation History	List of string	Internally updated based on event policies that were run.	Yes
`_repeat_count`	Repeated	Integer	Internal slot	No
`_tenant_id`	Organization ID	String	Tenant ID stored internally.	No
`_tenant_name`	Organization	String	Tenant name; same as the tenant ID.	No
`_unmapped_data`	Unmapped Data	Object	Holds 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
`alias`	Alias	List 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
`category`	Category	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
`class`	Class	String `Default=CUSTOM`	Class identifying the event.	No
`creation_time`	Occurred	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
`details`	Detailed Message	String	Detailed information about the event. Expands the information in the `msg` slot.	No
`msg`	Message	String	Event summary (text description) in brief	No
`priority`	Priority	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
`severity`	Severity	Enum (Severity) `Default=MINOR`	Severity value of the event. Possible values are: `UNKNOWN` `OK` `INFO` `WARNING` `MINOR` `MAJOR` `CRITICAL`	No
`location`	Location	String	Source of the event. The event source can be PATROL Agent or a third party event provider (event generated via the API).	No
`source_address`	Host Address	String	IP address of the event source. Used for looking up topology information in the equivalent field, __`all_ip_addrs` in BMC Helix Dynamic Service Modeling .	No
`source_hostname`	Host	String	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_port`	Source Port	Integer	Port of the event provider.	No
`source_identifier`	Source Identifier	String	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
`status`	Status	Enum `Default=OPEN`	Status value of the event. Possible values are: `OPEN` `ACK` `ASSIGNED` `CLOSED` `BLACKOUT`	No
`sub_category`	Monitor 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
`tags`	Tags	List of string	Represents a logical value to identify a group of events of a particular type.	No
`user_assigned`	Owner	String	Current user assigned to the event.	No
`lifecycle_time`	Lifecycle Time	Long	Internal slot	No
`_node_id`	Node ID	List of string	Internal slot Represents the list of host IDs present in BMC Helix Dynamic Service Modeling .	No
`_service_id`	Service ID	List of string	Internal slot Represents the list of service IDs present in BMC Helix Dynamic Service Modeling .	No
`_node_service_mapping`	Node Service Mapping	List of string	Internal slot Represents the list of node ID(s) associated with the service(s) in BMC Helix Dynamic Service Modeling .	No
`model`	Model	String	Internal slot	No
`incident_id`	Incident ID	String	Incident ID generated/associated with event	No
`incident_company`	Incident Company	String	Incident company, or the tenant name. Example `"incident_company": "Calbro Services"`	No
`componentalias`	Component Alias	String	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
`cdmclass`	CDM Class	String	The CMD class that is used for incident generation. Example `cdmclass = BMC_SoftwareServer`	No
`modelname`	Model Name	String	The model name that is used for incident generation. Example `modelname = Oracle Database server`	No
`instancename`	CMDB Instance Name	String	The Configuration Management Database (CMDB) instance name that is used for incident generation. Example `instancename = DB instance name`	No
`_errors`	Errors	List of string	Internal slot	No

Event base event class

Comments