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.
xMatters supports the following protocols:
- BES - BlackBerry® Enterprise Server, used to send messages via BlackBerry mobile devices.
- DTMF - Dual Tone Multi-Frequency protocol, used for keypad signaling over a voice phone line.
- Generic - Generic protocol providers to enable integration between xMatters and proprietary or in-house protocols.
- GSM - Global System for Mobile Communications, used to send notifications via mobile phones.
- HTTP Conference - Protocol used to create conferencing sessions using a voice cloud provider other than xMatters.
- HTTP Generic - Protocol used to send SMS notifications via a cloud SMS provider other than xMatters.
- HTTP xMattersConference - Protocol used to create conferencing sessions using the xMatters voice cloud.
- HTTP xMatters SMS - Protocol used to send SMS notifications via thexMatters SMS cloud.
- Jabber - Instant messaging protocol, used to send instant messages via Jabber (one-way only).
- MAPI - Messaging Application Programming Interface, used to send email notifications via Microsoft Outlook.
- NOTES - Lotus Notes®/Domino® Protocol, used to send notifications via an IBM Lotus Domino server.
- PSTN - Public switched telephone network, used to make phone calls.
- SUCP - Universal Computer Protocol, used to send notifications via an Internet socket.
- PUCP - Universal Computer Protocol, used to send notifications via a serial port.
- SIP - Session Initiation Protocol, used to send notifications via SIP-enabled telephone sets and other voice-over-IP (VOIP) devices.
- SMPP - Short Message Peer-to-Peer protocol, used to transmit SMS messages on text-enabled mobile phones.
- SMTP - Simple Mail Transfer Protocol, the de facto standard for transmitting email over the Internet.
- SNPP - Simple Network Paging Protocol, used to send notifications to a pager over the Internet.
- TAP - Telelocator Alphanumeric Protocol, used to send pages or SMS messages via a serial modem.
- TAPL - TAP Leased, used to send pages or SMS messages using the TAP protocol and a dedicated or leased line.
- WCTP - Wireless Communication Transfer Protocol, used to send and receive responses over the network.
For details on configuring each Protocol Provider, see Protocol Providers.
Managing Protocol Providers
- Click the Admin tab.
- On the Administration menu, click Protocol Providers.
- xMatters displays a current list of Protocol Providers for the system.
- From the Protocol Providers list, do any of the following:
- 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.
- 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.
- 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:
- On the List Service Providers page, in the Current Service Providers table, click the name of the Service Provider you want to modify.
- 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.
- 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
- Maximum Message Length setting: 100 characters
- Message body length: 50 characters
- Appended text: 150 characters
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
- Maximum Message Length setting: 350 characters
- Message body length: 150 characters
- Appended text: 300 characters
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.