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

Compare with Current View Page History

« Previous Version 3 Next »

What

nameofinstance.xml

Description

Configuration for the time series availability checker module

schema location

http://fews.wldelft.nl/schemas/version1.0/timeSeriesAvailabilityChecker.xsd

Entry in ModuleDescriptors 

<moduleDescriptor id="TimeSeriesAvailabilityChecker">
	<description>TimeSeriesAvailabilityChecker</description>
	<className>nl.wldelft.fews.system.plugin.timeseriesavailabilitychecker.TimeSeriesAvailabilityChecker</className>
</moduleDescriptor>

Timeseries Availability Checker (since build 24501)

The timeseries availability checker module can be used to perform certain checks on time series data. A check can generate log messages, which can trigger actions in the master controller, like e.g. sending warning e-mails.

Configuration

When available as configuration on the file system, the name of an XML file for configuring an instance of the timeseries availability checker module called for example CheckImportedData may be:

CheckImportedData 1.00 default.xml

CheckImportedData

File name for the CheckImportedData configuration.

1.00

Version number

default

Flag to indicate the version is the default configuration (otherwise omitted).

In a timeseries availability checker configuration file one or more checks can be configured. The configured checks will be performed one by one. Each check will check the configured time series on the configured properties. If a time series does not pass the check, then the configured log message is logged. See below for more details.

A configuration example with four different checks configured is given below:

<timeSeriesAvailabilityChecker xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/timeSeriesAvailabilityChecker.xsd">
	<timeSeries>
		<timeSeriesId>input1</timeSeriesId>
		<timeSeriesSet>
			<moduleInstanceId>CheckImportedData</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>H.obs</parameterId>
			<locationId>location1</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="minute" multiplier="15"/>
			<!-- any relativeViewPeriod here will always be overruled by checkRelativePeriod in each check -->
			<readWriteMode>read only</readWriteMode>
		</timeSeriesSet>
	</timeSeries>
	<timeSeries>
		<timeSeriesId>input2</timeSeriesId>
		<timeSeriesSet>
			<moduleInstanceId>CheckImportedData</moduleInstanceId>
			<valueType>scalar</valueType>
			<parameterId>H.obs</parameterId>
			<locationId>location2</locationId>
			<timeSeriesType>external historical</timeSeriesType>
			<timeStep unit="minute" multiplier="15"/>
			<!-- any relativeViewPeriod here will always be overruled by checkRelativePeriod in each check -->
			<readWriteMode>read only</readWriteMode>
		</timeSeriesSet>
	</timeSeries>
	<minReliableValuesCheck id="MinReliableValuesCheck">
		<timeSeries>
			<timeSeriesId>input1</timeSeriesId>
		</timeSeries>
		<timeSeries>
			<timeSeriesId>input2</timeSeriesId>
		</timeSeries>
		<checkRelativePeriod unit="hour" start="-12" end="0"/>
		<minNumberOfValues>6</minNumberOfValues>
		<logLevel>WARN</logLevel>
		<logEventCode>TimeSeries.Check</logEventCode>
		<logMessage>Not enough reliable values available for time series %header%</logMessage>
	</minReliableValuesCheck>
	<minReliableOrDoubtfulValuesCheck id="MinReliableOrDoubtfulValuesCheck">
		<timeSeries>
			<timeSeriesId>input1</timeSeriesId>
		</timeSeries>
		<timeSeries>
			<timeSeriesId>input2</timeSeriesId>
		</timeSeries>
		<checkRelativePeriod unit="hour" start="-12" end="0"/>
		<minNumberOfValues>12</minNumberOfValues>
		<logLevel>WARN</logLevel>
		<logEventCode>TimeSeries.Check</logEventCode>
		<logMessage>Not enough reliable or doubtful values available for time series %header%</logMessage>
	</minReliableOrDoubtfulValuesCheck>
	<minNonMissingValuesCheck id="MinNonMissingValuesCheck">
		<timeSeries>
			<timeSeriesId>input1</timeSeriesId>
		</timeSeries>
		<timeSeries>
			<timeSeriesId>input2</timeSeriesId>
		</timeSeries>
		<checkRelativePeriod unit="hour" start="-12" end="0"/>
		<minNumberOfValues>18</minNumberOfValues>
		<logLevel>INFO</logLevel>
		<logEventCode>TimeSeries.Check</logEventCode>
		<logMessage>Not enough non-missing values available for time series %header%</logMessage>
	</minNonMissingValuesCheck>
	<minNumberOfValuesCheck id="MinNumberOfValuesCheck">
		<timeSeries>
			<timeSeriesSet>
				<moduleInstanceId>CheckImportedData</moduleInstanceId>
				<valueType>scalar</valueType>
				<parameterId>P.obs</parameterId>
				<locationSetId>locationSet1</locationSetId>
				<timeSeriesType>external historical</timeSeriesType>
				<timeStep unit="nonequidistant"/>
				<!-- any relativeViewPeriod here will always be overruled by checkRelativePeriod in each check -->
				<readWriteMode>read only</readWriteMode>
			</timeSeriesSet>
		</timeSeries>
		<checkRelativePeriod unit="hour" start="-12" end="0"/>
		<minNumberOfValues>24</minNumberOfValues>
		<logLevel>DEBUG</logLevel>
		<logEventCode>TimeSeries.Check</logEventCode>
		<logMessage>Not enough values available for time series %header%</logMessage>
	</minNumberOfValuesCheck>
</timeSeriesAvailabilityChecker>


  • No labels

Disclaimer