Siebel Object Interfaces Reference > Customizing Siebel Object Interfaces > Accessing a Siebel Object Interface >

Accessing the Siebel Java Data Bean

A Java client that uses the Siebel Java Data Bean to connect to the Siebel Server requires JAR files. These files allow the Java language to access the objects and methods of the Siebel Object Interface. These files are specific to the version of the Siebel application. Do not use these JAR files with other versions. For more information, see About the Siebel Java Data Bean Object Interface.

To access the Siebel Java Data Bean

1. Add the following JAR files to the CLASSPATH:
   • Siebel.jar
   • SiebelJI_lang.jar
2. To install the Siebel Java Data Bean interface, do one of the following:
   • Use the Siebel Enterprise Server Installer. Make sure the EAI Siebel Connectors option contains a check mark. For more information, see the Siebel Installation Guide for the operating system you are using.
   • Install Siebel Tools. The Oracle Universal Installer installs the Siebel Java Data Bean interface by default when you install Siebel Tools.
3. Start a new SiebelDataBean Java object.
4. To call the Login method for the object you started in Step 3, use the following code:

   SiebelDataBean l_sdb = new SiebelDataBean();

   l_sdb.login(<parameters>);

   You must use the Login method. You cannot use an object interface method that returns an active Siebel object because no Siebel objects are currently active. You must use your own Siebel objects. For more information, see Step 2.

Example of Accessing the Siebel Java Data Bean

The following example code accesses the Siebel Java Data Bean. You can use a Java IDE to compile and run this code:

import com.siebel.data.*;
import com.siebel.data.SiebelException;

public class DataBeanDemo
{
   private SiebelDataBean m_dataBean = null;
   private SiebelBusObject   m_busObject = null;
   private SiebelBusComp       m_busComp = null;

   public static void main(String[] args)
   {
      DataBeanDemo demo = new DataBeanDemo();
   }

   public DataBeanDemo()
   {
      try
      {
         // instantiate the Siebel Java Data Bean
         m_dataBean = new SiebelDataBean();

         // log in to the Siebel Server
         // SiebelServerhost = the name or IP address of your Siebel Server
         // SCBPort = listening port number for the SCBroker component (default 2321)
         m_dataBean.login("Siebel://SiebelServerhost:SCBPort/enterpriseServer/
          AppObjMgr_enu", CCONWAY, CCONWAY, "enu");

         // get the business object
         m_busObject = m_dataBean.getBusObject("Opportunity");

         // get the business component
         m_busComp = m_busObject.getBusComp("Opportunity");

         // log off
         m_dataBean.logoff();
      }

      catch (SiebelException e)
      {
         System.out.println(e.getErrorMessage());
      }
   }
}

Using Single Sign-on (SSO) with Siebel Java Data Bean

If you use single sign-on (SSO) with Siebel Java Data Bean, then you must include the following items in the login:

• Login ID of an employee as the username.
• The value of the TrustToken parameter in the connect string. To determine the value for the TrustToken, examine the TrustToken parameter in the Siebel application configuration (CFG) file. For more information, see Setting the Connect String.

For example:

m_dataBean.login("Siebel://gatewayserver:2321/enterpriseServer/SCCObjMgr_enu", SADMIN, HELLO,"enu");

where:

• SADMIN is an employee.
• The TrustToken parameter is HELLO in the LDAPSecAdpt section of the Siebel application configuration (CFG) file.

Customizing the Parameters a Third-Party Application Uses to Connect Through the Siebel Java Data Bean

You can customize the parameters that a third-party application uses when it connects to a Siebel application through the Siebel Java Data Bean.

To customize the parameters a third-party application uses to connect through the Siebel Java Data Bean

1. Open the siebel.properties file.

   This file is located in your classpath, which is an operating system environment variable that a Java program references. The siebel.properties file can exist in any location. The CLASSPATH environment variable must include an entry for this file so that the Java Virtual Machine can find the file when it starts.

2. Set the properties.

