FilterMaskedAlm
- Last UpdatedJul 05, 2024
- 2 minute read
The function of this Business Logic Tier (BLT) is similar to filterAlm (to return filtered alarm summary data) but with two added parameters. In order to see Test Mode alarms in the easy eXtended Operator Station (ezXOS), FilterMaskedAlm must be used.
Syntax
FilterMaskedAlm <skip> <almFilter> <ackFilter> <filterMask> <filterValue> <dbname> <ptname> <field <{field]>
|
Property Type |
Property Description |
|---|---|
|
skip |
The number of matching alarms to skip before returning data. |
|
almFilter |
If this is shown as yes, filteralm returns data that are in the alarm. If this is shown as no, filteralm returns data that are not in the alarm. If this is shown as both, filteralm returns both data that either are or are not alarm. |
|
ackFilter |
If this is shown as yes, filteralm returns unacknowledged alarms. If this is shown as no, filteralm returns acknowledged alarms. If this is shown as both, filteralm returns both acknowledged and unacknowledged alarms. |
|
filterMask |
Allows you to specify which filter by using 0 for no filter and 1 test mode filtering. |
|
filterValue |
Allows you to specify the values of the filters by using 0 to hide test mode alarms, and 1 to see test mode alarms. |
|
dbname |
The table that generated the alarm. |
|
ptname |
The point on the table that generated the alarm. |
|
field |
One or more field names from the almsum table. The values of these fields are returned in addition to the foreground color integer (fgint), the flashing status, and the severity (sevint) of the alarm. |
Comments
Note: Best practice is to use filterMaskedAlm instead of filterAlm.
Example
Filter application results
|
filterMask |
filterValue |
Expectation |
|---|---|---|
|
0 |
0 |
No filtering is active; all alarms are shown. |
|
0 |
1 |
No filtering is active; all alarms are shown. |
|
1 |
0 |
Test mode filtering is active; active test mode alarms are hidden, but all other alarms are shown. |
|
1 |
1 |
Test mode filtering is active; active test mode alarms are shown, but all other alarms are hidden. |
Note: filterMaskedAlm can be used to return alarms of the points included in the device (filtered by test mode) by setting dbname to device, and ptname to Device.