Thresholds file

The schema-companion to the Thresholds & warnings task guide. Thresholds span three files; this one defines the threshold slots and which warning level each raises. This page is the generated field list.

At a glance

Purpose : Defines named threshold slots (e.g. MinorFlood, MajorFlood) and the warning level each crossing raises. The values are assigned separately in threshold value sets.

Folder : Config/RegionConfigFiles/

Root element : <thresholdGroups> (no version attribute)

Depends on : The ThresholdWarningLevels file (for the upWarningLevelId / downWarningLevelId it references).

Minimal example

Config/RegionConfigFiles/Thresholds 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<thresholdGroups xmlns="http://www.wldelft.nl/fews">
  <thresholdGroup id="Public" name="Public warnings">
    <defaultThreshold shortName="Normal"/>
    <levelThreshold id="MinorFlood" name="Minor flood">
      <upWarningLevelId>Minor</upWarningLevelId>
    </levelThreshold>
    <levelThreshold id="MajorFlood" name="Major flood">
      <upWarningLevelId>Major</upWarningLevelId>
    </levelThreshold>
  </thresholdGroup>
</thresholdGroups>

Tip

upWarningLevelId is raised when a value crosses upward; use downWarningLevelId for low-flow-style limits. The task guide explains the three-file split.

Field reference

Auto-generated from thresholds.xsd. Descriptions are the schema's own annotations.

Element <thresholdGroups>

Element	Type	Cardinality	Description
eventExpiryTime	CalendarTimeSpanComplexType	optional	Optional expiry time for threshold events in the ThresholdEvent table in the database.
maxActionEventDuration	TimeSpanComplexType	optional	Optional maximum duration of actions (like e.g. enhanced forecasting mode). An action can be switched on by a threshold upActionLogEvent. When this duration has passed after the most recent upActionLogEvent that switched on the action, then the action is automatically switched off. If not defined, then uses duration of one day.
forecastAvailableThreshold	ForecastAvailableThresholdComplexType	optional	Optional threshold that triggers forecast available threshold events. If this is specified, then forecast available events will be logged and these events can then be used in the SkillScoreDisplay. A forecast available threshold event indicates if there is a forecast available for a given observed threshold crossing event.
thresholdGroup	ThresholdGroupComplexType	required · repeats	One or more threshold groups. When thresholds are used or displayed, then it is possible to select which group of thresholds should be used or displayed.

CalendarTimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

ForecastAvailableThresholdComplexType

This threshold type is used to log the info that the related forecast run was available within a certain time window when the observed threshold has been crossed.

Attributes

Attribute	Use	Notes
id	required	Identifier of this threshold. Each threshold must have a unique id. Also thresholds that are in different threshold groups cannot have the same id.
name	optional	Name of this threshold. This name is used when this threshold is displayed (e.g. in the SkillScoreDialog). If not specified, then the id is used when this threshold is displayed.

Elements

Element	Type	Cardinality	Description
intId	idIntType	optional	DEPRECATED, do not use in new configurations. Id that will be logged as part of a ThresholdEvent in the ThresholdEvents table. This id must be unique through this file. If not specified, then this id will be generated automatically.

ThresholdGroupComplexType

Attributes

Attribute	Use	Notes
id	required	Identifier of this threshold group.
name	optional	Name of this threshold group, e.g. "Public" or "Internal". This name is used when this threshold group is displayed. If not specified, then the id is used when this threshold group is displayed.

Elements

Element	Type	Cardinality	Description
defaultThreshold	DefaultThresholdComplexType	required	Extra information for the state in which no thresholds are crossed. The state in which no thresholds are crossed always corresponds to the least severe warning level in the thresholdWarningLevels configuration file. The least severe warning level is used e.g. to get the color to display in the user interface when no thresholds are crossed.
levelThreshold	LevelThresholdComplexType	optional · repeats	A threshold that triggers a threshold event if a certain level is crossed upwards or downwards.
rateThreshold	RateThresholdComplexType	optional · repeats	A threshold that triggers a threshold event if the rate of change of data values becomes higher or lower than a certain rate, e.g. -0.1 m per hour.
maxThreshold	MaxThresholdComplexType	optional	A threshold that triggers a threshold event if there is a peak (maximum) in the data. The peak has to be higher than a certain level and has to be the maximum within a certain time window. If a maximum is at the end of a time series, then it does not count as a peak.

