Installing and using Siebel ODA

This section discusses the following:

Installing SiebelODA

To install SiebelODA, use the WebSphere Business Integration Adapter Installer. Follow the instructions in the System Installation Guide for UNIX or for Windows. When the installation is complete, the following files are installed in the directory on your system where you have installed the product:

Note:
If ICS is your broker, CWODAEnv.bat must be modified to reflect the version of ICS. For ICS version 4.2.x, change CWVERSION to 4.2. For ICS version 4.1.1, change CWVERSION to 4.1.
Note:
Except as otherwise noted, this document uses backslashes (\) as the convention for directory paths. For UNIX installations, substitute slashes (/) for backslashes. All IBM product pathnames are relative to the directory where the product is installed on your system.

Before using SiebelODA

Before you can run SiebelODA, you must copy the required Siebel application's .jar files to the %ProductDir%/connectors/Siebel/dependencies directory. The following files must be copied to this directory:

Siebel 7.x

SiebelJI_enu.jar
SiebelJI_Common.jar

The default version of Siebel is set to 7.x. Ensure that the REM in the following line is not removed:

REM set SIEBELVERSION="6.x"

Siebel 6.2.x

SiebelDataBean.jar
SiebelTC_enu.jar
SiebelTcCommon.jar
SiebelTcOM.jar

You must edit the start_SiebelODA.bat file to remove the REM in the line:

REM set SIEBELVERSION ="6.X"

After installing the SiebelODA, you must do the following to generate business objects:

  1. Start the ODA.
  2. Start Business Object Designer.
  3. Follow a six-step process in Business Object Designer to configure and run the ODA.

The following sections describe these steps in detail.

Understanding datatype mapping

The following table lists the Siebel application datatypes and their corresponding WBI business object definition datatypes. These are used by the WBI Adapter for Siebel ODA only; the application regards all attribute values as strings.

Table 7. Siebel application and WBI Adapter datatypes

Siebel datatype WBI Adapter for Siebel datatype
DTYPE_BOOL
Boolean
DTYPE_ID
String
DTYPE_PHONE
String
DTYPE_TEXT
String
DTYPE_NOTE
String
DTYPE_DATE
Date
DTYPE_TIME
Date
DTYPE_DATETIME
Date
DTYPE_UTCDATETIME
Date
DTYPE_INTEGER
Integer
DTYPE_NUMBER
Float
DTYPE_CURRENCY
Double
The following datatype mappings are used when you create business object definitions using the Business Services option.
Hierarchy Container or String, depending on the populated content, if any, of the Integration Object field.
Integration object Container or String, depending on the populated content, if any, of the Integration Object field.
Number Integer
String String
Date Date

Launching the SiebelODA

You can launch SiebelODA with the startup script appropriate for your operating system.

UNIX

start_SiebelODA.sh
Windows

start_SiebelODA.bat
Note:
The Windows Installer provides shortcuts to startup the ODAs it installs. If you have used this Installer to install SiebelODA, you will find a shortcut to start it under the menu Programs > IBM WebSphere Business Integration Adapters > Adapters > Object Discovery Agents.

You configure and run SiebelODA using Business Object Designer. Business Object Wizard, which Business Object Designer starts, locates each ODA by the name specified in the AGENTNAME variable of each script or batch file. The default ODA name for this connector is SeibelODA.

Running SiebelODA on multiple machines

You can run multiple instances of the ODA, either on the local host or a remote host in the network. Each instance runs on a unique port.

Working with error and trace message files

Error and trace message files (the default is SiebelODAAgent.txt) are located in the \ODA\messages, subdirectory under the product directory. These files use the following naming convention:

AgentNameAgent.txt

If you create multiple instances of the ODA script or batch file and provide a unique name for each represented ODA, you can have a message file for each ODA instance. Alternatively, you can have differently named ODAs use the same message file. There are two ways to specify a valid message file:

Important:
Failing to correctly specify the message file's name when you configure the ODA causes it to run without messages. For more information on specifying the message file name, see Table 9.

During the configuration process, you specify:

Table 8 describes these values.

Table 8. Tracing levels

Trace Level Description
0 Logs all errors
1 Traces all entering and exiting messages for method
2 Traces the ODA's properties and their values
3 Traces the names of all business objects
4 Traces details of all spawned threads
5 * Indicates the ODA initialization values for all of its properties * Traces a detailed status of each thread that SiebelODA spawned * Traces the business object definition dump

For information on where you configure these values, see Table 9.

Copyright IBM Corp. 1997, 2004