Installation and usage

This section discusses the following:

Installing the XML ODA

To install the XML ODA, use an IBM WebSphere Installer. For instructions on how to install this ODA with the Installer for IBM WebSphere Business Integration Adapters, see the Implementing Adapters with WebSphere MQ Integrator Broker or Implementing Adapters with WebSphere Application Server. For instructions on how to install this ODA with the InterChange Server Installer, see the System Installation Guide for UNIX or for Windows.

When the installation is complete, the following files are installed in the product directory on your system:

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 product is installed on your system.

Before using the XML ODA

Before you run the XML ODA, verify that your system has the required files for the XML ODA. In particular, make sure that the ODA environment file has been installed in the bin subdirectory of your product directory.

UNIX

Make sure that the ODA environment file, CWODAEnv.sh, is installed in the following directory: ProductDir/bin.

Windows

Make sure that the ODA environment file, CWODAEnv.bat, is installed in the following directory: ProductDir\bin.

You must also make sure that the variables are correctly set in the startup script or batch file, which runs the ODA. Open for editing the shell (start_XMLODA.sh) or batch (start_XMLODA.bat) file and confirm that the values described in Table 83 are correct.

Table 83. Shell and batch file configuration variables

Variable Explanation Example
set AGENTNAME Name of the ODA set AGENTNAME=XMLODA
set AGENT Name of the ODA's jar file

UNIX: set AGENT = ${ProductDir}/ODA/XML/XMLODA.jar

WINDOWS: set AGENT = %ProductDir%\ODA\XML\XMLODA.jar

set AGENTCLASS Name of the ODA's Java class set AGENTCLASS=com.crossworlds.oda.xml.XMLAgent

After installing the XML ODA and setting configuration variables in the shell or batch file (see Table 83), you must do the following to generate business objects:

  1. Launch the XML ODA.
  2. Launch Business Object Designer.
  3. Follow a six-step process in Business Object Wizard, a GUI interface that Business Object Designer provides to configure and run an ODA.

The following sections describe these steps in detail.

Launching the XML ODA

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

UNIX
start_XMLODA.sh
 
Windows
start_XMLODA.bat
 
Note:
The Windows Installer provides shortcuts to startup the ODAs it installs. If you have used this Installer to install the XML ODA, 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 the XML ODA 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 XMLODA.

Running multiple instances of the XML ODA

You can run multiple instances of an XML ODA either on the local host machine or a remote host machine. Each instance runs on a unique port. You can specify this port number as part of launching the ODA from within Business Object Designer. Figure 45 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 XMLODAAgent.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 85.

During the configuration process, you specify:

Table 84 describes these values.

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

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

Copyright IBM Corp. 1997, 2003