Installing the AE Internal Webservice (Glassfish)

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 file UC4WS.WAR 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 Glassfish application server.

To Install the Internal Webservice

On the Host computer, log on to the administrator console.
By default, the file Realm is used. Create a new user under Configuration > Security > Realms > file and enter uc4 as the group.
Select the menu item Applications > Web Applications and select Deploy... in the right window.
Under Location, select the file UC4WS.WAR. By default, the context root is uc4ws. If you want to change it, go to General and click OK.
After deployment, you find the Internal Webservice listed in the Webservices tree.
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.