Skip to content
Delft-FEWS Config Guide

Import module file

The schema-companion to the Import time series task guide, which explains reader selection, the general-vs-timeSeriesSet split, and the gotchas. This page is the generated field list.

At a glance

Section titled “At a glance”

Purpose : Reads an external file/service/database and stores it as internal series (hops ①–③).

Folder : Config/ModuleConfigFiles/

Root element : <timeSeriesImportRun> (no version attribute — a module-run file, unlike region-config files)

Depends on : An idMap, plus the locations and parameters it writes into.

Minimal example

Section titled “Minimal example”
Config/ModuleConfigFiles/ImportObservations 1.00 default.xml
<?xml version="1.0" encoding="UTF-8"?>
<timeSeriesImportRun xmlns="http://www.wldelft.nl/fews">
  <import>
    <general>
      <importType>generalCsv</importType>
      <folder>$IMPORT_FOLDER$/discharge</folder>
      <fileNamePatternFilter>*.csv</fileNamePatternFilter>
      <idMapId>IdImportObservations</idMapId>
      <importTimeZone>
        <timeZoneName>GMT</timeZoneName>
      </importTimeZone>
    </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>add originals</readWriteMode>
    </timeSeriesSet>
  </import>
</timeSeriesImportRun>

Field reference

Section titled “Field reference”

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

Element <timeSeriesImportRun>

ElementTypeCardinalityDescription
import TimeSeriesImportRunComplexType required · repeats

TimeSeriesImportRunComplexType

ElementTypeCardinalityDescription
general TimeSeriesImportGeneralComplexType required groups a number of general import properties
tolerance TimeStampToleranceComplexType optional · repeats Definition of the tolerance for importing time values to cardinal time steps in the series to be imported to. Tolerance is defined per location/parameter or per parameter combination. Multiple entries may exist
delay DelayComplexType optional · repeats Defines a delay to apply during import of time series. A positive value will cause a delay of the timestamps before the data is imported.
startTimeShift TimeSeriesImportStartTimeShiftComplexType optional · repeats Define the shift of the ExternalForecastStartTime according to the time of the first value in the import array.
properties PropertiesComplexType optional Available since Delft-FEWS version 2010.02. These properties are passed to the time series parser that is used for this import. Some (external third party) parsers need these additional properties. See documentation of the (external third party) parser you are using.
externUnit (inline) optional · repeats
gribRecordTimeIgnore (inline) optional · repeats Deprecated. Use gribTimeSeriesReader configuration
interpolateSerie (inline) optional · repeats
minimumAgeForImport TimeSpanComplexType optional
timeSeriesSet TimeSeriesSetComplexType required · repeats Only the specified time series are imported others are skipped. When no sets are specified, all time series that can be mapped with the id map are imported.
temporary boolean required Since 2013.01. FEWS-7379. The time series are imported as temporary. When true it is not necessary to add the locations/parameters to the locations.xml and parameters.xml
locationId idStringType required · repeats Since 2014.01.
locationSetId idStringType required Since 2014.01.
annotationLocationSetId idStringType required Since 2021.01

TimeSeriesImportGeneralComplexType

