Export module file

The schema-companion to the Export data task guide. Export is the mirror of import; this page is the generated field list.

At a glance

Purpose : Reads internal series and writes them out to a file/service/database, renaming via ID map on the way out (hop ⑤, reverse boundary).

Folder : Config/ModuleConfigFiles/

Root element : <timeSeriesExportRun> (no version attribute — a module-run file)

Depends on : An idMap (applied internal → external) and the series it reads.

Minimal example

Config/ModuleConfigFiles/ExportDischarge 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<timeSeriesExportRun xmlns="http://www.wldelft.nl/fews">
  <export>
    <general>
      <exportType>generalCsv</exportType>
      <folder>$EXPORT_FOLDER$/discharge</folder>
      <exportFileName>
        <name>discharge.csv</name>
      </exportFileName>
      <idMapId>IdExportObservations</idMapId>
      <exportTimeZone>
        <timeZoneName>GMT</timeZoneName>
      </exportTimeZone>
    </general>
    <timeSeriesSet>
      <moduleInstanceId>ImportObservations</moduleInstanceId>
      <valueType>scalar</valueType>
      <parameterId>Q.obs</parameterId>
      <locationId>RiverGauge_01</locationId>
      <timeSeriesType>external historical</timeSeriesType>
      <timeStep unit="hour" multiplier="1"/>
      <readWriteMode>read only</readWriteMode>
    </timeSeriesSet>
  </export>
</timeSeriesExportRun>

Field reference

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

Element <timeSeriesExportRun>

Element	Type	Cardinality	Description
export	TimeSeriesExportRunComplexType	required · repeats

TimeSeriesExportRunComplexType

Element	Type	Cardinality	Description
general	TimeSeriesExportGeneralComplexType	required	groups a number of general export properties
properties	PropertiesComplexType	optional	Since 2010.02, Properties that are passed to the serializer. Very few external third party serializer need additional configuration. See documentation of the external third party serializer you are using.
metadata	TimeSeriesExportMetadataComplexType	optional	Optional metadata that is written in the exported file. The options netcdfMapDPhase and alertMapDPhase are deprecated (do not use these). For the other options it is possible to use the following tags: %TIME_ZERO% the T0 of this time series export run. %CURRENT_TIME% the current time. %MODULE_INSTANCE_ID% the id of this module instance. %MODULE_INSTANCE_NAME% the name of this module instance. %MODULE_INSTANCE_DESCRIPTION% the configured description of this module instance. %WORKFLOW_ID% the id of the workflow in which this export runs. %WORKFLOW_NAME% the name of the workflow in which this export runs. %WORKFLOW_DESCRIPTION% the configured description of the workflow in which this export runs. %TASK_DESCRIPTION% user description of the forecast in which this export runs. %WHAT_IF_NAME% name of the what-if used in the forecast in which this export runs. %USER_ID% the id of the user by which this export run is executed.
exportAttribute	ExportAttributeType	optional · repeats	Since 2015.01 Id of attribute that can be used for export. Specification is needed to include it in the data available for export
exportLocationAttributeAsNetCDFVariable	ExportLocationAttributeAsNetCDFVariableComplexType	optional · repeats	Since 2021.01. Adds a new variable to the NetCdf export for locations. The value of the attributes is a location attribute.
exportArchiveMetadata	boolean	optional	Since 2022.01 Adds archive meta data to the netcdf-file during export. The harvester of the netcdf-storage uses this metadata to build the catalogue.
timeSeriesSet	TimeSeriesSetComplexType	optional · repeats
timeSeriesSets	ZLayersTimeSeriesSetsComplexType	optional · repeats
filterId	idStringType	optional · repeats	Since 2018.02 Id of filter from Filters.xml, time series from that filter will be used for export.
annotationLocationSetId	idStringType	required	Since 2021.01 Id of the location set for which annotations should be exported

TimeSeriesExportGeneralComplexType

