Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA Enterprise SCADA

AlarmFilterString

  • Last UpdatedApr 24, 2025
  • 2 minute read

This business object’s function is to return alarm summary data filtered by severity for each severity level.

For further information on Business Object References (BORs) (aka Business Logic Tiers [BLTs]), see Understanding the Business Logic Tier (BLT).

Syntax

AlarmFilterString <@skip> <@almFilter> <@ackFilter> <@filter_spec> <@field>

Name

Description

@skip

The number of matching alarms to skip before returning data.

@almFilter

  • If this value is yes, it returns alarm summary data for alarms that are in alarm.

  • If this value is no, it returns alarm summary data for alarms that are not in alarm.

  • If this value is both, it returns alarm summary data for alarms that are both in alarm and not in alarm.

@ackFilter

  • If this value is yes, it returns alarm summary data for alarms that are unacknowledged.

  • If this value is no, it returns alarm summary data for alarms that are acknowledged.

  • If this value is both, it returns alarm summary data for alarms that are both unacknowledged and acknowledged.

@filter_spec

Parameters specified in the form @name=value.

  • A vertical bar is used to separate a list of filters for a given filtering parameter.

    Examples:

    • @severity=low searches for alarms with low severity.

    • @severity=low|high searches for alarm with low or high severity.

  • A comma is used to separate the different filtering parameters.

    Example:

    • @severity=medium,@rtu=LMSRemote searches for alarms with medium severity and the Remote Terminal Unit (RTU) LMSRemote.

Possible filtering _spec parameters:

  • @area_name or @area (the name of the area)

  • @group or @grp (the name of the group)

  • @station_name or @sta (the name of the station)

  • @rtu_name or @rtu (the name of the remote)

  • @pnt (the name of the database point)

  • @desc (a description of the database point)

  • @safety or @safe (safety database point)

  • @order_by_time or @time (sort alarms by time, from latest to oldest)

  • @parked or @prk (parked alarms)

  • @pre_parked or @prprk (pre-parked alarms)

  • @severity or @sev (alarm severity)

  • @order_by_unack or @unack (sort alarms by unacknowledged alarms first)

  • @all_groups (alarms for all groups)

  • @db_tables_filter (database table name)

  • @is_critical_point (Is this a critical database point [yes/no]?)

  • @category or @category_name (category name)

@field

The field to display in the dataset.

In This Topic