Chatter/Fleeting Alarms Report

The Chatter/Fleeting Alarms report is used to display points that go into and out of alarm within a specified amount of time. Chattering alarms are first set, then cleared, then set again within a specified time. Fleeting alarms are first set and then cleared within a specified time.

Here is a sample configuration:

<Section>

<Title>Top 25 Chattering Points</Title>

<QueryType>WorstChatterAlarms</QueryType>

 

<OffenderCount>25</OffenderCount>

<IncludeSecondSet>True</IncludeSecondSet>

<TimeInterval>60</TimeInterval>

 

<Start_Date>H=0 M=0 S=0</Start_Date>

<End_Date>H=23 M=59 S=59</End_Date>

<Contract_OffSet>0</Contract_OffSet>

 

<Filters>

<Filter>System Chatter</Filter>

</Filters>

<Columns>

<Column item="Site" text="Site"/>

<Column item="Service" text="Service"/>

<Column item="PointIdLong" text="Point"/>

<Column item="FacilityId" text="Facility"/>

<Column item="LongDescription" text="Description"/>

<Column item="count" text="Count">

<SummaryCalc>Sum</SummaryCalc>

<SummaryCalc>Average</SummaryCalc>

<SummaryCalc>Min</SummaryCalc>

<SummaryCalc>Max</SummaryCalc>

</Column>

</Columns>

</Section>

Elements

The following table describes each configuration element.

Element Description

<Title>

The name of the Worksheet tab in Excel for XLSX and PDF formatted reports or the name of the file for CSV and XML formatted reports.

<QueryType>

The query type is WorstChatterAlarms for this report.

<OffenderCount>

An integer representing the number of points to display in the report.

<IncludeSecondSet>

A Boolean used to indicate if the second set is a required condition. A value of "True" indicates Chattering. A value of "False" indicates Fleeting.

<TimeInterval>

The amount of time (in minutes) the setting and clearing of alarms must occur to be included in the report.

<Start_Date>

The starting date to use for the report. Valid values are relative timestamps. For example:

  • d-5 means 5-days ago
  • h-5 means 5-hours ago

In the above examples, “d” and “h” represent the interval. Other intervals include:

  • m — Month
  • d — Day
  • h — Hour
  • n — Minute
  • s — Second

<End_Date>

The ending date to use for the report. See <Start_Date> for valid values.

<Contract_OffSet>

The contract hour offset.

<Filters>

Used to specify which filter to use for the report. This is the referenced filter name and is specified in the <Filter> node of the <Filters> element.

<Columns>

The list of <Column> nodes specifying which columns to display in the report.

Attributes

The following table describes each configuration attribute of a column node.

Attribute Description

item

The item to display in the cell. Valid values are facility attributes, point attributes and real-time record attributes.

See Enumeration Attributes for more information. Additionally, any alarm record attribute can be displayed.

See AUD, ELSALM, and ELS XML Properties for more information.

text

The text value to display for the column header.

Summary calculations can be added to any column. See Adding Summary Calculations for information on configuration.

Back to top