The following document contains the installation instructions for the Java-based work process (JWP).
The JWP is a component of the Automation Engine which is required for the following functions:
The JWP is provided in the same directory as all the other Automation Engine files.
File / Directory | Description |
---|---|
ucsrvjp.jar | File for starting the JWP. |
/lib/ | Directory with OSGI implementation and JDBC driver. |
/plugins/com.automic.databaseA database is an organized collection of data including relevant data structures..jar | File for database access. |
/plugins/com.automic.ara.jar | Opens the ARA WebService. |
/plugins/com.automic.ert.jar | (Adaptive) ERT calculation. |
/plugins/com.automic.kernel.jar | JWP kernel. |
/plugins/com.automic.network.jar | TCP/IP connections. |
/plugins/com.automic.sso.jar | Single Sign-on. |
/plugins/com.automic.util.logging.jar | Logging / Trace. |
/plugins/org.apache* /plugins/org.eclipse* |
Additional OSGI bundles for console and services. |
The directory /configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied./ is created automatically when the JWP is first started and contains the OSGI bundle's cache.
In Windows, the JWP files are automatically copied from the SETUP.EXE program to the BIN directory. In UNIX, the files are located in the respective TAR archive.
Copy the provided "plugin" and "lib" directories into the BIN directory of the Automation Engine.
The subsequent installation steps depend on the database type used.
1) |
Install JDBC driver |
---|
Download Microsoft JDBC Driver 4.0 for SQL servers.
After downloading, copy the file "sqljdbc4.jar" into the lib directory of the Automation Engine.
2) |
Activate TCP/IP in the MS SQL server |
---|
Now check whether the MS SQL server instance used allows access via TCP/IP.
Open the SQL Server Configuration Manager and select Protocols for MSSQLSERVER under SQL Server Network Configuration. The item "TCP/IP" must be set to "Enabled" in the right-hand section.
3) |
Determine the MS SQL server port |
---|
The default port of the MS SQL server port is 1433.
If you are not sure of the port of your MS SQL server instance, you can find this out from its log file. The message "Server is listening on [ 'any'<ipv4> port number]" should be found in the current log file, which contains the port.
4) |
Modify the Automation Engine configuration file |
---|
The JWP uses the same configuration file (ucsrv.ini) as the other work processes of the Automation Engine system.
The database connection must be modified in the configuration file for the JWP. There are 2 different options for this:
1) DSN-less ODBC Connection
Please note that with this option, the same database connection string that is also used by all the other WPs in the Automation Engine system must be changed in the configuration file. When installing a JWP for an existing system, all WPs must be subsequently restarted.
A connection string is required in the [ODBC] section of the configuration file, the syntax of which does not require DSN. The server and database name must be specified directly in this case.
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,Driver={SQL Server Native Client VERSION};Server=tcp:SRVNAME,PORT;Database=DBNAME;Uid=DBUSER;Pwd=DBPWD
Example:
[ODBC]
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,Driver={SQL Server Native Client 11.0};Server=tcp:dbsrv01,1433;Database=AEV10;Uid=user;Pwd=password
The entry should be on one line (no break).
2) Separate connection string for the JWP
With this option, a separate database connection string for the JWP is defined in the [JDBC] section.
Example:
[JDBC]
SQLDRIVERCONNECT=jdbc:sqlserver://dbsrv01;databaseName=AEV10
The name and password of the database user are used by the [ODBC] item.
The advantage of this method is that the connection string of the other WPs ([ODBC] section) does not need to be changed or restarted.
1) |
Install JDBC driver |
---|
Copy the JDBC driver "ojdbc6.jar" from the Oracle database client installation to the "lib" folder of the JWP.
The file is located here: ORACLE_HOME/jdbc/lib/ojdbc6.jar
2) |
Configuring the database connection |
---|
There are 2 options:
1) Connection via OCI
Modification of the INI file "ucsrv.ini" is not necessary in this option. However, the JWP requires access to the Oracle database libraries in the same way as a WP. In UNIX, the environment variables LD_LIBRARY_PATH or SHLIB_PATH must therefore be selected accordingly, depending on the platform.
More information on installing the JDBC driver can be found in the JDBC installation instructions from Oracle.
2) Direct connection to the database
You can connect directly to the database using the Oracle JDBC Thin driver.
The [JDBC] section in the ucsrv.ini file must be configured accordingly. Example:
[JDBC]
SQLDRIVERCONNECT=jdbc:oracle:thin:@dbserver:1521/service_name
The name and password of the database user can be found in the [ODBC] item.
1) |
Install JDBC driver |
---|
Copy the file "db2jcc4.jar" (JDBC driver) into the "lib" directory of the JWP.
This file is part of the DB2 client and is located in the sub-directory "SQLLIB/java".
2) |
Configuring the database connection |
---|
Modification of the ucsrv.ini file is not necessary.
However, if required, the database connect string can be defined in the [JDBC] section of the INI file.
Example:
[JDBC]
SQLDRIVERCONNECT=jdbc:db2://server:<port>/database
The user nameName of the Automation Engine user. and password for database access can be found in the [ODBC] item.
In order to use SSL, the certificate(s) of the LDAP server must be available to the Java Work Process.
The JWP uses the default keystore file "cacerts" in the lib/security directory of the JRE.
Two options are available to add the certificates:
1 | Add certificates with the keytool |
---|
2 | Add certificates via download |
---|
Another option to install the certificate is the command line parameter -installcert of the Java Work Process.
java -jar ucsrvjp.jar -installcert <host>:<sslport>
If a certificate is missing, the message "unable to find valid certification path to requested target" is printed and the missing certificate is downloaded and stored in the cacerts file.
Use this kind of command to start the JWP via the command line:
java -Xmx512M -jar ucsrvjp.jar -IC:\temp\ucsrv.ini
The file "ucsrvjp.jar" is provided in the same directory as the other Automation Engine files. It is used exclusively to start the JWP.
The JWP can also be started via ServiceManager.
java -Xmx512M -jar ucsrvjp.jar -svc%port% -IC:\temp\ucsrv.ini
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 JWP attempts to find the file "ucsrv.ini" in the current working directory (= directory in which the file "ucsrvjp.jar" is located).