Element	Type	Cardinality	Description
description	string	optional
table	TableMetadataComplexType	optional	Since 2014.02. FEWS-10153 . Currently the generalCsv export requires a table layout description configured by the user. The order of the listed columns determines the column indices.
idMapId	fileStringType	optional	Id of IdMap to be used for parameterId mapping
externalLocationNameFunction	nonEmptyStringType	optional	Location dependent external location name by using a function with location attributes. An example: @EXTERNAL_NAME@
unitConversionsId	idStringType	optional	Id of UnitConversions to be used for unit mapping
flagConversionsId	idStringType	optional	Id of flagConversions to be used for flag mapping
omitMissingValues	boolean	optional	Are missing values to be written to the export file or should they be left out.
precision	nonNegativeIntegerStringType	optional	Since 2018.02. Number of fraction digits that are always shown. By default the parameters valueResolution will be used to determine the maximum number of digits instead. The configured number of digits should always be smaller than or equal to the valueResolution.
exportTimeZone	TimeZoneComplexType	optional	Time zone of the export data.
geoDatum	geoDatumStringType	optional	Type of coordinate system
convertDatum	boolean	optional	Convert datum to local datum during import. The conversion wil be done for all parameters which use datum (as configured Parameters.xsd)
ensembleMemberFormat	ensembleMemberFormatEnumStringType	optional	Since 2019.02 Use option 'name' to write ensemble member id. By default the ensemble member index is written One of: index, name
convertValuesToEnumerationLabels	boolean	optional	Since 2015.01 Applies only to time series that are associated with a time series value enumeration (see Parameters.xsd). If this option is true, then the enumeration label is written to the file, and not the numerical value . Please note that this option is only applicable to those file formats where time series values can be stored as strings, for example CSV formats
convertAnnotationEnumerationPropertyValuesToLabels	boolean	optional	Since 2021.01 Applies only to textual time series that have properties connected to value enumeration (see AnnotationMetaDataSchema.xsd). If this option is true, then the enumeration label is written to the file, and not the numerical code.
forecastSelectionPeriod	RelativePeriodComplexType	optional	If configured all forecasts with a forecast time within the configured period will be exported. Since 2020.01 all forecasts will be exported to the same file. When also configuring timeZeroFormattingString in the 'prefix' of the 'exportFileName', each forecast will be exported to a separate file
externalForecastTimeId	idStringType	optional	Since 2018.01. Use this external forecast time id as forecast time in the exported files. The forecast time should be defined in the forecast length estimator
exportLastValue	boolean	optional	Since 2024.01. Use this boolean switch to only export the last value.
coldStartDataExportRelativeStartTime	RelativeTimeComplexType	optional	Optional. If this is specified, then the period for which data is exported will be truncated for simulated data that was created in a run that started with a cold state. In other words for this type of data, any data before the specified start time will not be exported. This start time is relative to the time zero of the run in which the data was created. This can be used to avoid exporting data that was created during the warm-up period of a model run after a cold start. Note: this option only works when the default state selection was configured to be warm state for the run in which the data was created.
creationTime	creationTimeEnumStringType	optional	Optional. Set the creation time of the exported timeseries equal to the time of export. If omitted or none then no creation time value set. One of: none, currentTime
dateTimePattern	nonEmptyStringType	optional	Since 2016.02. For formats that supports a custom date time pattern. e.g. yyyy/MM/dd HH:mm:ss
exportThresholds	boolean	optional	Since 2016.02 Optional element which specifies that thresholds should be exported, so far this is available for the netcdf scalar export and PI version 1.14
flagSourceColumnFilter	idStringType	optional	Since 2024.01. This flagSourceColumn can be used to keep record of what entries are already exported.
exportedFlagSource	idStringType	optional	Since 2024.01. This flag source can be used to mark entries as exported.
exclusiveFlagSourceColumn	boolean	optional	Since 2024.01. Use this boolean switch to determine whether the flagSourceColumn will be used for exclusive or inclusive filtering. True means entries that are not flagged will be filtered away.
user	string	required	User name
password	string	required	Password for user
encryptedPassword	string	required	Encrypted password for user
columnSeparator	columnSeparatorEnumStringType	required	Since 2016.01 User defined column separator used for specific serializers like generalCsvSerializer One of: ;, ,, |,  , 	
decimalSeparator	decimalSeparatorEnumStringType	required	Since 2016.01 User defined decimal separator used for specific serializers like generalCsvSerializer One of: ., ,
exportTypeStandard	exportTypeEnumStringType	required	This type specifies which writer should be used to write the file. The type must be one from the enumeration One of: alert, asciigrid, bfg, BigModCsv, correlationEventSets, csv, csvdutch, csvdutchwithquality, csvensemble, csvwithflagsource, csvwithouttimezone, csvwithquality, DdscExport, dinotuf, EA, fliwas, generalCsv, GIN_Export, GINUpdate_Export, grdc, grid2shp, HecDss, hhrr, HYDAMS-ASCII, iBever, IQM, itaipuForecast, itaipuObservedValidated, kwaliteit_csv, LHP, LILA, lmw, lmw_wnt, mam, mapdphase, menyanthes, MeteoAlarm, MeteoAlarmCap, netcdf, netcdf-cf, NETCDF-CF_DOMAIN, NETCDF-CF_GRID, NETCDF-CF_GRID_MATROOS, NETCDF-CF_PROFILE, NETCDF-CF_PROFILE_MATROOS, NETCDF-CF_SPECTRUM, NETCDF-CF_TIMESERIES, NETCDF-CF_TIMESERIES_MATROOS, NETCDF-CF_ZLAYERS, netcdf-stf, NETCDF-STF_TIMESERIES, NETCDF-TIDAL_TIMESERIES, netcdf-vertical-profile, NETCDF-VERTICAL_PROFILE, noos_timeseries, pi, pi 1.2, pi 1.3, pi 1.4, pi 1.5, pi 1.10, pi 1.11, pi 1.12, pi 1.13, pi 1.14, pi 1.19, pi 1.23, pi 1.24, pi 1.25, pi 1.26, pi 1.27, pi 1.31, pi_ascii_map_stack, pi_pcr_map_stack, pi_server, pi_server_SOAP, pi_tables, pi_usgs_map_stack, ram, SHEF, UM-Aquo-2009, uvf, wiski_zrxp, wml2
exportType	string	required	This type specifies which writer should be used to write the file. It may be any string as long as this type is supported by the TimeSeriesExport module
serializerClassName	string	required	Fully qualifying name of a Java class that implements a time series serializer interface.
binDir	string	optional	Directory with jar files and optionally native dlls. When not specified the bin dir and class loader of FEWS is used. When specified the java class is executed in a private class loader, it will not use any jar in the FEWS bin dir. Only one class loader is created per binDir , adapters should still not use static variables
moduleDataSetName	string	optional	Name of dataset file containing the binaries located in the 'binDir'. Use this to update 'binDir' through configuration changes.
folder	directoryStringType	required	Folder in which export files are located
exportFileName	ExportFileNameComplexType	required
validate	boolean	optional	Only applicable if the data are exported to the xml-file. This option activates the validation of the exported file against a XML schema.
serverUrl	string	required	(Internet) Url to a time series server. The specified time series serializer communicates with this server.
backupServerUrl	string	optional · repeats	Optional Url's to define backup import locations.
connectionTimeOutMillis	int	optional	Optional timeout in milliseconds before a connection is deemed as unavailable.
exportMissingValue	double	required	Missing value definition for this time series. Defaults to NaN if not defined. An exception applies to NetCdf files: if exportMissingValue is not configured, then 9.96921e+036f is used
exportMissingValueString	string	required
dataFeedId	idStringType	required	Id for data feed. Export status will be stored in database using this id
disableDataFeedInfo	emptyElement	required	Option disableDataFeedInfo indicates that no export status should be stored in database
exportChanges	ExportChangesComplexType	optional	Since 2022.01. Use this option to only export changes in the configured period
exportManualChanges	ExportManualChangesComplexType	optional	Since 2013.01. FEWS-8798. use this to only export manual changes

PropertiesComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).
string	StringPropertyComplexType	required
int	IntPropertyComplexType	required
float	FloatPropertyComplexType	required
double	DoublePropertyComplexType	required	Since 2014.01
bool	BoolPropertyComplexType	required
dateTime	DateTimePropertyComplexType	required	Since 2014.01

TimeSeriesExportMetadataComplexType

Element	Type	Cardinality	Description
netcdfMapDPhase	NetcdfMapDPhaseMetadataComplexType	required	Deprecated. Do not use.
alertMapDPhase	AlertMapDPhaseMetadataComplexType	required	Deprecated. Do not use.
title	nonEmptyStringType	optional	A short description of the dataset. Its value will be used by THREDDS opendap servers as the name of the dataset. It therefore should be human readable and reasonable to display in a list of such names.
institution	nonEmptyStringType	optional	Specifies where the original data was produced.
source	nonEmptyStringType	optional	The method of production of the original data. If it was model-generated, source should name the model and its version, as specifically as could be useful. If it is observational, source should characterize it (e.g. "surface observation" or "radiosonde").
history	nonEmptyStringType	optional	Provides an audit trail for modifications to the original data. It should contain a separate line for each modification with each line including a timestamp, user name, modification name, and modification arguments. Its value will be used by THREDDS opendap servers as a history-type documentation. It is recommended that each line begins with a timestamp indicating the date and time of day at which the modification was performed.
references	nonEmptyStringType	optional	Published or web-based references that describe the data or methods used to produce it.
comment	nonEmptyStringType	optional	Miscellaneous information about the data or methods used to produce it.
summary	nonEmptyStringType	optional	The "summary" attribute gives a longer description of the dataset. In many discovery systems, the title and the summary will be displayed in the results list from a search. It should therefore capture the essence of the dataset it describes. For instance, include information on the type of data contained in the dataset, how the data was created (e.g. instrument X or model X, run Y), the creator of the dataset, the project for which the data was created, the geospatial coverage of the data, and the temporal coverage of the data.
keyword	nonEmptyStringType	optional · repeats	Optional one or more key words or phrases that are relevant to the dataset. The values in this list may be taken from a controlled list of keywords (e.g. the AGU Index list or the GCMD Science Keywords).
customAttributes	PropertiesComplexType	optional	If you want to add an attribute that is not predefined in the schema, then you can add it as a custom attribute here.

ExportAttributeType

Attributes

Attribute	Use	Notes
internalAttributeId	optional	Since 2015.01. FEWS-11063
externalAttributeId	optional	Since 2015.01. FEWS-11063

ExportLocationAttributeAsNetCDFVariableComplexType

Element	Type	Cardinality	Description
ncVariable	idStringType	required	Name of the variable in the NetCdf file.
attributeId	idStringType	required	Attribute id to be used as attribute value.

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

ZLayersTimeSeriesSetsComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required · repeats
zParameter	idStringType	optional	Since 2020.01. Z layer parameter

TableMetadataComplexType

Currently the generalCsv and Database import and generalCsv export require a table layout description configured by the user. Non-standard imports (plugins) can also required a table layout. See the documentation of the specific import. The order of the listed column is used to calculate the column indices when there is no column name information available. Add the columns that are not used as skipped columns so the column indices can be calculated correctly

Attributes

Attribute	Use	Notes
name	optional	Name of the table. Only required when file contains multiple tables. Always required for databases.

Elements

Element	Type	Cardinality	Description
dateTimeColumn	DateTimeColumnComplexType	required	Column that contains the date and time for the complete row.
dateColumn	DateColumnComplexType	required	Column that only contains the date without time for the complete row. Time information is read from the timeColumn or from the fixed time attribute that can be specified separately for every value column. Day of month information can be overruled by the day of month attribute of the value column.
yearColumn	ColumnComplexType	required	Column that only contains the year for the complete row. Do not use in combination with dateColumn or dateTimeColumn. When used, a month and day column must also be used. (Only available for GeneralCsv import)
monthColumn	ColumnComplexType	required	Column that only contains the month for the complete row. Do not use in combination with dateColumn or dateTimeColumn. When used, a year and day column must also be used. (Only available for GeneralCsv import)
dayColumn	ColumnComplexType	required	Column that only contains the day of the month for the complete row. Do not use in combination with the day of month attribute of the value column, or the dateColumn or dateTimeColumn. When used, a month and year column must also be used. (Only available for GeneralCsv import)
timeColumn	TimeColumnComplexType	required	Column that only contains the time without date for the complete row. Time information of the column. Do not use in combination with time attribute of value column.
hourColumn	ColumnComplexType	required	Column that only contains the hour for the complete row, using 24h notation, i.e., a number between 0 and 24 where 24 is interpreted as 0 the next day. Do not use in combination with time attribute of value column or timeColumn or dateTimeColumn. When no minute or no second column is used, the minutes and seconds are assumed to be 0. (Only available for GeneralCsv import)
minuteColumn	ColumnComplexType	required	Column that only contains the minute for the complete row, i.e., a number between 0 and 59. Do not use in combination with time attribute of value column or timeColumn or dateTimeColumn. When used, an hour column must also be used. (Only available for GeneralCsv import)
secondColumn	ColumnComplexType	required	Column that only contains the second for the complete row, i.e., a number between 0 and 59. Do not use in combination with time attribute of value column or timeColumn or dateTimeColumn. When used, an hour and minute column must also be used. (Only available for GeneralCsv import)
forecastDateTimeColumn	DateTimeColumnComplexType	required	Column that contains the (external) forecast time. All rows that share the same external forecast are stored as a single forecast.
forecastDateColumn	DateColumnComplexType	required	Column that contains the date part of the (external) forecast time. All rows that share the same external forecast date and time are stored as a single forecast.
forecastTimeColumn	TimeColumnComplexType	required	Column that contains the time part (external) forecast date time. All rows that share the same external forecast date and time are stored as a single forecast.
startDateTimeColumn	DateTimeColumnComplexType	required	Column that contains the start time. This start time will be used for a time range instead of a single time
endDateTimeColumn	DateTimeColumnComplexType	required	Column that contains the end time. This end time will be used for a time range instead of a single time
locationColumn	ColumnComplexType	required	Column that contains the (external) location id for the complete row. The location id can be converted with an id map. When the location id is different for each value column or there is no locationColumn, fill in the location id attribute of each value column.
parameterColumn	ColumnComplexType	required	Column that contains the (external) parameter id for the complete row. The location id can be converted with an id map. When the parameter id is different for each value column or there is no parameterColumn, fill in the parameterId attribute of each value column.
qualifierColumn	QualifierColumnComplexType	required	Column that contains the (external) qualifier id for the complete row. The qualifier id can be converted with an id map or can be used in the id map to map to a different location parameter. Multiple qualifier columns can be specified.
ensembleColumn	ColumnComplexType	required
ensembleMemberColumn	ColumnComplexType	required
commentColumn	ColumnComplexType	required	Column that contains the comment for the complete row. The comment is attached to all values in the current row.
userColumn	ColumnComplexType	required	Column that contains the user for the complete row. The user is attached to all values in the current row. (Only available for GeneralCsv and Database import)
flagColumn	FlagColumnComplexType	required	Column that contains the flag for the complete row. The flag is attached to all values in the current row unless locationId or parameterId is specified.
flagSourceColumn	FlagSourceColumnColumnComplexType	required	Column that contains the flag source id. Multiple columns are allowed. If no flagSourceColumn is specfied, the flagColumn is used. (Only available for GeneralCsv import and export.)
valueColumn	ValueColumnComplexType	required	Column that contains the value. Multiple value columns are allowed
unitColumn	ColumnComplexType	required	Column that contains the (external) unit. Only one unit column is allowed. Attribute unit for value column should not be specified when this column is available. When field is NULL, "-" is used as default unit.
skippedColumn	ColumnComplexType	required	Column that contains information that can not be imported or exported. Required to calculate the correct column index of the non skipped columns It is not required to list the none used columns when the file format contains column name information (like a databases or a csv file with header).
sampleIdColumn	SampleIdColumnComplexType	required	Column that contains sample id. (Only available for GeneralCsv import and export.)
propertyColumn	PropertyColumnComplexType	required	Column that contains a property value. (Only available for GeneralCsv import and export)
attributeColumn	AttributeColumnComplexType	required	Column that contains an attribute value (only available for GeneralCsv export since attributes can not be imported, only configured)
limitSymbolColumn	ColumnComplexType	required	Since 2014.02 build 58201 Column that contains a limit symbol
lineNumberColumn	ColumnComplexType	required	Since 2020.02