ElementTypeCardinalityDescription
description string optional
forecastMaxAge TimeSpanComplexType optional Skip all forecasts with are older than the specified age. The (external) forecast time and the time0 are used to calculate the age. The import file modification time and current actual time are not used.
table TableMetadataComplexType optional · repeats Currently the generalCsv and Database import 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
validate boolean optional Option to allow validation of the import files against the template, i.e. xml-schema. If there is no template available, this option wil be ignored.
logWarningsForUnmappableTimeSeries boolean optional When true warnings are logged when time series in the imported files are skipped. By default unmappable time series are silently skipped
failOnUnmappableTimeSeries boolean optional If an import file contains some time series that can not be mapped use this option to mark file as failed
logWarningsForUnmappableLocations boolean optional When true warnings are logged when locations in the imported files are skipped. By default un mappable locations are silently skipped
logWarningsForUnmappableParameters boolean optional Since 2014.02. FEWS-10839. When true warnings are logged when parameters in the imported files are skipped. By default unmappable parameters are silently skipped
logWarningsForUnmappableQualifiers boolean optional Since 2014.02. FEWS-10839. When true warnings are logged when qualifiers in the imported files are skipped. By default unmappable qualifiers are silently skipped
failOnUnmappableLocations boolean optional If an import file contains some locations that can not be mapped use this option to mark file as failed
maxLogWarnings nonNegativeInteger optional Since 2014.02. FEWS-10078. Maximum number of warnings logged for import. When not specified max log warnings is set to 5. Only applies to general import warnings and not parser specific warnings.
logWarningsToSeparateFile boolean optional Since 2014.02. FEWS-10839. Log warnings for import file to a specific file called [importFileName].log This file will be placed in either the backupFolder or failedFolder depending on whether they are configured and if the import was successful or not
ignoreFileNotFoundWarnings boolean optional Available since 2020.02. Default is false. If it is set to true, FileNotFound warnings are only logged in debug mode.
idMapId fileStringType optional Id of IdMap to be used for parameter, location, qualifier and ensemble member mapping
moduleInstanceAware boolean optional Since 2023.01. If value is set to true, data will only be imported if the module instance id specified in the config file matches the module instance id of the downloaded data.
useStandardName boolean optional Since 2012.02. When the parser provides the standard name the parameter mapping can be done by matching the standard name. The standard name of the parameter in the time series set should be configured in the parameters.xml and the standard name should be provided by the import format. If not an error is logged. When also the maximumSnapDistance is configured no id map is required at all.
maximumSnapDistance doubleStringType optional Since 2012.02. Optional maximum horizontal snap distance in meters. When the parser provides horizontal location coordinates (x,y) and no locationIds, then the location mapping will be done by matching the horizontal coordinates. The horizontal snap distance is the tolerance used to detect which internal and external horizontal coordinates are the same. Don't forget to configure the geoDatum when the input format does not provide the coordinate system for the locations. When the parser does not provide the coordinates for a time series an error is logged. Note: this option has no effect for grid data. Note 2: it is not possible to import data using horizontal coordinates and using locationIds in the same import, need to define separate import elements for that (one with maximumSnapDistance and one without maximumSnapDistance).
unitConversionsId idStringType optional Id of UnitConversions to be used for unit mapping
disableImportOnMissingUnitConversion boolean optional If this flag is True and the extern unit does not equal the intern unit and there is no unit-mapping available, the time series wil be not imported.
flagConversionsId idStringType optional Id of flagConversions to be used for flag mapping
flagSourceConversionsId idStringType optional Since 2024.02 Id of flag source conversions(flagConversions.xsd format) to be used for flag source mapping
missingValue float optional · repeats Values that are replaced by NaN during import. NaN is always recognized as missing value.
missingValueText string optional · repeats Values that are replaced by NaN during import. NaN is always recognized as missing value.
traceValue float optional · repeats All trace values are replaced by 0 during import, before datum conversion
importTimeZone TimeZoneComplexType optional Time zone of the import data. If this is not configured, then GMT is used.
gridStartPoint GridStartPointSimpleType optional Identification of the cell considered as the first cell of the grid. Enumeration of options includes : NW for upper left, SW for lower left, NE for upper right , SE for lower right. This option should only be used if the NetCDF file is not CF compliant and contains insufficient metadata with info of the grid, its orientation etc.
One of: NW, SW, NE, SE
geoDatum geoDatumStringType optional Type of coordinate system
importTypeConfig fileStringType optional configuration of the reader specified with importType
convertDatum boolean optional Convert datum from local datum during import. The conversion wil be done for all parameters which use datum (as configured Parameters.xsd)
skipMissingValues boolean optional Since 2019.02 Skip missing values so they are not overwriting existing values in the database
skipEmptyTextValues boolean optional Since 2021.02 Skip empty text values so they are not imported as missing values.
ignoreNonExistingLocationSets boolean optional Since 2021.01. Option to skip time series sets if the location set does not exist. Useful when module or workflow is run in loop with tags being translated. When omitted defaults to 'false'.
reportChangedValues boolean optional Option to allow printing messages to the log-file if the imported values are changed, compared to the previously imported values
actionLogEventTypeId idStringType optional ID of the action message that must be logged if any data imported. This message is then used to start up an action as configured in the MasterController config.files (e.g. start a forecast)
comment CommentComplexType optional Comment to add to the imported values, visible in the time series dialog as tooltip
synchLevel int optional Sync level used when not specified in the time series sets
expiryTime CalendarTimeSpanComplexType optional Expiry time used when not specified in the time series sets
relativeForecastTime RelativeTimeComplexType optional Optional forecast time relative to the T0 of the import run. All imported external forecast time series will get this forecast time. This overrules any forecast times stored in the imported data itself. All time series with the same forecast time belong to the same forecast.
skipFirstLinesCount int optional Skips the first n lines of a file. Error is logged when this option is configured for a binary file.
gotoLineWhichStartsWith string optional Since 2017.02: Find the first line that starts with the specified string. All lines before will be skipped by the import. Only supported for line based text imports
commentIgnoreFilter (inline) optional
ignoreEmptyComments boolean optional Since 2021.02. Default is true. When false imported empty comments overwrite existing comments. Import notice: this will also overwrite comments written by users when data is reimported
mergeWithExistingSampleData boolean optional Since 2014.02. When true, newly imported sample data will overwrite and extend existing sample data, keeping non overwritten data from the same sample. When false the non overwritten sample data from the same sample will be removed. Be careful with changing qualifiers when set to true because changing a qualifier will result in a different time series. This "new" time series will be added to the sample and the "old" will remain, instead of overwriting the old with the new. Also sample properties can not be changed when merging because sample properties should be the same for the entire sample, this also applies to already and newly imported data for the same sample.
rejectCompleteSampleOnUnmappableId boolean optional Since 2014.02. When true, if part of an imported sample cannot be mapped to a time serie in FEWS the whole sample will be rejected, when false part of a sample can be imported.
rejectCompleteSampleOnDuplicateValues boolean optional Since 2021.02. When true, if for the same time step within a time series multiple values are imported reject sample and add log warning
overwriteAnnotations boolean optional Since 2022.02. When true, annotations with same location and time but different content (both annotation itself and properties) will overwrite eachother instead of coexist. Default is false.
trimPeriodWhenLastImportedTimeStepAfterPeriod boolean optional Since 2018.02. When true, import types that trim requested period to last imported time step will not make an exception (and skip entire period) when last imported time step is after the requested period
dateTimePattern nonEmptyStringType optional Since 2016.02. For formats that supports a custom date time pattern. e.g. yyyy/MM/dd HH:mm:ss
charset charsetEnumStringType optional Since 2017.01. Character set of the import file. Specify only when the file contains non western characters.
One of: US-ASCII, windows-1250, windows-1251, windows-1252, windows-1253, windows-1254, windows-1257, ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9, ISO-8859-13, ISO-8859-15, KOI8-R, UTF-8, UTF-16, UTF-16BE, UTF-16LE, windows-1255, windows-1256, windows-1258, ISO-8859-3, ISO-8859-6, ISO-8859-8, windows-31j, EUC-JP, x-EUC-JP-LINUX, Shift_JIS, ISO-2022-JP, x-mswin-936, GB18030, x-EUC-CN, GBK, ISCII91, x-windows-949, EUC-KR, ISO-2022-KR, x-windows-950, x-MS950-HKSCS, x-EUC-TW, Big5, Big5-HKSCS, TIS-620, Big5_Solaris, Cp037, Cp273, Cp277, Cp278, Cp280, Cp284, Cp285, Cp297, Cp420, Cp424, Cp437, Cp500, Cp737, Cp775, Cp838, Cp850, Cp852, Cp855, Cp856, Cp857, Cp858, Cp860, Cp861, Cp862, Cp863, Cp864, Cp865, Cp866, Cp868, Cp869, Cp870, Cp871, Cp874, Cp875, Cp918, Cp921, Cp922, Cp930, Cp933, Cp935, Cp937, Cp939, Cp942, Cp942C, Cp943, Cp943C, Cp948, Cp949, Cp949C, Cp950, Cp964, Cp970, Cp1006, Cp1025, Cp1026, Cp1046, Cp1047, Cp1097, Cp1098, Cp1112, Cp1122, Cp1123, Cp1124, Cp1140, Cp1141, Cp1142, Cp1143, Cp1144, Cp1145, Cp1146, Cp1147, Cp1148, Cp1149, Cp1381, Cp1383, Cp33722, ISO2022_CN_CNS, ISO2022_CN_GB, JISAutoDetect, MS874, MacArabic, MacCentralEurope, MacCroatian, MacCyrillic, MacDingbat, MacGreek, MacHebrew, MacIceland, MacRoman, MacRomania, MacSymbol, MacThai, MacTurkish, MacUkraine
columnSeparator columnSeparatorEnumStringType required Since 2016.01 User defined column separator used for specific serializers like generalCsvSerializer
One of: ;, ,, |, &#x20;, &#009;
decimalSeparator decimalSeparatorEnumStringType required Since 2016.01 User defined decimal separator used for specific serializers like generalCsvSerializer
One of: ., ,
importTypeStandard importTypeEnumStringType required This type specifies which reader should be used to read the file. The type must be one from the enumeration
One of: AdconTimeSeriesServerParser, ahd, AifsML, AifsMLArea, AifsMLHazard, AifsMLObservations, Akvo, AoClimateIndex, Aqualarm, AqualarmRest, AquariusRestV2, AquariusFieldVisitReadingsByLocation, ArcInfoAsciiGrid, ARCWAT_DBF, AsciiGrid, AsciiGridWithOptionalFooterLines, AVAMET, AzureIotHub, Bayern, bc2000, bfg, bil, BILBIPBSQ, BMALatest, BMADay, BUFR, BrazilAna, BroGldAdditionServer, BroGldAddition, BSH-MARNET, CanadaDFO, CanadaMeteo, CanadaMeteoWCS, campbell, CapAlert, CapAlerts, CEMIG, cerf, CHC, Cmems, CorpsFlowsheet, cosmo7_cor, covadem, covademTrack, covademTrack2, CroatianHFSResults, CS3xTidalSurge, CSV, CWMS, CyMons, delft3dflow, database, DataWare, DDSC, Delft3dFlow, DHI_PRESA, DHI-SFA, DHILAWRArcInfoAsciiGrid, DHM, DigitalDelta, DigitalDelta3.0, dino, dinoservice, divermon, dwd-gme, dwd-lm, dwd-lm2, dwd8, dwd9, dwd10, DXOFFLINE, DXOnline, ea, EARS_Satellite_Rainfall_Estimate, easyQ, ECTemperature, EDSHydrothermal, EDStransmission, EEX, EHDCC, EfasSos, EfasSosServer, eksw, eksw2005, Element360, Element360Metadata, EnviromonCsv, era15, EtaSmn, evn, Farm21, fewsdatabase, foc, FOCnew, generalCsv, GermanSnow, ghd, grayscaleimage, GSMaP, grib, grib1, GRIB1Unstructured, grib2, GRIB2DIR, GRIB2_UKV, GRIB_HIRLAM_FLIPPED, gribbasic, gribcosmo, gsod, HCS, hdf4, hdfSoilMoisture, EDSHydrothermal, HecDss, Hessen, HidroInformatica, HHRR, HHZZ, hims, historicalEventsXML, HVZ-LILA, Hycom_netcdf, HYDAMS-XML, hydris, HydroQuebecPRN, OttawaRiverRegulation, HyFSAstro, HYMOSASCII, IDEAM, IDEAMQ, hymosTransfer, IFKIS, iHistorian, IJGKlepstanden, IMIS, IModIDF, IOCSeaLevelMonitoring, ItaipuBDH, ItaipuForecast, ItaipuRawData, ItaipuSchedule, IP1, JTWC, keller, knmi, knmi-hdf5, knmicsv, knmieps, knmievp, Knmi-Hdf5-Radar-Nowcast, knmiiris, knmisynops, KnmiWAQUA-TS, Landsat-Hdf5, LILA, LMW, LmwHy3m, LmwKnmiCsv, LmwLixhe, LmwUkmo, LmwWallonie, LmwWeatherdata, locationIdsHeaderCsv, lubw, LUBWImport, MactaquacDischarge, matroos_netcdf-cf_grid, matroos_netcdf-cf_timeseries, matroos_netcdfmapseries, matroos_netcdfspectrumseries, McIDASArea, MeiClimateIndex, MeteoFranceAscii, MeteoFranceArome, MeteoFranceDPObs, MetOffice, MetOfficeWW3, MinerveJson, Mis, MjoClimateIndex, mm3pCsv, Modifier, modis, ModisSca, mosaic, mosm, MultiflexMeter, MunisenseImport, msw, nea, netcdf-cf, netcdf-stf, netcdf-wdss2, NetCdfGridDataset, NetCdfGridDatasetFlipped, NetcdfHydralab, NETCDF-CF_GRID, NETCDF-CF_GRID_REFERENCES, NETCDF-CF_GRID-NW, NETCDF-CF_GRID-SW, NETCDF-CF_PROFILE, NETCDF-CF_TIMESERIES, NETCDF-CF_TRAJECTORY, NETCDF-CF VERTICAL PROFILE, NETCDF-CF_SPECTRUM, NETCDF-CF_SPECTRUM_TEMP, NETCDF-WDSS2_SPARSE_LAT_LON_GRID, NETCDF-STF_TIMESERIES, NETCDF-TIDAL_TIMESERIES, NetCDFStorageLatestForecastScalar, NetCDFStorageLatestForecastGrid, NetcdfVerticalProfile, nimrod, NinoClimateIndex, noaa_global_forecast_system, noaa_satellite_rainfall_estimate, noos_server, noos_mapseries, noos_timeseries, noos_1dmapseries, NRWTelemetry, NRWTelemetryMeasure, NRWWiski, ntuquarter, nturain, NWS-DATACARD, NWS-DATACARD-HINDCAST, NWS-DATACARD-INSTANTANEOUS, NWS-DATACARD-RATING-CURVE, Obscape, obserview, ofsde, OGCSensorThings, omc, ONS-CPTEC_ETA, ONS-Synoptic, ONSSoap, ONSWebService, OSHDAsciiGrid, PdoClimateIndex, pegelonline, pi, pi_json, pi_ratingcurves, pi_server, pi_server_SOAP, pi_tables, piDiagnostics, piMapStack, pmdsynoptici, pmdtelemetric, QboClimateIndex, QPF, radolan, rijnlandrtd, RivDaily, RotterdamPort, SAIH, senamhi, shd, shd-extloc, shef, SingaporeLDS, SingaporeNEA, SingaporeNEAv2, SkyGeo, SsarrPrecipitation, SsarrTemperature, sma, smaecmwf, SoiClimateIndex, sse, swan-spectrum, swe, swissradar, synop, tahmo, TaiwanRmoServer, TaiwanCwbAsciiForecast, TaiwanCwbSeaWave, TeleconnClimateIndex, TheissCsv, tmsi, tmx, tmxCsv, ttrr, TvaDailyWaterViewCsv, TvaHourlyWaterViewCsv, TvaKentuckyBarkley, TvaTvaKentuckyBarkley, TvaTransaction, UkEaBwq, UruguayAna, UruguayDatawise, UruguayDc, UruguayDher, UruguayEtaSmn, UruguayFdc, UruguayFundagro, UruguayHermes, UruguayHydroEstimator, UruguayInia, UruguayInmet, UruguayPna, UruguaySmn, UruguaySupervisor, UruguayTero, UruguayTractebel, VaisalaXML, URA, UsgsTwis, UsgsWSIVJson_server, UVF, UyAna, UyDinagua, UySalto, UyUteTelemetric, UyUteConventional, VegaAir, Vigicrues_web, VQJA, wapdatelemetric, WaterqualityApp, WdtfXml, WdtfTsoXml, WinSys, WIWB, WIWB_async, wiski, wiskiservice, Wispcloud, wml2, wml2_server, wml2_kiwis, wmoBufr, wmoBufrAscii, WQCSV, WRFGrads, WSCCCsv, wsd, WW3Spectrum, YacyretaImport, ZhiTian
importType string required This type specifies which reader should be used to read the file. It may be any string as long as this type is supported by the TimeSeriesImport module
parserClassName string required Fully qualifying name of a Java class that implements a time series parser interface.
binDir string optional Directory with jar files and optionally native DLLls. 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 import files are located, deep scan, sub folder are also imported
fileNameDateTimeFilter FileNameDateTimeFilterComplexType optional · repeats Since 2017.01. Filter out files and sub dirs that are not part of the list. List of date times is created by specifying a loop.
fileNamePatternFilter nonEmptyStringType optional e.g *.xml to skip non xml files. Only the * and ? wild cards are recognized.
fileNameEnsembleMemberIndexPattern nonEmptyStringType optional Use ? to indicate the position of the ensemble member index in the filename. For example cosmo_???.dat Litteral parts that contain unrelated characters can be also replaced with any other character. For example xxxxxx???.dat This is useful if the filename keeps changing , for example because the of presence of a date in the filename
fileNameObservationDateTimePattern nonEmptyStringType optional 'IMAGE_'yyyyMMdd_HHmmss'.jpg' This will overrule the observation time stored in the file, some grid formats don't contain the time at all, so for these files the pattern is required Put the literal parts of the pattern between '
fileNameLocationIdPattern nonEmptyStringType optional Regular Expression. When a match of the pattern in the filename is found, this will overrule the location Id for the time series being imported. A simple pattern is (without quotations) '(.*)' which matches the whole filename. An other simple pattern is .{2}(.*).{4} that removes the first 2 and last 4 character of the filename to get the id More complicated expressions can be found at http://en.wikipedia.org/wiki/Regular_expression
fileNameParameterIdPattern nonEmptyStringType optional Regular Expression. When a match of the pattern in the filename is found, this will overrule the parameter Id for the time series being imported. A simple pattern is (without quotations) '(.*)' which matches the whole filename An other simple pattern is .{2}(.*).{4} that removes the first 2 and last 4 character of the filename to get the id More complicated expressions can be found at http://en.wikipedia.org/wiki/Regular_expression
maxAllowedFolderSizeMB positiveInteger optional When the total size of all the files in the specified directory is larger than the specified number of MBs an error will be logged and the import of files from this directory will be skipped
failedFolder directoryStringType optional Files that could not be imported due to an error are copied to this folder.
backupFolder directoryStringType optional Successfully imported files are moved to this folder.
suspendedFolder directoryStringType optional Files from a suspended import are moved to this folder.
importTriggeringFile fileStringType optional · repeats Since 2020.01 Full path to the files that trigger the import. If configured, import will start when all configured files are found. The files are deleted at the end of the import run.
groupImportPattern GroupImportPatternComplexType optional Since 2024.01 File name pattern defining a complete forecast. When as many files as configured match the pattern, they can be imported. If waiting time has passed without all files, the existing files are moved to the failed folder.
deleteImportedFiles boolean optional Boolean to specify whether or not to delete files after import. This is useful when files are needed for multiple imports.
fileNameForecastCreationDateTimePattern nonEmptyStringType required 'IMAGE_'yyyyMMdd_HHmmss'.jpg' This will overrule the forecast time stored in the file, some grid formats don't contain the forecast time at all, so for these files the pattern is required. Put the literal parts of the pattern between '. When the file name also contains non forecast date times put this parts between ' and use ? wildcard All forecast with the same forecast time belong to the same forecast. When filename starts with the pattern do not use quotes in at the start: yyyyMMdd'_bla.nc'
fileNamePrefixForecastCreationDateTimePattern nonEmptyStringType required instead of fileNameForecastCreationDateTimePattern to use the start of the file name
fileNamePostfixForecastCreationDateTimePattern nonEmptyStringType required instead of fileNameForecastCreationDateTimePattern to use the end of the file name
fileNameForecastCreationDateTimePatternFromZip nonEmptyStringType required 'hd_'yyyyMMdd_HHmmss'.zip' This will overrule the forecast time stored in the file name, and uses the timestamp given in the .zip folder name. Put the literal parts of the pattern between '. When the .zip file name also contains non forecast date times put this parts between ' and use ? wildcard All forecast with the same forecast time belong to the same forecast.
ftpPassiveMode boolean optional Since 2026.01 the default has been set to true. Can bet set to false ftp passive mode is not supported by a ftp server.
sftpHostKeyFile string optional Since 2025.02. File reference to the host key to validate the connection to a SFTP server. Only absolute paths are supported. For an existing sftp server the content of the file can be retrieved with: 'ssh-keyscan -t rsa,ecdsa mysftpserver'
sftpPrivateKeyFile string optional Since 2025.02. Allow connecting to a SFTP server using a private key instead of username and password. File location of the sftp private key to be used for authentication when connecting to the sftp server. Only absolute paths are supported. Only RSA and ECDSA PEM keys are supported. Ed25519 is supported from 2026.01. Typically generated with: 'ssh-keygen -t rsa -m PEM -f my_rsa_key.pem' or 'ssh-keygen -t ecdsa -b 521 -m PEM -f ecdsa'
sftpPrivateKey string optional Since 2025.02. Allow connecting to a SFTP server using a private key instead of username and password. Never put the Key directly in the config. Can be referenced using an ENV variable or secure global properties. Only RSA and ECDSA PEM keys are supported. Ed25519 is supported from 2026.01. Typically generated with: 'ssh-keygen -t rsa -m PEM -f my_rsa_key.pem' or 'ssh-keygen -t ecdsa -b 521 -m PEM -f ecdsa'
sftpPassPhraseFile string optional Since 2025.02. File reference to the pass phrase the is required to read the private key. Only absolute paths are supported.
sftpPassPhrase string optional Since 2025.02. Content of the pass phrase required to read the private key. Never put the pass phrase directly in the config. Can be referenced using an ENV variable or secure global properties.
jdbcDriverClass string required e.g. com.microsoft.jdbc.sqlserver.SQLServerDriver or com.mysql.jdbc.Driver
jdbcBinDir nonEmptyStringType optional Directory with driver jar files and optionally native dlls/sos. When not specified the bin dir and class loader of FEWS is used. When specified the jdbc drive class is loaded from the bin dir, it will not use any jar in the FEWS bin dir.
jdbcConnectionString string required Connection string to external database. Test the connection string in db visualiser before using
jdbcConnectionTimeOutMillis positiveIntegerStringType optional When specified the connection to the database is first tested before asking the jdbc driver to connect. Some jdbc drivers are using a very long time out.
serverUrl string required (Internet) Url to a time series server. The specified time series parser communicates with this server. Tags should be separated by "%" signs. The following tags can be used in this URL: %TIME_ZERO(dateFormat)% is replaced with the time0 of this import run. The time0 is formatted using the dateFormat that is specified between the brackets. For example %TIME_ZERO(yyyyMMdd)% would be replaced with the year, month and day of the time0. %RELATIVE_TIME_IN_SECONDS(dateFormat,relativeTime)% is replaced with time = (time0 + relativeTime), where time0 is the timeZero of this import run and relativeTime is a time relative to time0 in seconds (can be negative). The time is formatted using the dateFormat that is specified as the first argument between the brackets. For example %RELATIVE_TIME_IN_SECONDS(yyyyMMdd,-18000)% would be replaced with the year, month and day of time = time0 - 18000 seconds.
backupServerUrl string optional · repeats Optional Url's to define backup import locations.
downLoadFolder directoryStringType optional data will downloaded and saved as a file to this folder as well as imported
fileNamePatternFilter nonEmptyStringType optional Since 2014.02. FEWS-11593 e.g *.xml to skip non xml files from server. Only the * and ? wild cards are recognized. Only supported by specific import types and parsers
fileNameObservationDateTimePattern nonEmptyStringType optional Since 2017.02 Currently supported only by import from OpenDAP. An example 'http://nomads.ncep.noaa.gov:9090/dods/gfs_0p25_1hr/gfs'yyyyMMdd'/gfs_0p25_1hr_'HH'?'. This will overrule the observation time stored in the file. Some grid formats don't contain the time at all, so for these files the pattern is required. Put the literal parts of the pattern between '
connectionTimeOutMillis int optional Optional timeout in milliseconds before a connection is deemed as unavailable.
oauth2Config OAuth2ConfigComplexType required
forecastSearchPeriod RelativePeriodComplexType required Since 2024.02. Only time series with (external) forecast time within this forecastSearchPeriod will be imported. If multiple forecast are found, only the most recent forecast will be imported. Supported only for specific imports
onlyGaps boolean optional Since 2022.02. Only import for periods where there are gaps in the data. Only supported for specific imports, an error will be logged when not supported
relativeViewPeriod TimeSeriesSetRelativePeriodComplexType required Period relative to the time 0 of the run. When the start and end time are overrulable the user can specify the download length with the cold state time and forecast length in the manual forecast dialog.
startDateTime DateTimeComplexType required Start date and time of the (fixed) period for which data should be read. Start is inclusive. This dateTime is in the configured importTimeZone.
endDateTime DateTimeComplexType required End date and time of the (fixed) period for which data should be read. End is inclusive. This dateTime is in the configured importTimeZone.
externalForecastTimesSearchRelativePeriod RelativePeriodComplexType required Since 2021.01, it is possible to import older forecast data within a given period. Only supported for specific imports, an error will be logged when not supported
externalForecastTimesCardinalTimeStep TimeStepComplexType required Since 2021.01, for each time step within the period, the parser is used to import forecast data.
logErrorsAsWarnings boolean required Since 2014.01. Exceptions occuring in a parser as well as some not parser-specific log messages such as " Import folder ... does not exist" or " Can not connect to..." can be logged as Error or as Warning. Use this option to change it. Default is logErrorsAsWarnings=true. Configure False if you wish clear alert notifications in SystemMonitor and Explorer statusBar
logErrorsAsWarningsToFileOnly boolean required Since 2018.02. Exceptions occuring in a parser as well as some not parser-specific log messages such as " Import folder ... does not exist" or " Can not connect to..." can be logged to file and database. Set this option to true if you do not wish to log them to the database.
maximumVerticalSnapDistance doubleStringType required Since 2014.02. Optional maximum vertical snap distance in meters. When the parser provides vertical location coordinates (z) and no locationIds, then the location mapping will be done by matching the vertical coordinates. The vertical snap distance is the tolerance used to detect which internal and external vertical coordinates are the same. This only works when the input format provides the coordinates of the locations. When the parser does not provide the vertical coordinates for a time series an error is logged. Note: this option currently only works for importing horizontal layers from netcdf 3D grid data. Note 2: it is not possible to import data with z-coordinates (layers from 3D grids) and data without z-coordinates (2D grids) in the same import, need to define separate import elements for that (one with maximumVerticalSnapDistance and one without maximumVerticalSnapDistance).
mapLocationsByLayerSigmaCoordinate boolean required Since 2017.02. When true the location is resolved by the layer sigma coordinate
dataFeedId idStringType required Id for data feed. Import status will be stored in database using this id
disableDataFeedInfo emptyElement required option disableDataFeedInfo indicates that no import status should be stored in database
user nonEmptyStringType required User name used for authentication
encryptedPassword string required Encrypted user's password. Password is encrypted with clipboard utils in F12 menu in (any) SA/OC
password string required The user's password. Error will be logged when used. Error message will contain the encrypted password to replace this element with the element encryptedPassword

