Page History

...

Icon shown in browser tab. Can be specified using a fully qualified domain name or using a relative path. When using a relative path the file is expected to be in the WebResources configuration folder.

defaultComponent

The component which will be shown after startup of the Web OC.

splashScreen

Splash screen for Web OC. Image file is expected to be in the WebResources configuration folder.

helpMenu

Optional menu that appears on the bottom left of the Web OC. Menu items can be configured as external url and/or path to a HTML display configured in the Web OC component section. See configuration example below.

timeSettings

If configured, users will be able to change the relative view period for Web OC time series charts by using the down menu in the upper right corner of Web OC. Multiple viewPeriodPresets can be configured (see config example below). Configured view periods are relative to browser time. Additionaly, users can select a custom view period in Web OC. The selected view period will only apply to time series charts and not gridded data visualization.

agreeToTermsAndConditions

If enabled (default is false) a pop-up will be shown at start up of Web OC, showing the Terms and Conditions that aply to Web OC. Users can only continue to browse Web OC after selecting "I Agree". Please note that these terms and conditions have to be available in WebResourceFiles with file name: terms-and-conditions.html. Terms and conditions will be stored in local cache.

components

In the components section the order of components and components specifics can be configured , such as: name of components and permissions. For more information on Web OC components see: https://deltares.github.io/fews-web-oc/configuration/. By default, only the Topology component will be visible.

Example config file

Code Block

<?xml version="1.0" encoding="utf-8"?>
<webOperatorClient xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews https://fewsdocs.deltares.nl/schemas/version1.0/webOperatorClient.xsd">
	<general>
		<title>Delft FEWS Web Operator Client</title>
		<icons>
			<logo>logo.png</logo>
			<favicon>favicon.svg</favicon>
		</icons>
		<defaultComponent>topologyDisplay</defaultComponent>
		<splashScreen>splash.png</splashScreen>
		<helpMenu>
			<url name="Deltares">https://www.deltares.nl/</url>
			<url name="Delft-FEWS Web OC">https://github.com/Deltares/fews-web-oc</url>
			<path name="Terms and Conditions">terms-and-conditions</path>
		</helpMenu>
		<timeSettings>
			<showtimeSettings>true</showtimeSettings>
			<viewPeriodPresets>
				<relativeViewPeriod unit="day" label="last month" start="-31"/>
				<relativeViewPeriod unit="day" label="last week" start="-7"/>
				<relativeViewPeriod unit="day" label="next week" end="7"/>
				<relativeViewPeriod unit="day" label="last month & next week" start="-31" end="7"/>
			</viewPeriodPresets>
		</timeSettings>
		<agreeToTermsAndConditions enabled="true"/>
	</general>
	<components>
		<spatialDisplay enabled="false">
			<title>Spatial Display</title>
		</spatialDisplay>
		<systemMonitor enabled="false"/>
		<topologyDisplay enabled="true">
			<title>Overview</title>
			<defaultPath>
				<nodeId>node_defined_in_topology_xml</nodeId>
			</defaultPath>
			<showLeafNodesAsButtons>false</showLeafNodesAsButtons>
			<enableTaskRuns>false</enableTaskRuns>
			<showActiveThresholdCrossingsForFilters>true</showActiveThresholdCrossingsForFilters>
		</topologyDisplay>
		<schematicStatusDisplay enabled="false"/>
		<htmlDisplay enabled="true" showInNavigationMenu="false">
			<title>Terms and Conditions</title>
			<path>terms-and-conditions</path>
			<url>terms-and-conditions.html</url>
		</htmlDisplay>
	</components>
</webOperatorClient>

...

Page tree

Versions Compared

Old Version 17

New Version Current

Key