General Adapter file

The schema-companion to the Run a model (General Adapter) task guide, which walks the export → run → import cycle in full. This page is the generated field list.

At a glance

Purpose : Bridges FEWS to an external model executable: export inputs → run the model → import results (hop ④).

Folder : Config/ModuleConfigFiles/

Root element : <generalAdapterRun> (no version attribute — a module-run file; the model-format version knob is piVersion inside <general>)

Depends on : The series it exports, the model binary, and the parameters/locations it imports results into.

Minimal example

Config/ModuleConfigFiles/RainfallRunoffModel 1.00 default.xml

<?xml version="1.0" encoding="UTF-8"?>
<generalAdapterRun xmlns="http://www.wldelft.nl/fews">
  <general>
    <rootDir>%REGION_HOME%/Modules/rrmodel</rootDir>
    <workDir>%ROOT_DIR%/work</workDir>
    <exportDir>%ROOT_DIR%/input</exportDir>
    <importDir>%ROOT_DIR%/output</importDir>
    <dumpFileDir>%ROOT_DIR%/dump</dumpFileDir>
    <dumpDir>%ROOT_DIR%</dumpDir>
    <diagnosticFile>%ROOT_DIR%/output/diagnostics.xml</diagnosticFile>
  </general>
  <activities>
    <exportActivities>
      <exportTimeSeriesActivity>
        <exportFile>discharge_in.xml</exportFile>
        <timeSeriesSets>
          <timeSeriesSet>
            <moduleInstanceId>ImportObservations</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>Q.obs</parameterId>
            <locationSetId>AllDischargeGauges</locationSetId>
            <timeSeriesType>external historical</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>read only</readWriteMode>
          </timeSeriesSet>
        </timeSeriesSets>
      </exportTimeSeriesActivity>
    </exportActivities>
    <executeActivities>
      <executeActivity>
        <command><executable>%ROOT_DIR%/bin/rrmodel.exe</executable></command>
        <arguments><argument>%ROOT_DIR%</argument></arguments>
        <timeOut>600000</timeOut>
      </executeActivity>
    </executeActivities>
    <importActivities>
      <importTimeSeriesActivity>
        <importFile>discharge_out.xml</importFile>
        <timeSeriesSets>
          <timeSeriesSet>
            <moduleInstanceId>RainfallRunoffModel</moduleInstanceId>
            <valueType>scalar</valueType>
            <parameterId>Q.sim</parameterId>
            <locationSetId>AllDischargeGauges</locationSetId>
            <timeSeriesType>simulated forecasting</timeSeriesType>
            <timeStep unit="hour" multiplier="1"/>
            <readWriteMode>add originals</readWriteMode>
          </timeSeriesSet>
        </timeSeriesSets>
      </importTimeSeriesActivity>
    </importActivities>
  </activities>
</generalAdapterRun>

Field reference

Note

This is a large surface — the General Adapter supports many activity and serializer options (states, grids, NetCDF, rating curves). The full graph is below; the task guide covers the common cycle.

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

Element <generalAdapterRun>

Element	Type	Cardinality	Description
general	GeneralComplexType	required	General - i.e. activity independent - settings for this General Adapter run.
burnInProfile	BurnInProfileComplexType	optional · repeats	Burn-in periods for cold state starts.
activities	ActivitiesComplexType	required	Activities that will be performed within this General Adapter run.

GeneralComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description of the General Adapter run.
piVersion	piVersionString	optional	Version of the PI specification that is supported by the pre and post adapter One of: 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21, 1.22, 1.23, 1.24
inMemoryFileTransfer	booleanStringAttributeAndPropertyType	optional	Since 2022.02. When true all exported and imported files are transferred in memory between FEWS and execute activities. An execute activity can read the file content from var input = (InputStream) System.getProperties().get(file) and write to var output = (BufferedOutputStream) System.getProperties().get(file). All execute activities that transfer files to and from FEWS should be java activities that don't use a custom jre and check the System.getProperties().get(file) before they fall back to read/write the file on disk. Only NetCDF3 files can be transferred in memory. For NetCDF files the System.getProperties().get(file) contains a chunked byte array (byte[][]). An empty byte[][] array is set to tell an execute activity to save the nc file to memory as chunked byte array. The diagnostic file is also transferred in memory. Execute activities should always fall back on the files on disk when the System.getProperties().get(file) == null
rootDir	directoryStringType	required	Root directory of the module instance. This may be either a relative or absolute path.
workDir	directoryStringType	required	Working directory for several activities. Best to use %TEMP_DIR% as value. The OS location of the temp dir can be overruled with global property tempDir. When running the GA in debug mode using the manual forecast dialog (ctrl+R) the temp dir is preserved till FEWS exits
exportDir	directoryStringType	required	Directory to which the General Adapter will export data.
exportDataSetDir	directoryStringType	optional	Directory to which the General Adapter will export data sets.
updateExportDataSetDirOnlyOnChange	boolean	optional	Check all export dataset activities for changes before updating. If no change detected skip update. If change detected dataset is updated
purgeExportDataSetDirOnUpdate	boolean	optional	Option to purge content of export module dataset dir before updating. Default 'false' will result in overwriting of existing contents
exportIdMap	fileStringType	optional	Id of a file that contains mapping from internal to external location and parameter ID's.
exportUnitConversionsId	idStringType	optional	Id of UnitConversions to be used for export unit mapping
importDir	directoryStringType	required	Directory the General Adapter will import data from.
importIdMap	fileStringType	optional	Id of a file that contains mapping from external to internal location and parameter ID's.
importUnitConversionsId	idStringType	optional	Id of UnitConversions to be used for import unit mapping
dumpFileDir	fileStringType	required	Directory of the dump file.
dumpDir	directoryStringType	required · repeats	List of directories that the General Adapter will dump in case of a module failure. The binary dump will include all sub directories.
diagnosticFile	fileStringType	required	File containing diagnostic information about the module instance run. This file always is located in the importDir.
missVal	double	optional	Missing value definition for this TimeSeries. Defaults to -999 if not defined. An exception applies to NetCdf files: if exportMissingValue is not configured, then 9.96921e+036f is used
convertDatum	boolean	optional	Convert datum from Ordnance level during Import. Convert datum to Ordnance level during Export.
timeZone	TimeZoneComplexType	optional	Import data is converted from this timezone to GMT. Export data is converted from GMT to this timezone.
time0Format	string	optional	The date time format of the %TIME0% variable. This date time format is only used if there is no date time format specified in the arguments for the variable. yyyy = Year, MM = Month in year, dd = Day in month, HH = Hour in day (0-23), mm = Minute in hour, ss = Second in minute.
startDateTimeFormat	string	optional	The date time format of the %START_DATE_TIME% variable. This date time format is only used if there is no date time format specified in the arguments for the variable. yyyy = Year, MM = Month in year, dd = Day in month, HH = Hour in day (0-23), mm = Minute in hour, ss = Second in minute. The %START_DATE_TIME% variable only works in an importStateActivity (since 2014.02) and inside a template file for an exportCustomFormatRunFileActivity (since 2013.02).
endDateTimeFormat	string	optional	The date time format of the %END_DATE_TIME% variable. This date time format is only used if there is no date time format specified in the arguments for the variable. yyyy = Year, MM = Month in year, dd = Day in month, HH = Hour in day (0-23), mm = Minute in hour, ss = Second in minute. The %END_DATE_TIME% variable only works in an importStateActivity (since 2014.02) and inside a template file for an exportCustomFormatRunFileActivity (since 2013.02).
dateTimeFormat	GeneralAdapterDateFormatComplexType	optional · repeats	Since stable build 2015.01. Definitions of date time formats that can be used as arguments for the %TIME0%, %START_DATE_TIME% and %END_DATE_TIME% variables, e.g.: %START_DATE_TIME(idOfADateFormat)% %END_DATE_TIME(idOfAnotherDateFormat)%. Date time formats specified as arguments overrule the startDateTimeFormat and endDateTimeFormat specified above. The %START_DATE_TIME% and %END_DATE_TIME% variables only work in an importStateActivity (since 2014.02) and inside a template file for an exportCustomFormatRunFileActivity (since 2013.02).
ensembleMemberCount	int	optional	Deprecated and obsolete since 2009.01. Specify the member range in the workflow.
modelTimeStep	TimeStepComplexType	optional	The model time step adjusts the end time when necessary of the run period for this model and for all models/modules that will run after this model in the same task run

