Open Interfaces and APIs

Overview

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 1 of 17 Rev Paradigm_revision
Open Interfaces and APIs
System References
None

Distribution
Job Title*

Ownership
The Job Title [list@YourCompany.com?Subject=703356333.doc] is responsible for ensuring
that this document is necessary and that it reflects actual practice.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 2 of 17 Rev Paradigm_revision
Open Interfaces and APIs

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 3 of 17 Rev Paradigm_revision
Objectives

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 4 of 17 Rev Paradigm_revision
Agenda

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 5 of 17 Rev Paradigm_revision
Open Interface Overview

Open Interface Overview

An interface enables you to:
• Import data from a variety of environments, including your own system, previous systems,
data collection devices, and external systems
• Review the results of import runs, including validation, review, update, re-imports, and
error identification
• Export data from Oracle Applications for use in other systems
Through open interfaces in Oracle Manufacturing, you can import historical data from other
management systems to keep your information consistent and up-to-date. You can review
results of the import run and identify the data that has been successfully imported. You can
also review the errors that occurred during the import process.
Instructor Note:
Oracle provides a hosted Integration Repository, which includes the APIs and Open Interfaces.
This includes table and column descriptions provided for each API, names of related
procedures and functions, and a brief high level description of each API.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 6 of 17 Rev Paradigm_revision
Interface Options

Interface Tables
Interface tables enable you to load data and run a concurrent program. The concurrent program
takes the data from the interface table, validates it, and imports it into your Applications'
instance.
Applications Programming Interfaces (APIs)
If you need tighter integration into Oracle Applications than what interface tables provide,
Oracle Applications also provides APIs.
APIs allow for tight integration into the Oracle Applications product. APIs provide a pre-
defined method to integrate into Oracle Applications.
There are also 3rd-party products that integrate into Oracle Applications and extend its
integration capabilities.
Other Methods
Oracle Applications provides other methods for data import and export. Spreadsheets are a
common method. Several Oracle Applications products allow for data upload and download
via spreadsheets. Spreadsheet formats are pre-defined.
Oracle Applications also support data uploads and downloads to Oracle Discoverer and word
processing files.
Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 7 of 17 Rev Paradigm_revision
Advantages of Open Interfaces

Advantages of Open Interfaces

Open interfaces enable you to:
• Integrate applications from different vendors with Oracle Applications
• Integrate your custom applications with Oracle Applications
• Integrate data from numerous sources, such as data collection devices
• Ensure validity of any data in your system through the use of a common validation
function (regardless of the source of the data)
Oracle Applications open interfaces simplify the process of converting data that is relatively
static from a prior system to Oracle Applications. For example, you can import inventory item
information from other systems into Oracle Inventory and Engineering using the Open Item
Interface.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 8 of 17 Rev Paradigm_revision
Interface Table Diagram

Interface Table Diagram

This is an example of the interface table methodology.
The Loader is responsible for uploading and downloading data from the interface table. Some
interface tables are inbound-only, outbound-only, and some are both. There are no restrictions
on your Loader. As long as the loader can communicate with the interface table in your Oracle
Applications' instance, you can use it as a loader. This is also the basic mechanism used for
transferring data with spreadsheets, word processing files, and others.
Once the data is in the interface table, it is validated. Validation is handled through a
concurrent program. In some cases this concurrent program is part of the import process. In
others, it is a separate validation program. In either case, invalid data is separated and noted.
This can be done through the generation of a report. It can also be done by moving the invalid
records into an error table. Once validation is complete, you may need to perform maintenance
on the data to correct errors or inconsistencies.
When the data is ready to go, the concurrent program takes the data from the interface table
and loads it into the Application. At no time are you writing data into or from the product
tables. The only tables you directly update are the interface tables.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 9 of 17 Rev Paradigm_revision
Open Interface Processing

Open Interface Processing

The following concurrent process parameters are frequently used in open interface processing:
• Launching multiple concurrent processes
• Batch size
• General prerequisites
Launching multiple concurrent processes
• For high-volume interfaces, you can use Oracle Applications to launch more than one
concurrent process to handle the processing of your data.
Batch size
• For frequently used open interfaces, you can use Oracle Applications to determine the
batch size (the number of rows you want processed in one batch). You set the batch size to
reflect the memory restrictions of your system during processing.
General prerequisites
• Before you use open interfaces, you should be familiar with the forms used to populate the
data tables from within the application.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 10 of 17 Rev Paradigm_revision
API Diagram

API Diagram
Here is an example of the API methodology.
The API methodology is different from the interface table methodology. The data is not staged.
The data is sent directly through the API. API methods are for single-record data importing.
Interface tables are for mass data importing.
The APIs communicate directly with the data source, letting it know if the import was
successful. The data source must be able to handle unsuccessful attempts to move data into the
product.
Using APIs creates a need for programs and code outside of Oracle Applications. The data
source must handle errors, data maintenance, and all the other actions that Oracle Application
interfaces do.
At no time are you writing data into or from the product tables. Only the API writes or reads
from the product tables. The API is responsible for communicating with your data source.
Instructor Note:
Oracle provides a hosted Integration Repository, which includes the APIs and Open Interfaces.
This includes table and column descriptions provided for each API, names of related
procedures and functions, and a brief high level description of each API.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 11 of 17 Rev Paradigm_revision
Agenda

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 12 of 17 Rev Paradigm_revision
Designing the Data Conversion Process

Designing the Data Conversion Process

For each converted entity, design a conversion process from data extraction through data
verification. Consider business objectives and dependencies for each point in the process.
Determine the technical resources that are available in the company and what resource can be
used in each of the design steps. Reduce the time required to execute the process with accurate
designs. Plan resources effectively with reasonable time estimates and good design
specifications. Clean up the database before conversion.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 13 of 17 Rev Paradigm_revision
Developing the Conversion Programs

Developing the Conversion Programs

Leverage existing interfaces in Oracle Applications to convert data. Write programs using
detailed design specifications to convert entities where an open interface does not exist.
Review, test, and tune the performance of each program to ensure a clean and timely
conversion. Identify any performance problems before the conversion date.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 14 of 17 Rev Paradigm_revision
Performing the Conversion

Performing the Conversion

After designing and developing all elements of the conversion, perform the conversion.
Manage any time constraints and ensure the integrity of the converted data. Minimize the time
required to actually convert from the original system to Oracle Applications by reviewing all
programs and designs before executing the conversion process.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 15 of 17 Rev Paradigm_revision
Development Standards

Document
Document the source of your data. Where is it coming from and how do you reproduce that
source, if it is not self-maintaining.
Document the method by which you move data from the source to the interface table or API.
Are you using SQL*Loader, spreadsheets, or C programs.
Document the data format. A simple description by column of the data you are moving.
Follow the Documentation
Open interfaces and APIs are documented in their product manuals. Use these sources.
Adhere to the Rules
Read the descriptions of the interface tables and APIs and follow the documentation. Oracle
Applications is a complex, inter-related product. You are not writing data into or from the
product tables. Only the interface tables and APIs write or read from the product tables.
Check Your Data
A big problem with interface tables and APIs is misformatted data. You are either not putting
the right data into the right columns of the interface table or you are not passing the proper
arguments in the proper format to the API.

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 16 of 17 Rev Paradigm_revision
Summary

Copyright © Oracle, 2007. All rights reserved.

Open Interfaces and APIs 703356333.doc

Effective Paradigm_effective Page 17 of 17 Rev Paradigm_revision