TimeZoneComplexType

Element	Type	Cardinality	Description
timeZoneOffset	timeZoneOffsetStringType	required
timeZoneName	timeZoneStringType	required

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

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.

ExportFileNameComplexType

Defines how the export filename must be composed. If no of the elements name, prefix and suffix is specified, the file name is not valid (is checked in the source code).

Element	Type	Cardinality	Description
prefix	AdditionComplexType	optional
suffix	AdditionComplexType	optional
temporaryPrefix	AdditionComplexType	optional	prefix for the file that is in process of being written
name	string	required
useExternalLocationIdAsName	boolean	required	Since 2014.02 FEWS-12229. When true every location is written to a different file

ExportChangesComplexType

Element	Type	Cardinality	Description
dbChangeViewPeriod	TimeSpanComplexType	optional	Only the values created within this view period will be exported. NOTE: the view period is calculated relative to the dispatch time and not T0

ExportManualChangesComplexType

If included, only manual changes will be exported.

Element	Type	Cardinality	Description
manualDbChangeViewPeriod	TimeSpanComplexType	optional	Edits should be conducted (time stamped) within this view period to be included in the export. ViewPeriod is calculated relative to the dispatch time and NOT T0. Since 2016.02 When this element isn't used, the relativeViewPeriod from the associated timeSeriesSet is used
exportNewManualEntries	boolean	required	Export entries that are manual entered
exportManualFlagChanges	boolean	required	Export entries where at least flags are changed manually. i.e. A entry that is manually set to doubtful. New entries are not included.
exportManualValueChanges	boolean	required	Export entries where at least values are changed manually. i.e. A value is manually correct to 1.0. New entries are not included.

