Audit History Report

The Audit History report is used to display audit history record data from the AUD service. This report type is useful for creating reports such Manual Points and Suppressed Points reports.

Section Node

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

Copy
Audit History Report
<Section>
    <Title>Manual Points - System Operator Points</Title>
    <QueryType>AuditCollect</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>
    <Filters>
        <Filter>System Manual Points</Filter>
    </Filters>
    <Columns>
        <Column item="auditattrch" text="Attribute"/>
        <Column item="key" text="Audit Key"/>
        <Column item="auditopdesc" text="Audit Desc"/>
        <Column item="audittxtime" text="Audit Time"/>
        <Column item="audituserid" text="User Id"/>
        <Column item="auditemid" text="Audit Id"/>
        <Column item="pointidlong" text="Long ID"/>
        <Column item="description" text="Point Description"/>
        <Column item="facilityid" text="Facility"/>
        <Column item="facility_desc" text="Facility Description"/>
        <Column item="general2" text="RTU"/>
    </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 AuditCollect 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.

<Contract_OffSet>

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

<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