Filteralm
- Last UpdatedApr 24, 2025
- 2 minute read
The function of this Business Logic Tier (BLT) is to return filtered alarm summary data. Foreground color and flashing status are returned along with up to 10 requested fields per alarm.
Syntax
filteralm <skip> <almFilter> <ackFilter> <dbname> <ptname> <field <{field]>
Parameters
|
Name |
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 data that either are or are not in the the 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. |
|
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.
Alarm information is returned, sorted in order from the highest to lowest severity. Within severity, the data is sorted from newest to oldest.
The alarm filter returns non-covered and/or system alarms based on the configuration in the xosdisplay table and the current user and display.
If the configuration is not defined in the xosdisplay table for either the user or display, both non-covered and system alarms are returned.
The foreground color is based on the alarm severity. The relationship between alarm color and severity is defined in the xosalmattr table. If the severity is not defined in the xosalmattr table, the color is returned red(1).
If a display name is not set, then the alarms are not filtered by the Area of Responsibility (AOR). Otherwise, alarms are filtered according to the areas that you and your display are currently logged.
Example
Filteralm 0 both both analog dbname ptname
|
fgint |
flash |
sevint |
dbname |
ptname |
|---|---|---|---|---|
|
2 |
yes |
1 |
analog |
test 1 |
|
2 |
yes |
1 |
analog |
test 2 |
|
2 |
yes |
1 |
analog |
test 3 |
|
2 |
yes |
1 |
analog |
test 4 |
|
2 |
yes |
1 |
analog |
|
(4 rows affected.) (return status = 0)
This example filters by the analog table. Notice that point is not indicated. This has the effect of returning all the alarms in the analog table.
Notes: filteralm can be used to return all alarms from a remote and the points included in it by setting
dbname to station, and ptname to the name of the remote.
filteralm can be used to return all alarms of the points included in the device by setting
dbname to device, and ptname to the name of the device.
filtaralm cannot be used to return the alarms of the points included in the station table.
You must use filterMaskedAlm for that purpose.