SMS/Text

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

To Configure SMS/Text Notifications:

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.
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

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 Tab

SMS/Text - SMS Settings Tab

Hardware and Data

In the Hardware and Data section, 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. 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. Click on Only Use Targeted Alarms if flagged alarms are to be used. Alarms are flagged by adding flags to alarms in the alarm server. If the Receive commands on this node checkbox is checked, this node will receive commands from the client.

Notification Message

In the Notification Message section, click on the Template pulldown menu to select from existing templates or Do Not Use Templates. You can also add (+) or delete (-) existing templates. Added templates will appear in the Project Explorer beneath the SMS/Text node. If you have created a template, you can give it a name in the Template Name text entry field.

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:

Check if the template exists.
If the template exists, use template values for all entries != NULL
If the entry for the template == NULL, use the base default value for those entries.

In cases where:

the template contains a data point, and
the 'Use UA Points' option is checked, and
the point resolves to NULL (bad point)...

...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.

Enter a Template Subject in the text entry field or click on the button to open the Data Browser. You can then select a data source that can populate the Subject field.
Enter a Template Message in the text entry field. Similar to the Subject field, you can click on the (Browse Tags) link to open the Data Browser and select a data source that can populate the Message field. Clicking on the (Add alarm field) link brings up the Select a Field dialog, where you can create subject and message configurations that will replace the field name with the value from the alarm that triggered the message. For instance, an example string can be:
Alarm: {SourceNameBaseEventType} reported: {MessageBaseEventType}

You can also click on the (Send Test Message) link to test the hardware settings. Note that you must have the Node, Subject, Message and To Address fields set correctly in order for the test message to work.
Enter your intended address in the To Address text entry field or click on the button to open the Data Browser. You can then select a data source that can populate the To Address field.
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.
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.

Alarms Subscription Tab

SMS/Text - Alarms Subscription Tab

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.
Once you have completed setting the SMS/Text Node properties, click on the Apply button. The new SMS/Text Node will now appear in the Project Explorer.