11 Web Operator Client

What	WebOperatorClient.xml
Config group	SystemConfigFiles
Required	no
Description	Defines the look and feel of the Web Operator Client
schema location	https://fewsdocs.deltares.nl/schemas/version1.0/webOperatorClient.xsd

Introduction

The Web Operator Client configuration can be used to customize the look and feel of a Web OC. The configuration will be used by the PI REST Service: https://fewsdocs.deltares.nl/webservices/rest-api/v1/#get-/weboc/config.

general

In the general section some web oc wide configurations can be set among which the title, logo etc.

components

In the components section the order of the compontent, name of components and permissions can be configured.

Example config file

<?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>deltares_logo.png</logo>
			<favicon>deltares_favicon.svg</favicon>
		</icons>
		<defaultComponent>topologyDisplay</defaultComponent>
		<customStyleSheet>weboc-default-style.css</customStyleSheet>
		<splashScreen>image.png</splashScreen>
		<helpMenu>
			<url name="Help entry links to external url">https://example.com</url>
			<path name="Help entry links to path in Web OC">terms-of-use</path>
		</helpMenu>
	</general>
	<components>
		<topologyDisplay>
			<title>Topology Display</title>
			<defaultPath>
				<nodeId>topology_node_id</nodeId>
			</defaultPath>
			<showLeafNodesAsButtons>true</showLeafNodesAsButtons>
		</topologyDisplay>
		<htmlDisplay>
			<title>Terms of Use page</title>
			<path>terms-of-use</path>
			<viewPermission>public</viewPermission>
			<url>terms-of-use.html</url>
		</htmlDisplay>
	</components>
</webOperatorClient>

Using Images and static resources

For configurations where images or static files like stylesheets can be configured, either a fully qualified url can be used (https://mydomain.com/images/logo.png) or a relative URL can be used that points to the resources enpoint of PI Rest service:

See: https://fewsdocs.deltares.nl/webservices/rest-api/v1/#get-/resources/images/-id- and https://fewsdocs.deltares.nl/webservices/rest-api/v1/#get-/resources/static/-id-.

IconFiles

When for example a logo is configured as: <logo>resources/images/my-logo.png</logo>, the my-logo.png file should be in de IconFiles folder of the Delft-FEWS Configuration.

PiClientConfigFiles

For other non-image resources, like CSS stylesheets, a relative URL resources/static/style.css can be used. The style.css file should be in the PiClientConfigFiles folder of the Delft-FEWS Configuration.

Multiple Web OC Configurations

It is possible to specify multiple webOperatorClient.xml files by using a custom FEWS WebServices Configuration File. In this configuration file a custom webOperatorClient.xml can be configured. For example:

WebServices.xml

<webOperatorClientConfiguration>
	<configFile>MyCustomWebOperatorClient</configFile>
</webOperatorClientConfiguration>

Page tree