Installing the AE Internal Webservice (Tomcat)

The AE Internal Webservice was the previous method to communicate with an AE system and is supported only for partners that have legacy installations and integrations to maintain. For new installations and integrations, the REST API is the newer and preferred communication technology. For more information, see REST API

As of version 21.0, the Automation Engine and the Java components communicate using TLS/SSL. These components establish a connection with the Java communication process (JCP), which uses trusted certificates to prove its identity to other communication partners.

You can use the trustedCertFolder= parameter in the respective configuration file to define the path to the folder where the trusted certificates are stored. Otherwise, the certificates should be installed in the Java trust store. For more information, see Securing Connections to the AE (TLS/SSL).

The AE Internal Webservice UC4WS_TOMCAT.WAR file is available in the directory IMAGE:WEBSERVICE.

Check the compatibility matrix to see which version is compatible with your system. For more information, see Compatibility Information.

The following steps are required for installing and configuring the AE Internal Webservice on a Tomcat application server.

To Install the Internal Webservice

In the Host computer, assign the role uc4 to a user by adapting <tomcat>/conf/tomcat-users.xml. For instructions go to the Tomcat Website.
Copy the file uc4ws_tomcat.war, rename it into uc4ws.war and paste it into deploy directory of tomcat (<tomcat>/webapps)
Download the Zip-Distribution of JAX-WS Reference Implementation (RI) from http://search.maven.org/remotecontent?filepath=com/sun/xml/ws/jaxws-ri/2.3.1/jaxws-ri-2.3.1.zip, paste the content of <jaxws>/lib into <tomcat>/webapps/<internal_webservice>/WEB-INF/lib.
Download the Web Services API from http://search.maven.org/remotecontent?filepath=javax/xml/webservices-api/2.1-b16/webservices-api-2.1-b16.jar, paste the file into <tomcat>/webapps/<internal_webservice>/WEB-INF/lib.
After deployment, no error log message should be shown in tomcat-log.
WSDL is available at http://Server name:Port/uc4ws/uc4ws?wsdl.

To Configure the Internal Webservice

On the Host computer, call the web interface for the internal webservice (http://Server name:Port/uc4ws/admin). For more information, see Configuration WebInterface for the Internal Webservice.
In Communication Process (Host:Port), specify at least one communication process using the format Server name:Port.

You can also store a default user with specific operations assigned.
In Session Handling, determine the connection settings to the Internal Webservice.

Note: the configuration file will be overwritten when you deploy the WAR file again. As a result you will have to redefine your configuration settings. Instead, you can also save a copy of your configuration file (INI file) before you start the deployment and copy it to the folder that includes the web application after the deployment has taken place.