Installing and running JDBC ODA

This section discusses the following:

Installing JDBC ODA

To install the JDBC ODA, use the Installer for WebSphere Business Integration Server Express Adapter for JDBC. Follow the instructions in the WebSphere Business Integration Server Express installation guide for Windows, for Linux, or for i5/OS. 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 Linux and i5/OS 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 WebSphere Business Integration Server Express Installation Guide for Windows or for Linux.
  2. For i5/OS: The JDBC ODA can connect to any database using a JDBC driver that supports JDBC 2.0 or later. There are two JDBC drivers that can be used on i5/OS:
  3. 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:
  4. Open for editing the Linux shell file (start_JDBCODA.sh) or Windows batch file (start_JDBCODA.bat) and configure the values described in Table 5.
    Table 5. Shell and batch file configuration variables
    Variable Explanation Example
    AGENTNAME
    Name of the ODA

    Linux: AGENTNAME=JDBCODA

    Windows: set AGENTNAME=JDBCODA

    AGENT
    Name of the ODA's jar file

    Linux: 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

    Linux: 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

    Linux: After copying db2jdbc.so to $CROSSWORLDS/lib*

    DRIVERLIB=$CROSSWORLDS/lib/db2jdbc.so

    Windows: After copying db2jdbc.dll to %CROSSWORLDS%\bin*

    DRIVERLIB=%CROSSWORLDS%\bin\db2jdbc.dll

    *Alternatively, you can point to the folders where these files exist.

Add your database driver to the DRIVERPATH in the start script. For example, if you are using DB2, add db2java.zip.

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 Express.
  3. Follow a six-step process in Business Object Designer Express 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.

Launching the ODA on Linux:

start_JDBCODA.sh

Launching the ODA on Windows:

start_JDBCODA.bat

Launching the ODA on i5/OS:

To Start i5/OS, select one of the following methods:

  1. From the Windows system where the WebSphere Business Integration Server Express Console is installed, select Programs>IBM WebSphere Business Integration Express>Toolset Express>Administrative Console. Then specify the OS/400 or i5/OS system name or IP address and a user profile and password that has *JOBCTL special authority. Select the ODA from the list of ODAs and select the Start ODA button.
  2. From the i5/OS command entry run the QSH CL command and from the QSHELL environment run /QIBM/ProdData/WBIServer44/bin/submit_oda.sh script with the following parameters in order
    pathToODAStartScript jobDescriptionName
    where pathToODAStartScript is the full path to the ODA start script, and
    jobDescriptionName is the name of the job description to use in the QWIBSVR44 library.
  3. From the OS/400 command entry, run the QSH CL command and from the QSHELL command entry, run the ODA startup script directly:
    start_ODAName.sh.

Stopping the ODA on i5/OS
The way to stop the ODA for i5/OS depends on how it was started. If you used option 1 or 2 in "Launching the ODA on i5/OS" then:

  1. From the Windows system where the WebSphere Business Integration Server Express Console is installed, select IBM Websphere Business Integration Server Express>Toolset Express>Administrative Console. Then specify the OS/400 or i5/OS system name or IP address and a user profile and password that has *JOBCTL special authority. Select the JDBC ODA from the list of ODAs and click the Stop ODA button.
  2. From the i5/OS command entry, run the CL command: WRKACTJOB SBS (QWBISVR44). The screen will show all jobs running in the subsystem.
  3. Scroll through the list to find the jobname that matches the job description for the ODA. For the ODAName JDBCODA, it is QWBIJDBODA.
  4. Select option 4 for this job, and press F4 to prompt for the ENDJOB command. Specify IMMED for the OPTION parameter.
  5. Press Enter.

If you used option 3 in "Launching the ODA on i5/OS" to start the ODA, then press F3 from the QSHELL command entry where you ran the start_ODAName.sh script.

Linux:
start_JDBCODA.sh

You configure and run the JDBC ODA using Business Object Designer Express. Business Object Designer Express 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 2 illustrates the window in Business Object Designer Express 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 6 describes these values.

Table 6. 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. 2004, 2005