Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The FEWS archive exporting module has several options for exporting data. In all those exports, time series can be selected by either specifying the time series using time series sets or by specifying a workflow in combination with a time series filter. When specifying a workflow, all the time series that comply with the defined filter will be exported. This filter can be used to select the desired data type, parameter, location, qualifier, etc. for exporting. By default the filter will be applied to the time series of the current workflow. If a workflow id workflowId is defined then the data from the last or current run will be used. One can also define a period, whereby all simulations or external forecasts for the that period are be exported. 

Generated file name

The path paths of the folders to which the data will be archived will not differ between the two options. 

Generated file name

written is the same for both options, following the default folder structure for the respective data type. 

When exports are setup by specifying timeseries, one must configure the filename of the exported file.  If the workflow selection option is used to select which time series will be archived, it is not necessary to define the file names of the netcdf files in which the data will be archived. These names will be generated based on the timeseries which will be that are stored in the file.   The generated filename will be determined as follows.: 

<parameterid>_<qualifierIds>_<timestep>_<valuetype>.nc

A file containing scalar data for parameter Hobs with qualifier Q and time step SETS60 will be stored in file Hobs_Q_SETS66SETS60_scalar.nc.  It is also possible to configure a fixed prefix for each generated file name.

If timeseries only differ by module instance id then the filename is extended with the module instance id.  

Example

Below an example of an export for a workflow with a time series selection through a filter. In the workflowTimeSeriesSelection section, one must specify at least one filter and one workflowId (optional).

Code Block
languagexml
<exportArchiveModule xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/exportArchiveModule.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews">
	<exportExternalForecast>
		<general>
			<archiveFolder>$ARCHIVE_DIR$</archiveFolder>
			<idMapId>IdExportArchiveExternalForecasts</idMapId>
		</general>
		<activities>
			<netcdfExportActivities>
				<netcdfExportActivity>
					<fileNamePrefix>Deltares</fileNamePrefix>
					<areaId>test</areaId>
					<sourceId>test</sourceId>
					<includeComments>false</includeComments>
					<includeFlags>false</includeFlags>
					<useModuleInstanceIdAsSourceId>true</useModuleInstanceIdAsSourceId>
					<workflowTimeSeriesSelection>
						<timeSeriesFilter>
							<parameterId>Q</parameterId>
						</timeSeriesFilter>
					    <workflowId>some_sub_workflow</workflowId>      
					</workflowTimeSeriesSelection>
				</netcdfExportActivity>
			</netcdfExportActivities>
		</activities>
	</exportExternalForecast>
</exportArchiveModule>

...