StringPropertyComplexType

Attributes

Attribute	Use	Notes
key	required
value	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).

IntPropertyComplexType

Attributes

Attribute	Use	Notes
key	required
value	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).

FloatPropertyComplexType

Attributes

Attribute	Use	Notes
key	required
value	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).

DoublePropertyComplexType

Attributes

Attribute	Use	Notes
key	required
value	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).

BoolPropertyComplexType

Attributes

Attribute	Use	Notes
key	required
value	required

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).

DateTimePropertyComplexType

Attributes

Attribute	Use	Notes
key	required
date	required
time	required

Elements

Element	Type	Cardinality	Description
description	string	optional

NetcdfMapDPhaseMetadataComplexType

Deprecated. Do not use.

Element	Type	Cardinality	Description
attribute	HeaderItemComplexType	required · repeats	Deprecated. Do not use.

AlertMapDPhaseMetadataComplexType

Deprecated. Do not use.

Element	Type	Cardinality	Description
attribute	HeaderItemComplexType	required · repeats	Deprecated. Do not use.

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

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

DateTimeColumnComplexType

Attributes

Attribute	Use	Notes
pattern	optional	Only required when the type of the column is text instead of timestamp
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

DateColumnComplexType

Attributes

Attribute	Use	Notes
pattern	optional	Only required when the type of the column is text instead of date
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

