GSM Device Engines

GSM Device Engines enable xMatters to send notifications to and receive responses from service providers using an SMS protocol.

For most protocols, the connection is transient, and each notification contains the required provider information. GSM providers are different in that they require that connections are constantly established. In xMatters, this means that the provider configuration must be performed at the Device Engine level, rather than the Protocol Provider level.

GSM modem technical issues

There are some technical considerations when using a GSM modem:

GSM Modem Device Engine details

Detail

Description

Name

Name used to identify this Device Engine.

Description

Brief description of this Device Engine (optional).

Notification Polling (sec)

How often (in seconds) the Device Engine polls the notification node for new alerts. Must be a whole number greater than or equal to 10 and less than or equal to 300. (See related point in “GSM modem technical issues”, above.)

Logging

For an explanation of Device Engine logging, see Enabling Device Engine logging.

Session Timeout (min)

Length of time in minutes before the session times out. To have every session time out, enter ‘0’. To have sessions never time out, enter a negative value.

Carrier Wait Time

How long, in seconds, to wait for provider to prepare before commencing transmission of notifications.

Response Wait Time

How long, in seconds, to wait for a response from the provider.

Notification Key

String included in the body of the notification that identifies the original alert or notification to which the User is responding.

Normally this key is enclosed with delimiting characters; e.g., the default value, <%Notification Key%>.

If the delimiting character sequence is not guaranteed to be unique, the Device Engine may make an incorrect match, causing an exception and response failure.

If no delimiters are present, the first word of the response will be used as the notification key. If the delimiters occur more than once in the body of the notification, the first instance is used as the notification key.

Response Key

String included in the body of the notification that identifies the beginning of the response portion of the User’s return message.

Choice Message

Portion of the notification message that defines User options.

Response Message

Portion of the notification message that contains the response instructions.

If you have configured simple SMS replies, as described in Configuring simple SMS replies, this field should be changed to reflect the new response process. The recommended value is "Reply %Response Choices%".

Serial Devices

This area displays an editable list of serial device resources available to the GSM Modem Device Engine. Click Add New Device to create a new serial device, and specify the following settings:

  • Serial Port: Port to use to connect to the GSM modem (e.g., Windows: COM1, COM2, etc.; Unix: /dev/ttyS0, /dev/USB0, etc.)
  • Init String: Initialization string or code required for the GSM modem.
  • Baud Rate: GSM modem’s baud rate.
  • Databits: GSM modem’s databits setting.
  • Stop Bits: GSM modem’s stop bits setting.
  • Parity: GSM modem’s parity setting.
  • Flow Control: GSM modem’s flow control setting.
  • Sim Pin: If required, the personal identification number for the SIM card in the GSM modem.
  • Mode: Messaging mode supported by the GSM modem.
  • Polling Interval: How often, in seconds, the Device Engine polls the modem for responses to notifications. (See related point in “GSM modem technical issues”, above.)

To remove a serial device, select the check box next to the device you want to remove, and then click Remove Selected Devices.

Note: The Notification Key, Response Key, and Choice Message fields are not editable if SMS simple replies are enabled, as described in Configuring simple SMS replies.

Known Good Configurations

The following represent known good configurations for the indicated GSM modems. Settings marked "Deployment-specific" should be configured to reflect the needs of your deployment.

Note: These known good configurations are only meant to provide examples of working deployments; your deployment may require different configuration values.
Wavecom Fastrack GO

Setting

Configured Value

Name

(Deployment-specific)

Description

(Deployment-specific)

Notification Polling (sec)

10

Logging

(Deployment-specific)

Session Timeout (min)

-1

Carrier Wait Time

120

Response Wait Time

2

Notification Key

(Deployment-specific)

Response Key

(Deployment-specific)

Choice Message

(Deployment-specific)

Response Message

(Deployment-specific)

Serial Devices

  • Serial Port: COM3
  • Init String: AT
  • Baud Rate: 115200
  • Databits: 8
  • Stop Bits: 1
  • Parity: NONE
  • Flow Control: NONE
  • Sim Pin: <Empty>
  • Mode: ASCII
  • Polling Interval: 61