...
Within Delft-FEWS, the datasets are exported to the archive in a workflow using the ExportArchiveModule. This workflow needs to be scheduled on a regular interval to archive all relevant data. Simulated data sets are preferably exported to the archive from the workflow which that created the simulation. This is especially the case when modifiers are used in the simulation. When a simulation is not exported to the archive directly, it might be that some modifiers which are that were used in the simulation are deleted are or changed in between. This will cause that it won't be possible to archived all the used modifiers correctlythe mean time. This can then result in archived simulation data without the modifiers that were used to produce them.
To prevent dependencies on other processes, the ExportArchiveModule is envisioned to write directly into the archive file storage. The FSS thus needs to be able to have write access to those disks.
For each kind of dataset, the ExportArchiveModule checks the database for changes over a (configured) relative period. It exports any all data which that meets the export instructions and that has changed within this period. Datasets are archived in a pre-defined predefined directory structure, which is based on areaId, date and dataset name.
The schema of the associated configuration file (Figure 4.1) is defined at:
http://fews.wldelft.nl/schemas/version1.0/exportArchiveModule.xsd.
Figure 4.1 Top level of Delft-FEWS exportArchiveModule.xsd
...
Archiving by using time series sets or workflow selection
The FEWS archive export exporting module has several exports in which data can be archivedoptions for exporting data. In all those exports, time series can be selected by either specifying the time series by using time series sets or it is possible to define by specifying a workflow in combination with a time series filter. In this case When specifying a workflow, all the time series which that comply to with the defined filter will be exported. By default the This filter will can be applied used to the time series of the 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. Or if One can also define a period is defined then , whereby all simulations or external forecasts for the defined that period will are be exported. When a time series filter is used then it is also possible to define a fileNamePrefix. The generated file name will then be prefixed with the defined prefix. This can be used to make the predefined filename more descriptive.
Generated file name
The paths of the folders to which the data will be 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 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_SETS60_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 | ||
---|---|---|
| ||
<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>
|
...
Element | Format | Description |
general ComplexType | ||
dataSetPeriod | string | By default the daily data sets are created. It also possible to create monthly data sets. For operational purposes it is recommend to use daily data sets. For migrating data from other systems to the FEWS archive it might be convenient to export the data in montly data sets. |
archiveFolder | string | Export destination folder, assumes that the account running the FEWS (FSS) application has write access |
relativePeriod | Exports entire the dataset by day. | |
idMap | string | idMap applied to translate internal FEWS identifiers to identifiers that meet NetCDF-CF criteria.E.g. netcdf does not allow a full stop ('.') in the variable name |
unitConversionsId | string | Id of UnitConversions to be used for unit mapping. Available since 2022.02, optional. |
omitMissingValues | bool | Available since 2022.02. If set to true, missing values won't be written to the export file. Optional, default is false. |
ignoreNonExistingLocationSets | bool | If this option is set FEWS will not log an error when an location set is not configured. |
---|---|---|
verifyExportedTimeSeries | bool | Deprecated since 2024.01 because this check takes much time and is not need any more. For previous versions, if this option is set to true, FEWS will verify if the data in the exported netcdf is the same as in the FEWS database. |
netcdfObservedExportActivities ComplexType | ||
fileName | string | should include nc extension, otherwise files will not be read. preferably no spaces |
areaId | string | area to which the dataset belongs |
sourceId | string | defines the source of the data set |
exportLocationAttributeAsNetCDFVariable | complex type | Since 2021.01, for archiving observed data. Adds a variable to the NetCdf file. Name of the variable is the value of ncVariable, the value is the configured location attribute of attributeId. |
ncMetaData | string elem. | optional metadata tags within NetCDF file following CF convention. Supported by the internal catalogue of the THREDDS Data Server |
includeFlags | bool | default=TRUE; if TRUE, a list of flags is stored, each value pointing to the associated flag |
includeTimeSeriesProperties | bool | default=TRUE, if TRUE the properties of the time series will also be stored in the NetCDF file. |
includeComments | bool | default=TRUE; if TRUE, a list of comments is stored, each value pointing to the associated comment |
thresholdGroupId | string | identifies FEWS ThresholdGroup which is used to detect threshold crossings to be highlighted in the metaData.xml |
timeSeriesSets | FEWS timeseries sets | |
workflowTimeSeriesSelection | In this tag the time series can selected by using a time series filter from either the current workflow or 1 or more other workflows. |
...