BurnInProfileComplexType

Burn-in profile for cold state starts. Used to replace first part of a time series. For time series with matching parameter-location ids, the first value is replaced by the initialValue. Element length defines the length of time series beginning that is to be replaced using linear interpolation.

Element	Type	Cardinality	Description
length	TimeSpanComplexType	required	Length of time series beginning that is to be replaced.
ignoreNonExistingLocationSets	boolean	optional	Since 2019.01. Option to skip export when location set does not exist.
timeSeries	BurnInProfileTimeSeriesComplexType	optional · repeats

ActivitiesComplexType

Element	Type	Cardinality	Description
startUpActivities	StartUpActivitiesComplexType	optional	Activities to start up a General Adapter run.
exportActivities	ExportActivitiesComplexType	optional	Activities to export data through the Published Interface format.
waitActivities	WaitActivitiesComplexType	optional	Since 2018.01 Activities to wait for event
executeActivities	ExecuteActivitiesComplexType	optional	Activities to execute the module or its adapters.
importActivities	ImportActivitiesComplexType	optional	Activities to import data through the Published Interface format.
shutDownActivities	ShutDownActivitiesComplexType	optional	Activities to shut down a General Adapter run.

TimeZoneComplexType

Element	Type	Cardinality	Description
timeZoneOffset	timeZoneOffsetStringType	required
timeZoneName	timeZoneStringType	required

GeneralAdapterDateFormatComplexType

Attributes

Attribute	Use	Notes
id	required	Identifier for this date time format. Use this identifier to refer to this date time format in the argument of a variable.

Elements

Element	Type	Cardinality	Description
dateTimePattern	nonEmptyStringType	required	Pattern for this date time format. This can be e.g. "yyyy-MM-dd HH:mm:ss". yyyy = Year, MM = Month in year, dd = Day in month, HH = Hour in day (0-23), mm = Minute in hour, ss = Second in minute.

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.

TimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

BurnInProfileTimeSeriesComplexType

Element	Type	Cardinality	Description
parameterId	idStringType	required	Parameter id of time series.
locationId	idStringType	required · repeats	List of location ids of time series.
locationSetId	idStringType	required	Location set id of time series.
initialValue	floatStringType	required	New start value for the time series.
initialValueAttributeId	idStringType	required	Since 2017.02. Id of the location attribute that contains the new start value for the time series.
lookupAttributeId	idStringType	required	Since 2019.01. Required when the attribute referenced by the initialValueAttributeId contains multiple values for a single location. When the look-up value is the nth value in the lookup attribute the nth initial value will be used.
lookupText	nonEmptyStringType	required	Since 2019.01. Required when the attribute referenced by the initialValueAttributeId contains multiple values for a single location. When the lookup text is the nth value in the lookup attribute the nth initial value will be used.

StartUpActivitiesComplexType

Element	Type	Cardinality	Description
purgeActivity	PurgeActivityComplexType	optional · repeats	Purges a single file or a set of files within a directory.
makeDir	MakeDirActivityComplexType	optional · repeats	Creates directories and, if necessary, any parent directories. Use this task for directories expected by the adapter but not used as input or output directory. Input and output directories are automatically created
unzipActivity	UnzipActivityComplexType	optional · repeats	Unzip a single file or a set of files within a directory.
zipActivity	ZipActivityComplexType	optional · repeats	Zip a single file or a set of files within a directory.

ExportActivitiesComplexType

Element	Type	Cardinality	Description
exportStateActivity	ExportStateActivityComplexType	optional · repeats	Exports a module instance state.
exportTimeSeriesActivity	ExportTimeSeriesActivityComplexType	optional · repeats	Exports time series.
exportDataSetActivity	ExportDataSetActivityComplexType	optional · repeats	Exports a data set. Triggers export of data set for active module instance. Since 2013.01 it is possible to export multiple data sets
exportMapStacksActivity	ExportMapStacksActivityComplexType	optional · repeats	Exports map stacks.
exportProfilesActivity	ExportTimeSeriesActivityComplexType	optional · repeats	Exports longitudinal profiles.
exportCustomFormatTimeSeriesActivity	ExportCustomFormatTimeSeriesActivityComplexType	optional · repeats	Since 2013.01. Calls a third party serializer that directly writes to a native model time series format. The serializer is not part of FEWS but is located in one of the jar files in the specified binDir
exportRatingCurveActivity	ExportRatingCurveActivityComplexType	optional · repeats	Exports rating curve for the configured locations. All rating curves within the run period and the last rating curve before or at the start of the run period are exported
exportPiTablesActivity	ExportPiTablesActivityComplexType	optional · repeats	Since 2016.01 Export time series with a single shared domainParameter at once to pi_tables.xml. All tables within the run period and the last table before or at the start of the run period are exported
exportParameterActivity	ExportParameterActivityComplexType	optional · repeats	Exports a module parameter set. Triggers export of parameter set for active module instance.
exportTableActivity	ExportTableActivityComplexType	optional · repeats	Exports a rating curve or other table for one or more locations
exportLocationAttributesCsvActivity	ExportLocationAttributesCsvActivityComplexType	optional · repeats	Since 2020.01 Exports a csv file with attribute values for locations
exportNetcdfActivity	ExportNetcdfActivityComplexType	optional · repeats	Exports scalar, grid or 1d/2d spectra time series to a NetCDF file. All time series specified inside one exportNetcdfActivity must have the same value type (grid, scalar, 1d spectra or 2d spectra). For this export it is required that all ensembles have exactly the same ensemble member indices. The usage of ensemble member id's (strings) is not supported yet.
exportRunFileActivity	ExportRunFileActivityComplexType	optional	Exports a pi run file in xml format. The run file contains general information about the run executed by the general adapter that is used by the pre and post adapter.
exportNetcdfRunFileActivity	ExportNetcdfRunFileActivityComplexType	optional	Since 2014.01. FEWS-10385. Exports a run file in netcdf format. The netcdf run file contains general information about the run executed by the general adapter that can be used by the pre and post adapter.
exportCustomFormatRunFileActivity	ExportCustomFormatRunFileActivityComplexType	optional · repeats	Activity to create a custom run info file. This activity replaces tags in a template file with actual (modified) values. The template file can contain location attribute tags between '@' signs, general adapter tags between '%' signs and global properties between '$' signs. The specified template file will be copied to the specified export file before the tags are replaced. So the template file itself is not changed. If the export file already exists, then it will be overwritten.
exportAreaSelectionActivity	ExportAreaSelectionActivityComplexType	optional	Exports an area selection mask as shape file or as PiMapStack. This activity requires an embedded polygon to be specified within the areaSelectionShapeFileBase64 field of the TaskProperties. This file is then available to be used by the pre and post adapter.
exportLocationAreaActivity	ExportLocationAreaActivityComplexType	optional	Exports an area selection mask in the form of a PiMapStack (currently NGMS only). This activity requires selectedLocationIds to be specified within the TaskProperties. This selection is then available to be used by the pre and post adapter.
exportCsvModuleRunTablesActivity	ExportCsvModuleRunTablesActivityComplexType	optional · repeats	Since 2015.01. Exports csv files as module run tables.
exportCoefficientSetActivity	ExportCoefficientSetActivityComplexType	optional · repeats	Exports configured coefficient set for the configured location or location set.