ColumnComplexType

Attributes

Attribute	Use	Notes
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

TimeColumnComplexType

Attributes

Attribute	Use	Notes
pattern	optional	Only required when the type of the column is text instead of time
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

QualifierColumnComplexType

Attributes

Attribute	Use	Notes
prefix	optional	Optional. Used to add in front of the external qualifier id. Can be useful for id mapping.
defaultValue	optional	Since 2020.02 if the qualifier is missing, use this default value instead.
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

FlagColumnComplexType

Attributes

Attribute	Use	Notes
locationId	optional	Since 2017.01 When there is no location id column for the location id. Only implemented for GeneralTimeSeriesCsvParser.
parameterId	optional	Since 2017.01 When there is no parameter id column for the parameter id. Only implemented for GeneralTimeSeriesCsvParser.
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

FlagSourceColumnColumnComplexType

Attributes

Attribute	Use	Notes
id	optional	The id of the flag source column
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

ValueColumnComplexType

Attributes

Attribute	Use	Notes
parser	optional	Only required when the column type is blob/grid/file.
locationId	optional	When there is no location id column for the location id
parameterId	optional	When there is no parameter id column for the parameter id
ensembleMemberIndex	optional	specify ensembleMemberIndex for this valueColumn
unit	optional	Used for unit conversion. Unit should not be specified when unit column is available
time	optional	This time is combined with the date from the specified date column
dayOfMonth	optional	The day is combined with the month from the specified date column.
ignoreForEnumerationParameters	optional	Since 2017.01. When for the current parameter an enumeration is defined ignore the value. Skip the value when reading and replace by missing when writing
requireEnumerationParameters	optional	Since 2021.02. When for the current parameter an enumeration is defined decline the value / sample when reading, do nothing for writing
ignoreForNumericalParameters	optional	Since 2017.01. When for the current parameter no enumeration is defined ignore the value. Skip the value when reading and replace by missing when writing
requireNumericalParameters	optional	Since 2021.02. When for the current parameter no enumeration is defined decline the value / sample when reading, do nothing for writing
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

SampleIdColumnComplexType

Attributes

Attribute	Use	Notes
prefix	optional	Optional. Used to add in front of the external sample id. Can be useful to separate same sample imported from different sources.
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

PropertyColumnComplexType

Attributes

Attribute	Use	Notes
key	required	The key for the found property value.
pattern	optional	Only required when the attribute type is dateTime.
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

AttributeColumnComplexType

Attributes

Attribute	Use	Notes
id	required	The id of the attribute.
pattern	optional	Only required when the attribute type is dateTime.
name	optional	Column name. When the file format does not contain column name information the name is ignored. In this case add also the non used columns as skipped columns so the index of the column can be calculated

AdditionComplexType

Defines the possible prefixes and suffixes of the filename

Element	Type	Cardinality	Description
simpleString	string	required	Generally it is used when specifying a temporary prefix
timeZeroFormattingString	dateTimeFormatType	required	Use timeZero of the task-run as prefix/suffix. Format it as specified with this element.
currentTimeFormattingString	dateTimeFormatType	required	Use currentTime as prefix/suffix. Format it as specified with this element.

HeaderItemComplexType

Attributes

Attribute	Use	Notes
id	required
value	required

See also

• Task guide: Export data
• Mirror: Import module file
• Schema: timeSeriesExportRun.xsd