Installing and running JDBC ODA

This section discusses the following:

Installing JDBC ODA

To install the JDBC ODA, use the Installer for IBM WebSphere Business Integration Adapter for JDBC. 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:
Except as otherwise noted, this document uses backslashes (\) as the convention for directory paths. For UNIX installations, substitute slashes (/) for backslashes. All product pathnames are relative to the directory where the product is installed on your system.

Before using JDBC ODA

Before you can run the JDBC ODA, you must:

  1. Install the appropriate JDBC driver. Follow the instructions in the System Installation Guide for UNIX or for Windows.
    Important:
    The JDBC ODA can connect to any database using a JDBC driver that supports JDBC 2.0 or later.
  2. Because the JDBC ODA generates business object names and attribute names from the names of corresponding database tables and columns, and because business object names and attribute names must be in ISO Latin-1, verify that the appropriate database components have Latin-1 names. If they do not, you have the following choices:
  3. Open for editing the UNIX shell or Windows batch file and configure the values described in Table 6.

    Table 6. Shell and batch file configuration variables

    Variable Explanation Example
    AGENTNAME
    
    Name of the ODA

    UNIX: AGENTNAME=JDBCODA

    Windows: set AGENTNAME=JDBCODA

    AGENT
    
    Name of the ODA's jar file

    UNIX: AGENT=$CROSSWORLDS/ODA/JDBC/JDBCODA.jar

    Windows: set AGENT= %CROSSWORLDS%\ODA\JDBC\JDBCODA.jar

    DRIVERPATH
    
    Path of JDBC driver library; JDBC ODA uses the driver classes to establish a connection to a specified database

    UNIX: DRIVERPATH=$CROSSWORLDS/lib/ \ xwutil.jar:$CROSSWORLDS/lib/ \ xwbase.jar:$CROSSWORLDS/lib/ \ xwsqlserver.jar:$CROSSWORLDS/lib/ \ spy/lib/spy.jar

    Windows: set DRIVERPATH=%CROSSWORLDS%\ / lib\xwutil.jar;%CROSSWORLDS%\lib\ / xwbase.jar;%CROSSWORLDS%\lib\ / xwsqlserver.jar;%CROSSWORLDS%\lib\ / spy\lib\spy.jar

    DRIVERLIB
    
    Path of the native libraries used by the JDBC driver

    UNIX:
    DRIVERLIB=$CROSSWORLDS/lib/db2jdbc.so

    Windows: DRIVERLIB=%CROSSWORLDS%\bin\db2jdbc.dll

After installing the JDBC driver and setting configuration values in the shell or batch file, you must do the following to generate business objects:

  1. Launch the ODA.
  2. Launch 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.

Launching JDBC ODA

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

UNIX:

start_JDBCODA.sh

Windows:

start_JDBCODA.bat

You configure and run the JDBC ODA using Business Object Designer. Business Object Designer 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 JDBCODA.

Running multiple instances of JDBC ODA

It is recommended that you change the name of the ODA when you run multiple instances of it. To create additional uniquely named instances of the JDBC ODA:

It is recommended that you prefix each name with the name of the host machine when you run ODA instances on different machines.

Figure 6 illustrates the window in Business Object Designer from which you select the ODA to run.

Working with error and trace message files

Error and trace message files (the default is JDBCODAAgent.txt) are located in \ODA\messages\, which is 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 "Configure initialization properties".

During the configuration process, you specify:

Table 7 describes these values.


Table 7. 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 JDBC ODA spawned
* Traces the business object definition dump

For information on where you configure these values, see "Configure initialization properties".

Copyright IBM Corp. 1997, 2004