TimeStampToleranceComplexType

Tolerance limit for time stamps belonging to a given (FEWS) parameterId

Attributes

AttributeUseNotes
locationSetId optional
locationId optional
parameterId required
timeUnit required
unitCount required

DelayComplexType

Attributes

AttributeUseNotes
unit required
multiplier optional
locationSetId optional
locationId optional
parameterId required

TimeSeriesImportStartTimeShiftComplexType

Allows the external forecast start time to begin prior to the begin time of the imported time series.

ElementTypeCardinalityDescription
parameterId idStringType required
relativePeriod RelativePeriodComplexType required
locationSetId idStringType required
locationId idStringType required

PropertiesComplexType

ElementTypeCardinalityDescription
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

externUnit_inline

Attributes

AttributeUseNotes
parameterId required
unit required
cumulativeSum optional default: false. This is a boolean flag indicating if the value is an accumulation. This is the case in some forecast grids where the precipitation in each cell increases through the forecast. The import module will then calculate the real value of the time step by looking at the difference with the previous time step.Only available for forecast time series
cumulativeMean optional default: false. This is a boolean flag indicating if the value is an accumulated mean. The import module will then calculate the real value of the time step by looking at the difference with the previous time step. Only available for forecast time series
cumulativeSumIgnoreFirstTimeStep optional default: false. This is a boolean flag indicating that for deaccumulation the first time step is to be ignored, see JIRA FEWS-33762.

