JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Developing OTDs for Oracle Java CAPS Application Adapters     Java CAPS Documentation
search filter icon
search icon

Document Information

Developing OTDs for Application Adapters

Creating SAP BAPI OTDs

SAP BAPI Encoding

Date and Time Stamp Requirements

Installing SAP JCo for SAP BAPI

To Install SAP JCo on Windows 32

To Install SAP JCo on UNIX

Important Notes:

Creating BAPI and RFC OTDs

To Create BAPI OTDs

Relaunching BAPI and RFC OTDs

Creating a SAP ALE OTD

SAP JCo and SAP IDoc Class Library Installation

The SAP Java Connector

SAP Java IDoc Class Library

To Download the SAP Java IDoc Class Library

Important Notes:

Creating IDoc OTDs

To Create IDoc OTDs Directly From SAP

To Create IDOC OTDs From a Description File

Exporting the IDOC File from SAP

To Download the IDoc Description File From SAP

Saving the IDoc Description File (After 4.6)

To Save the IDoc Description File From SAP

Creating Siebel EAI OTDs

Configuring Your System Before Creating the OTD

Configuring NetBeans to Work with Siebel

Installing seebeyond.sif for Siebel 7.5.x

Installing SiebelMessage XSD Generation Process.xml for Siebel 7.7 and 7.8.x

Creating the OTD

To Create the OTD

To Relaunch the OTD

Creating COBOL Copybook OTDs

To Create COBOL Copybook OTDs

Parsing Copybook Entries

Relaunching OTDs

To Relaunch an Existing OTD

COBOL Copybook OTD Methods

OTD Method Guidelines

Encoding Behavior for Redefinitions

DBCS Items

Root-level Methods

enableUnmarshalValidation(boolean enable) Method

marshal() Method

marshal(String charset) Method

marshal(OtdOutputStream out) Method

marshal(OtdOutputStream out, String charset) Method

marshalToString() Method

reset() Method

resetHigh() Method

resetLow() Method

retrieveEncoding() Method

unmarshal(byte[] in) Method

unmarshal(OtdInputStream in) Method

unmarshal(OtdInputStream in, String charset) Method

unmarshal(byte[] in, String charset) Method

unmarshalFromString(String in) Method

useEncoding(String enc) Method

Non-Root Methods

BPEL Operations

Creating an Oracle Applications OTD

To Create an Oracle Applications OTD

Exposed Oracle Applications OTD Nodes

Staging Table Node

COUNT

Description

Parameters

Requirements

DELETE

Description

Parameters

Requirements

INITIALIZE

Description

Parameters

Requirements

MOVE

Description

Parameters

Requirements

REQUEST

Description

Parameters

Requirements

REQUEST_STATUS

Description

Parameters

Requirements

VALIDATE

Description

Parameters

Requirements

SWIFT Alliance Gateway Adapter OTD Features

Configuration Node

Constants Node

Primitives Node

Remote APIs Node

Service Node

Generating DTDs from PeopleTools 8.13

Generating and Publishing an XML Test Message

To generate a PeopleSoft XML message

Extracting and Viewing the XML Test Message

To view the XML message

Generating a DTD for the XML File

OTD Methods and Business Process Operations

sendMessage() method

Syntax

Description

Parameters

Return Value

Throws

sendMessage Operation

Description

Input and Output

processRequest Operation

Description

Input and Output

Creating an Oracle Applications OTD

The Oracle Applications Adapter uses a wizard-based OTD builder to create OTDs based on your Oracle tables. The wizard queries the Oracle tables to determine the hierarchies of the interface tables for a particular module, and creates a corresponding OTD. It also sets up the necessary staging table and the stored validation procedures to be run against the table.

Figure 18 Oracle Applications OTD

image:Oracle Apps Builder

When building an OTD, the wizard calls many JDBC APIs (for example, getProcedureColumns()) which in turn queries the database and returns the resultset. While the Adapter itself doesn’t issue the queries directly, it is the Oracle driver that translates the API into multiple queries. In a situation where there is a lot of data in the database, it may take a while to return all the resultsets to the wizard. The performance of the queries is dependent on the execution path which is formulated when a SQL call is prepared. Not having good statistics in the data dictionary could produce a long running query.

Oracle recommends doing the following to gather vital statistics to improve performance:

  1. Set the following in either the init.ora file or spfile (whichever is appropriate for your installation):

    _table_lookup_prefetch_size=0

  2. Analyze the SYS schema for the system as follows:

    1. Start SQL*Plus

    2. Connect as the sys user

    3. exec dbms_stats.gather_schema_stats(’SYS’);

    Keep in mind that significant changes to the database would affect the data dictionary (like new tables, indexes, and so on). You should consider running the analysis regularly.


    Note - Please consult your Database Administrator or Oracle before taking these steps as it may impact other applications.


To Create an Oracle Applications OTD

  1. In the projects window, right-click your Project, point to New, and then click Object Type Definition.

    The Object Type Definition Wizard appears.


    image:OTD Wizard Selection
  2. From the New Object Type Definition Wizard window, select the Oracle Applications Wizard and click Next.

    The Specify Database Connection Information page appears.


    image:Database Connection Information
  3. Specify the applicable connection information for your database including:
    • Host Name - The server where Oracle Applications resides.

    • Port ID- The port number of Oracle Applications.

    • SID - The name of the Oracle instance (equivalent to the database name).

    • User Name - The user name that the Adapter uses to connect to the database.

    • Password - The password used to access the database.

  4. Click Next.

    The Select Oracle Applications Module window appears.


    image:Select Database Objects
  5. Select the Business Function and Module and choose whether to use fully-qualified names and to replace existing stored procedures.
    Module Information
    Description
    Business Function
    Currently Financial and Manufacturing are the only supported business functions.
    Module
    The available modules in the Financial business function are:
    • Auto Invoice

    • Auto Lock

    • Bank Statement

    • Budget

    • Customers

    • Daily Rates

    • Fixed Assets Categories

    • Fixed Assets Mass Additions

    • Journal

    • Payable

      The available modules in the Manufacturing business function are:

    • Customer Item

    • Customer Item Cross-Reference

    • Cycle Count Entries

    • Item Import

    • Item Transactions

    • Order Requisition

    • Order Import

    • Order Receiving

    • Replenishment

    Use fully-qualified names in the Java code
    Specifies whether the generated Java code uses fully-qualified names.
    Replace Existing Stored Procedures
    Specifies to replace any existing stored procedures or stop the wizard if any stored procedures exist. You must select this option in order to continue with the wizard.

    Take care to back up any stored procedures you have modified before continuing with this wizard.


    Note - A set of stored procedures are installed with the Oracle Applications Adapter. Unless these stored procedures are somehow deleted, the only way to create the OTD is by selecting Replace Existing Stored Procedures, otherwise, the existing stored procedures are not overwritten, an error appears, and the wizard stops.


  6. Click Next to continue.

    The Specify the OTD Name window appears.


    image:Naming an OTD
  7. Enter a name for the OTD.
  8. Click Next.

    The Review Your Selections dialog box appears.


    image:Database Wizard - Summary
  9. View the summary of the OTD. If you find any errors, click Back and correct the information.
  10. If you are satisfied with the OTD information, click Finish to generate the OTD.

    Caution

    Caution - If the Oracle Applications DDL Scripts have not been properly installed, an error message occurs before the OTD can be successfully generated.


    The resulting OTD appears in the Java CAPS IDE. The time it takes the OTD to generate depends on the module you selected and your system performance.

    The generated OTD appears in the OTD Editor. Nodes and methods for your OTD depend on the module you selected and the configuration of your tables.


    image:Generated OTD