Transports and Interfaces: Siebel Enterprise Application Integration > EAI Java Business Service >

Prerequisites for Implementing a Java Business Service

To implement a Java business service, the following software must be installed and properly configured on each Siebel Server or Siebel Mobile and Developer Web Clients:

• A Java Runtime Environment (JRE)
• All necessary Java code
• A configured named subsystem of type JVMSubSys

The named subsystem supplies the parameters to the JBS. There are three parameters:

• DLL. The complete path of the JRE library, as shown in Table 12:

  Table 12. Complete JRE Library Paths for Various Operating Systems

  Operating System	JRE Library	Typical Location on Server and Environment Variable Setting
  AIX	libjvm.so	/usr/java5/jre/bin/j9vm Both /usr/java5/jre/bin and /usr/java5/jre/bin/j9vm must be included in the LIBPATH variable. For example: siebenv.csh: setenv LIBPATH=/siebel/siebsrvr/lib:/siebel/siebsrvr/mw/lib:/siebel/siebsrvr/SYBSsa90/lib:/usr/lib:/siebel/siebsrvr/lib:/oracle_client/app/oracle/OraHome_1/lib32:/oracle_client/app/oracle/OraHome_1/lib:/siebel/siebsrvr/mgmtagent/lib:/usr/java5/jre/bin:/usr/java5/jre/bin/j9vm siebenv.sh: LIBPATH=/siebel/siebsrvr/lib:/siebel/siebsrvr/mw/lib:/siebel/siebsrvr/SYBSsa90/lib:/usr/lib:/siebel/siebsrvr/lib:/oracle_client/app/oracle/OraHome_1/lib32:/oracle_client/app/oracle/OraHome_1/lib:/siebel/siebsrvr/mgmtagent/lib:/usr/java5/jre/bin:/usr/java5/jre/bin/j9vm
  HP-UX	libjvm.sl	/opt/java1.4/jre/lib/PA_RISC2.0/server Set the environment variable SHLIB_PATH to include the JVM's jre and server directories. Set LD_PRELOAD in the siebmtshw file located in /siebsrvr/bin. For example: setenv SHLIB_PATH=${SHLIB_PATH}:/opt/java1.4/jre/lib/PA_RISC2.0; export SHLIB_PATH In siebmtshw: LD_PRELOAD=/opt/java1.4/jre/lib/PA_RISC2.0/server/libjvm.sl export LD_PRELOAD
  Linux	libjvm.so	/usr/java/jdk1.5.0_05/jre/lib/i386/server Set the environment variable LD_LIBRARY_PATH to include the JVM's server directory. For example: setenv LD_LIBRARY_PATH=/usr/java/jdk1.5.0_05/jre/lib/i386/server: /usr/java/jdk1.5.0_05/jre/lib/i386
  Solaris	libjvm.so	/usr/jdk/instances/jdk1.5.0/jre/lib/sparc/server Set the environment variable LD_LIBRARY_PATH to include the JVM's server directory. Add /platform/SUNW,Sun-Fire-V440/lib to LD_LIBRARY_PATH. For example: siebenv.csh: setenv LD_LIBRARY_PATH=/usr/jdk/instances/jdk1.5.0/jre/lib/sparc/server:/platform/SUNW,Sun-Fire-V440/lib:{LD_LIBRARY_PATH} siebenv.sh: LD_LIBRARY_PATH=/usr/jdk/instances/jdk1.5.0/jre/lib/sparc/server:/platform/SUNW,Sun-Fire-V440/lib:{LD_LIBRARY_PATH};export LD_LIBRARY_PATH
  Windows	jvm.dll	JDK installation directory No environment variable

  NOTE:  You cannot use 64-bit JVMs with Java business services in Siebel Business Applications, which are 32-bit.

• CLASSPATH. The classpath used by the JVM.

  The classpath must include the following Siebel JAR files as well as all Java code implementing the desired business service.

  The required Siebel JAR files are:

  • Siebel.jar
  • SiebelJI_lang.jar (lang corresponds to the default language for your installation).
• VMOPTIONS. Java virtual machine options. On all platforms, except AIX, it is recommended that the option -Xusealtsigs be used to make sure that the signal handlers used by the Siebel Server do not conflict with those of the JVM.

  NOTE:  The -Xusealtsigs option is mandatory for use on the Oracle Solaris platform. The JVM options will not load successfully into the Application Object Manager without this option.

