Messaging API

The Messaging API is used to develop custom messaging panels that allow users to inject messages into xMatters. Specifically, the Messaging API provides the means of selecting the information needed for message creation of a message, and for submitting a message into the xMatters system.

Default Messaging Panel

You can view an example of the Messaging API results in the Quick Message JSP in the xMatters installation directory, under webserver/webapps/cocoon/alarmpoint/jsp/custom. The file name is CustomMessagingPanel1.jsp.

The JSP content of the default panel is very simple, and illustrates how to use some of the custom XML markup specific to messaging.

If you modify an existing JSP file, the changes will not be reflected in the web user interface until you restart the web server or clear the working cache as explained in Clearing the Working Cache.

Scheduled messages recovery mechanism

If the xMatters Node is shut down when a scheduled message is due to be sent, the message is automatically stored for up to 30 minutes. If the Node is started during this 30-minute period, xMatters automatically sends the message; otherwise, the message is discarded.

Custom Messaging XML Tags

Messaging Form Data

Using the Messaging JavaBean

Custom Subscription and Messaging Panels