Installation and usage

This section discusses the following:

Installing SAPODA

To install SAPODA, use Installer for IBM WebSphere Business Integration Adapters. Follow the instructions in the WebSphere Business Integration Adapters Implementation Guide for MQ Integrator, or, for InterChange System (ICS), 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:
In this document, backslashes (\) are used 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 SAPODA

This section describes the following:

Before running SAPODA

Before you can run SAPODA, you must:

Before using SAPODA

Before using SAPODA to generate a business object definition from an SAP Intermediate Document (IDoc) format, you must create the IDoc definition file for each IDoc you want supported. SAPODA uses this file as input. For more information, see "Generating the IDoc definition dile".

How to use SAPODA

After installing SAPODA, 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 SAPODA

You can launch SAPODA in either of the following ways:

Important:
If you register the ODA with OAD, but run the script or batch file before selecting the ODA in Business Object Designer, Business Object Designer may display two names when you press Find Agents: the one registered with OAD and the one in the script or batch file. If the two names are identical, two identical names display. However, if both names represent the ODA in the same subnet and the ODA has been started manually, Business Object Designer connects only to the manually started ODA. In this case, Business Object Designer does not call OAD. Attempting to start the second identically named ODA in the same subnet causes the second ODA to quit with an error. For information on changing the name of an ODA, see "Running SAPODA on multiple machines".

You configure and run SAPODA 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 SAPODA. During installation, if you register the ODA with an Object Activation Daemon, the wizard automatically prefixes the hostname to the AGENTNAME value to make it unique.

Running SAPODA on multiple machines

It is recommended that you change the name of the ODA when you run multiple instances of it on different machines. To create additional uniquely named instances of SAPODA, specify a unique name in the AGENTNAME variable of the script or batch file on each machine on which the ODA is installed.

To run the desired ODA, you select it by name from a list of available ODAs in Business Object Designer, which displays all active ODAs. Non-unique names can cause confusion when selecting the appropriate ODA to run.

A naming convention for assigning unique names is prefixing each name with the name of the host machine on which the ODA runs. If you registered the ODA with an Object Activation Daemon, you can use an ORB finder (osfind) to locate existing CORBA object names on your network.

Figure 34 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 SAPODAAgent.txt) are located in \ODA\messages\, which is under the product directory. These files are language and country or territory specific and use the following naming convention:

AgentNameAgent_ll_TT.txt

Where _ll is the language, and _TT is the country or territory, and where, when taken together, constitiute a locale.

For instance, a Chinese mainland file name would be:
SAPODAAgent_zh_CN.txt.

The same file name for Taiwan would be:
SAPODAAgent_zh_TW.txt.

The Business Object Designer uses this information when selecting a message file. The default search order is to first look for the locale-specific file that matches the locale in which the Business Object Designer is running. If that is not found, the Business Object Designer defaults to the English-US (en_US) version, and finally, the Business Object Designer looks for the file name without any locale or language information.

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:

Note:
If a non-English locale is required, the same naming convention is still applicable; for example, SAPODA1Agent_zh_TW.txt.
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 46 describes the tracing level values.

Table 46. 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 SAPODA spawned.
  • Traces the business object definition dump

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

Copyright IBM Corp. 1997, 2003