CygNet Alarm Manager Screens

The CAM provides a collection of sample CygNet Studio screens illustrating an example workflow. The sample files used by CygNet Studio are located in a folder call M_CAM of the BSS specified during installation. The screens are intended to work together and all files should remain in the same folder location.

The sample CygNet Studio screens provided in the module represents a sample workflow for viewing and interacting with the calculated KPI metrics and reports. Specific customer requirements may be required and as such modifications to the screens and/or new screens may be needed.

See CygNet Alarm Manager Screens Overview for more information about the sample screens.

XML Configuration

The CAM sample screens utilize an XML file for certain configuration elements. Instead of hard-coding installation specific information into the screens, the CAMConfig.xml file is used. This file is in the same location as the other CAM CygNet Studio files. Below is an outline of the file.

Copy

CAMConfig.xml

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
<CAM>
    <Config>
        <BaseFilterLocation>\\SITE.STORAGE\AlarmManagement\Filters</BaseFilterLocation>
        <BaseQueryLocation>\\SITE.STORAGE\AlarmManagement\Queries</BaseQueryLocation>
    </Config>
    <AOR name="System" facilityid="SITE">
        <Screens>
        </Screens>
    </AOR>
    <AOR name="North Area" facilityid="NORTH">
        <Screens>
        </Screens>
    </AOR>
    <AOR name="South Area" facilityid="SOUTH">
        <Screens>
        </Screens>
    </AOR>
    <AOR name="East Area" facilityid="EAST">
        <Screens>
        </Screens>
    </AOR>
    <AOR name="West Area" facilityid="WEST">
        <Screens>
        </Screens>
    </AOR>
</CAM>

There are two main sections of the file. The configuration and the Area of Responsibility (AOR) list.

The configuration section just has two items specifying the location of files. They are as follows:

Item	Description
<BaseFilterLocation>	The base file path for Filters.
<BaseQueryLocation>	The base file path for Queries.

Area of Responsibility (AOR)

The list of AORs are used to specify information about a particular AOR.

Attributes

Each AOR node has two attributes.

Item	Description
name	The name of the AOR. This will be shown in the drop-down list on the CAM Dashboard screen.
facilitid	The Facility ID associated with the AOR. Based on the drop-down screen selection, this facility will be passed to the associated nested views for proper presentation of data.

Some screens will utilize a filter file while others will use a query file to perform certain actions. The appropriate file to use for a specific AOR is defined within each AOR node. Here is sample configuration section:

Copy

Filter File or Query File

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
50
51
52
<AOR name="System" facilityid="SITE">
    <Screens>
        <Screen name="KPI Detail">
            <Filter>System - History Total.xml</Filter>
        </Screen>
        <Screen name="CRM Priority Mgmt">
            <Filter>System - Priority Screen.xml</Filter>
        </Screen>
        <Screen name="CRM Controller Query">
            <Filter>System - Alarms by Controller Screen.xml</Filter>
        </Screen>
        <Screen name="CRM AQ - 10 Min Distribution">
            <Query>System 10-Min Dist.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Hourly Distribution">
            <Query>System Hourly Dist.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Worst Offenders">
            <Query>System Worst Offenders.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Avg per HOD">
            <Query>System Avg per HoD.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Avg per DoW">
            <Query>System Avg per DoW.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Alarms">
            <Query>System Alarms.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Alarm Flood">
            <Query>System Alarm Flood.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Manual Points">
            <Query>System Manual Points.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Standing">
            <Query>System Standing Points.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Chatter">
            <Query>System Chatter Points.xml</Query>
        </Screen>
        <Screen name="CRM AQ - Maintenance Query">
            <Filter>System - Maint Hist Alarms - Total.xml</Filter>
        </Screen>
        <Screen name="CRM AQ - Inhibited Query">
            <Filter>System - Inhibit History Alm Total.xml</Filter>
        </Screen>
        <Screen name="Hourly Histogram">
            <Query>Histogram.xml</Query>
        </Screen>
    </Screens>
</AOR>

Each AOR will have a <Screens> node that contains multiple <Screen> elements. The name of the screen, without the .CSF extension, is configured in the name attribute. Typically there will be either a <Filter> node or a <Query> node nested within the specific <Screen> element. However, both could be included.

Copy

Filter Node

1
2
3
<Screen name="KPI Detail">
    <Filter>System - History Total.xml</Filter>
</Screen>

In this example, there is a screen called "KPI Detail.csf". When this specific AOR is selected (System), the filter to use for the screen will be "System – History Total.xml". This filter file should be in the <BaseFilterLocation> defined in the <Config> section of the file. Each AOR will have a set of screens with specific filter or query files referenced that are specific for the AOR/Screen combination.

Below is a sample configuration where there are five (5) areas defined. Each area has the same screen referenced but each screen has a different reference filter. Each of the filter files would be configured with the appropriate settings for that particular AOR.

Copy

Different Reference Filters

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
<CAM>
    <Config>
        <BaseFilterLocation>\\SITE.STORAGE\AlarmManagement\Filters</BaseFilterLocation>
        <BaseQueryLocation>\\SITE.STORAGE\AlarmManagement\Queries</BaseQueryLocation>
    </Config>
    <AOR name="System" facilityid="SITE">
        <Screens>
            <Screen name="KPI Detail">
                <Filter>System - History Total.xml</Filter>
            </Screen>
        </Screens>
    </AOR>
    <AOR name="North Area" facilityid="NORTH">
        <Screens>
            <Screen name="KPI Detail">
                <Filter>North - History Total.xml</Filter>
            </Screen>
        </Screens>
    </AOR>
    <AOR name="South Area" facilityid="SOUTH">
        <Screens>
            <Screen name="KPI Detail">
                <Filter>South - History Total.xml</Filter>
            </Screen>
        </Screens>
    </AOR>
    <AOR name="East Area" facilityid="EAST">
        <Screens>
            <Screen name="KPI Detail">
                <Filter>East - History Total.xml</Filter>
            <Screen>
        </Screens>
    </AOR>
    <AOR name="West Area" facilityid="WEST">
        <Screens>
            <Screen name="KPI Detail">
                <Filter>West - History Total.xml</Filter>
            </Screen>
        </Screens>
    </AOR>
</CAM>