The following topics are also discussed here:

• Creating a Java Subsystem by Using the Siebel Server Manager
• Creating a Java Subsystem by Using the Siebel Web Client
• About Platform-Specific Configurations for the JVM

Creating a Java Subsystem by Using the Siebel Server Manager

The following example shows how to create a named subsystem using the Siebel Server Manager:

create named subsystem JAVA for subsystem JVMSubSys with

DLL="D:\jdk1.5.0\jre\bin\server\jvm.dll",

CLASSPATH="c:\cp\Siebel.jar;c:\cp\SiebelJI_enu.jar;c:\cp\myJARs.jar;.",

VMOPTIONS="-Xrs -Djava.compiler=NONE"

NOTE:  On Solaris, the create statement might be truncated. To avoid this, you can set CLASSPATH in the create statement and DLL and VMOPTIONS in the Siebel application.

Alternatively, the parameters to the Java Business Service can be specified in the application configuration (CFG) file instead of a named subsystem. Only do this with the Siebel Mobile and Developer Web Clients, and not the Siebel Server.

[JAVA]

DLL = D:\jdk1.5.0\jre\bin\server\jvm.dll

CLASSPATH = c:\cp\Siebel.jar;c:\cp\SiebelJI_enu.jar;c:\cp\myJARs.jar;.

VMOPTIONS = -Xrs -Djava.compiler=NONE

Creating a Java Subsystem by Using the Siebel Web Client

The following is an alternative procedure for creating a Java subsystem by using the Siebel Web Client.

To create a Java subsystem by using the Siebel Web Client

1. In the Siebel client, navigate to the Administration - Server Configuration screen, Enterprises view.
2. In the top list applet, select the Enterprise Server that you want to configure.
3. In the middle applet, click the Profile Configuration tab.
4. Click New to create a new component profile and set the following parameters:

   Name	Value
   Profile	JAVA
   Alias	JAVA
   Subsystem Type	JVMSubsys

5. In the Profile Parameters list applet (the bottom applet), set the following values:
   1. Set the Value of the JVM Classpath parameter to one of the following:
      • The location of the jndi.properties file (if using the JMS Transport).
      • The JMS provider JAR files (if using the JMS Transport).
      • The Siebel.jar and SiebelJI_enu.jar files. These files can be installed by using either Siebel Tools or the Siebel Server. An example of these files for Microsoft Windows follows:

   c:\bea\weblogic.jar;c:\siebel\jndi;c:\siebel\siebsrvr\CLASSES\Siebel.jar; c:\siebel\siebsrvr\classes\SiebelJI_enu.jar

   2. Set the Value of the JVM DLL Name parameter to the path where you have the jvm.dll file installed. For example, DLL= D:\jdk1.5.0\jre\bin\server\jvm.dll.
   3. Set the Value of the JVM Options record to any JVM-specific options that you would like to enable.

About Platform-Specific Configurations for the JVM

Depending on the platform, it is necessary to set certain environment variables to load the JVM properly:

• AIX. Make sure that you have the environment variable LIBPATH set to include the JVM's /bin and /bin/j9vm directories. For example:

  setenv LIBPATH=/siebel/siebsrvr/lib:/siebel/siebsrvr/mw/lib:/siebel/siebsrvr/SYBSsa90/lib:/usr/lib:/siebel/siebsrvr/lib:/oracle_client/app/oracle/OraHome_1/lib32:/oracle_client/app/oracle/OraHome_1/lib:/siebel/siebsrvr/mgmtagent/lib:/usr/java5/jre/bin:/usr/java5/jre/bin/j9vm

  Also, make sure that the LD_LIBRARY_PATH is set correctly.

• HP-UX. Make sure that you have the environment variable SHLIB_PATH set to include the JVM's jre and server directories. For example:

  setenv SHLIB_PATH

  /opt/java1.5/jre/lib/PA_RISC2.0:/opt/java1.5/jre/lib/PA_RISC2.0/server:${SHLIB_PATH}

  Set the variable LD_PRELOAD to the full path of the Java library.

• Solaris, Windows. No additional settings are needed.

When a Java business service is invoked on UNIX from a server component (for example, the JMS Receiver; see EAI JMS Transport for more information), the necessary settings must be done in the script that creates the component.

For the receiver, the script is siebshw; for the Application Object Managers, it is siebmtshw. These scripts are present in the /bin directory where the Siebel Server is installed.