Threshold value sets file

The schema-companion to the Thresholds & warnings task guide. Thresholds span three files; this one — where the numbers live and bind to real data — is the one you edit most. This page is the generated field list.

At a glance

Purpose : Assigns threshold values (e.g. minor/major flood levels) to a specific location/parameter series, referencing the warning levels and threshold slots defined in the other threshold files.

Folder : Config/RegionConfigFiles/

Root element : <thresholdValueSets> (no version attribute — unlike most region-config files)

Depends on : The Thresholds and ThresholdWarningLevels files (for the ids it references) and the stored series its timeSeriesSet binds to.

Minimal example

Config/RegionConfigFiles/ThresholdValueSets 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<thresholdValueSets xmlns="http://www.wldelft.nl/fews">
  <thresholdValueSet id="Flood_Discharge" name="Discharge flood levels">
    <levelThresholdValue>
      <levelThresholdId>MinorFlood</levelThresholdId>
      <value>250</value>
      <label>Minor flood</label>
    </levelThresholdValue>
    <timeSeriesSet>
      <moduleInstanceId>ImportObservations</moduleInstanceId>
      <valueType>scalar</valueType>
      <parameterId>Q.obs</parameterId>
      <locationSetId>AllDischargeGauges</locationSetId>
      <timeSeriesType>external historical</timeSeriesType>
      <timeStep unit="hour" multiplier="1"/>
      <readWriteMode>read only</readWriteMode>
    </timeSeriesSet>
  </thresholdValueSet>
</thresholdValueSets>

Tip

levelThresholdId points back to a slot defined in the Thresholds file; value is in the parameter’s stored unit; the timeSeriesSet says which series the values apply to. See the task guide for the three-file split.

Field reference

Note

This is a large type — threshold value sets support many value kinds (level, rate, max, event, rating-curve-derived, aggregation). The full graph is below; in practice you use a small subset (usually levelThresholdValue + timeSeriesSet).

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

Element <thresholdValueSets>

Element	Type	Cardinality	Description
thresholdValueSet	ThresholdValueSetComplexType	required · repeats	One or more thresholdValueSets to define which of the available thresholds should be evaluated for which combinations of locations and parameters.
eventTimeViewPeriod	RelativePeriodComplexType	optional	Since 2017.02. View period for showing threshold events in the Threshold Events display. Uses FEWS system time to construct absolute view period.

ThresholdValueSetComplexType

contains level- and/or rate- and/or max-thresholds set for a given time series

Attributes

Attribute	Use	Notes
id	required
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description for the ThresholdValueSet. Used for reference purposes only.
considerQualifiers	boolean	optional	Since 2016.01 #67260. Default = true. If set to false, qualifiers are ignored when matching threshold value rule sets to time series. When set to false it is no longer possible to generate threshold events using the ThresholdCrossingModule. The explorer and time series dialog will work with this option
standDownIndividualLocations	boolean	optional	By default observation stand-down events are only issued when all locations of the same ThresholdValueSet are stood down. To issue stand down events even if other locations are in enhanced mode set this option to 'true'. This cannot be used in combination with SystemAlert triggers linked to enhanced forecasts, but it can be used to triggers linked to sending email messages.
locationAttributeId	idStringType	optional · repeats	Location attribute ids for which the values should be added to the threshold log messages
graceTime	TimeSpanComplexType	optional	To avoid numerous rate thresholds being issued during a period of heavy rain the graceTime period can be configured. After an initial threshold crossing for a given timeseries no further crossings will be issued for the duration of the graceTime period. Only if the timeseries crosses the next threshold level, an event will be issued.
stage	stageOrDischargeComplexType	required	Threshold values and time series that are in units of stage.
discharge	stageOrDischargeComplexType	required	Threshold values and time series that are in units of discharge.
forecastAvailableThresholdValue	ForecastAvailableValueComplexType	optional	If a threshold crossing event is measured for a given observed parameter, then the thresholdEventCrossing module logs whether or not there is a forecast run available for the corresponding forecast parameter, within a given relative time period. This information is used in the ThresholdSkillScoreDisplay.
ratingCurveLocationId	idStringType	optional	When specified the rating curve available at this location is used instead of the location from the time series set.
ratingCurveQualifierId	idStringType	optional · repeats	One or more qualifier ids the used rating curve should have all
forecastAvailableThresholdValue	ForecastAvailableValueComplexType	optional	If a threshold crossing event is measured for a given observed parameter, then the thresholdEventCrossing module logs whether or not there is a forecast run available for the corresponding forecast parameter, within a given relative time period. This information is used in the ThresholdSkillScoreDisplay.
timeSeries	TimeSeriesFilterComplexType	required · repeats	Define one or more time series to filter the time series sets for which the threshold values in this thresholdValueSet will be used. Please note that only time series with value type scalar or sample will be considered.
timeSeriesSet	TimeSeriesSetComplexType	required · repeats	Define one or more time series sets for which the threshold values in this thresholdValueSet will be used.
unit	string	optional	Specify when the unit given for the values is not the same as the (internally stored) unit of the parameter it applies to. When specified it is required to also specify configUnitConversionsId in Parameters.xml. In this unit conversions the conversion from the specified unit to the (internal) unit should be available
rateThresholdValue	RateThresholdValueComplexType	optional · repeats	Specific values for rate thresholds.
maxThresholdValue	MaxThresholdValueComplexType	optional · repeats	Specific values for max thresholds.
eventThresholdValues	EventThresholdValuesComplexType	optional · repeats	Specific values based on events
levelThresholdValue	LevelThresholdValueComplexType	required · repeats	Specific values for level thresholds.
aggregationLevelThresholdValues	AggregationLevelThresholdValuesComplexType	required · repeats	Specific values for level thresholds. This contains one or more level threshold values for different aggregation periods.
stageDischargeConversion	StageDischargeConversionComplexType	required	since 2010.01, for NEW style rating curve types. Used when stages are specified for the threshold levels and there are discharges in (some of) the specified time series sets.
dischargeStageConversion	DischargeStageConversionComplexType	required	since 2010.01, for NEW style rating curve types. Used when discharges are specified for the threshold levels and there are stages in (some of) the specified time series sets.
ratingCurve	RatingCurveMappingComplexType	required	For OLD style rating curve types. Convert the threshold levels from stage to discharge or vice versa using the rating curve defined here.

RelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time.

Attributes

Attribute	Use	Notes
start	required
end	required
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.
unit	required

Elements

Element	Type	Cardinality	Description
description	string	optional

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

stageOrDischargeComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required · repeats	Define one or more time series sets for which the threshold values in this thresholdValueSet will be used. Please note that the config unit conversion specified here is ignored if no discharge timeSeriesSets are specified here.
unit	string	optional	Specify when the unit given for the values is not the same as the (internally stored) unit of the parameter it applies to. When specified it is required to also specify configUnitConversionsId in Parameters.xml. In this unit conversions the conversion from the specified unit to the (internal) unit should be available
rateThresholdValue	RateThresholdValueComplexType	optional · repeats	Specific values for rate thresholds.
maxThresholdValue	MaxThresholdValueComplexType	optional · repeats	Specific values for max thresholds.
eventThresholdValues	EventThresholdValuesComplexType	optional · repeats	Specific values based on events
levelThresholdValue	LevelThresholdValueComplexType	required · repeats	Specific values for level thresholds.
aggregationLevelThresholdValues	AggregationLevelThresholdValuesComplexType	required · repeats	Specific values for level thresholds. This contains one or more level threshold values for different aggregation periods.

ForecastAvailableValueComplexType

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

Element	Type	Cardinality	Description
forecastAvailableThresholdId	idStringType	required
description	string	optional
periodBegin	RelativeTimeComplexType	required
periodEnd	RelativeTimeComplexType	required
parameterPairs	ParameterPairComplexType	required · repeats

TimeSeriesSetComplexType

Attributes

Attribute	Use	Notes
id	optional
name	optional

Elements

Element	Type	Cardinality	Description
description	string	optional
valueType	timeSeriesValueTypeStringType	required
parameterId	idStringType	required
domainParameterId	idStringType	optional · repeats	For a spectrum specify the frequency / wave length parameter. For a directional spectrum specify first the frequency parameter and secondly the directional parameter
qualifierId	idStringType	optional · repeats	Id that references an qualifier listed in the regionConfigFiles/Qualifiers.xsd
timeSeriesType	timeSeriesTypeStringType	required
timeStep	TimeStepComplexType	required
aggregationPeriod	RelativePeriodComplexType	optional	The value at a time represents the aggregated value over the aggregation period e.g when the aggregation period is -6 to 0 hour the value at 13:00 represents an aggregation (e.g. moving average) from 7:00 till 13:00 (including)
cycle	CalendarTimeSpanComplexType	optional	If cycle specified, then the data is repeated periodically with this cycle as the period length. There is original data for only one cycle. After that cycle the data will be repeated periodically. In other words, when cycle is defined, then a missing value is filled up with a value from the last available cycle before the missing value.
externalForecastSearchTimeStep	TimeStepComplexType	optional	Since 2024.01. Only time series with an external forecast time that match this time step are visible while searching
externalForecastTimeCardinalTimeStep	TimeStepComplexType	optional	When no external forecast exists in the data store younger that the specified age a new external forecast is returned with a minimum age that applies to the specified cardinal time step
qualifierAggregation	qualifierAggregationStringType	optional	When specified all the time series that have ALL the specified qualifiers are aggregated to a single time series on read. Can not be specified when this time series set is meant for writing
readWriteMode	timeSeriesReadWriteModeStringType	required	Note: this readWriteMode is only used in the TimeSeriesDisplay. Other modules ignore this readWriteMode.
synchLevel	intStringType	optional
expiryTime	CalendarTimeSpanComplexType	optional
delay	TimeShiftComplexType	optional
multiplier	floatStringType	optional
divider	floatStringType	optional
incrementer	floatStringType	optional
ensembleId	idStringType	optional	Optional field for running ensembles. Ensemble id's in a time series set will override ensemble id's defined in the workflow.
visibilityControllingFlagSourceColumnId	idStringType	optional	All values that not passed this validation step are removed on read. Set to missing for equidistant and removed for non-equidistant
onlyReliableFlagSourceColumnId	idStringType	optional	Since 2022.02. All values that passed this validation step and are reliable will be included other will be set to missing for equidistant and removed for non-equidistant. This will work as an "or" operation together with "visibilityControllingFlagSourceColumnId", so data should either have passed "visibilityControllingFlagSourceColumnId" or "onlyReliableFlagSourceColumnId".
locationRelationId	idStringType	required	Relation id to map the time series set locations to related locations. Instead of the time series set locations the related locations are used to read/write the time series.
skipLocationsWithoutRelation	boolean	optional	Since 2020.01 When true locations that do not have a related location will be skipped, when false all location must have a related location. Default is false
moduleInstanceId	idStringType	required · repeats
moduleInstanceSetId	idStringType	required	Query a single module instance in the data store that is available for this time series set
filterModuleInstanceSetId	idStringType	required	Query all module instances in the data store that are available for this time series set
locationId	idStringType	required · repeats
locationSetId	idStringType	required
chainageLocationSetId	idStringType	required	Id of location set which represents a chainage of locations. This can only be used in combination with readWriteMode readOnly
relativeViewPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative the time 0 of the workflow or the system time of the fews explorer
relativeForecastPeriod	TimeSeriesSetRelativePeriodComplexType	optional	Period relative to first time of a simulated or external forecast time series
ensembleMemberId	nonEmptyStringType	required · repeats	Optional field used for reading or writing one or more particular ensemble member
ensembleMemberIndex	nonNegativeIntegerStringType	required	Optional field used for reading or writing one particular ensemble member
ensembleMemberIndexRange	EnsembleMemberIndexRangeComplexType	required	Optional field used for reading or writing one particular sub set of the ensemble
relativeForecastSearchPeriod	TimeSeriesSetRelativePeriodComplexType	required	Since 2015.02. The latest available external forecast in this period will be read. By default the latest before time0 is returned
externalForecastTimeId	idStringType	required	Since 2018.01. Forecast time reference id configured in the forecast length estimator config. Can only be used in workflows and only after the forecast length estimator.
externalForecastMinAge	TimeSpanComplexType	optional	Since 2014.02. By default is there is no minimum age. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0
externalForecastMaxAge	TimeSpanComplexType	optional	By default is there is no maximum age so the returned external forecast can be very old when there is no recent forecast available. All external forecasts after the time0 are ignored. The age of an external forecast is defined as the time span between the external forecast time and the time 0

RateThresholdValueComplexType

contains rate threshold value

Element	Type	Cardinality	Description
rateThresholdId	idStringType	required	ID of the rate threshold type, as it is specified in the file thresholds
description	string	optional
upActionLogEventTypeId	string	optional	ID of the action message (=additional log.message) that must be logged if threshold value is crossed UP. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Up". The event code need not be unique.
downEventTypeId	string	optional	ID of the action message (=additional log.message) that must be logged if threshold value is crossed DOWN. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Down". The event code need not be unique.
timeSpan	TimeSpanComplexType	required	This time span will be used in the computation of the rate of change. Rate of change = (change within timeSpan) / timeSpan.
relativeViewPeriod	RelativePeriodComplexType	optional	Relative view period to be used for this specific threshold. Use this when no relative view period configured in the time series sets
rainRate	boolean	optional	If rainRate is true, then the input time series is accumulated before the rate of change is computed.
visibleInEventsDisplay	boolean	optional	Since 2017.02. Option to toggle the visibility of the level in the Threshold Events display.
value	float	required	Value of the rate threshold. This is the change within timeSpan where timeSpan is the timeSpan configured below. Rate of change = (change within timeSpan) / timeSpan.
valueFunction	string	required	Location dependent threshold value by using a function with location attributes. eg. @FLOOD_WATCH@. When an attribute is missing for a location the threshold value is invisible/ignored for that location
label	string	required	Optional label.
labelFunction	string	required	Optional location dependent label that is specified by a function, e.g. "@FLOOD_WATCH@", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then the label is ignored for that location.

MaxThresholdValueComplexType

contains max threshold value

Element	Type	Cardinality	Description
maxThresholdId	idStringType	required	ID of the max threshold type, as it is specified in the file thresholds
description	string	optional
actionLogEventTypeId	idStringType	optional	ID of the action message (=additional log.message) that must be logged if threshold value is exceeded. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Max". The event code need not be unique.
timeSpan	TimeSpanComplexType	required	If two peaks fall have a distance that is less then the defined timeSpan, only the first peak will be reported.
visibleInEventsDisplay	boolean	optional	Since 2017.02. Option to toggle the visibility of the level in the Threshold Events display.
value	float	required	max threshold value
valueFunction	string	required	Location dependent threshold value by using a function with location attributes. eg. @FLOOD_WATCH@. When an attribute is missing for a location the threshold value is invisible/ignored for that location
label	string	required	Optional label.
labelFunction	string	required	Optional location dependent label that is specified by a function, e.g. "@FLOOD_WATCH@", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then the label is ignored for that location.

EventThresholdValuesComplexType

Contains event threshold values. Especially designed for multi valued attributes. The used attribute functions should all have the same amount of values

Element	Type	Cardinality	Description
eventThresholdId	idStringType	required	ID of the event threshold type, as it is specified in the file thresholds
description	string	optional
valueFunction	string	required	Location dependent threshold value by using a function with location attributes. eg. @FLOOD_WATCH@. When an attribute is missing for a location the threshold value is invisible/ignored for that location. Especially designed for multi valued attributes.
labelFunction	string	required	Optional location dependent label that is specified by a function, e.g. "@FLOOD_WATCH@", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then the label is ignored for that location. Especially designed for multi valued attributes.
parameterIdFunction	idStringType	optional	Function to determine which parameter is used in the events
warningAreaIdFunction	idStringType	optional	Function to determine which location id's should be used as warning area's. Especially designed for multi valued attributes.
enabledFunction	idStringType	required	Boolean which specifies whether the event should be included. Especially designed for multi valued attributes.

LevelThresholdValueComplexType

contains level threshold value

