The purpose of the messaging form is to provide a means to create and send a message into the xMatters system. The contents of the form will be posted to a URL that is processed on the server side and injected into the xMatters system.
The message details consist of the following information:
Form Area | Detail | Description |
---|---|---|
Message | Message Subject Fields | A text input field that specifies a part of the message subject. These input elements should be identified by combining the “APPEND_SUBJECT_” prefix with some unique name. You can specify any number of subject fields and they will be concatenated together within the message. |
Message Text |
A single text area input field that specifies the entire message body content. This input element should be identified by “messageText”. |
|
Message Body Fields |
A text area input or text field that specifies a part of the message body content. These input elements should be identified by combining the “APPEND_MESSAGE_” prefix with some unique name. You can specify any number of message fields and they will be concatenated together within the message body content. |
|
Predicate Delimiter |
A text predicate can be used to submit a delimited list of values. The delimiter can be specified for each predicate by using the "PREDICATE_DELIMITER_" prefix. This prefix is combined with the predicate name and should contain the value of the delimiter; for example: Predicate: Event Value: fire,flood Delimiter: ,
The input can be a hidden field, as shown here: <input type="hidden" name="predicate_delimiter_event" value="," /> |
|
Event Domain Predicates |
The list of predicates the user can apply a value against for this message. These predicates are supplied as key/value pairs within the message. The name of the predicate should be used as a label to indicate to the user what predicate they are providing information about. There are two types of predicates:
Despite the type of predicate, this input field should be identified combining the “PREDICATE_VALUE_” prefix with the predicate name. Using any other unique identifier will have the same effect as not having the inputs at all. |
|
Recipients | Favorites List |
A selection list of available recipients that the logged in user has recently used or view. This input field is identified by “favorites”. |
Delivery | Device Type Overrides |
A check box for each device type that the user can select for the message delivery. These input elements are identified by combining the prefix “useDeviceFilter” with one of the following names: “All”, “Email”, “Text”, “Voice”, or “IM”. |
Handling | Override Device Restrictions | A check box that the user can select to ignore all Device delays, timeframes, and event priority settings. This input element should be identified by "overrideDeviceRestrictions". |
Outbound Only | A check box that the user can select to remove al response choices from the message, making it a one-way notification. This input element should be identified by "outboundOnly". | |
Bypass Outbound Phone Password | A check box that the user can select so the message does not ask for a password when delivered to a Voice Device, but instead plays the notification message to whoever answers the phone (provided it is not a machine). This input element should be identified by "bypassOutboundAuthentication". | |
Scheduled Messaging | Schedule Message | A check box that the user can select to view and specify the Schedule Message details. These input elements should be identified by |