Standing Alarms Report

The Standing Alarms report displays values from alarm records that have been in alarm for a specified amount of time.

Section Node

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

Copy
Standing Alarms Report
<Section>
    <Title>System Standing Alarms</Title>
    <QueryType>StandingAlarms</QueryType>
    <StandingThreshold>120</StandingThreshold>
    <Filters>
        <Filter>System Standing Alarms Total</Filter>
    </Filters>
    <Columns>
        <Column item="facilityid" text="Facility"/>
        <Column item="pointidlong" text="Long ID"/>
        <Column item="description" text="Description"/>
        <Column item="privalue" text="Value">
            <SummaryCalc>Sum</SummaryCalc>
            <SummaryCalc>Average</SummaryCalc>
            <SummaryCalc>Min</SummaryCalc>
            <SummaryCalc>Max</SummaryCalc>
        </Column>
        <Column item="timestamp" text="Time"/>
        <Column item="reporttime" text="Report Time"/>
        <Column item="pointstatedescription" text="Point State" />
        <Column item="alarmpriority" text="Alarm Priority"/>
        <Column item="alarmprioritycat" text="Alarm Priority Category"/>
        <Column item="alarmack" text="Acknowledged?"/>
        <Column item="hidden" text="Hidden?"/>
        <Column item="suppression" text="Suppressed?"/>
        <Column item="alarmcleared" text="Cleared?"/>
        <Column item="" text="Action/Findings"/>
        <Column item="" text="Recommendation"/>
    </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 StandingAlarms for this report.

<StandingThreshold>

An integer representing the amount of time (in minutes) an alarms needs to be in alarm to be included in the report.

<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