Alarm Flood Report

The Alarm Flood report displays the periods within a specified date range where there were more than a configured number of annunciated alarms. This is different to the Alarm History Distribution report. The Alarm History Distribution report will show all periods and the number of alarms for each filter. The Alarm Flood report will only show periods that have more than the configured number of alarms in the period.

Section Node

Here is a sample configuration for the report <Section> node of the XML file:

Copy

Alarm Flood Report

<Section>
    <Title>Alarm Flood</Title>
    <QueryType>AlarmFlood</QueryType>
    <IncludeDetail>True</IncludeDetail>
    <FloodThreshold>10</FloodThreshold>
    <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>
    <Period>10</Period>
    <Period_Type>Fixed</Period_Type>
    <Filters>
        <Filter>System History Total</Filter>
    </Filters>
    <Columns>
        <Column item="r_date" text="Date" />
        <Column item="r_interval" text="Time Interval" />
        <Column item="r_count" text="Count" />
        <Column item="facility" text="Facility" />
        <Column item="udc" text="UDC" />
        <Column item="almtagl" text="Long ID" />
        <Column item="description" text="Description" />
        <Column item="pt_value" text="Value" />
        <Column item="eventtime" text="Time" />
        <Column item="key" text="Key" />
        <Column item="details" text="Details" />
        <Column item="comments" text="Comments" />
    </Columns>
</Section>

See CygNet Alarm Manager Reports for an explanation of the required <Config> and <Jobs> nodes at the top of the report XML file.

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 AlarmFlood for this report.
<IncludeDetail>

Valid values are "True" and "False". If true, each alarm record for each period will be displayed.

<FloodThreshold>

The threshold number of alarms for a period to qualify as a flood.

<Start_Date>

The starting date to use when the <Backfill> is set to "Yes". 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 when the <Backfill> is set to "Yes". See <Start_Date> for valid values.

<Contract_OffSet>

The contract hour offset to use in the calculation. Use 0 for no contract hour.

<Period>

The "width" of a period in minutes to use for the calculation. For example, a value of 10 would mean a 10-minute window.

<Period_Type>

Used to set the type of time window. Valid values are "Fixed" or "Sliding". See HISTCOUNT Operation for more information on type.

<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.

Additionally, there are three reserved item names:

  • r_date – period date
  • r_interval – time frame (00:20 – 00:29)
  • r_count – number of alarms in period

If <IncludeDetail> is "False", then only these three reserved items will be displayed.

If <IncludeDetail> is "True", all configured columns will be displayed.

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