Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


What

Parameters.xml

Required

yes

Description

Definitions of all parameters used in DELFT-FEWS

schema location

http

https://

fews

fewsdocs.

wldelft

deltares.nl/schemas/version1.0/parameters.xsd


Table of Contents

Overview

...

The unit conversions id to convert from the (internal) units to the display units. This id should be available in the UnitConversionsDescriptors. Only required when a displayUnit is specified for a parameter group

...

The unit conversions id to convert from the units specified in config files to the internal units for this parameter. This id should be available in the UnitConversionsDescriptors.   Only required when a user unit is specified for a thresholdValuesSet, validationRuleSet or ratingCurve

...

Optional cell method (for time dimension) as defined in the netcdf CF convention. This is currently only used for export to netcdf files. See http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#cell-methods

tideNumberParameterId

SINCE 2022.02. The parameter of a time series (set) is replaced (behind the screens) with this parameter to find the tide number



Configuring a hierarchical tree view for parameters in Fews Explorer

...

Code Block
xml
xml
 
<parameters version="1.0" xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:schemaLocation="http://www.wldelft.nl/fews httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/parameters.xsd">
         <parameterGroups>
                <parameterGroup id="Discharge">
                     ...as before ...
                </parameterGroup>
         </parameterGroups>
         <parameterRootNode id="Parameters">
                <parameterNode id="Discharge">
                        <parameterId>Q.obs</parameterId>
                        <parameterId>Q.rated</parameterId>
                        <parameterId>Q.simulated</parameterId>
                        <parameterId>Q.simulated.historical</parameterId>
                        <parameterId>Q.simulated.forecast</parameterId>
                        <parameterId>Q.simulated.event</parameterId>
                        <parameterId>Q.updated</parameterId>
                        <parameterId>Q.correlated</parameterId>
                        <parameterId>Q.updated.historical</parameterId>
                        <parameterId>Q.updated.forecast</parameterId>
                        <parameterId>Q.generated</parameterId>
                        <parameterId>Q.merged</parameterId>
                        <parameterId>Q.profile</parameterId>
                        <parameterId>Q.target</parameterId>
                        <parameterId>Q.peak</parameterId>
                        <parameterId>Q.simulated.inflow</parameterId>
                </parameterNode>
                <parameterNode id="Water Level">
                        <name>Water level</name>
                        <parameterId>H.obs</parameterId>
                        <parameterId>H.obs.upstream</parameterId>
                        <parameterId>H.obs.downstream</parameterId>
                        <parameterId>H.obs.head</parameterId>
                        <parameterId>H.obs.tail</parameterId>
                        <parameterId>H.obs.crest</parameterId>
                        <parameterId>H.simulated</parameterId>
                        <parameterId>H.simulated.historical</parameterId>
                        <parameterId>H.simulated.forecast</parameterId>
                        <parameterId>H.simulated.event</parameterId>
...
                </parameterNode>	
         </parameterRootNode>
</parameters>

...

In case there is no timeseriesset for the combination of parameter and location, the nodes will be grayed out:

Enumerations

Parameters can also be defined as enumerations. Then there will be a set number of possible values with a specific label. The value will be stored in the database, the label will be shown in the GUI. 

Code Block
xml
xml
<parameters version="1.0" 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/parameters.xsd">
	<displayUnitConversionsId>ImportUnitConversions_IMmetingen</displayUnitConversionsId>
	<enumerations>
		<enumeration id="GATE">
			<value code="0" label="Closed"/>
			<value code="1" label="Half Open"/>
			<value code="2" label="Open"/>
		</enumeration>
		<enumeration id="SMELL">
			<value code="0" label="None"/>
			<value code="1" label="Weak"/>
			<value code="2" label="Strong"/>
		</enumeration>

Parameters in csv format

It is possible to define parameters in a csv file. By using %% can be referred to the content of the columns in the csv file. For example:

Code Block
xml
xml
<?xml version="1.0" encoding="UTF-8"?>
<parameters version="1.0" xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews httphttps://fewsfewsdocs.wldelftdeltares.nl/schemas/version1.0/parameters.xsd">
	<displayUnitConversionsId>ImportUnitConversions</displayUnitConversionsId>
	<ratingCurveStageParameterId>H.obs</ratingCurveStageParameterId>
	<ratingCurveDischargeParameterId>Q.rated</ratingCurveDischargeParameterId>
	<parametersCsvFile>
		<file>parametersALL.csv</file>
		<id>%ID%</id>
		<name>%NAME%</name>
		<shortName>%SHORT_NAME%</shortName>
		<group>%GROUP%</group>
    	<groupName>%GROUP_NAME%</groupName> <!--optional-->
	    <enumerationId>%ENUMERATION_ID%</enumerationId> <!--optional-->
		<parameterType>%TYPE%</parameterType>
		<unit>%UNIT%</unit>
		<valueResolution>%VALUE_RESOLUTION%</valueResolution>
		<allowMissing>%ALLOW_MISSING%</allowMissing> <!--optional-->
		<attribute id="InternalParameterId">
			<text>%ID%</text>
		</attribute>
	</parametersCsvFile>
</parameters>

...