Configuring event priority

Introduced in xMatters version 5.0, the xm_priority token, or predicate, allows you to set the priority level of an incoming event. This determines the order in which xMatters processes the event, and the default priority level of all notifications related to the event.

Note that the instructions in this section assume that you are using a default installation of xMatters; if you have customized your installation, you may need to adjust the described process accordingly.

Overview

To implement event and notification priority in your deployment, add the xm_priority token as a predicate to an Event Domain. The following steps explain how to add xm_priority to the messaging domain and the default Quick Message Panel.

To add priority to messages sent via the Quick Message Panel:
  1. Log in to the xMatters web user interface as a Company Administrator and click the Developer tab.
  2. On the Event Domains page, click messaging.
  3. On the Event Domain Details page, in the Predicates section, click Add New.
  4. On the Event Domain Predicates page, in the Predicate Name field, type xm_priority.
  5. Select the Important check box.
  6. In the Type drop-down list, select List.
    1. xMatters will display the List Values options.
  7. Add the following list values; for each entry, type the value in the New List Value field, and then click Add List Value:
    1. LOW
    2. MEDIUM
    3. HIGH
  8. Click Save.

The xm_priority predicate will now be added to the Quick Message Panel; click the Messaging tab to see the changes.

Whenever a User sends a message using the Quick Message Panel, they can set the priority of the message using the drop-down list. This priority setting will be used to determine the order in which xMatters processes the event, and also set the priority-level of the notifications that are sent to Users' Devices. For example, if an Administrator sends a message with a low priority to a User who has an email account with a Priority Threshold setting of Use for Medium and High Events, xMatters will not attempt to deliver the message to that Device.

Note that any messages sent without specifying an xm_priority value will default to MEDIUM priority.

Other Implementations

You can add priority to events and notifications for any Event Domain in the system by adding the xm_priority predicate as described above. You can further refine the behavior using the following options on the Event Domain Predicates page:

For more information about these options, see Defining Predicates.

Advanced Messaging

You can use the xm_priority setting with the xMatters Advanced Messaging feature by adding the predicate to the advanced_messaging Event Domain. After you have added the predicate to the Event Domain, add it as an appropriate predicate to the Message Domain on which the Scenarios are based to make it available in the Scenario details. For more information about the Advanced Messaging feature, see the xMatters User Guide.

Events from another source

You can also use a severity or priority setting within a management system to set the xm_priority value for an incoming event. When an event is sent to the integration agent to be injected into xMatters, whatever property the management system uses to denote priority can be mapped to a corresponding xm_priority level using Input Action Scripting. For more information about predicates in the integration agent, see the xMatters Integration Agent Guide.

The xm_priority token can also be used when creating an event via the AddEvent web service.

Setting a different Priority Threshold

You can separate the priority of notifications (used for the Priority Threshold setting) from the priority for an event by using the @notification::setDeviceThreshold method in the xMatters scripts. For example, if you had a Help Desk that was sending ticket information into xMatters, you might want to use the ticket severity as the priority for event processing, but change the Device notification priority based on the nature of the ticket.

For more information, see the xMatters Online Developer's Guide