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 (General Web OC Documentation). The configuration will be used by the PI REST Service: https://fewsdocs.deltares.nl/webservices/rest-api/v1/#get-/weboc/config.

general

The general section is used to configure overall web oc items like: the title, logo, help menu etc.

components

In the components section the order of components and components specifics can be configured , such as: name of components and permissions.

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 endpoint 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-.

WebResourceFiles

When for example a logo is configured as:  <logo>resources/images/my-logo.png</logo>, the my-logo.png file should be in de WebResourceFiles folder of the Delft-FEWS Configuration. This also applies to non-image resources, like CSS stylesheets.

Multiple Web OC Configurations

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

WebServices.xml
<webOperatorClientConfiguration>
	<configFile>WebOperatorClientCustomVersion</configFile>
</webOperatorClientConfiguration>
  • No labels