Free tool for Oracle E-Business Suite (EBS 12.2)

Oracle EBS Integration and EDI Designer

Pick the business objects and the systems you need to connect, and get an Oracle E-Business Suite integration inventory that names the real interface for each flow: open interface tables such as OE_HEADERS_IFACE_ALL with their import programs, public PL/SQL APIs such as OE_ORDER_PUB and HZ_CUST_ACCOUNT_V2PUB exposed through Integrated SOA Gateway, Workflow business events, or e-Commerce Gateway transactions such as POI, POAO, DSNO and INO. Switch to EDI mode to see how X12 850, 855, 856, 810 and their EDIFACT equivalents land in EBS, interface record by interface record.

Business objects

Toggle what moves between systems. Presets add a typical set.

Targets, direction and frequency

Direction is seen from Oracle EBS.

Nothing in scope yet

Pick an object or a preset in step 1.

Integration inventory

Oracle EBS has no single message bus. Batch inbound loads use open interface tables plus a concurrent import program; synchronous calls use public PL/SQL APIs deployed as SOAP or REST services through Integrated SOA Gateway; outbound events come from the Workflow Business Event System; EDI runs through e-Commerce Gateway flat files and a third-party translator. Every API call runs under an EBS user and responsibility, and multi-org data needs the operating unit (ORG_ID).

Your inventory appears here

Each interface gets the Oracle EBS method, the exact artifact and a relative effort score.
Free, optional. Reopen it on any device.
Download the design:

Exports include the inventory, rationale, field maps with your target names, selected EDI maps and risks. No sign-in needed.

How to use it

  1. 1

    Pick the objects

    Select the business objects in scope, such as customers, items, sales orders and shipments.

  2. 2

    Add the target systems

    For each object choose the system on the other side, the direction seen from Oracle EBS and how often data must move.

  3. 3

    Read the inventory

    Each row names the EBS interface (open interface table, PL/SQL API, SOA Gateway service, business event or e-Commerce Gateway transaction), why it fits and what to watch for.

  4. 4

    Check the field map

    Open the starter map for an object, fill in the target field names and note the keys, the ORIG_SYS references and the required columns.

  5. 5

    Export or save

    Download the design as PDF, Excel, Word or CSV, save it to your account, or send it to an engineer for review.

Oracle EBS interfaces in this tool

Open interface tables and import programs asynchronous
Staging tables such as OE_HEADERS_IFACE_ALL, MTL_SYSTEM_ITEMS_INTERFACE, RA_INTERFACE_LINES_ALL, AP_INVOICES_INTERFACE and GL_INTERFACE, processed by a concurrent program (Order Import, Import Items, AutoInvoice, Payables Open Interface Import, Journal Import). Validation runs in the program and failed rows stay in the interface with error messages for correction.
Public PL/SQL APIs synchronous
Documented public packages such as OE_ORDER_PUB (Process Order), HZ_CUST_ACCOUNT_V2PUB, HZ_CUST_ACCOUNT_SITE_V2PUB and QP_PREQ_PUB.PRICE_REQUEST. They return the new record id at once and apply the same validation as the forms. Call them from a database session after setting the apps context, or deploy them as services through Integrated SOA Gateway.
Integrated SOA Gateway (REST and SOAP) synchronous
Deploys Integration Repository interfaces as web services: PL/SQL APIs as SOAP or REST, open interface tables as REST (GET, POST, PUT, DELETE), concurrent programs as SOAP. REST endpoints follow /webservices/rest/<alias>/<operation>/ with a RESTHeader (Responsibility, RespApplication, SecurityGroup, Org_Id) and HTTP Basic or token based authentication.
Workflow Business Event System asynchronous
EBS raises named events (for example oracle.apps.ar.hz.CustAccount.update or oracle.apps.po.event.xmlpo). Subscribing through the Integration Repository enqueues the event as WF_EVENT_T on the WF_BPEL_Q advanced queue, where middleware dequeues it. Events usually carry keys, so the consumer reads the full record by API or view.
Oracle XML Gateway asynchronous
Message maps that produce or consume OAG style XML documents, delivered over the Oracle Transport Agent or queues. Used by delivered B2B flows such as the purchase order XML on PO approval and the Shipment_Request and Shipment_Advice messages for distributed warehouses and legacy shipping systems.
Oracle e-Commerce Gateway asynchronous
Delivered EDI for Order Management, Shipping, Receivables, Purchasing, Payables, Release Management and Supplier Scheduling. A third-party translator converts X12 or EDIFACT to fixed record flat files; e-Commerce Gateway imports them into the product open interfaces and extracts outbound documents through ECE views, with trading partner setup and code conversion in EBS.
Read-only SQL extract asynchronous
Read base tables or views through a read-only database account, a standby or a replicated copy for reporting and bulk extracts. Never insert or update EBS base tables; Oracle supports data changes only through forms, open interfaces and public APIs.

