Page tree

Versions Compared

Key

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

...


Delft-FEWS can export simulations to the archive via the ArchiveExportModule (exportSimulations activity). Typically this archiving activity is included in the workflow that computes the final approved forecast.

It is however also possible to archive a simulation from a scheduled workflow. In this case a relative period (relativePeriod in schema) should be configured to indicate which time period should be archived. In addition the workflow id (workflowId in schema) should be configured which should be archived.  It is also possible to archive the current forecast to the archive. If the export is done without an relative period but not in the workflow which created the forecast the current forecast will be exported. If you have used modifiers in this workflow you should also configure the relatedWorkflowId. The modifiers which are applied in the last run of this workflow which also be exported to archive. This scenario is typically used when the simulation is published manually after the forecast has run and was reviewed.


The associated root directory structure of the Delft-FEWS export for this type of dataset is as follows:
<archiveRoot>/<yyyy>/<MM>/<areaId>/<dd>/simulated/<workflowId><TimeZero><DispatchTime>
Where <dd> refers to the date of the forecast time T0.
This directory holds the metaData.xml as well as runInfo.xml file with the FEWS taskrun properties (see Figure 3.8). Within this directory the following sub-folders may exist:
/timeseries, /reports, /modifiers, /states
The exportArchiveModule.xsd has a dedicated exportSimulated section to configure the messages that need to be archived (see Figure 3.7). The associated specification is given in Table 4.4.
Table 4.4 Delft-FEWS export configuration for archiving simulations

Element

Format

Description

GeneralExportForecastSection ComplexType

 

 

archiveFolder

string

Export destination folder, assumes that the account running the FEWS (FSS) application has write access

relativePeriod

 

Exports entire simulated timeseries by workflow, for any simulated forecast where database change (blob creation time) are detected within the relativePeriod (relative to T0). Existing timeseries files are overwritten*
If no relativePeriod is specified the Current simulated forecast is exported

workflowIdstringThis option should be in combination with the relativePeriod. Al the forecasts of the workflowId which exists in the relative period will be exported

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

relatedWorkflowIdStringIf the export is done without the relativePeriod and workflowId option but not in the workflow which created the forecasts the workflow id of the forecast you are trying to export should be configured to make sure that the modifiers which are used in this forecast will be exported.

ForecastActivities ComplexType

 

 

NetcdfForecastExportActivities ComplexType

 

 

NetcdfForecastExportActivity ComplexType*

 

 

fileName

string

without nc extension, preferably no spaces

areaId

string

area to which the dataset belongs

ncMetaData

string elem.

optional metadata tags within NetCDF file following CF convention. Supported by the internal catalogue of the THREDDS Data Server

includeFlags

bool

only applied for scalar values.
default=TRUE; if TRUE, a list of flags is stored, with each value pointing to the associated flag

includeComments

bool

only applied for scalar values.
default=TRUE; if TRUE, a list of comments is stored, with each value pointing to the associated comment

timeSeriesSets

 

FEWS timeseries sets

ReportsExportActivity ComplexType*

 

 

subfolder

string

Subdirectory within the 'reports' directory

moduleInstanceId

string

moduleInstanceId which created the report

ModuleStatesExportActivity ComplexType*

 

 

moduleInstanceId

string

moduleInstanceId which created the state

*When an existing file is locked while it needs to be overwritten, the export function writes a new temporary file. The FileSweeper, a scheduled process, renames this file when the lock is removed from the original file.


Figure 4.5 Delft-FEWS export configuration for archiving simulations

...