Event - Global

The Event API provides methods that enable the setting and getting of values within an event.

These events are sent from a MID Server to a ServiceNow instance. Before you are able to successfully send events, the connection between the MID Server and the ServiceNow instance must be defined.

Use the Event API to add/update fields within an event. Use the SNEventSenderProvider API to instantiate an event sender object. Then use the IEventSender API to send the event to a ServiceNow instance.

You must activate the Event Management (com.glideapp.itom.snac) plugin before attempting to access this API. The Event Management plugin requires a separate subscription and must be activated. This plugin includes demo data and activates related plugins if they are not already active.

For additional information on event management, see Event Management.

Event - Event()

Instantiates an Event constructor.

Tableau 1. Parameters

Name	Type	Description
None

var event = new Event();
var esource = event.getField("source");
var eseverity = event.getField("severity");       

Event - getField(String field)

Returns the current value of the passed in event management field.

Tableau 2. Parameters

Name	Type	Description
field	String	Name of the event management field value to return.

Tableau 3. Returns

Type	Description
String	Value of the requested event management field.

var event = new Event();
var eventSource = event.getField("source");
var eventSeverity = event.getField("severity");       

Event - setAdditionalInfo(String additionalInfo)

Replaces the existing additional_info field in the associated event with the passed in JSON string.

Remarque :

You can use the setField() method to update a specific field within the additional_info field.

Tableau 4. Parameters

Name	Type	Description
additionalInfo	String	JSON String (key/value pairs) to save in the additional_info field. Remarque : This parameter replaces the existing information. It does not update the existing fields.

Tableau 5. Returns

Type	Description
void

event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

Event - setField(String key, String value)

Sets the specified field in the associated event.

If the passed in key matches a predefined event field, the method updates the corresponding event field. Otherwise, the method adds the key parameter to the additional_info section of the event before applying the passed in value.

The following are the predefined event fields that you can modify using this method:

Field	Description
additional_info	Key-value pair to add to the additional_info field of the associated event. If the passed in key already exists, its value is overwritten. Maximum length: 4,000 characters Associated UI field: Additional information
ci_identifier	JSON string that uniquely identifies a configuration item. For example, {"name":"SAP ORA01","type":"Oracle"}. Maximum length: 1,000 characters
cmdb_ci	Sys_id of the Configuration Item [cmdb_ci] record to bind the event to. Default: Null
description	Free-form description of the event. Maximum length: 4,000 characters Associated UI field: Description Default: Null
event_class	Enterprise Message Service (EMS) that generated the event. For example, "Solarwinds" or "SCOM". Maximum length: 100 Associated UI field: Source instance Default: Null
message_key	Unique event identifier. To override an existing event severity, use the same message_key value. Maximum length: 1024 characters Associated UI field: Message key Default: Combination of source, node, type, resource, and metric name.
resolution_state	Event resolution state. Valid values: New: Resolution state for the corresponding event is open. Closing: Resolution state for corresponding event is closing/closed. Associated UI field: Resolution state Default: New
resource	Node resource to associate with the event. For example, "Disk C:", "CPI-1", or the name of a process or service. Maximum length: 100 characters Associated UI field: Resource
severity	Event severity. Valid values: 0: Clear - No action is required. An alert is not created from this event. Existing alerts are closed. 1: Ok - An alert is created. The resource is still functional. 2: Warning - Attention is required, even though the resource is still functional. 3: Minor - Partial, non-critical loss of functionality or performance degradation occurred. 4: Major - Major functionality is severely impaired or performance has degraded. 5: Critical - Immediate action is required. The resource is either not functional or critical problems are imminent. Associated UI field: Severity Default: Null
source	Instance of the EMS that triggered the event. Typically the connector instance name. Maximum length: 200 characters Associated UI field: Source Default: Null
time_of_event	UTC time that the event occurred in the source system. Format: "yyyy-MM-dd HH:mm:ss" Maximum length: 40 characters Associated UI field: Time of event Default: Current date/time
type	Metric type to which the event is related, such as Disk or CPU. This value is used to identify an event record from which alerts are created. Maximum length: 100 characters Associated UI field: Type Default: Null

Remarque :

You can also use the setText() method to update the description field and the setTimeOfEvent() method to update the event time.

For additional information on events, see Event Management.

Tableau 6. Parameters

Name	Type	Description
key	String	Name of the key to add or update in the event. For additional information on the predefined event fields, see Event field format for event collection.
value	String	Information to store in the associated event field. Remarque : The value string is trimmed before it is stored, whereby multiple spaces are replaced with a single space.

Tableau 7. Returns

Type	Description
void

var event = new Event();
event.setField("source","SAP Solman");
event.setField("severity","3");
event.setField("time_of_event", "2019-18-05 13:12:05");
event.setField("type", "SAP object");
event.setField("user", "admin"); // parameter will be added to additional_info section       

Event - setText(String text)

Sets the description field of the associated event to the passed in value.

Remarque :

You can also use the Event - setField(String key, String value) method to set the text field in the current event. Unlike the setField() method, this method does not trim the passed in text.

Tableau 8. Parameters

Name	Type	Description
text	String	Text to store in the description field of the associated event. Max length: 4000 characters

Tableau 9. Returns

Type	Description
void

var event = new Event();
event.setText("SAP Solman");       

Event - setTimeOfEvent(String timeOfEvent)

Sets the time_of_event field in the associated event to the passed in UTC time value.

Remarque :

You can also use the Event - setField(String key, String value) method to set the time_of_event field.

Tableau 10. Parameters

Name	Type	Description
timeOfEvent	String	UTC time value to set in the time_of_event field. Format: "yyyy-MM-dd HH:mm:ss" Max length: 40 characters

Tableau 11. Returns

Type	Description
void

var event = new Event();
event.setTimeOfEvent("2019-18-05 13:12:05");