Custom Messaging Panels
You can use the xMatters Messaging API to develop custom messaging panels that allow Users to inject messages into xMatters. The out-of-the-box Quick Message panel in the xMatters web user interface is an example of the Messaging API output.
- To view this example in the xMatters web user interface, log in as an xMatters Administrator, and click the Messaging tab. xMatters displays the default Quick Message panel (if deployed).
The xMatters Online Developer's Guide includes detailed instructions for using the Messaging API to create custom messaging panels. The following steps explain how to add the panels to the xMatters web user interface so that Users can access them.
To view and manage custom messaging panels:
- Do one of the following:
- To modify an existing panel, click its name in the Custom Messaging Panels list to view its details. For more information, see Defining Custom Messaging Panel Details.
- To remove an existing panel from xMatters, select the check boxes for the panels you want to delete, and then click Remove Selected. Note that you must have at least one messaging panel configured; you cannot remove all messaging panels from xMatters.
- To change the order in which panels are listed, click Reorder. On the Order Messaging Panels page, select a panel in the list box and then use the buttons to reorganize the list. When you are finished, click Save to return to the Messaging Panels page. For more information about reordering messaging panels, see the following section, "Changing the Default Messaging Panel".
- To create a new custom messaging panel, click the Add New link, and then specify the Event Domain you want to associate with the new panel by selecting an Event Domain from the drop-down list. Click Continue, and then specify the custom messaging panel details. Click Save, and then specify the Roles you want to have access to the new panel. Click Save to create the panel and return to the Custom Messaging Panels page.
Changing the Default Messaging Panel
When Users click the Messaging tab in a default xMatters deployment, xMatters displays the Quick Message panel. You can change this behavior in xMatters On Demand by reordering the list of panels on the Messaging Panels page.
Whenever a User clicks the Messaging tab (or clicks the Send a Message option available in the Common Tasks menu), xMatters directs them to the first messaging panel listed on the Messaging Panels page. If you reorder the panels so that a custom messaging panel is the first one in the list, or remove the other messaging panels from your deployment so that your custom messaging panel is the only one remaining, then Users will automatically be directed to that panel whenever they send a message.