WaitActivitiesComplexType

Element	Type	Cardinality	Description
waitForFileCreation	WaitForFileCreationComplexType	optional · repeats	SINCE 2018.01. Used in combination with the parallel run option in the workflow. Wait until the specified file exits before starting the execute activities

ExecuteActivitiesComplexType

Attributes

Attribute	Use	Notes
executeImportActivitiesOnError	optional	default: false. Since 2014.03. FEWS-12495. Execute import activities after error occurred, activity with error still fails.

Elements

Element	Type	Cardinality	Description
waitForFileCreation	WaitForFileCreationComplexType	optional · repeats	SINCE 2018.01. Used in combination with the parallel run option in the workflow. Wait until the specified file exits before starting the execute activities
executeActivity	ExecuteActivityComplexType	optional · repeats	Executes a module or its adapters.

ImportActivitiesComplexType

Element	Type	Cardinality	Description
importStateActivity	ImportStateActivityComplexType	optional · repeats	Imports a module instance state.
importTimeSeriesActivity	ImportTimeSeriesActivityComplexType	optional · repeats	Imports time series.
importMapStacksActivity	ImportTimeSeriesActivityComplexType	optional · repeats	Import map stacks.
importNetcdfActivity	ImportNetcdfActivityComplexType	optional · repeats	Imports scalar, grid or 1d/2d spectra time series from a NetCDF file resulting from the run of the external modules. All time series specified inside one importNetcdfActivity must have the same value type (grid, scalar, 1d spectra or 2d spectra). For this activity the exportPlaceholderFile option only works for scalar and grid data, not for spectra data. Note: this activity is exactly the same as importPiNetcdfActivity, only the name is better, since the NetCDF format has nothing to do with the PI format.
importPiNetcdfActivity	ImportNetcdfActivityComplexType	optional · repeats	Deprecated, do not use. Please use importNetcdfActivity instead. Imports scalar, grid or 1d/2d spectra time series from a NetCDF file resulting from the run of the external modules. All time series specified inside one importPiNetcdfActivity must have the same value type (grid, scalar, 1d spectra or 2d spectra). For this activity the exportPlaceholderFile option only works for scalar and grid data, not for spectra data.
importProfilesActivity	ImportTimeSeriesActivityComplexType	optional · repeats	Import longitudinal profiles.
importShapeFileActivity	ImportShapeActivityComplexType	optional · repeats	Since 2017.02. Import shape file
importGeoJsonActivity	ImportGeoJsonActivityComplexType	optional · repeats	Since 2024.02. Imports GeoJson files
importCustomFormatTimeSeriesActivity	ImportCustomFormatTimeSeriesActivityComplexType	optional · repeats	Imports time series using a dedicated custom time series parser.
importCsvModuleRunTablesActivity	ImportCsvModuleRunTablesActivityComplexType	optional · repeats	Since 2015.01. Imports csv files as module run tables.

ShutDownActivitiesComplexType

Element	Type	Cardinality	Description
unzipActivity	UnzipActivityComplexType	required	Unzip a single file or a set of files within a directory.
zipActivity	ZipActivityComplexType	required	Zip a single file or a set of files within a directory.
purgeActivity	PurgeActivityComplexType	required	Purges a single file or a set of files within a directory.

PurgeActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
includeSubdirectories	boolean	optional	Optional, set this to true to allow deletion of nested subdirectories when using a wild card.
filter	fileStringType	required	File or files to be deleted. Use * and ? as wild cards.
minimumFileAge	TimeSpanComplexType	optional	Since 2023.02. Files older than this age are to be purged.

MakeDirActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
dir	fileStringType	required	Directory to be created.

UnzipActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
sourceZipFile	fileStringType	required	Zip File that is to be unpacked.
destinationDir	fileStringType	required	Destination directory to which source is unpacked.

ZipActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
sourceDir	fileStringType	required	Source directory that has to be packed. Wildcards are NOT allowed.
destinationZipFile	fileStringType	required	Zip file that to be created.
sourcePattern	fileStringType	required · repeats	Since 2019.02 eSource file pattern to select a subset of files to be packed, relative to the source directory specified in the sourceDir element. Wildcards are allowed. Tags between %% are allowed since 2022.01
fileNameDateTimePattern	nonEmptyStringType	required	Since 2024.02 Pattern to parse the date/time from the file name. e.g.'BXD0521000005_???????'yyyyMMdd_HHmmss'.nc'
fileNameRelativePeriod	RelativePeriodComplexType	required	Since 2024.02 Only files with file name in this period are allowed in this period

ExportStateActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
moduleInstanceId	idStringType	required	ID of the module instance for which the state will be exported.
ensembleId	idStringType	optional	Export state exported by this ensemble
stateExportDir	directoryStringType	required	Directory to which the module instance state is to be exported. This should be the path where the model expects to find the state file(s). This should be either an absolute path or a path relative to the exportDir defined in the general section. All contents of the stored state are exported to this directory.
stateSelection	StateSelectionComplexType	optional	State specific settings. They can be overruled by the TaskProperties. When not specified the state selection in the workflow descriptor is used. Time settings are relative to time0.
adjustTimeSeriesStartTime	boolean	optional	Adjusts the start time of time series to the exported state time within this general adapter run when start is overrulable or not specified. Default is true.
stateConfigFile	fileStringType	required	Only use this option in combination with a PI state description xml file. Fully qualified name of the XML file containing the state export configuration. This should be either an absolute path or a path relative to the exportDir defined in the general section. This option writes the input state file paths to a pi state description xml file.
stateLocations	StateLocationsComplexType	required	Only use this option in combination with a PI state description xml file. The locations of the state. In case the state consists of a whole directory only one stateLocation is allowed. This option writes the input state file paths to a pi state description xml file.
ensembleMemberIdSubstringPattern	string	optional	Use a sub string of the active ensemble member id as member id when resolving the state. Fore example use (...) to use the first three characters of the active ensemble member id
ensembleMemberId	string	optional	Use ensemble member id when resolving the state.
loopTimeStep	TimeStepComplexType	optional	When specified all activities are run in a loop to ensure on every cardinal time a state is produced. This has two advantages. States are equally and frequently distributed over time so it possible to start a update run from every point, also half way a cold update run that spans several days. The other advantage is the restriction on memory consumption, you can can run over months without going out of RAM. States will be produced on every cardinal time between the exported state time and time0. After finishing all activities, all the activities are run again until all states have been produced until time0. Do not specify a relative view period for the time series sets in the export activities when you need time series from input to output state time.
writeIntermediateState	boolean	optional	Write an extra state at end of the state search period that can be used in the next state run.
minimumRunLength	TimeSpanComplexType	optional	Some (HBV) models need a minimum run length to perform corrections at the end of the run.

ExportTimeSeriesActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the data will be exported. This file is always placed in exportDir.
exportBinFile	boolean	optional	When true the events in the PI time series file are written to a binary file instead of the xml file. The written xml file will only contain the time series headers and optionally a time zone. The binary file has the same name as the xml file only the extension is "bin" instead of "xml" During PI time series import the bin file is automatically read when available. The byte order in the bin file is always Intel x86.
ignoreRunPeriod	boolean	optional	When true the run period, written in the pi run file, will not be extended. When false the relative view period specified is used to extend the period. For "read complete forecast" the period of actual available data is used.
includeThresholds	boolean	optional	When true any thresholds for a time series will be written in its header
allowLocationSelection	boolean	optional	When true, the location selection will be applied. Otherwise all available locations will be exported.
ensembleMemberFormat	ensembleMemberFormatValueTypeEnumStringType	optional	By default the ensemble member index is written. Since FEWS 2012.01 it is also possible to use non integer ensemble member ids. Configure in the general section piVersion = 1.10 One of: index, name, hide
timeSeriesSets	TimeSeriesSetsWithConstraintsComplexType	required · repeats	TimeSeriesSet that defines what data is to be exported with the possibility to define constraints.
omitMissingValues	boolean	optional	When "read complete forecast" is specified this also affects the run period.
omitEmptyTimeSeries	boolean	optional	The time series is not exported when the time series is empty or when omitMissingValues = true and the time series is empty after removing the missing values.
omitEmptyFiles	boolean	optional	File is not written when file is empty (after omitMissingValues and omitEmptyTimeSeries)
forecastSelectionPeriod	RelativePeriodComplexType	optional	use this period to select all approved forecasts with forecast start time lying within this period
checkMissing	boolean	optional	Option to check the timeseries for missing values. This option works in combination with the Parameter flag 'allowMissing'. When omitted defaults to 'false'.
ignoreNonExistingLocationSets	boolean	optional	Since 2017.02. 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'.

ExportDataSetActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
coldStateDataSetName	idStringType	optional	Since 2015.02 FEWS-13044 Overruling dataset name when cold state was exported
moduleInstanceId	idStringType	required	ID of the module instance for which the state will be exported.
moduleDataSetName	idStringType	required	Since 2021.01. Name of the module data set file that will be exported
moduleDataSetNameMap	ModuleDataSetNameMapComplexType	required	Since 2014.02. FEWS-11097. Map a time series vale at time0 to a module data set name

ExportMapStacksActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the map stack will be exported. This file is always placed in exportDir.
gridFile	(inline)	required · repeats	Name of exported grids. The number of names must coincide with the number of locations being exported.
gridFormat	GridFormatEnumStringType	required	Format of the exported grids One of: ascii, ascii_llcorner, pcrgrid, usgs
ignoreRunPeriod	boolean	optional	When true the run period, written in the pi run file, will not be extended.
timeSeriesSet	TimeSeriesSetComplexType	required	Time series set information. ValueType must be equal to 'grid'.
properties	PropertiesComplexType	optional	Optional list of properties that can be used for configuring the export grids. USGS-properties: - nrBits (int) - nrDecimals (int)

ExportCustomFormatTimeSeriesActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the data will be exported. This file is always placed in exportDir.
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 except the Delft_Utils.jar. Only one class loader is created per binDir , serializers 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. This will delete the 'binDir' for an update, therefore this will be limited to a 'binDir' that is a sub directory of region home.
ignoreRunPeriod	boolean	optional	When true the run period, written in the pi run file, will not be extended. When false the relative view period specified is used to extend the period. For "read complete forecast" the period of actual available data is used.
allowLocationSelection	boolean	optional	When true, the location selection will be applied. Otherwise all available locations will be exported.
timeSeriesSets	TimeSeriesSetsWithConstraintsComplexType	required · repeats	TimeSeriesSet that defines what data is to be exported with the possibility to define constraints.
omitMissingValues	boolean	optional	When "read complete forecast" is specified this also affects the run period.
omitEmptyTimeSeries	boolean	optional	The time series is not exported when the time series is empty or when omitMissingValues = true and the time series is empty after removing the missing values.
omitEmptyFiles	boolean	optional	File is not written when file is empty (after omitMissingValues and omitEmptyTimeSeries)
forecastSelectionPeriod	RelativePeriodComplexType	optional	use this period to select all approved forecasts with forecast start time lying within this period
checkMissing	boolean	optional	Option to check the time series for missing values. This option works in combination with the Parameter flag 'allowMissing'. When omitted defaults to 'false'.

ExportRatingCurveActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the rating curve will be exported. This file is always placed in exportDir
onlyLatestAvailable	boolean	optional	SINCE 2019.02 If configured, then only the latest available rating curve in the run period will be exported
linearTableStageResolution	nonNegativeDouble	optional	Stage resolution. Use unit configured with 'displayUnit' in stage parameter group. If there is no 'displayUnit' , m are used. Every resolution 'step' (e.g. 0.5 ft) stage/flow pair are exported. The exporting stage/value pairs starts at rating curve minStage and goes up to the ratingCurve maxStage, if any available, otherwise up to the last rating curve stage value. Background info: the logarithmic interpolation in a rating curve needs a complex algorithm. For this reason it's it is convenient when we can convert to a more detailed table where we can use linear interpolation
locationId	idStringType	required · repeats
locationSetId	idStringType	required

ExportPiTablesActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity
exportFile	fileStringType	required	File to which the 1D spectra time series will be exported. This file is always placed in exportDir
timeSeriesSets	TimeSeriesSetsWithConstraintsComplexType	required · repeats	TimeSeriesSet that defines what 1D spectra time series should be exported to pi_tables.xml

ExportParameterActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
fileName	fileStringType	optional	Module name for parameter file being exported (Do not add file extension).
templateLocationLooping	TemplateLocationLoopingComplexType	optional	This tag can be used to generate a parameter-xml based on a template-xml. For each location in the locationset a group will be added to the parameter xml
moduleInstanceId	idStringType	optional	ID of the module instance for which the state will be exported.

ExportTableActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the table will be exported. This file is always placed in exportDir.
tableType	string	required	Type of table to be exported. One of: ratingCurve
operation	string	required	ID of the table to be exported. One of: selectValidTable, convertEquation
parameters	EquationConversionComplexType	optional	Parameters for the convertEquation operation.
locationId	idStringType	required · repeats	location id to select the rating curve
locationSetId	idStringType	required	Location set id of time series.

ExportLocationAttributesCsvActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the data will be exported. This file is always placed in exportDir.
exportEmptyHeaderFile	boolean	optional	When true an empty or non existing location set results in an empty header file, when false nothing will be exported. Default is false
locationIdColumn	LocationIdColumnComplexType	optional	First column which specifies the id of the location, can be overruled with an attribute
attributeColumn	ExportLocationAttributeColumnComplexType	required · repeats	Column for exported location attribute values
locationSetId	idStringType	required	Id of the location set for which the attributes will be exported
locationId	idStringType	required	Id of the location for which the attributes will be exported

ExportNetcdfActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the data will be exported. This file is always placed in exportDir.
netcdfFormat	netcdfFormatEnumStringType	optional	Default value is netcdf3. One of: netcdf3, netcdf4
metaData	MetadataComplexType	optional
geoDatum	geoDatumStringType	optional	Configure a GeoDatum conversion during export - applicable only to scalar data
exportZLayers	boolean	optional	Since 2017.02 Applicable only to scalar time series. When true then the scalar time series at the same geo point X,Y but different Z are considered to be Z-layers. Z values are used to create a z-dimension in the NetCdf file, and the time series values are written to the associated z element. Per parameter only one z-dimension is allowed. Different parameters may have different z-dimensions
writeRealizationDimension	boolean	optional	Since 2021.02 Applicable only to scalar and gridded time series with exactly one ensemble member. When false then this ensemble member is not written to the file and parameter in the file does not have realization dimension. A config error will be given when set to false and more ensemble members are found in the timeseries
ignoreRunPeriod	boolean	optional	When true the run period, written in the pi run file, will not be extended.
timeSeriesSets	TimeSeriesSetsWithConstraintsAndZLayerComplexType	required · repeats	TimeSeriesSet that defines what data is to be exported with the possibility to define constraints.
omitMissingValues	boolean	optional	Are missing values to be written to the export file or should they be left out.
omitEmptyTimeSeries	boolean	optional	The time series is not exported when the time series is empty or when omitMissingValues = true and the time series is empty after removing the missing values.
omitEmptyFiles	boolean	optional	File is not written when file is empty (after omitMissingValues and omitEmptyTimeSeries)
allowLocationSelection	boolean	optional	When true, the location selection will be applied. Otherwise all available locations will be exported.
ignoreNonExistingLocationSets	boolean	optional	Since 2017.02. 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'.
checkMissing	boolean	optional	Option to check the time series for missing values. This option works in combination with the Parameter flag 'allowMissing'. When omitted defaults to 'false'.
includeFlags	boolean	optional	When true any flags for a time series will be written. Available since 2026.02

ExportRunFileActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the general run information is exported. This should be either an absolute path or a path relative to the exportDir defined in the general section.
properties	PropertiesComplexType	optional	Kind of environment variables for the pre and post adapters. These properties are copied to the run file. This is also a convenient way way to pass global properties to a pre or post adapter. An adapter is not allowed to access the FEWS global.properties directly. Global properties (between $) are replace by there literal values before copied to the run file. These extra options makes an additional pre or post adapter configuration file unnecessary.

ExportNetcdfRunFileActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for this activity.
exportFile	fileStringType	required	Netcdf run file to which the general run information will be exported. This should be either an absolute path or a path relative to the exportDir defined in the general section.
properties	PropertiesWithLocationAttributesComplexType	optional	Optional. Properties in the form of key-value pairs that can be used to pass information to the pre and post adapter. These properties will be copied to the netcdf run file. These properties can be used as configuration for the pre and post adapter, so it is not needed to have a separate configuration file for the pre and post adapter. This is also a convenient way to pass global properties from FEWS to a pre or post adapter, since an adapter is not allowed to access the FEWS global.properties file directly. Global properties (between '$' signs) in these key-value pairs will be replaced by their literal values before they are copied to the netcdf run file.

ExportCustomFormatRunFileActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
templateFile	fileStringType	required	The pathname of the template file relative to the rootDir (or absolute path). This file can contain location attribute tags between '@' signs, general adapter tags between '%' signs and global properties between '$' signs.
exportFile	fileStringType	required	The pathname of the export file relative to the exportDir (or absolute path). This file is created during the workflow run and will be a copy of the template file in which the tags are replaced with actual (modified) values. If this file already exists, then it will be overwritten.
locationId	idStringType	optional	Optional. Location attribute tags in the template file will be replaced with the corresponding (modified) attribute values of the location with this locationId. If this is not specified, then location attribute tags will not be replaced.
fixedWidth	intStringType	optional	Since 2017.02, optional. All tags will be replaced with a fixed number of characters, spaces are inserted in front of the value where necessary. Note that when tags are replaced with text, the replacement text must be small enough to fit in the fixed width, otherwise the replacement text is used as is and the outputted value will therefore not conform to the fixed width. A warning is logged in this case.
numberOfDecimals	intStringType	required	Since 2017.02, optional. When replacing a tag with a number value, the specified number of decimals is used. Note that if configured, the fixedWidth must be large enough to fit all number values with the given number of decimals.
minNumberOfDecimals	nonNegativeIntegerStringType	required	Since 2023.02, optional. When replacing a tag with a number value, the specified minimum number of decimals is used. Note that if configured, the fixedWidth must be large enough to fit all number values with the given number of decimals.
maxNumberOfDecimals	nonNegativeIntegerStringType	required	Since 2023.02, optional. When replacing a tag with a number value, the specified maximum number of decimals is used. Note that if configured, the fixedWidth must be large enough to fit all number values with the given number of decimals.

ExportAreaSelectionActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the area selection will be exported. This file is always placed in exportDir. The specified file can have the extension shp for shape file or xml for a map stack in the case the grid location and gridFormat should also be specified
esriShapeFileGeoDatum	geoDatumStringType	required	By default the shape file is exported with WGS 1984 coordinates
gridLocationId	idStringType	required	Fews Location id to which the gridName is linked. When not specified a shape file is exported.
gridFormat	GridFormatEnumStringType	required	Format of the exported grids. When not specified a shape file is exported. One of: ascii, ascii_llcorner, pcrgrid, usgs

ExportLocationAreaActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the area selection will be exported. This file is always placed in exportDir.
gridLocationId	idStringType	required	Fews Location id to which the gridName is linked.
polygonLocationSetId	idStringType	required	Identifier for locationset for which to generate grid files for each. The locations should have polygons associated with them.
gridFormat	GridFormatEnumStringType	required	Format of the exported grids One of: ascii, ascii_llcorner, pcrgrid, usgs

ExportCsvModuleRunTablesActivityComplexType

Since 2020.02. Export csv files for ModuleRunTables.

Element	Type	Cardinality	Description
moduleInstanceId	idStringType	required	ID of the module instance for which the current ModuleRunTable will be exported.
charset	charsetEnumStringType	optional	Since 2020.02. Character set of the text in the csv file. Specify only when the data 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
description	string	optional	Since 2015.01. Optional description for the export activity.
exportFile	fileStringType	required	Since 2020.02. File the data will be exported to.
displayName	idStringType	required	Since 2020.02. Display name of the Module Run Table file that is to be exported.
onFailWarnAndContinue	boolean	optional	Since 2020.02. By design the activity will fail if a moduleRunTable with the requested ModuleInstanceId and display name is not found. To overrule this behaviour a warning will be logged but the activity won't fail.

ExportCoefficientSetActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
exportFile	fileStringType	required	File to which the coefficient set will be exported. This file is always placed in exportDir.
coefficientSetId	idStringType	required	Identifier of a coefficientSet to export.
coefficientSetFile	fileStringType	required	Name of the file that contains the coefficientSet to use. This name should not include the file extension.
locationId	idStringType	required · repeats
locationSetId	idStringType	required

WaitForFileCreationComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description of the execute activity.
file	fileStringType	required	File that should exist before continue
timeOut	nonNegativeIntegerStringType	required	Timeout to wait in milliseconds.

ExecuteActivityComplexType

Attributes

Attribute	Use	Notes
executeOnPreviousError	optional	default: false. Since 2019.02 Execute even after error occurred, run will still fail, can be useful to still process (partial) output

Elements

Element	Type	Cardinality	Description
description	string	optional	Optional description of the execute activity.
command	CommandComplexType	required	Command to execute. This can be either an executable or a Java class.
arguments	ArgumentsComplexType	optional	Arguments to be passed to the executable.
environmentVariables	EnvironmentVariablesComplexType	optional	Environment variables to be passed to the executable.
console	ConsoleComplexType	optional	Since 2018.01. Redirect output to log file and define trigger to restart the workflow. Doesn't work for java activities that don't run in their own jre
logFile	LogFileComplexType	optional · repeats	Since 2014.01. Optional. One or more text files that contain log information from the module that is executed. After the module has executed, the specified lines from these files will be imported in FEWS as log messages with the specified log level.
activityDurationWeight	nonNegativeDouble	optional	Weight of the activity compared to others, used for tracking progress percentage of the module. Can be any positive number, FEWS will compare the total weight configured in the module config file and compare it to the individual weights of the activities to calculate the progress percentage
timeOut	nonNegativeIntegerStringType	required	Timeout for execute activity in milliseconds.
ignoreExitCode	boolean	optional	For this activity no check should be done whether the executable returns a non zero exit code. A non zero exit code can prevent the post adapter from running. When the post adapter parses a log file the exit code can be ignored. The error in the log file is more descriptive than the error code.
maxNumberOfSimultaneousRuns	positiveIntegerStringType	required	Since 2013.01. FEWS-8674. Some models only allow a limited number of runs simultaneously, sometimes limited by license server. maxNumberOfSimultaneousRuns = 1 is exactly the same as waitForOtherRun = true. By default the number of runs is limited by the workflow and runInLoopParallelProcessorCount in the global properties.
waitForOtherRun	boolean	required	Since 2009.02. When an adapter is using shared writable resources (e.g. common blocks in a linked fortran library or writable static java fields) it will not allow multiple runs of this java class at the same time. When waitForOtherRun is true it will wait until any other run of the specified class is finished. When the executable only allows one instance set this option to true. Some executables only allow one instance due to licensing issues or temporary files that are used.
overrulingDiagnosticFile	fileStringType	required	File containing diagnostic information about activity. This file always is located in the importDir and overrules the global diagnostic file.
ignoreDiagnostics	boolean	required	For this activity no check should be done whether the diagnostics file is present or not

ImportStateActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
compressedStateLocation	warmStateLocation	optional	By default the warm state is zipped and stored as a blob in the database. For large states (>50MB) it is recommended to store the data outside the database in a directory. This directory is configured in the clientConfig.xml (optional element warmStatesDirectory). When using a stand alone system or using oracle and a single MC system it is possible to store larger grids inside the database. Expired states are removed automatically from this directory by the CompactCacheFiles workflow. The state description is still written to the database, the blob field will be empty One of: database, directory
expiryTime	CalendarTimeSpanComplexType	optional	By default the expiry time is the same as the original expiry tme of the forecast.
synchLevel	int	optional	Optional Synch level for state. Defaults to 0 if not specified. Configure synch level 20 when this state should be downloaded to the OC for use in IFD
stateConfigFile	fileStringType	required	Deprecated, do not use this if a pi state description xml file is not needed. Fully qualified name of the XML file containing the state import configuration. This should be either an absolute path or a path relative to the importDir defined in the general section. This option reads the output state file paths from a pi state description xml file.
stateImportDir	fileStringType	optional	Since 2014.01. Optional state import directory. This should be either an absolute path or a path relative to the importDir defined in the general section. If this stateImportDir is specified, then the importFile paths in this activity can be paths relative to this stateImportDir instead of absolute paths. This stateImportDir is only needed when you want to use relative importFile paths. If all importFile paths in this activity are absolute, then this stateImportDir is not needed and will not be used. This option does not use a pi state description xml file.
stateFile	ImportStateFileComplexType	required · repeats	Since 2014.01. One or more output state files from the model. The specified files will be imported. This option does not use a pi state description xml file.
stateFileDateTimePattern	nonEmptyStringType	optional	Since 2017.02. eg. 'State_'yyyyMMdd_HHmmss'.bin' Imports all files from the state import dir that matches this pattern. To get the state time the pattern is used. The work dir is used when the state import dir is not specified. This option does not use a pi state description xml file.
relativeExportFile	fileStringType	required	Since 2017.02. This relative path and name are used to store the imported file in FEWS. This path should be relative to the stateExportDir in the exportStateActivity that will be used to export this state file again for a future model run. If the imported output state file needs to be renamed before it can be used as input state file for a future model run, then the name of the relativeExportFile can be different from the name of the importFile. Since the 2023.02 is it possible to use question marks. The ? chars are copied from the input file name

ImportNetcdfActivityComplexType

Element	Type	Cardinality	Description
maximumSnapDistance	doubleStringType	optional	Since 2014.01. FEWS-10771. 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. This only works when the input format provides the coordinate system for the coordinates of 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 importNetcdfActivity, need to define separate import activities for that (one with maximumSnapDistance and one without maximumSnapDistance).
startWhileRunningExecuteActivities	boolean	optional	Default is false. If this is true, then this importActivity will run continuously during the configured execute activities. Additionally this importActivity will also run as part of the configured import activities as normal. This way it is possible to import data that is produced by an execute activity, while it is being produced. For instance if a model run writes new output data to an existing file after each timeStep, then the continuously running importActivity will immediately import the file, including the new data. This way the new data can be viewed in FEWS as soon as it becomes available, i.e. already during the model run. Currently the data that is imported during the execute activities can only be viewed after selecting "open most recent running forecast and adjust system time" from the debug menu in the FEWS Explorer window. If the running forecast is opened and selected in the data viewer, then the displays are updated each time when new data becomes available during the run. This feature only has effect for stand alone FEWS systems and for FEWS systems that use direct database access.
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 importNetcdfActivity, need to define separate import activities 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
description	string	optional	Optional description for the activity.
timeSeriesSets	TimeSeriesSetsComplexType	required	TimeSeriesSet that defines what data is to be exported with the possibility to define constraints.
ignoreNonExistingLocationSets	boolean	optional	Since 2019.01. Option to skip import when location set does not exist.
propertyProvidingTimeSeriesSet	TimeSeriesSetComplexType	optional	Since 2014.02. FEWS-11446 .TimeSeriesSet to take over property from.
properties	PropertiesComplexType	optional
exportPlaceholderFile	boolean	optional	if TRUE, at GA export the importFile will be exported with headers only, without any data. Usage : lets models know which data are expected at GA import. Note: this option is not supported for spectra data.
importFile	fileStringType	required	File the data will be imported from. This file is always placed in the importDir.
folder	directoryStringType	required	FEWS-11360. Folder in which import files are located, only available for Netcdf Import Activities
fileNamePatternFilter	nonEmptyStringType	optional	FEWS-11360. e.g *.xml to skip non xml files. Only the * and ? wild cards are recognized. Only available for Netcdf Import Activities
fileNameLocationIdPattern	nonEmptyStringType	optional	Since 2023.02. Regular Expression. When a match of the pattern in the filename is found, this will overrule the exernal grid location Id for the time series being imported. A simple pattern is (without quotations) '(.*)' which matches the whole filename. (.*)\.nc extracts the fle name without the .nc extension 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

ImportShapeActivityComplexType

Element	Type	Cardinality	Description
geoDatum	geoDatumStringType	optional	Indication of the coordinate system used - defaults to WGS-1984
charset	charsetEnumStringType	optional	Since 2023.01. Character set of the dbf file. 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
importFile	fileStringType	required	File to import. The file will be imported at time 0
shapeFileImportDir	fileStringType	required	Directory (relative to work dir or absolute) to import the files from
fileDateTimePattern	nonEmptyStringType	optional	eg. 'Shape_'yyyyMMdd_HHmmss'.shp' or 'provincies_'ddMMMyyyyHHmmss'.geojson'. Imports all files from the import dir that matches this pattern. To get the time the pattern is used. The work dir is used when the import dir is not specified. When not specified time0 is used. In this case a single file is expected in the import dir
shapeFileAttribute	ShapeFileAttributeComplexType	optional · repeats	Attribute to import from the file
valueAttributeId	nonEmptyStringType	optional	Id of the dbf file column. The values from this column are use to fill the polygons
timeSeriesSet	TimeSeriesSetComplexType	required

ImportGeoJsonActivityComplexType

Element	Type	Cardinality	Description
importFile	fileStringType	required	File to import. The file will be imported at time 0
shapeFileImportDir	fileStringType	required	Directory (relative to work dir or absolute) to import the files from
fileDateTimePattern	nonEmptyStringType	optional	eg. 'Shape_'yyyyMMdd_HHmmss'.shp' or 'provincies_'ddMMMyyyyHHmmss'.geojson'. Imports all files from the import dir that matches this pattern. To get the time the pattern is used. The work dir is used when the import dir is not specified. When not specified time0 is used. In this case a single file is expected in the import dir
shapeFileAttribute	ShapeFileAttributeComplexType	optional · repeats	Attribute to import from the file
valueAttributeId	nonEmptyStringType	optional	Id of the dbf file column. The values from this column are use to fill the polygons
timeSeriesSet	TimeSeriesSetComplexType	required

ImportCustomFormatTimeSeriesActivityComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the activity.
importFile	fileStringType	required	File the data will be imported from. This file is always placed in the importDir.
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 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 except the Delft_Utils.jar. Only one class loader is created per binDir , parsers 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.
timeSeriesSets	TimeSeriesSetsComplexType	required	TimeSeriesSet that defines what data is to be exported with the possibility to define constraints.
ignoreNonExistingLocationSets	boolean	optional	Since 2019.01. Option to skip import when location set does not exist.

ImportCsvModuleRunTablesActivityComplexType

Since 2015.01. Import csv files that can be viewed by the ModuleDataViewer.

Element	Type	Cardinality	Description
charset	charsetEnumStringType	optional	Since 2015.01. Character set of the text in the csv file. Specify only when the csv 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
description	string	optional	Since 2015.01. Optional description for the import.
importFile	fileStringType	required	Since 2015.01. File the data will be imported from.
displayName	idStringType	required	Since 2015.01. Display name of the csv file that is imported.
table	CsvTableMetadataComplexType	optional	Since 2015.01. Configure a mapping of the CSV columns to different database types. If no mapping is specified for a column, the column will be mapped to a string.
onFailWarnAndContinue	boolean	optional	Since 2019.02. By design the activity will fail if the configured importFile is not found. To overrule this behaviour a warning will be logged but the activity won't fail.

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

StateSelectionComplexType

