Introduction
The configuration of DELFT-FEWS is defined in a set of XML files. In this section the different parts of the configuration are introduced. An understanding of these different parts of the configuration is required before attempting configuration of a DELFT-FEWS system.
When dealing with the configuration, it is important to note that the configuration may be retrieved from the local file system or from the local database.
- In the former case the configuration is a set of directories, each containing different parts of the configuration. These directories are all contained under the Config directory.
- In the latter case the configuration is contained entirely within the local database in a set of tables, each table containing different parts of the configuration. Each of the tables in the local database reflects one of the sub-directories in the file system.
When initiating DELFT-FEWS, it will first look for configuration stored on the local file system. If this is found, then the system will expect to use all configuration from the file system. If the Config directory is not available the system will expect to use all configuration from the database. If neither is found then an appropriate error message is issued and the system will stop.
The configuration stored in either the Config directory of the database is configuration that is common to all versions of an implementation of DELFT-FEWS for a particular forecasting system. In the live system situation the contents of the database will be synchronised between all operator clients and forecasting shell servers in the system, and is therefore expected to be identical in all parts of the system.
Besides this configuration that is synchronised, there is also a small set of XML files referred to as the root configuration files. These may be unique to each operator client and/or forecasting shell server. This root configuration is required to identify for example if the particular instance of DELFT-FEWS is operating in stand-alone mode or as an operator client, and for the latter cases information such as IP-addresses for the Master Controller the operator client should log on to. These root configuration files are always used from the file system. They have no effect on the hydrological configuration and are normally not changed during configuration of the forecasting system side of DELFT-FEWS.
Elements of the configuration
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 system.
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 |
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 |
Table 2 Overview of different configuration items contained in the file system only
Configuration Item |
Directory on File System |
Root Configuration. 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 directory |
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 naming convention is introduced to identify which of the possible multiple versions are used as a default.
The naming convention for the default version:
<Name of XML configuration file>SPACE<Version number>SPACE<default>.xml
Other version of configuration will have a different version number. The <default> item is omitted.
Example:
The default version of the configuration settings for the FEWS Explorer could be:
Explorer 1.00 default.xml
A second version may exist. This should then not have the <default> item in the file name:
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.
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 DELFT-FEWS, as the primary validation makes sure the syntax of the configuration made is correct.
There are two types of configuration in DELFT-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.
