Installation and usage

The following section describes the installation and usage of SAPODA.

Installing SAPODA

To install SAPODA, use Installer for adapters. Follow the instructions in the WebSphere Business Integration Server Express Installation Guide for Linux. 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 Linux installations, substitute slashes (/) for backslashes. All product path names are relative to the directory where the product is installed on your system.

Before using SAPODA

This section contains the following sections:

Before running SAPODA

Before you can run SAPODA, you must:

Before using SAPODA to create definitions for the ALE or ABAP Extension Module

You can use SAPODA to generate business object definitions for the ABAP Extension Module and the ALE Module based upon an IDoc (Intermediate Document):

Important:
Before using SAPODA to generate a business object definition from an SAP IDoc definition file, you must create the IDoc definition file for each IDoc type you want supported. This step is required only when using an extracted IDoc definition file as the template for a business object definition. For more information, see Creating the IDoc definition file.

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 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 SAPODA

You can launch SAPODA by running the appropriate file:

Linux

start_SAPODA.sh

Windows

start_SAPODA.bat

You configure and run SAPODA using Business Object Designer Express. Business Object Designer Express locates an ODA using the Agent's host and the port. The Agent's name is specified in the AGENTNAME variable of each script or batch file. The default ODA name for this connector is SAPODA. For more on ODAs and business object definitions and how to configure, start and use ODAs, see the IBM WebSphere Business Object Development Guide.

Launching the ODA on i5/OS

To launch the ODA on i5/OS, use one of the following methods:

  1. From the Windows system where WBI SE Console for i5/OS is installed, select Programs>IBM WebSphere Business Integration Console for i5/OS0>Console for i5/OS. Then specify the 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
    /QIBM/ProdData/WBIServer44/AdapterCapacityPack/start_SAPODA.sh
    QWBISAPODA
  3. From i5/OS command entry run the QSH CL command and from the QShell environment run script:
    /QIBM/ProdData/WBIServer44/AdapterCapacityPack/ODA/SAP/Start_SAPODA.sh

Stopping the ODA on i5/OS

Stopping the ODA depends on the method used to start it. If you started it using either method described in step 1 or step 2 in Launching the ODA on i5/OS.

  1. Run the CL Command: WRKACTJOB SBS(QWBISVR44). The screen shows all of the jobs running in the subsystem.
  2. Scroll through the list to find the job with a job name that matches the job description for the ODA. For SAPODA, it is QWBISAPODA.
  3. Select option 4 and press F4 to prompt for the ENDJOB command and specify *IMMED for the OPTION parameter.
  4. Press Enter.

If you started the ODA using the start_ODAName.sh script, press the F3 key where you ran the start_ODAName.sh script.

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.

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 Express 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 Express is running. If that is not found, the Business Object Designer Express defaults to the English-US (en_US) version, and finally, the Business Object Designer Express looks for the file name without any locale or language information.

Although not required, 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:

The MessageFile property does not display in the Configure agent properties window of Business Object Designer Express if you use the deployment descriptor odk_dd.xml file that exists in the ODA root directory.

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 5 describes the tracing level values.

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