Element	Type	Cardinality	Description
overrulingColdStateModuleInstanceId	idStringType	optional	Since 2017.02. Different module instance id used for finding cold state (when warm state is configured but can't be found, or always when cold state is configured)
coldState	ColdStateComplexType	required	Time independent default module instance state.
warmState	WarmStateComplexType	required	Module instance state for a particular timestamp.
backupWarmStateModuleInstanceId	idStringType	optional	Since 2019.01. Different module instance id used for finding warm state, when original warm state can't be found

StateLocationsComplexType

Attributes

Attribute	Use	Notes
type	required	Type of location: this is either file or directory

Elements

Element	Type	Cardinality	Description
stateLocation	StateLocationComplexType	required · repeats	In case the state consists of a list of files the location can only be a file name without a path.

TimeSeriesSetsWithConstraintsComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required · repeats
zParameter	idStringType	optional	Since 2020.01. Z layer parameter
locationConstraints	ConstraintsComplexType	optional	Since 2015.01. FEWS-11031 Restriction for the locations in the specified time series sets.

ModuleDataSetNameMapComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required	Since 2014.02. FEWS-11097. Time series set that determines the time serie for the value at T0 to pick the correct entry from the module data set map
map	ModuleDataSetMapComplexType	required · repeats	Since 2014.02. FEWS-11097. Map with different value-moduleDataSetName pairs, the value at T0 at the time serie from configured time series set will be used to pick the correct entry from the map

gridFile_inline

Element	Type	Cardinality	Description
locationId	idStringType	required	Fews Location id to which the gridName is linked.
gridName	nameStringType	required	For USGS BIL files this represents the file name. For ASCII/PCRASTER files this represents a file prefix used to store the separate time steps.

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

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

TemplateLocationLoopingComplexType

Element	Type	Cardinality	Description
locationModelLoop	LocationModelLoopComplexType	required · repeats	this tag can used to generate a group for each location in the locationSet for the defined model
locationTableLoop	LocationTableLoopComplexType	required · repeats	this tag can used to used to generate table from a template defined for a certain parameter

EquationConversionComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description for the parameters.
minimumLevel	float	required
maximumLevel	float	required
stepSize	float	required

LocationIdColumnComplexType

Attributes

Attribute	Use	Notes
columnName	required	Name / header of the column used for the location id

ExportLocationAttributeColumnComplexType

Attributes

Attribute	Use	Notes
columnName	required	Name / header of the column used for the values of this attibute
attributeId	required	Attribute that should be used to overrule the id of the location, useful if a different external id is desired for the location

MetadataComplexType

Element	Type	Cardinality	Description
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.

TimeSeriesSetsWithConstraintsAndZLayerComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required · repeats
zParameter	idStringType	optional	Since 2020.01. Z layer parameter
locationConstraints	ConstraintsComplexType	optional	Since 2015.01. FEWS-11031 Restriction for the locations in the specified time series sets.

PropertiesWithLocationAttributesComplexType

Element	Type	Cardinality	Description
description	string	optional	Optional description (this is never used in the code).
locationAttribute	LocationAttributePropertyComplexType	optional · repeats	Optional. Since 2021.02, it is possible to include location attributes as properties.
string	StringPropertyComplexType	required
int	IntPropertyComplexType	required
float	FloatPropertyComplexType	required
double	DoublePropertyComplexType	required	Since 2014.01
bool	BoolPropertyComplexType	required
dateTime	DateTimePropertyComplexType	required	Since 2014.01

CommandComplexType

Element	Type	Cardinality	Description
executable	fileStringType	required	Absolute path plus file name of the executable.
className	string	required	Fully qualified name of a Java class with method: public static void main(String [] args) throws Exception
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.
customJreDir	directoryStringType	required	Since 2016.01 Directory of specific jre that should be used to run java class. This could be required for modules that are not compatible with the java version used by FEWS
jvmArg	nonEmptyStringType	optional · repeats	Since 2016.01 Specifies extra jvm arguments for instance -mx512m to give the jvm more memory than the -mx256m that FEWS uses by default for the custom jre

ArgumentsComplexType

Element	Type	Cardinality	Description
argument	string	optional · repeats

EnvironmentVariablesComplexType

Element	Type	Cardinality	Description
environmentVariable	EnvironmentVariableComplexType	optional · repeats

ConsoleComplexType

Element	Type	Cardinality	Description
redirectToLogFile	fileStringType	optional	Since 2018.01. Copy console output of the executable to this log file.
progressPattern	nonEmptyStringType	optional	Since 2021.02. Pattern to extract a percentage number from a console log line, each line will be checked for the pattern when it comes through. The places of the question marks should contain the value. Will be read as double but written as integer rounded down. Question marks should be at the start or end of the pattern. For instance "progress: ???". The progress will be shown in the running tasks panel of the system monitor.
restartWorkflowLinePattern	nonEmptyStringType	required · repeats	Since 2018.01. As soon the executable writes a line, matching this pattern, to the console the complete workflow is restarted
maxRestartWorkflowCount	positiveInteger	required	Since 2018.01. Max number of times the workflow is restarted. Default is 2

LogFileComplexType

Element	Type	Cardinality	Description
file	fileStringType	required	Path and name of a log file to be filtered for log entries. This should be either an absolute path or a path relative to the rootDir defined in the general section.
errorLinePattern	nonEmptyStringType	required	Each line in the specified file that matches this pattern will be extracted as a FEWS error log message.
warningLinePattern	nonEmptyStringType	required	Each line in the specified file that matches this pattern will be extracted as a FEWS warning log message.
infoLinePattern	nonEmptyStringType	required	Each line in the specified file that matches this pattern will be extracted as a FEWS info log message.
debugLinePattern	nonEmptyStringType	required	Each line in the specified file that matches this pattern will be extracted as a FEWS debug log message.

CalendarTimeSpanComplexType

Attributes

Attribute	Use	Notes
unit	required
divider	optional
multiplier	optional

ImportStateFileComplexType

Element	Type	Cardinality	Description
importFile	fileStringType	required	Path and name of an output state file from the model. This file will be imported. This should be either an absolute path or a path relative to the stateImportDir defined in this activity. The %END_DATE_TIME% tag can be used here (since 2014.02), in case the state file name contains a timestamp of the end time of the run.
relativeExportFile	fileStringType	required	This relative path and name are used to store the imported file in FEWS. This path should be relative to the stateExportDir in the exportStateActivity that will be used to export this state file again for a future model run. If the imported output state file needs to be renamed before it can be used as input state file for a future model run, then the name of the relativeExportFile can be different from the name of the importFile. The %END_DATE_TIME% tag can be used here (since 2014.02), in case the state file name contains a timestamp of the end time of the run.

TimeSeriesSetsComplexType

Element	Type	Cardinality	Description
timeSeriesSet	TimeSeriesSetComplexType	required · repeats

ShapeFileAttributeComplexType

Attributes

Attribute	Use	Notes
attributeId	required	Attribute Id to import. This Id is associatedwith dbf column. Note: geojson file is first converted to the shp file
propertyKey	optional	Time series property key used to store the property value. By default, the key equals the attribute id

CsvTableMetadataComplexType

Since 2015.01. CSV columns will be mapped to database types so they can be viewed with the Module Data Viewer.

Element	Type	Cardinality	Description
stringColumn	CsvColumnComplexType	required	Since 2015.01. Column that contains string values
integerColumn	CsvColumnComplexType	required	Since 2015.01. Column that contains integer values
doubleColumn	CsvColumnComplexType	required	Since 2015.01. Column that contains double values
booleanColumn	CsvColumnComplexType	required	Since 2015.01. Column that contains boolean values. Should be set to either true or false.
dateTimeColumn	DateTimeCsvColumnComplexType	required	Since 2015.01. Column that contains the date and time values

ColdStateComplexType

Element	Type	Cardinality	Description
groupId	idStringType	optional	ID of the group of cold states to be used within the task run. If not specified default cold state will be used.
fixedStartTime	DateTimeComplexType	required	Absolute start time of the coldstate. Since 2012_02, used via upload in Admin Interface.
startDate	TimeSpanComplexType	required	Relative date of the cold state to the time0 of the taskrun.

WarmStateComplexType

Element	Type	Cardinality	Description
stateSearchPeriod	RelativePeriodComplexType	required	Time window used to search for a warm state. If no warm module instance state could be found the default cold state will be used instead.
searchForTransientStates	boolean	optional	A state run should not start with a transient state, default is true, set to false for state runs
transientStateExpiryTime	CalendarTimeSpanComplexType	optional	Expiry time of imported states with a time after the warm the state search period. These states should on be used by state runs.
coldStateTime	RelativeTimeComplexType	optional	When no warm state is found the default cold state is used. The time is a relative time against t0. By default the start time of the state search period is used.
insertColdState	boolean	optional	Deprecated, for backward compatibility only.

StateLocationComplexType

Element	Type	Cardinality	Description
readLocation	fileStringType	required	This should be either an absolute path or a path relative to the stateExportDir defined in this activity.
writeLocation	fileStringType	required	This should be an absolute path.

ConstraintsComplexType

Element	Type	Cardinality	Description
not	ConstraintComplexType	required
anyValid	ConstraintsComplexType	required
allValid	ConstraintsComplexType	required
idStartsWith	IdStartsWithComplexType	required	Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idEndsWith	IdEndsWithComplexType	required	Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idContains	IdContainsComplexType	required	Only the locations/parameters/qualifiers with an id that contains the specified text will be included
relatedLocationExists	RelatedLocationExistsComplexType	required	Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
attributeExists	AttributeExistsComplexType	required	Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
attributeTextStartsWith	AttributeTextStartsWithComplexType	required	Only the locations with attribute value start with the specified text will be included.
attributeTextEndsWith	AttributeTextEndsWithComplexType	required	Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
attributeTextContains	AttributeTextContainsComplexType	required	Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
attributeTextEquals	AttributeTextEqualsComplexType	required	Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
attributeTrue	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
attributeFalse	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.

ModuleDataSetMapComplexType

Attributes

Attribute	Use	Notes
timeSeriesValue	required	Since 2014.02. FEWS-11097 When equal to the value at T0, this module data set with moduleDataSetName will be selected
moduleDataSetName	required	Since 2014.02. FEWS-11097 Module data set to select when value at T0 corresponds to timeSeriesValue

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

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

LocationModelLoopComplexType

Element	Type	Cardinality	Description
model	string	required
locationId	idStringType	required · repeats
locationSetId	idStringType	required
locationConstraints	ConstraintsComplexType	optional	Since 2015.01. FEWS-11031 Restriction for the locations in the specified time series sets.
ignoreNonExistingLocationSets	boolean	optional

LocationTableLoopComplexType

Element	Type	Cardinality	Description
parameterId	idStringType	required
locationId	idStringType	required · repeats
locationSetId	idStringType	required

LocationAttributePropertyComplexType

Attributes

Attribute	Use	Notes
key	required
locationId	required
attributeId	required

EnvironmentVariableComplexType

Element	Type	Cardinality	Description
name	string	required	Name of the environment variable.
value	string	required	Value of the environment variable.

CsvColumnComplexType

Attributes

Attribute	Use	Notes
name	optional	Since 2015.01. Name of the column in the CSV file.
displayName	optional	Since 2015.01. Name of the column to be stored in FEWS. If not specified the name of the imported csv will be used.

DateTimeCsvColumnComplexType

Attributes

Attribute	Use	Notes
pattern	optional	Since 2015.01. Only required when the type of the column is text instead of timestamp
name	optional	Since 2015.01. Name of the column in the CSV file.
displayName	optional	Since 2015.01. Name of the column to be stored in FEWS. If not specified the name of the imported csv will be used.

DateTimeComplexType

Attributes

Attribute	Use	Notes
date	required
time	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.

ConstraintComplexType

Element	Type	Cardinality	Description
not	ConstraintComplexType	required
anyValid	ConstraintsComplexType	required
allValid	ConstraintsComplexType	required
idStartsWith	IdStartsWithComplexType	required	Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idEndsWith	IdEndsWithComplexType	required	Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idContains	IdContainsComplexType	required	Only the locations/parameters/qualifiers with an id that contains the specified text will be included
relatedLocationExists	RelatedLocationExistsComplexType	required	Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
attributeExists	AttributeExistsComplexType	required	Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
attributeTextStartsWith	AttributeTextStartsWithComplexType	required	Only the locations with attribute value start with the specified text will be included.
attributeTextEndsWith	AttributeTextEndsWithComplexType	required	Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
attributeTextContains	AttributeTextContainsComplexType	required	Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
attributeTextEquals	AttributeTextEqualsComplexType	required	Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
attributeTrue	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
attributeFalse	AttributeTrueOrFalseComplexType	required	Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.

RelatedLocationExistsComplexType

Attributes

Attribute	Use	Notes
locationRelationId	required	Id of the location relation (eg. UPSTREAM)

AttributeExistsComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute

AttributeTextStartsWithComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
prefix	required	The text the attribute value should start with

AttributeTextEndsWithComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
postfix	required	The text the attribute value should end with

AttributeTextContainsComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
contains	required	The text the attribute value should contain

AttributeTextEqualsComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
equals	required	The text the attribute value should match
modifierDependent	optional	When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display

AttributeTrueOrFalseComplexType

Attributes

Attribute	Use	Notes
id	required	Id of the attribute
modifierDependent	optional	When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display

See also

• Task guide: Run a model (General Adapter)
• Concept: The forecasting lifecycle (cold vs. warm state)
• Schema: generalAdapterRun.xsd