...
Typically, a new Delft-FEWS configuration is first setup in a Stand alone application, using a configuration setup on the local file system. In this case, the configuration is defined by a fixed set of directories, each containing different parts of the configuration. These directories are all contained under the Config directory.
...
When distributing the application, the configuration files are instead shared via a local datastore or the central database. The local datastore or the central database, stores the same local filesystem configuration directory structure in dedicated SQL tables, each table containing different configuration directory. The configuration in the central database belongs to a dedicated Delft-FEWS implementation of a particular forecasting system. In the live system situation the contents of the database will be shared between all operator clients and forecasting shell servers in the system, and is therefore expected to be identical in all parts of the system. In the central database active versions of configuration items have synchLevel 11 whereas inactive configuration files have synchLevel 0. The ConfigRevisionSets table defines the the active configuration.
...
A small set of XML files referred to as the root configuration files may differ between 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, or on windows or linux. These root Some configuration files have no effect on the hydrological configuration and are normally not changed during configuration of the forecasting system side of Delft-FEWSmay differ between operator client and/or forecasting shell server. These files have a filename with a meaningful prefix such as 'oc_windows_' or 'fss_linux_'.
Elements of the configuration
...
Configuration Item | Directory on filesystem | Table name in database | Single/ | Documentation | |||
| Transformation coefficient sets for specifying ranges or conditions in locations in specific time periods. | CoefficientSetsFiles | CoefficientSets | |||||
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. | CorrelationEventSetsFiles | CorrelationEventSets | CorrelationEvent travel times describing travel time for events from location to location. | TravelTimesFiles | CorrelationTravelTimes | ||
Definition of layout of user displays, including What-if scenarios, Grid Display, etc. | DisplayConfigFiles | DisplayConfigurations | Multiple | 07 Display Configuration | |||
Flag conversions between external sources (e.g. telemetry, modules) and flags used in Delft-FEWS internally. | FlagConversionFilesFlagConversionsFiles | FlagConversions | Multiple | 08 Mapping Id's flags and units | |||
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 | 09 Module datasets and Module Parameters | |||
Definition of module parameters stored in Delft-FEWS | ModuleParametersModuleParFiles | ModuleParameters | Multiple | 09 Module datasets and Module Parameters | |||
| Files for the PiClient. | PiClientConfigurationsPiClientConfigFiles | PiClientConfigurations | Multiple | ||||
| Triggers Triggers export/import for modules. | PiServiceConfigurationsPiServiceConfigFiles | PiServiceConfigurations | Multiple | ||||
Regional configuration, including all locations, location sets, parameters, several types of descriptors, etc.. | RegionConfigFiles | RegionConfigurations | Single | 04 Regional Configuration | |||
Images used in reports. | ReportImageFiles | ReportImageFiles | Single | 09 Report Module | |||
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) | 09 Report Module | |||
| Operating system configuration, clientConfiguration, global properties and patch.jar for supporting automated updates. | RootConfigFiles | RootConfigFiles | Multiple | 01 Root Configuration Files | |||
System configuration items, including the plug-ins available to the system, definition, icons etc. | SystemConfigFiles | SystemConfigurations | Single | 03 System Configuration | |||
| CorrelationEvent travel times describing travel time for events from location to location. | TravelTimesFiles | CorrelationTravelTimes | |||||
Unit conversions between external sources (e.g. telemetry, modules) and units used in Delft-FEWS internally. | UnitConversionFilesUnitConversionsFiles | UnitConversions | Multiple | 08 Mapping Id's flags and units | |||
Workflow configuration for running sequences of modules. | WorkflowFiles | WorkflowFiles | Multiple | 06 Workflow Configuration |
Naming conventions for defining module config files
...
| Warning |
|---|
NB. The "default" versioning name convention described here is not required / recommend anymore for new configurations. In general it is good practice to manage config versioning using SVN tooling, see https://en.wikipedia.org/wiki/Apache_Subversion. |
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:
...