Configuring the CygNet Alarm Manager
The module configuration for CygNet Alarm Manager (CAM) is stored as XML in the Script field of a dedicated HSS point. This point will be created if it does not exist when you set the options via the CamModuleConfiguration.csf CygNet Studio screen. The Long Point ID for the configuration point is ALMMODULE_CONFIG.
CygNet Alarm Manager Configuration
There are two main areas of configuration for CAM.
- Job Configuration — Jobs are executed by the engine to perform specific operations. There are operations for near-time calculation of alarm activity and for reporting alarm activity.
- Screen Configuration — Screens are used to display alarm calculations, activity, and reports.
Job Configuration
A KPI job definition file is an XML file that contains one or more jobs with each job specifying the operations to perform. Each job file is stored in the Storage service created in Installing CygNet Alarm Manager, Step 1 (for example, \\SITE.STORAGE\AlarmManagement\JobFiles). The basic format is as follows:
<?xml version="1.0" encoding="utf-16"?>
<KpiJobDefinition>
<Config>
<OutFile>xxxxxxx</OutFile>
<AudServices>SITE.AUD</AudServices>
<CasServices>SITE.CAS</CasServices>
<CvsServices>SITE.UIS</CvsServices>
<ElsAlmServices>SITE.ELSALM</ElsAlmServices>
<Status_Point>SITE.UIS:SITE_KPI_STATUS</Status_Point>
<ExecTime_Point> SITE.UIS:SITE_KPI_EXECTM </ ExecTime_Point >
</Config>
<Jobs>
<Job>
<Operation>xxxx</Operation>
<Individual Job Configuration Elements>
</Job>
<Job>
<Operation>xxxx</Operation>
<Individual Job Configuration Elements>
</Job>
</Jobs>
</KpiJobDefinition>The AUD, CAS, CVS and ELSALM services section are provided for override purposes. These items can be left blank and the values from the Module Configuration will be used.
There is no limit for the number of jobs that a KPI job definition file can contain. You may want to divide jobs into different files. Reasons for this are:
- Job files can then be scheduled to run at different intervals.
- A job that takes longer to run can be run independently of others.
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.
Job File Configuration Section Elements
Each job file will have a configuration section. This section is used to override the defaults defined in the Module Configuration.
| Element | Description |
|---|---|
|
<OutFile> |
The name of the Output File, for example, "System Alarm Records.txt". |
|
<AudServices> |
A semi-colon list of AUD services used by default in jobs. |
|
<CasServices> |
A semi-colon list of CAS services used by default in jobs. |
|
<CvsServices> |
A semi-colon list of CVS services used by default in jobs. |
|
<ElsAlmServices> |
a semi-colon list of ELSALM services used by default in jobs. |
|
<Status_Point> |
If provided, a status message indicating the status of the job. |
|
<ExecTime_Point> |
If provided, the time it took to run the job file is posted to this point. It is suggested that this point be setup for History. |
|
<MaxCacheSize> |
A long integer specifying the maximum cache size for each query request. This value must be between 20,000 and 10,000,000. |
|
<QueryWaitTime> |
An integer specifying the number of milliseconds to wait before checking if the CxEventIF query is complete. |
|
<QueryWaitCycles> |
An integer specifying the number of times to check the completion status of a CxEventIF query. If the Query Wait Time is set to 500 ms and Query Wait Cycles is set to 500, then the total amount of time the engine will wait for the query to complete is 250,000 ms or 250 seconds. |
Screen Configuration
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.
There is a file call CAMConfig.xml that contains configuration that is used by the provided screens. See CygNet Alarm Manager Screens for more information on configuring this file.
More:
