Defining Predicates

You can define the list of predicates for each Event Domain independently, and edit or add predicates at any time. Note that if you are defining predicates for use with Scenarios (e.g., adding to the "advanced_messaging" domain), you will also need to add the predicates to the related Message Domain (as described in Defining Message Domain Details), after you have added them to the Event Domain.

To add predicates to an Event Domain:
  1. Enter the following information into the form:

Detail

Description

Predicate Name

Name of the predicate, as displayed in Event Domain details and on Subscription panels.

Important

Specifies whether the predicate’s value should be displayed in Event Reports.

An Event Report displays the first three predicates flagged as Important in each Event Domain as Detail 1, Detail 2, and Detail 3. The order in which the predicates are listed on the Event Domain details page determines their position in the Report.

For example, if an Event Domain contains ten predicates, and numbers two, five, and eight are flagged as important, then the value for Predicate Two is included in the Event Details Report as Detail 1, Predicate Five’s value is included as Detail 2, and Predicate Eight’s value is included as Detail 3.

If more than three predicates are flagged as Important, only the first three are included in the Report.

Required

When selected, any injected event that does not contain this predicte will be rejected by the system, and no notifications will be sent. xMatters will also sent out a Health Monitor message about the failure; for details about the failure, review the Exhaustive Report for the event.

Note: This feature is still in Beta release.

Validate

When this option is selected, the system will compare each incoming predicate against either a specified pattern for text predicates or the list entries for list predicates.

If the predicate value does not match the pattern, or if a list item does not match one of the specified list values, the event will be rejected and no notifications will be sent. xMatters will also sent out a Health Monitor message about the failure; for details about the failure, review the Exhaustive Report for the event.

To set the validation criteria for text predicates, specify the following settings:

  • Pattern Library: specifies a common input type against which the predicate value should be compared.
  • Pattern: specifies the Java regular expression to compare against the incoming predicate value.

For a list of the available pattern libraries and their default patterns, see the "Validation Patterns" section, below. You can also select a pattern library and then modify the regular expression for custom behavior.

Note: This feature is still in Beta release.

Type

Select one of the following options:

  • Text: allows Users to specify operators to match values.
  • List: presents a predefined set of values from which Users can select one or more values. To add a list value, type the value you want to add in the New List Value field and then click Add List Value. To remove a value from the list, select the values you want to remove, and then click Remove Selected List Values.

Note that you cannot change the predicate’s type after it has been created; you must delete the predicate and create it again.

  1. Click Save.

Validation Patterns

The following table lists the available pattern libraries and the default regular expression for the Validate feature. Note that you can also select a pattern library and then modify the pattern using Java regular expression syntax for custom behavior.

Pattern library options
Pattern Name Default Value
Letters only [A-Z,a-z]*
Numbers only \d*
5 Numbers only \d{5}
Basic Decimal number [-\+]?\d+\.?\d
Basic IP Address (no range checking) \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
Generic date time \d{1,4}/\d{1,2}/\d{1,4} \d{1,2}:\d{2}(:\d{2}) (AM|PM)?
ISO Date time (ISO 8601) \d{4}\-\d{2}\-\d{2}T\d{2}:\d{2}(:\d{2})?(Z)?
Boolean (case-insensitive) (?i:true|false|yes|no)
String 10 characters or shorter .{0,10}
Other - Manual