24 Topology

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 is defined by individual nodes and their connectivity. The topology can be viewed in the topology panel, which shows a block diagram of the topology, or in the forecast panel, which shows

a tree view of the topoloy. The behaviour of the forecast panel can also be configured in the topology-file. For example a workflow can be configured for a topology-node. By default the workflow will

run locally when the node is selected in the forecast panel. This can be switched off by setting the option enableAutoRun to false.

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

<topology xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="chps1/schemas/topology.xsd">    
  <nodes id="ABRFC">
    <workflowId>ABRFC_Forecast</workflowId>
    <nodes id="NMWTX" name="NMWTX">
    <workflowId>NMWTX_Forecast</workflowId>
    </node>
        <node id="EGLN5" name="EAGLE NEST DAM">
            <workflowId>EGLN5_Forecast</workflowId>
        </node>        
        <node id="CMMN5" name="CIMARRON 4SW">
            <previousNodeId>EGLN5</previousNodeId>
            <workflowId>CMMN5_Forecast</workflowId>

     

In the example above we see that the region abrfc has two leaf nodes CMMN5 and EGLN5. They are grouped in the group NMWTX. The group NMWTX is part of the toplevel node ABRFC.

This simple example shows how a topology can be defined and how the nodes and groupnodes can be grouped together. It is also possible to configure the connnectivity between nodes. This can be done

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.

The following global options are available

• forecasterHelperDirectories
• enableOriginalButtons
• enableAutorun
• enableAutoSelectParameters
• enableRunUpstreamServerNodes
• enableRunAllPreviousNodes
• enableSelectNodesFromMap
• enableAutoSaveOnRun
• nodes

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

If this option is enabled it will not be possible to select nodes by clicking on the location in the map.

enableAutoSaveOnRun

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.

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:

• showModifiers
• properties
• workflowId
• StateSelection
• localRun
• showRunApprovedForecastButton
• node
• nodes
• groupId

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.

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

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.

Possible options are:

• coldState
• coldStateFromCurrentRun
• warmState
• warmStateSelectionPeriod
• noInitialState
• relativePeriod

LocalRun

This option can be used to configure if the workflow of this node should be run locally or at the server. By default workflow of leaf nodes are run locally and workflows of group nodes are run at the server. Local runs are considered to be temporary runs. The results of these runs are deleted when FEWS is stopped.

Viewpermission

With this option an (optional) viewpermission can be configured. If a user is not allowed to view this node it will not be visible in the forecast panel.

Leaf nodes (<node>)

The following options are available for leaf nodes:

• showRunApprovedForecastButton
• localRun
• coldStateFromCurrentRun
• warmStateSelectionPeriod
• nodes
• coldState
• node
• moduleInstanceId
• groupId
• relativePeriod
• warmState
• noInitialState
• nextNodeId
• previousNodeId
• locationId
• filterId
• mapExtendId
• workflowId
• initialState
• localRun
• viewPermission

NextNodeId

This option is used to configure the next node of a topology node in the case that two topology nodes have configured a node to be the previous node. The nextNodeId indicates which node is considered to be the next node when going downstream by using the next segment button in the topology panel

PreviousNodeId

The connectivity between nodes is configured by using the previousNodeId-option.

LocationId

This option can be used to connect a location to a topology node. After selection of a node the configured locations are automatically selected in the filters.

FilterId

If a filter is configured to a topology node it will automatically be selected after selection of the topology node.

MapExtendId

If a mapExtendId is configured the map will automatically zoom to the configured map extend after selection of the node.

The remaining options:workflowId, initialState, localRun and viewPermission are described in the section groupNodes.

Schema