   For more information, see Properties of the Siebel Properties File.

Properties of the Siebel Properties File

Table 6 describes the properties of the siebel.properties file.

Example of the Siebel Properties File

The following code is an example of the siebel.properties file:

siebel.connection.string = siebel.tcpip.rsa.none://test.siebel.com/siebel/sseobjmgr_enu/test

siebel.user.name          = User1

siebel.user.password      = password

siebel.user.language      = enu

siebel.user.encrypted     = false

siebel.conmgr.txtimeout   = 3600

siebel.conmgr.poolsize    = 5

siebel.conmgr.sesstimeout = 300000

siebel.conmgr.retry       = 5

siebel.conmgr.jce         = 1

Determining the Total Number of Open Connections

The connection pool maintains a set of connections to a specific server process. The default value for the siebel.conmgr.poolsize property is 2. The maximum value is 500.

The siebel.conmgr.poolsize property and the Min MT Server parameter on the object manager determine the total number of open connections. Each MT server process is a Windows process that includes a connection pool. The total number of open connections is the value in the siebel.conmgr.poolsize property multiplied by the value in the Min MT Server parameter.

For example, if the siebel.conmgr.poolsize is 2, and if the Min MT Server parameter is 3, then the total number of open connections is six.

Customizing Character Encoding for the Siebel Java Data Bean

The character encoding of the Siebel Server and the character encoding of the Siebel client must be the same. This allows the Siebel client and the Siebel Server to communicate correctly. If the Siebel client and the Siebel Server default character encoding cannot be the same, then you can modify the Siebel client character encoding.

To customize character encoding for the Siebel Java Data Bean

• To set the file.encoding system property to the proper character encoding, do one of the following:
  • Set it for the entire Java Virtual Machine on the command line. For example:

  java -Dfile.encoding=ascii java_application

  • Set it in the environment variable. For more information, see your particular Java Virtual Machine.
  • Set it for a particular Java component. Add the following line to the Java component:

  System.setProperty("file.encoding", CodePageValue);

  where:

  • CodePageValue is a Siebel value that specifies character encoding for the Java Data Bean.

Table 7 lists character encoding mappings you can use for the Java Data Bean. The Siebel Value column contains the codes you can specify in the CodePageValue variable.

Encrypting Communication Between the Java Data Bean and the Siebel Server

To encrypt communication between the Siebel Java Data Bean and the Siebel Server, you can use the Rivest, Shamir and Adleman (RSA) encryption libraries. For information about platforms you can use with encryption, see Siebel System Requirements and Supported Platforms on Oracle Technology Network.

To encrypt communication between the Siebel Java Data Bean and the Siebel Server

1. Enable encryption in the Object Manager server component that you use for the communication between the Java Data Bean and the Siebel Server.

   For more information, see Siebel System Administration Guide.

2. Set the encryption parameter of the connect string in the Siebel Java Data Bean to rsa.

   For example:

   siebel.tcpip.rsa.none://gateway/enterprise/ObjMgr

   where:

   • gateway is the name of the gateway
   • enterprise is the name of the enterprise
   • ObjMgr is the name of the Object Manager

Encrypting Communication on a Platform That the RSA Libraries do Not Support

To use encryption on a platform that the RSA libraries do not support, Oracle uses the Java Cryptography Extension (JCE) v1.2.1 specification. JCE provides a way to encrypt, create the encryption key, create the key agreement, and handle Message Authentication Code. With JCE, you can use some other qualified cryptography library as a service provider. For information about developer resources for Java technology, see the following Web site:

http://www.oracle.com/technetwork/java/java-sun-com-138872.html

To encrypt communication on a platform that the RSA libraries do not support

1. Download and install the JCE v1.2.1 software, policy files, and documentation.

   For information about installing and configuring your Java Virtual Machine for use with JCE, see the following Web site:

   http://java.sun.com/products/archive/jce/

   Note that you can only use a static specification of JCE providers with the Siebel Java Data Bean.

2. Modify the java.security file to specify your provider of choice.
3. Make sure the classpath variable includes the necessary provider JAR files.
4. Set the siebel.conmgr.jce property in the siebel.properties file to 1.

Login Errors You Might Encounter When You Use the Siebel Java Data Bean

The Siebel Java Data Bean might return a login error that is similar to the following:

Siebel Exception thrown invoking login Method. Code--1. Message-Logon request 75 was abandoned after 2ms connection.

Any of the following items can cause this error:

• An Object Manager process is down.
• A hardware reset is required. For example, Object Manager hardware, router, switch, and so forth.
• There is a problem with an operating system setting or the operating system network.
• There is a network failure.
• There is a network address translation timeout.

Using the Siebel Java Data Bean with Multiple Threads

Multiple threads of a single process must not access a common instance of the Siebel Java Data Bean. If a process with multiple threads must use the Siebel Java Data Bean, then each thread must create a separate instance of the Siebel Java Data Bean.

Do not reuse an instance of any other object that the Siebel Java Data Bean makes available across multiple threads of the same process. This requirement includes the following objects:

• SiebelBusObject
• SiebelBusComp
• SiebelService
• SiebelPropertySet

CAUTION:  You must configure Siebel CRM to create one instance of the Siebel Java Data Bean for each thread that must use it. If a thread gets Siebel Java Data Bean Objects, then do not configure Siebel CRM to share these objects with any other thread.