Alarm History Distribution Report

The Alarm History Distribution report displays the number of alarms for configured periods of the specified date range. Each period can display the results of a defined filter. This report type can be used to generate 10-Minute, Hourly, or Daily Priority Distribution reports.

Here is a sample configuration:

<Section>

<Title>Hourly Distribution</Title>

<QueryType>HistoryAlarmCount</QueryType>

 

<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>60</Period>

<Period_Type>Fixed</Period_Type>

<Columns>

<Column filter="" item="r_period" text="Period"/>

<Column filter="System Total" text="Total" >

<SummaryCalc>Sum</SummaryCalc>

<SummaryCalc>Average</SummaryCalc>

<SummaryCalc>Min</SummaryCalc>

<SummaryCalc>Max</SummaryCalc>

</Column>

<Column filter="System Category 4" text="Cat 4" >

<SummaryCalc>Sum</SummaryCalc>

<SummaryCalc>Average</SummaryCalc>

<SummaryCalc>Min</SummaryCalc>

<SummaryCalc>Max</SummaryCalc>

</Column>

<Column filter="System Category 3" text="Cat 3" >

<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 HistoryAlarmCount for this 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.

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

<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

filter

The name of the filter (specified in the list of filters) to use to determine the value to use for the cell.

item

If filter is blank, the item is used to determine what value to blank. The value of "r_period" is the only valid item name for this report. This indicates to use the period (mm/dd/yyyy hh:mm:ss AM/PM) as the value for the cell.

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