...

Contents

Overview

The topology.xml is an mandatory configuration file when you are setting up an IFD-environment. This configuration file is used to configure the topology of a region.

...

The topology.xml plays a central role in configuring an IFD-environment since it is used to configure the forecast panel which is the central panel in an IFD-environment.

Configuration

Nodes definition

The topology of a region is configured by defining the indvidual nodes off a region and grouping them. Below an example from the topology of the abrfc region

...

by using the tag previousNodeId. In the example above we can see that EGLN5  is upstream of node CMMN5. The connectivity between nodes is visualised in the topology panel.

Configuration options which apply to all nodes

The topology.xml has two types of configuration options. The first group is applied to all nodes, the second group is applied to individual nodes. In this part the first group of options will be explained.

...

These global options are configured at the top of the topology.xml before the definition of the nodes.

forecasterHelperDirectories

When present, this element specifies the directories where the forecaster helper should look for the files instead of the INFORMATION_PANEL_FOLDER property in oc_global.properties

enableOriginalButtons

Since 2014.01. By default the toolbar with 2 buttons is use: buttons 'Run' and 'Run approved forecast'. If a group node is selected, both buttons start the workflow of that node. When this element is set to true, the original toolbar with 4 or 5 buttons will be used. The original buttons are: 1) 'Switch to edit/forecast mode' (optional), 2) 'Go to next segment', 3) Re-run segment', 4) 'Re-run forecast group', and 5) 'Run approved forecast'. 

enableAutoRun

This option is set to true by default. If a topology node is selected in the forecast panel and a workflow is configured for this node and the option is enabled than the associated workflow will automatically run. By setting this option to false this behaviour can be switched off. Note: This option only works if enableOriginalButtons is set to true.

enableAutoSelectParameters

This option is set to false by default. In a node is selected and a filter is configured for that node than the filter will be selected automatically. If this option is also enabled than the parameters of that filter will also be selected automatically. Because the parameters are also selected after selecting the node the plot display will automatically show the time series of the filters in the plot display.

enableRunUpstreamServerNodes

When this option is set to true upstream server nodes with a workflow are run at the server prior tot running the selected server node.

enableRunAllPreviousNodes

If this option is enabled and a node is run, all previous nodes in the topology tree are run before running the selected node, even if the nodes are not connected by the defined topology. Default this option is not enabled, then only the upstream nodes will be run.

enableSelectNodesFromMap

This option is set to false by default. If this option is enabled it will be possible to select nodes by clicking on the location in the map, if that node has a locationId and a filterId configured in the Topology file.

...

Default is false. When this option is set to true all edits will be automatically saved to the database without having to press apply or confirm when a node is run.

enableCrossGroupReferencing

By default the topology only considers nodes which are part of the same group as being linked to the current node.

...

If that node is however part of another group then FEWS will ignore that node despite the fact that it is linked to that node.

selectFirstPlotOnSelectionChange

When selecting an other topology node the (thumbnail) plot is selected that shows the same parameter or location as currently displayed. To revert to the behaviour of 2016.01 must set this option to true.

Configuration options which apply to individual nodes

The second group of configuration options are applied to indvidual nodes or a group of nodes. These options are defined in the nodes to which these options should be applied.

Groupnodes (<nodes>)

The following options are available for groupNodes:

...

All options are optional.

showModifiers

Since 2014.01. This element will enable that modifiers are shown and editable at groupNodes

properties

These properties can be referenced in workflow files and moduleconfig files with $keys$, similar to global properties. These properties overrule the global properties and module properties.

Please note that Topology properties are only possible for local runs and not for server runs!

WorkflowId

The workflowid is optional for a node. If a workflow is configured this workflow is automatically started after selection of the node if the option enableAutorun is set to true. The workflow can also be started from the forecast panel or the modifier panel.

moduleInstanceId

SecondaryWorkflowId

It is possible to run a second (supporting) workflow from the IFD. If a secondary workflow is configured an additional button will be shown in the button panel.

The running of a the secondary workflow will not have any influence on the icons in the topology panel.

RunSecondaryWorkflowAtServer

By default the secondary workflow will in the same mode as the primary workflow. If the primary workflow is a configured to run as a local (IFD) run then the secondary workflow will also as run as an IFD run.

The default behaviour can be changed with this option.

ModuleInstanceId

When no moduleInstanceId is specified, all moduleInstances in the workflow are executed. When you specify a modulInstance, only that specific modulInstance will run. Note: this will only work for local runs.

StateSelection

The forecast panel also allows the forecaster to select a state. The default state selection can be configured with this option.

...