You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Contents

Introduction

Starting with release 2011.02, a task for the MC_SytemAlerter workflow can be configured to send an alert to the Alarmmodule, developed by Imtech for the IWP system. The alert sending has been implemented as an invocation of the Alarmmodule via a SOAP call (also know as a Webservice call). This page how to describe the FEWS-related part of the implementation.

Currently these tasks can only be scheduled using the "Upload task(s) from file" functionality in the Admin interface. The uploaded XML configuratio should conform to the taskList.xsd schema. For examples see below. The Alarmmodule alert part is defined in the referenced mcSystemAlerter.xsd schema.

Configuration

The following documents play a role in the generation of alerts.

  • ModuleConfigFiels\<secondaryValidation>.xml
    Contains the secondary validation rules that will generate logEventCodes that become visible in the logging when rules are exceeded. File name is free to choose, secondaryValidation refers to the xsd that is used.
  • RegionConfigFiles\ all three threshold configuration files. See also the wiki page on this: 09 Thresholds
    • RegionConfigFiles\Thresholds.xml
      Defines the level for each threshold with <levelThreshold>. These thresholds can be used to change colors and the use of Flags in the Displays
    • RegionConfigFiles\TresholdValueSets.xml
      Links timeSeriesSets to <thresholdValueSets>
    • RegionConfigFiles\TresholdWarningLevels.xml
      Can be used to define the overlays and colors used when <thresholdWarningLevels> are exceeded, both up and down..
  • DisplayConfigFiles\<scadaDisplay>.xml
    Defines the scada display in which alerts can be used by means of <shapeComponentBehaviourDefinition>. File name is free to choose, scadaDisplay refers to the xsd that is used.

From logging to Alarmmodule

Van logmelding naar alarmmodule

De werking van deze functionaliteit is als volgt:

  • De alarmen module instance controleert alle opgegeven tijdreeksen en logged een alarm in de FEWS logging tabel. Op de FSS logging is het volgende zichtbaar:

 

  • Als je in de FEWS Admin Interface de pagina “System Status”en vervolgens “View Logs” opent kan je dezelfde logging informatie vinden.

 

  • Ook in de FEWS OC System Monitor komen deze log meldingen door.

In de FEWS Admin Interface en in de FEWS OC System Monitor is te zien dat alle alarm log meldingen een Event code hebben die begint met “IWP.”. Nu is in de Admin Interface een actie geconfigureerd die uitgevoerd wordt wanneer er log meldingen met “IWP.” gelogged worden. Deze configuratie bestaat uit drie onderdelen:

  1. Een Event and Action Configuration
  2. Een Event Action Mapping
  3. Een Geschedulde Workflow
  • In de Event and Action configuration moet een Action ID opgezet worden

Achter de action ID “Alarmmodule.alarm” hangt het volgende configuratie bestand.

<?xml version="1.0" encoding="UTF-8" ?>
<actionxml type="task">
<oneoff>
<cardinaltime interval="60" reference="2004-01-01T00:00:00.000+00:00" />
<tag name="ALARM_MODULE" />
  </oneoff>
</actionxml>

 

Dit betekent dat er een eenmalige actie “Alarmmodule.alarm” zal worden uitgevoerd. Deze actie genereert een TAG “ALARM_MODULE”, die niet vaker dan 1 keer per 60 seconden mag worden gedraaid. Deze tijd kunnen we ook op 10 minuten of langer zetten. Dat betekend dat momenteel de log meldingen niet vaker dan 1 keer per minuut naar de Alarm module gestuurd worden.

 

  • In de Event Action Mappings moet de door een FEWS FSS gegenereerde log event code gekoppeld worden aan een Action ID.

Dit betekent dat wanneer er een log melding “IWP.*” voorbij komt de actie “Alarmmodule.alarm” zal worden uitgevoerd. Door het gebruik van de “*” hoef je niet alle individuele Event codes op te geven.

 

  • In de Scheduled Tasks geef je op dat de Systeem workflow “MC_SystemAlerter” moet draaien wanneer de TAG “ALARM_MODULE” gegenereerd wordt.

De eigenschappen van deze geschedulde taak zijn als volgt:

Schedule fixed alert

In the fixed alert scenario, the alert is entered as part of the taskproperties of the scheduled MC_SystemAlerter task. This can be used to send regular or one-off alerts and will probably mostly be used for testing purposes.

<?xml version="1.0" encoding="UTF-8"?>
<taskList
    xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/taskList.xsd"
    xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <task>
        <taskStatus>S</taskStatus>
        <runOnFailOver>false</runOnFailOver>
        <taskProperties>
            <description>Test IWP_0_TEST Alarm</description>
            <workflowId>MC_SystemAlerter</workflowId>
            <taskSelection>
                <scheduledTask>
                    <schedulingPeriod>
                        <startDate>2010-12-20T13:28:00.000Z</startDate>
                        <endDate>3010-12-20T13:28:00.000Z</endDate>
                    </schedulingPeriod>
                    <schedulingInterval unit="minute" multiplier="30"/>
                </scheduledTask>
            </taskSelection>
            <forecastPriority>Normal</forecastPriority>
            <makeForcastCurrent>false</makeForcastCurrent>
            <makeStateCurrent>false</makeStateCurrent>
            <mcSystemAlerter>
				<alerts>
					<alarmModuleAlert>
						<webserviceURL>http://localhost:8989/AlarmModuleManager/webservices/alarmService</webserviceURL>
						<alarmDiagLine code="IWP_0_TEST" description="Test Alert from FEWS" source="MC01" level="1"/>
					</alarmModuleAlert>
				</alerts>
			</mcSystemAlerter>
        </taskProperties>
    </task>
</taskList>

Schedule template alert

The alert with the template is intended to be used as a suspended task which can be triggered through event-action configurations to trigger a single task, in that case, the log messages triggering the alert will be added to the task, if in the template, the following tags are used:

  • %LOG% will be replaced by the message part of log entry
  • %EVENT_CODE% will be replaced by the event code of the log entry
  • %MC_ID% will be replaced by the MasterController ID creating the alert.
<?xml version="1.0" encoding="UTF-8"?>
<taskList
    xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/taskList.xsd"
    xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <task>
        <taskStatus>S</taskStatus>
        <runOnFailOver>false</runOnFailOver>
        <taskProperties>
            <description>IWP_0_Alarm</description>
            <workflowId>MC_SystemAlerter</workflowId>
            <taskSelection>
				<singleTask>
					<time0>2011-09-21T12:43:00.000Z</time0>
				</singleTask>
            </taskSelection>
            <forecastPriority>Normal</forecastPriority>
            <makeForcastCurrent>false</makeForcastCurrent>
            <makeStateCurrent>false</makeStateCurrent>
            <mcSystemAlerter>
				<alerts>
					<alarmModuleAlert>
						<webserviceURL>http://localhost:8989/AlarmModuleManager/webservices/alarmService</webserviceURL>
						<alarmDiagTemplateLine code="%EVENT_CODE%" description="%LOG%" source="%MC_ID%" level="1"/>
					</alarmModuleAlert>
				</alerts>
			</mcSystemAlerter>
        </taskProperties>
    </task>
</taskList>
  • No labels

Disclaimer