With the implementation of the
Since
When alarms are received,
Note
The
An alarm condition prompts the ION module (for example, Setpoint module) to send a pulse signal to the Trigger input of the
The Alert module initiates modem communication, and calls the phone number specified in the Alert module’s Destination setup register.
The
The new connection request is received and placed in the queue. If other connection requests to the same site already exist, the new request is merged with the others.
Note
Note
This section is intended for advanced users. Contact
The configuration settings for
Use a text editor or XML authoring tool to create and edit the configuration file. Remember to rename the config file to match the machine name (for example, if the primary server is named “ComputerOne”, rename the config file to “ComputerOne.AlertMonitor.config”).
Channels define the communication port and modem that the
A Channel contains the modem definition and configuration settings for the port.
The following table lists the attributes you can assign for a Channel:
|
Channel attribute |
Description |
|
Name |
Name of the communications port the modem is connected to. The default value is COM1. |
|
ModemType |
The type of modem. The value entered here must exactly match the displayed value under “Modem Type” property in the “Dial Out Modem Options” dialog. |
|
BaudRate |
The modem’s baud rate. The default value is 9600. |
|
AlertMonitorNodeName |
The node name, as it appears in the system log messages. The text specified here defines the value for the %a command parameter (described below). The default value is AlertMonitor.[ComputerName] |
|
NoLog |
This controls whether all alarms are logged to the product's system log. The default value is “YES” (log all alarms). A value of “NO” disables all alarm logging. |
|
NumTries |
This specifies how many times a connection attempt should be retried if there are communication errors. |
Tip
Open the example file “{MachineName}.AlertMonitor.config” in a text editor program and refer to it when reading this section to see the proper usage of the elements and attributes in the
Actions are grouped inside ActionSet elements, which contain connection requests and/or commands to execute when alarms are received. Specify “ConnectionRequest” to set up an ActionSet to send a connection request; specify “Command” to set up an ActionSet to execute an operating system command when the alert is received. You can specify attributes for ActionSets:
If the Channel attribute is used in the ActionSet (for example, <ActionSet Channel="COM1">), then the actions (commands) listed in the ActionSet are executed for all alarms coming through the communications port and modem specified for that Channel (that is, “COM1”).
If the Location attribute is used in the ActionSet, then the actions (commands) listed in the ActionSet are executed for all alarms originating from the specified Location (regardless of Channel).
If no attribute is specified, then the actions (commands) listed in the ActionSet are executed for all alarms originating from any communication port or location.
If there are two ActionSets (one specifying a Channel attribute, the other specifying Location attribute), then the one that specifies the Location attribute takes priority.
Note
The value of the “Location” attribute is specified in the Location setup register of the Alert module for the meter that is sending the alert. For details, refer to the Alert Module description in the ION Reference.
Commands (i.e., command lines that run separate applications such as “net send”) contained in the ActionSet can include parameters that return data values, as described in the following table:
|
Command Parameter |
Description |
|
%U |
Universal time: seconds since January 1, 1970 |
|
%u |
Universal time: YYYY-MM-DD HH:MM:SS.FFF |
|
%T |
Local time: seconds since January 1, 1970 |
|
%t |
Local time: YYYY-MM-DD HH:MM:SS.FFF |
|
%n |
Node name (for example, device name) |
|
%g |
Gate name (for example, site name) |
|
%p |
Priority name |
|
%P |
Priority number |
|
%m |
Alarm message without delimiters |
|
%M |
Alarm message with “ “ delimiters |
|
%a |
The value of the AlertMonitorNodeName attribute. If this attribute is not used, the default value is “AlertMonitor.[ComputerName]”. |
The “ConnectionRequest” element contained in the ActionSet has attributes that you can define, as described in the following table:
|
ConnectionRequest Attribute |
Description |
|
MaxConnectTimeSeconds |
Maximum time (in seconds) a connection to the site is maintained. The default value is 300 seconds. |
|
MinConnectTimeSeconds |
Minimum time (in seconds) a connection to the site is maintained. The default value is 60 seconds. |
|
RequestLifetimeHours |
Defines how many hours a connection request remains valid before it is discarded (even if attempts to connect to the site are unsuccessful). The default value is 0. |
|
RequestPriority |
Priority of the connection request, which ranges from 0 to 2000. The highest priority is 2000. The default value is 1999. |
|
DisconnectOnCaughtUp |
This specifies to automatically disconnect from the site after |
|
Device |
This explicitly defines which specific device to connect to in the site. This attribute overrides data contained in the alarm message. |
|
Site |
This explicitly defines which site to connect to. This attribute overrides data contained in the alarm message. |
It is possible to run the
For example, the
Diagnostic and error messages are logged in the
By default, the