Transformation functions — temporal reshaping

This page is the generated field list for the temporal reshaping transformation functions — the families that change a series’ time step or time alignment without changing what it physically represents: running totals, resampling to a coarser or finer time step, shifting in time, rate of change, and bulk copying to a new module instance. Part of the transformation function catalogue; see that page for the shared <transformationModule>/<transformation> mechanics these all sit inside.

At a glance

Covers : accumulation (running totals), deaccumulation (undo a running total), aggregation (many values → fewer, e.g. hourly → daily), disaggregation (fewer values → many, the reverse), timeShift (shift in time), gradient (rate of change), copy (bulk-copy to a new module instance).

Used inside : A <transformation>, <periodTransformation>, or <rangeTransformation> in a transformationModule file.

Related : Transformations task guide’s “Aggregation / disaggregation” family row.

Minimal example

Config/ModuleConfigFiles/AccumulateRainfall 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<transformationModule xmlns="http://www.wldelft.nl/fews" version="1.0">
  <transformation id="CumulativeRainfall">
    <accumulation>
      <sum>
        <inputVariable>
          <timeSeriesSet>
            <moduleInstanceId>ImportObservations</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>P.obs</parameterId>
            <locationId>RainGauge_01</locationId>
            <timeSeriesType>external historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>read only</readWriteMode>
          </timeSeriesSet>
        </inputVariable>
        <outputVariable>
          <timeSeriesSet>
            <moduleInstanceId>PreProcessObservations</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>P.cumulative</parameterId>
            <locationId>RainGauge_01</locationId>
            <timeSeriesType>simulated historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>add originals</readWriteMode>
          </timeSeriesSet>
        </outputVariable>
      </sum>
    </accumulation>
  </transformation>
</transformationModule>

Field reference

Note

Nearly every concrete function type here repeats the same wrapper fields — className (which Java class runs it; leave it out and FEWS uses the default), period (optionally restrict when it runs), trimOutput, and inputVariable/outputVariable. That repetition is the schema, not a documentation artifact — the basics page explains why every function extends this shape.

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

Function <accumulation>

Element	Type	Cardinality	Description
max	AccumulationMaxComplexType	required	This transformation takes a time series, and replaces the values to the highest value, that has been observed up to that point. It ignores unreliable values. Available since 2019.02
meanInterval	AccumulationMeanIntervalComplexType	required	This transformation calculates the accumulative mean from the input time series within several intervals. The intervals are defined by the specified intervalTimeStep. For a given interval the first output value equals the first input value within the interval and the other output values are equal to the mean of the corresponding input value and all previous input values within the interval. The startTime of an interval is exclusive and the endTime of an interval is inclusive. The output time series must have the same timeStep as the input time series. The calculation starts at the first valid interval time step within the run period. Therefore the relative view period for the input and output variables must be large enough so that it contains at least one interval time step.
sum	AccumulationSumComplexType	required	This transformation creates a cumulative curve from the entire input time series. The output is one cumulative curve that starts at value 0 at the start of the run period. Each output value is the sum of the corresponding input value and all previous input values. The output time series must have the same timeStep as the input time series. In case the transformation is from instantaneous/mean to accumulated, the result is multiplied by the timestep.
sumInterval	AccumulationSumIntervalComplexType	required	This transformation creates cumulative curves from the input time series within several intervals. The intervals are defined by the specified intervalTimeStep. For a given interval the first output value equals the first input value within the interval and the other output values are equal to the sum of the corresponding input value and all previous input values within the interval. The startTime of an interval is exclusive and the endTime of an interval is inclusive. The output time series must have the same timeStep as the input time series. In case the transformation is from instantaneous/mean to accumulated, the result is multiplied by the timestep. The calculation starts at the first valid interval time step within the run period. Therefore the relative view period for the input and output variables must be large enough so that it contains at least one interval time step.
sumIntervalWithResetCondition	AccumulationSumIntervalWithResetConditionComplexType	required	This transformation creates cumulative curves from the input time series within several intervals. The intervals are defined by the specified intervalTimeStep. For a given interval the first output value equals the first input value within the interval and the other output values are equal to the sum of the corresponding input value and all previous input values within the interval. The startTime of an interval is exclusive and the endTime of an interval is inclusive. The output time series must have the same timeStep as the input time series. In case the transformation is from instantaneous/mean to accumulated, the result is multiplied by the timestep. The calculation starts at the first valid interval time step within the run period. Therefore the relative view period for the input and output variables must be large enough so that it contains at least one interval time step. The reset condition sets the curve during the calculation to zero when the cumulative value is positive or negative (depending on the condition selected)
sumOriginAtTimeZero	AccumulationSumOriginAtTimeZeroComplexType	required	Calculates the accumulation of the forecast and the accumulation of the historical data. In this context all input values before T0 are historical data and all input values after T0 are forecast data. The sum of the historical data is accumulated backwards in time starting at T0. The sum of the forecast data is accumulated forwards in time starting at T0. The output time series must have the same timeStep as the input time series. In case the transformation is from instantaneous/mean to accumulated, the result is multiplied by the timestep.

Function <deaccumulation>

Element	Type	Cardinality	Description
sum	DeAccumulationSumComplexType	required

Function <aggregation>

Element	Type	Cardinality	Description
accumulative	AggregationAccumulativeComplexType	required	Aggregates input data to output data by accumulation of the input data. This can be used to aggregate data from e.g. an hour timestep to e.g. a day timestep. For a given output time the output value equals the sum of all the input values within the aggregation period. If no aggregation period is configured, then it is equal to the period between the current output time and the previous output time. Alternatively the aggregation period can be configured in the time series set of the output variable. In that case the aggregation period is relative to the current output time and aggregation periods for different output times are allowed to overlap. Using overlapping aggregation periods it is possible to use this transformation to calculate a moving sum. Not designed for non-equidistant input data, this may result in unexpected output values
instantaneous	AggregationInstantaneousComplexType	required	Aggregates input data to output data by copying instantaneous values from input data.
instantaneousToMean	AggregationInstantaneousToMeanComplexType	required	Aggregates input data to output data by taking the mean of the input data in the aggregation period.
meanToMean	AggregationMeanToMeanComplexType	required	Aggregates input data to output data by aggregating mean data with a smaller time step to mean data with a larger time step
nonEquidistantTimeSpan	AggregationNonEquidistantTimeSpanComplexType	required	Aggregates input data to output data by aggregating data using a chosen statisticMethod and has nonequidistant output

Function <disaggregation>

Element	Type	Cardinality	Description
accumulative	DisaggregationAccumulativeComplexType	required	Disaggregation for accumulative time series
accumulativeReferencePattern	DisaggregationAccumulativeReferencePatternComplexType	required	Disaggregate using a reference pattern. For each location in the inputVariable, the same location is searched in the referencePatternVariable to get a reference pattern. The reference pattern is used for disaggregation. I.E. without the pattern, input value 6 (hourly) would disaggregate into output values 1.5, 1.5, 1.5, 1.5 (15 minutely). But with the reference pattern 0, 2, 2, 0 (15 minutely) it will disaggregate into output values 0, 3, 3, 0 (15 minutely).
constant	DisaggregationConstantComplexType	required
instantaneous	DisaggregationInstantaneousComplexType	required
meanToInstantaneous	DisaggregationMeanToInstantaneousComplexType	required
meanToMean	DisaggregationMeanToMeanComplexType	required
weights	DisaggregationWeightsComplexType	required	Disaggregate using the specified weights.
closestTimestep	DisaggregationClosestTimestepComplexType	required

Function <timeShift>

Element	Type	Cardinality	Description
constant	TimeShiftConstantComplexType	required	Function to shift time series data by a fixed number of time steps. Note: this transformation produces output only for the relative view period of the output variable. In other words, input values that are shifted outside the output period will be lost. To avoid this, make the output period large enough to contain all the shifted input data values. Note that a negative shift forward in time is the same as a positive shift backward in time.
referenceDateTime	TimeShiftReferenceDateTimeComplexType	required	Function to shift time series data by a fixed number of time steps, using a fixed absolute reference date time. The number of time steps to shift, is determined as follows: periodToShift = T0 - referenceDateTime. Where T0 is the timeZero of the workflow in which this transformation runs. If T0 and/or referenceDateTime are not valid times according to the output timeStep, then they are rounded to the nearest valid times. The specified direction determines whether the shift is applied toward T0, or toward the referenceDateTime. This transformation can be used to shift values from the configured referenceDateTime to T0, or from T0 to the referenceDateTime. Note: this transformation produces output only for the relative view period of the output variable. In other words, input values that are shifted outside the output period will be lost. To avoid this, make the output period large enough to contain all the shifted input data values.
length	TimeShiftLengthComplexType	required	For a given time in the outputVariable series and inputVariable series (inputVariable and outputVariable must have the same times), this function searches for the nearest time (in forward, backward or both of these directions) in the lookupVariable series. The result is the difference between the nearest time found in the lookupVariable series and the time in the inputVariable series, rounded to seconds.
variable	TimeShiftVariableComplexType	required	Shift input time series in time using shifts defined in another time series. For each entry in the input variable, it looks for a value in the shiftValues variable that shared the same time. This value represents the amount of seconds the input value will be shifted. Example: Let's say the 3 variables all have a 1 second timestep and the first value for each variable is at the same time. The values are as follows: input [5, 3, 12, 2], timeshift [0, 1, 0, -2], output [ , , , ]. This is what the output variable would look like after processing the first element from the input variable: [5, , , ], after 2nd [5, , 3, ] after 3rd [5, , 12, ] and after 4th [5, 2, 12, ].

Function <gradient>

Element	Type	Cardinality	Description
firstOrder	FirstOrderGradientComplexType	required	Calculation of the gradient of a timeserie: (y1-y0)/(t1-t0)

Function <copy>

Element	Type	Cardinality	Description
newModuleInstance	CopyNewModuleInstanceComplexType	required	Since 2025.02. Copies many time series at once to time series with a different module instance. It uses a time series filter instead of time series set, this way many different parameters and qualifiers sets can be selected at once.

AccumulationMaxComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AccumulationMeanIntervalComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
intervalTimeStep	TimeStepComplexType	required	This time step defines the intervals that are used for the accumulation. Each time in this time step is the boundary between two intervals. The calculation starts at the first valid interval time step within the run period. Therefore the relative view period for the input and output variables must be large enough so that it contains at least one interval time step.
ignoreMissing	boolean	optional	If true, then missing values are ignored. If false, then output values will be set to missing values starting from the first missing input value in an interval until the end of that interval. Default is true.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AccumulationSumComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
ignoreMissing	boolean	optional	If true, then missing values are ignored and treated as 0. If false, then output values will be set to missing values starting from the first missing input value. Default is true.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AccumulationSumIntervalComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
preCalculatedInputVariable	InputVariableComplexType	optional	Input variable which contains values that can immediatly be written to the output, the accumulation can then continue from the last available time step. This can save loading lots of data and calculating output values that have been calculated and written before.
intervalTimeStep	TimeStepComplexType	required	This time step defines the intervals that are used for the accumulation. Each time in this time step is the boundary between two intervals. The calculation starts at the first valid interval time step within the run period. Therefore the relative view period for the input and output variables must be large enough so that it contains at least one interval time step.
ignoreMissing	boolean	optional	If true, then missing values are ignored and treated as 0. If false, then output values will be set to missing values starting from the first missing input value in an interval until the end of that interval. Default is true.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AccumulationSumIntervalWithResetConditionComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
intervalTimeStep	TimeStepComplexType	required	This time step defines the intervals that are used for the accumulation. Each time in this time step is the boundary between two intervals. The calculation starts at the first valid interval time step within the run period. Therefore the relative view period for the input and output variables must be large enough so that it contains at least one interval time step.
resetCondition	resetConditionTypeEnumStringType	required	During the calculation, if the cumulative value is either positive or negative (depending on condition chosen), it is set to zero. This zero value will then be used to base the next cumulative value on. i.e. If resetCondition is set to negative, the serie 4,-3,-3,1,2 would result in 4,1,0,1,3 and NOT 4,1,0,0,1 One of: positive, negative
ignoreMissing	boolean	optional	If true, then missing values are ignored and treated as 0. If false, then output values will be set to missing values starting from the first missing input value in an interval until the end of that interval. Default is true.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AccumulationSumOriginAtTimeZeroComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
ignoreMissing	boolean	optional	If true, then missing values are ignored and treated as 0. If false, then output values will be set to missing values starting from the first missing input value. Default is true.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DeAccumulationSumComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with the time series which
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AggregationAccumulativeComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
outputVariable	OutputVariableComplexType	required	Output variable. The time step of this output variable is used as the period to aggregate values over.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
validationRule	ValidationRuleComplexType	optional · repeats	Since 2013.01. FEWS-8586

AggregationInstantaneousComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
outputVariable	OutputVariableComplexType	required	Output variable. The time step of this output variable is used as the period to aggregate values over.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

AggregationInstantaneousToMeanComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
includeFirstValueOfAggregationPeriodInCalculation	boolean	optional
outputVariable	OutputVariableComplexType	required	Output variable. The time step of this output variable is used as the period to aggregate values over.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
allowMissingValues	boolean	optional
validationRule	ValidationRuleComplexType	optional · repeats	Since 2013.01. FEWS-8586

AggregationMeanToMeanComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
outputVariable	OutputVariableComplexType	required	Output variable. The time step of this output variable is used as the period to aggregate values over.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
ignoreMissings	boolean	required	Default is false
validationRule	ValidationRuleComplexType	optional · repeats	Since 2013.01. FEWS-8586

AggregationNonEquidistantTimeSpanComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
includeMissingValues	boolean	optional	If true, then missing values count towards the total number of values. If false missing values are ignored.
statisticMethod	statisticsEnumStringType	required	One of: max, min, mean, sum
aggregationTimespan	TimeSpanComplexType	required
outputVariable	OutputVariableComplexType	required	Output variable. The time step of this output variable is used as the period to aggregate values over.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationAccumulativeComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with the time series which
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationAccumulativeReferencePatternComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable that is to be disaggregated.
referencePatternVariable	InputVariableComplexType	required	Variable from which the pattern is used for disaggregation.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationConstantComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with larger time steps, the values of which should be copied into several smaller timesteps.
outputVariable	OutputVariableComplexType	required	Output variable with smaller time steps.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationInstantaneousComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with the time series which
interpolate	boolean	optional
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationMeanToInstantaneousComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with the time series which
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationMeanToMeanComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with the time series which
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationWeightsComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
weight	float	required · repeats	Weights used for disaggregation.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

DisaggregationClosestTimestepComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable with the time series to b disaggregated.
fillGaps	boolean	optional	When true, allows filling in gaps in the input arrays when creating the disaggregated output. To fill gaps, the value will be copied from the closest closest (in time) timestep that doe not have a missing value.
fillGapTimeSteps	int	optional	Set the maximum number of input timesteps to traverse when looking for a non-missing value to use for filling in gaps. The default value is 1, resulting in a maximum input gap size of 2 timesteps.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

TimeShiftConstantComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
moduleParameterFile	nameStringType	optional	reference to a module parameter file which can be modified in the mods-display
inputVariable	InputVariableComplexType	required	Input variable.
moduleParameterFile	nameStringType	optional	reference to a module parameter file which can be modified in the mods-display
direction	timeShiftDirectionEnumStringAttributeType	optional	Direction can be "forward" or "backward". This can also be a reference to a location attribute between '@' signs. The referenced location attribute must contain a valid direction.
numberOfTimeSteps	intStringAttributeAndPropertyType	optional	Integer number of time steps to shift input time series. This can also be a reference to a location attribute between '@' signs. The referenced location attribute must contain an integer.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

TimeShiftReferenceDateTimeComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
referenceDateTime	DateTimeStringComplexType	required	The number of time steps to shift, is determined as follows: periodToShift = T0 - referenceDateTime. Where T0 is the timeZero of the workflow in which this transformation runs. If T0 and/or referenceDateTime are not valid times according to the output timeStep, then they are rounded to the nearest valid times.
direction	timeShiftReferenceDateTimeDirectionEnumStringType	required	Direction can be "toward_time_zero" or "toward_reference_date_time". This indicates the direction of the shift in time. One of: toward_time_zero, toward_reference_date_time
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

TimeShiftLengthComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
lookupVariable	InputVariableComplexType	required	Variable used to lookup the nearest time step.
lookupDirection	timeShiftLengthLookupDirectionEnumStringType	required	Search for nearest time step in forward, backward or both of these directions. One of: forward, backward, any
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

TimeShiftVariableComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputVariable	InputVariableComplexType	required	Input variable.
shiftValuesVariable	InputVariableComplexType	required	Variable that contains for each time step the time shift to shift that time step over.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

FirstOrderGradientComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
moduleParameterFile	nameStringType	optional	reference to a module parameter file which can be modified in the mods-display
inputVariable	InputVariableComplexType	required	Input variable.
outputVariable	OutputVariableComplexType	required	Output variable.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.

CopyNewModuleInstanceComplexType

Element	Type	Cardinality	Description
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
period	TransformationRunPeriodComplexType	optional	This element can be used to configure the run period of the transformation.
trimOutput	trimOutputEnumStringType	optional	When true missing values at the start and end of the output will be removed before writing the data to the database. This can prevent existing values to be overwritten with missings. One of: true, false, startOnly, endOnly
inputTimeSeries	TimeSeriesFilterComplexType	required	Input filter which results in all time series existing which match the filter.
outputModuleInstanceId	idStringType	required	Module instance id used in output to overrule the module instance id of input time series and create new unique output time series
includeUnreliableInputValues	boolean	optional	Default false. When true, unreliable values in the input will not be ignored.
className	nameStringType	optional	Optional element to define the name of the class that should be executed to perform this transformation. Normally this element can be left out of the xml configuration, and the default class name will be used. This default class name is defined as the default value for this element in the xsd schema for this transformation. Only use this element if you need to use a custom class that is present in the program code.
aggregateQualifierGroup	idStringType	required · repeats	Qualifier group for which all input time series should be combined into one
qualifierAggregation	qualifierAggregationStringType	required	Calculation method used to aggregate the input time series when multiple input time series with qualifiers from the aggregateQualifierGroups are combined into one output time series.
inputSampleIdPostFix	nonEmptyStringType	optional	Postfix of input sample id which will be stripped off the end of the input sample id before adding a postfix
outputSampleIdPostFix	nonEmptyStringType	required	Non empty text to add to input sample id to create new output sample id

TransformationRunPeriodComplexType

Element	Type	Cardinality	Description
relativePeriod	RelativePeriodComplexType	required
cardinalTimeStep	TimeStepComplexType	required	Aligns the start and end time of the run period of the transformation with this time step.
extendStart	boolean	required	Determines whether the start of the run period of the transformation should be extended or cropped to match the cardinal time step
extendEnd	boolean	required	Determines whether the end of the run period of the transformation should be extended or cropped to match the cardinal time step
startMonthDay	monthDayType	required
endMonthDay	monthDayType	required

InputVariableComplexType

Choose between a reference to a variable or an embedded definition of a variable.

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.

OutputVariableComplexType

Choose between a reference to a variable or an embedded definition of a variable.

Element	Type	Cardinality	Description
variableId	idStringType	required	Identifier of a variable to use.
locationId	idStringType	optional	If the specified variable contains multiple locations, then specify the location to use here.
timeSeriesSet	TimeSeriesSetComplexType	required	A time series set that can be used as input or as output for a transformation function.
convertDatum	boolean	optional	If true, then this time series is converted from local to ordnance datum level before a transformation and back to local datum level after the transformation. Default is false.
checkMissing	boolean	optional	Option to check this timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing', which can be set for a parameter in the parameters.xml configuration file. If for a given parameter allowMissing is false and checkMissing is true, then the transformation throws an exception when there are missing values for this parameter. When omitted defaults to 'false'. For grid data this option only checks whether the entire grid contains missing values or not, i.e. individual cells can still have missing values as long as there are other cells with non-missing values in the grid for the same time step.

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.

ValidationRuleComplexType

Element	Type	Cardinality	Description
minimumInputValuesCount	intStringAttributeType	optional	Only works for non-equidistant data. When there are less than the minimum number of input values available the validation rule is not considered valid.
inputDoubtfulPercentage	floatStringAttributeType	optional
inputMissingPercentage	floatStringAttributeType	optional
outputValueFlag	validationRuleFlagEnumStringType	required	One of: missing, doubtful, reliable
outputCustomFlagSourceId	idStringType	optional

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

DateTimeStringComplexType

Attributes

Attribute	Use	Notes
date	required
time	optional

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

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

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

Gotchas

• accumulation vs aggregation are easy to conflate: accumulation produces a running/cumulative curve at the same time step as the input (each output value is the running total so far); aggregation changes the time step itself (e.g. hourly sums rolled up into daily totals via accumulative). Reach for aggregation when you actually want fewer, coarser output values.
• disaggregation needs a reference for shape, not just a target time step — accumulativeReferencePattern, weights, and friends each define how to spread one coarse value across finer time steps; picking the wrong variant silently produces a flat (or badly shaped) disaggregation rather than an error.
• timeShift constant only shifts, it doesn’t extrapolate — per its own schema annotation, it produces output only for the overlap between the shifted input and the output series’ own time span. Don’t expect it to invent values beyond the input’s range.
• copy newModuleInstance (since 2025.02) is for bulk-copying many matching series at once via a filter (inputTimeSeries), not a single series — if you only need one series under a new module instance, a variable/outputVariable rename elsewhere is simpler.

See also

• Reference: Transformation functions — basics
• Task guide: Transformations
• Schema: transformationTypes.xsd