gribRecordTimeIgnore_inline

Attributes

AttributeUseNotes
locationId required
parameterId required
ignore required

interpolateSerie_inline

Attributes

AttributeUseNotes
parameterId required
interpolate required

TimeSpanComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

TimeSeriesSetComplexType

Attributes

AttributeUseNotes
id optional
name optional

Elements

ElementTypeCardinalityDescription
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

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

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

Elements

ElementTypeCardinalityDescription
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

ElementTypeCardinalityDescription
timeZoneOffset timeZoneOffsetStringType required
timeZoneName timeZoneStringType required

CommentComplexType

ElementTypeCardinalityDescription
dateTimePattern nonEmptyStringType optional Date time pattern used for %IMPORT_DATE_TIME%, %FILE_DATE_TIME%
timeZone TimeZoneComplexType optional Time used for formatting %IMPORT_DATE_TIME%, %FILE_DATE_TIME%
commentForFirstValue nonEmptyStringType optional %IMPORT_DATE_TIME%, %FILE_DATE_TIME%, %FILE_NAME%
commentForAllValues nonEmptyStringType optional %IMPORT_DATE_TIME%, %FILE_DATE_TIME%, %FILE_NAME%

CalendarTimeSpanComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

RelativeTimeComplexType

Defines a time relative to T0.