Element	Type	Cardinality	Description
toolTip	nonEmptyStringType	optional	Since 2015.02 Tooltip to be displayed in the TimeSeriesDisplay plot while pointing to the threshold line. The tooltip supports html . Use the CDATA xml tag to include html in a xml file. You can configure location dependent toolTip that is specified by a function, e.g. '@FLOOD_WATCH_INFO@' (similar to the labelFunction)
targetLocationIdFunction	string	optional	Location dependent text value that points to an id of a different location that is effected by this threshold crossing @TARGET_LOCATION_ID@
warningArea	nonEmptyStringType	optional · repeats	One or more warnings that correspond to this threshold for the configured timeSeriesSet(s). These warningAreas are e.g. used in the ThresholdOverviewDisplay threshold crossing counts tabs.
visibleInEventsDisplay	boolean	optional	Since 2017.02. Option to toggle the visibility of the level in the Threshold Events display.
levelThresholdId	idStringType	required	ID of the level threshold type, as it is specified in the file thresholds
levelThresholdIdFunction	string	required	Location dependent threshold id by using a function with location attributes. eg. @THRESHOLD_ID@
description	string	required	Optional description.
descriptionFunction	string	required	Optional location dependent description that is specified by a function, e.g. "@FLOOD_WATCH@", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then the description is ignored for that location.
comment	string	required	Optional comment.
commentFunction	string	required	Since 2020.02, Optional location dependent comment that is specified by a function.
value	float	required	level threshold value
valueFunction	string	required	Location dependent threshold value by using a function with location attributes. eg. @FLOOD_WATCH@. When an attribute is missing for a location the threshold value is invisible/ignored for that location.
label	string	required	Optional label.
labelFunction	string	required	Optional location dependent label that is specified by a function, e.g. "@FLOOD_WATCH@", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then the label is ignored for that location.
upActionLogEventTypeId	string	required	ID of the action message (=additional log.message) that must be logged if a threshold value is crossed UP. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Up". The event code need not be unique.
upActionLogEventTypeIdFunction	string	required	ID of the action message (=additional log.message) that must be logged if a threshold value is crossed UP. This id has to contain a dot, because the action eventis only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Up". The event code need not be unique.
downActionLogEventTypeId	string	required	ID of the action message (=additional log.message) that must be logged if a threshold value is crossed DOWN. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Down". The event code need not be unique.
downActionLogEventTypeIdFunction	string	required	ID of the action message (=additional log.message) that must be logged if a threshold value is crossed DOWN. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Down". The event code need not be unique.

AggregationLevelThresholdValuesComplexType

Element	Type	Cardinality	Description
levelThresholdId	idStringType	required	ID of the level threshold type, as it is specified in the file thresholds
description	string	optional
toolTip	nonEmptyStringType	optional	Since 2015.02 Tooltip to be Since 2015.02 Tooltip to be displayed in the TimeSeriesDisplay plot while pointing to the threshold line. The tooltip supports html . Use the CDATA xml tag to include html in a xml file. You can configure location dependent toolTip that is specified by a function, e.g. '@FLOOD_WATCH_INFO@' (similar to the labelFunction)
warningArea	nonEmptyStringType	optional · repeats	One or more warnings that correspond to this threshold for the configured timeSeriesSet(s). These warningAreas are e.g. used in the ThresholdOverviewDisplay threshold crossing counts tabs.
upActionLogEventTypeId	string	optional	ID of the action message (=additional log.message) that must be logged if a threshold value is crossed UP. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Up". The event code need not be unique.
downActionLogEventTypeId	string	optional	ID of the action message (=additional log.message) that must be logged if a threshold value is crossed DOWN. This id has to contain a dot, because the action event is only visible to the master controller if this id contains a dot, e.g. "Threshold_Name.Down". The event code need not be unique.
visibleInEventsDisplay	boolean	optional	Since 2017.02. Option to toggle the visibility of the level in the Threshold Events display.
timeSpanValue	AggregationTimeSpanValueComplexType	required · repeats	One or more level threshold values for different aggregation periods. If this threshold value set is used for a time series without an aggregation period, then the timeStep of that time series is used as aggregation period. If a value for the aggregation period of a time series is not configured here, then these threshold values are ignored for that time series.
timeSpanValueFunction	AggregationTimeSpanValueFunctionComplexType	required · repeats	One or more level threshold values for different aggregation periods. If this threshold value set is used for a time series without an aggregation period, then the timeStep of that time series is used as aggregation period. If a value for the aggregation period of a time series is not configured here, then these threshold values are ignored for that time series. Here the value elements can be function expressions, e.g. "@N@ / 1000", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The expression is evaluated when the configuration is read, by replacing the tags with actual values. These values can be different for different locations. When an attribute is missing for a location the threshold value is invisible/ignored for that location.
label	string	required	Optional label.
labelFunction	string	required	Optional location dependent label that is specified by a function, e.g. "@FLOOD_WATCH@", in which tags between "@" signs refer to location attributes that are defined in the locationSets config file. The tags are replaced by actual attribute values. These attribute values can be different for different locations. If an attribute is missing for a location, then the label is ignored for that location.

