SMS/Text

AlertWorX allows you to configure SMS/Text notifications within the Workbench.

 

To Configure SMS/Text Notifications:

 

1. Start the Workbench, then expand your project. Next, expand the Alarms and Notifications node to show the AlertWorX node. Expand the AlertWorX node to show the Configurations node. Expand the Configurations node to show the SMS/Text node.

 

2. Right-click the SMS/Text node in the navigation tree and select Add SMS/Text Node, as shown in the figure below.

Add SMS/Text Node from the Project Explorer

 

-OR-

 

Select the SMS/Text node in the Project Explorer, then click on the Add SMS/Text Node button, shown below, in the Edit section of the Home ribbon in the Workbench.

 

Add SMS/Text Node Button

 

3. This opens the SMS/Text Node properties window, shown below, beneath the Project Details section in the Workbench. Enter a unique name in the Name text entry field.

 

SMS/Text Node Properties

 

SMS Settings

4. You can enter the Node name of the Alert SMS/Text Service in the text entry field. Next, enter the name of the modem in the Device text entry field. Next, enter the name of the modem in the Device text entry field. Provide the Pin in the text entry field to securely access the service. Click on the Baud Rate pulldown menu to select the modem communication rate (DEFAULT, INVALID, 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 56000, 57600, 64000, 115200, 128000, 230400, 256000, 460800, 921600). Enter the string to be sent to the modem containing modem initialization parameters in the Init String text entry field. Enter the destination of a Paging Debug File in the text entry field or click on the button to navigate to one within the file browser. Click the Use UA Points checkbox when Notification Message Fields are loaded as data points. If the Receive commands on this node checkbox is checked, this node will receive commands from the client.

 

5. If you have checked the Use UA Points checkbox in the Hardware and Data section, the Send and Status fields will be activated. In the Send text entry field, you can enter a data source that will transition from False to True to cause a message to be sent or click on the button to open the Data Browser and select that data source.

 

6. The Status field is also active only when the Use UA Points checkbox is checked. This field can be used to enter the status of the Sent message. You can also click on the button to open the Data Browser and select a data source to populate the Status field.

 

7. You can also click on the Test SMS  link on SMS Settings  tab to test the  settings. Note that you must have the Node, Subject, Message and To Address fields set correctly in order for the test message to work.

 

Send a test message Tab

 

SMS Message Settings Tab

SMS/Text Node - Message Settings Tab

 

Message Settings

Template can be configured when "Enable alarm subscription and send a message for every incoming alarm" option is checked.

 

8. In the Notification Message Settings section, click on the Template pulldown menu to select from existing templates or Do Not Use Templates.

NOTE: Any string/string block containing the colon character ':' or beginning with the @ character will be treated as a data point if the 'Use UA Points' option is enabled. To ensure correct AlertWorX template behavior:

In cases where:

...the system will use the base default value for that entry.

 

With the following configuration:

 

Use UA points = 1. Template Message:   @Some:BadPoint

 

...the Base Template string for Message will be used instead of the Template string.

 

9.  Enter a Subject in the text entry field or click on the "Click to edit expression" button to open the Expression Editor. You can then configure an expression that can populate the Subject field. You can configure an expression with the value from the alarm that triggered the message.

 

10.  Enter a Message in the text entry field. Similar to the Subject field, you can click on the "Click to edit expression button" link to open  and configure an expression that can populate the Message field.

Configuring Message Template

AlertWorX allows you to configure Message template within the Workbench.

 

To Configure Message Template:

  1. Start the Workbench, then expand your project. Next, expand the Alarms and Notifications node to show the AlertWorX node. Expand the AlertWorX node to show the Message Templates node. Right-click on it and select Edit.

  2. Right-click the Message Template node in the navigation tree and select Edit, as shown in the figure below.


Message Template Node - Edit dialog

 

  1. This opens the Message Templates Node properties window, shown below.

    Message Templates Node Properties window


  2. Click on Click here to add new item and enter a unique Name, Subject and the text of a message:

 

Message Templates Node Properties window

 

Alarm Template

 

Name - The unique name of the template. It can be used to identify the template.

Subject - Enter a subject in the text entry field. "Click to edit expression" link opens the Expression Editor window, which can help in constructing required expressions.

Message - Enter a message in the text entry field. "Click to edit expression" link opens the Expression Editor window, which can help in constructing required expressions.

 

Alarms Subscription Tab

SMS/Text Node - Alarms Subscription Tab

 

11. In the Alarm Subscriptions tab, click on + Click here to add new item. This allows you to enter a Tag name in the text entry field or click on the to open the Data Browser and navigate to your selected tag. You can then enter Min. Severity and Max. Severity in the next fields. Click on the field under the Alarm Type column and it will turn into a pulldown menu, where you can select from None, Simple, Tracking, Condition, Simple & Tracking, Simple & Condition, Tracking & Condition or All.

 

12. Once you have completed the setting of the SMS/Text Node properties, click on the Apply button. The new SMS/Text Node will now appear in the Project Explorer.

 

See Also:

About AlertWorX

Email

ATT Configurations

Twilio Configurations

Setting Up Twilio

Setting Up Vonage