View Source

Functionality to define flagSourceColumns (i.e. validation steps) to be able to get insight in the progress of the validation process

Function:	Configure Validation Status
Where to Use?	\RegionConfigFiles\
Why to Use?	The FlagSourceColumns.xml is necessary to be able to use validation status related functionality, as described in 26. Validation Status
Description:	The FlagSourceColumns file is used to define flagSourceColumns (i.e. validation steps) which can be defined to store flagSources of individual validation steps and which can be stored in the datastore and visualized in the time series dialog
Available since:	DelftFEWS 2015.02

Overview

Since version 2015.02 FEWS makes it possible to configure so-called 'flagSource columns' for each individual validation step, in which the flagSource of the specific validation step will be recorded. From these flagSource columns the user can deduct which individual validation steps have been performed and to what result. Even when a defined validation step has been executed successfully and no quality flag has been changed, a default flagSource "OK" will be set for the respective flagSource column. The flagSource columns therefor provide details on all the validation steps. Since 2016.01 it is possible to open up 'Time of Validity' related functionality in the timeSeries display, by configuring a timeOfValidity element. The functionality of Time of Validity is more exhaustively described in the Validation Status page.

Configuration

FlagSource columns can be defined in FlagSourceColumns.xml regional configuration file. These flagSource Columns are stored for each timestep for all timeseries that have been validated in the FEWS database. Various configuration options allow the user to harness the Validation Status in the operational process, either by visualisation, export, conditional filtering in transformations, etc.

Within the flagSourceColumns configuration file, several columns can be defined.

DELFT-FEWS Documentation > 29 FlagSourceColumns > flagSourceColumn_Schema.png

flagSourceColumn

column id

Id of the column. This id is only used to reference this column from the rest of the configuration. This id is not stored in the database. This id can be changed at any time without the requirement of deleting the datastore

column name

optional element with name of the column. When not specified the id is used as the name

storageKey

An integer between 0 to 127 that is used in the datastore to reference this column. After changing this key you have to delete the local datastore and MC database

description

optional element; Long (descriptive) name of location (tool tip) or description

shortName

Short name used in the header of in the time series dialog. When not specified the name is used

toolTip

Tooltip to be displayed in the time series dialog when hovering the column header

editable

The column is not editable in the time series dialog by default. Editable columns are also visible when empty and in edit-mode

alwaysVisible

Makes this column also visible when this column is empty and you are not in edit mode

backgroundColor

Background color of this column in the the time series dialog

timeOfValidity (since version 2016.01)

Optional element. When configured, this element opens up functionality in the time series display related to Time of Validity. When this element is configured, one needs to also define the timeOfValiditySearchPeriod in the TimeSeriesDisplayConfig configuration file. The functionality of Time of Validity is more exhaustively described on the Validation Status page.

columnId

Flag source column used as base for the time of validity.

defaultFlagSource

Flag source used to fill this column. Flag source should be a predefined flag source or flag source defined in the customFlagSources.xml

Example configuration

The example configuration below defines 5 validation steps. It also has the timeOfValidity element defined.

<flagSourceColumns xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews https://fewsdocs.deltares.nl/schemas/version1.0/flagSourceColumns.xsd">
	<column id="V1" name="First validation step">
		<storageKey>0</storageKey>
		<description>Validationstep A is the first validationstep</description>
		<shortName>V1</shortName>
		<toolTip>A Tooltip</toolTip>
		<editable>true</editable>
		<alwaysVisible>true</alwaysVisible>
		<backgroundColor>lawn green</backgroundColor>
	</column>
	<column id="V2">
		<storageKey>5</storageKey>
		<description>Second validation step</description>
		<shortName>V2</shortName>
		<toolTip>B Tooltip</toolTip>
		<editable>false</editable>
		<alwaysVisible>true</alwaysVisible>
		<backgroundColor>alice blue</backgroundColor>
	</column>
	<column id="V3">
		<storageKey>1</storageKey>
		<description>Validation step C</description>
		<shortName>V3</shortName>
		<toolTip>C Tooltip</toolTip>
		<editable>true</editable>
		<alwaysVisible>true</alwaysVisible>
		<backgroundColor>cyan</backgroundColor>
	</column>
	<column id="V4">
		<storageKey>2</storageKey>
		<description>Validation step D</description>
		<shortName>V4</shortName>
		<toolTip>D Tooltip</toolTip>
		<editable>true</editable>
		<alwaysVisible>true</alwaysVisible>
		<backgroundColor>purple</backgroundColor>
	</column>
	<column id="V5" name="F5">
		<storageKey>6</storageKey>
		<description>My E</description>
		<shortName>V5</shortName>
		<toolTip>E Tooltip</toolTip>
		<editable>false</editable>
		<alwaysVisible>false</alwaysVisible>
		<backgroundColor>aquamarine</backgroundColor>
	</column>
	<timeOfValidity>
		<columnId>V3</columnId>
		<defaultFlagSource>OK</defaultFlagSource>
	</timeOfValidity>
</flagSourceColumns>

Contents