StageDischargeConversionComplexType

Element	Type	Cardinality	Description
dischargeParameterId	idStringType	required · repeats	Discharge parameters for which the threshold values should be converted from stage to discharge.
ratingCurveLocationId	idStringType	optional	When specified the rating curve available at this location is used instead of the location from the time series set.
ratingCurveQualifierId	idStringType	optional · repeats	One or more qualifier ids the used rating curve should have all

DischargeStageConversionComplexType

Element	Type	Cardinality	Description
stageParameterId	idStringType	required · repeats	Stage parameters for which the threshold values should be converted from discharge to stage
ratingCurveLocationId	idStringType	optional	When specified the rating curve available at this location is used instead of the location from the time series set.
ratingCurveQualifierId	idStringType	optional · repeats	One or more qualifier ids the used rating curve should have all

RatingCurveMappingComplexType

Element	Type	Cardinality	Description
id	idStringType	required	Rating curve id to use for threshold mapping.
ratingCurveType	RatingCurveTypeEnumStringType	required	Type of rating curve One of: LevelToFlow, FlowToLevel
parameterId	idStringType	required · repeats	Parameter ids of the time series sets for which the conversion should take place.

RelativeTimeComplexType

Defines a time relative to T0.

Attributes

Attribute	Use	Notes
value	required
unit	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description with additional comments. This is never used in the code.

ParameterPairComplexType

Attributes

Attribute	Use	Notes
parameterIdObs	required
parameterIdFor	required

TimeStepComplexType

Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone], times+[timeZone] + monthDays+[timeZone] ([]=optional)

Attributes

Attribute	Use	Notes
id	optional	Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml. Only specify the id attribute when referring to a predefined time step. In the regionConfig/timeSteps.xml the time steps list both the id and the attributes that define the time step
label	optional	Short name for the time step which is shown to the user when he can choose one from a list.
unit	optional
divider	optional
multiplier	optional
times	optional	Defines the time step by a list of times without dates, e.g. "10:00 23:00"
minutes	optional	Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc.
daysOfMonth	optional	Defines the time step by a list of days of month, use "01 11 21" for a decade time step
monthDays	optional	Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for the meteorological seasons
timeZone	optional

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description of this timeStep. This is not used and is only present for convenience.

CalendarTimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeShiftComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

TimeSeriesSetRelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time. When the start time is not specified it is determined by the start time of the state of the current run. When the start is overrulable the time is overruled by the start of search period or the start of cold state run when one of two is specified When the end is overrulable this time is overruled by the end of the forecast when specified

Attributes

Attribute	Use	Notes
unit	required
start	optional	e.g. -1 hour means one before time 0
end	required	e.g. 1 hour means one hour after time 0
startOverrulable	optional	default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable	optional	default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.

Elements

Element	Type	Cardinality	Description
description	string	optional

EnsembleMemberIndexRangeComplexType

Attributes

Attribute	Use	Notes
start	required
end	optional

AggregationTimeSpanValueComplexType

Attributes

Attribute	Use	Notes
value	required	Threshold value for this aggregation timeSpan.
unit	required
divider	optional
multiplier	optional

AggregationTimeSpanValueFunctionComplexType

Attributes

Attribute	Use	Notes
value	required	Threshold value for this aggregation timeSpan.
unit	required
divider	optional
multiplier	optional

See also

• Task guide: Thresholds & warnings
• Filters & display groups — thresholds are drawn on these displays
• Schema: thresholdValueSets.xsd