Questions

What is the difference between open interface tables and public APIs in Oracle EBS?

Open interface tables (for example OE_HEADERS_IFACE_ALL or GL_INTERFACE) are staging tables processed by a concurrent program such as Order Import or Journal Import. They suit batches, keep failed rows for correction and absorb peaks, but results arrive when the program runs. Public PL/SQL APIs (for example OE_ORDER_PUB or HZ_CUST_ACCOUNT_V2PUB) process one request at once and return the new record id, which suits integrations that need an answer immediately. Order Import itself calls the Process Order API, so validation is the same.

How do I expose an Oracle EBS API as a REST service?

Use Integrated SOA Gateway. An integration administrator finds the interface in the Integration Repository, sets a service alias, selects the methods, deploys it and creates grants for the integration user. The endpoint follows /webservices/rest/<alias>/<operation>/ and the request carries a RESTHeader with Responsibility, RespApplication, SecurityGroup, NLSLanguage and Org_Id. Open interface tables can be deployed as REST services too, for example RA_INTERFACE_LINES_ALL for AutoInvoice.

Which EDI transactions does e-Commerce Gateway support out of the box?

For customers: inbound 850 (POI), 860 (POCI), 830 (SPSI), 862 (SSSI) and 866 (PSQI); outbound 855 (POAO), 865 (POCAO), 856 (DSNO), 810 (INO) and 812 (CDMO). For suppliers: outbound 850 (POO), 860 (POCO), 830 (SPSO), 862 (SSSO), 820 (PYO) and 824 (ADVO); inbound 810 (INI), 832 (CATI), 843 (RRQI), 856 (ASNI) and 857 (SBNI). There is no 846 and no inbound 855 in the delivered list.

How does an inbound EDI 850 become a sales order in Oracle EBS?

The translator writes the POI flat file, e-Commerce Gateway validates the trading partner and loads the Order Import interface tables with ORDER_SOURCE_ID 6, and Order Import creates the order through the Process Order API. The customer is derived from the translator code and EDI location code, and customer items are resolved through the customer item cross references. Rows that fail stay in the interface for correction in Order Import Corrections.

How do I get business events out of Oracle EBS to middleware?

Subscribe to the event from the Integration Repository. EBS then enqueues it as a WF_EVENT_T message on the WF_BPEL_Q advanced queue, where an AQ consumer such as a SOA composite or other middleware dequeues it with a message selector on the event name. Events usually carry keys, so the consumer reads the full record afterwards. TCA events such as oracle.apps.ar.hz.CustAccount.update and the purchase order approval event oracle.apps.po.event.xmlpo are common starting points.

Can I insert directly into Oracle EBS base tables?

No. Inserting into OE_ORDER_LINES_ALL, MTL_SYSTEM_ITEMS_B or similar tables bypasses validation, workflow, accounting and the multi-org model, and Oracle does not support data created that way. Use the open interface tables, public APIs or e-Commerce Gateway, and keep direct SQL to read-only extracts.

Why are my Order Import rows not processed?

Common causes: READY_FLAG is N, ORG_ID does not match the operating unit of the responsibility running Order Import, the order source or order type is missing, or defaulting rules do not supply a price list or salesperson. Check the Order Import Corrections window and the Process Messages for the exact error, fix the row and resubmit.

How do I send a third-party WMS picks and get ship confirms back?

Shipping Execution supports XML transactions through XML Gateway: Shipment_Request sends delivery data to the external system and Shipment_Advice returns what shipped, equivalent to the X12 940 and 945. For a distributed warehouse, enable the organization as distributed and set WSH: Distributed Source Entity. Receipts come back through the Receiving Open Interface.