Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin


scrollbar


Section
bordertrue


Column
width50%
Introduction

Overview

All functionality used

...

by Delft-FEWS in

...

processing

...

data, running external forecasting modules and running external

...

adapters is achieved with use of modules and workflows. A Module is a tool, and a configuration on how to apply it (with what options and on what data) is a module instance.

...

A variety of modules is available in
DELFT-FEWS to provide specific functionality. Examples include interpolation,
running external modules, data import etc. The modules available are defined in
the ModuleDescriptors in the System configuration. This defines the Java
classes used to run each module, and assigns a recognizable name for that
module (e.g. Transformation). These Java classes implement the workflow plug-in
interface to DELFT-FEWS. The list of available modules can be extended through
adding classes implementing this plug-in interface.

To carry out a specific piece of data
processing, and instance of a module is configured. This instance specifies the
input data, the output data and the required steps in processing the data. Each
module instance is given a unique name with which it is identified in the
module instance section of the configuration. To link an instance of a module
to the type of module available, the module instance is registered in the
ModuleInstanceDescriptors in the Regional Configuration section.

The list of module instances in
DELFT-FEWS includes:

  • Interpolation Module
  • Transformation Module
  • Import Module
  • Export Module
  • General Adapter Module
  • Lookup Table Module
  • Correlation Module
  • Error Correction Module
  • Report Module
  • Report Export Module
  • Performance Indicator Module
section

A Workflow is a sequence of module instances and thus describes in what order the module configurations should be executed. A common way to start a workflow is in the manual forecast dialog or by running a node in the Interactive forecast dialog (IFD).

The availability of modules is set, but module instances and workflows are configured (Note that multiple module instances can make use of the same module). For a new module instance or workflow, make a new xml file in the ModuleConfigFiles or WorkflowFiles folder, and make an entry in the ModuleInstanceDescriptors or WorkflowDescriptors file. The entry should have an id that corresponds to the xml file name that was just created. Look at the schema below for more details.

The module used in the module config file is defined by the xsd schema. This is the schemaLocation attribute in the first element in the module config xml file. What schema corresponds to what module can be found in the documentation of each module. A list of all modules can be found in the content list.

  • ModuleConfigFiles = Specify how that module instance must be run
  • ModuleInstanceDescriptors = Lists all module instances that can be run (every entry corresponds with one file in the ModuleConfigFiles folder)
     
  • WorkflowFiles = Lists which module instances should be run for that workflow
  • WorkflowDescriptors = Lists all workflows (every entry corresponds with one file in the WorkflowFiles folder)


Image Added

Info
Many of the configuration items required will include references to strings. To avoid duplication, a tag can be defined in the global.properties file in the root configuration and the tag name used in the XML file (see also System Configuration).



Column
width50%

Contents

Children Display