CygNet Alarm Manager Reports

There are eleven report types that can be generated by the CygNet Alarm Manager (CAM). Each requires a KPI job definition file to specify the operations to perform. Job files are stored in the CAM-dedicated Storage service (for example, \\SITE.STORAGE\AlarmManagement\JobFiles).

See CygNet Alarm Manager Reports Overview for more information about the CAM reports.

XML Configuration

The CAM reports utilize an XML file for configuration elements. The following is a sample of the XML format for a Report operation file.

Copy

REPORT Operation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<?xml version="1.0" encoding="utf-16"?>
<KpiJobDefinition>
    <Config>
        <OutFile>System Reports.txt</OutFile>
        <AudServices></AudServices>
            <!--Semicolon separated list of AUD services -->
        <CasServices></CasServices>
            <!--Semicolon separated list of CAS services -->
        <CvsServices></CvsServices>
            <!--Semicolon separated list of CVS services -->
        <ElsAlmServices></ElsAlmServices>
            <!--Semicolon separated list of ELSALM services -->
        <Status_Point>SITE.UIS:QAQBQCQD_STKPIR</Status_Point>
        <ExecTime_Point>SITE.UIS:QAQBQCQD_TMKPIR</ExecTime_Point>    
    </Config>
    <Jobs>
        <Job>
            <Operation>Report</Operation>
             
                <!--List of filters used by report sections -->
            <Filter Name="System Total">
                <FilterFilePath>System - History Total.xml</FilterFilePath>
            </Filter>
             
            <Report>
                <FileName>System Reports</FileName>
                    <!--The base file name of the report file. -->
                <FilePath></FilePath>
                    <!--The location where the report file is stored. -->
                <TemplateFile></TemplateFile>
                     <!--The location of the template file to use. -->
                <FileFormat>xlsx</FileFormat>
                    <!--The file format of the report: XLSX, PDF, XML, CSV -->
                <FileNameDateAppend>3</FileNameDateAppend>
                    <!--Used to append date and time to file name: 1=yyyyMMdd   2=hhmm   3=yyyyMMdd hhmm -->
                 
                    <!-- See each report for Section details -->
                <Section>
                    <Title> xxxxxxx </Title>
                    <KPI Specific Elements>
                </Section>
                <Section>
                    <Title> xxxxxxx </Title>
                    <KPI Specific Elements>
                </Section>
            </Report>
        </Job>
    </Jobs>
</ KpiJobDefinition>

There are two main sections of the file: the configuration <Config> details and the jobs <Jobs> list.

Each KPI job definition file will contain:

One <Config> node — The configuration section defines items that will be used by all jobs in the file. The elements in this section are defined in Configuring the CygNet Alarm Manager.
One <Jobs> node — The jobs section contains one or more individual Job entries.
- One or more <Job> nodes — Each individual Job node represents an operation to be performed. The elements in this node include the operation type, path to a filter file where filters are defined, report or query configuration, and section configuration. All nodes and elements are defined in Understanding CygNet Alarm Manager Operations.

Section Node

The Section node is used to specify information about each report. See each report type for an explanation of the elements and attributes used.