Versions Compared

Key

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

...

Configuration Item

Directory on filesystem

Table name in database

Single/
Multiple

Transformation coefficient sets for specifying ranges or conditions in locations in specific time periods.CoefficientSetsFilesCoefficientSets

Cold states for modules. Zip file containing model specific data exported by GA usually before running a model.

ColdStateFiles

ColdStates

Multiple

CorrelationEvents describing discharges, levels or other obtained observations for historical floods.CorrelationEventSetsFilesCorrelationEventSets
CorrelationEvent travel times describing  travel time for events from location to location.TravelTimesFilesCorrelationTravelTimes

Definition of layout of user displays, including What-if scenarios, Grid Display, etc.

DisplayConfigFiles

DisplayConfigurations

Multiple

Flag conversions between external sources (e.g. telemetry, modules) and flags used in Delft-FEWS internally.

FlagConversionFiles

FlagConversions

Multiple

Icons used in main map display and button bar

IconFiles

Icons

Single

Mapping definition of ID's between external sources (e.g. telemetry, modules) and ID's used in Delft-FEWS internally.

IdMapFiles

IdMaps

Multiple

Map layers (shape files) used in main map display and spatial interpolation

MapLayerFiles

MapLayers

Single

Module configuration for handling data and running forecasting models

ModuleConfigFiles

ModuleInstanceConfigs

Multiple

Zipped files containing datasets for modules used by the forecasting system.

ModuleDataSetFiles

ModuleInstanceDatasets

Multiple

Definition of module parameters stored in Delft-FEWS

ModuleParameters

ModuleParameters

Multiple


PiClientConfigurationsPiClientConfigurations
 Triggers export/import for modules.PiServiceConfigurationsPiServiceConfigurations

Regional configuration, including all locations, parameters etc.

RegionConfigFiles

RegionConfigurations

Single

Images used in reports.

ReportImageFiles

ReportImageFiles

Single

HTML, css, js template files used in creating HTML reports for use on the web server.

ReportTemplateFiles

ReportTemplates

Multiple

 Several XML files describing some of the settings specific to the Operator Client used (e.g. client configuration, linux / windows directories)RootConfigFilesRootConfigFilesMultiple

System configuration items, including the plug-ins available to the system, definition, icons etc.

SystemConfigFiles

SystemConfigurations

Single

Unit conversions between external sources (e.g. telemetry, modules) and units used in Delft-FEWS internally.

UnitConversionFiles

UnitConversions

Multiple

Workflow configuration for running sequences of modules.

WorkflowFiles

WorkflowFiles

Multiple

Versioning of configuration and XML file naming conventions

Warning

NB. The "default" versioning name convention described here is not required / recommend anymore for new configurations.

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 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:

Info

<Name of XML configuration file>SPACE<Version number>SPACE<default>.xml

Another version of configuration will have a different version number. The <default> item is omitted. Examples:

...

In the central database active versions of configuration items have synchLevel 11 whereas inactive configuration files have synchLevel 0.

Naming conventions for defining module config files

...

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 XML 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.

Versioning of configuration and XML file naming conventions

Warning

NB. The "default" versioning name convention described here is not required / recommend anymore for new configurations.

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 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:

Info

<Name of XML configuration file>SPACE<Version number>SPACE<default>.xml

Another version of configuration will have a different version number. The <default> item is omitted. Examples:

exampledescription
Explorer 1.00 default.xmlA "default" version of the configuration settings for the FEWS Explorer
Explorer 2.00.xmlA second version that is not made active, since it has not the "default" tag.

In the central database active versions of configuration items have synchLevel 11 whereas inactive configuration files have synchLevel 0.