Installing the JCP
The following steps will help you install the JCP (Java Communication Process).
The files needed for JCP are the same as the files provided for JWP in the same directory as all the other Automation Engine files.
Since the JWP's installation is mandatory and the files necessary for the JCP are the same as those used to install the JWP, there is no need to unpack any files nor to carry out any other installation step.
Notes:
-
The JCP installation is relevant for the AE REST API as well as for the advanced object search. Therefore, make sure to configure the REST section of the Automation Engine configuration file (ucsrv.ini) accordingly. Otherwise the Automic Automation object advance search will not work. For more information, see Automation Engine.
-
We recommend using HTTPS.
HTTPS/SSL set up for AE REST API
In order to use HTTPS you need to set the sslEnabled parameter to 1 and continue with the setup of the following parameters in the Automation Engine configuration file (ucsrv.ini, see Automation Engine):
-
keystore
This parameter is mandatory and needs to point to the correct target, otherwise the JCP server will terminate.
-
keystorePassword
-
keyPassword
The keystorePassword and the keyPassword can be encrypted with the UCYBCRYP Utility.
Adding the certificates
JCP uses keystore as defined in the Automation Engine configuration file. For additional information as well as information on adding certificates, see https://www.eclipse.org/jetty/documentation/jetty-9/index.html#configuring-ssl.
Starting the JCP
Use this kind of command to start the JCP via the command line:
java -Xmx2G -jar ucsrvjp.jar -Iucsrv.ini -rest
The file "ucsrvjp.jar" is provided in the same directory as the other Automation Engine files. It is used exclusively to start the JWP and JCP.
The JCP can also be started via ServiceManager.
java -Xmx2G -jar ucsrvjp.jar -Iucsrv.ini -svc%port% -rest
The -svc parameter should be omitted when starting directly via the command line.
The parameter -I to specify the INI file is optional. If the parameter is missing, the JCP attempts to find the file "ucsrv.ini" in the current working directory (= directory in which the file "ucsrvjp.jar" is located).
Setting Up Multiple REST API Processes
The JCP installation is relevant for the AE REST API and for the advanced object search. You can install a single Java communication process (JCP). In this case, all REST requests are sent to this single AE REST API instance and no REST API is available if the Java communication process (JCP) is down.
You can also set up a system with multiple Java communication processes (JCPs). In this case, two Java communication processes (JCPs) are used in a cluster but only one of both is available at the time.
Important! When using multiple Java communication processes (JCPs), it is imperative that each one uses its own Automation Engine configuration file (ucsrv.ini, see Automation Engine). If only one INI file is used for more than one Java communication process (JCP), the first one connects successfully while the others terminated upon trying to register the same REST port if both run on the same node. An error message is written to the log file of the JCP stating the reason for termination.
Setting up a system with multiple Java communication processes (JCPs) can be convenient for balancing and to provide failover capabilities, because the REST requests are sent and distributed only to available Java communication processes (JCPs).
For more information, see AE REST API - General Info.
Next step: