Because RFL™ and Hubbell® have a policy of continuous product improvement, we reserve the right to change designs and specifications without notice.
Chapter 11 - Programming Data Alarms
SNMP Access Gateway User’s Manual - v1.0 -- 11/99 - Page 43
11.7 - Macro Section
Macros are similar to alarm formulas, in that they are designed to test conditions against an incoming record. Before
the evaluation of any alarm formulas, all defined macros are evaluated against the incoming record, resulting in a
TRUE or FALSE evaluation of each macro. Macro definitions which are referenced in alarm formulas then use the
TRUE or FALSE results of those tests to evaluate if an alarm has occurred. Macros eliminate the need to retest for
the same conditions more than once.
Macro definitions, if used, must be the second section in the definition text file. The macro definition section starts
with the definition header [macros]. After the macro definition header comes all the macro definitions. Up to 30
macros can be defined. The syntax for a macro definition is:
macroname = formula
The macroname is the name you want to use to reference this macro condition in later formulas. The formula is the
formula which defines the condition being tested for.
So, how are macros used? If you wanted several alarms which tested for a group of identical conditions, your
formulas might look like:
Alarm1_e=(ext=”103” OR ext=”107” OR ext=”111” OR ext=”114” OR ext=”116” OR
ext=”121” OR ext=”133” OR ext=”140” OR ext=”145” OR ext=”167”) AND
(localprefix=”976” or areacode=”900”)
Alarm2_e=( ext=”103” OR ext=”107” OR ext=”111” OR ext=”114” OR ext=”116” OR
ext=”121” OR ext=”133” OR ext=”140” OR ext=”145” OR ext=”167”) AND
duration>”00:00:10”
All the extensions tested for in the first alarm formula are retested in the second formula, resulting in duplicate
testing for the same conditions. By defining a macro, these extensions can be tested for once, and then the resulting
TRUE or FALSE condition can be referenced in your formulas without having to retest the record. For example:
[macros]
MyExtensions= ext=”103” OR ext=”107” OR ext=”111” OR ext=”114” OR ext=”116” OR
ext=”121” OR ext=”133” OR ext=”140” OR ext=”145” OR ext=”167”
[dataalarms]
Alarm1_e=MyExtensions=TRUE AND (localprefix=”976” or areacode=”900”)
Alarm2_e=MyExtensions=TRUE AND duration>”00:00:10”
Not only is this easier to type, its is much more efficient within the SNMP Access Gateway as the test for extensions
only has to be done once. The above data alarm formulas are not complete, see the next section.
11.8 - Data Alarm Section
Data Alarm definitions, if used, must follow the Macro section. The Data Alarm section of the alarm file starts with
the definition header [dataalarms]. After the definition header comes all the data alarm definitions. Up to 30 data
alarms can be defined. The syntax for a data alarm definition is:
alarmname = applicableports , threshold , actions, cleartime
alarmname_e = formula
To prevent alarm definitions from becoming too long, each data alarm is split into two lines. The first line of the
data alarm definition contain the following entries:
alarmname - This entry specifies the name of the alarm, whatever you want to call it. This name will be used as
part of the alarm action process to inform you what event you are being notified about.
applicableports - This entry specifies the I/O ports to which this data alarm will apply. Either or both of the 2
SNMP Access Gateway serial I/O ports can be can be listed here, for example:
To Next Page
Loading...