| Table of Contents |
|---|
Introduction
Since FEWS 2017.02 all FEWS Web Services have been unified into one installation package (FewsWebServices.war). The following WebServices are available with this installation using HTTP(s):
- PI REST Web Service: The PI REST Service can be accessed using the REST protocol.
- PI SOAP Web Service: The PI SOAP Service can be accessed by the SOAP protocol.
- WaterML Web Service: The WaterML2 Web Service can be accessed by the WaterML protocol.
- Digitale Delta Web Service: The Digitale Delta Web Service can be accessed by the REST protocol.
- Umaquo Web Service: The Umaquo Web Service can be accessed by the SOAP protocol.
Installation
Tomcat Installation
The FEWS Web Services are supported on the Tomcat 7 and Tomcat 8 application server. See: https://tomcat.apache.org/download-70.cgi. and https://tomcat.apache.org/download-80.cgi The requirements of the Java version to be used for Tomcat is the same as for the FEWS version that is being used. It is strongly advised to use same Java JRE for tomcat as is used for a FEWS OC when installing tomcat.
...
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?> <clientConfiguration 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/clientConfig.xsd"> <clientType>Stand alone</clientType> </clientConfiguration> |
| Warning |
|---|
Only direct database access should be used for operational use of the FEWS Web Services. A standalone configuration can be used, but only has limited functionality. For example only the Derby local data store is supported and workflows depending on DLL's (or .so files on Linux) are NOT supported. |
Configure a default filter in the Filters.xml of the FEWS configuration with the name of the filter that should be used for all requested timeSeries: "${catalina.home}/fews/Region_Home/Config/RegionConfig/Filters.xml"
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?> <filters version="1.1" 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/filters.xsd"> <defaultFilterId>All</defaultFilterId> ... |
Alternatively a property file can be used to configure the default filter (and other properties as well). The property file should be located at: "${catalina.home}/fews/Region_Home/Config/PiClientConfigFiles/FewsPiService.properties". In the following code snippet the default filter to be used by the FEWS Web Services is configured using the property key "FILTER_ID" where the filter "All" has been configured. A filter configured in hte FewsPiService.properties overrules the default filter in the Filters.xml.
| Code Block |
|---|
FILTER_ID=All |
N.B.: In versions before FEWS 2017.02 it was possible to override the FewsPiService.properties with another name or location. This is no longer supported. Only one property file can be used for all services and the name is fixed to FewsPiService.properties.
If the previous configurations have been applied, the FewsWebServices.war can be installed using the standard deployment options of Tomcat. See the tomcat deployment documentation for more information. When installing a new version of the FewsWebServices.war file it is recommended to restart tomcat after deployment.
Testing
The FEWS Web Services come with a testing page that can be accessed at: http://localhost:8080/FewsWebServices/. This leads to an overview page with links to test pages for the different services (SOAP, REST, WaterML, Digitale Delta and UmAquo). You can find more on how to configure the different services on 18 FEWS data exchange interfaces.
See Tomcat Installation as Windows Service usage for running the Web Services as a Windows service.
| Info |
|---|
The default tomcat installation runs at port 8080. Change the port value in case your tomcat installation runs on another port. |
Security
FEWS Web Services can be protected using the capabilities of the Tomcat Application Server. See FEWS Web Services Tomcat Security for more information.
Migrating from before 2017.02
In case an existing FEWS web service has to be migrated to the 2017.02 or later version, the following changes should be taken into account.
...