Average Alarms per Day of Week Report

The Average Alarms per Day of Week report displays alarm statistics about specific days of the week during the configured date range, for example, 22 alarms on Sunday.

Section Node

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

Copy
Average Alarms per Day of Week Report
<Section>
    <Title>Average Alarms per Day of Week</Title>
    <QueryType>AlarmsPerWeekDay</QueryType>
    <Start_Date>d-7 H=0 M=0 S=0</Start_Date>
    <End_Date>H=23 M=59 S=59</End_Date>
    <Period>1440</Period>
    <Period_Type>Fixed</Period_Type>
    <Filters>
        <Filter>System Total</Filter>
    </Filters>
    <Columns>
        <Column item="r_day" text="Day"/>
        <Column item="r_almcount" text="Alarm Count"/>
        <Column item="r_almtotal" text="Total Alarms"/>
        <Column item="r_daycount" text="Day Count"/>
        <Column item="r_almpercent" text="Alarm % for Day"/>
        <Column item="r_dailyavg" text="Alarm Daily Average">
            <SummaryCalc>Sum</SummaryCalc>
            <SummaryCalc>Average</SummaryCalc>
            <SummaryCalc>Min</SummaryCalc>
            <SummaryCalc>Max</SummaryCalc>
        </Column>
    </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 AlarmsPerWeekDay for this report.

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

<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 include only the following:

  • r_day — day of week (Sunday, Monday, etc…)
  • r_almcount — The number of alarms for the day
  • r_almtotal — The total number alarms for the date range
  • r_daycount — The number of days in the date range
  • r_almpercent — The percentage of total alarms for the specific day
  • r_dailyavg — The daily average of alarms (total alarms for day of week divided by the number of the specific week day in the date range)

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