DefaultThresholdComplexType

Attributes

Attribute	Use	Notes
shortName	required	Short name for the state in which no thresholds are crossed. This short name is used e.g. for the column headers in the threshold crossing counts tables in the ThresholdOverviewDisplay.

LevelThresholdComplexType

contains definition of level threshold type

Attributes

Attribute	Use	Notes
id	required	Identifier of this threshold. Each threshold must have a unique id. Also thresholds that are in different threshold groups cannot have the same id.
name	optional	Name of this threshold. This name is used when this threshold is displayed (e.g. in the timeSeriesDialog). If not specified, then the id is used when this threshold is displayed.
shortName	optional	Optional short name for this threshold. This short name is used e.g. for the column headers in the threshold crossing counts tables in the ThresholdOverviewDisplay. If not specified, then the id is used as short name.

Elements

Element	Type	Cardinality	Description
upIntId	idIntType	optional	DEPRECATED, do not use in new configurations. Id that wil be put to the output time series if a particular threshold value of this type is crossed upwards. This id must be unique through this file. If not specified, then this id will be generated automatically.
downIntId	idIntType	optional	DEPRECATED, do not use in new configurations. Id that wil be put to the output time series if a particular threshold value of this type is crossed downwards. This id must be unique through this file. If not specified, then this id will be generated automatically.
season	SeasonComplexType	optional	Optional element if threshold is only valid for part of a year
upWarningLevelId	idStringType	required	Optional id of a warning level that will be activated for a particular location and parameter if a data value is above this threshold. Warning levels are defined in the thresholdWarningLevels configuration file. If no warningLevels are defined, then this threshold will not activate any warningLevels to be displayed, but it will still generate threshold crossing events for both upward and downward crossings.
downWarningLevelId	idStringType	required	Optional id of a warning level that will be activated for a particular location and parameter if a data value is below this threshold. Warning levels are defined in the thresholdWarningLevels configuration file. If no warningLevels are defined, then this threshold will not activate any warningLevels to be displayed, but it will still generate threshold crossing events for both upward and downward crossings.

RateThresholdComplexType

contains definition of the rate threshold type

Attributes

Attribute	Use	Notes
id	required	Identifier of this threshold. Each threshold must have a unique id. Also thresholds that are in different threshold groups cannot have the same id.
name	optional	Name of this threshold. This name is used when this threshold is displayed (e.g. in the timeSeriesDialog). If not specified, then the id is used when this threshold is displayed.

Elements

Element	Type	Cardinality	Description
upIntId	idIntType	optional	DEPRECATED, do not use in new configurations. Id that wil be put to the output time series if a particular threshold value of this type is crossed upwards. This id must be unique through this file. If not specified, then this id will be generated automatically.
downIntId	idIntType	optional	DEPRECATED, do not use in new configurations. Id that wil be put to the output time series if a particular threshold value of this type is crossed downwards. This id must be unique through this file. If not specified, then this id will be generated automatically.
season	SeasonComplexType	optional	Optional element if threshold is only valid for part of a year

MaxThresholdComplexType

contains definition of the max threshold type

Attributes

Attribute	Use	Notes
id	required	Identifier of this threshold. Each threshold must have a unique id. Also thresholds that are in different threshold groups cannot have the same id.
name	optional	Name of this threshold. This name is used when this threshold is displayed (e.g. in the timeSeriesDialog). If not specified, then the id is used when this threshold is displayed.

Elements

Element	Type	Cardinality	Description
intId	idIntType	optional	DEPRECATED, do not use in new configurations. Id that wil be put to the output time series if a particular threshold value of this type is exceeded. This id must be unique through this file. If not specified, then this id will be generated automatically.
season	SeasonComplexType	optional	Optional element if threshold is only valid for part of a year

SeasonComplexType

A period that occurs every year.

Attributes

Attribute	Use	Notes
startMonthDay	required
endMonthDay	required
timeZone	optional	default: GMT.
label	optional	Short name for the season which is shown to the user when he can choose one from a list.

See also

• Task guide: Thresholds & warnings
• Related references: Threshold value sets · Threshold warning levels
• Schema: thresholds.xsd