Attributes

AttributeUseNotes
value required
unit required

Elements

ElementTypeCardinalityDescription
description string optional Optional description with additional comments. This is never used in the code.

commentIgnoreFilter_inline

ElementTypeCardinalityDescription
ignoreCommentPattern nonEmptyStringType optional Regular expression that specifies which comments should be ignored during import. For instance the regular expression ^(FEWS).* specifies that comments starting with "FEWS" must be ignored. This can also be extended for multiple strings: for instance the regular expression ^(FEWS|DELTARES).* specifies that comments starting with "FEWS" or "DELTARES" must be ignored.
ignoreComment nonEmptyStringType optional · repeats List of exact comments that should be ignored

FileNameDateTimeFilterComplexType

Attributes

AttributeUseNotes
subFolderLevel required SINCE 2017.01 Level of the sub dir. Specify 0 for the folder itself

Elements

ElementTypeCardinalityDescription
timeStep TimeStepComplexType required SINCE 2017.01. Specify a monthly time step for yyyyMM
dateTimePattern nonEmptyStringType required SINCE 2017.01. eg yyyyMM,
preFixLength nonNegativeInteger required SINCE 2017.01. Number of characters before date time in the file-name / sub-dir name
postFixLength nonNegativeInteger required SINCE 2017.01. Number of characters after date time in the file-name / sub-dir name

