(SM 2008) Java Connector Setup
Datavard Java connector is a component facilitating both Kerberos authentication and communication with remote services using JDBC drivers. It runs as an independent OS process and can be configured and controlled through transaction /DVD/JCO_MNG
. Following steps describe the setup.
/DVD/JCO_MNG
allows you to link Datavard Java connector to existing SAP RFC and maintain the settings. After all required fields are filled and saved, you can click the Restart button to start the Java service. When Java process is running, you can control it across the application servers and display logs.
Setup
This component requires initial setup to be fully functional.
Java runtime environment
An up-to-date Java runtime must be available to the SAP's <sid>adm user. The java connector is tested and built using OpenJDK 11.
JRE can be the latest SAPmachine from https://sap.github.io/SapMachine/ or OpenJDK from https://jdk.java.net/14/.
Not to interfere with possible Java installation already present on SAP application server, the archive should be unpacked into a non-default directory, e.g. /sapmnt/<SID>/global/
.
SAP Java Connector library
SAP Java Connector 3.0 library libsapjco3.so, which can be downloaded from the SAP marketplace, needs to be uploaded to the SAP application server. It should be located in the directory referenced by LD_LIBRARY_PATH
environment variable of <sid>adm user.
It is recommended to append a shared Datavard directory /sapmnt/<SID>/global/security/dvd_conn
to LD_LIBRARY_PATH
variable of <sid>adm user and place libsapjco3.so to this directory.
Or you may also copy it directly into the SAP kernel directory, which is by default included in LD_LIBRARY_PATH
variable.
If you copy the SAP Java Connector library into the SAP kernel directory, you must ensure the library will be preserved during each SAP kernel upgrade.
$ echo $LD_LIBRARY_PATH
/usr/sap/DVQ/SYS/exe/run:/usr/sap/DVQ/SYS/exe/uc/linuxx86_64:/usr/sap/DVQ/hdbclient:/sapmnt/DVQ/global/security/dvd_conn
/sapmnt/DVQ/global/security/dvd_conn/ # ls -l libsapjco3.so
-rwxr-x--- 1 dvqadm sapsys 59 Apr 5 15:12 libsapjco3.so |
SAP RFC role and user
The Java connector uses a dedicated user in the SAP system for communication. In our reference configuration, we use the username 'hadoop'. This user should be created with the type 'Communications Data' and with authorizations limiting his privileges to basic RFC communication.
Authorization object required is S_RFC with these settings:
ACTVT = 16
RFC_NAME = SYST, RFC1, SDIFRUNTIME
RFC_TYPE = FUGR
Example of custom SAP role in PFCG transaction (Display Authorization Data):
Java RFC
Java RFC by name refers to Datavard Java service which is used for authentication and communication with other services.
Entries explained:
Connection Type – T for TCP/IP Connection
Activation Type – select Registered Server Program
Program ID – DATAVARD_JAVA_CONN
SAP gateway access
External communication with SAP system goes through the SAP gateway. If SAP system parameter gw/acl_mode is enabled, there are two files (secinfo and reginfo) which limit the access.
In this case a program needs to have granted access either explicitly or by wildcard definition:
DATAVARD_JAVA_CONN
More information on the SAP gateway ACL topic can be found on the SAP web site Gateway Security Files secinfo and reginfo.
/DVD/JCO_MNG initial setup
Select the latest JCO by double-clicking the row on the left side of the screen
Switch to Edit mode
Click fill default values
Adjust values you want to change
Config
Client - the client of SAP technical user used to register on SAP gateway
RFC User - username of SAP technical user used to register on SAP gateway
Password - hashed password of SAP technical user used to register on SAP gateway. The hash can be created by typing password in the field below and clicking 'Hash' button
Install directory - directory on the application server where the application and log files will be generated - can be a physical path or a logical path enclosed in <>, default path </DVD/DEF_JCO_DIR> can be used. After changing this value, you have to click the 'Generate paths' button
Java exe - the path to Java executable on the SAP application server
Java vendor - Name of Java vendor, ORACLE or IBM (for SAP JVM, or OpenJDK, fill ORACLE)
Dependencies
select a library which you want to use with JCO. Base library must always be selected. In case the connection to AWS or GCP is required, library supporting such platform must be selected.
Advanced
In most scenarios, these settings don’t need to be changed.OS Command for starting java service - name of an OS command for starting Java service (SM69)
OS Command for setting access permissions - name of an OS command for setting execution rights (SM69)
Max RAM used - maximum amount of RAM used by Java service (heap size)
Additional java starting arguments - additional arguments used to start Java service
Repository destination - client destination from which repository should be obtained
Work thread MIN - number of threads Java service always runs with
Work thread MAX - maximum number of threads that can be used by Java service
Connection count - number of connections registered at SAP gateway
Peak limit - limit of connections at peak
Log4j log level - level of messages collected in logs
Log4j log deletion - how long the logs should be archived
JAR path - the path where the JAR file will be created
Server config path - the path where the server config will be created
Destination config path - the path where the destination config will be created
Log files path - a directory where the log files will be saved
Log4j config path - the path where the log4j config file will be created
Go to the 'General' tab and assign an RFC to the java connector
RFC Usage - Defines an RFC that points to this java application.
Save the settings
Start the Java service by clicking the 'Restart' button
The Java service is started with a system command. You can adjust the name of this command in the table Advanced tab. The default name of the command is ZDVD_START_JAVA. In the case the system command doesn't exist, it is created automatically. You can view the system commands through the transaction SM69. On Linux, another system command is required, which sets executable rights for the configuration files (chmod 755 <filename>). Its name can be adjusted in the Advanced tab.
The following authorizations are required for automatic start of the Java process:
S_RFC_ADM (Administration for RFC Destination): ACTVT = 03, RFCTYPE = * , RFCDEST = <JAVA_RFC>, ICF_VALUE = *
S_DATASET (Authorization for file access): PROGRAM =/DVD/*, ACTVT = *, FILENAME = *
S_LOG_COM (Authorization to Execute Logical Operating System Commands): COMMAND = ZDVD*, OPSYSTEM = * , HOST = *
Management of JCO config versions (upload/download) also requires S_GUI (Authorization for GUI activities) with ACTVT = 61,60
Central Java instance
It is possible to have a single Java connector running, instead of running one on every application server. To setup such scenario, follow these steps:
If the Java connector is already running on several application servers, stop all instances.
Open the Java RFC destination and fill the Gateway options valid for the desired instance
When you restart transaction
/DVD/JCO_MNG
, only buttons belonging to the desired application server should be functional and all the other app. servers should be using this connection. Start the connector and all rows in theConnection
column should be green.
Upgrading Java connector
This is a list of steps to do, when you update your Datavard software and you would like to switch to a new version of Java connector.
Open transaction
/DVD/JCO_MNG
Double-click the current working connector and click
Copy config
Double-click the latest connector, enter
Edit mode
, then clickPaste config
, then fill theRFC Usage
field with the same RFC that was used with the old connectorSwitch to
Dependencies
tab and make sure you are using the latest libraries for your connectorSwitch back to the
General
tab and ClickRestart
for every Application server
Restarting the connector can cause running Glue/Outboard jobs to fail. Either do the Restart the connector in quiet hours, or make sure you re-run the failed jobs.