Protocol Providers

Protocol Providers define how xMatters accesses servers for outgoing notifications. While User Service Providers restrict protocol selection at the Company level, the Super Administrator can configure Protocol Providers that are available throughout xMatters.

Supported protocols

xMatters supports the following industry-standard protocols:

DTMF, PSTN, and SIP

These are two-way protocols, used mainly for making and receiving voice calls, or interfacing with public address systems:

Jabber

This is a one-way instant messaging platform, used to send messages to desktop computers, or to mobile Devices using apps (e.g., Bejive on the iPhone).

HTTP Protocols

These protocols are used to send notifications or create conferencing sessions over a cloud-computing provider:

MAPI, Notes, and SMTP

These providers are used for two-way email message communications to any desktop computer or email-capable hand-held Device:

These protocols are not recommended for sending SMS messages to mobile phones as there is no guarantee that the message will ever arrive on the intended Device. In the event that the message does arrive, it will usually result in a one-way message where no response is ever returned to xMatters. No tracking information is returned to xMatters during the notification process, and a succession of email servers can be involved in each transmission.

BES

The BlackBerry® Enterprise Server protocol can send two-way text messages to BlackBerry Devices as "Level 1" messages. These are not considered SMS or email messages; they are BES-specific messages that can be encrypted, have a different ring tone or vibrate setting, and be replied to on the target Device.

SUCP and PUCP

These older, text-based protocols are less common, and typically used with pagers:

GSM

The Global System for Mobile Communications two-way protocol requires that xMatters have a GSM modem attached (this can be as simple as a mobile phone with a SIM card built into a small box with an antenna). This allows xMatters to send and receive text messages just as a User would from a mobile phone.

SMPP, SNPP, and WCTP

These protocols are the latest two-way network-based protocols for use with pagers and SMS text providers:

These protocols are recommended as the first protocols to use when xMatters is communicating with text Devices as they provide a receipt ID for each notification and, if the provider supports two-way notifications, xMatters can check for responses from the target User on their Device.

Some providers also provide xMatters with additional information, such as read receipt information that can be logged when the User reads the message on the Device, even if they do not respond.

TAP and TAPL

These one-way protocols are older, but can still provide a redundant option to get a text message out to an SMS phone or pager:

Even when a network is down, these protocols may still work because they use modems and analog phone lines. The message displayed on the target Device can also include the call-in number for xMatters, so the User can call in and then perform actions via two-way voice communication.

Other options

Another option when configuring protocols is to use an SMS text message aggregator company. xMatters can communicate with these companies via a two-way protocol (typically SMPP/SNPP/WCTP) and will guarantee delivery of the text message to a target mobile phone; in most cases, the aggregator will also handle all responses back into xMatters. These aggregators charge for this service, but will provide service-level agreements for the message delivery and response.

Any combination of the above protocols can be used with xMatters, and for each Service Provider, the Administrator can define the preferred order of the protocols. xMatters will attempt to send the message out using the first protocol; if it fails, the attempt is logged and xMatters moves on to the next protocol. The key to configuring xMatters for your text message service providers is to find out what protocols they support, and to implement as many of them as possible so that you have redundancy in place.

For details on configuring each Protocol Provider, see Protocol Providers.

Managing Protocol Providers

  1. Click the Admin tab.
  2. On the Administration menu, click Protocol Providers.
    1. xMatters displays a current list of Protocol Providers for the system.
  1. From the Protocol Providers list, do any of the following:
    1. To modify an existing Protocol Provider, click its name in the list to view its details. For more information, see Defining Protocol Provider Details below.
    2. To remove a Protocol Provider from the list, select the check box next to the Protocol Provider or Providers you want to remove, and then click Remove Selected.
    3. To add a new Protocol Provider, click the Add New link, click the Provider of Type drop-down list and select a Provider Type, and then specify the Protocol Details. For settings details for each provider type, see Setting Maximum Session Size, below.

Defining Protocol Provider Details

You can define the details for each Protocol Provider using the Protocol Provider Details page.

To modify Protocol Provider details:
  1. On the List Service Providers page, in the Current Service Providers table, click the name of the Service Provider you want to modify.
    1. If you are creating a new Protocol Provider, xMatters displays the Select Your Protocol Providers page. In the Available Protocol Providers box, select the Protocol Providers you want to add to the User Service Provider, and then click Add. To save your work and return to the User Service Providers list, click Save.
  2. Click Save.

Setting Maximum Session Size

You can help optimize the throughput of your xMatters node deployment by adjusting the maximum session size for Protocol Providers.

The session size represents the number of notifications transacted within a single session. For example, if you set the maximum session size of an email Protocol Provider to 20, and there are at least 20 notifications to dispatch, the Device Engine connects to the email server, sends 20 notifications, and then disconnects.

To tune the performance of Protocol Providers, ensure that the session size is as large as possible for each Protocol Provider in use. For email providers in particular, a session size of 20 to 50 is recommended.

Setting Maximum Message Length

Protocol Providers that support text messages include a Maximum Message Length setting. This setting specifies the maximum number of characters in a single notification the Protocol Provider will handle before truncating the remaining text.

There are two separate portions to the message text: the message body and the appended text. The message body is the actual notification content and the appended text contains the notification key, response choices, etc.

If the Maximum Message Length setting is less than the total number of characters in the appended text portion of the message, the recipient will not be able to reply to the notification. In effect, the notification becomes one-way. Consider the following examples:

Example One

In this case, the appended text is discarded because it exceeds the Maximim message length setting. The User will receive the entire message body of the notification because it is less than the Maximum message length, but will be unable to reply because the appended text portion of the notification is missing.

Example Two

In this case, the entire appended text portion of the notification will be included, but the message body will be truncated to 50 characters. The User will receive the notification and will be able to reply because the entire appended text portion was included in the notification.