FEWS WebServices Configuration File (since 2022.02)

Introduction

Since 2022.02 a WebServices xml configuration file is supported (and replaces the deprecated FewsPiServices.properties file). Please note that the WebServices xml file has to be in the PiServiceConfigFiles folder. (The FewsPiServices.properties file used to be in the PiClientConfigFiles folder).

Configuration

The default file name is WebServices.xml and  should be placed in the PiServiceConfigFiles folder of the Delft-FEWS Configuration. In a live system, the file has to be uploaded using the config manager.

The XML file should comply to the following schema: https://fewsdocs.deltares.nl/schemas/version1.0/webServices.xsd

The following is an example of a web services configuration file in the Config folder: PiServiceConfigFiles/WebServices.xml.

<?xml version="1.0" encoding="utf-8"?>
<webServices xmlns="http://www.wldelft.nl/fews" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.wldelft.nl/fews http://fews.wldelft.nl/schemas/version1.0/webServices.xsd">
	<general>
		<filters>
			<filterId>myFilterId</filterId>
		</filters>
		<testPageEnabled>true</testPageEnabled>
 	</general>
</webServices>

Multiple WebServices xml configurations

 It is also possible to use a different file than the default WebServices.xml. Additional files can be added to the PiServiceConfigFiles folder. To use another config file in the Delft-FEWS Web Services, an environment variable needs to be specified with the file to use. See also: 

FEWS_WS_WEB_SERVICES_CONFIG_FILE_NAME=MyCustomWebServices.xml

Web Operator Client

In the WebServices.xml file a specific webOperatorClient configuration file can be specified since the 2023.01 version. In the following example a reference to the MyWebOperatorClient config is included. It is required to have a MyWebOperatorClient.xml file in the SystemConfigFiles folder.

<?xml version="1.0" encoding="utf-8"?>
<webServices 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/webServices.xsd">
	<general>
        <filters>
            <filterId>webservice</filterId>
        </filters>
        <readonlyMode>false</readonlyMode>
		<testPageEnabled>true</testPageEnabled>
	</general>
	<webOperatorClientConfiguration>
		<configFile>MyWebOperatorClient</configFile>
	</webOperatorClientConfiguration>
</webServices>