...
The two tables below provide an overview of the configuration elements of Delft-FEWS. In the first table the configuration contained both in the database and on the file system is described. The second table describes the configuration that is only available on the file systemTable1 identifies for which type of configuration a single files per type is allowed and for which multiple instances for each type of configuration may exist.
Table 1 Overview of different configuration items contained either in the config directory or in the database.
Configuration Item | Directory on File System | Table name in file system | Single/ |
Definition of regional configuration, including all locations, parameters etc. | RegionConfigFiles | RegionConfigurations | Single |
Definition of system configuration items, including the plug-ins available to the system, definition, icons etc. | SystemConfigFiles | SystemConfigurations | Single |
Definition of modules for handling data and running forecasting models | ModuleConfigFiles | ModuleInstanceConfigs | Multiple |
Definition of workflows for running sequences of modules | WorkflowFiles | WorkflowFiles | Multiple |
Cold states for modules. Zip file containing model specific data exported by GA usually before running a model | ColdStateFiles | ColdStateFiles | Multiple |
Definition of mapping of ID's and parameters between external sources (e.g. telemetry, modules) and ID's and parameters defined in the DELFT-FEWS configuration | IdMapFiles | IdMaps | Multiple |
Definition of unit conversions between external sources (e.g. telemetry, modules) and units used in DELFT-FEWS | UnitConversionFiles | UnitConversions | Multiple |
Definition of flag conversions between external sources (e.g. telemetry, modules) and flags used in DELFT-FEWS | FlagConversionFiles | FlagConversions | Multiple |
Definition of layout of user displays, including What-if scenarios, Grid Display etc.) | DisplayConfigFiles | DisplayConfigurations | Multiple |
Definition of module parameters stored in DELFT-FEWS | ModuleParameters | ModuleParameters | Multiple |
Zipped files containing datasets for modules used by the forecasting system. | ModuleDataSetFiles | ModuleInstanceDatasets | Multiple |
Definition of HTML template files used in creating HTML reports for use on the web server. | ReportTemplateFiles | ReportTemplates | Multiple |
Map layers (shape files) used in main map display and spatial interpolation | MapLayerFiles | MapLayerFiles | Single |
Images used in reports etc | ReportImageFiles | ReportImageFiles | Single |
Icons used in main map display and button bar | IconFiles | IconFiles | Single |
...
Configuration Item | Directory on File System | ||
| Several XML files describing some of the settings specific to the Operator Client used (e.g. client configuration, IP addresses) | These files are contained in the root of the Delft-FEWS configuration directoryRootConfigFiles | RootConfigFiles | Multiple |
Versions of configuration and XML file naming conventions
For each of the configurations managed by Delft-FEWS in either the database or on the file system as described above, various versions of configuration may exist. Configurations that are active and used as a default can be identified both in the file system and in the database. On the file system a an optional naming convention is introduced to identify which of the possible multiple versions are used as a default. The naming convention for the default version:
...
Another version of configuration will have a different version number. The <default> item is omitted.
ExampleExamples:The default
| example | description |
|---|---|
| Explorer 1.00 default.xml | A "default" version of the configuration settings for the FEWS Explorer |
...
| Explorer |
...
| 2.00 |
...
| .xml | A second version |
...
| that is not made active, since it has not the "default" tag. |
The current practice does not advocate the use of the "default" tag naming convention any more.
In the central
Explorer 2.00.xml
If the configuration does not include the "default" item it will not be used. This configuration may be reverted to by adding the "default" flag - and removing it from the other file.
In the database the default version for each configuration item is identified in an associated table. For each configuration item a default table is available. This is identified by a table with the same name, prefixed by "Default". For example for the SystemConfigurations a table with the name DefaultSystemConfigurations identifies which of the available versions in the former table is to be used a default.with synchLevel 11.
Naming conventions for defining module config files
For complex forecasting systems the number of configuration files can be very large. This is particularly the case for the module config files, and because the names of these are used in Time Series Sets TimeSeriesSets for storing and retrieving data, the names given should be chosen logically. Before configuring large numbers of XML files it is wise to:
- define a naming convention and use this throughout. An example of such a convention is where a number of steps are used to process data prior to running a model.
A forecast model run for the HBV model in the Rhine may be defined in a module called:
HBV_Rhine_Forecast.xml
Data processing steps such as an interpolation module may then be called
HBV_Rhine_ForecastInterpolate.xml
Or a data merge module
HBV_Rhine_ForecastMergeInputs.xml
This clearly indicates the association between modules and brings structure to the configuration.
- with multiple more or less identifcal configuration files, use template configuration files. Template configuration files contain $ tagged variables that can be filled in as as properties when referred to in by other XML files.
XML Schemas and schema validation
Each configuration item contained in an XML file must be formatted as specified in an appropriate XML schema (XSD file). Validating against the schemas is an important step in configuring DELFTDelft-FEWS, as the primary validation makes sure the syntax of the configuration made is correct. There are two types of configuration in DELFTDelft-FEWS. In the first set, for each different schema type, only one default configuration file may be used and the name of the configuration file is unique. For the second set of configuration, multiple configuration types may be available for a specific schema. The names of these may be defined by the user. An XML file contained in the regional configuration element is then used to register these XML files with a user specified name to the system, and identify the type of configuration. This file is referred to as a descriptor file.Table1 identifies for which type of configuration a single files per type is allowed and for which multiple instances for each type of configuration may exist.