WhatWebOCComponentSettings.xml
Requiredno
Description

Allows for configuration of the layout of Web OC Components

Schema location


Contents

Introduction

The Web OC has default behaviour of Web OC components. Components are for example:

  • Charts
  • Map
  • Schematic Status Display
  • Data Analysis Display
  • Run Task panel
  • Dynamic Report Display
  • Document Displays

The WebOCComponentSettings.xml is added to the Delft-FEWS configuration to allow for tailoring the represenation of these components. Please note that as of 2024.02 not all components already have custom configuration options.

Configuration 

Currently the following components have configuration options in the Web OC component settings:

  1. Map
  2. Charts
  3. SSD (schematic status displays)

Applying Component Settings

There are three places where component settings can be referenced:

  1. In the WebOperatorClient.xml, under the <topologyDisplay> element. The componentSetting that is configured here can seen as the default component settings for the whole topology display, as it will apply to every node.
  2. In the Topology.xml, under the <node> element. 
  3. In the WebOCDashboards.xml, under the <item> element.

If two component settings are configured for a display (e.g. both in the WebOperatorClient.xml and on the Topology node), than a union of the two is made where the component setting that is configured "deeper", as in closer to the data definition - is given preference. So if for example the legend element is configured like this:

  • In the component setting referenced in the WebOperatorClient.xml : <legend enabled="true"/>
  • In the component setting referenced on the Topology.xml node:<legend enabled="false">
  • Then the result will be: <legend enabled="false"> 

As per design, there are a maximum of two component settings used:

  1. The component setting in the WebOperatorClient;
  2. A display specific component setting. This can be either:
    1. component setting on a topology <node>
    2. component setting on a Web OC dashboard <item>

If both the topology <node> that is referenced in a Web OC Dashboard and the <item> in the Web OC dashboard have a component setting configured, than only the one on the <item> element will be used. 











  • No labels