GroupImportPatternComplexType

ElementTypeCardinalityDescription
numberOfFiles int required
fileNameDateTimePattern nonEmptyStringType required
waitingTime TimeSpanComplexType required

OAuth2ConfigComplexType

ElementTypeCardinalityDescription
authUrl string required
clientId string optional
clientSecret string optional For some servers no CLIENT_ID or CLIENT_SECRET are required. Instead the auth URL is queried with Basic Authentication using the username and password
scope string optional · repeats
audience string optional · repeats
issuer string optional
refreshToken string optional

RelativePeriodComplexType

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

Attributes

AttributeUseNotes
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

ElementTypeCardinalityDescription
description string 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

AttributeUseNotes
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

ElementTypeCardinalityDescription
description string optional

DateTimeComplexType

Attributes

AttributeUseNotes
date required
time optional

TimeStepComplexType

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

Attributes

AttributeUseNotes
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

ElementTypeCardinalityDescription
description string optional Optional description of this timeStep. This is not used and is only present for convenience.

StringPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

IntPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

FloatPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

DoublePropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

BoolPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

DateTimePropertyComplexType

Attributes

AttributeUseNotes
key required
date required
time required

Elements

ElementTypeCardinalityDescription
description string optional

TimeShiftComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

EnsembleMemberIndexRangeComplexType

Attributes

AttributeUseNotes
start required
end optional

DateTimeColumnComplexType

Attributes

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

AttributeUseNotes
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

See also

Section titled “See also”