Creating and Configuring External SMS Gateway Provider Device

Scenario: You want to configure the External SMS Gateway Provider.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • System Manager is in Engineering mode.
  • System Browser is in Management View.

 

Steps:

1 – Create and Start a External SMS Gateway Provider Driver
  1. Depending on where to add the driver, select one of the following:
  • Project > Management System > Servers > Main Server > Drivers
  • Project > Management System > FEPs > [FEP Station] > Drivers
  1. In the Object Configurator tab, click New and select New External SMS Gateway Provider Driver.
  1. In the New Object dialog box enter a unique name and description.
  1. Click OK.
  • The External SMS Gateway Provider Driver node displays in System Browser below the Drivers node and is selected.
    NOTE: The description must be different from that of any other driver on the server or FEP stations. A single driver can be used for multiple devices.
  1. In the Operation tab, navigate to the Driver Status property and click Start.
  • The External SMS Gateway Provider Driver is created and started.

 

2 – Configure a External SMS Gateway Provider Driver
  1. In the System Browser, select External SMS Gateway Provider Driver and click the Driver Editor tab.
  1. (Optional) In the Driver Settings expander, modify the description.
  1. In the Configuration Properties expander, do the following:
  • In the Device Request Timeout field, enter 10000 (value in milliseconds).
  • In the Check Status Rate field, enter 30000 (value in milliseconds).
  • In the Default Country Code field, enter the country code of the country the Notification application is installed in.
  • In the International Prefix field, enter the prefix that must be dialed before the country code when manually dialing an international number from the country the Notification application is installed in (for example, 011 in the USA, 00 in Germany).
  • In the Remove Leading Zero From National Number check box if the Notification application is installed in a country whose national telephone numbers have leading zeros in their area codes that need to be removed when dialed as an international number (for example, in Germany, 089xxxxxx becomes +49-89xxxxxx).
  1. In the Notification Integration expander, do the following:
  • Set the Batch Size field value as 10 (default is 100). Batch size specifies the size in which the request is processed by the driver. The batch size displays the number of devices to which Notification interacts in one instant. For example, if there are 100 devices on which a message has to be displayed and a batch size of 10 is entered, Notification will send the message to batches of 10 devices each.
  • Enter a value in the Expected delivery time field (default is 10 seconds).
    NOTE :Notification does not guarantee the message delivery will be completed within the time entered here. This value is solely used to compute delivery statistics indicating whether message delivery to the External SMS Gateway Provider server was on-time or late.
    On-time or late displays based on the time taken for Notification to deliver the message to the External SMS Gateway Provider server and not the time taken to deliver the message to the actual recipient.
  1. Click Save .
  • The parameters are configured for the External SMS Gateway Provider driver.

 

3 – Create External SMS Gateway Provider Field Network
  1. Select Project > Field Networks.
  • The Object Configurator tab displays in the Primary pane.
  1. Click New and select New External SMS Gateway Provider Field Network.
  1. In the New Object dialog box, enter a name and description.
  1. Click OK.
  • The External SMS Gateway Provider Field Network node appears in the Field Networks hierarchy.
  • The External SMS Gateway Provider driver is automatically associated to the field network. In the Network Editor tab, under the Network Settings expander, you can see that the values are preselected, and the driver is already assigned.

 

4 – Create External SMS Gateway Provider Device
  1. Navigate to Project > Field Networks > External SMS Gateway Provider Field Network.
  1. Click the Network Editor tab.
  1. Click Create .
  • In the New object dialog box, enter a Name and Description.
  • Click OK.
  1. In the Device Editor tab that displays, proceed as follows.
  1. In the Device Settings expander, enter a Description for the device
  1. Enter the Configuration Properties parameters as detailed in Configuration Properties for SMS Gateway Device.
  1. Enter the values for the fields in Routing Configuration as listed in the Routing Configuration.
  1. Click Save .
  • The user device type is automatically configured. In the Recipient Editor tab, under the User Device Types expander, you can see that the SMS Gateway Driver is set as the handling driver and modality is set as SMS.

 

 

5 – Configure Recipient User Devices
  • You have added one or more users as Recipient Users
  1. In the Recipient User Devices dialog box, from the Type drop-down list, select Personal Mobile Phone or Work Mobile Phone as a recipient device.
  1. Select the Recipient User Devices section.
  1. From the Type drop-down list, select Personal Mobile Phone or Work Mobile Phone
  1. In the Address field, enter the mobile number.
  1. From the Preferred Delivery Method drop-down list, select SMS.
    NOTE: The following telephone number formats are supported:
  • International number format with + and country code (for example, +1-123-4567890 in the USA, +49-12-345678 in Germany)
  • International number as dialed, with international prefix and country code (for example, 011-49-12-345678 in the USA, 00-1-123-4567890 in Germany)
  • National number format (for example, 123-456-7890 in the US, 012-345678 in Germany)
  1. Set up a message and incident template with these users as recipients.
  1. Initiate incidents.
  • Recipients in the message template will receive an SMS message with the content as described in the corresponding message template.