Om API

Oracle® Order Management
Open Interfaces, API, & Electronic Messaging Guide

Release 12
Part No. B31585-01
April 2007
Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 12
Part No. B31585-01
Copyright © 1996, 2007, Oracle. All rights reserved.
Primary Author: John Brazier, Pratima Mahtani, John Salvini
Contributing Author: Alok Singh, Pravin Nair, Rakesh Moharana, Sasi Erla, Anjana Ramachandran
The Programs (which include both the software and documentation) contain proprietary information; they
are provided under a license agreement containing restrictions on use and disclosure and are also protected
by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or
decompilation of the Programs, except to the extent required to obtain interoperability with other
independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in
the documentation, please report them to us in writing. This document is not warranted to be error-free.
Except as may be expressly permitted in your license agreement for these Programs, no part of these
Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on
behalf of the United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS

Programs, software, databases, and related documentation and technical data delivered to U.S. Government
customers are "commercial computer software" or "commercial technical data" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall
be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent
applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted
Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for such
purposes, and we disclaim liability for any damages caused by such use of the Programs.
The Programs may provide links to Web sites and access to content, products, and services from third parties.
Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all
risks associated with the use of such content. If you choose to purchase any products or services from a third
party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality
of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party,
including delivery of products or services and warranty obligations related to purchased products or services.
Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third
party.
Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective owners.

Contents
Send Us Your Comments
Preface
1 Integrating Your Systems

Overview of Oracle Order Management APIs and Open Interfaces....................................... 1-1
Basic Business Needs................................................................................................................ 1-1
Oracle Order Management Interfaces.......................................................................................1-2
Inbound Open Interface Model.............................................................................................. 1-11
Components of an Open Interface.......................................................................................... 1-13
2 Oracle Advanced Pricing Open Interfaces and APIs

Key of Short Names................................................................................................................... 2-2
Agreements Public Application Program Interface................................................................. 2-2
Functional Overview........................................................................................................... 2-2
Setting Up and Using Parameter Descriptions.....................................................................2-2
Validation of Agreements Public API................................................................................ 2-26
Example of Agreements Public API................................................................................... 2-26
Attribute Mapping Application Program Interface............................................................... 2-26
Functional Overview......................................................................................................... 2-27
Setting Up and Parameter Descriptions............................................................................. 2-28
Business Object for Modifier Setup Application Program Interface.................................... 2-48
Validation of Business Object for Modifier Setup API....................................................... 2-86
Example of Modifier Setup Application Program Interface...............................................2-86
iii
Business Object for Pricing Formulas Application Program Interface..................................2-87
Validation of Business Object for Pricing Formulas API....................................................2-99
Example of Pricing Formulas API...................................................................................... 2-99
Business Object for Pricing Limits Application Program Interface.................................... 2-100
Functional Overview....................................................................................................... 2-100
Setting Up and Parameter Descriptions........................................................................... 2-101
Validation of Limits Public API....................................................................................... 2-118
Example of Limits Public API.......................................................................................... 2-119
Create Publish Price Book Application Program Interface.................................................. 2-119
Validation of Create Publish Price Book API................................................................... 2-123
Examples of Create_Publish_Price_Book API.................................................................. 2-126
Get Currency Application Program Interface....................................................................... 2-126
Validation of Get_Currency API...................................................................................... 2-127
Get Custom Price Application Program Interface................................................................ 2-128
Validation of Get Custom Price API................................................................................ 2-130
Get Price Book Application Program Interface ................................................................... 2-133
Setting Up and Parameter Descriptions .......................................................................... 2-134
Validation of Get Price Book API..................................................................................... 2-144
Examples of Get_Price_Book API.................................................................................... 2-145
Get Price List Application Program Interface.......................................................................2-145
Validation of Get_Price_List API..................................................................................... 2-147
Multi-Currency Conversion Setup Application Program Interface.....................................2-147
Validation of Multi-Currency Conversion API................................................................ 2-156
Example of Multi-Currency Conversion API................................................................... 2-157
Price List Setup Application Program Interface................................................................... 2-157
Validation of Price List Setup API....................................................................................2-178
iv
Example of Price List Setup API...................................................................................... 2-178
Price List Setup Group Application Program Interface....................................................... 2-179
Validation of Price List Group API.................................................................................. 2-199
Price Request Application Program Interface...................................................................... 2-200
Validation of Price Request API....................................................................................... 2-260
Example of Price Request Application Program Interface............................................... 2-260
Pricing Data Bulk Loader API............................................................................................... 2-263
Functional Overview .......................................................................................................2-263
Validation of Pricing Data Bulk Loader .......................................................................... 2-265
Examples of Pricing Data Bulk Loader API..................................................................... 2-267
Pricing Object Security - Check Function API..................................................................... 2-275
Validation of Pricing Object Security API........................................................................ 2-278
Pricing Attributes Application Program Interface............................................................... 2-278
Attribute Mapping Application Program Interface............................................................. 2-291
Validation of Attribute Mapping API.............................................................................. 2-297
Qualifiers Application Program Interface............................................................................ 2-297
Setting Up and Parameter Descriptions .......................................................................... 2-298
Validation of Qualifiers API.............................................................................................2-315
Example of Qualifiers API............................................................................................... 2-315
Reverse Limits Application Program Interface.................................................................... 2-315
Validation of Reverse Limits API..................................................................................... 2-321
Example of Reverse Limits API........................................................................................2-322
Round Price Application Program Interface........................................................................ 2-323
Validation of Round Price API......................................................................................... 2-325
Validate Price List with Currency Code Application Program Interface............................ 2-325
v
Validation of Validate Price List with Currency Code API.............................................. 2-326
3 Oracle Advanced Pricing XML Transactions

Get Catalog Transaction............................................................................................................ 3-1
Setting up and Parameter Descriptions................................................................................3-2
Validation of Get Catalog Transaction............................................................................... 3-12
Examples of the Get Catalog Transaction ......................................................................... 3-13
Sync Catalog Transaction........................................................................................................ 3-17
Validation of Sync Catalog Transaction............................................................................. 3-29
Examples of Sync Catalog Transaction.............................................................................. 3-29
4 Oracle Order Management XML Transactions: Implementation Considerations

Process_PO................................................................................................................................ 4-1
Setup: Customer Setup.........................................................................................................4-1
Installation..................................................................................................................... 4-6
Message Map: Seeded Workflow for Inbound XML Messages............................................4-7
Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO............................... 4-9
Acknowledge_PO.................................................................................................................... 4-22
Message Map..................................................................................................................... 4-22
Setup: Customer Setup.......................................................................................................4-22
Oracle XML Gateway Details............................................................................................. 4-26
Show_SalesOrder.................................................................................................................... 4-27
Setup.................................................................................................................................. 4-27
Additional User Setup................................................................................................. 4-31
Change_SalesOrder................................................................................................................. 4-39
Setup.................................................................................................................................. 4-39
Data Archive and Purge Procedures........................................................................... 4-43
Change_PO.............................................................................................................................. 4-44
Implementation Considerations.........................................................................................4-47
Message Map..................................................................................................................... 4-47
Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO....................................4-76
Cancel_PO............................................................................................................................... 4-86
Setup: Customer Setup ...................................................................................................... 4-86
Implementation Considerations.........................................................................................4-90
Open Interface Tracking ........................................................................................................ 4-90
Integration Event – oracle.apps.ont.oi.xml_int.status............................................................ 4-91
vi
User Procedures............................................................................................................... 4-100
5 Oracle Order Management XML Transactions

What is RosettaNet?.................................................................................................................. 5-1
Process_PO ................................................................................................................................ 5-4
Acknowledge_PO.................................................................................................................... 5-41
Show_SalesOrder ................................................................................................................... 5-62
Change_salesorder.................................................................................................................. 5-78
Inbound Change PO Request ................................................................................................ 5-96
Cancel Purchase Order ......................................................................................................... 5-136
CONFIRM BOD.................................................................................................................... 5-139
Message Map................................................................................................................... 5-139
Seeded Workflow for Inbound XML Messages................................................................... 5-148
Message Details .................................................................................................................... 5-150
Extension Tags....................................................................................................................... 5-153
Open Interface Tracking ...................................................................................................... 5-156
Overview......................................................................................................................... 5-156
Major Features................................................................................................................. 5-157
Business Scenarios and Process Flow............................................................................... 5-158
Messages.......................................................................................................................... 5-158
Event/Event Subscription...................................................................................................... 5-161
Seeded workflow OEEM/Open Interface Tracking............................................................. 5-161
Event Parameters & Population............................................................................................ 5-161
6 Oracle Order Management EDI Transactions

Oracle Order Management........................................................................................................ 6-1
Inbound Purchase Order (POI/850/ORDERS).......................................................................... 6-2
Order Import ............................................................................................................................. 6-5
Review and Resolve Order Management Open Interface Exceptions..................................... 6-5
7 Oracle Order Management Open Interfaces and APIs

Integrating Oracle Order Management Using Order Import...................................................7-1
Process Order Application Open Interface........................................................................... 7-110
8 Oracle Order Management: Integration with Other Products

Integrating Oracle Order Management with Oracle Receivables and Invoicing.................... 8-1
Telecommunications Services Orders (MACD) Interfaces.................................................... 8-52
vii
9 Oracle Release Management XML Transactions
Overview of Oracle Release Management XML...................................................................... 9-1
Planning Schedule Transaction................................................................................................ 9-3
Sample Document Type Definition (DTD) and XML for Planning Schedule.......................9-4
Planning Schedule XML to Database Mapping................................................................... 9-9
Shipping Schedule Transaction.............................................................................................. 9-18
Sample Document Type Definition (DTD) and XML for Shipment Schedule....................9-20
Shipping Schedule XML to Database Mapping................................................................. 9-23
10 Oracle Release Management EDI Transactions

Production Sequence EDI....................................................................................................... 10-1
Shipping Schedule EDI........................................................................................................... 10-1
Planning Schedule EDI........................................................................................................... 10-2
Purpose Codes......................................................................................................................... 10-2
Transaction Descriptions........................................................................................................ 10-4
11 Oracle Release Management Open Interfaces and APIs

Understanding the Demand Processor Interface Tables........................................................ 11-1
Release Management Schedule Headers RLM_INTERFACE_HEADERS_ALL................ 11-1
Release Management Schedule Lines RLM_INTERFACE_LINES_ALL.......................... 11-23
12 Oracle Shipping Execution Open Interfaces and APIs

Overview of API Information................................................................................................. 12-1
Shipment Processing Using APIs........................................................................................... 12-3
Actions, APIs, and Parameters.............................................................................................. 12-16
Application Parameter Initialization.................................................................................... 12-34
Trip Public Application Program Interface.......................................................................... 12-35
Create_Update_Trip API Features................................................................................... 12-35
Functional Overview................................................................................................. 12-35
Trip_Action API Features................................................................................................ 12-41
Trip_Action (overloaded version) API features............................................................... 12-43
Stop Public Application Program Interface.......................................................................... 12-49
Create_Update_Stop API Features...................................................................................12-49
Stop_Action API Features................................................................................................ 12-56
viii
Deliveries Public Application Program Interface................................................................ 12-59
Create_Update_Delivery API Features............................................................................ 12-59
Delivery_Action API Features......................................................................................... 12-70
Generate_Documents API Features................................................................................. 12-76
Setting Up the Generate_Documents API........................................................................ 12-77
Exceptions Application Program Interface........................................................................... 12-78
Exception_Action API Features....................................................................................... 12-78
Setting Up the Exception_Actions API............................................................................ 12-79
Get_Exceptions API Features........................................................................................... 12-87
Setting Up the Get_Exceptions API..................................................................................12-87
Delivery Details Public Application Program Interface...................................................... 12-89
Detail_To_Delivery API Features.................................................................................... 12-90
Split_Line API Features................................................................................................... 12-92
Update_Shipping_Attributes API Features..................................................................... 12-95
Autocreate_Deliveries API Features.............................................................................. 12-107
Autocreate_Del_Trip API Features................................................................................ 12-109
Get_Detail_Status API Features..................................................................................... 12-111
Functional Overview............................................................................................... 12-111
Update_Shipping_Attributes (overloaded version) API................................................ 12-113
Init_Changed_Attribute_Rec API Features.................................................................... 12-125
AUTOCREATE_DEL_TRIP (overloaded version) API Features.................................... 12-136
Container Public Application Program Interface............................................................... 12-138
Create_Containers API Features.................................................................................... 12-139
Update Container API Features..................................................................................... 12-142
Auto_Pack API Features................................................................................................ 12-149
Container_Actions API Features.................................................................................... 12-152
ix
Freight Costs Public Application Program Interface..........................................................12-155
Create_Update_Freight_Costs API Features.................................................................. 12-155
Validate_Freight_Cost_Type API Features.................................................................... 12-161
Delete_Freight_Costs API Features................................................................................ 12-162
Pick Release Application Program Interface...................................................................... 12-167
Create_Batch API Features.............................................................................................12-168
Release_Batch API Features........................................................................................... 12-179
Get_Batch_Record API Features.................................................................................... 12-181
Document Public Application Program Interface.............................................................. 12-193
Functional Overview..................................................................................................... 12-193
Custom Public Application Program Interface.................................................................. 12-199
UI_Location_Code API Features.................................................................................... 12-199
Calculate_TP_Dates API Features.................................................................................. 12-203
Example of API Packages and Procedures.......................................................................... 12-204
13 Oracle Shipping Execution XML Transactions

XML Overview........................................................................................................................ 13-1
Oracle XML Gateway Setup.................................................................................................... 13-2
Trading Partners................................................................................................................ 13-3
Code Conversions.............................................................................................................. 13-3
Using XML Messaging with Carrier Manifesting.................................................................. 13-4
ShowShipment Request Transaction for Carrier Manifesting............................................ 13-5
ShowShipment Advice Transaction for Carrier Manifesting............................................. 13-6
Defining Trading Partners for Carrier Manifesting........................................................... 13-7
Overview of XML and DTD for Carrier Manifesting....................................................... 13-10
Document Type Definition (DTD) for Carrier Manifesting..............................................13-10
Sample XML Transaction for Carrier Manifesting........................................................... 13-13
Using XML Messaging with Third Party Warehousing....................................................... 13-88
ShowShipment Request Transaction for Third Party Warehousing................................ 13-89
ShowShipment Advice Transaction for Third Party Warehousing..................................13-90
Defining Trading Partners for Third Party Warehousing................................................ 13-90
Overview of XML and DTD for Third Party Warehousing..............................................13-95
Sample Document Type Definitions (DTD) for Third Party Warehousing...................... 13-95
x
Sample XML Transactions for Third Party Warehousing................................................ 13-98
Using XML Messaging with International Trade Management........................................ 13-176
ItemSynchronization Request Transaction for ITM....................................................... 13-176
PartySynchronization Request Transaction for ITM...................................................... 13-177
OrderCompliance Request for ITM................................................................................13-177
DeliveryCompliance Request Transaction for ITM........................................................ 13-177
ExportCompliance Response Transaction for ITM........................................................ 13-178
Overview of XML and DTD for ITM............................................................................. 13-179
ITM DTDs...................................................................................................................... 13-179
Sample ITM XML Transactions......................................................................................13-187
14 Oracle Shipping Execution EDI Transactions

DSNO...................................................................................................................................... 14-1
A Oracle Order Management Error and Information Messages

Process_PO and Acknowledge_PO.......................................................................................... A-1
Show_SalesOrder...................................................................................................................... A-2
Cancel_PO................................................................................................................................. A-2
Change SO................................................................................................................................. A-3
Inbound Change PO Request................................................................................................... A-4
xi

Send Us Your Comments
Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 12
Part No. B31585-01
Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.
Your feedback is important, and helps us to best meet your needs as a user of our products. For example:
• Are the implementation steps correct and complete?
• Did you understand the context of the procedures?
• Did you find any errors in the information?
• Does the structure of the information help you with your tasks?
• Do you need different information or graphics? If so, where, and in what format?
• Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us your name, the
name of the company who has licensed our products, the title and part number of the documentation and
the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that you have the latest version of the
document and if any concerns are already addressed. To do this, access the new Applications Release
Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most
current Documentation Library plus all documents revised or released recently.
Send your comments to us using the electronic mail address: appsdoc_us@oracle.com
Please give your name, address, electronic mail address, and telephone number (optional).
If you need assistance with Oracle software, then please contact your support representative or Oracle
Support Services.
If you require training or instruction in using Oracle software, then please contact your Oracle local office
and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at
www.oracle.com.
xiii

Preface
Intended Audience
Welcome to Release 12 of the Oracle Order Management Open Interfaces, API, & Electronic
Messaging Guide.
This guide assumes you have a working knowledge of the following:
• The principles and customary practices of your business area.
• The Oracle Applications graphical user interface. To learn more about the Oracle
Applications graphical user interface, read the Oracle Applications User's Guide.
See Other Information Sources for more information about Oracle Applications product
information.
See Related Information Sources on page xvi for more Oracle Applications product
information.
TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services
within the United States of America 24 hours a day, seven days a week. For TTY
support, call 800.446.2398.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of assistive
technology. This documentation is available in HTML format, and contains markup to
facilitate access by the disabled community. Accessibility standards will continue to
evolve over time, and Oracle is actively engaged with other market-leading technology
xv
vendors to address technical obstacles so that our documentation can be accessible to all
of our customers. For more information, visit the Oracle Accessibility Program Web site
at http://www.oracle.com/accessibility/ .
Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The
conventions for writing code require that closing braces should appear on an otherwise
empty line; however, some screen readers may not always read a line of text that
consists solely of a bracket or brace.
Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations
that Oracle does not own or control. Oracle neither evaluates nor makes any
representations regarding the accessibility of these Web sites.
Structure
1 Integrating Your Systems
2 Oracle Advanced Pricing Open Interfaces and APIs
3 Oracle Advanced Pricing XML Transactions
4 Oracle Order Management XML Transactions: Implementation Considerations
5 Oracle Order Management XML Transactions
6 Oracle Order Management EDI Transactions
7 Oracle Order Management Open Interfaces and APIs
8 Oracle Order Management: Integration with Other Products
9 Oracle Release Management XML Transactions
10 Oracle Release Management EDI Transactions
11 Oracle Release Management Open Interfaces and APIs
12 Oracle Shipping Execution Open Interfaces and APIs
13 Oracle Shipping Execution XML Transactions
14 Oracle Shipping Execution EDI Transactions
A Oracle Order Management Error and Information Messages
Related Information Sources

Oracle Order Management User's Guide
Oracle Order Management Implementation Manual
Using Oracle Workflow in Oracle Order Management
Oracle e-Commerce Gateway Implementation Manual
Oracle e-Commerce Gateway User's Guide
Oracle XML Gateway User's Guide
Oracle Integration Repository User's Guide
xvi
Oracle Configure to Order Process Guide
Oracle Shipping Execution User's Guide
Oracle Advanced Pricing Implementation Manual
Oracle Advanced Pricing User's Guide
Oracle Release Management Implementation Manual
Oracle Release Management User's Guide
Oracle Applications Multiple Organizations Implementation Guide
Integration Repository
The Oracle Integration Repository is a compilation of information about the service
endpoints exposed by the Oracle E-Business Suite of applications. It provides a
complete catalog of Oracle E-Business Suite's business service interfaces. The tool lets
users easily discover and deploy the appropriate business service interface for
integration with any system, application, or business partner.
The Oracle Integration Repository is shipped as part of the E-Business Suite. As your
instance is patched, the repository is automatically updated with content appropriate
for the precise revisions of interfaces in your environment.
Do Not Use Database Tools to Modify Oracle Applications Data

Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data
Browser, database triggers, or any other tool to modify Oracle Applications data unless
otherwise instructed.
Oracle provides powerful tools you can use to create, store, change, retrieve, and
maintain information in an Oracle database. But if you use Oracle tools such as
SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your
data and you lose the ability to audit changes to your data.
Because Oracle Applications tables are interrelated, any change you make using an
Oracle Applications form can update many tables at once. But when you modify Oracle
Applications data using anything other than Oracle Applications, you may change a
row in one table without making corresponding changes in related tables. If your tables
get out of synchronization with each other, you risk retrieving erroneous information
and you risk unpredictable results throughout Oracle Applications.
When you use Oracle Applications to modify your data, Oracle Applications
automatically checks that your changes are valid. Oracle Applications also keeps track
of who changes information. If you enter information into database tables using
database tools, you may store invalid information. You also lose the ability to track who
has changed your information because SQL*Plus and other database tools do not keep a
record of changes.
xvii
1
Integrating Your Systems
This chapter covers the following topics:

• Overview of Oracle Order Management APIs and Open Interfaces
• Basic Business Needs
• Oracle Order Management Interfaces
• Inbound Open Interface Model
• Components of an Open Interface
Overview of Oracle Order Management APIs and Open Interfaces

Oracle Order Management products provide a number of open interfaces that you can
link to, and exchange data with, other Oracle applications and non-Oracle applications
like legacy systems.
This chapter will help you understand the general model that Oracle Order
Management products use for open interfaces. Other chapters in this book provide
information about how to use specific open interfaces. Additional functional
information about the interfaces is available in the user or implementation guide for
each product. Additional technical information on these interfaces is available in the
product-specific e-Technical Reference Manuals.
Basic Business Needs

APIs and open interfaces of the Oracle Order Management Suite provide you with the
features you need to support the following basic business needs:
• Connect to data collection devices. You can collect material movement transactions
such as receipts, issues, quality data, movements, completions, and shipments. This
improves data entry speed and transaction accuracy.
• Connect to other systems such as finite scheduling packages, computer-aided
Integrating Your Systems 1-1

design systems, and custom and legacy manufacturing systems to create integrated
enterprise wide systems.
• Connect to external systems such as the customer's purchasing system and the
supplier's order entry system to better integrate the supply chain via electronic
commerce.
• Control processing of inbound data imported from outside Oracle applications.
• Validate imported data to maintain data integrity within the application.
• Review, update, and resubmit imported data that failed validation.
• Export data from Oracle Order Management products to external systems.
Oracle Order Management Interfaces
Open Interface Architectures

Oracle Order Management products use three different methods for importing and
exporting data:
• Interface Tables
• Interface Views (Business Views)
• Function Calls or Programmatic Interfaces (Processes)
Interface Tables
Interface tables in Oracle Order Management applications provide a temporary storage
area for loading information from an external source. After the information is loaded,
concurrent programs are executed to validate the information and then apply the
information to the base product tables.
The benefit of an interface table is that it provides a repository where records can be
processed and if errors are found, you can edit the records and resubmit them.
In the Oracle Order Management family of applications you should never write directly
to the product tables. An Oracle Applications validation step is always required. You
may achieve this either by loading information into the interface tables and submitting
a provided concurrent program to validate and process the information or by using a
function call to a programmatic interface.
1-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Interface Views (Business Views)
Views simplify the data relationships for easier processing, whether for reporting or
data export. Oracle Order Management products have defined business views that
identify areas of key business interest. You can access this data using a tool of your
choice. The OE_ORDER_HEADERS_BV is an example of a key business view.
Function Calls or Programmatic Interfaces (Processes)

As an alternative to the two step process of writing to an interface table and executing a
program to process the table data, many Oracle Order Management interfaces support
direct function calls. A calling application can pass appropriate parameters and execute
a public function to invoke the application logic.
The benefit of a function call is that the integration is real time, as opposed to interface
tables where the integration is batch.
Summary: Beyond Published Interfaces

The Oracle Cooperative Applications Initiative references many third party products
that provide import and export capabilities and allow varying degrees of integration
with legacy systems, supplier systems, and so on. Contact your Oracle consultant for
more information about system integration.
Some Key Terms and Tables

The lists below provide information on the database tables, views, procedures, and
modules used in data integration.
Table Key
Key Description
Data Flow Direction Inbound means into Oracle Order

Management; Outbound means out from
Oracle Order Management
Iface Man The interface is documented in detail in the

Oracle Order Management Open Interfaces, API,
& Electronic Messaging Guide
e-TRM The tables, views, or modules are described in

the product's e-Technical Reference Manual

Oracle Order Management APIs/Open Interfaces
Interface/API Data Flow Table, View, Iface Man TRM Table, View,
Name Direction Process, or Module
Procedure Name, or
Procedure
Name
ONT ONT ONT ONT ONT ONT
Order Import Inbound Table Yes Yes OE_HEADER

S_IFACE_AL
L
OE_LINES_IF
ACE_ALL
OE_RESERV
TNS_IFACE_
ALL
OE_CREDITS
_IFACE_ALL
OE_PRICE_A
DJS_IFACE_
ALL
OE_LOTSERI
ALS_IFACE_
ALL
OE_ACTION
S_IFACE_AL
L
Process Inbound Process No Yes OE_ORDER_

Order PUB.PROCES
S_ORDER
QP QP QP QP QP QP
Procedure Name, or
Procedure
Name
Agreement Inbound/Out Procedure Yes Yes OE_PRICING

Public bound _CONT_PUB.
Application PROCESS_A
Program GREEMENT
Interface
OE_PRICING
_CONT_PUB.
GET_AGREE
MENT
OE_PRICING
_CONT_PUB.
LOCK_AGRE
EMENT
Attribute Inbound/Out Procedure Yes Yes QP_ATTR_M

Mapping bound APPING_PU
Application B.BUILD_CO
Program NTEXTS
Interface
Business Inbound/Out Procedure Yes Yes QP_MODIFI

Object for bound ERS_PUB.PR
Modifier OCESS_MOD
Setup IFIERS
Application
Program QP_MODIFI
Interface ERS_PUB.GE
T_MODIFIER
S
QP_MODIFI
ERS_PUB.LO
CK_MODIFI
ERS

Procedure Name, or
Procedure
Name
Business Inbound/Out Procedure Yes Yes QP_PRICE_F

Object for bound ORMULA_P
Pricing UB.LOCK_P
Formulas RICE_FORM
Application ULA
Program
Interface QP_PRICE_F
ORMULA_P
UB.PROCESS
_PRICE_FOR
MULA
QP_PRICE_F
ORMULA_P
UB.GET_PRI
CE_FORMUL
A
Business Procedure Yes Yes QP_LIMITS_

Object for PUB.PROCES
Pricing S_LIMITS
Limits
Application QP_LIMITS_
Program PUB.GET_LI
Interface MITS
QP_LIMITS_
PUB.LOCK_L
IMITS
Create Inbound/Out Procedure Yes Yes QP_PRICE_B

Publish Price bound OOK_PUB.C
Book REATE_PUB
Application LISH_PRICE
Program _BOOK
Interface
Procedure Name, or
Procedure
Name
Custom Inbound/Out Procedure Yes Yes QP_RUNTIM

Runtime bound E_SOURCE.G
Sourcing ET_NUMERI
Application C_ATTRIBUT
Program E_VALUE
Interface
Get Currency Inbound/Out Procedure Yes Yes QP_CURREN

Application bound CY_PUB.GET
Program _CURRENCY
Interface
Get_Attribute Inbound/Out Procedure Yes Yes QP_UTIL_PU

_Text bound B.GET_ATTR
Application IBUTE_TEXT
Program
Interface
Get Custom Inbound/Out Procedure Yes Yes QP_CUSTO

Price (Used in bound M.GET_CUS
Formulas TOM_PRICE
Setup)
Application
Program
Interface
Get Price Inbound/Out Procedure Yes Yes QP_PRICE_B

Book bound OOK.GET_P
Application RICE_BOOK
Program
Interface
Get Price For Inbound/Out Procedure Yes Yes QP_PREQ_P

Line bound UB.PRICE_R
Application EQUEST
Program
Interface

Procedure Name, or
Procedure
Name
Get Price List Inbound/Out Procedure Yes Yes QP_UTIL_PU

Currency bound B.GET_CURR
Application ENCY
Program
Interface
Get Price List Inbound/Out Procedure Yes Yes QP_UTIL_PU

Application bound B.GET_PRIC
Program E_LIST
Interface
Multi-Curren Inbound/Out Procedure Yes Yes QP_CURREN

cy bound CY_PUB.
Conversion PROCESS_C
Setup URRENCY
Application
Program
Interface
Price List Inbound/Out Procedure Yes Yes QP_PRICE_L

Setup bound IST_PUB.PR
OCESS_PRIC
E_LIST
QP_PRICE_L
IST_PUB.GET
_PRICE_LIST
QP_PRICE_L
IST_PUB.LO
CK_PRICE_L
IST
Price List Inbound/Out Procedure Yes Yes QP_PRICE_L

Setup Group bound IST_GRP.PR
Application OCESS_PRIC
Program E_LIST
Interface
Procedure Name, or
Procedure
Name
Price Request Inbound/Out Procedure Yes Yes QP_PREQ_G

Application bound RP.PRICE_R
Program EQUEST
Interface
Pricing Data Inbound/Out Procedure Yes Yes QP_BULK_L

Bulk Loader bound OADER_PUB
API .LOAD_PRIC
ING_DATA
Pricing Inbound/Out Procedure Yes Yes QP_SECURIT

Object bound Y.CHECK_F
Security UNCTION
CHECK_FU
NCTION
Qualifiers Inbound/Out Procedure Yes Yes QP_QUALIFI

Application bound ER_RULES_P
Program UB.PROCESS
Interface _QUALIFIER
_RULES
QP_QUALIFI
ER_RULES_P
UB.LOCK_Q
UALIFIER_R
ULES
QP_QUALIFI
ER_RULES_P
UB.GET_QU
ALIFIER_RU
LES
QP_QUALIFI
ER_RULES_P
UB.COPY_Q
UALIFIER_R
ULES

Procedure Name, or
Procedure
Name
Reverse Inbound/Out Procedure Yes Yes QP_UTIL_PU

Limits bound B.REVERSE_
Application LIMITS
Program
Interface
Round Price Inbound/Out Procedure Yes Yes QP_UTIL_PU

Application bound B.ROUND_P
Program RICE
Interface
Validate_Pric Inbound/Out Procedure Yes Yes QP_UTIL_PU

e_list_Curr_c bound B.VALIDATE
ode _PRICE_LIST
Application _CURR_COD
Program E
Interface
RLM RLM RLM RLM RLM RLM
RLM_INTER Inbound Table Yes Yes RLM_INTER

FACE_HEAD FACE_HEAD
ERS ERS
RLM_INTER Inbound Table Yes Yes RLM_INTER

FACE_LINES FACE_LINES
WSH WSH WSH WSH WSH WSH
Trip Public Inbound Procedure Yes No WSH_TRIPS_

API PUB
(Procedure
package)
Stop Public Inbound Procedure Yes No WSH_TRIP_S

API TOPS_PUB
(Procedure
package)
Procedure Name, or
Procedure
Name
Deliveries Inbound Procedure Yes No WSH_DELIV

Public API ERIES_PUB
(Procedure
package)
Exceptions Inbound Procedure Yes No WSH_EXCEP

Public API TIONS_PUB
(Procedure
package)
Delivery Inbound Procedure Yes No WSH_DELIV

Details Public ERY_DETAIL
API S_PUB
(Procedure
package)
Container Inbound Procedure Yes No WSH_CONT

Public API AINER_PUB
(Procedure
package)
Freight Costs Inbound Procedure Yes No WSH_FREIG

Public API HT_COSTS_P
UB
(Procedure
package)
Pick Release Inbound Procedure Yes No WSH_PICKI

Application NG_BATCH
Program ES_PUB
Interface API (Procedure
package)
Inbound Open Interface Model

Oracle Order Management products use both inbound and outbound interfaces. For
inbound transactions and data import, interface tables as well as supporting validation,
processing, and maintenance programs are available. For outbound transactions and
data export to external systems, database views are available and the destination
application provides the validation, processing, and maintenance programs.

Discussion of Inbound Interfaces
In this manual, we discuss only inbound interfaces in detail. You can find information
about the tables, views, and processes related to outbound interfaces in the e-TRM for
each product. Note that the e-TRMs do not contain detailed, narrative descriptions
about the outbound interfaces.
Open Interface Diagram

This diagram shows the general model for open application interfaces:
Open API Diagram

This diagram illustrates the model used by APIs such as the Service Request interfaces
(Oracle Service):
Components of an Open Interface
The components described below are common to most open interfaces. Please note that
the component may be implemented slightly differently than described below.
Source Application
A source application may be an external system or another module in the e-Business
Suite. Data may be processed and stored in a source application.
Destination Application
A destination application may be an external system or another module in the
e-Business Suite. You send data to a destination application so that the application can
perform further processing and storage.
Interface Table
For inbound interfaces, the interface table is the intermediary table where the data from

the source application temporarily resides until it is validated and processed into an
Oracle Order Management product. The various types of interface columns, are listed
below:
Identifier Columns
Identifier columns uniquely identify rows in the interface table and provide foreign key
reference to both the source and destination applications. For example, typical identifier
columns for a move transaction would identify:
• The source application
• The row's unique identifier in the source application
• The destination application's unique identifier.
Control Columns
Control columns track the status of each row in the interface table as it is inserted,
validated, processed with or without errors, and ultimately deleted. Additional control
columns identify who last updated the row and the last update date.
Data Columns
Data columns store the specific attributes that the source application is sending to the
Oracle Order Management products.
Required Columns
Required columns store the minimum information needed by the Oracle Order
Management products to successfully process the interface row.
Some columns are conditionally required based on the specifics of the interface.
Derived Columns
Derived columns are created by the destination application from information in the
required columns. Derived columns are usually required columns that need to contain a
value so that processing may continue.
Optional Columns
The data in optional columns is not mandatory for transaction processing to take place,
however the optional columns may be useful for storing additional information.
Errors Table
For inbound interfaces, the errors table stores all errors generated by the validation and
processing functions. You can either handle multiple error rows or single rows to
resolve the errors.
Database View
Database views are database objects that enable users of destination applications to look
at source application data.
Oracle Order Management products provide predefined views of key data that is likely
to be used by destination applications.
For example, Oracle Cost Management provides work in process valuation and
transaction distribution database views for use by other cost reporting destination
products.
Load Function
For inbound interfaces, the load function is the set of programs that selects and
accumulates data from the source application and inserts it into Oracle Order
Management interface tables. The programming languages and tools used in the load
function are highly dependent on the hardware and system software of the source
application.
For example, if you are passing data between an Oracle based source application and an
Oracle destination application, you would likely use a tool such as Pro*C or PL/SQL
since these tools work in both environments. If you are bringing data from a non-Oracle
based application into a product interface table, you would likely use a procedural
language available on the source application to select the data and convert it into an
ASCII file. Then you could use SQL*Loader to insert that file into the destination
product's interface table.
For outbound interfaces, the load function is the SQL that creates the database view.
Validate Function
The validate function is the set of programs that Oracle Applications destination
products use to ensure the integrity of inbound data. In the source application, you can
typically validate data upon entry using techniques such as forms triggers, not null
columns, data types, and so on. However, since Oracle Applications products may not
be the source of this data, validation programs ensure data integrity.
In addition, the validate function can derive additional columns based on the required
columns and foreign key relationships with data elsewhere in the Oracle destination
application.
The validation programs check the interface table for rows requiring validation, and the
programs validate and update each row indicating whether validation is complete or if
errors were found. If errors were found, validation programs need to write errors to the
error table of the destination application.
When the source application is a product in the e-Business Suite, the destination
application should provide the validate function.
Process Function
The process function is a set of programs that processes the data from the interface table

into the Oracle destination product. The specific processing performed varies by
application. For open transaction interfaces, the processing generally includes recording
the transaction history, updating the inventory and order balances, and charging for
costs.
Interfaces typically let you control both the frequency and the number of validated rows
that the processing programs attempt to process. Upon successful completion of
processing, the process function should delete the processed row from the interface
table.
Occasionally, the process function may need to insert rows into the errors table.
application should provide the process function.
Maintain Function
The maintain function is generally accomplished from a window within an Oracle
application. Most of these windows allow you to query, update, and resubmit interface
records that have failed validation. In general you can use these windows to query
unprocessed or unvalidated rows to check their current status.
When the maintain function is not called explicitly, you can use SQL*Plus to query and
update the interface table rows that are in error.
application should provide the maintain function.
2
Oracle Advanced Pricing Open Interfaces
and APIs

• Key of Short Names
• Agreements Public Application Program Interface
• Attribute Mapping Application Program Interface
• Business Object for Modifier Setup Application Program Interface
• Business Object for Pricing Formulas Application Program Interface
• Business Object for Pricing Limits Application Program Interface
• Create Publish Price Book Application Program Interface
• Get Currency Application Program Interface
• Get Custom Price Application Program Interface
• Get Price Book Application Program Interface
• Get Price List Application Program Interface
• Multi-Currency Conversion Setup Application Program Interface
• Price List Setup Application Program Interface
• Price List Setup Group Application Program Interface
• Price Request Application Program Interface
• Pricing Data Bulk Loader API
• Pricing Object Security - Check Function API
• Pricing Attributes Application Program Interface
• Attribute Mapping Application Program Interface
• Qualifiers Application Program Interface
Oracle Advanced Pricing Open Interfaces and APIs 2-1

• Reverse Limits Application Program Interface
• Round Price Application Program Interface
• Validate Price List with Currency Code Application Program Interface
Key of Short Names

A key of the short names and definitions used in the API tables are provided in the
following table:
Key of Short Names
Short name Definition
Drv Derived
Req Required
• Yes: This is a required parameter.
• No: This is an optional parameter.
N/A (no entry) No value/not applicable
Agreements Public Application Program Interface

This section explains how to use the Agreements Public API and how it functions in
Oracle Advanced Pricing. The Agreements Public package consists of entities to
support creating and maintaining agreements.
Functional Overview
Process_Agreement processes inserts, updates, and deletes records related to
agreements.
Setting Up and Using Parameter Descriptions

The following tables describe all parameters used by the public Agreements Public API.
All of the inbound and outbound parameters are listed. Additional information on
these parameters follows.
PROCESS_AGREEMENT
The following table shows the parameters for this structure.
PROCESS_AGREEMENT Parameters
Parameter Usage Type Req Drv
p_api_version_n IN Number No No
umber
p_init_msg_list IN Varchar2 No No
p_return_values IN Varchar2 No No
p_commit IN Varchar2 No No
x_return_status OUT Varchar2 No No
x_msg_count OUT Number No No
x_msg_data OUT Varchar2 No No
p_Agreement_re IN Agreement_Rec_ No No
c Type
p_Agreement_va IN Agreement_Val_ No No
lue_rec Rec_Type
p_Price_LHeade IN QP_Price_List_P No No
r_rec UB.Price_List_Re
c_Type
p_Price_LHeade IN QP_Price_List_P No No
r_val_rec UB.Price_List_V
al_Rec_Type
p_Price_LLine_t IN QP_Price_List_P No No
bl UB.Price_List_Li
ne_Tbl_Type
p_Price_LLine_v IN QP_Price_List_P No No
al_tbl UB.Price_List_V
al_Tbl_Type

p_Pricing_Attr_t IN QP_Price_List_P No No
bl UB.Pricing_Attr_
Tbl_Type
p_Pricing_Attr_v IN QP_Price_List_P No No
al_tbl UB.Pricing_Attr_
Val_Tbl_Type
x_Agreement_re OUT Agreement_Rec_ No No

c Type
x_Agreement_va OUT Agreement_Val_ No No

l_rec Rec_Type
x_Price_LHeader OUT QP_Price_List_P No No

_rec UB.Price_List_Re
c_Type
x_Price_LHeader OUT QP_Price_List_P No No

_val_rec UB.Price_List_V
al_Rec_Type
x_Price_LLine_t OUT QP_Price_List_P No No

bl UB.Price_List_Li
ne_Tbl_Type
x_Price_LLine_v OUT QP_Price_List_P No No

al_tbl UB.Price_List_Li
ne_Val_Tbl_Typ
e
x_Pricing_Attr_t OUT QP_Price_List_P No No

bl UB.Pricing_Attr_
Tbl_Type
x_Pricing_Attr_v OUT QP_Price_List_P No No

al_tbl UB.Pricing_Attr_
Val_Tbl_Type
AGREEMENT_REC_TYPE
REC_TYPE
accounting_rule_ Null Number No No

id
agreement_conta Null Number No No

ct_id
agreement_id Null Number Yes1 No
agreement_num Null Varchar2(50) No No
agreement_sourc Null Varchar2(30) No No

e_code
agreement_type_ Null Varchar2(30) No No

code
attribute1 Null Varchar2(150) No No

comments Null Varchar2(30) No No
context Null Varchar2(30) No No
created_by Null Number Yes No
creation_date Null Date Yes No
sold_to_org_id Null Number No No
end_date_active Null Date No No
freight_terms_co Null Varchar2(30) No No

de
invoice_contact_i Null Number No No

d
invoice_to_org_i Null Number No No

d
invoicing_rule_i Null Number No No

d
last_updated_by Null Number Yes No
last_update_date Null Date Yes No
last_update_logi Null Number No No

n
name Null Varchar2(30) Yes No
orig_system_agr Null Number No No

_id
override_arule_fl Null Varchar2(1) Yes No

ag
override_irule_fl Null Varchar2(1) Yes No

ag
price_list_id Null Number Yes2 No
pricing_contract Null Number No No

_id
purchase_order_ Null Varchar2(50) No No

num
revision Null Varchar2(50) Yes No
revision_date Null Date Yes No
revision_reason_ Null Varchar2(30) No No

code
salesrep_id Null Number No No
ship_method_co Null Varchar2(30) No No

de
signature_date Null Date No No
start_date_active Null Date No No
term_id Null Number Yes No
return_status Null Varchar2(1) No No
db_flag Null Varchar2(1) No No
operation Null Varchar2(30) Yes No

tp_attribute1 Null Varchar2(240) No No
tp_attribute_cate Null Varchar2(30) No No

gory
orig_system_agr_id
The following table describes notations listed in the preceding table:
Notations
Note Description
1 For update and delete
2 If you are not passing a price list record
AGREEMENT_TBL_TYPE
AGREEMENT_TBL_TYPE Parameters
Agreement_Rec_ Null Record No No

Type
AGREEMENT_VAL_REC_TYPE
AGREEMENT_VAL_REC_TYPE Parameters
accounting_rule Null Varchar2(240) Null Null
agreement_conta Null Varchar2(240) Null Null

ct
agreement Null Varchar2(240) Null Null
agreement_type Null Varchar2(240) Null Null
customer Null Varchar2(240) Null Null
freight_terms Null Varchar2(240) Null Null
invoice_contact Null Varchar2(240) Null Null

invoice_to_site_ Null Varchar2(240) Null Null

use
invoicing_rule Null Varchar2(240) Null Null
override_arule Null Varchar2(240) Null Null
override_irule Null Varchar2(240) Null Null
price_list Null Varchar2(240) Null Null
revision_reason Null Varchar2(240) Null Null
salesrep Null Varchar2(240) Null Null
ship_method Null Varchar2(240) Null Null
term Null Varchar2(240) Null Null
AGREEMENT_VAL_TBL_TYPE
AGREEMENT_VAL_TBL_TYPE Parameters
Agreement_Val_ Null Record No No

Rec_Type
PRICE_LIST_REC_TYPE
PRICE_LIST_REC_TYPE Parameters
attribute1 Null Varchar2 No No
automatic_flag Null Varchar2 No No
comments Null Varchar2 No No
context Null Varchar2 No No
created_by Null Number No No
creation_date Null Date No No
currency_code Null Varchar2 Yes No

discount_lines_fl Null Varchar2 No No

ag
end_active_date Null Date No No
freight_terms_co Null Varchar2 No No

de
gsa_indicator Null Varchar2 No No
last_updated_by Null Number No No
last_update_date Null Date No No

n
list_header_id Null Number No No
list_type_code Null Varchar2 No No
program_applica Null Number No No

tion_id
program_id Null Number No No
program_update Null Date No No

_date
prorate_flag Null Varchar2 No No
request_id Null Number No No
rounding_factor Null Number No No
ship_method_co Null Varchar2 No No

de
terms_id Null Number No No
return_status Null Varchar2 No No
db_flag Null Varchar2 No No
operation Null Varchar2 Yes No
name Null Varchar2 Yes No
description Null Varchar2 No No
version_no Null Varchar2 No No
active_flag Null Varchar2 No No
mobile_downloa Null Varchar2 No No

d
currency_header Null Number No No

_id
pte_code Null Varchar2 No Yes
list_source_code Null Varchar2 No No
orig_system_hea Null Varchar2 No No

der_ref
global_flag Null Varchar2 No No
org_id Null Number No Yes
Note: This API will initialize MOAC if it is not initialized prior. On the
price_list_rec, if the global_flag is passed as FND_API.G_MISS_CHAR,
the API will default the global_flag as Y. If global_flag is passed as N
and if org_id is not null, the API will create the modifier list for that
operating unit (OU). If global_flag is passed as "N" and if org_id is not
passed, the API will derive the org_id from the org context if set; if not
set, use the default OU for that responsibility. The API validates the
Org_id to verify if the Org_Id corresponds to one of the OUs for that
responsibility and raises an error if the org_id is not valid.

PRICE_LIST_TBL_TYPE
PRICE_LIST_TBL_TYPE Parameters
Price_List_Rec_T Null Record No No

ype
PRICE_LIST_VAL_REC_TYPE
PRICE_LIST_VAL_REC_TYPE Parameters
automatic Null Varchar2 No No
currency Null Varchar2 No No
discount_lines Null Varchar2 No No
freight_terms Null Varchar2 No No
list_header Null Varchar2 No No
list_type Null Varchar2 No No
prorate Null Varchar2 No No
ship_method Null Varchar2 No No
terms Null Varchar2 No No
currency_header Null Varchar2 No No
pte Null Varchar2 No No
PRICE_LIST_VAL_TBL_TYPE
PRICE_LIST_VAL_TBL_TYPE Parameters
Price_List_Val_R Null Record No No

ec_Type
PRICE_LIST_LINE_REC_TYPE
The following table shows the parameters for this structure:
PRICE_LIST_LINE_REC_TYPE Parameters
accrual_qty Null Number No No
accrual_uom_co Null Varchar2 No No

de
arithmetic_opera Null Varchar2 No No

tor

base_qty Null Number No No
base_uom_code Null Varchar2 No No
effective_period_ Null Varchar2 No No

uom
estim_accrual_ra Null Number No No

te
generate_using_f Null Number No No

ormula_id
inventory_item_i Null Number No No

d

n
list_line_id Null Number No No
list_line_type_co Null Varchar2 No No

de
list_price Null Number No No
modifier_level_c Null Varchar2 No No

ode
number_effectiv Null Number No No

e_periods
operand Null Number No No
organization_id Null Number No No
override_flag Null Varchar2 No No
percent_price Null Number No No
price_break_type Null Varchar2 No No

_code
price_by_formul Null Number No No

a_id
primary_uom_fl Null Varchar2 No No

ag
print_on_invoice Null Varchar2 No No

_flag


tion_id

_date
rebate_trxn_type Null Varchar2 No No

_code
related_item_id Null Number No No
relationship_typ Null Number No No

e_id
reprice_flag Null Varchar2 No No
revision Null Varchar2 No No
revision_date Null Date No No
revision_reason_ Null Varchar2 No No

code
substitution_attri Null Varchar2 No No

bute
substitution_con Null Varchar2 No No

text
substitution_val Null Varchar2 No No

ue
db_flag Null' Varchar2 No No
operation Null Varchar2 No No
from_rltd_modif Null Number No No

ier_id
rltd_modifier_gr Null Number No No

oup_no
rltd_modifier_gr Null Varchar2 No No

p_type
product_precede Null Number No No

nce
Customer_Item_ Null Number Yes No

Id
price_break_hea Null Number No No

der_index
list_line_no Null Number No Yes
qualification_ind Null Number No Yes
PRICE_LIST_LINE_TBL_TYPE
PRICE_LIST_LINE_TBL_TYPE Parameters
Price_List_Line_ Null Record No No

Rec_Type
PRICE_LIST_LINE_VAL_REC_TYPE

PRICE_LIST_LINE_VAL_REC_TYPE Parameters
accrual_uom Null Varchar2 No No
base_uom Null Varchar2 No No
generate_using_f Null Varchar2 No No

ormula
inventory_item Null Varchar2 No No
list_line Null Varchar2 No No
list_line_type Null Varchar2 No No
modifier_level Null Varchar2 No No
organization Null Varchar2 No No
override Null Varchar2 No No
price_by_formul Null Varchar2 No No

a
primary_uom Null Varchar2 No No
rebate_transactio Null Varchar2 No No

n_type
related_item Null Varchar2 No Null
relationship_typ Null Varchar2 No Null

e
reprice Null Varchar2 No Null
revision_reason Null Varchar2 No Null

Val_Rec_Type
PRICING_ATTR_REC_TYPE
PRICING_ATTR_REC_TYPE Parameters
accumulate_flag Null Varchar2 No No

attribute_groupi Null Number No No

ng_number
excluder_flag Null Varchar2 No No

n
pricing_attribute Null Varchar2 No No

_context
pricig_attribute_ Null Number No No

id
pricing_attr_valu Null Varchar2 No No

e_from

e_to
product_attribut Null Varchar2 Yes No

e

e_context
product_attr_val Null Varchar2 Yes No

ue
product_uom_co Null Varchar2 Yes No

de

tion_id

_date
pricing_attr_valu Null Number No Yes

e_from_number
pricing_attr_valu Null Number No Yes

e_to_number
qualification_ind Null Number No Yes

PRICE_LIST_LI Null Number No No

NE_index

ier_id
comparison_ope Null Varchar2 Yes No

rator_code
product_attribut Null Varchar2 No Yes

e_datatype
pricing_attrubut Null Varchar2 No Yes

e_datatype
list_header_id Null Number No Yes
pricing_phase_id Null Number No Yes
PRICING_ATTR_TBL_TYPE
PRICING_ATTR_TBL_TYPE Parameters
Pricing_Attr_Rec Null Record No No

_Type
PRICING_ATTR_VAL_REC_TYPE
PRICING_ATTR_VAL_REC_TYPE Parameters
accumulate Null Varchar2 No No
excluder Null Varchar2 No No
product_uom Null Varchar2 No No

_desc

e_from_desc

e_to_desc
Pricing_Attr_Val Null Record No No

_Rec_Type
Note: This API will initialize MOAC if it has not been initialized prior.
For more information, see the Oracle Multi-Organization Reference
Manual.

Validation of Agreements Public API
Standard Validation
Oracle Advanced Pricing validates all required columns in the Agreements Public API.
Other Validation
None
Error Handling
If any validation fails, the API will return error status to the calling module. The
Agreements Public API processes the rows and reports the values in the following table
for every record.
Error Handling
Condition PROCESS_STATUS ERROR_MESSAGE
Success 5 null
Failure 4 actual error message
Example of Agreements Public API

The following example scripts are located in the directory $qp/patch/115/sql:
• QPAGXMP1.sql: Insert an agreement and a price list header.
• QPAGXMP2.sql: Insert an agreement, a price list header, and lines.
• QPAGXMP3.sql: Create an agreement with a standard price list.
• QPAGXMP4.sql: Update an agreement which has a standard price list.
• QPAGXMP5.sql: Update agreement record and create agreement price list.
• QPAGXMP6.sql: Update an agreement record and update an agreement price list

header.
• QPAGXMP7.sql: Delete an agreement.
Attribute Mapping Application Program Interface

This section explains how to use the Attribute Mapping APIs and how it functions in
Oracle Advanced Pricing. Currently, in the new model, there are three Attribute
Mapping packages. They are :
• QP_ATTR_MAP_PUB
• QP_ATTRIBUTES_PUB
• QP_ATTR_MAPPING_PUB
Functional Overview
The Public package QP_ATTR_MAP_PUB is a Business Object API, based on the
following tables:
• QP_LOOKUPS (Type : QP_PTE_TYPE)
• QP_PTE_SOURCE_SYSTEMS
• QP_PTE_REQUEST_TYPES_B/TL
• QP_PTE_SEGMENTS
• QP_ATTRIBUTE_SOURCING
• QP_SOURCESYSTEM_FNAREA_MAP
The QP_ATTR_MAP_PUB model and its object name is Attr_Map and the relationship
of the tables is shown below. The package QP_ATTR_MAP_PUB contains the following
APIs and record type definitions:
Note: The API processes one record with each call. The calling
application must populate the global records that referenced in the
attribute mapping rules. The output of the API is a PL/SQL table with
each record having the context name, attribute name, and attribute
value.
• Pte_Val_Rec_Type
• Pte_Val_Rec_Type
• Rqt_Rec_Type
• Rqt_Tbl_Type
• Rqt_Val_Rec_Type
• Ssc_Rec_Type
• Ssc_Tbl_Type

• Ssc_Val_Rec_Type
• Psg_Rec_Type
• Psg_Val_Rec_Type
• Sou_Rec_Type
• Sou_Val_Rec_Type
• Fna_Rec_Type
• Fna_ValRec_Type
• PROCEDURE Process_Attr_Mapping
• PROCEDURE Lock_Attr_Mapping
• PROCEDURE Get_Attr_Mapping
Setting Up and Parameter Descriptions

The following chart describes all parameters used by the public Attribute Mapping API
QP_ATTR_MAP_PUB. All of the inbound and outbound parameters are listed.
Additional information on these parameters may follow.
Procedure PROCESS_ATTR_MAPPING
The following table shows the parameters for this structure. This API will add, update
or delete a Source System, Request type, PTE-Attribute link, Attribute Mapping rules
depending on the input parameter.
PROCESS_ATTR_MAPPING Parameters
p_api_version_n In Number Yes No

umber
p_init_msg_list In Varchar2 No No
p_return_values In Varchar2 No No
p_commit In Varchar2 No No
x_return_status Out Number No No
x_msg_count Out Varchar2 No No
x_msg_data Out Pte_Rec_Type No No
p_PTE_rec In Pte_Val_Rec_Ty No No
pe
p_PTE_val_rec In Pte_Val_Rec_Ty No No
pe
p_RQT_tbl In Rqt_Tbl_Type No No
p_RQT_val_tbl In Rqt_Val_Tbl_Ty No No
pe
p_SSC_tbl In Ssc_Tbl_Type No No
p_SSC_val_tbl In Ssc_Val_Tbl_Typ No No
e
p_PSG_tbl In Psg_Tbl_Type No No
p_PSG_val_tbl In Psg_Val_Tbl_Ty No No
pe
p_SOU_tbl In Sou_Tbl_Type No No
p_SOU_val_tbl In Sou_Val_Tbl_Ty No No
pe
p_FNA_tbl In Fna_Tbl_Type No No
p_FNA_val_tbl In Fna_Val_Tbl_Ty No No
pe
x_PTE_rec Out Pte_Rec_Type No No
x_PTE_val_rec Out Pte_Val_Rec_Ty No No

pe

x_RQT_tbl Out Rqt_Tbl_Type No No
x_RQT_val_tbl Out Rqt_Val_Tbl_Ty No No

pe
x_SSC_tbl Out Ssc_Tbl_Type No No
x_SSC_val_tbl Out Ssc_Val_Tbl_Typ No No

e
x_PSG_tbl Out Psg_Tbl_Type No No
x_PSG_val_tbl Out Psg_Val_Tbl_Ty No No

pe
x_SOU_tbl Out Sou_Tbl_Type No No
x_SOU_val_tbl Out Sou_Val_Tbl_Ty No No

pe
x_FNA_tbl Out Fna_Tbl_Type No No
x_FNA_val_tbl Out Fna_Val_Tbl_Ty No No

pe
p_api_version_number
This the version number of the API.
P_PTE_REC
P_PTE_REC Parameters
Description Null Varchar2 No No
Enabled_flag Null Varchar2 No No
End_date_active Null Date No No
Lookup_code Null Varchar2 No No
Lookup_type Null Varchar2 No No
meaning Null Varchar2 No No
Start_date_active Null Date No No
P_PTE_VAL_REC
P_PTE_VAL_REC Parameters
enabled Null Varchar2 No No
lookup Null Varchar2 No No
The following table shows the parameters for the tables and their structures.
Tables and Structures
Table Name Usage Type
P_RQT_TBL Null TABLE OF Rqt_Rec_Type
P_RQT_VAL_TBL Null TABLE OF Pte_Val_Rec_Type
P_SSC_TBL Null TABLE OF Ssc_Rec_Type
P_SSC_VAL_TBL Null TABLE OF Ssc_Val_Rec_Type
P_PSG_TBL Null TABLE OF Psg_Rec_Type

P_PSG_VAL_TBL Null TABLE OF

Psg_Val_Rec_Type
P_SOU_TBL Null TABLE OF Sou_Rec_Type
P_SOU_VAL_TBL Null TABLE OF

Sou_Val_Rec_Type
P_FNA_TBL Null TABLE OF Fna_Rec_Type
P_FNA_VAL_TBL Null TABLE OF

Fna_Val_Rec_Type
X_PTE_REC_TYPE
X_PTE_REC_TYPE Parameters
X_PTE_VAL_REC
X_PTE_VAL_REC Parameters
The following table shows the parameters for the following table structures (no
parameters are used for the following):
Table Parameters
Table Name Usage Type Req Drv
X_RQT_TBL Null TABLE OF No No

Rqt_Rec_Type
X_RQT_VAL_TB Null TABLE OF No No

L Pte_Val_Rec_Ty
pe
X_SSC_TBL Null TABLE OF No No

Ssc_Rec_Type
X_SSC_VAL_TB Null TABLE OF No No

L Ssc_Val_Rec_Ty
pe
X_PSG_TBL Null TABLE OF No No

Psg_Rec_Type
X_PSG_VAL_TB Null TABLE OF No No

L Psg_Val_Rec_Ty
pe
X_SOU_TBL Null TABLE OF No No

Sou_Rec_Type
X_SOU_VAL_TB Null TABLE OF No No

L Sou_Val_Rec_Ty
pe

Table Name Usage Type Req Drv
X_FNA_TBL Null TABLE OF No No

Fna_Rec_Type
X_FNA_VAL_TB Null TABLE OF No No

L Fna_Val_Rec_Ty
pe
P_RQT_REC
P_RQT_REC Parameters
enabled_flag Null Varchar2 No No
line_level_global Null Varchar2 No No

_struct
line_level_view_ Null Varchar2 No No

name
order_level_glob Null Varchar2 No No

al_struct
order_level_vie Null Varchar2 No No

w_name
pte_code Null Varchar2 No No
request_type_co Null Varchar2 No No

de
request_type_de Null Varchar2 No No

sc
row_id Null Varchar2 No No
P_RQT_VAL_REC
P_RQT_VAL_REC Parameters
request_type Null Varchar2 No No
row Null Varchar2 No No
P_SSC_REC
P_SSC_REC Parameters
application_shor Null Varchar2 No No

t_name
pte_source_syste Null Varchar2 No No

m_id
P_SSC_VAL_REC
P_SSC_VAL_REC Parameters


m
P_PSG_REC
P_PSG_REC Parameters
limits_enabled Null Varchar2 No No
lov_enabled Null Varchar2 No No
seeded_sourcing Null Varchar2 No No

_method
segment_id Null Number No No
segment_level Null Varchar2 No No
segment_pte_id Null Number No No
sourcing_enable Null Varchar2 No No

d
sourcing_status Null Varchar2 No No
user_sourcing_m Null Varchar2 No No

ethod
P_PSG_VAL_REC
P_PSG_VAL_REC Parameters
segment Null Varchar2 No No
segment_pte Null Varchar2 No No
P_SOU_REC
P_SOU_REC Parameters
attribute_sourcin Null Number No No

g_id
attribute_sourcin Null Varchar2 No No

g_level
application_id Null Number No No
request_type_co Null Varchar2 No No

de
seeded_flag Null Varchar2 No No
seeded_sourcing Null Varchar2 No No

_type
seeded_value_str Null Varchar2 No No

ing
segment_id Null Number No No

user_sourcing_ty Null Varchar2 No No

pe
user_value_strin Null Varchar2 No No

g
PSG_index Null Number No No
P_SOU_VAL_REC
P_SOU_VAL_REC Parameters
attribute_sourcin Null Varchar2 No No

g
request_type Null Varchar2 No No
seeded Null Varchar2 No No
segment Null Varchar2 No No
P_FNA_REC
P_FNA_REC Parameters
functional_area_i Null Number No No

d
pte_sourcesyste Null Number No No

m_fnarea_id
pte_source_syste Null Number No No

m_id
seeded_flag Null Varchar2 No No
SSC_index Null Number No No
P_FNA_VAL_REC
P_FNA_VAL_REC Parameters
functional_area Null Varchar2 No No
pte_sourcesyste Null Varchar2 No No

m_fnarea

m
seeded Null Varchar2 No No
Procedure LOCK_ATTR_MAPPING
The following table shows the parameters for this structure. User can use this API to
lock PTE-Attribute link and all its Attribute Mapping rules from getting updated by a
different user concurrently.

LOCK_ATTR_MAPPING Parameters

umber
x_msg_data Out Pte_Rec_Type No No
p_PTE_rec In Pte_Val_Rec_Ty No No
pe
p_PTE_val_rec In Pte_Val_Rec_Ty No No
pe
p_RQT_tbl In Rqt_Tbl_Type No No
p_RQT_val_tbl In Rqt_Val_Tbl_Ty No No
pe
p_SSC_tbl In Ssc_Tbl_Type No No
p_SSC_val_tbl In Ssc_Val_Tbl_Typ No No
e
p_PSG_tbl In Psg_Tbl_Type No No
p_PSG_val_tbl In Psg_Val_Tbl_Ty No No
pe
p_SOU_tbl In Sou_Tbl_Type No No
p_SOU_val_tbl In Sou_Val_Tbl_Ty No No
pe
p_FNA_tbl In Fna_Tbl_Type No No
p_FNA_val_tbl In Fna_Val_Tbl_Ty No No
pe
x_PTE_rec Out Pte_Rec_Type No No
x_PTE_val_rec Out Pte_Val_Rec_Ty No No

pe
x_RQT_tbl Out Rqt_Tbl_Type No No
x_RQT_val_tbl Out Rqt_Val_Tbl_Ty No No

pe
x_SSC_tbl Out Ssc_Tbl_Type No No
x_SSC_val_tbl Out Ssc_Val_Tbl_Typ No No

e
x_PSG_tbl Out Psg_Tbl_Type No No
x_PSG_val_tbl Out Psg_Val_Tbl_Ty No No

pe
x_SOU_tbl Out Sou_Tbl_Type No No
x_SOU_val_tbl Out Sou_Val_Tbl_Ty No No

pe
x_FNA_tbl Out Fna_Tbl_Type No No
x_FNA_val_tbl Out Fna_Val_Tbl_Ty No No

pe
P_PTE_REC_TYPE

P_PTE_REC_TYPE Parameters
P_PTE_VAL_REC
P_PTE_VAL_REC Parameters
The following table shows the parameters for the following table structures:
Table Structure Parameters
P_RQT_TBL Null TABLE OF Rqt_Rec_Type
P_RQT_VAL_TBL Null TABLE OF

Rqt_Val_Rec_Type
P_PSG_TBL Null TABLE OF Psg_Rec_Type
P_PSG_VAL_TBL Null TABLE OF

Psg_Val_Rec_Type
P_SOU_TBL Null TABLE OF Sou_Rec_Type
P_SOU_VAL_TBL Null TABLE OF

Sou_Val_Rec_Type
P_FNA_VAL_TBL Null TABLE OF

Fna_Val_Rec_Type
X_PTE_REC_TYPE

X_PTE_VAL_REC
X_RQT_TBL Null TABLE OF Rqt_Rec_Type
X_RQT_VAL_TBL Null TABLE OF Rqt_Val_Rec_Type
X_PSG_TBL Null TABLE OF Psg_Rec_Type
X_PSG_VAL_TBL Null TABLE OF Psg_Val_Rec_Type
X_SOU_TBL Null TABLE OF Sou_Val_Rec_Type
X_SOU_VAL_TBL Null TABLE OF Sou_Val_Type
P_FNA_VAL_TBL Null TABLE OF Fna_Val_Rec_Type
Procedure GET_ATTR_MAPPING
The following table shows the parameters for this structure. This API will fetch the
records for an Source System, Request Type, PTE_Attribute link, Attribute Mapping
rules given the input parameter.
GET_ATTR_MAPPING Parameters
Parameter Usa Type Req Drv

ge

umber
x_msg_data Out Pte_Rec_Ty No No

pe
p_lookup_code In Varchar2 No No
p_lookup In Varchar2 No No
x_PTE_rec Out Pte_Rec_Ty No No

pe
x_PTE_val_rec Out Pte_Val_Re No No

c_Type
x_RQT_tbl Out Rqt_Tbl_Ty No No

pe
x_RQT_val_tbl Out Rqt_Val_Tb No No

l_Type
x_SSC_tbl Out Ssc_Tbl_Ty No No

pe
x_SSC_val_tbl Out Ssc_Val_Tb No No

l_Type

Parameter Usa Type Req Drv
ge
x_PSG_tbl Out Psg_Tbl_Ty No No

pe
x_PSG_val_tbl Out Psg_Val_T No No

bl_Type
x_SOU_tbl Out Sou_Tbl_T No No

ype
x_SOU_val_tbl Out Sou_Val_T No No

bl_Type
x_FNA_tbl Out Fna_Tbl_T No No

ype
x_FNA_val_tbl Out Fna_Val_T No No

bl_Type
p_lookup_code
This is the code for the Pricing Transaction Entity; for example, ORDFUL for Order
Fulfillment, DEMAND for Demand Planning etc.
p_lookup
This is the type of the Pricing Lookups. For Pricing Transaction Entities, it is
QP_PTE_TYPE.
X_PTE_REC_TYPE
X_PTE_VAL_REC
X_RQT_TBL Null TABLE OF Rqt_Rec_Type
X_RQT_VAL_TBL Null TABLE OF Rqt_Val_Rec_Type
X_SSC_TBL Null TABLE OF Ssc_Rec_Type
X_SSC_VAL_TBL Null TABLE OF Ssc_Val_Rec_Type
X_PSG_TBL Null TABLE OF Psg_Rec_Type

X_PSG_VAL_TBL Null TABLE OF Psg_Val_Rec_Type
X_SOU_TBL Null TABLE OF Sou_Rec_Type
X_SOU_VAL_TBL Null TABLE OF Sou_Val_Rec_Type
X_FNA_TBL Null TABLE OF Fna_rec_type
X_FNA_VAL_TBL Null TABLE OF Fna_Val_Rec_type
Business Object for Modifier Setup Application Program Interface

This section explains how to use the Business Object for Modifier Setup API and how it
functions in Oracle Advanced Pricing. The Business Object for Modifier Setup package
consists of entities to set up modifiers.
Functional Overview
The package QP_Modifiers_PUB.Process Modifiers contains the following public record
type and table of records entities:
• Process_Modifiers: QP_Modifiers_PUB.Process_Modifiers is a Public API. It takes
two record types and six table types as input parameters. Use this API to insert,
update and delete modifiers or to set up a modifier list header for a given
p_MODIFIER_ LIST_rec record structure.
You can:
• Set up multiple modifier lines by giving multiple modifier definitions in the p_
MODIFIERS_tbl table structure.
• Attach multiple qualifiers either at the header level (modifier list) or at the line level
(modifier) by giving multiple qualifiers in the p_QUALIFIERS_tbl table structure.
• Attach multiple pricing attributes to modifier lines by giving the pricing attributes
in the p_PRICING_ATTR_tbl table structure.
• Modifier_List_Rec_Type: Corresponds to the columns in the modifier header tables

QP_LIST_HEADERS_B and QP_LIST_HEADERS_TL.
• Modifier_List_Tbl_Type
• Modifier_List_Val_Rec_Type: Corresponds to the columns in the modifier header
table QP_LIST_HEADERS_B.
• Modifier_List_Val_Tbl_Type
• Modifiers_Rec_Type: Corresponds to the columns in the modifier and related

modifiers tables QP_LIST_LINES and QP_RLTD_MODIFIERS.
• Modifiers_Tbl_Type
• Modifiers_Val_Rec_Type: Corresponds to the columns in the modifier table

QP_LIST_ LINES.
• Modifiers_Val_Tbl_Type
• Qualifiers_Rec_Type: Corresponds to the columns in the qualifier table QP_

QUALIFIERS.
• Qualifiers_Tbl_Type
• Qualifiers_Val_Rec_Type: Corresponds to the columns in the qualifier table QP_

QUALIFIERS.
• Qualifiers_Val_Tbl_Type
• Pricing_Attr_Rec_Type: Corresponds to the columns in the pricing attributes table

QP_ PRICING_ATTRIBUTES.
• Pricing_Attr_Tbl_Type
• Pricing_Attr_Val_Rec_Type: Corresponds to the columns in the pricing attributes

table QP_PRICING_ATTRIBUTES.
• Pricing_Attr_Val_Tbl_Type
• Currently, the QP_Modifiers_PUB.Process_Modifiers API does not

evaluate or validate the required default attributes when a GSA
price list is created. When you create a GSA price list using the
QP_Modifiers_PUB.Process_Modifiers API, you need to initialize
the modifier list line attributes in synchronization with the GSA
Price List window.
• Updating Modifier Records using

QP_GLOBALS.G_OPR_UPDATE: If you get the error message
"PL/SQL: Function returned without value in Package" when using
the API QP_GLOBALS.G_OPR_UPDATE to update the modifier

records, then use the header id/line id of the modifier to be updated
rather than the modifier name.

The following chart describes all parameters used by the public Business Object for
Modifier Setup. All of the inbound and outbound parameters are listed. Additional
information on these parameters may follow.
Important: Date and DateTime fields
Dates and date times are stored in the following default canonical
formats--use these formats to pass any Dates or Datetime fields to the
API:
• Date: YYYY/MM/DD
• DateTime: YYYY/MM/DD HH:MM:SS
These formats should also be used for pricing and qualifier attribute
values with the datatype of Date or DateTimes.
PROCESS_MODIFIERS
PROCESS_MODIFIERS Parameters
p_api_version_n In Number No No
umber
x_return_status Out Varchar2 No No
x_msg_data Out Varchar2 No No
p_MODIFIER_LI In Modifier_List_ No No
ST_rec Rec_Type
p_MODIFIER_LI In Modifier_List_ No No
ST_val_ rec Val_Rec_Type
p_MODIFIERS_t In Modifiers_Tbl_ No No
bl Type
p_MODIFIERS_ In Modifiers_Val_ No No
val_tbl Tbl_Type
p_QUALIFIERS_ In Qualifiers_Tbl_ No No
tbl Type
p_QUALIFIERS_ In Qualifiers_Val_ No No
val_tbl Tbl_Type
p_PRICING_AT In Pricing_Attr_ No No
TR_tbl Tbl_Type
p_PRICING_AT In Pricing_Attr_Val No No
TR_val_tbl _ Tbl_Type
x_MODIFIER_LI Out Modifier_List_ No No

ST_rec Rec_Type
x_MODIFIER_LI Out Modifier_List_ No No

ST_val_ rec Val_Rec_Type
x_MODIFIERS_t Out Modifiers_Tbl_ No No

bl Type
x_MODIFIERS_v Out Modifiers_Val_ No No

al_tbl Tbl_Type
x_QUALIFIERS_ Out Qualifiers_Tbl_ No No

tbl Type

x_QUALIFIERS_ Out Qualifiers_Val_ No No

val_tbl Tbl_Type
x_PRICING_AT Out Pricing_Attr_ No No

TR_tbl Tbl_Type
x_PRICING_AT Out Pricing_Attr_Val No No

TR_val_tbl _ Tbl_Type
p_init_sg_list
Default Value: FND_API.G_FALSE
p_return_values
p_commit
p_MODIFIER_LIST_rec
Default Value: G_MISS_MODIFIER_LIST_REC
p_MODIFIER_LIST_val_rec
Default Value: G_MISS_MODIFIER_LIST_VAL_REC
p_MODIFIERS_tbl
Default Value: G_MISS_MODIFIERS_TBL
p_MODIFIERS_val_tbl
Default Value: G_MISS_MODIFIERS_VAL_TBL
p_QUALIFIERS_tbl
Default Value: G_MISS_QUALIFIERS_TBL
p_QUALIFIERS_val_tbl
Default Value: G_MISS_QUALIFIERS_VAL_TBL
p_PRICING_ATTR_tbl
Default Value: G_MISS_PRICING_ATTR_TBL
p_PRICING_ATTR_val_tbl
Default Value: G_MISS_PRICING_ATTR_VAL_TBL
MODIFIER_LIST_REC_TYPE
Note: For the structure MODIFIER_LIST_REC_TYPE, the ask_for_flag
is only populated for modifier lists of type Promotion and Deal. This is
not supported for Discount List, Surcharge List, or Freight and Special
Charges modifier lists.
MODIFIER_LIST_REC_TYPE Parameters
automatic_flag Null Varchar2 Yes No


ag
end_date_active Null Date Yes No

de

n
list_type_code Null Varchar2 Yes No

tion_id

_date

de
source_system_c Null Varchar2 Yes No

ode
active_flag Null Varchar2 Yes No
parent_list_head Null Number No No

er_id

_first

_first
active_date_first Null Varchar2 No No

_type

_second

_second
active_date_seco Null Varchar2 No No

nd_type
ask_for_flag Null Varchar2 No No

version_no Null Varchar2 Yes No
pte_code Null Varchar2 Yes No
description Null Varchar2 Yes No
List_Source_cod Null Varchar2 Yes No

e
Orig_System_He Null Varchar2 Yes No

ader_Ref
Shareable_flag Null Varchar2 Yes No
Global_flag Null Varchar2 No No
Org_id Null Number No Yes
attribute1-15
Default Value: FND_API.G_MISS_CHAR
automatic_flag
comments
context
created_by
Default Value: FND_API.G_MISS_NUM
creation_date
Default Value: FND_API.G_MISS_DATE
currency_code
discount_lines_flag
end_date_active
freight_terms_code
gsa_indicator
last_updated_by
last_update_date
last_update_login
list_header_id
list_type_code
program_application_id
program_id
program_update_date
prorate_flag
request_id
rounding_factor

ship_method_code
start_date_active
terms_id
source_system_code
active_flag
parent_list_header_id
start_date_active_first
end_date_active_first
active_date_first_type
start_date_active_second
end_date_active_second
active_date_second_type
ask_for_flag
return_status
db_flag
operation
name
description
List_Source_code
Orig_System_Header_Ref
Shareable_flag
Global_flag
Default Value: Y
Org_Id
modifier_list_rec, if the global_flag is passed as
FND_API.G_MISS_CHAR, the API will default the global_flag as 'Y'. If
global_flag is passed as 'N' and if org_id is not null, the API will create
the modifier list for that operating unit (OU). If global_flag is passed as
"N" and if org_id is not passed, the API will derive the org_id from the
org context if set; if not, use the default OU for that responsibility. The
API will validate the Org_id to check if the Org_Id corresponds to one
of the OUs for that responsibility and raise an error if org_id is not
valid.
MODIFIER_LIST_TBL_TYPE
MODIFIER_LIST_TBL_TYPE Parameters
Modifier_List_R Null Record No No

ec_Type

e

MODIFIER_LIST_VAL_REC_TYPE
MODIFIER_LIST_VAL_REC_TYPE Parameters

e
automatic
currency
discount_lines
freight_terms
list_header
list_type
prorate
ship_method
terms
List_Source_code
MODIFIER_LIST_VAL_TBL_TYPE
MODIFIER_LIST_VAL_TBL_TYPE Parameters
Modifier_List_V Null Record No No

al_Rec_ Type
MODIFIERS_REC_TYPE
MODIFIERS_REC_TYPE Parameters

tor

automatic_flag Null Varchar2 Yes No

uom
end_date_active Null Date Yes No

te

ormula_id

d

n
list_line_type_co Null Varchar2 Yes No

de
modifier_level_c Null Varchar2 Yes No

ode

e_periods
price_break_type Null Varchar2 Yes No

_code

a_id


_flag

tion_id

_date

_code

e_id

code
start_date_active Null Date Yes No

bute

text

ue
accrual_flag Null Varchar2 Yes No
pricing_group_s Null Number Yes No

equence
incompatibility_ Null Varchar2 No No

grp_code
list_line_no Null Varchar2 No No

ier_id
to_rltd_modifier Null Number No No

_id

p_no
rltd_modifier_gr Null Varchar2 No No

p_type
pricing_phase_id Null Number Yes No
product_precede Null Number Yes No

nce
expiration_perio Null Date No No

d_start_ date
number_expirati Null Number No No

on_periods
expiration_perio Null Varchar2 No No

d_uom
expiration_date Null Date No No
estim_gl_value Null Number No No
benefit_price_list Null Number No No

_line_id

benefit_limit Null Number No No
charge_type_cod Null Varchar2 No No

e
charge_subtype_ Null Varchar2 No No

code
benefit_qty Null Number No No
benefit_uom_co Null Varchar2 No No

de
accrual_conversi Null Number No No

on_rate
proration_type_c Null Varchar2 No No

ode
arithmetic_operator
attribute1-15
automatic_flag
comments
context
created_by
creation_date
effective_period_uom
end_date_active
estim_accrual_rate
generate_using_formula_id
inventory_item_id
last_updated_by
last_update_date
last_update_login
list_header_id
list_line_id
list_line_type_code
list_price
modifier_level_code
number_effective_periods
operand

organization_id
override_flag
percent_price
price_break_type_code
price_by_formula_id
primary_uom_flag
print_on_invoice_flag
program_id
program_update_date
rebate_trxn_type_code
related_item_id
relationship_type_id
reprice_flag
request_id
revision
revision_date
revision_reason_code
start_date_active
substitution_attribute
substitution_context
substitution_value
accrual_flag
pricing_group_sequence
incompatibility_grp_code
list_line_no
from_rltd_modifier_id
to_rltd_modifier_id
rltd_modifier_grp_no
rltd_modifier_grp_type
pricing_phase_id
product_precedence

expiration_period_start_date
number_expiration_periods
expiration_period_uom
expiration_date
estim_gl_value
benefit_price_list_line_id
benefit_limit
charge_type_code
charge_subtype_code
benefit_qty
benefit_uom_code
accrual_conversion_rate
proration_type_code
return_status
db_flag
operation
MODIFIERS_TBL_TYPE
MODIFIERS_TBL_TYPE Parameters
Modifiers_Rec_T Null Record No No

ype
MODIFIERS_VAL_REC_TYPE
MODIFIERS_VAL_REC_TYPE Parameters
accrual_type Null Varchar2 No No

ormula
gl_class Null Varchar2 No No
list_price_uom Null Varchar2 No No


a
rebate_subtype Null Varchar2 No No

n_type
related_item Null Varchar2 No No
relationship_typ Null Varchar2 No No

e
reprice Null Varchar2 No No
revision_reason Null Varchar2 No No
accrual_type
accrual_uom
automatic
generate_using_formula
gl_class
inventory_item
list_header
list_line
list_line_type
list_price_uom
modifier_level
organization
override
price_break_type
price_by_formula
primary_uom
print_on_invoice
rebate_subtype
rebate_transaction_type
related_item
relationship_type
reprice

revision_reason
MODIFIERS_VAL_TBL_TYPE
MODIFIERS_VAL_TBL_TYPE Parameters
Modifiers_Val_R Null Record No No

ec_Type
QUALIFIERS_REC_TYPE
QUALIFIERS_REC_TYPE Parameters

rator_code
created_from_ru Null Number No No

le_id

n

tion_id


_date
qualifier_attribut Null Varchar2 Yes No

e
qualifier_attr_val Null Varchar2 Yes No

ue
qualifier_context Null Varchar2 Yes No
qualifier_groupi Null Number Yes No

ng_no
qualifier_preced Null Number Yes No

ence
qualifier_id Null Number No No
qualifier_rule_id Null Number No No
start_date_active Null Date Yes No
attribute1-15
comparison_operator_code
context
created_by
created_from_rule_id
creation_date
end_date_active
excluder_flag
last_updated_by
last_update_date
last_update_login
list_header_id
list_line_id
program_id
program_update_date
qualifier_attribute
qualifier_attr_value
qualifier_context
qualifier_grouping_no

qualifier_id
qualifier_rule_id
request_id
start_date_active
return_status
db_flag
operation
QUALIFIERS_TBL_TYPE
QUALIFIERS_TBL_TYPE Parameters
Qualifiers_Rec_T Null Record No No

ype
QUALIFIERS_VAL_REC_TYPE
QUALIFIERS_VAL_REC_TYPE Parameters
comparison_ope Null Varchar2 No No

rator
created_from_ru Null Varchar2 No No

le
qualifier Null Varchar2 No No
qualifier_rule Null Varchar2 No No
comparison_operator
created_from_rule
excluder
list_header
list_line
qualifier
qualifier_rule
QUALIFIERS_VAL_TBL_TYPE

QUALIFIERS_VAL_TBL_TYPE Parameters
Qualifiers_Val_R Null Record No No

ec_Type
PRICING_ATTR_REC_TYPE Parameters

ng_no

n

_context
pricing_attribute Null Number No No

_id

e_from

e_to


e

e_context

ue

de

tion_id

_date
product_attribut Null Varchar2 No No

e_datatype

_datatype

rator_code
MODIFIERS_ind Null Number Yes No

ex
accumulate_flag
attribute1-15
attribute_grouping_no
context
created_by
creation_date
excluder_flag
last_updated_by
last_update_date
last_update_login
list_line_id
pricing_attribute
pricing_attribute_context
pricing_attribute_id
pricing_attr_value_from
pricing_attr_value_to
product_attribute

product_attribute_context
product_attr_value
product_uom_code
program_id
program_update_date
product_attribute_datatype
pricing_attribute_datatype
request_id
return_status
db_flag
operation
MODIFIERS_index
PRICING_ATTR_TBL_TYPE Parameters

_Type
PRICING_ATTR_VAL_REC_TYPE Parameters
accumulate
excluder
list_line
pricing_attribute
product_uom
PRICING_ATTR_VAL_TBL_TYPE

PRICING_ATTR_VAL_TBL_TYPE Parameters

_Rec_ Type
Validation of Business Object for Modifier Setup API

Standard Validation
Oracle Advanced Pricing validates all required columns in the Business Object for
Modifier Setup API.
Other Validation
None
Error Handling
Business Object for Modifier Setup API processes the rows and reports the values in the
following table for every record.
Error Handling
Success 5 null
Example of Modifier Setup Application Program Interface

The following example scripts of the Modifier Setup Application Program Interface are
located in the directory $qp/patch/115/sql:
• QPXEXDS1.sql: This script provides a line level discount of 8% on all products.
• QPXEXDS2.sql: This script provides an 8% discount when you buy more than 5
quantities of item 62081.
• QPXEXDS3.sql: This script provides a 10% discount when customer "1000" buys
more than 2 units of item 62081.
• QPXEXSUR.sql: This script charges a 2% surcharge on all products.
• QPXEXTSN.sql: This script provides Payment Terms of 2/10 NET 30 if customer
"1000" buys more than 2 units of item 62081.
• QPXEXOID.sql: This script provides an other item discount: buy 1 of item 62081,
get 1 free
• QPXEXPRG.sql: This script provides a promotional good: buy 1 of item 45, and 1 of
item 63, then get 1 item 62081 at 20% discount.
• QPXEXCIE.sql: This script provides a coupon issue: buy 2 of item 45, get coupon for
20% discount.
• QPXEXPBH.sql: This script provides a price break: buy 1-100 of item 45, get 20%
discount.
Business Object for Pricing Formulas Application Program Interface

This section explains how to use the Business Object for Pricing Formulas API and how
it functions in Oracle Advanced Pricing. The Business Object for Pricing Formulas
package consists of entities to support the Formulas window.
Functional Overview
The Formulas window is based on the following APIs. However, the modal Formula
Factors window is based on the Modifiers public API
QP_Modifiers_PUB.Process_Modifiers.
The package QP_Price_Formula_PUB contains the following public record type and
table of records definitions:
• Formula_Rec_Type: A record type corresponding to the columns in the Formula
Headers view (QP_PRICE_FORMULAS_VL).
• Formula_Tbl_Type
• Formula_Val_Rec_Type: A record type used to store values corresponding to IDs in

the formula record.
• Formula_Val_Tbl_Type
• Formula_Lines_Rec_Type: A record type corresponding to the columns in the

Formula Lines table (QP_PRICE_FORMULA_LINES).
• Formula_Lines_Tbl_Type
• Formula_Lines_Val_Rec_Type: A record type used to store values corresponding to

IDs in the Formula Lines record.

• Formula_Lines_Val_Tbl_Type
• QP_Price_formula_PUB.Process_Price_Formula: Performs the insert, update, and

delete of price formula header and price formula lines.
• QP_Price_formula_PUB.Lock_Price_Formula: Locks price formula header and price

formula lines records prior to updates.
• QP_Price_formula_PUB.Get_Price_Formula: Retrieves the price formula header and

lines for a given formula.

The following chart describes all parameters and the inbound and outbound
parameters. Additional information on these parameters follows.
API:
QP_PRICE_FORMULA.PROCESS_PRICE_FORMULA
QP_PRICE_FORMULA.PROCESS_PRICE_FORMULA Parameters
umber
x_msg_count Out Number No No
p_FORMULA_re In Formula_Rec_ No No
c Type
p_FORMULA_v In Formula_Val_ No No
al_rec Rec_Type
p_FORMULA_L In Formula_Lines_ No No
INES_tbl Tbl_Type
p_FORMULA_L In Formula_Lines_ No No
INES_ val_tbl Val_Tbl_Type
x_FORMULA_re Out Formula_Rec_ No No

c Type
x_FORMULA_v Out Formula_Val_ No No

al_rec Rec_Type
x_FORMULA_LI Out Formula_Lines_ No No

NES_tbl Tbl_Type
x_FORMULA_LI Out Formula_Lines_ No No

NES_ val_tbl Val_Tbl_Type
p_init_msg_list
p_return_values
p_commit
p_FORMULA_rec

Default Value: G_MISS_FORMULA_REC
p_FORMULA_val_rec
Default Value: G_MISS_FORMULA_VAL_REC
p_FORMULA_LINES_tbl
Default Value: G_MISS_FORMULA_LINES_TBL
p_FORMULA_LINES_val_tbl
Default Value: G_MISS_FORMULA_LINES_VAL_TBL
FORMULA_REC_TYPE
FORMULA_REC_TYPE Parameters
formula Null Varchar2 Yes No

n
price_formula_id Null Number No No
attribute1-15
context

created_by
creation_date
description
end_date_active
formula
last_updated_by
last_update_date
last_update_login
name
price_formula_id
Default Value:Comes from the sequence QP_PRICE_FORMULAS_B_S
start_date_active
step_number
retun_status
db_flag
operation
FORMULA_TBL_TYPE
FORMULA_TBL_TYPE Parameters
Formula_Rec_Ty Null Record No No

pe
FORMULA_VAL_REC_TYPE
FORMULA_VAL_REC_TYPE Parameters
price_formula Null Number No No
price formula
FORMULA_VAL_TBL_TYPE
FORMULA_VAL_TBL_TYPE Parameters
Formula_Val_Re Null Record No No

c_Type
FORMULA_LINES_REC_TYPE
FORMULA_LINES_REC_TYPE Parameters


n
numeric_constan Null Number Yes1 No

t
price_formula_li Null Number No No

ne_id
formula_line_ty Null Varchar2 Yes No

pe_code
price_list_line_id Null Number Yes2 No
price_modifier_li Null Number Yes3 No

st_id
pricing_attribute Null Varchar2 Yes4 No
pricing_attribute Null Varchar2 Yes5 No

_context
step_number Null number Yes No
reqd_flag Null Varchar2 No No
The following table describes notations listed in the preceding table:

Notations
Note Description
1 Conditionally Required when

formula_line_type_code is 'NUM'

formula_line_type_code is 'PLL'

formula_line_type_code is 'ML'

formula_line_type_code is 'PRA'

formula_line_type_code is 'PRA'
attribute1-15
context
created_by
creation_date
end_date_active
last_updated_by
last_update_date
last_update_login
numeric_constant
price_formula_id
price_formula_line_id
Default Value: Comes for the sequence QP_PRICE_FORMULA_LINES_S
formula_line_type_code
price_list_line_id
price_modifier_list_id
pricing_attribute
pricing_attribute_context
start_date_active
step_number
reqd_flag
retun_status
db_flag
operation
FORMULA_LINES_TBL_TYPE

FORMULA_LINES_TBL_TYPE Parameters
Formula_Lines_ Null Record No No

Rec_Type
FORMULA_LINES_VAL_REC_TYPE
FORMULA_LINES_VAL_REC_TYPE Parameters
price_formula Null Varchar2 No No
price_formula_li Null Varchar2 No No

ne
price_formula_li Null Varchar2 No No

ne_type
price_list_line Null Varchar2 No No
price_modifier_li Null Varchar2 No No

st
price_formula
price_formula_line
price_formula_line_type
price_list_line
price_modifier_list
FORMULA_LINES_VAL_TBL_TYPE
FORMULA_LINES_VAL_TBL_TYPE Parameters
Formula_Lines_ Null Record No No

Val_Rec_ Type
Validation of Business Object for Pricing Formulas API

Validations:
Standard Validation
Oracle Advanced Pricing validates all required columns in the Business Object for
Pricing Formulas API. For more information, see: Oracle Pricing Technical Reference
Manual.
Other Validation
None
Error Handling
Business Object for Pricing Formulas API processes the rows and reports the values in
the following table for every record.
Error Handling
Success 5 null
Example of Pricing Formulas API

The following example script is located in the directory $qp/patch/115/sql:
QPPFXMP1.sql: This sample script inserts a pricing formula with seven different
pricing formula lines to demonstrate the six formula line types supported in Advanced
Pricing formulas:
• Price List Line (PLL)

• Function (FUNC)
• List Price (LP)
• Numeric Constant (NUM)
• Pricing Attribute (PRA)
• Factor List (ML)
• Modifier Value (MV)
Business Object for Pricing Limits Application Program Interface

This section explains how to use the Business Object for Pricing Limits API and how it
functions in Oracle Advanced Pricing. The Business Object for Pricing Limits package
consists of entities to support the Limits window.
Functional Overview
The Limits window is based on the following APIs:
The package QP_Limits_PUB contains the following public record type and table of
records definitions:
• Limits_Rec_Type: A record type corresponding to the columns in the Pricing Limits
view (QP_LIMITS).
• Limits_Tbl_Type
• Limits_Val_Rec_Type: A record type used to store values corresponding to IDs in

the Limits record.
• Limits_Val_Tbl_Type
• Limit_Attrs_Rec_Type: A record type corresponding to the columns in the Limit

Attributes. View (QP_LIMIT_ATTRIBUTES)
• Limit_Attrs_Tbl_Type
• Limit_Attrs_Val_Rec_Type: A record type used to store values corresponding to

IDs in the Limits Attributes record.
• Limit_Attrs_Val_Tbl_Type
• Limit_Balances_Rec_Type : A record type corresponding to the columns in the

Limit Balances. View (QP_LIMIT_BALANCES)
• Limit_Balances_Tbl_Type
• Limit_Balances_Val_Rec_Type : A record type used to store values corresponding

to IDs in the Limits Balances record.
• Limit_Balances_Val_Tbl_Type

The following chart describes all parameters used by the public API
QP_LIMITS_PUB.PROCESS_LIMITS. All of the inbound and outbound parameters are
listed.
API:
PROCEDURE Process_Limits
Additional information on these parameters follows.
QP_LIMITS_PUB.PROCESS_LIMITS Parameters
Parameter Usage Type Default
p_api_version_numb IN Number
er
p_init_msg_list IN Varchar2 FND_API.G_FALSE
p_return_values IN Varchar2 FND_API.G_FALSE
p_commit IN Varchar2 FND_API.G_FALSE
x_return_status OUT Varchar2

x_msg_count OUT Number
x_msg_data OUT Varchar2
p_LIMITS_rec IN Limits_Rec_Type G_MISS_LIMITS_RE

C
p_LIMITS_val_rec IN Limits_Val_Rec_Type G_MISS_LIMITS_VA

L_REC
p_LIMIT_ATTRS_tbl IN Limit_Attrs_Tbl_Typ G_MISS_LIMIT_ATT

e RS_TBL
p_LIMIT_ATTRS_val IN Limit_Attrs_Val_Tbl_ G_MISS_LIMIT_ATT

_tbl Type RS_VAL_TBL
p_LIMIT_BALANCE IN Limit_Balances_Tbl_T G_MISS_LIMIT_BAL

S_tbl ype ANCES_TBL
p_LIMIT_BALANCE IN Limit_Balances_Val_ G_MISS_LIMIT_BAL

S_val_tbl Tbl_Type ANCES_VAL_TBL
x_LIMITS_rec OUT Limits_Rec_Type
x_LIMITS_val_rec OUT Limits_Val_Rec_Type
x_LIMIT_ATTRS_tbl OUT Limit_Attrs_Tbl_Typ

e
x_LIMIT_ATTRS_val OUT Limit_Attrs_Val_Tbl_

_tbl Type
x_LIMIT_BALANCES OUT Limit_Balances_Tbl_T

_tbl ype
x_LIMIT_BALANCES OUT Limit_Balances_Val_

_val_tbl Tbl_Type
PROCEDURE Lock_Limits
QP_LIMITS_PUB.LOCK_LIMITS. All of the inbound and outbound parameters are
listed. Additional information on these parameters follows.
QP_LIMITS_PUB.LOCK_LIMITS Parameters
p_api_version_numb IN Number
er
p_init_msg_list IN Varchar2 FND_API.G_FALSE
p_return_values IN Varchar2 FND_API.G_FALSE
x_return_status OUT Varchar2
x_msg_count OUT Number
x_msg_data OUT Varchar2
p_LIMITS_rec IN Limits_Rec_Type G_MISS_LIMITS_RE

C
p_LIMITS_val_rec IN Limits_Val_Rec_Type G_MISS_LIMITS_VA

L_REC
p_LIMIT_ATTRS_tbl IN Limit_Attrs_Tbl_Typ G_MISS_LIMIT_ATT

e RS_TBL
p_LIMIT_ATTRS_val IN Limit_Attrs_Val_Tbl_ G_MISS_LIMIT_ATT

_tbl Type RS_VAL_TBL
p_LIMIT_BALANCE IN Limit_Balances_Tbl_T G_MISS_LIMIT_BAL

S_tbl ype ANCES_TBL
p_LIMIT_BALANCE IN Limit_Balances_Val_ G_MISS_LIMIT_BAL

S_val_tbl Tbl_Type ANCES_VAL_TBL
x_LIMITS_rec OUT Limits_Rec_Type
x_LIMITS_val_rec OUT Limits_Val_Rec_Type
x_LIMIT_ATTRS_tbl OUT Limit_Attrs_Tbl_Typ

e

x_LIMIT_ATTRS_val OUT Limit_Attrs_Val_Tbl_

_tbl Type
x_LIMIT_BALANCES OUT Limit_Balances_Tbl_T

_tbl ype
x_LIMIT_BALANCES OUT Limit_Balances_Val_

_val_tbl Tbl_Type
PROCEDURE Get_Limits
QP_LIMITS_PUB.GET_LIMITS. All of the inbound and outbound parameters are listed.
Additional information on these parameters follows.
QP_LIMITS_PUB.GET_LIMITS Parameters
Parameter Usage Type Req Default
p_api_version_n IN Number Yes

umber
p_init_msg_list IN Varchar2 No FND_API.G_FA

LSE
p_return_values IN Varchar2 No FND_API.G_FA

LSE
x_return_status OUT Varchar2 No
x_msg_count OUT Number No
x_msg_data OUT Varchar2 No
p_limit_id IN Number No FND_API.G_MI

SS_NUM
p_limit IN Varchar2 No FND_API.G_MI

SS_CHAR
Parameter Usage Type Req Default
x_LIMITS_rec OUT Limits_Rec_Type No
x_LIMITS_val_re OUT Limits_Val_Rec_ No

c Type
x_LIMIT_ATTRS OUT Limit_Attrs_Tbl_ No

_tbl Type
x_LIMIT_ATTRS OUT Limit_Attrs_Val_ No

_val_tbl Tbl_Type
x_LIMIT_BALA OUT Limit_Balances_ No

NCES_tbl Tbl_Type
x_LIMIT_BALA OUT Limit_Balances_ No

NCES_val_tbl Val_Tbl_Type
PL/SQL Record Structures

For each column of the PL/SQL record structure, the following information has been
documented:
• Datatype: data type for this field
• Req: X if required at entry, Blank if Optional
• Drv: For internal use, users cannot update these fields
• Default: Defaulted value for this field
Limits_Rec_Type
For column descriptions, please refer to the Oracle Pricing TRM for the table
QP_LIMITS.
The Derived value for the following parameters is Null.

QP_LIMITS
Parameter Type Req Default
attribute1 Varchar2(240) No FND_API.G_MISS_C

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR

HAR
Amount Number Yes FND_API.G_MISS_N

UM
Basis Varchar2(30) Yes FND_API.G_MISS_C

HAR
Context Varchar2(30) No FND_API.G_MISS_C

HAR
created_by Number Yes FND_API.G_MISS_C

HAR
creation_date Date Yes FND_API.G_MISS_D

ATE
last_updated_by Number Yes FND_API.G_MISS_N

UM
last_update_date Date Yes FND_API.G_MISS_D

ATE
last_update_login Number No FND_API.G_MISS_N

UM
limit_exceed_action_c Varchar2(30) Yes FND_API.G_MISS_C

ode HAR
limit_id Number Yes FND_API.G_MISS_N

UM
limit_level_code Varchar2(30) Yes FND_API.G_MISS_C

HAR
limit_number Number Yes FND_API.G_MISS_N

UM

list_header_id Number Yes FND_API.G_MISS_N

UM
list_line_id Number No FND_API.G_MISS_N

UM
limit_hold_flag Varchar2(1) Yes FND_API.G_MISS_C

HAR
multival_attr1_type Varchar2(30) No FND_API.G_MISS_C

HAR
multival_attr1_contex Varchar2(30) No FND_API.G_MISS_C

t HAR
multival_attribute1 Varchar2(30) No FND_API.G_MISS_C

HAR
multival_attr1_dataty Varchar2(10) No FND_API.G_MISS_C

pe HAR
multival_attr2_type Varchar2(30) No FND_API.G_MISS_C

HAR
multival_attr2_contex Varchar2(30) No FND_API.G_MISS_C

t HAR
multival_attribute2 Varchar2(30) No FND_API.G_MISS_C

HAR
multival_attr2_dataty Varchar2(10) No FND_API.G_MISS_C

pe HAR
organization_flag Varchar2(1) Yes FND_API.G_MISS_C

HAR
program_application Number No FND_API.G_MISS_N

_id UM
program_id Number No FND_API.G_MISS_N

UM
program_update_dat Date No FND_API.G_MISS_D

e ATE
request_id Number No FND_API.G_MISS_N

UM
return_status Varchar2(1) No FND_API.G_MISS_C

HAR
db_flag Varchar2(1) No FND_API.G_MISS_C

HAR
operation Varchar2(30) No FND_API.G_MISS_C

HAR
Limits_Tbl_Type
Limits_Tbl_Type
Parameter Type Req Drv Default
Limits_Rec_Type Record
Limits_Val_Rec_Type
Limits_Val_Rec_Type
limit_exceed_acti Varchar2(240) No No FND_API.G_MI

on SS_CHAR
limit Varchar2(240) No No FND_API.G_MI

SS_CHAR

limit_level Varchar2(240) No No FND_API.G_MI

SS_CHAR
list_header Varchar2(240) No No FND_API.G_MI

SS_CHAR
list_line Varchar2(240) No No FND_API.G_MI

SS_CHAR
organization Varchar2(240) No No FND_API.G_MI

SS_CHAR
Limits_Val_Tbl_Type
Limits_Val_Tbl_Type
Limits_Val_Rec_ Record
Type
Limit_Attrs_Rec_Type
For column descriptions, please refer to the Oracle Pricing TRM for the table
QP_LIMIT_ATTRIBUTES.
Limit_Attrs_Rec_Type
attribute1 Varchar2(240) No No FND_API.G_MI

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR
comparison_ope Varchar2(30) Yes No FND_API.G_MI

rator_code SS_CHAR
context Varchar2(30) No No FND_API.G_MI

SS_CHAR

created_by Number Yes No FND_API.G_MI

SS_CHAR
creation_date Date Yes No FND_API.G_MI

SS_DATE
last_updated_by Number Yes No FND_API.G_MI

SS_NUM
last_update_date Date Yes No FND_API.G_MI

SS_DATE
last_update_logi Number No No FND_API.G_MI

n SS_NUM
limit_attribute Varchar2(30) Yes No FND_API.G_MI

SS_CHAR
limit_attribute_c Varchar2(30) Yes No FND_API.G_MI

ontext SS_CHAR
limit_attribute_i Number Yes No FND_API.G_MI

d SS_NUM
limit_attribute_t Varchar2(30) Yes No FND_API.G_MI

ype SS_CHAR
limit_attr_dataty Varchar2(10) Yes No FND_API.G_MI

pe SS_CHAR
limit_attr_value Varchar2(240) Yes No FND_API.G_MI

SS_CHAR
limit_id Number No No FND_API.G_MI

SS_NUM
program_applica Number No No FND_API.G_MI

tion_id SS_NUM
program_id Number No No FND_API.G_MI

SS_NUM
program_update Date No No FND_API.G_MI

_date SS_DATE
request_id Number No No FND_API.G_MI

SS_NUM
return_status Varchar2(1) No No FND_API.G_MI

SS_CHAR
db_flag Varchar2(1) No No FND_API.G_MI

SS_CHAR
operation Varchar2(30) No No FND_API.G_MI

SS_CHAR
Limit_Attrs_Tbl_Type
Limit_Attrs_Tbl_Type
Limit_Attrs_Rec Record
_Type
Limit_Attrs_Val_Rec_Type
Limit_Attrs_Val_Rec_Type
comparison_operator Varchar2(240) No FND_API.G_MISS_C

HAR
limit_attribute Varchar2(240) No FND_API.G_MISS_C

HAR

limit Varchar2(240) No FND_API.G_MISS_C

HAR
Limit_Attrs_Val_Tbl_Type
Limit_Attrs_Val_Tbl_Type
Limit_Attrs_Val_ Record
Rec_Type
Limit_Balances_Rec_Type
The following table shows the parameters for this structure. For column descriptions,
see the Oracle Pricing e-TRM for the table QP_LIMIT_BALANCES.
Limit_Balances_Rec_Type

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR

SS_CHAR
available_amoun Number Yes No FND_API.G_MI

t SS_NUM
consumed_amou Number Yes No FND_API.G_MI

nt SS_NUM
context Varchar2(30) No No FND_API.G_MI

SS_CHAR
created_by Yes No FND_API.G_MI

SS_CHAR
creation_date Date Yes No FND_API.G_MI

SS_DATE

last_updated_by Number Yes No FND_API.G_MI

SS_NUM
last_update_date Date Yes No FND_API.G_MI

SS_DATE
last_update_logi Number No No FND_API.G_MI

n SS_NUM
limit_balance_id Number Yes No FND_API.G_MI

SS_NUM
limit_id Number Yes No FND_API.G_MI

SS_NUM
organization_attr Varchar2(30) No No FND_API.G_MI

_context SS_CHAR

ibute SS_CHAR

_value SS_CHAR
multival_attr1_t Varchar2(30) No No FND_API.G_MI

ype SS_CHAR
multival_attr1_c Varchar2(30) No No FND_API.G_MI

ontext SS_CHAR
multival_attribut Varchar2(30) No No FND_API.G_MI

e1 SS_CHAR
multival_attr1_v Varchar2(240) No No FND_API.G_MI

alue SS_CHAR
multival_attr1_d Varchar2(10) No No FND_API.G_MI

atatype SS_CHAR
multival_attr2_t Varchar2(30) No No FND_API.G_MI

ype SS_CHAR
multival_attr2_c Varchar2(30) No No FND_API.G_MI

ontext SS_CHAR
multival_attribut Varchar2(30) No No FND_API.G_MI

e2 SS_CHAR
multival_attr2_v Varchar2(240) No No FND_API.G_MI

alue SS_CHAR
multival_attr2_d Varchar2(10) No No FND_API.G_MI

atatype SS_CHAR
program_applica Number No No FND_API.G_MI

tion_id SS_NUM
program_id Number No No FND_API.G_MI

SS_NUM
program_update Date No No FND_API.G_MI

_date SS_DATE
request_id Number No No FND_API.G_MI

SS_NUM
reserved_amoun Number Yes No FND_API.G_MI

t SS_NUM
return_status Varchar2(1) No No FND_API.G_MI

SS_CHAR
db_flag Varchar2(1) No No FND_API.G_MI

SS_CHAR
operation Varchar2(30) No No FND_API.G_MI

SS_CHAR
Limit_Balances_Tbl_Type

Limit_Balances_Tbl_Type
Limit_Balances_ Record
Rec_Type
Limit_Balances_Val_Rec_Type
Limit_Balances_Val_Rec_Type
limit_balance Varchar2(240) FND_API.G_MI

SS_CHAR
limit Varchar2(240) FND_API.G_MI

SS_CHAR
Limit_Balances_Val_Tbl_Type
Limit_Balances_Val_Tbl_Type
Limit_Balances_ Record
Val_Rec_Type
Validation of Limits Public API

Validations:
Standard Validation
Oracle Advanced Pricing validates all required columns in the Limits Public API.
Other Validation
None
Error Handling
If any validation fails, the API will return error status to the calling module. The Limits
Public API processes the rows and reports the values in the following table for every
record.
Error Handling
Success 5 Null
Example of Limits Public API

• insert_limits.sql: Example of inserting limits.
• update_limit_avlbl_amt.sql: Example of how to update available amount on a limit

balance.
• delete_limits.sql: Example of deleting a limits record.
Create Publish Price Book Application Program Interface

This section explains how to use the Create_Publish_Price_Book API and how it
functions in Oracle Advanced Pricing.
Functional Overview
The Create_Publish_Price_Book PL/SQL API can be used by applications integrating
with Oracle Advanced Pricing to initiate a Concurrent Request to create and publish a
new price book or to publish an existing price book. The concurrent program name is
QP: Price Book Generate and Publish. The request id of the concurrent request
submitted is available in the output parameter x_request_id of this API. You can use the
request id to monitor the concurrent request status either from the price book user
interface (UI), the View Concurrent Requests UI, or programmatically using the Oracle
Application Object Library (FND) API FND_CONCURRENT.GET_REQUEST_STATUS
(For more information on this FND API, see: Oracle Applications Coding Standards
Guide).
The package QP_PRICE_BOOK_PUB contains the Procedure
Create_Publish_Price_Book. The package specification QP_PRICE_BOOK_PUB contains
the following public record type and table of records type definitions used in the
Create_Publish_Price_Book API:

• pb_input_header_rec: record type corresponding to the columns in view
QP_PB_INPUT_HEADERS_VL
• pb_input_lines_rec: record type corresponding to the columns in table

QP_PB_INPUT_LINES
• pb_input_lines_tbl: table of records of type pb_input_lines_rec

Create_Publish_Price_Book. All of the inbound and outbound parameters are listed.
Additional information on these parameters may follow.
Procedure CREATE_PUBLISH_PRICE_BOOK
The following table lists the parameters for this Procedure
p_pb_input_hea In Pb_input_header No No
der_rec _rec
p_pb_input_line In Pb_input_lines_t No No
s_tbl bl
x_request_id Out Number No No
x_retcode Out Number No No
x_err_buf Out Varchar2 No No
x_price_book_m Out Price_book_mess No No

essages_tbl ages_tbl
Type PB_INPUT_HEADER_REC
The following table lists the parameters in this structure:
customer_context Null Varchar2 No No
customer_attribute Null Varchar2 No No
customer_attr_value Null Varchar2 Yes No
cust_account_id Null Number No No
limit_products_by Null Varchar2 No No
product_context Null Varchar2 No No
product_attribute Null Varchar2 No No
product_attr_value Null Varchar2 No No
effective_date Null Date Yes No
item_quantity Null Number Yes No
pub_template_code Null Varchar2 No No
pub_language Null Varchar2 No No
pub_territory Null Varchar2 No No
pub_output_document_t Null Varchar2 No No

ype
dlv_xml_flag Null Varchar2 No No
dlv_xml_site_id Null Number No No
dlv_email_flag Null Varchar2 No No
dlv_email_addresses Null Varchar2 No No
dlv_printer_flag Null Varchar2 No No
dlv_printer_name Null Varchar2 No No

generation_time_code Null Varchar2 No No
gen_schedule_date Null Date No No
org_id Null Number Yes No
price_book_type_code Null Varchar2 Yes No
price_based_on Null Varchar2 No No
pl_agr_bsa_id Null Number No No
pricing_perspective_code Null Varchar2 No No
publish_existing_pb_flag Null Varchar2 No No
overwrite_existing_pb_fl Null Varchar2 No No

ag
request_origination_code Null Varchar2 No No
request_type_code Null Varchar2 No Yes
price_book_name Null Varchar2 Yes No
pl_agr_bsa_name Null Varchar2 No No
pub_template_name Null Varchar2 No No
Type PB_INPUT_LINES_REC
The following table lists the parameters in this structure
context Null Varchar No No

2
attribute Null Varchar No No

2
attribute_value Null Varchar No No

2
attribute_type Null Varchar No No

2
Type PB_INPUT_LINES_TBL
The following table lists the record type of which this structure is a plsql table:
pb_input_lines_rec Null Record No No
Validation of Create Publish Price Book API

Standard Validation
Oracle Advanced Pricing validates all required columns in the
• For the input parameter p_pb_input_header_rec the columns price_book_name,
price_book_type_code, customer_attr_value, currency_code and org_id are
required.
• Price_book_type_code if Null, will be defaulted to 'F' for Full price book.
• Customer_Attr_Value refers to the Party_Id of the customer. Internal users of

Advanced Pricing must specify a value since the system cannot determine a default
value for this column. For external users, Customer_Attr_Value if Null, will be
defaulted with the customer associated with the user who is logged in to the
application.
Note: Internal user refers to the customer who has implemented

Oracle Advanced Pricing while external user refers to the
customer's customer.
Oracle Advanced Pricing validates all conditionally required fields in the

• If publish_existing_pb_flag = N (that is, new price book will be generated), then the
following fields are required:

1. Currency_Code if null will be defaulted as follows – If the multi-currency
functionality is not installed or enabled for the Pricing Perspective application,
and if p_pb_input_header_rec.limit_products_by is PRICE_LIST, then
currency_code is defaulted from the corresponding price list id specified in
p_pb_input_header_rec.pl_agr_bsa_id. However, in cases where a default value
is not determinable for the currency_code, the user must specify a value for this
column.
2. Org_id if null will be defaulted based on Multi-Org Access Control rules.

However, if the system cannot determine a default value, the user must specify
a value for this column.
3. Item_Quantity and Effective_Date, if null, are defaulted to 1 and current system

date respectively but are required for price book generation.
4. Pricing_Perspective_Code: If null, the value defaults from the system profile

option QP: Internal Default Pricing Perspective for internal customers; for
external customers, the value defaults from the profile option QP: External
Default Pricing Perspective. However, it is required to generate a price book.
5. Request_Type_Code defaults from the profile QP: Pricing Perspective Request

Type. It is required to generate a price book.
6. Limit_products_by is required. If limit_products_by is ITEM,

ITEM_CATEGORY or ALL_ITEMS then product_attr_value is required. If
limit_products_by = PRICE_LIST then pl_agr_bsa_id field is required.
7. If price_based_on is not null then pl_agr_bsa_id is required.
• If either dlv_printer_flag or dlv_email_flag = 'Y', then pub_template_code,

pub_language and pub_territory are required fields.
• If pub_template_code is populated and either a) dlv_email_flag = Y or b) both

dlv_email_flag and dlv_printer_flag are N, then pub_output_document_type is
required.
• If dlv_email_flag = Y, then a delivery e-mail address is required. One or more e-mail

address may be specified separated by commas.
• If dlv_xml_flag = Y then dlv_xml_site_id is required.
• If generation_time_code = SCHEDULE then gen_schedule_date is required.
For more information, see: Oracle eTRM (eTechnical Reference Manual) available on
OracleMetaLink.
Other Validation
Oracle Advanced Pricing validates each field against a valid set of values in the
Create_Publish_Price_Book API. The valid set of values is the same as the set of values
one that can be selected from the price book UI. Additionally, all flags –
publish_existing_pb_flag, overwrite_existing_price_book_flag, dlv_email_flag,
dlv_printer_flag, dlv_xml_flag – can be Y or N (null defaults to N) only. A
price_book_name, customer_attr_value and price_book_type_code combination is
unique. You can overwrite an existing combination by specifying
overwrite_existing_pb_flag = Y. A validation error is raised if this flag is N and the price
book already exists.
Publish_existing_pb_flag indicates that an existing price book is to be published. A
validation error occurs is if the price book to be published does not already exist. For
Basic Pricing users, generating and publishing a delta price book and publishing an
XML Message is not supported. A validation error is raised if price_book_type_code is
D or dlv_xml_flag = Y.
An external user can only generate or publish a price book with customer_attr_value
that matches the Customer_Id of the user or matches a parent organization of the
Customer_id of the user. If the Customer party associated with the user is a Person
party who belongs to an Organization party (a record exists in the Trading Community
Architecture (TCA) table hz_relationships with a party_type
of'PARTY_RELATIONSHIP for the Customer party of the user and the Object
(object_id) of the relationship is an Organization party), then the Person can create a
price book for himself or for the Organization to which he belongs, but not for any other
customer.
An external user cannot create or publish a price book using the Purchasing pricing
perspective. An internal user can create or publish a price book with pricing perspective
Purchasing, but cannot use the "Send XML message" publishing option for such price
books. While creating or publishing a price book from the Purchasing pricing
perspective, the value -1 must be passed for the input parameter
p_pb_input_header_rec.customer_attr_value and null must be passed for the
input parameter p_pb_input_header_rec.cust_account_id. While creating a
price book with Purchasing pricing perspective, the input parameter
p_pb_input_header_rec.price_based_on can be PRICE_LIST (or null) but not
AGREEMENT or BSA.
Error Handling
The output parameter x_return_status can have the values - fnd_api.g_ret_sts_success
(S) or fnd_api.g_ret_sts_error (E) – indicating Success or Error respectively. The
parameter x_return_status is E when either validation fails or if the concurrent request
submission failed (such as x_request_id = 0). The output parameter x_request_id, if 0,
indicates that the concurrent request submission failed to generate a Request Id.
Similarly, output parameter x_retcode can have values 0 (success), 1 (warning) or 2
(error) indicating the status of concurrent request submission and x_err_buf contains
any corresponding message. The output parameter x_price_book_messages_tbl
contains any validation error messages associated with the price book create or publish
request.

Examples of Create_Publish_Price_Book API
• QPPBXMP1.sql: Create a price book.
• QPPBXMP2.sql: Create and Publish (print, e-mail, and view document) a price
book.
Get Currency Application Program Interface

The Get_Currency API retrieves all the currency codes for a given price list. The
package QP_UTIL_PUB contains the procedure Get_Currency. This section explains
how to use the Get_Currency API and how it functions in Oracle Advanced Pricing.
Functional Overview
While processing an order using a particular price list, Order Management (OM)
displays a valid set of currency codes when the list of values (LOV) is selected. OM calls
this API to get the valid currency codes for the given price list and pricing effective
date. If pricing effective date is not passed by calling application, the current date
defaults. If the profile options QP: Multi Currency Installed and QP: Multi Currency
Usage are set to Y (Yes), then currency codes are retrieved by joining the view
fnd_currencies_vl, table qp_list_headers_b and table qp_currency_details for the passed
price list id; otherwise, all the effective currencies are retrieved from view
fnd_currencies_vl.

The following chart describes all parameters used by the Get_Currency API. All of the
inbound and outbound parameters are listed.
Get_Currency
l_price_list_id IN Number Yes No
l_pricing_effecti IN Date No No
ve_date
l_currency_code OUT currency_code_t No No

_tbl bl
CURRENCY_REC
CURRENCY_REC
currency_name Null Varchar2 Yes No
currency_precisi Null Number Yes No

on
CURRENCY_CODE_TBL
CURRENCY_CODE_TBL
Currency_rec Null Record No No
Validation of Get_Currency API

Validations:
Standard Validation
The caller is responsible for passing the right parameters to Get_Currency.
For specific information on the data implied by these columns, see your Oracle Pricing
Technical Reference Manual for details.
Other Validation
None.
Error Handling
If any exception occurs in the Get_Currency API, it does not return any Currency
Codes.
Note: The Package Specification and Body files are QPXRTCNS.pls and
QPXRTCNB.pls and are available under the source control directory
$QP_TOP/patch/115/sql.

Get Custom Price Application Program Interface
This section explains how to use the Get_Custom Price API (used in Formulas Setup)
and how it functions in Oracle Advanced Pricing.
The pricing engine calls the Get_Custom_Price API when evaluating a formula that
contains a formula line (step) of type Function. One or more formulas may be set up to
contain a formula line of type Function and the same Get_Custom_price API is called
each time. Therefore, the user must code the logic in the API based on the
price_formula_id that is passed as an input parameter to the API.
Note: The Get Custom Price API can be customized by adding custom
code.
Functional Overview
The package specification QP_CUSTOM contains the specification for the
Get_Custom_Price API. The package body/function body is not shipped with Oracle
Advanced Pricing. The user must create the Package Body for QP_CUSTOM containing
the function body for Get_Custom_Price which must adhere to the Function
specification (in terms of parameters and return value) provided in the QP_CUSTOM
package specification. For the engine to make a call to Get_Custom_Price API, set the
profile QP: Get Custom Price Customized at the site level to Yes. The Pricing engine
displays an error if this profile is set and QP_CUSTOM. Get_Custom_Price is not
created in the database in the applications schema:
• API to all procedures within and outside of this package
• Get_Custom_Price: A customizible function.

The following chart describes all parameters used by the public Get Custom Price API.
these parameters may follow. These parameters are input parameters to the
Get_Custom_Price API and are passed by the Engine.
Get_Custom_Price
p_price_formula In Number Yes No

_id
p_list_price In Number No No
p_price_effective In Date Yes No

_date
p_req_line_attrs_ In Table Yes No

tbl (REQ_LINE_AT
TRS_TBL)
Return Number Yes No
REQ_LINE_ATTRS_TBL
REQ_LINE_ATTRS_TBL
rec_line_attrs_re Null Record No No

c (REQ_LINE_AT
TRS_REC)
REQ_LINE_ATTRS_REC
REQ_LINE_ATTRS_REC
line_index Null Number Yes No
attribute_type Null Varchar2 Yes No

context Null Varchar2 Yes No
attribute Null Varchar2 Yes No
value Null Varchar2 Yes No
Validation of Get Custom Price API

The following describes the validations for the Get Custom Price API:
Standard Validation
The user is responsible for all code and validations in the Get Custom Price API. For
more information, see: Oracle Pricing Technical Reference Manual.
Other Validation
None
Error Handling
The user is responsible for all error handling in the Get Custom Price API. If any
user-coded validation fails, the API should raise exceptions to propagate it to the calling
module.
Sample Code1: The following is a sample code showing how the body of the
Get_Custom_Price function is coded in the file $QP_TOP/patch/115/sql/.
The user must use the function specification of Get_Custom_Price as well as any type
definitions from $QP_TOP/patch/115/sql/.
The parameters to Get_Custom_Price are always fixed and not customizible. But the
user can use the input parameters passed by the pricing engine in their custom code.
The function returns a number. The user can code the function to return the desired
value which must be a number. The return value is used in the evaluation of the
formula.
For example, consider a formula having an expression 1*2 where 1 and 2 are step
numbers. Each step number corresponds to a formula line. Each formula line has a type:
• Step 1 corresponds to a formula line of type Numeric Constant with a component of
'200,' and
• Step 2 corresponds to a formula line of type Function. This means the value
returned by the QP_CUSTOM.Get_Custom_Price function will be used as the value
for this step.
To evaluate the Formula, the pricing engine first obtains the value of each step and
substitutes the step with its value in the expression. So step 1 is substituted by the value
which is 200. Step 2 is substituted with the value returned by Get_Custom_Price which
must be customized by the user (the Profile Option mentioned earlier must also be set
to Yes to use this Get_Custom_Price functionality.
If Get_Custom_Price is customized as below:

PACKAGE BODY QP_CUSTOM AS
/***********************************************************************
***
The Get_Custom_Price Function name and parameters are not customizable
but the
body can be been customized. The parameters are:
p_price_formula_id: Primary key of the formula that uses the
Get_Custom_Price
function
p_list_price: List price of the price list line to which the formula
using Get_
Custom_Price is attached. May have null value.
p_price_effective_date: Current date when Formula is being evaluated by
the
pricing engine.
p_req_line_attrs_tbl: PL/SQL table of records containing Context,
Attribute,
Attribute Value records for Product and Pricing Attributes and a column
indicating the type - whether Product Attribute or Pricing Attribute.
Also the engine passes the Pricing Attributes and Product Attributes of
only the
current line to which the formula is attached.
The parameters are passed to the function by the pricing engine and can
be used
in the function body.
************************************************************************
**/
FUNCTION Get_Custom_Price
p_price_formula_id IN NUMBER,
p_list_price IN NUMBER,
p_price_effective_date IN DATE,
p_req_line_attrs_tbl IN
QP_FORMULA_PRICE_CALC_PVT.REQ_LINE_ATTRS_TBL)
RETURN NUMBER IS
v_requested_item VARCHAR2(240);
v_weight NUMBER;
BEGIN
IF p_price_formula_id = 1726 -- Assume this is the internal Id/primary
key for
the sample Formula 1*2
THEN
--Loop through the PL/SQL table of records passed by the Engine as
an input parameter and
--containing Pricing Attributes and Product Attributes of the Price
List
Line or Modifier Line to which
-- the current formula is attached.
FOR i IN 1..p_req_line_attrs_tbl.count LOOP
IF p_req_line_attrs_tbl(i).attribute_type = 'PRODUCT'
AND /*Attribute Type is Product*/

p_req_line_attrs_tbl(i).context = 'ITEM'
AND
p_req_line_attrs_tbl(i).attribute = 'PRICING_ATTRIBUTE1'
THEN
-- For this combination of Product Context and Attribute, the
Attribute Value is the Inventory Item Id
v_requested_item := p_req_line_attrs_tbl(i).value;
END IF;
IF p_req_line_attrs_tbl(i).attribute_type = 'PRICING'
AND /*Attribute Type is Pricing*/
p_req_line_attrs_tbl(i).context = 'MIXED'
AND
p_req_line_attrs_tbl(i).attribute = 'PRICING_ATTRIBUTE4'
THEN
--For this combination of Pricing Context and Attribute, let's
say, the
Attribute Value is the Weight of
--the item to which the formula is attached.
v_weight := p_req_line_attrs_tbl(i).value;
END IF;
END LOOP; /*For Loop*/
RETURN v_weight;
EXCEPTION
WHEN OTHERS THEN
RETURN NULL;
END Get_Custom_Price;
END QP_CUSTOM;
Then if v_weight has a value '1.2' then Get_Custom_Price returns a value
of'1.2'
Therefore,the pricing engine evaluates the formula as 200*1.2 = 240.
Get Price Book Application Program Interface

This section explains how to use the Get_Price_Book API and how it functions in Oracle
Advanced Pricing.
Functional Overview
The Get_Price_Book PL/SQL API can be used by applications integrating with Oracle
Advanced Pricing to query an existing price book. This API maybe used to query a
price book that has been created from the price book user interface (UI), the
Create_Publish_Price_Book public API, or from a Get_Catalog Inbound XML Message.
Before querying a price book, ensure that the concurrent request generating the price
book has completed successfully.
The package QP_PRICE_BOOK_PUB contains the Procedure Get_Price_Book and a
version of Get_Price_Book with an additional output parameter x_documents_rec. The
package specification QP_PRICE_BOOK_PUB contains the following public record type
and table of records type definitions used in the Get_Price_Book API:
• price_book_header_rec: record type corresponding to the view–
QP_PRICE_BOOK_HEADERS_V
• price_book_lines_rec: record type corresponding to the view

QP_PRICE_BOOK_LINES_V
• price_book_lines_tbl: table of records of type price_book_lines_rec
• price_book_line_details_rec: record type corresponding to the view

QP_PRICE_BOOK_LINE_DETAILS_V
• price_book_line_details_tbl: table of records of type price_book_line_details_rec ·

price_book_attributes_rec - record type corresponding to the view
QP_PRICE_BOOK_ATTRIBUTES_V
• price_book_attributes_tbl: table of records of type price_book_attributes_rec
• price_book_break_lines_rec: record type corresponding to the view

QP_PRICE_BOOK_BREAK_LINES_V
• price_book_break_lines_tbl: table of records of type price_book_break_lines_rec
• price_book_messages_tbl: table of records where record type corresponds to the

ROWTYPE of table QP_PRICE_BOOK_MESSAGES
• documents_rec: record type corresponding to the table QP_DOCUMENTS (used in

the overloaded version)
• VARCHAR_TBL: table of VARCHAR2(240)

The following table describes all parameters used by the public API Get_Price_Book.
All of the inbound and outbound parameters are listed.
Procedure GET_PRICE_BOOK
The following table lists the parameters for this procedure:
p_price_book_name In Varchar2 Yes No
p_customer_id In Varchar2 Yes No
p_price_book_type_code In Varchar2 Yes No
x_price_book_header_rec Out price_book_ No No

header_rec
x_price_book_lines_tbl Out price_book_l No No

ines_tbl
x_price_book_line_details_tbl Out price_book_l No No

ine_details_t
bl
x_price_book_attributes_tbl Out price_book_ No No

attributes_tb
l
x_price_book_break_lines_tbl Out price_book_ No No

break_lines_
tbl
x_price_book_messages_tbl Out price_book_ No No

messages_tb
l
x_query_messages Out VARCHAR_ No No

TBL
Procedure GET_PRICE_BOOK (overloaded version)

The following table lists the parameters for this procedure:
Note: The overloaded version of Get_Price_Book procedure has an

additional output parameter x_documents_rec. This overloaded
version of Get_Price_Book API may be called instead, to additionally
get the formatted price book document (stored in the database as a .pdf
,.rtf, etc. file) and related information (mime type, file name, etc).
p_price_book_name In Varchar2 Yes No
p_customer_id In Varchar2 Yes No

p_price_book_type_code In Varchar2 Yes No
x_price_book_header_rec Out price_book_ No No

header_rec
x_price_book_lines_tbl Out price_book_l No No

ines_tbl
x_price_book_line_details_tbl Out price_book_l No No

ine_details_t
bl
x_price_book_attributes_tbl Out price_book_ No No

attributes_tb
l
x_price_book_break_lines_tbl Out price_book_ No No

break_lines_
tbl
x_price_book_messages_tbl Out price_book_ No No

messages_tb
l
x_documents_rec Out documents_ No No

rec
x_query_messages Out VARCHAR_ No No

TBL
Type PRICE_BOOK_HEADER_REC
price_book_header_id Null Number No No
price_book_type_code Null Varchar2 No No
currency_code Null Varchar2 No No
effective_date Null Date No No
org_id Null Number No No
customer_id Null Number No No
cust_account_id Null Number No No
document_id Null Number No No
item_category Null Number No No
price_based_on Null Varchar2 No No
pl_agr_bsa_id Null Number No No
pricing_perspective_code Null Varchar2 No No
item_quantity Null Number No No
request_type_code Null Varchar2 No No
pb_input_header_id Null Number No No
pub_status_code Null Varchar2 No No
price_book_name Null Varchar2 No No
pl_agr_bsa_name Null Varchar2 No No

last_update_login Null Number No No
price_book_type Null Varchar2 No No
operating_unit Null Varchar2 No No
customer_name Null Varchar2 No No
Type PRICE_BOOK_LINES_REC
price_book_line_id Null Number No No
item_number Null Number No No
product_uom_code Null Varchar2 No No
net_price Null Number No No
sync_action_code Null Varchar2 No No
line_status_code Null Varchar2 No No
customer_item_number Null Varchar2 No No
customer_item_desc Null Varchar2 No No
display_item_number Null Varchar2 No No
sync_action Null Varchar2 No No
Type PRICE_BOOK_LINES_TBL
price_book_lines_rec Null Record No No
Type PRICE_BOOK_LINE_DETAILS_REC
price_book_line_det_id Null Number No No
list_line_no Null Varchar2 No No

modifier_operand Null Number No No
modifier_application_method Null Varchar2 No No
adjustment_amount Null Number No No
adjusted_net_price Null Number No No
list_line_type_code Null Varchar2 No No
price_break_type_code Null Varchar2 No No
list_name Null Varchar2 No No
application_method_name Null Varchar2 No No
Type PRICE_BOOK_LINE_DETAILS_TBL
The following table lists the record type of which this structure is a plsql table
price_book_line_details_rec Null Record No No
Type PRICE_BOOK_ATTRIBUTES_REC
price_book_attribute_id Null Number No No
pricing_prod_context Null Varchar2 No No
pricing_prod_attribute Null Varchar2 No No
comparison_operator_code Null Varchar2 No No
pricing_prod_attr_value_from Null Varchar2 No No
pricing_attr_value_to Null Varchar2 No No
pricing_prod_attr_datatype Null Varchar2 No No
attribute_type Null Varchar2 No No
context_name Null Varchar2 No No
attribute_name Null Varchar2 No No
attribute_value_name Null Varchar2 No No

attribute_value_to_name Null Varchar2 No No
comparison_operator_name Null Varchar2 No No
Type PRICE_BOOK_ATTRIBUTES_TBL
price_book_attributes_rec Null Record No No
Type PRICE_BOOK_BREAK_LINES_REC
price_book_break_line_id Null Number No No
pricing_context Null Varchar2 No No
comparison_operator_code Null Varchar2 No No
pricing_attr_value_from Null Varchar2 No No
pricing_attr_value_to Null Varchar2 No No
pricing_attribute_datatype Null Varchar2 No No
application_method Null Varchar2 No No
attribute_value_name Null Varchar2 No No
attribute_value_to_name Null Varchar2 No No
comparison_operator_name Null Varchar2 No No
application_method_name Null Varchar2 No No
recurring_value Null Number No No
Type PRICE_BOOK_BREAK_LINES_TBL
price_book_break_lines_rec Null Record No No
Type PRICE_BOOK_MESSAGES_TBL

QP_PRICE_BOOK_MESSAGES% Null Record No No

ROWTYPE
Type PRICE_BOOK_MESSAGES_TBL
VARCHAR2(240) Null Record No No
Type DOCUMENTS_REC
document_id Null Number No No
document_content Null Blob No No
document_content_type Null Varchar2 No No
document_name Null Varchar2 No No
Validation of Get Price Book API

Standard Validation
Oracle Advanced Pricing validates all required input parameters in the Get Price Book
API. For more information, see: Oracle eTRM (eTechnical Reference Manual) available
on OracleMetaLink.
Other Validation
Oracle Advanced Pricing ensures that an external user can only query a price book
whose customer id matches the customer id of the user or the parent organization of the
customer id of the user. If the Customer party associated with the user is a Person party
who belongs to an Organization party (for example, a record exists in the Trading
Community Architecture (TCA) table hz_relationships with a party_type of
PARTY_RELATIONSHIP for the Customer party of the user and the Object (object_id)
of the relationship is an Organization party), then the Person can query a price book
created for himself or for the Organization to which he belongs, but not for any other
customer.
An external user cannot query a price book with the pricing perspective Purchasing. An
internal user can query a price book with the pricing perspective Purchasing. However,
these price books have a customer_id of -1. So the internal user must pass -1 for the
input parameter p_customer_id while calling the Get_Price_Book API.
Error Handling
If any validation of the input parameters fails, the API returns error status to the calling
module from the output parameter x_return_status. Possible values are S or E for
Success and Error respectively. Validation error messages are returned in the output
parameter x_query_messages. Note that the output parameter
x_price_book_messages_tbl contains error messages associated with the generation of
the price book.
Examples of Get_Price_Book API

• QPPBXMP3.sql: Query a price book using the Get_Price_Book API.
• QPPBXMP4.sql: Query a price book using the overloaded version of the

Get_Price_Book API. This version has an additional output parameter
x_documents_rec which is the record containing columns relating to the view
(formatted) document.
Get Price List Application Program Interface

This section explains how to use the Get_Price_List API and how it functions in Oracle
Advanced Pricing.
The Get Price List API retrieves all the price lists for a given currency code and/or
agreement id. The package QP_UTIL_PUB contains the procedure Get_Price_List.
Functional Overview
While processing an order using a particular currency code and/or agreement id, the
OM displays a valid set of price lists when the LOV is activated. The OM calls this API
to get the valid price lists for the given currency code, and/or agreement id and pricing

effective date. If the pricing effective date is not passed by calling application, the
current date defaults. If the profile options QP: Multi Currency Installed and QP: Multi
Currency Usage are set to Y (Yes), then the price lists are retrieved by joining the view
qp_list_headers_vl and table qp_currency_details; otherwise, only the view
qp_list_headers_vl is used.

The following chart describes all parameters used by the Get_Price_List API. All of the
Get_Price_List
l_currency_code IN Varchar2 Yes No
ve_date
l_agreement_id IN Number No No
l_price_list_tbl OUT price_list_tbl No No
PRICE_LIST_REC
PRICE_LIST_REC
price_list_id Null Number Yes No
Description Null Varchar2 Yes No
PRICE_LIST_TBL
PRICE_LIST_TBL
price_list_rec Null Record No No
Validation of Get_Price_List API

Validations:
Standard Validation
The caller is responsible for passing the right parameters to Get_Price_List.
For specific information on the data implied by these columns, see: Oracle Pricing
Other Validation
None.
Error Handling
If any exception occurs in the Get_Price_List API, it does not return any price lists.
Multi-Currency Conversion Setup Application Program Interface

This section explains how to use the Multi-Currency Conversion Setup API and how it
functions in Oracle Advanced Pricing. The Multi-Currency Conversion Setup package
consists of entities to set up Multi-Currency Conversion.
Functional Overview
The Multi-Currency Conversion Setup package QP_Currency_PUB. Process_Currency
contains the following public record type and table of records entities:
• Process_Currency: QP_Currency_PUB.Process_Currency: Takes two record types
and two table types as input parameters. Use this API to insert, and update
Multi-Currency Conversion and to set up a Multi-Currency Conversion for a given
p_CURR_LISTS_rec record structure. The Multi-Currency Conversion can not be
deleted but it can be inactivated by setting the effective dates.
You can:

• Set up multiple multi-currency conversion lines by giving multiple multi-currency
conversion line definitions in the p_CURR_DETAILS_tbl table structure.
• Curr_Lists_Rec_Type: Corresponds to the columns in the multi-currency header

tables QP_ CURRENCY_LISTS_B and QP_CURRENCY_LISTS_TL.
• Curr_Lists_Val_Rec_Type: Attributes that store the meaning of id or code columns

in the multi-currency header table QP_ CURRENCY_LISTS _B, for example, Base
Currency.
• Curr_Details_Rec_Type: Corresponds to columns in the multi-currency conversion

line table QP_CURRENCY_DETAILS.
• Curr_Details_Tbl_Type: Table of Curr_Details_Rec_Type.
• Curr_Details_Val_Rec_Type: Attributes that store the meaning of id or code

columns in the multi-currency conversion line table QP_CURRENCY_DETAILS, for
example, Markup_Formula.
• Curr_Details_Val_Tbl_Type: Table of Curr_Details_Val_Rec_Type.

The following chart describes all parameters used by the public Multi-Currency
Conversion Setup. All of the inbound and outbound parameters are listed. Additional
PROCESS_CURRENCY
PROCESS_CURRENCY
umber
p_CURR_LISTS_ In Curr_Lists_Rec_ No No
rec Type
p_CURR_LISTS_ In Curr_Lists_Val_ No No
val_rec Rec_Type
p_CURR_DETAI In Curr_Details_Tbl No No
LS_tbl _Type
p_CURR_DETAI In Curr_Details_Va No No
LS_val_tbl l_Tbl_Type
x_CURR_LISTS_ Out Curr_Lists_Rec_ No No

rec Type
x_CURR_LISTS_ Out Curr_Lists_Val_ No No

val_rec Rec_Type
x_CURR_DETAI Out Curr_Details_Tbl No No

LS_tbl _Type
x_CURR_DETAI Out Curr_Details_Va No No

LS_val_tbl l_Tbl_Type
CURR_LISTS_REC_TYPE
CURR_LISTS_REC_TYPE

base_currency_c Null Varchar2 Yes No

ode
Context Null Varchar2 No No

_id

n
Name Null Varchar2 No No
base_rounding_f Null Number No No

actor
base_markup_fo Null Number No No

rmula_id
base_markup_op Null Varchar2 No No

erator
base_markup_va Null Number No No

lue

tion_id

_date
Operation Null Varchar2 Yes No

CURR_LISTS_TBL_TYPE
CURR_LISTS_TBL_TYPE
Curr_Lists_Rec_ Null Record No No

Type
CURR_LISTS_VAL_REC_TYPE
CURR_LISTS_VAL_REC_TYPE
base_currency Null Varchar2 No No
base_markup_fo Null Varchar2 No No

rmula
CURR_LISTS_VAL_TBL_TYPE
CURR_LISTS_VAL_TBL_TYPE
Curr_Lists_Val_ Null Record No No

Rec_Type
CURR_DETAILS_REC_TYPE
CURR_DETAILS_REC_TYPE
conversion_date Null Date No No
conversion_date Null Varchar2 No No

_type
conversion_type Null Varchar2 Yes No

currency_detail_ Null Number No No

id

_id
fixed_value Null Number No No

n
markup_formula Null Number No No

_id
markup_operato Null Varchar2 No No

r
markup_value Null Number No No

tion_id

_date
selling_rounding Null Number No No

_factor
to_currency_cod Null Varchar2 Yes No

e
curr_attribute_ty Null Varchar2 No No

pe
curr_attribute_co Null Varchar2 No No

ntext
curr_attribute Null Varchar2 No No
curr_attribute_v Null Varchar2 No No

alue
Precedence Null Number No No
CURR_DETAILS_TBL_TYPE
CURR_DETAILS_TBL_TYPE
Curr_Details_Re Null Record No No

c_Type
CURR_DETAILS_VAL_REC_TYPE

CURR_DETAILS_VAL_REC_TYPE
currency_detail Null Varchar2 No No
markup_formula Null Varchar2 No No
price_formula Null Varchar2 No No
to_currency Null Varchar2 No No
CURR_DETAILS_VAL_TBL_TYPE
CURR_DETAILS_VAL_TBL_TYPE
Curr_Details_Va Null Record No No

l_Rec_Type
Validation of Multi-Currency Conversion API

Validations:
Standard Validation
Oracle Advanced Pricing validates all required columns in the Multi-Currency
Conversion API. For more information, see: Oracle Pricing Technical Reference Manual.
Other Validation
None
Error Handling
Multi-Currency Conversion API processes the rows and reports the values in the
following table for every record.
Error Handling
Success 5 null
Example of Multi-Currency Conversion API

QPXEXCUR.sql: This script creates a multi-currency conversion list converting USD to
FRF and GBPn.
Attaching a multi-currency conversion to a Price List
The multi-currency conversion can be attached to a Price List by passing the currency
header id (of the multi-currency conversion to be attached) to the record
QP_Price_List_PUB. Price_List_Rec_Type while using the Application Program
Interface (QP_Price_List_PUB. Process_Price_List() ) for Price List.
Attaching a multi-currency conversion to 'AGR' agreement
The multi-currency conversion can be attached to a Agreement by passing the currency
header id (of the multi-currency conversion to be attached) to the record
QP_PRICE_LIST_PUB.Price_List_Rec_Type while using the Application Program
Interface (OE_Pricing_Cont_PUB.Process_Agreement () ) for Agreement.
Defaulting a multi-currency conversion to a 'STANDARD' agreement from the
price list
The multi-currency conversion of price list gets defaulted while creating an agreement
of type STANDARD. No extra steps are needed. Just specify the price list id, as used to
be, while creating an agreement of type STANDARD using the Application Program
Interface (OE_Pricing_Cont_PUB.Process_Agreement () ) for Agreement.
Price List Setup Application Program Interface

This section explains how to use the Price List Setup API and how it functions in Oracle
Advanced Pricing. The Price List Setup package consists of entities to set up price lists.
Functional Overview
The Price List Setup package QP_Price_List_PUB.Process_Price_List contains the
following public record type and table of records entities:
• Process_Price_List: QP_Price_List_PUB.Process_Price_List: Takes two record types
and six table types as input parameters. Use this API to insert, update, and delete

price lists and to set up a price list for a given p_PRICE_LIST_rec record structure.
You can:
• Set up multiple price list lines by giving multiple price list line definitions in the p_
PRICE_LIST_LINE_tbl table structure.
• Attach multiple qualifiers at the price list header level by giving multiple qualifiers
in the p_QUALIFIERS_tbl table structure.
• Attach multiple pricing attributes to price list lines by giving the pricing attributes
• Price_List_Rec_Type: Corresponds to the columns in the price list header tables

QP_ LIST_HEADERS_B and QP_LIST_HEADERS_TL.
• Price_List_Val_Rec_Type: Attributes that store the meaning of id or code columns

in the price list header table QP_LIST_HEADERS_B, for example, Currency.
• Price_List_Line_Rec_Type: Corresponds to columns in the price list line table and

related modifiers tables QP_LIST_LINES and QP_RLTD_MODIFIERS.
• Price_List_Line_Tbl_Type: Table of Price_List_Line_Rec_Type.
• Price_List_Line_Val_Rec_Type: Attributes that store the meaning of id or code

columns in the price list line table QP_LIST_LINES, for example, Price_By_Formula.
• Price_List_Line_Val_Tbl_Type: Table of Price_List_Line_Val_Rec_Type.
• Qualifiers_Rec_Type: Corresponds to the columns in the qualifier table QP_

QUALIFIERS.
• Qualifiers_Tbl_Type: Table of Qualifiers_Rec_Type.
• Qualifiers_Val_Rec_Type: Made up of attributes that store the meaning of id or

code columns in the qualifiers table QP_QUALIFIERS, for example, Qualifier_Rule.
• Qualifiers_Val_Tbl_Type: Table of Qualifiers_Val_Rec_Type.

QP_ PRICING_ATTRIBUTES.
• Pricing_Attr_Tbl_Type: Table of Pricing_Attr_Rec_Type.
• Pricing_Attr_Val_Rec_Type: Attributes that store the meaning of id or code

columns in the pricing attributes table QP_PRICING_ATTRIBUTES, for example,
Accumulate.
• Pricing_Attr_Val_Tbl_Type: Table of Pricing_Attr_Val_Rec_Type.

The following chart describes all parameters used by the public Price List Setup. All of
the inbound and outbound parameters are listed. Additional information on these
parameters may follow.
PROCESS_PRICE_LIST
PROCESS_PRICE_LIST
p_api_version_number In Number No No
p_PRICE_LIST_rec In Price_List_Re No No
c_ Type
p_PRICE_LIST_val_rec In Price_List_V No No
al_ Rec_Type
p_PRICE_LIST_tbl In Price_List_Li No No
ne_ tbl_type
p_PRICE_LIST_val_tbl In Price_List_Li No No
ne_Val_tbl_t
ype

p_QUALIFIERS_tbl In QP_Qualifier No No
_ Rules_
PUB.Qualifie
rs_ tbl_Type
p_QUALIFIERS_val_tbl In QP_Qualifier No No
_ Rules_
PUB.Qualifie
rs_
val_tbl_Type
p_PRICING_ATTR_tbl In Pricing_Attr_ No No
tbl_ type
p_PRICING_ATTR_val_tbl In Pricing_Attr_ No No
val_ tbl_type
x_PRICE_LIST_rec Out Price_List_Re No No

c_ Type
x_ PRICE_LIST_val_rec Out Price_List_V No No

al_ Rec_Type
x_PRICE_LIST_LINE_tbl Out Price_List_Li No No

ne_ tbl_type
x_PRICE_LIST_LINE_ val_tbl Out Price_List_Li No No

ne_Val_tbl_t
ype
x_QUALIFIERS_tbl Out QP_Qualifier No No

_ Rules_
PUB.Qualifie
rs_ tbl_Type
x_QUALIFIERS_val_tbl Out QP_Qualifier No No

_ Rules_
PUB.Qualifie
rs_
val_tbl_Type
x_PRICING_ATTR_tbl Out Pricing_Attr_ No No

tbl_ type
x_PRICING_ATTR_val_tbl In Pricing_Attr_ No No
val_ tbl_type
p_check_duplicate_lines* In VARCHAR2 No No
Note: The default value is Y

(Yes).
*Note: p_check_duplicate_lines: This parameter controls the duplicate check for price
list lines through QP_Price_List_PUB.Process_Price_list and the
OE_Pricing_Cont_PUB.Process_Agreement API. The parameter is optional and the
default value is set to NULL meaning the API does the duplicate check. For any
parameter value other than N (No), then the API checks for duplicate lines. The global
variable G_CHECK_DUP_PRICELIST_LINES defined in package QP_GLOBALS holds
the passed parameter value for the session.
PRICE_LIST_REC_TYPE
PRICE_LIST_REC_TYPE


ag

de

n
org_id Null Number No Yes

der_ref

tion_id

_date

de

Active_flag Null Varchar2 No No

(Default value is
Yes.)

d

_id
locked_from_list Null Number No No

_header_id
Source_System_c Null Varchar2 Yes No

ode
Sold_to_org_id Null Number Yes No
price_list_rec, if the global_flag is passed as FND_API.G_MISS_CHAR,
the API will default the global_flag as "Y." If global_flag is passed as
"N" and if org_id is not null, the API will create the modifier list for that
operating unit (OU). If global_flag is passed as "N" and org_id is not
passed, the API will derive the org_id from the org context if set; if not,
use the default OU for that responsibility. The API will validate the
Org_id to check if the Org_Id corresponds to one of the OUs for that
responsibility and raise an error if org_id is not valid.
PRICE_LIST_TBL_TYPE
PRICE_LIST_TBL_TYPE

ype


ec_Type

de

tor

uom

te

ormula_id

d


n

de

ode

e_periods

_code

a_id

ag

_flag

tion_id

_date

_code

e_id

code

bute

text

ue


ier_id

oup_no

nce
break_uom_code Null Varchar2 No No
break_uom_cont Null Varchar2 No No

ext
break_uom_attri Null Varchar2 No No

bute
Customer_Item_ Null Number Yes No

Id

Rec_Type

ormula

a

n_type


e

Val_Rec_ Type
QUALIFIERS_REC_TYPE
QUALIFIERS_REC_TYPE
QP_Qualifier_Ru Null Record No No

les_
PUB.Qualifiers_
Rec_Type
Refer to the Qualifiers public API for the definition.

QUALIFIERS_TBL_TYPE
QUALIFIERS_TBL_TYPE

les_
PUB.Qualifiers_
Tbl_Type


les_
PUB.Qualifiers_
Val_Rec_ Type


les_
PUB.Qualifiers_
Val_Tbl_ Type
Note: For setting up a Secondary Price List, create a qualifier with the
following parameters:
• QUALIFIER_CONTEXT: MODLIST

• QUALIFIER_ATTRIBUTE: QUALIFIER_ATTRIBUTE4
• QUALIFIER_ATTR_VALUE: <list_header_id of the primary price

list>
• LIST_HEADER_ID: <list_header_id of the secondary price list>
• COMPARISON_OPERATOR_CODE: =

ng_number

n

_context

_id

e_from

e_to


e

e_context

ue

de

tion_id

_date

NE_index

ier_id

rator_code

e_datatype
pricing_attribute Null Varchar2 No Yes

_datatype

_Type


_Rec_ Type
Validation of Price List Setup API

Validations:
Standard Validation
Oracle Advanced Pricing validates all required columns in the Price List Setup API.
Other Validation
None
Error Handling
If any validation fails, the API will return error status to the calling module. The Price
List Setup API processes the rows and reports the values in the following table for every
record.
Error Handling
Success 5 null
Example of Price List Setup API

• QPPLXMP1.sql: This sample script inserts three price list lines into a price list with
and the product information for each of the lines (product information is stored in
pricing attributes table in product attribute columns). This sample price list does
not have any qualifiers or price breaks or non product-information type of pricing
attributes.
• QPPLXMP2.sql: This sample script inserts three price list lines into a price list and
the product information for each of the lines (product information is stored in
pricing attributes table in product attribute columns); one secondary price list; two
price list qualifiers (only header level qualifiers supported for price lists); and two
non-product pricing attributes per price list line.
• QPPLXMP3.sql: This script inserts one price list line into a price list with product
information for this line (product Information is stored in pricing attributes table in
product attribute columns); one non-product pricing attribute for the price list line;
and one price list qualifier (only header level qualifiers supported for price lists).
• QPPLXMP4.sql: This script inserts one price list line of type PBH (price break
header) into a price list and the product information for this line (product
information is stored in pricing attributes table in product attribute columns); a
regular pricing attribute (non product) and a price break child line. To create a price
break child line, you must create a combination of a list line and a pricing attribute
where the pricing attribute can only have the Volume pricing context and Pricing
Attribute of Item Quantity.
• QPPLXMP5.sql: This script inserts the list price on a price list line. This script must
be modified by the user such that the qpr_list_line_ tbl(K).list_line_id
column is populated with a valid list_line_id from the instance where this script is
run.
Price List Setup Group Application Program Interface

This section explains how to use the Price List Setup Group API and how it functions in
Oracle Advanced Pricing. The Price List Setup package consists of entities to set up
price lists.
Functional Overview
The Price List Setup package QP_Price_List_GRP.Process_Price_List contains the
following public record type and table of records entities:
• Process_Price_List: QP_Price_List_GRP.Process_Price_List:Takes two record types
and six table types as input parameters. Use this API to insert, update, and delete
price lists and to set up a price list for a given p_PRICE_LIST_rec record structure.
You can:
• Set up multiple price list lines by giving multiple price list line definitions in the p_
PRICE_LIST_LINE_tbl table structure.
• Attach multiple qualifiers at the price list header level by giving multiple qualifiers
in the p_QUALIFIERS_tbl table structure.
• Attach multiple pricing attributes to price list lines by giving the pricing attributes
• Price_List_Rec_Type: Corresponds to the columns in the price list header tables

QP_ LIST_HEADERS_B and QP_LIST_HEADERS_TL.
• Price_List_Val_Rec_Type: Attributes that store the meaning of id or code columns

in the price list header table QP_LIST_HEADERS_B, for example, Currency.
• Price_List_Line_Rec_Type: Corresponds to columns in the price list line table and

related modifiers tables QP_LIST_LINES and QP_RLTD_MODIFIERS.
• Price_List_Line_Tbl_Type: Table of Price_List_Line_Rec_Type.
• Price_List_Line_Val_Rec_Type: Attributes that store the meaning of id or code

columns in the price list line table QP_LIST_LINES, for example, Price_By_Formula.
• Price_List_Line_Val_Tbl_Type: Table of Price_List_Line_Val_Rec_Type.
• Qualifiers_Rec_Type: Corresponds to the columns in the qualifier table

QP_QUALIFIERS.
• Qualifiers_Tbl_Type: Table of Qualifiers_Rec_Type.
• Qualifiers_Val_Rec_Type: Made up of attributes that store the meaning of id or

code columns in the qualifiers table QP_QUALIFIERS, for example, Qualifier_Rule.
• Qualifiers_Val_Tbl_Type: Table of Qualifiers_Val_Rec_Type.

QP_PRICING_ATTRIBUTES.
• Pricing_Attr_Tbl_Type: Table of Pricing_Attr_Rec_Type.
• Pricing_Attr_Val_Rec_Type: Attributes that store the meaning of id or code

columns in the pricing attributes table QP_PRICING_ATTRIBUTES, for example,
Accumulate.
• Pricing_Attr_Val_Tbl_Type: Table of Pricing_Attr_Val_Rec_Type.

The following chart describes all parameters used by the Price List Group API. All of
the inbound and outbound parameters are listed. Additional information on these
PROCESS_PRICE_LIST
PROCESS_PRICE_LIST
umber
p_PRICE_LIST_r In Price_List_Rec_ No No
ec Type
p_PRICE_LIST_ In Price_List_Val_ No No
val_rec Rec_Type
p_PRICE_LIST_t In Price_List_Line_ No No
bl tbl_type
p_PRICE_LIST_ In Price_List_Line_ No No
val_tbl Val_tbl_type
p_QUALIFIERS_ In QP_Qualifier_Ru No No
tbl les_PUB.Qualifie
rs_tbl_Type
p_QUALIFIERS_ In QP_Qualifier_Ru No No
val_tbl les_PUB.Qualifie
rs_val_tbl_Type
p_PRICING_AT In Pricing_Attr_tbl_ No No
TR_tbl type

p_PRICING_AT In Pricing_Attr_val No No
TR_val_tbl _tbl_type
x_PRICE_LIST_r Out Price_List_Rec_T No No

ec ype
x_ Out Price_List_Val_R No No
PRICE_LIST_val ec_Type
_rec
x_PRICE_LIST_L Out Price_List_Line_t No No

INE_tbl bl_type
x_PRICE_LIST_L Out Price_List_Line_ No No

INE_val_tbl Val_tbl_type
x_QUALIFIERS_ Out QP_Qualifier_Ru No No

tbl les_PUB.Qualifie
rs_tbl_Type
x_QUALIFIERS_ Out QP_Qualifier_Ru No No

val_tbl les_PUB.Qualifie
rs_ val_tbl_Type
x_PRICING_AT Out Pricing_Attr_tbl_ No No

TR_tbl type
x_PRICING_AT Out Pricing_Attr_val No No

TR_val_tbl _tbl_type
following table:
Short Name Key
Drv Derived
Req Required
Yes : This is a required parameter.
No : This is an optional parameter.
PRICE_LIST_REC_TYPE
PRICE_LIST_REC_TYPE
Attribute1 Null Varchar2 No No


ag

de

n

tion_id

_date

de
Active_flag Null Varchar2 No No

d

_id


der_ref
org_id Null Number No No
Source_System_c Null Varchar2 Yes No

ode
Sold_to_org_id Null Number Yes No
Note: On the price_list_rec, if the global_flag is passed as

FND_API.G_MISS_CHAR, the API will default the global_flag as "Y." If
global_flag is passed as "N" and if org_id is not null, the API will create
the modifier list for that operating unit (OU). If global_flag is "N" and
Org_Id is not passed, the API will derive the org_id from the org
context (if set); if not, use the default OU for that responsibility. The
API will validate the Org_id to check if the Org_Id corresponds to one
of the OUs for that responsibility and raise an error if the org_id is not
valid.
PRICE_LIST_TBL_TYPE
PRICE_LIST_TBL_TYPE

ype
Currency Null Varchar2 No No
Prorate Null Varchar2 No No
Terms Null Varchar2 No No

ec_Type


de

tor

uom

te

ormula_id

d

n

de


ode

e_periods

_code

a_id

ag

_flag

tion_id

_date

_code

e_id

code

bute

text

ue

ier_id

oup_no

nce


Rec_Type

ormula

a

n_type

e
PRICE_LIST_LINE_VAL_TBL_TYPE
PRICE_LIST_LINE_VAL_TBL_TYPE

Val_Rec_Type
QUALIFIERS_REC_TYPE

QUALIFIERS_REC_TYPE

les_
PUB.Qualifiers_
Rec_Type
QUALIFIERS_TBL_TYPE
QUALIFIERS_TBL_TYPE

les_
PUB.Qualifiers_
Tbl_Type

les_PUB.Qualifie
rs_Val_Rec_Typ
e

les_PUB.Qualifie
rs_Val_Tbl_Type

To set up a secondary price list, create a qualifier with the following parameters:
• QUALIFIER_CONTEXT: MODLIST
• QUALIFIER_ATTRIBUTE: QUALIFIER_ATTRIBUTE4
• QUALIFIER_ATTR_VALUE: <list_header_id of the primary price list>
• LIST_HEADER_ID: <list_header_id of the secondary price list>
• COMPARISON_OPERATOR_CODE: =


ng_number

n

_context

_id

e_from

e_to

e

e_context

ue

de

tion_id

_date

Operation Null Varchar2 Yes No

NE_index

ier_id

rator_code

e_datatype
pricing_attribute Null Varchar2 No Yes

_datatype

_Type
Accumulate Null Varchar2 No No
Excluder Null Varchar2 No No

_Rec_Type
Validation of Price List Group API

Validations:
Standard Validation
Oracle Advanced Pricing validates all required columns in the Price List Group API.
For more information, see: Oracle Pricing Technical Reference Manual.
Other Validation
None
Error Handling
List Group API processes the rows and reports the values in the following table for
every record.

Error Handling
Success 5 null
Price Request Application Program Interface

This section explains how to use the Price Request API and how it functions in Oracle
Pricing. The Price Request group API has procedures to be called to pass the request
information to the pricing engine. This API also has the different constants that the
pricing engine uses for error status, codes and so on.
The Price Request Application Program Interface (API) is a public API that allows you
to get a base price and to apply price adjustments, other benefits, and charges to a
transaction. Oracle Applications products request it for pricing calculations and you can
request it from custom applications and legacy systems.
A pricing request consists of numerous price request lines which mirror the transaction
lines of the calling application and may include a transaction header request line. Since
it is PL/SQL based, the pricing request processes one pricing request per call.
To properly use the Price Request Application Program Interface, pass all lines that
need prices and that the pricing engine needs to consider as part of pricing request. For
example, you may have frozen the price of one order line but, if you include it in the
pricing request, the pricing engine may be able to use the quantity on that line to
qualify the order to receive another discount based on quantities across multiple lines.
The Price Request Application Program Interface consists of two engines:
• Search engine: Uses qualifiers and pricing attributes passed from the calling
application to select the price list lines and the modifier list lines that may apply to
the pricing request. As part of this process, the search engine uses rules of
eligibility, incompatibility, exclusivity, and precedence.
For each pricing phase the search engine executes the following functions:
• Selects eligible price list lines and modifier list lines using predefined pricing rules.
• Resolve incompatibilities among eligible benefits.
• Applies the eligible benefits to the pricing request.
• Calculation engine: For each pricing request line and its associated pricing request
line details, calculates the base price, adjusted price, and extended price.
You can call one or both of the engines by setting the calculate flag on the control
record.
Functional Overview
The Price Request public API QP_PREQ_PUB contains the following entities:
• CONTROL_RECORD_TYPE: Parameters which control the behavior of the pricing
engine.
• LINE_REC_TYPE: A record which contains the elements in the calling application

that requires a base and adjusted price. It may equate to a transaction line or
transaction header record in the calling application.
• LINE_DETAIL_REC_TYPE: A record that contains the details of the derivation of

the base and adjusted prices. Each pricing request line detail provides details for a
price list line or modifier list line. The pricing engine may apply many pricing
request line detail records to a pricing request.
• QUAL_REC_TYPE: A record that contains qualifier information. Qualifier

information helps the pricing engine to determine the price list lines and modifier
list lines for which a pricing request is eligible. The pricing engine returns all
qualifiers that determined eligibility on the request line detail record.
• LINE_ATTR_REC_TYPE: A record that contains pricing attributes. Pricing attribute

information helps the pricing engine to determine the price list lines and modifier
list lines for which a pricing request is eligible. The calling application must load all
pricing attributes into this record type that the pricing engine should use to
determine if a pricing request line qualifies for a price or modifier.
• RELATED_LINES_REC_TYPE: A record that contains relationships between

request lines and between request lines and request line details. Types of
relationships are as follows:
• PBH_LINE: Relates a price break header to modifier price break lines.
• SERVICE_LINE: Relates an order line for a service item and its parent, the
serviceable item. The pricing engine needs to know this relationship when it must
price service items based on a percent of the serviceable item price.
• GENERATED_LINE: Indicates the lines—both request and detail that a pricing

request line or pricing request detail line created.

The following chart describes all parameters used by the public Price Request. All of the
inbound and outbound parameters are listed. Additional information on these
parameters follows.
Insert_Lines2
This API takes the request line information and does a bulk insert into the pricing
temporary table which holds the request lines, qp_preq_lines_tmp. Each of the input
parameter is a pl/sql table to enable the bulk insert. If an error occurs, this API returns
x_return_status as FND_API.G_RET_STS_ERROR.
QP_PREQ_GRP.INSERT_LINES2
Note: The value for qp_preq_lines_tmp.price_list_header_id has

precedence over the sourced price list value. For example, if a
consumer application passes the price list id in
qp_preq_lines_tmp.price_list_header_id, but also has a sourcing rule
for the price list attribute, the value in qp_preq_lines_tmp takes
precedence.
QP_PREQ_GRP.INSERT_LINES2
Parameter Usag Type

e
p_LINE_INDEX In QP_PREQ_GRP.PLS_INTEGER_TYPE,
p_LINE_TYPE_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_PRICING_EFFECTIVE_DATE In QP_PREQ_GRP.DATE_TYPE
p_ACTIVE_DATE_FIRST In QP_PREQ_GRP.DATE_TYPE
p_ACTIVE_DATE_FIRST_TYPE In QP_PREQ_GRP.VARCHAR_TYPE,
p_ACTIVE_DATE_SECOND In QP_PREQ_GRP.DATE_TYPE
p_ACTIVE_DATE_SECOND_TYPE In QP_PREQ_GRP.VARCHAR_TYPE ,
p_LINE_QUANTITY In QP_PREQ_GRP.NUMBER_TYPE ,
Parameter Usag Type
e
p_LINE_UOM_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_REQUEST_TYPE_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_PRICED_QUANTITY In QP_PREQ_GRP.NUMBER_TYPE,
p_PRICED_UOM_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_CURRENCY_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_UNIT_PRICE In QP_PREQ_GRP.NUMBER_TYPE,
p_PERCENT_PRICE In QP_PREQ_GRP.NUMBER_TYPE,
p_UOM_QUANTITY In QP_PREQ_GRP.NUMBER_TYPE,
p_ADJUSTED_UNIT_PRICE In QP_PREQ_GRP.NUMBER_TYPE,
p_UPD_ADJUSTED_UNIT_PRICE In QP_PREQ_GRP.NUMBER_TYPE,
p_PROCESSED_FLAG In QP_PREQ_GRP.VARCHAR_TYPE,
p_PRICE_FLAG In QP_PREQ_GRP.VARCHAR_TYPE,
p_LINE_ID In QP_PREQ_GRP.NUMBER_TYPE,
p_PROCESSING_ORDER In QP_PREQ_GRP.PLS_INTEGER_TYPE,
p_PRICING_STATUS_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_PRICING_STATUS_TEXT In QP_PREQ_GRP.VARCHAR_TYPE,
p_ROUNDING_FLAG In QP_PREQ_GRP.FLAG_TYPE,
p_ROUNDING_FACTOR In QP_PREQ_GRP.PLS_INTEGER_TYPE,
p_QUALIFIERS_EXIST_FLAG In QP_PREQ_GRP.VARCHAR_TYPE,
p_PRICING_ATTRS_EXIST_FLAG In QP_PREQ_GRP.VARCHAR_TYPE,

Parameter Usag Type
e
p_PRICE_LIST_ID In QP_PREQ_GRP.NUMBER_TYPE,
p_VALIDATED_FLAG In QP_PREQ_GRP.VARCHAR_TYPE,
p_PRICE_REQUEST_CODE In QP_PREQ_GRP.VARCHAR_TYPE,
p_USAGE_PRICING_TYPE In QP_PREQ_GRP.VARCHAR_TYPE,
p_LINE_CATEGORY In QP_PREQ_GRP.VARCHAR_TYPE :=
QP_PREQ_GRP.G_LINE_CATEGORY_DEF_TB
L
x_status_code OUT VARCHAR2
x_status_text OUT VARCHAR2
For information on each of these parameters, refer the LINE_REC_TYPE defined in this
manual under the price_request API.
Insert_Line_Attrs2
This API takes the attribute information and does a bulk insert into the pricing
temporary table which holds the request line attributes, qp_preq_line_attrs_tmp. Each
of the input parameter is a pl/sql table to enable the bulk insert. In case there is an error,
this API returns x_return_status as FND_API.G_RET_STS_ERROR.
QP_PREQ_GRP.INSERT_LINE_ATTRS2
Parameter Type
p_LINE_INDEX_tbl QP_PREQ_GRP.pls_integer_type
p_LINE_DETAIL_INDEX_tbl QP_PREQ_GRP.pls_integer_type
p_ATTRIBUTE_LEVEL_tbl QP_PREQ_GRP.varchar_type
p_ATTRIBUTE_TYPE_tbl QP_PREQ_GRP.varchar_type
p_LIST_HEADER_ID_tbl QP_PREQ_GRP.number_type
Parameter Type
p_LIST_LINE_ID_tbl QP_PREQ_GRP.number_type
p_CONTEXT_tbl QP_PREQ_GRP.varchar_type
p_ATTRIBUTE_tbl QP_PREQ_GRP.varchar_type
p_VALUE_FROM_tbl QP_PREQ_GRP.varchar_type
p_SETUP_VALUE_FROM_tbl QP_PREQ_GRP.varchar_type
p_VALUE_TO_tbl QP_PREQ_GRP.varchar_type
p_SETUP_VALUE_TO_tbl QP_PREQ_GRP.varchar_type
p_GROUPING_NUMBER_tbl QP_PREQ_GRP.pls_integer_type
p_NO_QUALIFIERS_IN_GRP_tbl QP_PREQ_GRP.pls_integer_type
p_COMPARISON_OPERATOR_TYPE_tbl QP_PREQ_GRP.varchar_type
p_VALIDATED_FLAG_tbl QP_PREQ_GRP.varchar_type
p_APPLIED_FLAG_tbl QP_PREQ_GRP.varchar_type
p_PRICING_STATUS_CODE_tbl QP_PREQ_GRP.varchar_type
p_PRICING_STATUS_TEXT_tbl QP_PREQ_GRP.varchar_type
p_QUALIFIER_PRECEDENCE_tbl QP_PREQ_GRP.pls_integer_type
p_DATATYPE_tbl QP_PREQ_GRP.varchar_type
p_PRICING_ATTR_FLAG_tbl QP_PREQ_GRP.varchar_type
p_QUALIFIER_TYPE_tbl QP_PREQ_GRP.varchar_type
p_PRODUCT_UOM_CODE_TBL QP_PREQ_GRP.varchar_type
p_EXCLUDER_FLAG_TBL QP_PREQ_GRP.varchar_type

Parameter Type
p_PRICING_PHASE_ID_TBL QP_PREQ_GRP.pls_integer_type
p_INCOMPATABILITY_GRP_CODE_TBL QP_PREQ_GRP.varchar_type
p_LINE_DETAIL_TYPE_CODE_TBL QP_PREQ_GRP.varchar_type
p_MODIFIER_LEVEL_CODE_TBL QP_PREQ_GRP.varchar_type
p_PRIMARY_UOM_FLAG_TBL QP_PREQ_GRP.varchar_type
x_status_code OUT VARCHAR2
x_status_text OUT VARCHAR2);
For more information on each of these input parameters, refer to the line_attr_rec_type
in the price_request API.
PRICE_REQUEST
The Derived value for each parameter is Null.
PRICE_REQUEST
Parameter Usage Type Req
p_line_tbl In LINE_TBL_ TYPE Yes
p_qual_tbl In QUAL_TBL_ TYPE No
p_line_attr_tbl In LINE_ATTR_ No
TBL_TYPE
p_line_detail_tbl In LINE_DETAIL_ No
TBL_TYPE
p_line_detail_qual_tb In LINE_DETAIL_ No
l QUAL_TBL_ TYPE
p_line_detail_attr_tbl In LINE_DETAIL_ No
ATTR_TBL_ TYPE
p_related_lines_tbl In RELATED_LINES_TB No (req. for Service

L_ TYPE Line Pricing)
p_control_rec In CONTROL_ Yes

RECORD_TYPE
x_line_tbl Out LINE_TBL_ TYPE Yes
x_qual_tbl Out QUAL_TBL_ TYPE No
x_line_attr_tbl Out LINE_ATTR_ No

TBL_TYPE
x_line_detail_tbl Out LINE_DETAIL_ Yes

TBL_TYPE
x_line_detail_qual_tbl Out LINE_DETAIL_ No

QUAL_TBL_ TYPE
x_line_detail_attr_tbl Out LINE_DETAIL_ No

ATTR_TBL_ TYPE
x_related_lines_tbl Out RELATED_LINES_TB No

L_ TYPE
x_return_status Out Varchar2 Yes
x_return_status_text Out Varchar2 Yes
PRICE_REQUEST (Overloaded)
This API has been overloaded for performance features. The request line and attributes
are inserted into the pricing temporary tables prior to calling this API. Please refer to
the performance features section under this API for more details regarding this call.

PRICE_REQUEST (Overloaded)
p_control_rec In CONTROL_REC_ Yes

TYPE
x_return_status Out Varchar2 Yes
x_return_status_text Out Varchar2 Yes
CONTROL_REC_TYPE
The Derived value for each parameter is Null.
CONTROL_REC_TYPE
Parameter Type Req Usage
PRICING_EVENT Varchar2 Yes A point in the

transaction life cycle
of your transaction at
which you wish to
price it. The pricing
event determines
which phases the
search engine
processes according
to the mapping in
QP_EVENT_PHASES
.
CALCULATE_FLAG Varchar2 Yes Use to call the

engines. Allowable
values are:
QP_PREQ_GRP.
G_SEARCH_ONLY:
Search engine: If you
do not want the
engine to calculate
the selling price.
QP_PREQ_GRP.G_C
ALCUL_ATE_ONLY:
Calculate engine: If
you are passing the
adjustment records to
the engine and you
want the engine to
recalculate the selling
price, without
retrieving new
adjustments.
QP_PREQ_GRP.
G_SEARCH_N_CAL
CULATE: Both the
calculate and search
engines: Regular
engine call. Retrieves
new adjustments and
calculates the selling
price
SIMULATION_FLAG Varchar2 Yes A value of Yes

indicates that the call
to is a pricing
simulation and that
the pricing engine
should not make
permanent record
changes and neither
issue or redeem
coupons.

ROUNDING_FLAG Varchar2 Yes Indicates whether the

calculation engine
should round the list
price and selling price
based on the price list
rounding factor or the
pricing request line
record rounding
factor. When
rounding, the
calculation engine
rounds all
intermediate
subtotals for each
pricing group
sequence. By default,
the rounding is
enabled in the pricing
engine unless the
rounding flag is
explicitly set to No.
Allowable values are:
Y: engine applies the

rounding factor
defined in the price
list
N: unrounded figures
would be returned
Q: Refer to the value

of the profile QP:
Selling Price
Rounding Options
GSA_CHECK_FLAG Varchar2 No Indicates whether the

GSA Violation needs
to be checked,
provided the
customer is not a
GSA customer and
the selling price falls
below the price on the
GSA price list.
Y: engine applies the

rounding factor
defined in the price
list
N: unrounded figures
are returned
TEMP_TABLE_INSE Varchar2 No Indicates if the calling

RT_FLAG application wants the
engine to insert the
order lines into the
QP temporary
table(s). The values
for this are:
Y: The pricing engine

will insert the lines
into the QP
temporary tables
N – This means to the

engine that the order
lines are already there
in the temporary
tables.

MANUAL_DISCOU Varchar2 No This flag is

NT_FLAG introduced to support
new Release 11i
functionality. This
value is set by the
calling application
and the value is based
on the profile QP:
Return Manual
Discounts.
Indicates how pricing

engine should
perform
incompatibility
processing for
manual discounts. he
possible values for
this profile are:
Yes: All the manual

discounts will be
returned. All the
automatic discounts
that get deleted as
part of
incompatibility
processing will be
returned as manual
discounts.
No: All automatic and

manual discounts will
go through
incompatibility
processing and one of
them in each
incompatibility group
will be returned. In
this process an
automatic discount
might get deleted and
a manual discount
might get selected.
SOURCE_ORDER_A Varchar2 No This is for internal

MOUNT_FLAG use of the pricing
engine. Indicates
whether the pricing
engine will source the
order amount
attribute.
Y: Indicates to the
pricing engine to
source the order
amount. It means the
calling application
will provide the order
amount
N: The pricing engine

should calculate the
order amount
CHECK_CUST_VIE Varchar2 No This is for internal

W_FLAG use only. Indicates
whether the pricing
engine should take a
look at caller's pricing
tables.
Y: Indicates that to
access the calling
applications data, the
source system uses
the view provided by
calling application.
N: Indicates that the

calling application
directly provides the
data to the source
system
REQUEST_TYPE_CO Varchar2 Yes Identifies the

DE transaction system
making the pricing
request.

VIEW_CODE Varchar2 No This is for internal

use only. Indicates
the view code for the
transaction system of
the caller.
It indicates database
view id, which the
source system uses to
access the calling
application's data.
USE_MULTI_CURRE Varchar2 No Indicates if the calling

NCY application wants to
use multi-currency.
Valid values: 'Y' or 'N'
Default value: 'N'
USER_CONVERSIO Number No User defined

N_RATE Conversion rate, used
for multi-currency
USER_CONVERSIO Varchar2 No User defined

N_TYPE conversion type, used
for multi-currency
FUNCTION_CURRE Varchar2 No Functional currency,

NCY used for
multi-currency
FULL_PRICING_CA Varchar2 No Indicates if the calling

LL application passed
only changed lines to
the pricing engine or
all the lines during
reprice. Set to 'Y' if
passed all the lines,
'N' if passed only
changed lines. Refer
to the changed lines
feature
GET_FREIGHT_FLA Varchar2 No When the control

G record
get_freight_flag is set
to Y, the pricing
engine will only
process the phases
that have freight
charges existing. The
pricing engine will
return the modifiers
(including freight
charge modifiers and
non-freight charge
modifiers) that are
qualified in these
phases.
Org_Id Number No Passes the Org_Id

(Operating Unit) of
the transaction
placed. If the Org_Id
is not passed, the
pricing engine
derives it from the
Org context (if it is
set), otherwise it uses
the default Org_Id for
the responsibility.
Note: The pricing engine will set the policy context to Single Org to the
Org_Id passed on the control record. If Org_Id is not passed, the
pricing engine will derive the Org_Id from the Org context if it is set;
otherwise use the default Org_Id for the responsibility. If the Org_Id is
not passed to the pricing engine on the control record, and the pricing
engine is not able to derive an Org_Id, it will return prices from global
price lists and modifiers only. If the Build_Contexts API has been called
prior to calling the Price_Request API, the Org Context may have been
set by the Build Contexts API.
The pricing event determines the pricing phases to be run during the call to pricing
engine. If you create your own pricing phase, associate the pricing events to phases
using screen setup _ event phases. Each modifier is associated to one pricing phase.
Pricing engine looks only at those modifiers associated with the phases defined for the
pricing event passed.

The following are some of the seeded pricing events:
Seeded Pricing Events
Pricing Event Pricing Phase
PRICE List Line Base Price
LINE List Line Base Price
LINE List Line Adjustment
LINE Line Charges
LINE Line Charges - Manual
BOOK Modifiers for Book event
ORDER All Lines Adjustments
ORDER Header Level Adjustments
ORDER Header Level Charges
SHIP Line Charges
BATCH Pricing phases in LINE+ORDER
ICBATCH Pricing phases in LINE+ORDER.This event is

specific to Inventory Intercompany Invoice
Transfer Pricing
LINE_REC_TYPE
LINE_REC_TYPE
Parameter Datatype Req Drv Type Usage
REQUEST_T Varchar2 No No In Identifies the

YPE_CODE transaction
system
making the
pricing
request.
PRICING_EV Varchar2 No No N/A Not used

ENT
HEADER_ID Number No No N/A Not used
LINE_INDEX Number Yes No In/Out PL/SQL

unique
identifier for
request line.
LINE_ID Number No No In Unique

identifier of
the request
line in the
calling
application.
LINE_TYPE_ Varchar2 Yes No In Type of line

CODE within the
request.Allo
wable values
are:
• ORDE
R
• LINE

PRICING_EF Date Yes No In/Out Date for

FECTIVE_ which the
DATE pricing
engine
calculates the
prices.
ACTIVE_DA Date No No In/Out In addition to

TE_FIRST the pricing
effective date,
you can
specify two
additional
dates for the
pricing
engine to use
to qualify
pricing
entities. The
pricing
engine
compares this
date against
the first date
range on the
modifier list
—
QP_LIST_HE
ADERS_B.ST
ART_DATE_
ACTIVE_FIR
ST and
QP_LIST_HE
ADERS_B.EN
D_DATE_AC
TIVE_FIRST.
ACTIVE_DA Varchar2 No No In/Out The date type

TE_FIRST_ of
TYPE ACTIVE_DA
TE_FIRST
based on
lookup type
EFFECTIVE_
DATE_
TYPES.
ACTIVE_DA Date No No In/Out In addition to

TE_SECOND the pricing
effective date,
you can
specify two
additional
dates for the
pricing
engine to use
to qualify
pricing
entities. The
pricing
engine
compares this
date against
the first date
range on the
modifier list
—
QP_LIST_HE
ADERS_B.ST
ART_DATE_
ACTIVE_SEC
OND and
QP_LIST_HE
ADERS_B.EN
D_DATE_AC
TIVE_SECO
ND.
ACTIVE_DA Varchar2 No No In/Out The date type

TE_ of
SECOND_TY ACTIVE_DA
PE TE_SECOND
based on
lookup type
EFFECTIVE_
DATE_
TYPES.
LINE_QUAN Number Yes No In/Out Pricing

TITY request line
quantity.

LINE_UOM_ Varchar2 Yes No In/Out Pricing

CODE request line
unit of
measure.
UOM_QUAN Number No No In/Out Unit of

TITY measure
quantity,
internal value
used by
engine to
perform
service
pricing.
PRICED_QU Number No Yes Out Quantity of

ANTITY pricing
request line
that pricing
engine has
priced.
PRICED_UO Varchar2 No Yes Out Unit of

M_CODE measure in
which the
pricing
engine
priced.
CURRENCY_ Varchar2 Yes No In/Out Currency in

CODE which the
pricing
engine
priced.
UNIT_PRICE Number No Yes Out Unit price of

the item that
is expressed
in Priced
UOM Code
PERCENT_P Number No Yes Out Price

RICE calculated as
a percentage
of the price of
another item.
UPDATED_A Number No No In This is used

DJUSTED_U for
NIT_PRICE overriding
the unit
selling price
of an item to
apply a
suitable
manual
adjustment.
In this case,
the pricing
engine will
apply a
suitable
manual
adjustment
after
calculating
the unit
selling price
to match the
updated_adju
sted_unit_pri
ce that the
caller has
passed in.

ADJUSTED_ Number No Yes Out Price per unit

UNIT_PRICE after the
pricing
engine
applies
discounts and
surcharges. It
indicates the
unit price for
the service
item, which
has the
percent price.
PARENT_PRI Number No Yes Out When the

CE pricing
engine
determines
the price of
an item from
the price of
another item,
the price of
the related
item. This is
used only for
service items
and it is
populated
from the
serviceable
item.
PARENT_QU Number No Yes Out When the

ANTITY pricing
engine
determines
the price of
an item from
the price of
another item,
the quantity
of the related
item.
ROUNDING Number No No In/Out The pricing

_FACTOR engine will
use this factor
to which the
selling price
is rounded to
when the
pricing
engine
returns the
price.
If the caller
does not pass
this field, the
pricing
engine will
populate the
rounding
factor from
the qualified
price list into
this field and
use it for
rounding. If
multi-currenc
y is installed
and used, the
pricing
engine will
populate the
selling
rounding
factor of the
matching
currency
from the
attached
multi-currenc
y list
(currency
conversion
criteria) of the
qualified
price list into
this field and

use it for
rounding
PARENT_UO Varchar2 No Yes Out When the

M_CODE pricing
engine
determines
the price of
an item from
the price of
another item,
the unit of
measure of
the related
item.
PRICING_PH Number No No Not used

ASE_ID
PRICE_FLAG Varchar2 Yes No In Indicates the

degree to
which the
price is
frozen.
Allowable
values, based
on lookup
type
CALCULATE
_PRICE_FLA
G are:
Y (Calculate
Price): Apply
all prices and
modifiers to
the request
line.
N (Freeze
Price): Do not
apply any
prices or
modifiers to
the request
line. Consider
the volume of
the request
line when
processing
LINEGROUP
modifiers for
other lines.
P (Partial
Price):, Apply
prices and
modifiers in
phases whose
freeze
override flag
is Y.

PROCESSED Varchar2 No No Out Internal code

_CODE which
indicates the
stage of
engine
processing
when an
error
occurred.
STATUS_CO Varchar2 No No In/Out Returned

DE status.
Allowable
values are:
N: New
record
created(All
'N' records
are returned
back from the
pricing
engine.These
are success
records)
X:
Unchanged(D
efault status
when the line
is passed to
the pricing
engine for
processing)
U: Updated
IPL: Invalid
price
list(When
passed in
price list is
not found ,
then an error
is given)
GSA: GSA
violation
FER: Error
processing
formula
OER: Other
error
CALC: Error
in calculation
engine

UOM: Failed
to price using
unit of
measure
INVALID_U
OM: Invalid
unit of
measure
DUPLICATE
_PRICE_LIST
: Duplicate
price list
INVALID_U
OM_CONV:
Unit of
measure
conversion
not found
INVALID_IN
COMP:
Could not
resolve
incompatibilit
y
INVALID_BE
ST_PRICE:
Could not
resolve best
price
STATUS_TEX Varchar2 No No Out Returned

T message.
PRICE_REQ Varchar2 No Yes In/Out This is

UEST_CODE unique code
to identify
each order
line
consuming a
modifier. It is
request_type
_code
concatenated
to the
header_id
and the
line_id(applic
able only for
order lines as
line_id is null
for header
lines) of the
order line
separated .
HOLD_COD Varchar2 No No Out This indicates

E that a limit
having the
hold_flag
checked has
been
exceeded or
adjusted and
is a
recommendat
ion to the
caller to put
the order/line
on hold.
HOLD_TEXT Varchar2 No No Out This is a

detailed
message
correspondin
g to the
hold_code.

USAGE_PRI Varchar2 No No In/Out Indicates the

CING_TYPE usage pricing
type.
REGULAR –
Regular
pricing
AUTHORIN
G–
Authoring
call
BILLING –
Billing call
LINE_CATE Varchar2 Yes No In/Out Indicates the

GORY line category.
The
applicable
values:
RETURN –
Returned line
CANCEL –
Cancelled
line
NULL –
Regular line
CONTRACT_ Date No No In When UOM

START_DAT conversion is
E time related
and Profile
QP: Time
UOM
Conversion is
set to Oracle
Contracts,
order
quantity by
order UOM
and pricing
quantity by
pricing UOM
are calculated
based on
contract_start
_date,
contract_end
_date.
CONTRACT_ Date No No In When UOM

END_DATE conversion is
time related
and Profile
QP: Time
UOM
Conversion is
set to Oracle
Contracts,
order
quantity by
order UOM
and pricing
quantity by
pricing UOM
are calculated
based on
contract_start
_date,
contract_end
_date.
LINE_UNIT_ Number No Yes Out Unit price by

PRICE order UOM

CHARGE_PE Varchar2 No No In Determines

RIODICITY_ the time
CODE period of the
charge to be
calculated for
an order line
such as daily,
monthly or
one time.
Types Of Request Lines

The following describes the types of request lines:
• Regular Order Line where line_type_code = LINE.
• Summary Line where line_type_code = ORDER which is the summary line for the
whole Sales Order. This line has all the order level attributes attached to it. This line
is required to be passed to the pricing engine to get any Order Level Discounts
based on the attributes or qualifiers that are attached to this Line.
• Lines that are generated or derived by the pricing engine , in case of discounts like
Promotional Good , where in a new order line is created. This line would have the
processed code as ENGINE. The relationship between the new line and the original
request line is stored in the Relationship record structure
RELATED_LINES_REC_TYPE. So, if the pricing engine returns a free good (PRG
Modifier), it generates a new request line.
LINE_DETAIL_REC_TYPE
LINE_DETAIL_REC_TYPE
Parameter Type Req Drv Type Usage
LINE_DETAI Number Yes Yes In/Out PL/SQL

L_INDEX unique
identifier.
Unique
identifier of
request line
detail in
calling
application.
LINE_DETAI Number No No N/A Not Used

L_ID
LINE_DETAI Varchar2 Yes No Out Type of detail

L_TYPE_ line.
CODE
LINE_INDEX Number Yes No In/Out Identifier for

parent
request line.
LIST_HEAD Number Yes No In/Out Identifier of

ER_ID the list
header used
to create or
update the
pricing line.
LIST_LINE_I Number Yes No In/Out Identifier of

D the list line
used to create
or update the
pricing line.

LIST_LINE_T Varchar2 Yes No In/Out Line type of

YPE_CODE the list line
used to
update the
pricing line.
Possible
values can be
found from
the lookup
type
LIST_LINE_T
YPE_CODE
from
qp_lookups
table.
SUBSTITUTI Varchar2 No No Not used.

ON_TYPE_
CODE
SUBSTITUTI Varchar2 No No Not used.

ON_FROM
SUBSTITUTI Varchar2 No No Out Value for

ON_TO terms
substitution
attribute.
AUTOMATI Varchar2 Yes No Out Indicates if

C_FLAG the pricing
engine
should
automatically
apply the
request line
detail to the
request line.
The engine
derives the
value from
the list line.
OPERAND_ Varchar2 Yes No In/Out Type of

CALCULATI operand.
ON_CODE Allowable
values are:
Adjustment
percent(for
discounts)
Adjustment
amount (for
discounts)
Adjustment
NewPrice(for
discounts)
UNIT_PRICE
(for price
lists)
PERCENT_P
RICE(for
price lists)
OPERAND_ Number Yes No In/Out Value of

VALUE pricing
request detail
line, for
example, 10
currency unit
list price with
3% discount
PRICING_G Number Yes No In/Out Indicates the

ROUP_ pricing
SEQUENCE bucket in
which the
pricing
engine
applied this
list line.

PRICE_BREA Varchar2 Yes No In/Out Type of price

K_TYPE_ break based
CODE on lookup
type
PRICE_BREA
K_TYPE_CO
DE. Possible
Values:
POINT ,
RANGE ,
RECURRING
CREATED_F Varchar2 Yes No In/Out List type used

ROM_LIST_ to create or
TYPE_CODE update the
pricing
line.Possible
values can be
found from
the
lookup_type
LIST_TYPE_
CODE from
qp_lookups
table.
PRICING_P Number Yes No In/Out The pricing

HASE_ID phase which
created the
request line
detail.
LIST_PRICE Number No No Out Not Used
LINE_QUAN Number No Yes Out Quantity on

TITY the price
break line.
Populated if
the pricing
engine
derived the
value of the
request line
or request
line detail
from a price
break. A not
null value
indicates that
this perticular
break line
was used in
the
calculation.
ADUSTMEN Number No No Out It holds the

T_AMOUNT value of the
bucketed
adjusted
amount for
line types like
PLL , DIS
,SUR etc. For
price
break(PBH)
child lines ,
the field is
populated if
the pricing
engine
derived the
value of the
request line
or request
line detail
from a price
break.

APPLIED_FL Varchar2 No No In/Out The lists or

AG list lines that
this pricing
event or a
prior pricing
event
applied.
Allowable
values are
Yes:
Applicable
when the
attribute
context is a
list or list line
No:
Applicable
when the
attribute
context is a
list or list line
Null
MODIFIER_L Varchar2 Yes No In/Out The level at

EVEL_ which the list
CODE line qualified
for the
transaction.
Based on
lookup type
MODIFIER_L
EVEL_CODE.
STATUS_CO Varchar2 No No Out Returned

DE status.
Possible
Values:
N: New
record
created(All
'N' records
are returned
back from the
pricing
engine.These
are success
records)
UPDATED:
Indicates
Success status
and that the
record is
Updated
record and is
not new.
X: Indicates
Success status
and that the
record is
Unchanged
BACK_CALC
ULATION_E
RROR :
Indicates that
there were no
qualified
manual
overrideable
adjustments
to adjust the
price.
D : Deleted.
This indicates
Failure.
D_PBH :

deleted in
PBH
processing
STATUS_TE Varchar2 No No Out Returned

XT message.
SUBSTITUTI Varchar2 No No Out Modifier

ON_ details. The
ATTRIBUTE attribute in
the TERMS
context that
the pricing
engine
substituted,
for example,
Payment
Terms. Used
for Term
Substitution-t
ype
modifiers.
ACCRUAL_F Varchar2 No No In/Out Indicates that

LAG the modifier
is an accrual
LIST_LINE_ Varchar2 No No In/Out Modifier

NO number.This
field is
applicable in
case of
Coupon Issue
kind of
modifier line.
ESTIM_GL_V Number No No Out The discount

ALUE or surcharge
value of the
modifier.
Used to
estimate the
discount cost
for
non-monetar
y modifiers.
ACCRUAL_ Number No No Out The rate to

CONVERSIO use when
N_RATE converting a
non-monetar
y accrual to a
monetary
value.
OVERRIDE_ Varchar2 No No In/Out Indicates if a

FLAG user in the
calling
application
can override
the modifier
value.
PRINT_ON_I Varchar2 No No Out Not used.

NVOICE_
FLAG
INVENTORY Number No No Out Inventory

_ITEM_ID item
identifier in
an item
relationship.
Used for list
line type Item
Upgrade.

ORGANIZA Number No No Out Organization

TION_ID identifier in
an item
relationship.
Used for list
line type Item
Upgrade.
RELATED_IT Number No No Out Related

EM_ID inventory
item
identifier in
an item
relationship.
Used for list
line type Item
Upgrade.
RELATIONS Number No No Out Relationship

HIP_TYPE_ type
ID identifier in
an item
relationship.
Used for list
line type Item
Upgrade.
ESTIM_ACC Number No No Out Indicates the

RUAL_RATE percentage at
which to
accrue or, for
a coupon, the
expected rate
of
redemption
of the
coupon.
Liability is
defined as:
ACCRUAL
OR COUPON
VALUE *
ESTIM_
ACCRUAL_R
ATE.
Default
Value: 100
EXPIRATIO Date No No Out The

N_DATE expiration
date of the
accrual or
coupon.
BENEFIT_PR Number No No Out The price

ICE_LIST_ list_line_id
LINE_ID which has the
list price
before
promotional
discount.
Used for
Promotional
Goods-type
modifiers
when the
pricing
engine
creates a new
transaction
line.

RECURRING Varchar2 No No Not Used

_FLAG
BENEFIT_LI Number No No Out Not Used.

MIT
CHARGE_TY Varchar2 No No In/Out Indicates the

PE_CODE type of
charge based
on lookup
type
FREIGHT_C
HARGES_TY
PE. Used for
Freight/Speci
al
Charge-type
modifiers.
CHARGE_S Varchar2 No No In/Out Indicates the

UBTYPE_ type of
CODE charge based
on lookup
type
CHARGE_TY
PE_CODE.
INCLUDE_O Varchar2 No No Out Indicates

N_ whether the
RETURNS_F pricing
LAG engine
should
include the
charge on a
return
transaction.
Used for
Freight/Speci
al
Charge-type
modifiers.
BENEFIT_QT Number No No Out The accrual

Y quantity for
non-monetar
y accruals or,
for
promotional
goods, item
quantity.
BENEFIT_U Varchar2 No No Out The accrual

OM_CODE unit of
measure for
non-monetar
y accruals, or,
for
promotional
goods, item
unit of
measure.
PRORATION Varchar2 No No Out Not Used.

_TYPE_
CODE
SOURCE_SY Varchar2 No No Out Not Used.

STEM_
CODE
REBATE_ Varchar2 No No Out Not Used.

TRANSACTI
ON_TYPE_
CODE
SECONDAR Varchar2 No No Out Indicates that

Y_PRICE_ the pricing
LIST_IND used a
secondary
price list
instead of the
price list that
the calling
application
requested.

GROUP_VA Varchar2 No No Out This is

LUE populated for
modifiers
with modifier
level code
'Group of
Lines' and
arithmetic
operator as
'LUMPSUM'.
It indicates
the
quantity/amo
unt applied
for that order
line to which
this belongs
to. It is the
quantity if
the pricing
attribute has
'Item
Quantity' and
amount if the
pricing
attribute is
'Item
Amount'.
COMMENTS Varchar2 No No Out The

comments on
a modifier
UPDATED_F Varchar2 No No In/Out Indicates that

LAG this modifier
has been
overridden.
PROCESS_C Varchar2 No No Out Indicates the

ODE pricing
engine
processing
code for
internal use.
LIMIT_COD Varchar2 No No Out Indicates that

E the limit on
this modifier
has either
exceeded or
adjusted or
consumed.
Applicable
values:
• EXCE
EDED
• ADJU
STED
• CONS
UME
D
LIMIT_TEXT Varchar2 No No Out The detailed

message
correspondin
g to the
limit_code
FORMULA_I Varchar2 No No Out The

D formula_id
setup on the
modifier.

CALCULATI Varchar2 No No Out Indicates the

ON_CODE calculation
code on the
adjustment.
BACK_CALC
ULATE :
Indicates that
this
adjustment is
a back
calculated
adjustment
and it got
applied to
adjust the
overridden
selling price.
This is related
to the field
updated_adju
sted_unit_pri
ce on
line_rec_type.
ROUNDING Number No No Out Conversion

_FACTOR rounding
factor,
populated
when
multi-currenc
y set-up is
being used
CURRENCY_ Number No No Out Unique

DETAIL_ID identifier for
the
multi-currenc
y detail
record,
populated
when
multi-currenc
y set-up is
being used
CURRENCY_ Number No No Out Unique

HEADER_ID identifier for
the
multi-currenc
y header
record,
populated
when
multi-currenc
y set-up is
being used
SELLING_R Number No No Out Rounding

OUNDING_F Factor,
ACTOR populated
when
multi-currenc
y set-up is
being used
ORDER_CUR Varchar2 No No Out Order

RENCY Currency,
populated
when
multi-currenc
y set-up is
being used
PRICING_EF Date No No Out Pricing

FECTIVE_D effective date,
ATE populated
when
multi-currenc
y set-up is
being used
BASE_CURR Varchar2 No No Out Base currency

ENCY_COD code,
E populated
when
multi-currenc
y set-up is
being used

Break_Uom_ Varchar2 No No Out Unit of

code Measure code
for the price
break.
Break_Uom_ Varchar2 No No Out Context to

Context define the
seeded
context for
break UOM.
Break_Uom_ Varchar2 No No Out Attribute in

Attribute which the
calling
application is
supposed to
pass the
break UOM
of volume
attribute used
for break.
Inserting Lines into Temporary Tables: The pricing engine takes in the input data,
processes and inserts to the temporary table. By inserting the request lines, passed in
attributes, qualifiers and modifiers directly to the temporary tables, pricing engine
performance is improved. The caller can indicate to the pricing engine that the data is
inserted to the temporary tables by passing a value of "No" to the
TEMP_TABLE_INSERT_FLAG on the control record. The following procedures enable
bulk inserts to the pricing temporary tables:
• The procedure INSERT_LINES2 in the pricing engine API QP_PREQ_GRP inserts
the request lines to the temporary table. This procedure does a bulk insert to the
temporary tables, so you need to load the request line details PL/SQL table of
records to individual PL/SQL tables one for each column. The temporary table for
request lines QP_PREQ_LINES_TMP has columns that map to the columns of the
P_LINE_TBL PL/SQL table.
• The procedure INSERT_LINE_ATTRS2 in the API QP_PREQ_GRPT inserts the

passed in attributes. This also does a bulk insert. Each column of the
P_LINE_ATTR_TBL maps to a column in the temporary table for line attributes
QP_PREQ_LINE_ATTRS_TMP .
• The manual modifiers that need to be applied can be inserted into the temporary
table for modifiers QP_PREQ_LDETS_TMP.
• The build sourcing API has been modified to insert into the temporary tables
directly. The procedure BUILD_CONTEXTS in the QP_ATTR_MAPPING_PUB API
populates the temporary tables directly. This can be called to source the necessary
attributes.
• The procedure to make the pricing engine call, PRICE_REQUEST in the pricing
engine API QP_PREQ_PUB, has been overloaded to pass only the control record.
• The output of the pricing engine exists in the temporary tables and the caller can
process the data from the pricing temporary tables.
This is the process to insert records into the temporary tables and this will enhance the
performance of the pricing engine. There is a example script to demonstrate the direct
insertion. Please refer to the example scripts mentioned in this document.
Types of Request Line Details

• Price List Line (PLL): OPERAND_VALUE and
OPERAND_CALCULATION_CODE columns store the price information and the
type of price(UNIT_PRICE or PERCENT_PRICE).
• Discount Line (DIS): OPERAND_VALUE and OPERAND_CALCULATION_CODE

columns store the price information and the type of price(AMT,%,or NEW_PRICE).
• Surcharge Line (SUR): OPERAND_VALUE and

OPERAND_CALCULATION_CODE columns store the price information and the
type of price(AMT,%,or NEW_PRICE).
• Other Item Discount (OID) processing: For OID processing, two request lines need
to be passed to the pricing engine; for example, Buy A get 10% of B.
In the above example A and B need to be ordered on two order lines, so two request
lines are passed to the pricing engine. When the engine does the OID processing, it
creates a discount line for 10% on the 2nd request line, which applies the 10%
discount to the 2nd request line. Also a relationship record is created in the
RELATED_LINES_REC_TYPE record structure. Line Detail Index 8 is the actual
Discount Line which is the OID line and Line Detail Index 9 is the actual benefit line
which is 10% off line. So, the relationship is as follows:

Relationship
Line Index Line Detail Related Line Related Line Relation Ship
Index Index Detail Index Type
1 8(OID Line) 2 9(10% line) GENERATED_

LINE
• Promotional Goods Discount (PRG)

PRG Processing: For example, Buy A get B for free, only Buy Item A request line
needs to be passed to the pricing engine.
In the above example only request line/order line with Item A is sent to the pricing
engine. Item B need not be ordered . This is the basic difference between OID and
PRG. The pricing engine selects the PRG Modifier because of purchase of Item A
and creates a record in the LINE_DETAIL_REC_TYPE record structure (Line Index
1-Line Detail Index 1). Then it tries to give the benefit which is a free B Item. In the
process, it does the following:
1. A new request line is created in the LINE_REC_TYPE record structure.(Line
Index 2).
2. A new relationship between the Item A line and Item B line is created ,in the
RELATED_LINES_REC_TYPE record structure. It is a Line-Line
relationship(Line Index 1 - Line Index 2).
3. A new Price List Line is created for the new request line in the
LINE_DETAIL_REC_TYPE record structure.(Line Index 2 - Line Detail Index 3).
4. A new adjustment line for 100% discount is created for the new request line in
the LINE_DETAIL_REC_TYPE record structure.(Line Index 2 - Line Detail
Index 4).
5. A new relationship line between the original PRG Line Detail Line and the new
100% off line detail is created in the RELATED_LINES_REC_TYPE record
structure .(Line Detail Index 1 - Line Detail Index 4).
6. A new record is created in the LINE_ATTR_REC_TYPE record structure for the

new item B. (Line Index 2 - PRICING_CONTEXT = 'ITEM' ,
PRICING_ATTRIBUTE = 'PRICING_ATTRIBUTE1', PRICING_ATTR_VALUE =
'Item B').
• Terms Substitution (TSN)
• SUBSTITUTION ATTRIBUTE
• SUBSTITUTION TO
• Freight Charge
Freight Charges Processing: All the freight charge discounts do not affect the selling
price. The pricing engine calculates the adjustment amount for the freight charge
discounts but, this does not effect the selling price.
• Manual Modifiers Processing

All the automatic modifiers of type Discounts and Surcharges that the user has
qualified for , that are deleted as part of incompatibility resolution (due to
incompatibility setup rules), are returned as manual discounts. In addition to these
discounts, all the qualified manual modifiers of type Discounts and Surcharge
discounts are also returned to the caller, unapplied.
Manual adjustments can be applied in two ways:
• The caller can pass the manual adjustment to the pricing engine with
Applied_Flag = Y and Updated_Flag = Y. The engine will apply this manual
adjustment. The manual adjustment can be overridden by passing the new
operand on the line_detail_rec_type.adjustment_amount.
Example: A pricing call is made for three order lines with a manual adjustment
of 10% to be applied to the second order line. The manual adjustment should be
passed in the line_detail_tbl with columns updated_flag = Y and applied_flag =
Y and with the line_index of the second order line. The pricing engine API, will
calculate the adjustment amount and will apply this manual adjustment to the
second order line. The applied_flag and updated_flag will be returned as Y to
indicate that it has been applied.
• The selling price can be overridden by passing the new selling price in the
line_detail_rec_type.updated_adjusted_unit_price. The engine will then pick up
a suitable manual overrideable modifier that is qualified and back calculate the
adjustment amount and operand to match the new selling price. In this case the
pricing engine will pass back this manual modifier with calculation_code as
BACK_CALCULATE, updated_flag = Y and applied_flag = Y.
Example: Three order lines are passed to the pricing engine: the unit selling
price on the second order line is $80 and the unit list price is $100 and you want
to override the selling price to $90. In this case, you must pass 80 in the column
UPDATE_ADJUSTED_UNIT_PRICE on the request line in the record
corresponding to the second order line in the LINE_TBL.
Then the pricing engine selects all the qualifying manual overrideable
adjustments, decides whether it needs to apply a discount or a surcharge. It
prefers a manual overrideable adjustment that has been applied already. If

none has been applied already, it randomly picks up a manual adjustment, back
calculates the adjustment amount ($10 surcharge in this case), and returns it
with calculation_code as BACK_CALCULATE.. If there are no qualified manual
overrideable adjustments, an error status is returned on the second order line
indicating that there are no manual adjustments. If an error occurs during the
back calculation, the pricing engine returns an error status on the second order
line. The pricing_status_code on the second order line has the error code
BACK_CALCULATION_ERROR.
• Coupon Issue (CIE)

Coupon processing: For example, Buy Item A , get a Coupon for 10% of Item B.
The pricing engine gets one request line with Item A. Based on the search , the
engine loads the Coupon Issue Modifier Line (CIE) in the
LINE_DETAIL_REC_TYPE record structure. When processing the coupon issue, the
pricing engine generates a coupon number which can be found from the
LIST_LINE_NO column of the LINE_DETAIL_REC_TYPE record structure on the
CIE modifier line. Also, the pricing engine creates a qualifier with this generated
list_line_no for the 10% discount on Item B. That way, this discount will not be
given unless this coupon number is presented the next time as a qualifier to the
pricing engine.
In the above example, suppose C10B is generated as the coupon number. The next
time the customer gets this Coupon and this coupon number is punched in before
making a pricing engine call, then the 10% discount on Item B is given if the
Customer Buys Item B.
• Price Break Header (PBH)

Price Break Processing: The price break processing is the same for both Price List
Breaks and Discount/Surcharge Breaks. Price Breaks can be either POINT or
RANGE breaks. This is found in the PRICE_BREAK_TYPE_CODE column in the
record structure. The following is an example of how a Price Break is set up:
Price Break setup has a Price Break Parent Record which has a line type called PBH.
This PBH record can have more than 1 child record that actually define the breaks.
The parent and child records are contained in the LINE_DETAIL_REC_TYPE
record structure.
Example
List Line Parent/Chil Price Break Price Break Value Break Type
Type Code d From To
PBH Parent -- -- -- POINT/RAN

GE
PLL Child 0 100 $100 POINT/RAN

GE

GE

GE
PLL Child 300 -- $70 POINT/RAN

GE
The Adjustment Amount and Line Quantity Fields exactly tell how and which child
line has been used in deriving the break . For example, if the ordered Quantity is
350, then the record structure will have the following information:
Record Structure Information
List Line Type Adjustment Line Quantity Break Type

Code Amount
PBH $90 350 POINT
PLL $100 0 POINT
PLL $90 0 POINT
PLL $80 0 POINT
PLL $70 350 POINT
PBH $87.1428571 350 RANGE
PLL $100 100 RANGE

List Line Type Adjustment Line Quantity Break Type
Code Amount
PLL $90 100 RANGE
PLL $80 100 RANGE
PLL $70 50 RANGE
The relationship between the Parent and Child Records are stored in the
RELATED_LINES_REC_TYPE record structure. The relationship type is
PBH_LINE.
RELATED_LINES_REC_TYPE
Line Index Line Detail Related Line Related Line Relation Ship
Index Index Detail Index Type
1 8(PBH Line 1 9(PLL Line PBH_LINE

Detail) Detail 1)
1 8 1 10(PLL Line PBH_LINE

Detail 2)

Detail 3)

Detail 4)
• Item Upgrade (IUE)

Important Columns:
• INVENTORY_ITEM_ID
• RELATED_ITEM_ID
• QUAL_REC_TYPE
The Required and Derived values for the following parameters are Null.
QUAL_REC_TYPE
Parameter DataType Type Usage
LINE_INDEX Number In/Out Unique identifier for

request line or
request line detail.
QUALIFIER_CONT Varchar2 In/Out Context for qualifier,

EXT for example,
Customer
Hierarchy.
QUALIFIER_ATTRI Varchar2 In/Out Qualifier attribute,

BUTE for example,
QUALIFIER_ATTRI
BUTE1: Customer
Class.
QUALIFIER_ATTR_ Varchar2 In/Out Value for qualifier

VALUE_FROM attribute
QUALIFIER_ATTR_ Varchar2 In/Out Return value for

VALUE_TO qualifier attribute.
Populated when the
pricing engine
returns details of a
volume break.
COMPARISION_ Varchar2 Out The pricing engine

OPERATOR_CODE creates qualifier
attributes to indicate
to the calling
application which
qualifier attribute
caused it to give a
benefit, for example,
Order Amount >
1000 currency units
(> is the operator
code).

Parameter DataType Type Usage
VALIDATED_FLAG Varchar2 In/Out Indicates that a price

list or modifier
list(asked for
promotion) is valid
for the pricing
request. Applicable
to price list and
modifier list
qualifiers; the
pricing engine
assumes that other
qualifiers are valid.
STATUS_CODE Varchar2 In/Out Return status.
STATUS_TEXT Varchar2 Out Return message
LINE_ATTR_REC_TYPE
LINE_ATTR_REC_TYPE
Parameter Datatype Type Usage
LINE_INDEX Number In/Out Unique identifier for

request line or
request line detail.
PRICING_CONTEX Varchar2 In/Out Context for a

T product or pricing
attribute, for
example, Product
Hierarchy.
PRICING_ATTRIBU Varchar2 In/Out Product or pricing

TE attribute, for
example,
PRICING_ATTRIBU
TE11: Customer
Item ID.
Parameter Datatype Type Usage
PRICING_ATTR_V Varchar2 In/Out Value for product or

ALUE_ FROM pricing attribute.
PRICING_ATTR_V Varchar2 In/Out Return value for

ALUE_ TO Pricing attribute.
Populated when the
pricing engine
returns details of a
volume break
VALIDATED_FLAG Varchar2 In/Out Not used.
STATUS_CODE Varchar2 In/Out Return status
STATUS_TEXT Varchar2 In/Out Return Message
Parameter Dataype Type Usage
LINE_INDEX Number In/Out PL/SQL unique

identifier for request
line.
LINE_DETAIL_IND Number In/Out PL/SQL unique

EX identifier for request
detail line
RELATIONSHIP_TY Varchar2 In/Out Type of relationship

PE_ CODE between pricing
lines.
RLTD_LINE_INDEX Number In/Out PL/SQL identifier for

related request line.

Parameter Dataype Type Usage
RLTD_LINE_DETAI Number In/Out PL/SQL unique

L_ INDEX identifier for related
request detail line.
Validation of Price Request API

Validations:
Standard Validation
Oracle Pricing validates all required columns in the Price Request API. For specific
information on the data implied by these columns, see: Oracle Pricing Technical Reference
Manual for details.
Other Validation
None
Error Handling
Request API processes the rows and reports the following values for every record.
Error Handling
Success 5 Null
Example of Price Request Application Program Interface

The following script names are used in the examples for the Price Request Application
Program Interface:
• qp_engine_testing.sql (All regular Price Lists, Discounts , Surcharges etc.)
• qp_test_service.sql (Service Item Pricing Setup)
• qp_test_oid.sql (Other Item Discount Setup)
• qp_direct_insert.sql (Direct insertion into temporary tables to improve

performance)
• qp_manual_adjustments (Apply manual adjustments)
• qp_override_selling_price.sql (Override the unit selling price)
These scripts help you set up data and make a call to the pricing engine to return the
price and any related discounts. The scripts are located in the following area:
The setup involves passing information to the pricing engine using the following:
1. Control Record Information: The Control Record has parameters which control the
behavior of the pricing engine. Please refer to the example script for more details.
2. Request/Order Line Information: Request Line has information that contains the
elements in the calling application that require a base and adjusted price. It may
equate to a transaction line or transaction header record in the calling application.
Refer to qp_engine_testing.sql for information on setting up the request line data.
LINE_REC_TYPE is the record structure that needs to be completed when passing
information related to a request line.
3. Qualifiers and Pricing Attributes Information: Qualifiers and pricing attributes

information that helps the pricing engine to determine the price list lines and
modifier list lines for which a price request is eligible.
Pricing Attributes and Qualifier Attributes Setup

LINE_ATTR_REC_TYPE is the record structure that needs to be filled in when passing
information related to a pricing attribute. The following are the important columns:
• PRICING_CONTEXT
• PRICING_ATTRIBUTE
• PRICING_ATTR_VALUE_FROM
QUAL_REC_TYPE is the record structure that needs to be filled in when passing

information related to a qualifiers. The following are the important columns:
• QUALIFIER_CONTEXT
• QUALIFIER_ATTRIBUTE
• QUALIFIER_ATTR_VALUE_FROM
Any attribute for example Item, Price List Id, Customer Name, Order Type etc. will
have a mapping to give the Context, Attribute, Value_Id (will be the actual value). For
more information on seeded attributes, see: Oracle Advanced Pricing User's Guide. Please
refer to the following examples:

Pricing Attributes and Qualifier Attributes
Attribute Attribute Context Attribute Value_Id (id) Value

Name (Name)
Pricing Inventory ITEM PRICING_AT 149 AS54888

Attribute Item Id TRIBUTE1
Pricing Plastics ITEM PRICING_AT 29 PLASTIC

Attribute TRIBUTE2
Qualifier Order Type ORDER QUALIFIER_ 1000 Standard

ATTRIBUTE1
Qualifier Customer CUSTOMER QUALIFIER_ 100 Business

ATTRIBUTE1 World
Qualifier Price List MODLIST QUALIFIER_ 1000 Corporate

ATTRIBUTE4
Qualifier Agreement ORDER QUALIFIER_ RESELLER RESELLER

Type ATTRIBUTE9
Qualifier Order Date ORDER QUALIFIER_ 2000/12/10

ATTRIBUTE5 00:00:00
Note: Dates and Numbers are to be passed in canonical format

Canonical Date Format: YYYY/MM/DD HH24:MM:SS Ex: select
fnd_date.date_to_canonical ('01-OCT-2000') from dual; Canonical
Number Format, '.' is the decimal separator. For example, select
fnd_number.number_to_canonical(2000.45) from dual.
Interpreting the results from the pricing engine

• Request Line Information: The output request line record would have the unit_price
and adjusted unit price information. Please refer to the example to see more details.
• Price List/Discount Related Information: The output request line detail record
would have the price list line and modifier list line detail information like the
unit_price value, discount percentage etc. The columns of the output record
structure are described further in this document.
• Qualifiers and Pricing Attributes: The output qualifier and pricing attribute records
would have the qualifiers and pricing attributes which qualified the price list line or
modifier list line. The columns of the output record structure are described further
in this document.
• Related Lines Information: This record structure has information related to Service
Lines Relationship , Price Break Lines Relationship, OID Modifier Line relationship,
PRG Modifier Line Relationship and Order To Line Relationship (Type -
ORDER_TO_LINE) which tells an Order Level Discount was applied to which
Lines.
Pricing Data Bulk Loader API

You can use the Pricing Data Bulk Loader API to load pricing data from interface tables
to the core pricing tables. Before using this feature, ensure that the interface tables
contain the data to be uploaded. When you run the concurrent program QP: Bulk
Import of Price List to upload the data, the Pricing Data Bulk Loader API uploads the
pricing data into the pricing core tables.
Note: Currently, only the price list data is uploaded by the API.
Functional Overview
Using the Pricing Data Bulk Loader API, you can:
• Use the same interface program and tables for updating the pricing data.
• Delete or update pricing attributes, qualifiers, breaks, and so on, using the interface
tables.
• Store the interface program id in the main pricing tables so that user knows which
request id has updated the records.
• Optionally, load list lines even if validation of pricing attributes fails.
• Mark the record as being processed so that multiple processes do not pick up the
same record.
• Process a specific set rather than the entire eligible data.
• Provide all validation error messages in the same run for unloaded records instead
of returning errors one after another.
The pricing data is retrieved from four interface tables to populate the core pricing
tables. The data model and validations should be considered while populating the
interface tables.

Input Tables
• QP_INTERFACE_LIST_HEADERS: This table should be populated with the header
information of the price lists to be uploaded.
• QP_INTERFACE_LIST_LINES: This table should be populated with the line

information of the price lists to be uploaded.
• QP_INTERFACE_PRICING_ATTRIBS: This table should contain the Product and

Pricing attribute details of the price list line, which are to be imported.
• QP_INTERFACE_QUALIFIERS: This table should contain the header qualifiers

associated with the price lists which are to be imported.
Output table
• QP_INTERFACE_ERRORS: This table stores errors encountered during the bulk
import process. The QP core tables are also populated during the bulk import
process.
Note: For more information, see: Oracle eTRM (eTechnical

Reference Manual) available on OracleMetaLink.

The following parameters can be passed to the concurrent program and API:
• Entity: Indicates the pricing entity (for example, price list) that can be uploaded.
Entity type for price lists is PRL.
• Entity Name: Specifies the name of the pricing entity to be processed, for example,
price list name is Corporate. A null value means that all the available entities of that
Entity type in the interface tables should be processed.
• Process ID: This corresponds to the process_id in the interface tables. The Process
ID groups data in the interface table and can be specified by the user as the criteria
to pick up records for processing. A null value for this parameter means all
available records for processing should be considered subject to restrictions
imposed by the value of parameter p_entity_name.
• No of Threads: Indicates the total number of child processes or threads to achieve

multithreading for list lines and their child records. Default is 1.
• Turn Debug On: Valid values are Yes or No. If Yes, detailed debug messages are
written to the concurrent program log file. As debug messages add to the
performance overhead, selecting No results in quicker completion of the concurrent
request.
• Enable Duplicate Check: Has two valid values:
• Yes: Does a duplicate check on the entered lines and gives an error if a
duplicate line is found.
• No: Does not do a duplicate check on the entered lines and, therefore, gives
better performance.
This concurrent program calls the procedure

QP_Bulk_Loader_PUB.Load_Pricing_Data, which has following parameters:
Err_buff Out Varchar2 No No
Retcode Out Number No No
P_entity In Varchar2 No No
P_entity_name In Varchar2 No No
P_process_id In Number No No
P_process_type In Varchar2 No No
P_no_of_threads In Number No No
P_spawned_req In Varchar2 No No
uest
P_request_id In Number No No
P_Debug_On In Varchar2 No
Validation of Pricing Data Bulk Loader

Standard Validation
Some standard validations are listed below.
• UNIT price break has no BLOCK price break child lines.
• If list line type is Price List Line then values for operand, price by formula id,
generate using formula id, cannot all be null.

• Recurring value is not null--when a recurring value is present, the value should be
at least 1. For example, recurring value can be present when price_break_type_code
is RANGE and arithmetic_operator is BLOCK_PRICE.
• If both start date and end date are filled, then start date should be before the end
date.
• If list line type is Price Break Header then price break type code and
RLTD_MODIFIER_GRP_CODE cannot be null.
• If block pricing and price break type code is Point then there should not be any
child lines with unit price or recurring value filled.
• If the price list line and price break header is not NULL then both line and child line
should have unit price or line and the child line should have block pricing. For
break unit price, the parent line should be block price and break type code should
be range.
All the standard price list validations are done. Some fields like
SHIP_METHOD_CODE, FREIGHT_TERMS_CODE, TERMS_ID, and
CURRENCY_HEADER_ID in the QP_INTERFACE_LIST_HEADERS table and
PRICE_BY_FORMULA, GENERATE_USING_FORMULA fields in the
QP_INTERFACE_LIST_LINES are populated with the internal code value. To ease this,
one extra field for each field is provided where the description/name of the code can be
populated and the code field can be left empty during the loading of the interface
tables. During the loading process the appropriate code would be fetched and
populated in the live tables. For more information, see: Oracle eTRM (eTechnical
Reference Manual) available on OracleMetaLink.
Other Validation
The following specific user interface (UI) validations are also handled:
• The Pricing attribute context for a PBH (price break header) child line must be
VOLUME.
• For each line record inserted, there must be one pricing attribute record, with null
pricing context/attribute/value.
• Application method of the PBH child line must be compatible with application
method of parent PBH line.
• All the pricing attribute records of the same parent price list line must have same
product context/attribute/value.
Result
Once the concurrent program runs, the following attributes in the table can be checked
to find the status.
• Process_Status_Flag: The process status of the record. The following table outlines
the status values and their meaning:
Status Value Meaning
P Ready to be picked.
I Successfully interfaced.
NULL The record encountered errors during

validation.
• Request_Id: Concurrent request_id which picked this record for processing.
The records in the interface tables which are successfully copied to the live tables get
deleted from the interface tables. So if a record is not in the interface table after the
program executes, then it indicates that the record has migrated successfully to the live
tables.
Error Handling
If any validation failure occurs for the record, the process_status_flag value is set to
NULL and the corresponding error message is inserted in the qp_interface_errors table
along with request_id and orig_sys_reference. The error messages are also sent to the
output log (when concurrent program is run).
Correct any errors in the interface tables in the QP_INTERFACE_ERROR and then reset
PROCESS_STATUS_FLAG value to "P." The REQUEST_ID should also to be reset to
NULL to resubmit the records for next upload. (Alternatively, you can give the Name of
the price list that failed as an input so that it is not necessary to reset the values.)
Periodically, the QP_INTERFACE_ERRORS table needs to be purged of error messages
from prior requests to maintain effective performance. If a child record needs to be
corrected and resubmitted when the parent (and grandparent if applicable) record was
successfully interfaced and deleted by the previous run of the program, you need to
repopulate the parent (and grandparent if applicable) record with a
process_status_flag= I in the interface table.
Examples of Pricing Data Bulk Loader API

The following table contains some example data which can be uploaded. Note that only
the mandatory fields are listed.
The following script examples of the price list bulk loader feature are available from the
$QP_TOP/patch/115/sql directory:
• QPBLKEX1.sql: Script to insert price list header and price list line.
• QPBLKEX2.sql: Script to insert price list header and price list line and pricing

attributes.
• QPBLKEX3.sql: Script to insert price list header and price break line.
• QPBLKEX4.sql: Script to update price list header with qualifiers.
• QPBLKEX5.sql: Script to attach secondary price lists to the primary price list.
Example: Inserting a price list
QP_INTERFACE_LIST_HEADERS
Parameter Value
LIST_TYPE_CODE PRL
name CATALOG_PRICE_LIST1
description Catalog Price List 1
currency_code USD
active_flag Y
process_flag Y
orig_sys_header_ref CPL00001
Interface_action_code INSERT
Language US
source_lang US
rounding_factor -2
PROCESS_STATUS_FLAG P
Example: Inserting the preceding price list as a secondary price list to the
Corporate price list
QP_INTERFACE_QUALIFIERS
Parameter Value
ORIG_SYS_QUALIFIER_R OSQR0001
EF
QUALIFIER_GROUPING_ -1
NO
QUALIFIER_CONTEXT MODLIST
QUALIFIER_ATTRIBUTE PRICE_LIST
_CODE
QUALIFIER_ATTR_VAL Corporate
UE_CODE
ORIG_SYS_HEADER_REF CPL00001
PROCESS_FLAG Y
INTERFACE_ACTION_C INSERT
ODE
COMPARISON_OPERAT =
OR_CODE
QUALIFIER_PRECEDEN 10
CE
Example: Inserting a price list line
QP_INTERFACE_LIST_LINES
Parameter Value
ORIG_SYS_LINE_REF OSLR0001

Parameter Value
list_line_type_code PLL
arithmetic_operator UNIT_PRICE
OPERAND 999
PRIMARY_UOM_FLAG Y
PROCESS_FLAG Y
ODE
QP_INTERFACE_PRICING_ATTRIBS
Parameter Value
ORIG_SYS_PRICING_AT OSPAR0001
TR_REF
PRODUCT_ATTRIBUTE_ ITEM
CONTEXT
PRODUCT_ATTR_CODE INVENTORY_ITEM_ID
PRODUCT_ATTR_VAL_D AS54888
ISP
PROCESS_FLAG Y
Parameter Value
ODE
PRODUCT_UOM_CODE Ea
Example: Inserting a price break header and line
Parameter Value
list_line_type_code PBH
arithmetic_operator POINT
OPERAND UNIT_PRICE
PROCESS_FLAG Y
ODE
QP INTERFACE_PRICING_ATTRIBS
Parameter Value
ORIG_SYS_PRICING_ATT OSPAR0002
R_REF

Parameter Value
PRODUCT_ATTRIBUTE_C ITEM
ONTEXT
PRODUCT_ATTR_VAL_DI CM13139
SP
PROCESS_FLAG Y
INTERFACE_ACTION_CO INSERT
DE
PRODUCT_UOM_CODE Ea
Parameter Value
list_line_type_code PLL
arithmetic_operator UNIT_PRICE
PRICE_BREAK_TYPE_CO POINT
DE
OPERAND 420
PRICE_BREAK_HEADER OSLR0002
_REF
Parameter Value
RLTD_MODIFIER_HEAD pRICE bREAK

ER_REF
PROCESS_FLAG Y
ODE
QP_INTERFACE_PRICING_ATTRIBS
Parameter Value
ORIG_SYS_PRICING_AT OSPAR0003
TR_REF
EXCLUDER FLAG Y
PRODUCT_ATTRIBUTE_ ITEM
CONTEXT
PRODUCT_ATTR_VAL_D CM13139
ISP
PRICING_ATTRIBUTE_C VOLUME
ONTEXT
PRICING_ATTR_CODE ITEM_QUANTITY
PRICING_ATTR_VALUE_ 25
FROM_DISP

Parameter Value
PRICING_ATTR_VALUE_ 35
TO_DISP
COMPARISON_OPERAT BETWEEN
OR_CODE
PROCESS_FLAG Y
ODE
PRODUCT_UOM_CODE Ea
Example: Inserting a qualifier
QP_INTERFACE_QUALIFIERS
Parameter Value
ORIG_SYS_QUALIFIER_R OSQR0002
EF
QUALIFIER_GROUPING_ -1
NO
QUALIFIER_CONTEXT ORDER
QUALIFIER_ATTRIBUTE SHIPPED_FLAG
_CODE
QUALIFIER_ATTR_VAL NO
UE_CODE
PROCESS_FLAG Y
Parameter Value
ODE
COMPARISON_OPERAT =
OR_CODE
Example: Deleting a price list line
Parameter Value
PROCESS_FLAG Y
INTERFACE_ACTION_C DELETE
ODE
Related Topics
Oracle Advanced Pricing Implementation Manual, Pricing Data Bulk Loader chapter
Pricing Object Security - Check Function API

This section explains how to use the Pricing Object Security CHECK_FUNCTION API
and how it functions in Oracle Advanced Pricing.
The CHECK_FUNCTION API is used to check if a specific user, logging in with a
specific responsibility and within a specific operating unit, can have the functional
access to a specific pricing object or not. The package QP_SECURITY contains the
function CHECK_FUNCTION. In our pricing data security system, we define two levels
of functional access: QP_SECU_VIEW access and QP_SECU_UPDATE access. The data
model is additive, so, this API will check all existing security rules and decide to
authorize the user with the functional access or deny him.

Functional Overview
This API will take the parameters and check the pricing object security rules that have
been set up in the pricing data security system.
The parameter p_function_name is required and can take two different values:
• QP_SECU_VIEW
• QP_SECU_UPDATE
The parameter p_instance_type is required and can take three different values:
• PRL: For type of standard price list.
• MOD: For type of modifier list.
• AGR: For type of agreement price list.
The parameter p_instance_pk1_value is required and is the list_header_id from

qp_list_headers_b for a specific pricing object.
The parameter p_instance_pk2_value and p_instance_pk3_value are not in use now.
This is for future consideration if the pricing objects to be secured have composite keys.
The parameter p_user_name, p_resp_id and p_org_id are optional. If they are not
passed in, CHECK_FUNCTION will take the values from the current user and the
corresponding settings for responsibility and operating unit.
This API will return one of the following three values:
• T: The user has the asking-for functional access to the pricing object.
• F: The user has been denied with the access.
• E-<error message>: Error occurred within the API.

The following chart describes all parameters used by the public Pricing Object Security
Check API. All of the inbound and outbound parameters are listed. Additional
CHECK_FUNCTION
CHECK_FUNCTION
p_function_nam In Varchar2 Yes No

e
p_instance_type In Varchar2 Yes No
p_instance_pk1 In Number Yes No
p_instance_pk2 In Number No No
p_instance_pk3 In Number No No
p_user_name In Varchar2 No Yes
p_resp_id In Number No Yes
p_org_id In Number No Yes
Function return Out Varchar2 Yes No

value
following table:
Short Names Key
Drv Derived
Req Required
Yes : This is a required parameter.
No : This is an optional parameter.

Validation of Pricing Object Security API
Standard Validation
Oracle Advanced Pricing validates all required columns in the CHECK_FUNCTION
API.
Other Validation
None
Error Handling
If any validation fails, the API will return error to the calling module.
Error Handling
Condition Function Return Value
Success T or F
Failure E-error message
Pricing Attributes Application Program Interface
Functional Overview
The Pricing Attributes API (QP_ATTRIBUTES_PUB) is a Business Object API that is
based on the following tables:
• QP_PRC_CONTEXTS_B/TL
• QP_SEGMENTS_B/TL
This API does all the transaction processing for all the data that is inserted, updated, or
deleted from contexts and attributes. The Business API Model is shown below. The
Object Name is Attributes and the object code is ATR.
Procedure PROCESS_ATTRIBUTES
The following table shows the parameters for this structure. This procedure is used to
add, update, or delete contexts and attributes.
PROCESS_ATTRIBUTES
umber
p_CON_rec In Con_Rec_Type No No
p_CON_val_rec In Con_Val_Rec_Ty No No
pe
p_SEG_tbl In Con_Tbl_Type No No
p_SEG_val_tbl In Con_Val_Tbl_Ty No No
pe
x_CON_rec Out Con_Rec_Type No No
x_CON_val_rec Out Con_Val_Rec_Ty No No

pe
x_SEG_tbl Out Con_Tbl_Type No No
x_SEG_val_tbl Out Con_Val_Tbl_Ty No No

pe
P_CON_REC

P_CON_REC
Prc_context_cod Null Varchar2 Yes No

e
Prc_context_id Null Number Yes No
Prc_context_type Null Varchar2 Yes No
Program_applica Null Number No No

tion_id
Program_id Null Number No No
Program_update Null Date No No

_date
Seeded_descripti Null Varchar2 No No

on
Seeded_flag Null Varchar2 Yes No
Seeded_prc_cont Null Varchar2 No No

ext_name
User_description Null Varchar2 No No
User_prc_contex Null Varchar2 No No

t_name
Return_status Null Varchar2 No No
Db_flag Null Varchar2 No No
P_CON_VAL_REC
P_CON_VAL_REC
Enabled Null Varchar2 Yes No
Prc_context Null Varchar2 Yes No
Seeded Null Varchar2 Yes No
P_SEG_TBL
P_SEG_TBL
P_Seg_Tbl Null TABLE OF

Seg_Rec_Type
P_SEG_VAL_TBL
P_SEG_VAL_TBL
P_Seg_Val_Tbl Null TABLE OF

Seg_Val_Rec_Ty
pe
X_CON_REC

X_CON_REC
Prc_context_cod Null Varchar2 No No

e
Prc_context_id Null Number No No
Prc_context_type Null Varchar2 No No

tion_id

_date

on
Seeded_flag Null Varchar2 No No

ext_name

t_name
X_CON_VAL_REC
X_CON_VAL_REC
Enabled Null Varchar2 No No
Prc_context Null Varchar2 No No
Seeded Null Varchar2 No No
X_SEG_TBL
X_SEG_TBL
- Null TABLE OF No No
Seg_Rec_Type
X_SEG_VAL_TBL
X_SEG_VAL_TBL
- Null TABLE OF No No
Seg_Val_Rec_Ty
pe
Procedure LOCK_ATTRIBUTES
The following table shows the parameters for this structure. Users can use this
procedure to lock a context row and its attributes from getting updated by another user
concurrently.

LOCK_ATTRIBUTES

umber
p_CON_rec In Con_Rec_Type No No
p_CON_val_rec In Con_Val_Rec_Ty No No
pe
p_SEG_tbl In Con_Tbl_Type No No
p_SEG_val_tbl In Con_Val_Tbl_Ty No No
pe

pe

pe
P_CON_REC
P_CON_REC
Prc_context_cod Null Varchar2 Yes No

e
Prc_context_id Null Number Yes No
Prc_context_type Null Varchar2 Yes No

tion_id

_date

on
Seeded_flag Null Varchar2 Yes No

ext_name

t_name
P_CON_VAL_REC

P_CON_VAL_REC
Enabled Null Varchar2 Yes No
Prc_context Null Varchar2 Yes No
Seeded Null Varchar2 Yes No
The following table shows the parameters for these table structures:
Parameters
Table name Usage Type
P_SEG_TBL Null TABLE OF Seg_Rec_Type
P_SEG_VAL_TBL Null TABLE OF

Seg_Val_Rec_Type
X_CON_REC
X_CON_REC

e

tion_id

_date

on

ext_name

t_name
X_CON_VAL_REC
X_CON_VAL_REC
X_SEG_TBL

X_SEG_TBL
X_Seg_Tbl Null TABLE OF

Seg_Rec_Type
X_SEG_VAL_TBL
X_SEG_VAL_TBL
X_Seg_Val_Tbl Null TABLE OF

Seg_Val_Rec_Ty
pe
Procedure GET_ATTRIBUTES
The following table shows the parameters for this structure. This procedure fetches the
context and all its attributes, when prc_context_id is provided.
GET_ATTRIBUTES

umber
p_prc_context_id In Number No No
p_prc_context In Varchar2 No No

pe

pe
p_prc_context_id
This the primary key for a given context. The API will fetch all the context and all the
attributes for this value.
p_prc_context
This the unique code for a given context. The API will fetch all the context and all the
attributes for this value.
X_CON_REC
X_CON_REC

e

tion_id


_date

on

ext_name

t_name
X_CON_VAL_REC
X_CON_VAL_REC
X_SEG_TBL
X_SEG_TBL
X_Seg_Tbl Null TABLE OF

Seg_Rec_Type
X_SEG_VAL_TBL
X_SEG_VAL_TBL
X_Seg_Val_Tbl Null TABLE OF

Seg_Val_Rec_Ty
pe
Attribute Mapping Application Program Interface
Functional Overview
The build_contexts API calls QP_BUILD_SOURCING_PVT, which contains sourcing
calls to build attribute mapping rules for attributes. This API is called from the Oracle
Order Management (OM) pricing integration. OM passes the request_type_code and
pricing_type and this API builds the attribute mapping rules of the attributes used in
the setup that can be sourced at run time. Attribute mapping rules thus built are
returned in the PL/SQL table structures x_price_contexts_result_tbl and
x_qual_contexts_result_tbl.

The following table describes all parameters used by the Attribute Mapping API
(QP_ATTR_MAPPING_PUB). All of the inbound and outbound parameters are
listed.Additional information on these parameters follows.

QP_ATTR_MAPPING_PUB
p_request_type_ In Varchar2 Yes No

code
p_pricing_type In Varchar2 Yes No
P_org_id In Number No Yes
x_price_contexts Out CONTEXTS_ No No

_result_tbl RESULT_TBL_
TYPE
x_qual_contexts_ Out CONTEXTS_ No No

result_tbl RESULT_TBL_
TYPE
p_request_type_code
An allowable value from the QP_PRICING_REQ_SOURCES table. This is different from
source system code; groups of source system codes form a request type.
For example, CRM request type code can have the I-marketing and I-store source
system codes associated with it (using QP_PRICING_REQ_SOURCES). When you call
Build_ Contexts with the CRM request type, the process sources all contexts for both
I-marketing and I-store source systems.
p_pricing_type
Indicates the sourcing rules to use when building the attributes. Allowable values are:
• L (Line): The process builds the pricing contexts based on the rules associated with
the line pricing attributes entity and builds the qualifier contexts based on the rules
associated with the line qualifier attribute
• H (Header): The process builds the pricing contexts based on the rules associated
with the header pricing attributes entity and builds the qualifier contexts based on
the rules associated with the header qualifier attributes.
p_org_id
Indicates the Org_id (Operating Unit) of the transaction. This parameter is added for
MOAC compliance. The Build_context API can source the attributes for that OU
context. In case the p_org_id is not passed, the API would derive the value from the OU
context if set, and if OU context is not set, the API will use the Default OU for the
responsibility.
Note: The Build_Contexts API will set the policy_context to single Org
to the Org_Id passed to the API. If Org_Id was not passed to the
Build_Contexts API , the API will check if Org Context has been set; if
Org Context is not set, the policy context will be set to Single Org with
the default Org for that responsibility.
CONTEXTS_RESULT_TBL_TYPE
CONTEXTS_RESULT_TBL_TYPE
Contexts_Result Out Contexts_Result No NO

_Tbl_Type _Rec_Type
CONTEXTS_RESULT_REC_TYPE
CONTEXTS_RESULT_REC_TYPE
Attribute_value Null Varchar2 No No
Procedure BUILD_CONTEXTS (overloaded)

This API is called from the Order Management (OM) pricing integration in the
performant code path. OM passes request_type_code and pricing_type and this API
builds the attribute mapping rules of the attributes used in the setup that can be
sourced at run time. Attribute mapping rules thus built are inserted into the pricing
temporary table QP_PREQ_LINE_ATTRS_TMP for the passed in line_index.

BUILD_CONTEXTS (overloaded)

code
p_line_index In Number Yes No
p_pricing_type_ In Varchar2 Yes No

code
P_org_id In Number No Yes
p_request_type_code
P_line_index
Unique identifier for line in the table qp_preq_lines_tmp.
p_pricing_type
Indicates the sourcing rules to use when building the attributes. Allowable values are:
• L (Line): The process builds the pricing contexts based on the rules associated with
the line pricing attributes entity and builds the qualifier contexts based on the rules
associated with the line qualifier attribute
• H (Header): The process builds the pricing contexts based on the rules associated
with the header pricing attributes entity and builds the qualifier contexts based on
the rules associated with the header qualifier attributes.
p_org_id
Indicates the Org_id (Operating Unit) of the transaction. This parameter is added for
the MOAC compliance. The Build_context API can source the attributes for that OU
context. In case the p_org_id is not passed, the API would derive the value from the OU
context if set, and if OU context is not set, the API will use the Default OU for the
responsibility.
Note: The Build_Contexts API will set the policy_context to single Org
to the Org_Id passed to the API. If Org_Id was not passed to the
Build_Contexts API , the API will check if Org Context has been set, if
Org Context is not set, it will set the policy context to Single Org with
the default Org for that responsibility.
Procedure Get_User_Item_Pricing_Contexts
This API returns the pricing contexts whose sourcing method is USER ENTERED.This
API is called from the OM pricing integration. OM passes request_type_code and this
API returns the pricing contexts whose sourcing method is USER ENTERED in the
PLSQL table structure p_user_attribs_tbl.
Get_User_Item_Pricing_Contexts

code
p_user_attribs_t Out USER_ATTRIBU No No

bl TE_TBL_TYPE
p_request_type_code
USER_ATTRIBUTE_TBL_TYPE

USER_ATTRIBUTE_TBL_TYPE
User_Attribute_ Out User_Attribute_ No No

Tbl_Type Rec_Type
USER_ATTRIBUTE_REC_TYPE
USER_ATTRIBUTE_REC_TYPE
Function Is_attribute_used
This API is used to find out whether pricing attribute is used in the pricing setup. This
API is called by the pricing engine. The pricing engine passes context and pricing
attribute to this function and this API returns the attribute used flag (Y/N).
Is_attribute_used
p_attribute_cont In Varchar2 No No
ext
p_attribute_code In Varchar2 No No
p_attribute_context
A context name set up in the context definition table, for example, item, customer, or
volume.
p_attribute_code
Name of the attribute for the sourcing rule, for example, PRICING_ATTRIBUTE1,
PRICING_ATTRIBUTE2, or QUALIFIER_ATTRIBUTE1.
Validation of Attribute Mapping API

Validations.
Standard Validation
Oracle Advanced Pricing validates all required columns in the Attribute Mapping API.
Other Validation
None
Error Handling
Attribute Mapping API processes the rows and reports the values in the following table
for every record.
Error Handling
Success 5 Null
Qualifiers Application Program Interface

This section explains how to use the Qualifiers API and how it functions in Oracle
Advanced Pricing. The Qualifiers package consists of entities to set up qualifiers.
Functional Overview
The Qualifiers package QP_QUALIFIERS_RULES_PUB contains the following APIs and
record type definitions:
• Qualifier_Rules_Rec_Type
• Qualifier_Rules_Tbl_Type
• Qualifier_Rules_Val_Rec_Type
• Qualifier_Rules_Val_Tbl_Type
• Qualifiers_Rec_Type
• Qualifiers_Tbl_Type

• Qualifiers_Val_Rec_Type
• Qualifiers_Val_Tbl_Type
• Process_Qualifier_Rules: Creates, updates, and deletes pricing qualifier rules and

pricing qualifiers belonging to those rules.
• Lock_Qualifier_Rules: Locks table rows.
• Get_Qualifier_Rules: Retrieves the qualifier rule and qualifiers for a given qualifier
rule ID or qualifier rule name.
• Copy_Qualifier_Rules: Creates a new qualifier rule with the name in

p_to_qualifier_ rule. Also, copies the qualifiers belonging to the qualifier rule
specified by the qualifier rule in p_qualifier_rule or the qualifier rule ID in
p_qualifier_rule_id into a new qualifier rule. Returns qualifier rule ID for the new
qualifier rule.

The following chart describes all parameters used by the public Qualifiers. All of the
PROCESS_QUALIFIER_RULES
PROCESS_QUALIFIER_RULES
umber
p_QUALIFIER_ In Qualifier_Rules_ No No
RULES_ rec Rec_Type
RULES_ val_rec Val_Rec_Type
tbl Type
val_tbl Tbl_Type
x_QUALIFIER_R Out Qualifier_Rules_ No No

ULES_ rec Rec_Type

ULES_ val_rec Val_Rec_Type

tbl Type

val_tbl Tbl_Type
p_init_msg_list
p_return_values
p_commit
p_QUALIFIER_RULES_rec
In this procedure, P_QUALIFIER_RULES_rec.operation states the operation that the
process should perform. Allowable values of P_QUALIFIER_RULES_rec.operation are:
• QP_GLOBALS.G_OPR_CREATE
• QP_GLOBALS.G_OPR_DELETE

• QP_GLOBALS.G_OPR_UPDATE
• QP_GLOBALS.G_OPR_LOCK
• QP_GLOBALS.G_OPR_NONE
Default Value: G_MISS_QUALIFIER_RULES_REC

p_QUALIFIER_RULES_val_rec
Default Value: G_MISS_QUALIFIER_RULES_VAL_REC
p_QUALIFIERS_tbl
QUALIFIER_RULES_REC_TYPE
QUALIFIER_RULES_REC_TYPE

n

tion_id

_date

attribute1-15
context
created_by
creation_date
description
last_updated_by
last_update_date
last_update_login
name
program_id
program_update_date
qualifier_rule_id
Default Value: Comes from the sequence QP_QUALIFIER_RULES_S
request_id
return_status
db_flag
operation
QUALIFIER_RULES_TBL_TYPE
QUALIFIER_RULES_TBL_TYPE
Qualifier_Rules_ Null Record No No

Rec_Type
QUALIFIER_RULES_VAL_REC_TYPE
QUALIFIER_RULES_VAL_REC_TYPE
qualifier_rule
QUALIFIER_RULES_VAL_TBL_TYPE

QUALIFIER_RULES_VAL_TBL_TYPE Parameters
Optional Qualifier_Rules_ Null Record No

Val_Rec_ Type
QUALIFIERS_REC_TYPE
QUALIFIERS_REC_TYPE Parameters

rator_code
created_from_ru Null Number No No

le_id

n

tion_id

_date
qualifier_attribut Null Varchar2 Yes No

e

qualifier_attr_val Null Varchar2 Yes No

ue
qualifier_attr_val Null Varchar2 No No

ue_to
qualifier_context Null Varchar2 Yes No
qualifier_datatyp Null Varchar2 No Yes

e
qualifier_groupi Null Number No No

ng_no
qualifier_id Null Number No No
qualifier_preced Null Number No No

ence
qual_attr_value_ Null Number No Yes

from_number
qual_attr_value_ Null Number No Yes

to_number
active_flag Null Varchar2 No No
search_ind Null Number No Yes
qualifier_group_ Null Number No Yes

cnt
header_quals_ex Null Varchar2 No Yes

ist_flag
distinct_row_cou Null Number No Yes

nt
qualify_hier_des Null Varchar2 No No

cendent_flag
attribute1–15
context
created_by
created_from_rule_id
creation_date
end_date_active
excluder_flag
Default Value: 'N'
last_updated_by
last_update_date
last_update_login

list_header_id
list_line_id
program_id
program_update_date
qualifier_attribute
qualifier_attr_value
qualifier_attr_value_to
qualifier_context
qualifier_datatype
qualifier_grouping_no
qualifier_id
Default Value: From sequence QP_QUALIFIERS_S
qualifier_precedence
qualifier_rule_id
request_id
start_date_active
qual_attr_value_from_number
qual_attr_value_to_number
active_flag
search_ind
qualifier_group_cnt
header_quals_exist_flag
distinct_row_count
return_status
db_flag
operation
qualify_hier_descendent_flag
QUALIFIERS_TBL_TYPE
QUALIFIERS_TBL_TYPE Parameters
Qualifiers_Rec_T Null Record No No

ype
QUALIFIER_VAL_REC_TYPE

QUALIFIER_VAL_REC_TYPE
created_from_ru Null Varchar2 No No

le
qualifier_attribut Null Varchar2 No No

e_desc

ue_desc

ue_to_desc
created_from_rule
list_header
list_line
qualifier_rule
qualifier_attribute_desc
qualifier_attr_value_desc
qualifier_rule_value_to_desc
QUALIFIERS_VAL_TBL_TYPE Parameters
Qualifiers_Val_R Null Record No No

ec_Type
LOCK_QUALIFIER_RULES
LOCK_QUALIFIER_RULES Parameters
umber
RULES_ rec Rec_Type
RULES_ val_rec Val_Rec_Type
tbl Type
val_tbl Tbl_Type


ULES_ rec Rec_Type


tbl Type

val_tbl Tbl_Type
p_init_msg_list
p_return_values
p_QUALIFIER_RULES_rec
Default Value: G_MISS_QUALIFIER_RULES_REC
p_QUALIFIER_RULES_val_rec
Default Value: G_MISS_QUALIFIER_RULES_VAL_REC
p_QUALIFIERS_tbl
GET_QUALIFIER_RULES
GET_QUALIFIER_RULES Parameters
umber
p_qualifier_rule_ In Number No No
id
p_qualifier_rule In Varchar2 No No

ULES_ rec Rec_Type


tbl Type

val_tbl Tbl_Type
p_init_msg_list
p_return_values
p_qualifier_rule_id
p_qualifier_rule
COPY_QUALIFIER_RULES

COPY_QUALIFIER_RULES Parameters
umber
p_qualifier_rule_ In Number No No
id
p_qualifier_rule In Varchar2 No No
p_to_qualifier_r In Varchar2 No No
ule
p_to_description In Varchar2 No No
x_qualifier_rule_ Out Number No No

id
p_init_msg_list
p_return_values
p_commit
p_qualifier_rule_id
p_qualifier_rule
p_to_description
Validation of Qualifiers API

Validations:
Standard Validation
Oracle Advanced Pricing validates all required columns in the Qualifiers API.
Other Validation
None
Error Handling
Qualifiers API processes the rows and reports the values in the following table for every
record.
Error Handling
Success 5 null
Example of Qualifiers API

• QPQFXMP1.sql: This sample script inserts a qualifier Rule and a qualifier.
Reverse Limits Application Program Interface

This section explains how to use the Reverse Limits API and how it functions in Oracle
Advanced Pricing.
The Reverse Limits API is a procedure that must be called directly by Oracle Order
Management (OM) to reverse any promotional limits that were consumed by an order
line when the line is either cancelled, amended or returned and no pricing engine call is
made. The package QP_UTIL_PUB contains the procedure Reverse_Limits.

Note: The follow is not supported by this API:
• When the API is called with p_action_code = 'AMEND', an

amended quantity that is greater than the originally ordered or
consumed quantity is not supported.
• Reversal of order level discounts for an order line cancellation,

amendment, or return is not supported.
Functional Overview
When an item is ordered in OM, a call is made to the pricing engine to price the item
and to determine the promotions that are to be given away for the ordered item. If
promotional limits have been set up for the promotions, then the promotions that are
given away are consumed from this limit.
However, when the order line is either cancelled, amended or returned without making
a pricing engine call (since there was no need to calculate the price of return), the
promotional limits that were consumed do not get reversed.
To reverse the consumed limit when such a return, amend or cancellation occurs, OM
must call this API with the right parameters to increment the available limit balance(s).

The following chart describes all parameters used by the public Reverse Limits API. All
of the inbound and outbound parameters are listed. Additional information on these
parameters may follow. The input parameters must be passed to the Reverse Limits API
by OM and the output parameters are passed to OM.
REVERSE_LIMITS
Reverse_Limits Parameters
Parameter Usage Type Req Description
p_action_code In Varchar2 Yes Valid values are

RETURN,CANC
EL and AMEND
p_cons_price_re In Varchar2 Yes Price_Request_C

quest_code ode of the last,
successfully
priced order_line
that consumed
the promotional
limit:
• If the
p_action_co
de is
RETURN,
then the
price_reques
t_code of
the order
line that is
referenced
by the
returned
line must be
passed to
this
parameter.
• If the
p_action_co
de is
CANCEL,
then to this
parameter
must be
passed the
price_reques
t_code of
the order
line/order
that is being
cancelled.
• If the
p_action_co
de is
AMEND,
then to this
parameter

must be
passed the
price_reques
t_code of
the order
line that is
being
amended
p_orig_ordered_ In Number Yes1 Priced_quantity

qty of the last
successfully
priced order line
that consumed
the promotional
limit:
• If the
p_action_co
de is
'RETURN',
then to this
parameter
must be
passed the
priced
quantity of
the order
line that is
referenced
by the
returned
line.
• If the
p_action_co
de is
AMEND,
then to this
parameter
must be
passed the
originally
priced
quantity of
the order
line that is
being
amended.

p_amended_qty In Number Yes2 The new

quantity to
which the
original ordered
or priced
quantity has
been amended
to. The
Amended Qty
can be less than
or equal to the
originally priced
qty but not
greater.
p_ret_price_requ In Varchar2 Yes3 The price request

est_code code of the
return line.
P_returned_qty In Number Yes4 The returned

quantity (the
quantity on the
return line).
x_return_status Out Varchar2 Yes See Error

Handling for
possible values
returned.
x_return_messag Out Varchar2 Yes Suitable Error

e Message if the
API returns an
error status.
The following table describes the notations listed in the preceding table:
Notations
Note Description
1 When p_action_code is RETURN or AMEND
Note Description
2 When p_action_code is AMEND
3 When p_action_code is RETURN
4 When p_action_code is RETURN
Validation of Reverse Limits API

Validations:
Standard Validation
The calling application is responsible for passing the correct parameters to the Reverse
Limits API.
Other Validation
None
Error Handling
If any exception occurs in the Reverse Limits API, it should return the error status to the
calling module. The Order Management application must call the Reverse Limits API
while processing Cancellations, Amendments or Returned Order Lines, when the
pricing engine is not called.
Error Handling
Condition x_return_status x_return_message
Success FND_API.G_RET_STS_SUCC null

ES
Expected Error FND_API.G_RET_STS_ERRO actual error message

R
Unexpected Error FND_API.G_RET_STS_UNEX actual error message

P_ERROR
$qp/patch/115/sql.
Additional Notes

• When the API is called with p_action_code ='AMEND, the amended quantity can
less than or equal to the originally ordered or consumed quantity but not greater
than the originally priced quantity. If the amended quantity is greater, then the
promotional limit may potentially be exceeded, in which case, this API (which is
independent of the Limits Engine) cannot perform the logic that the Pricing Limits
Engine would have performed under such circumstances. (Also, Oracle Order
Management handles limit reversal for under-shipped or over-shipped quantities).
• When an order line is cancelled, amended or returned, this API may be used to only
reverse limits on order-line level Discounts but not order-level discounts.
• Order Cancellations are supported by this API. To achieve this, the calling
application (OM) must call this API for each order line on the order to be cancelled
and once with the Order's price_request_code. Number of times to call the API = no.
of order lines on the order to be cancelled + 1.
• The limit amount to be reversed/amended is calculated as a prorated value of the

originally consumed amount.
Example of Reverse Limits API

Example 1
The limit amount to be reversed/amended is calculated as a prorated value of the
originally consumed amount as in the following examples:
1. If an order line item has a unit price of $100 and the original priced/ordered
quantity is 10 then the gross revenue is $1000. If the order line is eligible for a
lumpsum discount of $20, then the actual revenue is $1000 - $20 = $980 which is a
selling price of $98 ($980/10) per unit of the item effectively.
If the priced quantity is amended to 5 from 10, then since selling price must be fixed
at $98 (since there's no repricing), the new total should be 5 x $98 = $490 which is
effectively a lumpsum discount of $10 for an order line of qty 5 with unit price = $10
(for example, 5 x $10 -$10).
2. With the pro-rated approach, the new benefit consumption against the limit would
be calculated as follows:
(amended_qty/original_ordered_qty) * original consumed amount
(5/10) * $20 (lumpsum benefit) = $10 (new lumpsum) which is the same as the
benefit(discount) calculated in a) above.
So pro-rating the original consumption correctly evaluates the new consumption

against a limit when the quantity is amended.
Example 2
1. If an order line item has a unit price of $100 and the original priced/ordered
quantity is 10 then the gross revenue is $1000. If the order line is eligible for a 30%
discount (for example, 30/100 x $1000= $300), then the actual revenue is $1000- $300
= $700 which is a selling price of $70 ($700/10) per unit of the item effectively.
If the priced quantity is amended to 6 from 10, then the selling price must be fixed
at $70 (since there is no repricing), and the new total should be 6 x $70 = $420. This
is effectively a discount of $180 (6x $100 - $420) which is an 18% percent discount
consumption ($180/$1000)
2. With the pro-rated approach, the new benefit consumption against the limit would
be:
(amended_qty/original_ordered_qty) * original consumed amount
(6/10) * 30 (discount%) = 18 (new discount%) which is the same as the benefit
(discount %) calculated in a) above.
So pro-rating the original consumption correctly evaluates the new consumption
against a limit when the quantity is amended.
Round Price Application Program Interface

This section explains how to use the round_price API and how it functions in Oracle
Advanced Pricing.
The round_price API is used to round the price using the rounding factor. The package
QP_UTIL_PUB contains the procedure round_price.
Functional Overview
This API is called by pricing engine as well as directly from OM.
When it is called from pricing engine, the pricing engine passes the rounding factor and
the operand (i.e. the price of an item) and so this API just uses the round() function and
return the rounded operand.
But when this API is called directly from OM (while re-pricing an item), it passes the
price_list_id and the operand. In this case, this API finds the rounding factor associated
with price list, round the passed operand and then return the rounded operand.
The parameter p_operand_type can take 3 different values–A, S, or R, with the default
value S. When R is passed for p_operand_type then rounding_factor is returned in the
out parameter p_rounded_operand, else rounded value (after applying rounding factor)
of p_operand is returned.
The rounded operand / rounding factor is returned only if one of the following
conditions is met :
• p_operand_type = A and profile "QP: Selling Price Rounding Options" =
'ROUND_ADJ'

• p_operand_type = S and profile "QP: Selling Price Rounding Options" =
'ROUND_ADJ' or 'NO_ROUND_ADJ'
• p_operand_type = R
• profile OE_UNIT_PRICE_ROUNDING = Y
When profile options QP: Multi Currency Installed and QP: Multi Currency Usage are
set to Y (Yes), then the rounding factor is retrieved by joining the tables
qp_list_headers_b and qp_currency_details for the passed values of price list id,
currency code and effective date; otherwise, the rounding factor is retrieved from table
qp_list_headers_b for the price list id (regardless of currency or effective date).

The following chart describes all parameters used by the round_price API. All of the
round_price Parameters
p_operand IN Number Yes, if the No

p_operand_type
is not 'R'
p_rounding_fact IN Number No No
or
p_use_multi_cur IN Varchar2 No No
rency
p_price_list_id IN Number No No
p_currency_code IN Varchar2 No No
p_pricing_effecti IN Date No No
ve_date
x_rounded_oper OUT Number No No

and
x_status_code OUT Varchar2 No No
p_operand_type IN Varchar2 No No
Validation of Round Price API

Validations:
Standard Validation
The caller is responsible for passing the right parameters to Round_Price.
For specific information on the data implied by these columns, See Oracle Pricing
Other Validation
None.
Error Handling
If any exception occurs in the Round_Price API, it returns appropriate status code as
below.
Status Code
Condition x_status_code
Success FND_API.G_RET_STS_SUCCES
Expected Error FND_API.G_RET_STS_ERROR
Unexpected Error FND_API.G_RET_STS_UNEXP_ERROR
Validate Price List with Currency Code Application Program Interface

This section explains how to use the Validate Price List with Currency Code API
(Validate_Price_list_Curr_code) and how it functions in Oracle Advanced Pricing.
The Validate Price List with Currency Code API is used to validate a given price list
with a currency code.

Functional Overview
When an order is processed using a particular price list and currency code, the
combination of price list and currency code must be verified to ensure it is correct for
the pricing effective date. If the pricing effective date is not passed by the calling
application, the current date defaults. If the profile options QP: Multi Currency Installed
and QP: Multi Currency Usage are Y (Yes) then validation is done by joining the tables
qp_list_headers_b and qp_currency_details else only table qp_list_headers_b is used.

The following chart describes all parameters used by the Validate Price List with
Currency Code API. All of the inbound and outbound parameters are listed.
Validate_Price_list_Curr_code parameters
l_price_list_id IN Number Yes No
l_currency_code IN Varchar2 Yes No
ve_date
l_validate_result OUT Varchar2 No No
Validation of Validate Price List with Currency Code API

Validations:
Standard Validation
The caller is responsible for passing the correct parameters to
Validate_Price_list_Curr_code.
Other Validation
None.
Error Handling
If any exception occurs in the Validate_Price_list_Curr_code API, it returns the value
"N" (No) in outbound parameter l_validate_result.
Note: The package specification and body files are QPXRTCNS.pls and

3
Oracle Advanced Pricing XML Transactions
Get Catalog Transaction

This section explains how to use the Get Catalog XML transaction (GET_CATALOG)
and how it functions in Oracle Advanced Pricing This XML transaction is based on the
XML messaging standards defined by the Open Applications Group (OAG).
Get Catalog is an inbound message used between a seller and a buyer to generate price
books via XML messaging. In a typical scenario, the buyer sends a GET_CATALOG
message to the seller, and the seller then returns a SYNC_CATALOG message
containing the price book details. This process can be set up to automatically request
and receive generated price books detailing the pricing of a particular set of products.
The following table provides general information on the GET_CATALOG message.
Message Map Name QP_CATGI_OAG72_IN
Direction Inbound
(Internal) Transaction QP
Type
(Internal) Transaction CATGI

Subtype
External Transaction CATALOG

Type
External Transaction GET

Subtype
DTD Directory xml/oag72
Oracle Advanced Pricing XML Transactions 3-1

Message Map Name QP_CATGI_OAG72_IN
Map Directory patch/115/xml/US
Message Maps XGM QP_CATGI_OAG72_IN.xgm

File Name
Standard OAG
Release 7.2
Format DTD
DTD Name 129_get_catalog_002.dtd
Setting up and Parameter Descriptions

The following table describes all inbound parameters used by GET_CATALOG. The
abbreviations used in this table are described below:
Abbreviation Meaning
HB QP_PB_INPUT_HEADERS_B
HTL QP_PB_INPUT_HEADERS_TL
L QP_PB_INPUT_LINES
OAG Element Description/Comment Oracle QP Required

Table
Column*
<CNTROLAR The fields included in this area provide N/A Yes

EA> information about the XML document such
as BSR, SENDER and DATETIME
(described below).
<BSR> Shows the Business Service Request name N/A Yes

per OAG.
Table
Column*
<VERB/> Value is GET. Oracle XML Yes

Gateway
tables
<NOUN/> Value is CATALOG. Oracle XML Yes

Gateway
tables
<REVISION/> Value is 002. Oracle XML Yes

Gateway
tables
</BSR> -- -- Yes
<SENDER> Provides information on the system that N/A Yes

sends the document.
<LOGICALID/ Sender system identifier. Oracle XML Yes

> Gateway
tables
<COMPONE Sender application name. Oracle XML Yes

NT/> Gateway
tables
<TASK/> Event or Action. Value is CATGI. Oracle XML Yes

Gateway
tables
<REFERENCE Unique reference ID for this doc. Oracle XML Yes

ID/> Gateway
tables
<CONFIRMA Confirmation when doc is received. Value Oracle XML Yes

TION/> is '0' means none required. Gateway
tables
<LANGUAGE ISO language in which the text fields are Oracle XML Yes
/> transmitted, for example, US. Gateway
tables

Table
Column*
<CODEPAGE/ Character set used in this XML doc, for Oracle XML Yes
> example, UTF8. Gateway
tables
<AUTHID/> System ID of sender. Value is "APPS". Oracle XML Yes

Gateway
tables
</SENDER> -- -- Yes
<DATETIME/ Creation date and time of the XML Oracle XML Yes
> document in OAG date format. Gateway
tables
</CNTROLA -- N/A Yes

REA>
<DATAAREA The fields included in this area provide N/A Yes

> information about the data included in the
XML document.
<GET_CATA Exactly one instance is required within a N/A Yes

LOG> message.
<CATALOG> The fields included in this area provide N/A Yes

price book input information. Exactly one
instance is required within a message.
<DATETIME/ Pricing effective date and time in OAG date HB.EFFECTIV Yes
> format. E_DATE
<CATALGNA Name of the price book. HTL.PRICE_B Yes

ME/> OOK_NAME
<USERAREA> The fields included in this area are N/A Yes

provided by Oracle.
<CURRENCY Currency code. HB.CURREN If

CODE/> CY_CODE PBTYPECODE
is "F"
Table
Column*
<ITEMQUAN Item quantity to be used for all items in the HB.ITEM_QU No, defaulted
TITY/> price book. ANTITY
<PUBLISHEXI Allows requestor to request an existing HB.PUBLISH_ No, defaulted

STINGPBFLA price book identified by the price book EXISTING_PB
G> name (CATALGNAME) and the pricing _FLAG
effective date (DATETIME). Valid values
are "Y" and "N."
<OVERWRITE Allows requestor to overwrite an existing HB.OVERWRI No, defaulted

EXISTINGPBF price book. Valid Values are "Y" and "N." TE_EXISTING
LAG/> _PB_FLAG
<PBTYPECOD Price book type. Valid values are F and D. HB.PRICE_BO No, defaulted
E/> OK_TYPE_CO
DE
<LIMITPROD Product filter type. Valid values are ITEM, HB.LIMIT_PR If

UCTSBYCOD ITEM_CATEGORY, ALL_ITEMS, and ODUCTS_BY PBTYPECODE
E/> PRICE_LIST. is "F"
<PRICEBASE Entity type for which the pricing is based HB.PRICE_BA If

DONCODE/> on, namely the pricing basis. Valid values SED_ON PBTYPECODE
are PRICE_LIST, AGREEMENT, and BSA. is "F"
<PRICELIST/> Price list name or ID referred to by either HB.PL_AGR_ If

or LIMITPRODUCTSBYCODE and/or BSA_ID LIMITPRODU
<PRICELISTI PRICEBASEDONCODE. CTSBYCODE
D/> or
PRICEBASED
ONCODE is "
PRICE_LIST"
<AGREEMEN Agreement name or ID referred to by HB.PL_AGR_ If

T/> PRICEBASEDONCODE. BSA_ID PRICEBASED
ONCODE is "
or AGREEMENT
<AGREEMEN "
TID/>

Table
Column*
<BSA/> or Sales agreement name or ID referred to by HB.PL_AGR_ If

<BSAID/> PRICEBASEDONCODE. BSA_ID PRICEBASED
ONCODE is "
BSA"
<ITEMX/> or Internal item number or ID referred to by HB.PRODUC If

<ITEMID/> LIMITPRODUCTSBYCODE. T_ATTR_VAL LIMITPRODU
UE CTSBYCODE
is "ITEM"
<ITEMCATEG Internal item category name or ID referred HB.PRODUC If

ORY/> or to by LIMITPRODUCTSBYCODE. T_ATTR_VAL LIMITPRODU
<ITEMCATEG UE CTSBYCODE
ORYID/> is "
ITEM_CATEG
ORY"
<GENDATET The fields included in this area describe N/A No

IME> when the price book will be generated.
<GENTIMEC Dictates whether the price book will be HB.GENERAT No, defaulted
ODE/> generated immediately or at a specific time. ION_TIME_C
Valid values are IMMEDIATE and ODE
SCHEDULE.
<DATETIME/ Price book generation date and time in HB.GEN_SCH If

> OAG date format. Used when EDULE_DAT GENTIMECO
GENTIMECODE is SCHEDULE. E DE is "
SCHEDULE"
</GENDATE -- N/A No
TIME>
<PBATTR> The fields included in this area describe a No

price book input attribute.
<CTXT/> or Context name such as Terms or code such L.CONTEXT If PBATTR is

<CTXTCODE/ as TERMS. specified
>
Table
Column*
<ATTR/> or Attribute name such as Payment Terms or L.ATTRIBUTE If PBATTR is

<ATTRCODE/ code such as QUALIFIER_ATRIBUTE1. specified
>
<ATTRVALU Attribute value name such as "2 Net" or L.ATTRIBUTE If PBATTR is

E/> or code "1145." _VALUE specified
<ATTRVALU
ECODE/>
<ATTRTYPE/> Attribute type. Valid values are L.ATTRIBUTE If PBATTR is

PRICING_ATTRIBUTE and QUALIFIER. _TYPE specified
</PBATTR> -- N/A No
</USERAREA -- N/A Yes

>
<PARTNER> The fields included in this area describe the No

customer for which the price book is
created.
<USERAREA> The fields included in this area are N/A No

provided by Oracle.
<CUSTACCT/ Internal customer account ID. HB.CUST_AC No, defaulted.

> COUNT_ID
</USERAREA -- N/A No
>
</PARTNER> -- N/A No
</CATALOG> -- N/A Yes
</GET_CATA -- N/A Yes

LOG>
</DATAARE -- N/A Yes

A>
The following table lists the defaulted table column values.

Oracle QP Table Value
Column
HB.REQUEST_ORIGIN XML
ATION_CODE
HB.CUSTOMER_CON CUSTOMER
TEXT
HB.CUSTOMER_ATTR QUALIFIER_ATTRIBUTE2
IBUTE
HB.GENERATION_TI IMMEDIATE
ME_CODE
HB.ITEM_QUANTITY 1
HB.OVERWRITE_EXIS N
TING_PB_FLAG
HB.PRICE_BOOK_TYP F
E_CODE
HB.PRODUCT_CONTE ITEM
XT
HB.PUBLISH_EXISTIN N
G_PB_FLAG
HB.DLV_XML_FLAG Y
HB.CUST_ACCOUNT_ If there is exactly one customer account associated with the

ID customer, then this customer account will be used.
The following table lists the derived table column values.
Oracle QP Table Derivation

Column
HB.CREATED_BY FND_GLOBAL.USER_ID
HB.CREATION_DATE SYSDATE
Column
HB.LAST_UPDATED_ FND_GLOBAL.USER_ID
BY
HB.LAST_UPDATE_D SYSDATE
ATE
HB.LAST_UPDATE_L FND_GLOBAL.LOGIN_ID
OGIN
HB.CUSTOMER_ATTR Customer defined in trading partner setup

_VALUE
HB.DLV_XML_SITE_I Party site ID defined in trading partner setup

D
HB.ORG_ID Provided by XML Gateway.
HB.PB_INPUT_HEADE Next value from sequence QP_PB_INPUT_HEADERS_B_S

R_ID
HB.PRICE_BASED_ON "PRICE_LIST" if B.LIMIT_PRODUCTS_BY is "PRICE_LIST"
HB.PRICING_PERSPE Value from profile QP: External Default Pricing Perspective

CTIVE_CODE
HB.REQUEST_TYPE_C Value from profile QP: Pricing Perspective Request Type

ODE
HB.PRODUCT_ATTRI Assigns appropriate attribute based on LIMITPRODUCTSBYCODE.

BUTE
HB.PRODUCT_ATTR_ Assigns appropriate attribute value based on

VALUE LIMITPRODUCTSBYCODE, ITEMX, ITEMID, ITEMCATEGORY,
ITEMCATEGORYID
HB.PL_AGR_BSA_ID Assigns appropriate list ID based on PRICEBASEDONCODE,

PRICELIST, PRICELISTID, AGREEMENT, AGREEMENTID, BSA,
BSAID.

Column
TL.PL_AGR_BSA_NA Assigns appropriate list name based on PRICEBASEDONCODE,

ME PRICELIST, PRICELISTID, AGREEMENT, AGREEMENTID, BSA,
BSAID.
L.CREATED_BY FND_GLOBAL.USER_ID
L.CREATION_DATE SYSDATE
L.LAST_UPDATED_BY FND_GLOBAL.USER_ID
L.LAST_UPDATE_DA SYSDATE
TE
L.LAST_UPDATE_LO FND_GLOBAL.LOGIN_ID
GIN
L.PB_INPUT_HEADER HB.PB_INPUT_HEADER_ID
_ID
L.PB_INPUT_LINE_ID Next value from sequence QP_PB_INPUT_LINES_S
L.CONTEXT Corresponding context code in the case where CTXT is provided.
L.ATTRIBUTE Corresponding attribute code in the case where ATTR is provided.
The following code shows the structure of the GET_CATALOG message. Although not
all tags will be necessary to construct a valid message, you must preserve the order of
the tag structure.
<GET_CATALOG_002>
<CNTROLAREA>
<BSR>
<VERB value="GET"/>
<NOUN value="CATALOG"/>
<REVISION value="002"/>
</BSR>
<SENDER>
<LOGICALID/>
<COMPONENT/>
<TASK/>
<REFERENCEID/>
<CONFIRMATION/>
<LANGUAGE/>
<CODEPAGE/>
<AUTHID/>
</SENDER>
<DATETIME qualifier="CREATION">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<GET_CATALOG>
<CATALOG returndata="1">
<DATETIME qualifier="EFFECTIVE">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<CATALGNAME/>
<USERAREA>
<CURRENCYCODE/>
<ITEMQUANTITY/>
<PUBLISHEXISTINGPBFLAG/>
<OVERWRITEEXISTINGPBFLAG/>
<PBTYPECODE/>
<LIMITPRODUCTSBYCODE/>
<PRICEBASEDONCODE/>
<PRICELIST/>
<PRICELISTID/>
<AGREEMENT/>
<AGREEMENTID/>
<BSA/>
<BSAID/>
<ITEM/>
<ITEMX/>
<ITEMID/>
<ITEMCATEGORY/>
<ITEMCATEGORYID/>

<GENDATETIME>
<GENTIMECODE/>
<DATETIME qualifier="GENERATION">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
</GENDATETIME>
<PBATTR>
<CTXT/>
<CTXTCODE/>
<ATTR/>
<ATTRCODE/>
<ATTRVALUE/>
<ATTRVALUECODE/>
<ATTRTYPE/>
</PBATTR>
</USERAREA>
<PARTNER>
<USERAREA>
<CUSTACCT\>
</USERAREA>
</PARTNER>
</CATALOG>
</GET_CATALOG>
</DATAAREA>
</GET_CATALOG_002>
Trading Partner Setup
The GET_CATALOG transaction uses Oracle XML Gateway to facilitate the incoming
messages. To use this transaction, you must define a trading partner and enable the
GET_CATALOG message for this partner in the Oracle XML Gateway Define Trading
Partner Setup form. The relevant message for this transaction has transaction type QP
and transaction subtype CATGI. For more information, see the Oracle XML Gateway
User's Guide.
Validation of Get Catalog Transaction

Standard Validation
Oracle XML Gateway first validates the GET_CATALOG message structure, and
ensures that the payload follows the DTD as specified by OAG. Oracle Advanced
Pricing then validates all required table columns using the same validation in the Get
Catalog transaction as that of the Create Publish Price Book API. The Get Catalog
transaction is available only to external users and not to internal users. For more
information, see validation section for Create Publish Price Book API.
Error Handling
If any validation fails, the error will be returned to Oracle Workflow. An e-mail
notification will be sent to both the Trading Partner and System Administrator contact
containing the error code and message. Users can also view error messages using the
Oracle XML Gateway Transaction Monitor and/or Oracle Workflow Status Monitor. For
more information, please refer to the documentation for these modules. Note that when
appropriate, error messages may refer to the table column names, and not the
corresponding tag names.
Examples of the Get Catalog Transaction
Request a New Price Book

The following example describes a standard request for a new price book with the
following characteristics:
• The price book is named 2006 - AS54999 effective 10/04/2006.
• The price book contains only item AS54999.
• The price book is based on price list Computer Desktops and Accessories.
• The price book is scheduled to be generated 10/04/2005.
• The order category is passed with value ORDER.
• The payment terms is passed with value 2 Net. Since the attribute code is known,
the requestor has specified the ATTRCODE as QUALIFIER_ATTRIBUTE1.

<GET_CATALOG_002>
<CNTROLAREA>
<BSR>
<VERB value="GET"/>
</BSR>
<SENDER>
<LOGICALID>ORACLE</LOGICALID>
<COMPONENT>QP</COMPONENT>
<TASK>CATGI</TASK>
<REFERENCEID>112233</REFERENCEID>
<CONFIRMATION>1</CONFIRMATION>
<LANGUAGE>US</LANGUAGE>
<CODEPAGE>UTF8</CODEPAGE>
<AUTHID>APPS</AUTHID>
</SENDER>
<YEAR>2000</YEAR>
<MONTH>10</MONTH>
<DAY>15</DAY>
<HOUR>16</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
<SUBSECOND>0000</SUBSECOND>
<TIMEZONE>-0500</TIMEZONE>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<GET_CATALOG>
<YEAR>2006</YEAR>
<MONTH>10</MONTH>
<DAY>04</DAY>
<HOUR>15</HOUR>
<MINUTE>30</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<CATALGNAME>2006 - AS54999</CATALGNAME>
<USERAREA>
<CURRENCYCODE>USD</CURRENCYCODE>
<ITEMQUANTITY>5</ITEMQUANTITY>
<PUBLISHEXISTINGPBFLAG>N</PUBLISHEXISTINGPBFLAG>
<OVERWRITEEXISTINGPBFLAG>N</OVERWRITEEXISTINGPBFLAG>
<PBTYPECODE>F</PBTYPECODE>
<LIMITPRODUCTSBYCODE>ITEM</LIMITPRODUCTSBYCODE>
<PRICEBASEDONCODE>PRICE_LIST</PRICEBASEDONCODE>
<PRICELIST>Computer Desktops and Accessories</PRICELIST>
<ITEMX>AS54999</ITEMX>
<GENDATETIME>
<GENTIMECODE>SCHEDULE</GENTIMECODE>
<YEAR>2005</YEAR>
<MONTH>10</MONTH>
<DAY>04</DAY>
<HOUR>16</HOUR>
<MINUTE>10</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
</GENDATETIME>
<PBATTR>
<CTXTCODE>ORDER</CTXTCODE>
<ATTR>Order Category</ATTR>
<ATTRVALUE>ORDER</ATTRVALUE>
<ATTRTYPE>QUALIFIER</ATTRTYPE>
</PBATTR>
<PBATTR>
<CTXTCODE>TERMS</CTXTCODE>
<ATTRCODE>QUALIFIER_ATTRIBUTE1</ATTRCODE>
<ATTRVALUE>2 Net</ATTRVALUE>
</PBATTR>
</USERAREA>
</CATALOG>
</GET_CATALOG>
</DATAAREA>
</GET_CATALOG_002>
Republish a Price Book

The example below displays a standard request to re-send an existing price book. The
desired price book is identified by the price book type, the price book name, and the
customer (which is derived from the trading partner setup).

<GET_CATALOG_002>
<CNTROLAREA>
<BSR>
<VERB value="GET"/>
</BSR>
<SENDER>
<TASK>CATGI</TASK>
</SENDER>
<YEAR>2000</YEAR>
<MONTH>10</MONTH>
<DAY>15</DAY>
<HOUR>16</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<GET_CATALOG>
<USERAREA>
<PUBLISHEXISTINGPBFLAG>Y</PUBLISHEXISTINGPBFLAG>
</USERAREA>
</CATALOG>
</GET_CATALOG>
</DATAAREA>
</GET_CATALOG_002>
Request a Delta Price Book

This payload example describes a standard request for a delta price book. Note that the
full price book, from which the delta is based, is identified by the price book type, the
price book name, and the customer (which is derived from the trading partner setup).
Note: The Effective Date that is used in a Delta Price Book request can
be different from (typically later than) the pricing effective date of the
corresponding full price book with the same price book name and
customer.
<GET_CATALOG_002>
<CNTROLAREA>
<BSR>
<VERB value="GET"/>
</BSR>
<SENDER>
<TASK>CATGI</TASK>
</SENDER>
<YEAR>2000</YEAR>
<MONTH>10</MONTH>
<DAY>15</DAY>
<HOUR>16</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<GET_CATALOG>
<YEAR>2006</YEAR>
<MONTH>10</MONTH>
<DAY>04</DAY>
<HOUR>15</HOUR>
<MINUTE>30</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<USERAREA>
<PUBLISHEXISTINGPBFLAG>N</PUBLISHEXISTINGPBFLAG>
<PBTYPECODE>D</PBTYPECODE>
</USERAREA>
</CATALOG>
</GET_CATALOG>
</DATAAREA>
</GET_CATALOG_002>
Sync Catalog Transaction

This section explains how to use the Sync Catalog XML transaction (SYNC_CATALOG)
and how it functions in Oracle Advanced Pricing. This XML transaction is based on
XML messaging standards defined by the Open Applications Group (OAG).
SYNC_CATALOG is an outbound message used between seller and buyer to send price

books via XML messaging. This message is generated and sent in response to a
GET_CATALOG message (described in the preceding section). The following table
provides general information on the SYNC_CATALOG message:
Message Map Name QP_CATSO_OAG72_OUT
Direction Outbound
(Internal) Transaction Type QP
(Internal) Transaction Subtype CATSO
External Transaction Type CATALOG
External Transaction Subtype SYNC
Message Maps XGM File Name QP_CATSO_OAG72_OUT.xgm
Standard OAG
Release 7.2
Format DTD
DTD Name 128_sync_catalog_003.dtd

The parameters table describes all outbound parameters used by SYNC_CATALOG.
The following abbreviations are used in the table:
IHV QP_PB_INPUT_HEADERS_V
IHTL QP_PB_INPUT_HEADERS_TL
ILV QP_PB_INPUT_LINES_V
PBHV QP_PRICE_BOOK_HEADERS_V
PBMV QP_PRICE_BOOK_MESSAGES_V
PBLV QP_PRICE_BOOK_LINES_V
PBAV QP_PRICE_BOOK_ATTRIBUTES_V
PBLDV QP_PRICE_BOOK_LINE_DETAILS_V
PBBLV QP_PRICE_BOOK_BREAK_LINES_V
The following table lists the outbound parameters used by SYNC_CATALOG:
Outbound parameters in SYNC_CATALOG
OAG Element Description/Comment Oracle QP Table.View

Column*
<CNTROLAREA> The fields included in this area N/A

provide information about the
XML document such as BSR,
SENDER, and DATETIME
described below.
<BSR> Shows the Business Service N/A

Request name per OAGI.
<VERB/> Value is SYNC Oracle XML Gateway
<NOUN/> Value is CATALOG Oracle XML Gateway
<REVISION/> Value is 003 Oracle XML Gateway
</BSR> -- --

Column*
<SENDER> Provides information on the N/A

system that sends the
document.
<LOGICALID/> Sender system identifier. Oracle XML Gateway
<COMPONENT/> Sender application name. Oracle XML Gateway
<TASK/> Event or Action. Value is Oracle XML Gateway

CATSO.
<REFERENCEID/> Unique reference ID for this Oracle XML Gateway

doc.
<CONFIRMATION/> Confirmation when doc is Oracle XML Gateway

received. Value is 0 means none
required.
<LANGUAGE/> ISO language in which the text Oracle XML Gateway

fields are transmitted, for
example, US.
<CODEPAGE/> Character set used in this XML Oracle XML Gateway

doc, for example, UTF8.
<AUTHID/> System ID of sender. Value is Oracle XML Gateway

APPS.
</SENDER> -- --
<DATETIME/> Creation date and time of the Oracle XML Gateway

XML document in OAG date
format.
</CNTROLAREA> -- N/A
<DATAAREA> The fields included in this area N/A

provide information about the
data included in the XML
document.
Column*
<SYNC_CATALOG> Exactly one instance is required N/A

within a message.
<CATALOG> The fields included in this area N/A

provide price book information.
Exactly one instance is required
within a message.
<DATETIME/> Pricing effective date and time PBHV.EFFECTIVE_DATE

in OAG date format.
<CATALGNAME/> Name of the price book. PBHV.PRICE_BOOK_NAME
<USERAREA> The fields included in this area N/A

are provided by Oracle.
<PBTYPECODE/> Price book type. Valid values PBHV.PRICE_BOOK_TYPE_CO

are F and D. DE
<CURRENCYCODE/> Currency code PBHV.CURRENCY_CODE
<ITEMQUANTITY/> Item quantity to be used for all PBHV.ITEM_QUANTITY

items in the price book.
<LIMITPRODUCTSBYCO Product filter type. Valid values IHV.LIMIT_PRODUCTS_BY

DE/> are ITEM, ITEM_CATEGORY,
ALL_ITEMS, and PRICE_LIST.
<ITEM/> Internal item name referred to IHV.PRODUCT_NAME

by
LIMITPRODUCTSBYCODE..
<ITEMCATEGORY/> Internal item category name IHV.PRODUCT_NAME

referred to by
LIMITPRODUCTSBYCODE.
<PRICELIST/> Price list name referred to by IHTL.PL_AGR_BSA_NAME

either
LIMITPRODUCTSBYCODE
and/orEBASEDONCODE.

Column*
<PRICEBASEDONCODE/ Entity type for which the IHV.PRICE_BASED_ON

> pricing is based on, namely the
pricing basis. Valid values are
PRICE_LIST, AGREEMENT,
and BSA.
<AGREEMENT/> Agreement name referred to by IHTL.PL_AGR_BSA_NAME

PRICEBASEDONCODE.
<BSA/> Sales Agreement Number IHTL.PL_AGR_BSA_NAME

referred to by
PRICEBASEDONCODE.
<PBATTR> The fields included in this area N/A

describe a price book input
attribute.
<CTXT/> Context name of attribute. ILV.CONTEXT
<ATTR/> Attribute name ILV.ATTRIBUTE
<ATTRVALUE/> Attribute value name such as "2 ILV.ATTRIBUTE_VALUE

Net."
<ATTRTYPE/> Attribute type. Valid values are ILV.ATTRIBUTE_TYPE

PRICING_ATTRIBUTE and
QUALIFIER_ATTRIBUTE.
</PBATTR> -- N/A
<PBHEADERMSG> The fields included in this area N/A

describe a price book header
error message.
<TYPE/> Message type PBMV.MESSAGE_TYPE
<CODE/> Message code PBMV.MESSAGE_CODE
<TEXT/> Message text PBMV.MESSAGE_TEXT
</PBHEADERMSG> -- N/A
Column*
<PARTNER> The fields included in this area N/A

describe the customer for which
the price book has been created.
<NAME/> Customer name PBHV.CUSTOMER_NAME
<PARTNRID/> Customer ID PBHV.CUSTOMER_ID

<CUSTACCT/> Internal customer account ID PBHV.CUST_ACCOUNT_ID
</USERAREA> -- --
</PARTNER> -- N/A
<CATITEM> The fields included in this area N/A

describe a price book line.
<ITEM/> Internal item number PBLV.ITEM_NUMBER
<SYNCIND/> Sync action indicator PBLV.SYNC_ACTION_CODE
<DESCRIPTN/> Internal item description PBLV.DESCRIPTION

<LISTPRICE/> List price PBLV.LIST_PRICE
<UOMCODE/> UOM code PBLV.PRODUCT_UOM_CODE
<NETPRICE/> Net price PBLV.NET_PRICE
<LINESTATUSCODE/> Line status code PBLV.LINE_STATUS_CODE
<ITEMCAT> The fields included in this area N/A

describe a category in which the
item belongs.

Column*
<ITEMCATEGORY/> Item category name PBAV.ATTRIBUTE_VALUE_N

AME
</ITEMCAT> -- N/A
<PBLINEMSG> The fields included in this area N/A

describe a price book line error
message.
<TYPE/> Message type PBMV.MESSAGE_TYPE
<CODE/> Message code PBMV.MESSAGE_CODE
<TEXT/> Message text PBMV.MESSAGE_TEXT
</PBLINEMSG> -- N/A
<PBLINEDETAIL> The fields included in this area N/A

describe a price book line detail
(such as price list lines and
modifiers).
<DETAILTYPE/> Line type PBLDV.LIST_LINE_TYPE
<BREAKTYPE/> Price break type PBLDV.PRICE_BREAK_TYPE
<LISTPRICE/> List price PBLDV.LIST_PRICE
<LISTNAME/> Name of either price list or PBLDV.LIST_NAME

modifier list
<MODLINENO/> Modifier number PBLDV.LIST_LINE_NO
<MODOPERAND/> Modifier operand PBLDV.MODIFIER_OPERAND
<MODAPPMETHOD/> Modifier application method PBLDV.MODIFIER_APPLICAT

ION_METHOD
<ADJAMT/> Modifier adjustment amount PBLDV.ADJUSTMENT_AMOU

NT
Column*
<CNETPRICE/> Cumulative net price PBLDV.ADJUSTED_NET_PRIC

E
<PBLINEATTR> The fields included in this area N/A

describe an attribute attached to
the price list line.
<CTXT/> Context name of attribute PBAV.CONTEXT_NAME
<ATTR/> Attribute name PBAV.ATTRIBUTE_NAME
<ATTRVALFROM/> Attribute FROM value PBAV.ATTRIBUTE_VALUE_N

AME
Note: This does not
correspond to the meaning
or description of the value,
but rather the value or ID.
<ATTRVALTO/> Attribute TO value PBAV.ATTRIBUTE_VALUE_T

O_NAME
<ATTRTYPE/> Attribute type. Valid value is PBAV.PRICING_PROD_ATTR_

PRICING_ATTRIBUTE. DATATYPE
</PBLINEATTR> -- N/A
<PBLINEBRK> The fields included in this area N/A

describe the price breaks
defined for the price book line
detail.
<CTXT/> Context name of attribute PBBLV.CONTEXT_NAME
<ATTR/> Attribute name PBBLV.ATTRIBUTE_NAME

Column*
<ATTRVALFROM/> Attribute FROM value PBBLV.ATTRIBUTE_VALUE_N

AME
Note: This does not
correspond to the meaning
or description of the value,
but rather the value or ID.
<ATTRVALTO/> Attribute TO value PBBLV.ATTRIBUTE_VALUE_T

O_NAME
<ATTRTYPE/> Attribute type. Valid value is PBBLV.PRICING_ATTRIBUTE_

PRICING_ATTRIBUTE. DATATYPE
<OPERAND/> Price break line operand PBBLV.OPERAND
</PBLINEBRK> -- N/A
</PBLINEDETAIL> -- N/A
</USERAREA> -- N/A
</CATITEM> -- --
</CATALOG> -- N/A
</GET_CATALOG> -- N/A
</DATAAREA> -- N/A
The following displays the structure of the SYNC_CATALOG message:
<SYNC_CATALOG_003>
<CNTROLAREA>
<BSR>
<VERB value="SYNC"/>
</BSR>
<SENDER>
<TASK>CATSO</TASK>
<REFERENCEID/>
<CONFIRMATION/>
<LANGUAGE/>
<CODEPAGE/>
<AUTHID/>
</SENDER>
<DATETIME qualifier="CREATION" type="T" index="1">
<YEAR>2005</YEAR>
<MONTH>12</MONTH>
<DAY>13</DAY>
<HOUR>16</HOUR>
<MINUTE>35</MINUTE>
<SECOND>49</SECOND>
<TIMEZONE>+0000</TIMEZONE>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SYNC_CATALOG>
<CATALOG>
<DATETIME qualifier="EFFECTIVE" type="T" index="1">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<CATALGNAME/>
<SYNCIND/>
<CATALOGRV/>
<CLSSSCHMID/>
<DESCRIPTN/>
<USERAREA>
<PBTYPECODE/>
<CURRENCYCODE/>
<ITEMQUANTITY/>
<LIMITPRODUCTSBYCODE/>
<ITEM/>
<ITEMCATEGORY/>
<PRICELIST/>
<PRICEBASEDONCODE/>
<AGREEMENT/>
<BSA/>
<PBATTR>
<CTXT/>
<ATTR/>
<ATTRVALUE/>

<ATTRTYPE/>
</PBATTR>
<PBHEADERMSG>
<TYPE/>
<CODE/>
<TEXT/>
</PBHEADERMSG>
</USERAREA>
<PARTNER>
<NAME index="1"/>
<PARTNRID/>
<PARTNRTYPE/>
<PARTNRIDX/>
<USERAREA>
<CUSTACCT/>
</USERAREA>
</PARTNER>
<CATITEM>
<ITEM/>
<SYNCIND/>
<DESCRIPTN/>
<USERAREA>
<LISTPRICE/>
<UOMCODE/>
<NETPRICE/>
<LINESTATUSCODE/>
<ITEMCAT>
<ITEMCATEGORY/>
</ITEMCAT>
<PBLINEMSG>
<TYPE/>
<CODE/>
<TEXT/>
</PBLINEMSG>
<PBLINEDETAIL>
<DETAILTYPE/>
<BREAKTYPE/>
<LISTPRICE/>
<LISTNAME/>
<MODLINENO/>
<MODOPERAND/>
<MODAPPMETHOD/>
<ADJAMT/>
<CNETPRICE/>
<PBLINEATTR>
<CTXT>
<ATTR>
<ATTRVALFROM>
<ATTRVALTO>
<ATTRTYPE>
</PBLINEATTR>
<PBLINEBRK>
<CTXT/>
<ATTR/>
<ATTRVALFROM/>
<ATTRVALTO/>
<ATTRTYPE/>
<OPERAND/>
</PBLINEBRK>
</PBLINEDETAIL>
</USERAREA>
</CATITEM>
</CATALOG>
</GET_CATALOG>
</DATAAREA>
</SYNC_CATALOG_003>
Trading Partner Setup

The Sync Catalog transaction uses Oracle XML Gateway to send the outgoing messages
To use this transaction, you must define a trading partner and enable the
SYNC_CATALOG message for this partner in the Oracle XML Gateway Define Trading
Partner Setup window. The relevant message for this transaction has transaction type
QP and transaction subtype CATSO. For more information, see the Oracle XML Gateway
User's Guide.
Validation of Sync Catalog Transaction

Standard Validation
No validation is required because there are no input parameters to SYNC_CATALOG.
Oracle Advanced Pricing generates the SYNC_CATALOG message and delivers the
message via the Oracle XML Gateway.
Error Handling
Although no validation is required, you can view any unexpected error messages using
the Oracle XML Gateway Transaction Monitor and/or Oracle Workflow Status Monitor.
For more information, see the available documentation for these modules.
Examples of Sync Catalog Transaction

The following examples show a full price book and a delta price book.
Full Price Book
The following example describes a generated full price book with the following
characteristics:
• The price book is named "2006 - AS54999," effective 10/04/2006.
• The price book contains only item "AS54999."
• The price book is based on price list "Computer Desktops and Accessories."
• The item "AS54999" has a list price of $100 and a net price of $75.
• The pricing details include:

• a price list line from "Computer Desktops and Accessories" with list price $100.
• a modifier from "F06-1" yielding a $10 discount.
• a modifier from "F06-1" yielding a 15% discount.

<SYNC_CATALOG_003>
<CNTROLAREA>
<BSR>
</BSR>
<SENDER>
<TASK>CATSO</TASK>
<REFERENCEID/>
</SENDER>
<YEAR>2006</YEAR>
<MONTH>02</MONTH>
<DAY>24</DAY>
<HOUR>10</HOUR>
<MINUTE>04</MINUTE>
<SECOND>15</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SYNC_CATALOG>
<CATALOG>
<YEAR>2006</YEAR>
<MONTH>10</MONTH>
<DAY>04</DAY>
<HOUR>15</HOUR>
<MINUTE>30</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<CATALGNAME>2006 – AS54999</CATALGNAME>
<SYNCIND/>
<CATALOGRV/>
<CLSSSCHMID/>
<DESCRIPTN/>
<USERAREA>
<ITEM>AS54999</ITEM>
<ITEMCATEGORY/>
<AGREEMENT/>
<BSA/>
<PBATTR>
<CTXT>Order</CTXT>
</PBATTR>
<PBATTR>
<CTXT>Terms</CTXT>
<ATTR>Payment Terms</ATTR>
</PBATTR>
</USERAREA>
<PARTNER>
<NAME index="1">Business World</NAME>
<PARTNRID>4429</PARTNRID>
<PARTNRTYPE/>
<PARTNRIDX/>
<USERAREA>
<CUSTACCT/>
</USERAREA>
</PARTNER>
<CATITEM>
<ITEM>2155</ITEM>
<SYNCIND/>
<DESCRIPTN>Sentinel Standard Desktop-Rugged</DESCRIPTN>
<USERAREA>
<LISTPRICE>100</LISTPRICE>
<UOMCODE>Ea</UOMCODE>
<NETPRICE>75</NETPRICE>
<LINESTATUSCODE/>
<ITEMCAT>
<ITEMCATEGORY>MISC.MISC.</ITEMCATEGORY>
</ITEMCAT>
<ITEMCAT>
<ITEMCATEGORY>COMPUTER.DESKTOP</ITEMCATEGORY>
</ITEMCAT>
<ITEMCAT>
<ITEMCATEGORY>Computer/Hardware/Desktop</ITEMCATEGORY>
</ITEMCAT>
<PBLINEDETAIL>
<DETAILTYPE>Price List Line</DETAILTYPE>
<BREAKTYPE/>
<LISTNAME>Computer Desktops and Accessories</LISTNAME>
<MODLINENO/>
<MODOPERAND/>
<MODAPPMETHOD>UNIT_PRICE</MODAPPMETHOD>
<ADJAMT/>
<CNETPRICE>100</CNETPRICE>
</PBLINEDETAIL>
<PBLINEDETAIL>
<DETAILTYPE>Discount</DETAILTYPE>
<BREAKTYPE/>
<LISTPRICE/>
<LISTNAME>F06-1</LISTNAME>
<MODLINENO>609637</MODLINENO>
<MODOPERAND>10</MODOPERAND>
<MODAPPMETHOD>AMT</MODAPPMETHOD>
<ADJAMT>-10</ADJAMT>
</PBLINEDETAIL>
<PBLINEDETAIL>
<BREAKTYPE/>

<LISTPRICE/>
<MODAPPMETHOD>%</MODAPPMETHOD>
</PBLINEDETAIL>
</USERAREA>
</CATITEM>
</CATALOG>
</SYNC_CATALOG>
</DATAAREA>
</SYNC_CATALOG_003>
Delta Price Book
The following example shows a generated delta price book with the following
characteristics:
• The delta price book is named 2006 - AS54999 effective 01/04/2007.
• The delta price book contains only one item AS54999 whose price has changed
when compared with the full price book.
• The item AS54999 has a list price of $100 and a net price of $65.
• The pricing details include:

• a price list line from Computer Desktops and Accessories with list price $100
• a modifier from F06-1 yielding a $10 discount
• a modifier from F06-1 yielding a 15% discount
• a modifier from W06-1 yielding a 10% discount
<SYNC_CATALOG_003>
<CNTROLAREA>
<BSR>
</BSR>
<SENDER>
<TASK>CATSO</TASK>
<REFERENCEID/>
</SENDER>
<YEAR>2006</YEAR>
<MONTH>02</MONTH>
<DAY>24</DAY>
<HOUR>15</HOUR>
<MINUTE>50</MINUTE>
<SECOND>23</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SYNC_CATALOG>
<CATALOG>
<YEAR>2007</YEAR>
<MONTH>01</MONTH>
<DAY>04</DAY>
<HOUR>15</HOUR>
<MINUTE>30</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<CATALGNAME>2006 – AS54999</CATALGNAME>
<SYNCIND/>
<CATALOGRV/>
<CLSSSCHMID/>
<DESCRIPTN/>
<USERAREA>
<PBTYPECODE>D</PBTYPECODE>
<ITEMCATEGORY/>
<AGREEMENT/>
<BSA/>
<PBATTR>
<CTXT>Order</CTXT>

</PBATTR>
<PBATTR>
<CTXT>Terms</CTXT>
<ATTR>Payment Terms</ATTR>
</PBATTR>
</USERAREA>
<PARTNER>
<NAME index="1">Business World</NAME>
<PARTNRTYPE/>
<PARTNRIDX/>
<USERAREA>
<CUSTACCT/>
</USERAREA>
</PARTNER>
<CATITEM>
<ITEM>2155</ITEM>
<SYNCIND/>
<DESCRIPTN>Sentinel Standard Desktop
- Rugged</DESCRIPTN>
<USERAREA>
<UOMCODE>Ea</UOMCODE>
<NETPRICE>65</NETPRICE>
<LINESTATUSCODE/>
<ITEMCAT>
<ITEMCATEGORY>MISC.MISC.</ITEMCATEGORY>
</ITEMCAT>
<ITEMCAT>
<ITEMCATEGORY>COMPUTER.DESKTOP</ITEMCATEGORY>
</ITEMCAT>
<ITEMCAT>
<ITEMCATEGORY>Computer/Hardware/
Desktop</ITEMCATEGORY>
</ITEMCAT>
<PBLINEDETAIL>
<DETAILTYPE>Price List Line</DETAILTYPE>
<BREAKTYPE/>
<LISTNAME>Computer Desktops and
Accessories </LISTNAME>
<MODLINENO/>
<MODOPERAND/>
<MODAPPMETHOD>UNIT_PRICE</MODAPPMETHOD>
<ADJAMT/>
</PBLINEDETAIL>
<PBLINEDETAIL>
<BREAKTYPE/>
<LISTPRICE/>
<MODAPPMETHOD>AMT</MODAPPMETHOD>
</PBLINEDETAIL>
<PBLINEDETAIL>
<BREAKTYPE/>
<LISTPRICE/>
<LISTNAME>W06-1</LISTNAME>
</PBLINEDETAIL>
<PBLINEDETAIL>
<BREAKTYPE/>
<LISTPRICE/>
</PBLINEDETAIL>
</USERAREA>
</CATITEM>
</CATALOG>
</SYNC_CATALOG>
</DATAAREA>
</SYNC_CATALOG_003>

4
Oracle Order Management XML
Transactions: Implementation
Considerations

• Process_PO
• Acknowledge_PO
• Show_SalesOrder
• Change_SalesOrder
• Change_PO
• Cancel_PO
• Open Interface Tracking
• Integration Event – oracle.apps.ont.oi.xml_int.status
Process_PO
Setup: Customer Setup

Using the Oracle Order Management Super User responsibility, Customer Standard
window (Customers-> Standard), query a customer for whom o create XML orders. On
one of the customer's addresses, create a primary Sold To site usage and specify an EDI
Location (for example Q7Q-1A1). Save your work. When provided on the inbound XML
document, this information will be used to denote a particular customer site and also to
determine the destination of the acknowledgment.
Oracle Order Management XML Transactions: Implementation Considerations 4-1

The following table lists the setup steps for Process_PO:
Process_PO Setup Steps
Step Description
1 Define Transactions
2 Define Trading Partner/Hub
3 Define Code Conversion
4 Set Up the Oracle Workflow Business Event

System
Define Transactions
Use Oracle XML Gateway to define a cross reference between the Oracle transaction
name and the external transaction name. The external transaction name will be based on
what is meaningful per the XML standard used by the recipient. The external
transaction name will appear on the message envelope to support message transport.
Define Trading Partner/Hub
e-Business can be conducted directly with a business partner commonly known as a
trading partner or by means of a hub such as Oracle Exchange where many buyers and
sellers converge to conduct electronic commerce.
With Oracle XML Gateway, you can define the hub or the actual business partner as a
trading partner. If you define the hub as the trading partner, you can identify all the
buyers and sellers who are conducting business on the hub as trading partners to the
hub.
Included in the trading partner/hub definition are the following:
• Trading partner/hub name
• Message enabled
• Message confirmation requested
• Message map to use for message creation or consumption
• E-mail address of trading partner contact to notify for data errors
• Trading partner specific code conversion values
• Transport protocol - SMTP, HTTP, and HTTPS with credential and

username/password as necessary

The Trading Partner Setup window is used to:
• Enable messages for the trading partner by identifying the internal and external
transaction type and transaction subtype codes, and the XML standard associated
with the message.
• Access the Trading Partner Code Conversion window.
• Select a message map for the trading partner.
• Identify the communications protocol and address for a message. Optionally, the
user can be selected from a hub.
To set up a trading partner:

1. Navigate to the Define Trading Partner Setup form from the XML Gateway
Responsibility by selecting Setup > Define Trading Partners.
2. Enter Customer in the Trading Partner Type field.
3. Select values in the Trading Partner and the Trading Partner Site fields.
4. Select ONT in the Transaction Type field.
5. Select ONT_3A4R_OAG72_IN in the Map field.
6. Save your work.
Define Code Conversion
With Oracle XML Gateway, you can identify the cross reference of an Oracle code to
something that is meaningful to the recipient or vice versa. Common examples of
Oracle e-Business Suite codes requiring code conversion are units of measure and
currency code.
Code conversion values can be defined to be applied universally for all trading partners
and all messages. Additionally, code conversion values can be defined for a specific
XML standard or specific to a trading partner.
The Oracle XML Gateway code conversion function provides a method to cross–
reference the codes defined in Oracle Applications to codes used by trading partners,
the XML standard, or other standard codes in the transactions.
The Code Conversion Standard code determines to which transaction standard these
values are applied. A standard code of UNIVERSAL applies these values across all
standards. In this case use the Code Conversion window from the Navigator Setup
menu.
Define the Subscribing System for the Event Subscription for the Event
'oracle.apps.ont.oi.po_inbound.create'
Subscriber: System - This will usually be the local system, the system where the
subscription code is to run.
Note: This data will be available as the initial setup, and comes as an
XML file and will be loaded to the customer system. The user of the

system can change it to work for their system settings.
Set Up the Oracle Workflow Business Event System

Oracle XML Gateway leverages the Oracle Workflow Business Event System to publish
and subscribe to application business events of interest to automatically trigger message
creation or consumption.
Seeded business events and event subscriptions to send outbound or consume inbound
messages are delivered for all Oracle pre-built messages.
Note: The seeded event subscriptions can be configured during

implementation to perform activities to address specific business
requirements.
The XML Gateway Execution Engine interfaces with Oracle Workflow to actively notify
the XML Gateway system administrator regarding system or process errors, or the
trading partner contact for data errors.
The XML Gateway system administrator has the option to "retry" failed outbound
processes, or "reprocess" failed inbound processes.
The following function is internal to the XML Gateway Execution Engine:
Validate Trading Partner/Hub
Verify that the trading partner is defined and the required documents are enabled.
Message Set Up
To implement a message with a trading partner, use XML Gateway message set up to
define the trading partner or hub, code conversion values, and internal to external
transaction name cross references. In addition, you can identify the XML Gateway
system administrator to notify for system or process errors.
Installation
This functionality is available as part of Oracle Order Management.
Loading of Message Map and DTD

Oracle message maps are delivered and installed as a part of Oracle Order Management
file structure and schema. They are automatically loaded into the XML Gateway
repository using the LoadMap program. The reports are available to verify the success
of the loading process.
Enabling and Consuming the Business Event

The necessary business events and subscriptions are also delivered and installed as part
of the schema, they are loaded by the driver.
Integrations
• Oracle XML Gateway
• Oracle Workflow
• Oracle Advanced Queuing
Message Map: Seeded Workflow for Inbound XML Messages

A pre-defined Workflow event is seeded to run Order Import immediately if the Profile
Option OM: Run Order Import for XML is set to 'Synchronous.' This Workflow
subscribes to the event raised by the Post Process of the XML Gateway. As part of the
Workflow Process it will run Order Import for the XML message, that is currently being
consumed. The following Workflow is designed using Workflow Builder 2.6.
Order Import Flow - Generic
Raise Send CBOD Out Sub Process

Run Order Import Sub Process
Raise Send Acknowledgement Sub Process
Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO
Step Buyer System E.G. Oracle Oracle Order Management

Purchasing
0 Figure, "Trading Partner

Setup completed for Oracle
Order Management via XML
Gateway forms"
Figure, "Profile Option 'OM:

Run Order Import for XML'
set to 'SYNCHRONOUS' at
site-level"
1 Figure, "Buyer approves a

Purchase Order"
2 Figure, "Order Management

receives the Purchase Order
electronically as a Process PO
XML document"
Figure, "Open Interface

Tracking Details Main Tab"
Figure, "Results Summary

Inbound Message Details"

Purchasing
3 Figure, "Seeded inbound

workflow is automatically
triggered and runs Order
Import"
Figure, "Corresponding XML

Sales Order is created
Header"
Figure, "Corresponding XML

Sales Order is created Lines"
4 Figure, "Seeded outbound

workflow is automatically
triggered. This flow generates
and sends Acknowledge PO
to the buyer"
Figure, "Status Diagram"
Figure, "Transaction Monitor"
Figure, "Results Summary"

Outbound Message Details"
Trading Partner setup completed for Oracle Order Management using XML Gateway
forms
Profile Option 'OM: Run Order Import for XML' set to 'SYNCHRONOUS' at site-level
Buyer approves a Purchase Order

Order Management receives the Purchase Order electronically as a Process PO XML
document
Open Interface Tracking Details Main Tab

Results Summary Inbound Message Details
Seeded inbound workflow is automatically triggered and runs Order Import

Corresponding XML Sales Order is created Header
Corresponding XML Sales Order is created Lines
Seeded outbound workflow is automatically triggered. This flow generates and sends
Acknowledge PO to the buyer

Status Diagram
Transaction Monitor

Results Summary
Results Summary Outbound Message Details

Acknowledge_PO
Message Map

Oracle message maps are delivered and installed as a part of the Oracle Order
Management file structure and schema. They are automatically loaded into the XML
Gateway repository using the LoadMap program. The reports are available to verify the
success of the loading process.

Create the Business Event and a Subscription for the event in the Application using the
Workflow Administrator Responsibility. This event will be raised by the Post Process
Action once the XML Message is consumed by Oracle XML Gateway and the data is
loaded in the Open Interface Tables.

window (Customers-> Standard), query a customer to create XML orders for. On one of
the customer's addresses, create a primary Sold To site usage and specify an EDI
Location (e.g. Q7Q-1A1). Save your work. When provided on the inbound XML
Before performing these Order Management Suite XML setup steps, check the
documentation for the following areas and verify that you have performed their set up:
• The Oracle Applications with which this transaction deals
• Oracle Workflow
Setup Steps
Step Description New Transaction Transaction

Development Implementation
1 Define Transactions Required Optional
2 Define Trading NA Required

Partner and Hub

Step Description New Transaction Transaction
Development Implementation
3 Define Code Required Required

Conversion
4 Setup Oracle NA As Needed

Workflow Business
Event System
Define Transactions
Define Trading Partner and Hub

e-Business may be conducted directly with a business partner commonly known as a
trading partner or via a hub such as Oracle Exchange where many buyers and sellers
converge to conduct electronic commerce.
hub.
• Trading Partner/Hub name
• Message enabled
• Trading Partner specific code conversion values
• Transport protocol - SMTP, HTTP, or HTTPS with credential and username and
password as necessary
With Oracle XML Gateway, you may identify the cross reference of an Oracle code to
currency code.
Code conversion values may be defined to be applied universally for all trading
partners and all messages. Additionally, code conversion values may be defined for a
specific XML standard or specific to a trading partner.
Setup Oracle Workflow Business Event System

The following seeded event subscription, will listen to the event
oracle.apps.ont.oi.po_acknowledge.create and will send the acknowledgment.
The XML Gateway system administrator has the option to retry failed outbound
processes, or reprocess failed inbound processes.
The raising of this event can be done, as part of the new workflow added for the Order
Import Inbound flow. After Order Import (Run Order Import), finishes with the status
complete we will Raise event, that will be received by above workflow for creating the
acknowledgment.
The above workflow will be provided as standard flow (where the acknowledgment is
sent when the synchronous flow of order import completes), the user can move the
event and put it anywhere in their existing standard flow.
Message Set Up
transaction name cross references. In addition, you may identify the XML Gateway
The raising of this event can done, as part of the new workflow added for the Order
Import Inbound flow. After Order Import (Run Order Import), finish with status

complete we will Raise event, which will be received by above workflow for creating
the acknowledgment.
Oracle XML Gateway Details

This table lists the Oracle XML Gateway Details.
Oracle XML Gateway Details
Detail Value
Message Map Name: ONT_3A4A_OAG72_OUT_PO
Direction: Outbound
(Internal) Transaction Type: ONT
(Internal) Transaction Subtype: POA
External Transaction Type: PO
External Transaction Subtype: ACKNOWLEDGE
DTD Directory: xml/oag72
Map Directory: patch/115/xml/US
Message Maps XGM File Name: ONT_3A4A_OAG72_OUT_PO.xgm
Standard: OAG
Release: 7.2
Format: DTD
DTD Name: 004_acknowledge_po_008.dtd
USERAREAs
This table explains the data in the USERAREAs.
USERAREA Data
Within Data Type Data Element Content
POORDERLIN USERITEMDESCRIPTN User Item Description
POLINESCHD ACKCODE Acknowledgment Code
POLINESCHD DATETIME Scheduled Arrival Date
POLINESCHD SALESORDID Sales Order Number
POLINESCHD SOLINENUM Line Number
Seed Codes for the Code Conversion

Following elements need to be enabled for code conversions:
• Currency
• UOM
• POType
• AckCode
• Termid
• Line Status
Show_SalesOrder
Setup

Oracle message maps are delivered and installed as a part of the Oracle Order

Create the Business Event and a Subscription for the event in the application using the
Workflow Administrator responsibility. This event will be raised by the either the WF
process (WF Support), the Concurrent Program (Periodical Support), or through the
Order Management internal processing (Attribute/Status Change Support).
window (Customers-> Standard), query a customer to create XML orders for. On one of
the customer's addresses, create a primary Sold To site usage and specify an EDI
Location (e.g. Q7Q-1A1). Save your work. When provided on the inbound XML
Setup Steps
Step Description
3 Define Code Conversion
Step Description
4 Setup Oracle Workflow Business Event

System
5 Setting Up Constraints
Define Transactions

e-Business may be conducted directly with a business partner commonly known as a
hub.
• Message enabled
• Transport protocol - SMTP, HTTP, or HTTPS with credential and

• Source Location Code

With Oracle XML Gateway, you may relate the cross reference of an Oracle code to

currency code.
Code conversion values may be defined to be applied universally for all trading
partners and all messages. Additionally, code conversion values may be defined for a
specific XML standard or specific to a trading partner.
Setup Oracle Workflow Business Event System

and subscribe to application business events of interest, to automatically trigger
message creation or consumption.
The following seeded event subscription will listen to the event
oracle.apps.ont.oi.showso.create and will send the acknowledgment.
Workflow Support
The raising of this event can be done, as part of the any existing workflow available for
Order Header (OEOH) or/and Order Line (OEOL) flow. The following example shows
one of the positions where the raise event process can be inserted for sending the 3A6 in
OEOH flow (after Booking), the process should be copied (or created same way) from
the new workflow (OESO).
Note: This is currently only supported for the OEOH flow (Pack J onwards).
The Raise Show Sales Order Event Sub Process will check if the Sold To customer on the
order is set up as a Trading Partner. If the customer is enabled for 3A6 Show SO, the
sub-process will raise the event oracle.apps.ont.oi.show_so.create to generate and send
the 3A6 Show SO XML document for XML orders.
In addition, the event oracle.apps.ont.oi.xml_int.status will be also be raised (for both
XML and non-XML orders).
Workflow for The Raise Event
Raise Event Position -
Standard OM Workflow (OEOH/OEOL) The workflow will continue to the point

where the raise event is entered. When it hit
raise event, the Show SO (3A6) with status
will be send.
Validate Trading Partner/Hub

Verify that the trading partner is defined and required document are enabled.
Additional User Setup
ON Demand
ON Demand generation of the Show_SalesOrder, can be achieved by running the
concurrent program on an as needed basis (this means run the concurrent program to
send the Show_SalesOrder).
Attribute Change
No User setup is required for the Show_SalesOrder in event of following attributes
change:
• Unit selling Price
• Ordered Qty
• Scheduled arrival date
• Shipped Qty
• Scheduled Ship Date
Any time any of these attributes change for an order (after the order has been booked)
Order Management will generate the Show_Salesorder message.

Adding a new line to a booked order will also generate a Show_Salesorder message.
Splitting a line on a booked order will also generate a Show_Salesorder message.
Status Change
No User setup is required for the Show_SalesOrder in event of following status change:
• Booking the order
• Shipping
• Scheduling of lines
When an order or line status changes, the show SO is generated.
Partner Segment Information for Partner type 'Supplier' Not Mapped

The Partner segment Supplier will be derived from the setup in XML Gateway. Trading
partner setup allows the setup of source location code, which is a source trading partner
location code for the particular trading partner and particular transaction (in many
cases this could be the location code of the supplying warehouse). This data will be
picked up by Order Management to populate the Supplier location code on the
outbound Show_SalesOrder message.
Make sure that while performing the trading partner setup the source location for the
outbound transaction (for Order Management) is set up. This source location needs to
be a valid EDI location code that will be validated by the XML Gateway and the Oracle
Application Server 10g (in case of Rosettanet implementations).
See the User Procedures section for additional information about this setup.
User Procedures
Defining Trading Partners
with the message.
• Access the Trading Partner Code Conversion form.
• Select a message map for the trading partner.
• Identify the communications protocol and address for a message. Optionally, the
user can be selected from a hub.
To define a trading partner:

1. Navigate to the Define Trading Partner Setup window from the XML Gateway
Responsibility. Setup > Define Trading Partners.
2. Enter the Trading Partner Type, Customer.
3. Select the Trading Partner and Trading Partner Site.
4. Select the transaction type as 'ONT' for this functionality.
5. Select 'ONT_3A6_OAG72_OUT_SSO' as the map.
6. Save your work.
Define Code Conversion Values

The Code Conversion Standard code determines which transaction Standard these
values are applied to. A Standard Code of 'UNIVERSAL' applies these values across all
Standards. In this case run the Code Conversion form from the Navigator Setup menu.
Define the Subscribing System for the event subscription for event
'oracle.apps.ont.oi.show_so.create'
Subscriber: System - This will usually be the local system, the system on which the
Define the Source Trading Partner Location Code
Setup the Source trading partner EDI Location Code. This EDI location Code will be
used as the Suppliers EDI Location code which is sent as the PARTNRIDX for Partner
'Ship From.'
This is as part of the Trading Partner Setup window. For each trading partner that you
have, specify the supplier location code to send on the Outbound XML transaction.
Setting Up Constraints
This details the setups required for constraint-based generation of an XML integration
event and the Show SO XML document.
You can setup a user action called 'Raise Integration Event' in the Constraints window.
This can be set for any attribute that is available and for any operation.
This action will raise the 'oracle.apps.ont.oi.xml_int.status' workflow business event.
Interested parties can subscribe to the event in a workflow to perform any desired
actions. Also, if the Customer on the order is defined as a trading partner in XML
Gateway and is enabled to receive the Show SO transaction, a Show SO XML document
will be generated and sent to that Customer.
You can also use the validation templates to perform any necessary validations before
raising the event and sending the XML document. For example, if the event should be
raised only for a specific trading partner then a validation template can be utilized to
check for the customer corresponding to that trading partner.
Constraint conditions can be defined to control exactly when your constraint will be
triggered. Those conditions can be set up such that multiple conditions need to be

satisfied for triggering (i.e. logical AND) or such that satisfaction of any particular
condition will trigger the constraint (i.e. logical OR).
Through use of constraint-based generation, you have more flexibility to dynamically
control the raising of integration events as well as the generation of the Show SO
message. A detailed setup example can be found in the next section.
Please refer to Oracle Order Management Implementation Manual for more detailed
information on how to setup constraints.
The following is an example of how to set up constraints to raise an Integration event if
the salesperson on an order changes:
1. Navigate to the Processing Constraints window using Order Mangement Super
User responsibility (Setup => Rules => Security => Processing Constraints.
2. Create the constraint. Query the constraints for the Application 'Oracle Order
Management' and the Entity 'Order Header.'
3. Navigate to the Constraints section of the window and enter a new constraint with
the following specifications:
Operation =>'UPDATE' (this field specifies which operation will fire your constraint…
i.e. INSERT, UPDATE, or DELETE)
Attribute =>'Salesperon' (this field restricts your constraint to fire when the operation
occurs on a particular attribute)
User Action =>'Raise Integration Event' (this field specifies what will happen if your
constraint is fired)
Enabled =>checked
Once this constraint has been saved, any updates to the Header-level Salesperson on an
order will raise an integration event.
The constraints framework also provides the flexibility to restrict this behavior to orders
that satisfy particular conditions. For instance, you could set up your constraint so you
only raise integration events for Salesperson changes for the customer "Computer
Service and Rentals." To do this you would need to define a condition on your
constraint and, consequently, an appropriate validation template.
To create the necessary validation template:
1. Navigate to the Validation Templates window (Setup => Rules => Security =>
Validation Templates). Then create a new template with the following
specifications:
Entity => 'Order Header'

Template Name => 'Customer Restricition Template'
Short Name => 'CUSTRES'
Description => 'Customer Restriction Template'
Validation Type => 'TBL'

1. Designate the Validation Type to be 'TBL', and enter the following information in
the Validation Semantics section of the window:
Column => 'Customer'

Validation Operation => '= (Equal To)'
Value String => 'Computer Service and Rentals'
1. After saving the validation template, you must run the Generate Constraints
Validation Packages concurrent program to make your validation template
available in the Constraints window (Setup => Rules => Security => Generate
Constraints Validation Packages).
After the concurrent process has completed successfully, navigate back to the
Constraints window and query your Salesperson constraint. To add a Condition that
utilizes your newly created validation template by entering the following information:
Group => '101'

Scope => 'Any'
Validation Entity => 'Order Header'
Validation Template => 'Customer Restriction Template'
Enabled =>checked
User Message => 'An integration event is being raised as a result of an UPDATE to
Salesperson'
After this condition is saved, only updates to the Salesperson on orders for Computer
Service and Rentals will raise an integration event. If you wanted to add another
restriction, for instance that the raise only occur after booking, you would simply add
another condition. A seeded validation template called 'Booked' already exists and can
be used for this purpose. Note that the Group # of the additional condition should be
the same as the Group # of the previously added template. This will cause the
conditions to be evaluated together as an AND condition. Differing Group #s would
cause the conditions to be treated separately as an OR condition.
Once the new condition is saved, integration events will only be raised for updates to
the salesperson on booked orders for Computer Service and Rentals.
Change_SalesOrder
Setup
Customer Setup
Setup Steps
Step Description
1 Define Transaction
2 Message Setup
4 Define Code Conversion Values
5 Set the Profile Options

Step Description
6 Loading of Message Map and DTD
7 Enabling and Consuming the Business Event
Define Transaction
name and the external transaction name. The external transaction name will base on
Message Setup
To implement a message with a Trading Partner, use the XML Gateway message set up
to define the Trading Partner or hub, code conversion values, and internal to external
system administrator to notify for system or process errors. Assign the Notify PO
Update transaction to the trading partner.

E-Business may be conducted directly with a business partner commonly known as a
Trading Partner or via a hub such as Oracle Exchange where many buyers and sellers
Trading Partner. If you define the hub as the Trading Partner, you can identify all the
buyers and sellers who are conducting business on the hub as Trading Partners to the
hub.
Included in this definition are the following:
• Message enabled
• E-mail address of Trading Partner contact to notify for data errors
• Transport protocol - SMTP, HTTP, HTTPS with credential and username/password
as necessary
Please refer to the Oracle XML Gateway documentation for further details.
5. Select 'ONT_3A7R_OAG72_OUT_SO' as the map.
6. Save your work.
Define Code Conversion Values

With Oracle XML Gateway, you can create a cross reference between an Oracle code to
a meaningful concept to the recipient or vice versa. Common examples are units of
measure and currency code.
Code conversion values can be defined to be universal for all Trading Partners and all
messages. Additionally, code conversion values may be defined for a specific XML
standard or specific to a Trading Partner.
Note: If consuming 3A8 Change PO Response XML documents sent by

Oracle Purchasing, you must convert the value Response to the Oracle
value of Y using the seeded Code Category DOC_PURPOSE_CODE.
This ensures that the column Response_Flag in
OE_HEADERS_INTERFACE is populated correctly.
Set the Profile Options

All these profile options are site level.
Set the 'OM: Change SO Response Required' the default value for this profile is No.'
Set the value of the profile ONT_ 3A7_RESPONSE_REQUIRED to either Yes or No.
Based on this profile the system will decide whether to put the order line on hold after
the changes are triggered and then wait for either a 3A8 response or a 3A9.
Set the 'OM: Order Accept State for XML' profile.
Based on this profile the system decides what status is sent on the outbound
Acknowlegement. The default value of this profile is Entered.

This is also governed by the value in the tag <Booked Flag> that is mapped in the
inbound transactions. The value in this tag determines whether the order is Booked or
not when it is created. The tag will have a value of Y or N.
Set the 'OM: Send Acknowledgment for Change PO Response' profile.
Set the value of the profile ONT_ 3A8_RESPONSE_ACK to either 'Yes' or 'No' (default
value is 'No').
Based on this profile the system will determine whether or not an Acknowledge PO
message is sent when a 3A8 Change PO response message is received. This profile does
not govern the behavior Acknowledge PO for normal 3A8 Change PO (i.e.
non-response) messages.

3A7 transaction message maps are delivered and installed as part of Oracle Order
Profile Options
Profile Option Name User Profile Name Description
ONT_3A7_RESPONSE_REQ OM: Change SO Response To determine if the Seller

UIRED Required should expect a response to
an outbound Change SO XML
message
ONT_3A8_RESPONSE_ACK OM: Send Acknowledgment Determines whether an

for Change PO Response Acknowledgment will be sent
for the Change PO Response
ONT_XML_ACCEPT_STATE OM: Order Accept State for Determines the order Accept
XML status for outbound XML
messages
The following table determines the status send on the Outbound Acknowledgment.
Status Send on the Outbound Acknowledgement
Profile Booked Flag Order Status Acknowledgement

Status
BOOKED Y Book the Order. Accept
Order in Booked state Pending
Order in Entered state
BOOKED N Don't book the Order Pending
ENTERED Y Book the Order Accept
Order in Booked state 'Accept'
ENTERED N Don't book the Order Accept

of the schema. They are loaded by the driver.
Data Archive and Purge Procedures
Purge Data From the Acknowledgment Tables

Acknowledgment data is deleted from the Acknowledgment tables after the extraction.
Data is left in the tables in case the outbound transaction fails.

Change_PO
Setup Steps
Step Description
1 Define Transaction Type 'ONT' and Subtype

'CHO'
2 Define Trading Partners
3 Define the Subscribing System for the event

subscription for event
4 Message Set Up
5 Define Subscription for the Event

6 Define System Profile Values
Define Transaction Type 'ONT' and Subtype 'CHO'

The transaction type ONT and subtype CHO is seeded for this functionality.
Navigate to the Define Transactions window from the XML Gateway Responsibility by
selecting Setup /rt.jar:$Workflow_JAR_file_directory/wfjava.jar: $
Workflow_JAR_file_directory/jdbc/lib/classes111.zip:" oracle.apps.fnd.wf.WFXLoad –d use
r connect_string lang objectJava
Define Trading Partners

Enable messages for the trading partner by identifying the internal and external
transaction type and transaction subtype codes, and the XML standard associated with
the message.
Access the Trading Partner Code Conversion form.
Select a message map for the trading partner.
Identify the communications protocol and address for a message. Optionally, the user
can be selected from a hub.
Navigate to the Define Trading Partner Setup window from the XML Gateway
Responsibility by selecting Setup DB password:Port mymap.xgm DB password:Port
mapname Define XML Standards.
• Transport protocol - SMTP, HTTP, or HTTPS with credential and

with the message.

5. Select 'ONT_3A8R_OAG72_IN' as the map.
6. Save your work.

(This data will be available as the initial setup, it will be an XML file and is loaded to the
customer system. The user of the system can change it to work for their system
settings).
Define Subscription for the Event 'oracle.apps.ont.oi.po_inbound.create'

Create a subscription for the event 'oracle.apps.ont.oi.po_inbound.create'. The event is
raised in the Post Process by the XML Gateway engine after the Inbound XML Message
is consumed and the data is loaded in the OM Interface tables. This subscription will
then consume this event and in turn run a pre-defined workflow.
Use the Oracle XML Workflow Loader utility to download and upload XML definitions
for Business Event System objects. When you download Business Event System object
definitions from a database, Oracle Workflow saves the definitions as an XML file. This
XML file will be delivered to the Customer as part of the Seed Data.
On UNIX, use the following commands to run the Workflow XML Loader:
jre –classpath "$JREPATH>/rt.jar:$Workflow_JAR_file_directory>:
$Workflow_JAR_file_directory>/wfjava.jar: $Workflow_JAR_file_directory>/wfapi.jar:
$ORACLE_HOME>/jdbc/lib/classes111.zip:" oracle.apps.fnd.wf.WFXLoad –d
user>password> connect_string> protocol> lang> output_file> object> key>Java
Define System Profile Values

The following table lists the System Profile options, which need to be set.
System Profile Values
Profile System Description Required Default Value

Option
OM: Run Order Determines whether No Synchronous

Import for XML Order Import will run
Asynchronously or
Synchronously
The directories listed in the above profiles should also be mentioned in the utl_file_dir
parameter in init.ora
Please refer to the Oracle XML Gateway User's Guide for the setup information.
Message Set Up
Pre-Defined Workflow Event

Workflow Process it will run Order Import for the XML Message, which is currently
being consumed.
Implementation Considerations


To install this functionality, the required prereq patch for the XML gateway should be
installed first.
Message Map
Most data values in the message map are seeded.
Message Map 'ONT_3A8 R_OAG72_IN.xgm'

The message map 'ONT_3A8R_OAG72_IN' is created using the Oracle XML Gateway
Message Designer tool.
The source DTD used is 058_cancel _po_006.dtd, revision 7.2.1 of the Open Application
Group. The other associated external reference DTD files are:
oagis_domains.dtd
oagis_resources.dtd
oagis_fields.dtd
oagis_segments.dtd
oagis_extensions.dtd
oagis_entity_extensions.dtd

All the DTD's will be checked in ONT source area under $ont/xml/oag72.
The target for the Inbound XML Message are the Order Management Open Interface
tables OE_HEADERS_INTERFACE & OE_LINES_INTERFACE.
The INBOUND CHANGE_PO DTD is a three level hierarchy with Order Lines split
into one or more Shipment Lines. The Order Management architecture is however a two
level one with Order Header and one or more Lines. The message map will collapse the
three level XML Message into a two level structure when the data is inserted in the
Order Management Open Interface tables.
Both the message map created using the Message Designer and its associated DTD's are
stored in the database. The following Java programs are available to Load/Delete Maps
or Load/Delete DTD's into/from the XML Gateway repository. Please refer to the Oracle
XML Gateway Manual for more information.
Load/Delete Maps, Load/Delete DTD's

The following process is used only for customizations.
java LoadMap DB username> DB password> Hostname>:Port>:SID> mymap.xgm>
Example: java oracle.apps.ecx.loader.LoadMap apps apps ap505dbs:1521:dev115
ONT_3A8R_OAG72_IN.xgm
1. java DeleteMap DB username> DB password> Hostname>:Port>:SID> mapname>
Example: java oracle.apps.ecx.loader.DeleteMap apps apps ap505dbs:1521:dev115

The Message Map is a .xgm file which will be stored in the Order Management Source
area under $ont/patch/115/map/ ONT_3A8R_OAG72_IN.xgm
Note: Maps and DTD's must be kept in sync between the Message
Designer and the XML Gateway repository. When in doubt, always
reload the map and DTD as a pair.
key: H => OE_HEADERS_INTERFACE, L => OE_LINES_INTERFACE
Mapping the Document to the Order Management Table
Source Target Re Code Derivati Defaul Action PO

q. Catego on Rule t Mapping
CHANGE_P OE_HE ry Value
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
<POHEADER
>
POID H.CUST Y PO_ECX_H

OMER_ EADER_AR
PO_NU CH_V.contr
MBER actb
PHA.SEGM
ENT1
H.CREA Y SYSD Execute

TION_D ATE Function Call
ATE
H.LAST Y FND_ Execute

_UPDA GLOB Function Call
TED_BY AL.LO
GIN_I
D
H.LAST Y SYSD Execute

_UPDA ATE Function Call
TE_DAT
E
H.CREA Y FND_ Execute

TED_BY GLOB Function Call
AL.US
ER_ID

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
H.ORDE Y 20 Get Pre-Defined

R_SOUR Variable Value
CE_ID
H.XML_ Y 'CHO' Get Pre-Defined

TRANS Variable Value
ACTIO
N_TYPE
_CODE
H.XML_ Y Get Pre-Defined

MESSA Variable Value
GE_ID (Internal
Control
Number)
H.OPER Y 'UPD
ATION_ ATE'
CODE
</USERARE
A>
ORGID H.ORG_ Derive Target

ID Org Id using
Sold To Org Id
(if not sent)
ORACLE.CH H.CHA
ANGESEQU NGE_SE
ENCE QUENC
E
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
ORACLE.BO H.BOOK
OKEDFLAG ED_FLA
G
MSGTYPE H.RESP
ONSE_F
LAG
ORACLE.SU H.ORIG
PPLIERDOC _SYS_D
REF OCUME
NT_REF
</USERARE
A>
<PARTNER>
(Supplier)
NAME PO_ECX_H
EADER_AR
CH_V.supp
_org_name
PO_VENDO
RS.VENDO
R_NAME

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
ONETIME PO_ECX_H
EADER_AR
CH_V.supp
_otf
DECODE
(PO_VEND
ORS.ONE_
TIME_FLA
G,'N','0','1')
PARTNRID PO_ECX_H
EADER_AR
CH_V.suppl
ier_partner_
id
PO_VENDO
RS.SEGME
NT1

PARTNRTYP
E
CURRENCY PO_ECX_H
EADER_AR
CH_V.supp
_Currency
PO_VENDO
RS.PAYME
NT_CURRE
NCY_CODE
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
PO_ECX_H
PARTNRIDX EADER_AR
CH_V.suppl
ier_partner_
id_x
NVL(PO_V
ENDOR_SIT
ES_ALL_EC
E_TP_LOC
ATIN_COD
E,PHA.VEN
DOR_ID
ADDRESS1
ADDRESS2
ADDRESS3
ADDRESS4
CITY
COUNTY
POSTALCOD
E
STATEPROV
N
</PARTNER>

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
<PARTNER> Y
(SoldTo)
NAME PO_ECX_H
EADER_AR
CH_V.buyin
g_org_name
HR_ALL_O
RGANIZAT
ION_UNITS
_TL .NAME
ONETIME PO_ECX_H
EADER_AR
CH_V.buyin
g_
org_otf '0
PARTNRID

PARTNRTYP
E
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
CURRENCY PO_ECX_H
EADER_AR
CH_V.buyin
g_org_curre
ncy
GL_SETS_O
F_BOOKS.C
URRENCY_
CODE
H.SOLD Y OE_XM Derive Address PO_ECX_H

PARTNRIDX _TO_OR L_PRO Id from Location EADER_AR
G_ID CESS_U Code CH_V.partn
TIL.GET er_id_x
_SOLD_ Execute
TO_OR Procedure Call HR_LOCAT
G_ID IONS_ALL.
ECE_TP_LO
CATION_C
ODE
ADDRESS1 HR_ORGA
NIZATION
_UNITS_
V.ADDRESS
_LINE_1-3
ADDRESS2
ADDRESS3
ADDRESS4

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
CITY HR_ORGA
NIZATION
_UNITS_
V.TOWN_O
R_CI T Y
COUNTRY PO_ECX_H
EADER_AR
CH_V.buyin
g_
org_country
COUNTY
POSTALCOD HR_ORGA
E NIZATION
_UNITS_
V.POS TAL
_CODE
STATEPROV HR_ORGA
N NIZATION
_UNITS_
V.RE GI
ON2
TELEPHONE HR_ORGA
NIZATION
_UNITS_
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
V.TELEPHO
NE_NUMB
ER_1-3
/PARTNER
/PARTNER
<PARTNER>
(BillTo)
NAME PO_ECX_H
EADER_AR
CH_V.buyin
g_org_name
HR_ALL_O
RGANIZAT
ION_UNITS
_TL .NAME
ONETIME PO_ECX_H
EADER_AR
CH_V.billto
_
org_otf '0
PARTNRID PO_ECX_H
EADER_AR
CH_V.partn
er_id
PHA.ORG_I
D

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)

PARTNRTYP
E
CURRENCY FINANCIA
LS_SYSTEM
_PARAMS_
ALL.PAYM
ENT_CURR
ENCY_COD
E
H.INVO OE_XM Derive Address HR_LOCAT

PARTNRIDX ICE_TO L_PRO Id from Location IONS_ALL.
_ORG_I CESS_U Code ECE_TP_
D TIL.GET
_BILL_T Execute LOCATION
O_ORG Procedure Call _CODE
_ID
ADDRESS1 H.INVO HR_LOCAT

ICE_AD IONS_ALL.
DRESS1 ADDRESS_
LINE_1-3
ADDRESS2 H.INVO
ICE_AD
DRESS2
ADDRESS3 H.INVO
ICE_AD
DRESS3
ADDRESS4
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
CITY H.INVO HR_LOCAT

ICE_CIT IONS_ALL.
Y TOWN_OR
_CITY
COUNTRY H.INVO HR_LOCAT

ICE_CO IONS_ALL.
UNTRY COUNTRY
COUNTY H.INVO
ICE_CO
UNTY
POSTALCOD H.INVO HR_LOCAT

E ICE_PO IONS_ALL.
STALC POSTAL_C
ODE ODE
STATEPROV H.INVO HR_LOCAT

N ICE_ST IONS_ALL.
ATE REGION_2
TELEPHONE HR_LOCAT
IONS_ALL.
TELEPHON
E_
NUMBER_1
-3
</PARTNER>
<PARTNER>
(ShipTo)

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
NAME
ONETIME
PARTNRID

PARTNRTYP
E
CURRENCY
H.SHIP_ OE_XM Derive Address

PARTNRIDX TO_OR L_PRO Id from Location
G_ID CESS_U Code
TIL.GET
_SHIP_ Execute
TO_OR Procedure Call
G_ID
ADDRESS1 H.SHIP_
TO_AD
DRESS1
ADDRESS2 H.SHIP_
TO_AD
DRESS2
ADDRESS3 H.SHIP_
TO_AD
DRESS3
ADDRESS4
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
CITY H.SHIP_
TO_CIT
Y
COUNTY H.SHIP_
TO_CO
UNTY
POSTALCOD H.SHIP_
E TO_POS
TAL_CO
DE
STATEPROV H.SHIP_
N TO_STA
TE
</PARTNER>
<POTERM>
DESCRIPTN PO_ECX_H
EADER_AR
CH_V.paym
et_terms_de
scription
AP_TERMS.
DESCRIPTI
N

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
TERMID H.PAY PAYM PO_ECX_H

MENT_ ENT_T EADER_AR
TERM ERMS CH_V.paym
e
t_terms_na
me
AP_TERMS.
NAME
DAYSNUM No mapping
provided by
PO although
generated
XML has
these
elements.
</POTERM>
/POHEADER
<POLINE>
ShipTo) L.CUST Convert from

OMER_I OAG Operating
="UNIT" TEM_N Amount
type="T"> ET_PRI
CE
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
VALUE L.CUST Convert from PO_ECX_LI

OMER_I OAG Operating NE_ARCH_
TEM_N Amount V.price
ET_PRI
CE PO_LINES_
ARCHIVE_
ALL.UNIT_
PRICE
L.CUST Convert from

NUMOFDEC OMER_I OAG Operating
TEM_N Amount
ET_PRI
CE
SIGN L.CUST Convert from

OMER_I OAG Operating
TEM_N Amount
ET_PRI
CE
CURRENCY PO_ECX_H
EADER_AR
CH_V.po_c
urrency
PHA.CURR
ENCY_COD
E

UOMVALUE

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)

UOMNUMD
EC
UOM
</OPERAMT
>
<QUANTITY
qualifier="
ORDERED">
VALUE PO_ECX_LI
NE_ARCH_
V.quantity
PO_LINES_
ARCHIVE_
ALL.QUAN
TITY
</QUANTIT
Y>
REASONCO PO_LINES_
DE ARCHIVE_
ALL.LINE_
NUM
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
L. Y PO_ECX_LI
POLINENU CUSTO NE_ARCH_
M MER_LI V.line_num
NE_NU
MBER
L.CREA Y SYSD Execute

TION_D ATE Function Call
ATE
L.LAST_ Y FND_ Execute

UPDAT GLOB Function Call
ED_BY AL.LO
GIN_I
D
L.LAST_ Y SYSD Execute

UPDAT ATE Function Call
E_DATE
L.CREA Y FND_ Execute

TED_BY GLOB Function Call
AL.US
ER_ID
L.ORDE Y 20 Get Pre-Defined

R_SOUR Variable Value
CE_ID
L.XML_ Y 'CHO' Get Pre-Defined

TRANS Variable Value
ACTIO
N_TYPE
_CODE

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
L.CALC 'Y' if PO_LINES_

ULATE_ L.CUS ARCHIVE_
PRICE_F TOME ALL.ITEM_
LAG R_ITE DESCRIPTI
M_NE ON
T_PRI
CE is
passed
DESCRIPTN PO_ECX_LI
NE_ARCH_
V.descriptio
n
ITEMRV PO_ECX_LI
NE_ARCH_
V.itemrv
PO_LINES_
ARCHIVE_
ALL.ITEM_
REVISION
ITEM L.CUST PO_ECX_LI

OMER_I NE_ARCH_
TEM_N V.item
AME
MTL_SYSTE
M_ITEMS_B
_
KFV.SEGM
ENT1
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
ITEMX PO_ECX_LI
NE_ARCH_
V.itemx
PO_LINES_
ARCHIVE_
ALL.VEND
OR_PRODU
CT_NUM
NOTES L.CHA PO_ECX_LI

index="1" NGE_C NE_ARCH_
OMME V.note_to_v
NTS endor
PO_LINES_
ARCHIVE_
ALL.NOTE_
TO_VENDO
R
<USERAREA
>
ORACLE.SU H.ORIG
PPLIERLINE _SYS_LI
REF NE_REF
</USERARE
A>
<SCHEDULE
>

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
<DATETIME L.REQU Convert from PO_ECX_LI

qualifier="NE EST_DA OAG Datetime NE_LOC_A
EDDELV"> TE RCH_V.nee
d_by_date
PO_LINE_L
OCATIONS
_ARCHIVE_
ALL.NEED_
BY_DATE
YEAR Convert from

OAG Datetime
MONTH Convert from

OAG Datetime
DAY Convert from

OAG Datetime
HOUR Convert from

OAG Datetime

MINUTE Convert from

OAG Datetime
SECOND Convert from

OAG Datetime
SUBSECOND Convert from

OAG Datetime
TIMEZONE Convert from

OAG Datetime
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
</DATETIME
>
="ORDERED" L.ORDE Convert from PO_ECX_LI

> RED_Q OAG Quantity NE_LOC_A
UANTIT RCH_V.ord
Y ered_quantit
y
(PO_LINE_
LOCATION
S_ARCHIV
E_ALL.QU
ANTITY
-PO_LINE_
LOCATION
S_ARCHIV
E_ALL.QU
ANTITY_C
ANCELLED
)
VALUE Convert from

OAG quantity
Convert from
NUMOFDEC OAG quantity
SIGN Convert from

OAG quantity
UOM L.ORDE UOM Convert from

R_QUA OAG quantity
NTITY_
UOM

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)

</QUANTIT
Y>
L.CUST Y
PSCLINENU OMER_
M SHIPME
NT_NU
MBER
REASONCO L.CHA 'Not

DE NGE_RE provid
ASON ed'
<USERAREA
>
PARTNER
(BillTo)
NAME
ONETIME
PARTNRID Execute
Procedure Call
PARTNRTY
PE
CURRENCY
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
PARTNRIDX L.INVOI OE_XM Derive Address

CE_TO_ L_PRO Id from Location
ORG_ID CESS_U Code
TIL.GET
_BILL
TOORG
ID
ADDRESS1 L.INVOI
CE_AD
DRESS1
ADDRESS2 L.INVOI
CE_AD
DRESS2
ADDRESS3 L.INVOI
CE_AD
DRESS3
ADDRESS4
CITY L.INVOI
CE_CIT
Y
COUNTRY L.INVOI
CE_CO
UNTRY
COUNTY L.INVOI
CE_CO
UNTY

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
POSTAL L.INVOI
CE_POS
CODE TALCO
DE
STATE L.INVOI
CE_STA
PROVN TE
</PARTNER>
<PARTNER>
(ShipTo)
NAME PO_ECX_LI
NE_LOC_A
RCH_V.Shi
pto_org_na
me
HR__ORGA
NIZATION
_UNITS_V
.NAME
ONETIME
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
PARTNRID PO_ECX_LI
NE_LOC_A
RCH_V.part
ner_id
PO_LINE_L
OCATIONS
_ARCHIVE_
ALL.ORG_I
D
PARTNRTY PO_ECX_LI
NE_LOC_A
PE RCH_V.ship
to_org_part
ner_type
'ShipTo'
CURRENCY
L.SHIP_ OE_XM Derive Address HR_LOCAT

PARTNRIDX TO_OR L_PRO Id from Location IONS_ALL.
G_ID CESS_U Code ECE_TP_LO
TIL.GET CATION_C
_SHIP Execute ODE
TOORG Procedure Call
ID
ADDRESS1 L.SHIP_ HR_LOCAT

TO_AD IONS_ALL.
DRESS1 ADDRESS_
LINE_1,2,3
ADDRESS2 L.SHIP_
TO_AD
DRESS2

O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
ADDRESS3 L.SHIP_
TO_AD
DRESS3
ADDRESS4
CITY L.SHIP_ HR_LOCAT

TO_CIT IONS_ALL.
Y TOWN_OR
_CITY
COUNTRY L.SHIP_ HR_LOCAT

TO_CO IONS_ALL.
UNTRY COUNTRY
COUNTY L.SHIP_
TO_CO
UNTY
POSTAL L.SHIP_ HR_LOCAT

TO_POS IONS_ALL.
CODE TAL_CO POSTAL_C
DE ODE
STATE L.SHIP_ HR_LOCAT

TO_STA IONS_ALL.
PROVN TE REGION_2
TELEPHONE HR_LOCAT
IONS_ALL.
TELEPHON
E_NUMBER
1,2,3
O ADERS
_INTER
FACE
(H)
OE_LIN
ES_INT
ERFAC
E (L)
</PARTNER>
OPERATION L.OPER ACTIO OE_XM

ATION_ N_CO L_PRO
CODE DE CESS_U
TIL.DE
RIVE_LI
NE_OP
ERATIO
N_COD
E if not
passed
ORACLE.SU L.ORIG_
PPLIERSHIP SYS_SHI
MENTREF PMENT
_REF
</USERARE
A>
</SCHEDUL
E>
</POLINE>

Sample business flow for 3A7 Change SO/3A8 Change PO response

Purchasing
0 Figure, "Trading Partner

Setup completed for Oracle
Order Management via XML
Gateway forms"
Figure, "Profile Option OM:

Change SO Response
Required set to 'Yes' at
site-level"
1 Figure, "Buyer approves a

Purchase Order"
2 Figure, "Order Management

receives the Purchase Order
XML document and a
corresponding sales order is
createdHeader"
Figure, "Order Management

receives the purchase order
XML document and a
corresponding sales order is
created Line"
3 Figure, "After booking the

order, the seller modifies the
ordered quantity on one of
the lines"
Figure, "The order line goes

on hold"
Figure, "3A7 Change SO XML

document is generated and
sent to the buyer"

Outbound Message Details"
Purchasing
4 Figure, "Buyer receives

seller-initiated changes"
Figure, "Buyer sends a 3A8

Change PO response
acknowledging the changes"
5 Figure, "Seller receives 3A8

Change PO response"

Inbound Message Details"
Figure, "3A8 Change PO

response is processed
successfully and the hold on
the sales order line removed"

Profile Option OM: Change SO Response Required set to 'Yes' at site-level
Buyer approves a Purchase Order
Order Management receives the Purchase Order electronically as a Process PO XML
document and a corresponding sales order is created.

Order Management receives the purchase order electronically as a Process PO XML
document and a corresponding sales order is created.
After booking the order, the seller modifies the ordered quantity on one of the lines.
The order line goes on hold.
3A7 Change SO XML document is generated and sent to the buyer.

Results Summary Outbound Message Details window.
Buyer receives seller-initiated changes.
Buyer sends a 3A8 Change PO response acknowledging the changes.

Seller receives 3A8 Change PO response.
Results Summary Inbound Message Details.
3A8 Change PO response is processed successfully and the hold on the sales order line
removed.

Cancel_PO

window (Customers-> Standard), query a customer for whom to create XML orders. On
one of the customer's addresses, create a primary Sold To site usage and specify a
location (for example Q7Q-1A1). Save your work. When provided on the inbound XML
Setup Steps
Step Description
2 Define Trading Partners
3 Define Code Conversions
Step Description
4 Set Up Oracle Workflow Business Event

System
Define Transactions
Define Trading Partners

e-Business can be conducted directly with a business partner commonly known as a
converge to transact in electronic commerce.
hub.
• Transport protocol: SMTP, HTTP, or HTTPS with credential and

with the message.


5. Select 'ONT_3A9R_OAG72_IN' as the map.
6. Save your work.
Define Code Conversions

The Code Conversion Standard code determines which transaction Standard these
values are applied to. A Standard Code of UNIVERSAL applies these values across all
Standards. Here, run the Code Conversion form from the Navigator Setup menu.
Set Up Oracle Workflow Business Event System

Seeded business events and event subscriptions to send outbound or consume inbound
messages are delivered for all Oracle pre-built messages. The seeded event
subscriptions may be configured during implementation to perform activities to
address specific business requirements.
Define System Profile Values

The following table lists the System Profile options, that need to be set.
Profile Options
Profile System Description Required Default Value

Option
OM: Run Order Determines whether No Synchronous

Import for XML Order Import will run
Asynchronously or
Synchronously.
The directories listed in the above profiles should also be mentioned in the utl_file_dir
parameter in init.ora
Please refer to the Oracle XML Gateway User's Guide for the setup information.
Setup the Subscribing System

Query the Inbound event and change the Subscribing system accordingly.
'oracle.apps.ont.oi.po_inbound.create.'
(This data will be available as the initial setup, come as an XML file and will be loaded
to the customer system. User of the system will be able to change it to work for their
system settings).
Message Set Up
Cancelled Reason Behavior

Order Import populates the OE_ORDER_LINES_HISTORY column with the reason
code for the cancellation. When change reasons are specified in the incoming
Cancel_PO document at both the header and line level, the line level reason populates
the above mentioned table (OE_ORDER_HEADERS_HISTORY does exist but is not
populated). The only exception to this behavior occurs when the incoming document
does not contain any POLINE tags (i.e. no lines specified but entire order being
cancelled). In this case, the header level cancel reason is entered in the history table for
each line being cancelled.
Note: This behavior is consistent with the Sales Orders window.
If the incoming document does not contain this tag, then the message map defaults the
cancelled code to 'Not provided,' that corresponds to the meaning: 'No reason
provided.'

Workflow Process it will run Order Import for the XML Message, which is currently
being consumed.

Note: Cancel_PO utilizes the same workflows as Process_PO.
Implementation Considerations


Open Interface Tracking

To setup for Open Interface Tracking:
1. Set up the appropriate Electronic Messages.
2. Set the profile option OM: Electronic Message Integration Event Sources. This
profile indicates the level at which electronic messages are tracked and has the
values XML, EDI & XML and All (if the value is NULL, this is treated as XML). If
the profile option is set to XML, this feature will track only orders with an order
source of XML. Similarly, if the profile option is set to EDI & XML, only orders with
order source of EDI or XML will be tracked.
Note: Order Management enables users to extract EDI 855 and 865
Acknowledgment data for orders with order source Online. To
enable these orders for tracking, the value of the profile option
must be set to All; setting the profile to EDI & XML will not track
these orders.
3. Set the user access to the form. To allow the form to link to the OA Framework
pages for Oracle Workflow and XML Gateway Transaction monitor, ensure that the
responsibility with the Open Interface Tracking form has access to the form
functions WF_G_DIAGRAM and TXMONITORRESULTSPG – these functions are
part of the responsibility Workflow Administrator Web Applications, but you may
need to add them to a menu within the responsibility containing the form.
4. Schedule the WF_DEFERRED Agent Listener.
5. Schedule the Workflow Background Process for Item Type OM: Open Interface
Tracking.
Integration Event – oracle.apps.ont.oi.xml_int.status

Oracle Order Management has a Business Event System-based mechanism to provide
subscribers with a way to perform processing at desired integration points.
Currently, there are three ways these events are triggered:
1. During processing of Electronic Messages (i.e. XML, EDI transactions) and Order
Import. In this scenario, the event is raised automatically via the seeded workflows.
2. Because of Processing Constraint-based generation. In this scenario, you can

determine the point where the event is raised by defining a Processing Constraint.
3. By inserting the workflow sub-process 'Raise Show Sales Order Event Sub Process'
from the item type 'OM Show Sales Order' (OESO) in an Order Header (OEOH)
workflow process. This method can be used, for example, to raise an event when an
order is booked.
To leverage this functionality, you can define custom synchronous or asynchronous

subscriptions to this event and perform any desired processing via the event
subscription. For further information about defining event subscriptions, please refer to
the Oracle Workflow documentation.
These events are controlled by the profile option, 'OM: Electronic Message Integration
Event Sources'. The possible values are 'XML' (default value), 'XML & EDI' and 'All.'
Users can use this profile option value to determine the Order Sources for which this
event is raised.
1. Integration Event Parameter Details
The following tables summarize the event parameters that are supported by the
integration event. Note that not every parameter will be populated in all cases, as
described in subsequent sections.
The event oracle.apps.ont.oi.xml_int.status will contain the following parameters:

Parameters and Descriptions
Parameter Name Parameter Description Comments
XMLG_INTERNAL_CONTR Unique document number Overloaded to provide a

OL_NUMBER generated by XML Gateway unique id for EDI inbounds
for inbound messages and Order Import as well
XMLG_MESSAGE_ID Unique message id generated

by XML gateway for
outbound messages
XMLG_INTERNAL_TXN_TY Typically 'ONT' except for

PE Confirm BOD which is owned
by 'ECX'
XMLG_INTERNAL_TXN_SU Identifies XML transaction Overloaded to also contain

BTYPE type EDI and Order Import
transaction type, namely '850',
'860', '855', '865', 'GENERIC'
DOCUMENT_DIRECTION 'IN' or 'OUT'
XMLG_DOCUMENT_ID Unique ID provided by OM Overloaded to provide a

for outbound messages unique id for outbound EDI
transactions
TRADING_PARTNER_TYPE 'C'
TRADING_PARTNER_ID TP Party ID
TRADING_PARTNER_SITE TP Party Site ID
DOCUMENT_NO Sales Order Number
ORG_ID Organization ID
PARTNER_DOCUMENT_NO Purchase Order Number
DOCUMENT_REVISION_N Change Sequence

O
ONT_DOC_STATUS 'ACTIVE', 'SUCCESS',

'ERROR'
MESSAGE_TEXT FND MESSAGE detailing

what has occurred.
WF_ITEM_TYPE Workflow Info for XML/EDI

processing
WF_ITEM_KEY Workflow Info for XML/EDI

processing
ORDER_SOURCE_ID Order Source
SOLD_TO_ORG_ID Customer ID
ORDER_TYPE_ID Order Type ID
CONC_REQUEST_ID Processing Concurrent

Request ID
PROCESSING_STAGE Code to identify why this

event was raised. Sample
values include
'INBOUND_IFACE',
'OUTBOUND_SENT'.
SUBSCRIBER_LIST Comma delimited list of

product short names of the
intended subscribers eg
'ONT,CLN'
DOCUMENT_STATUS 'SUCCESS', 'ERROR'
RESPONSE_FLAG 'Y' for 3A8 Change PO

Response documents
HEADER_ID Order Header identifier
LINE_IDS Only applicable for events

raised via Processing
Constraints
1. Integration Event Parameter Population

Electronic Messaging/Order Import
The following table contains a Y if a particular parameter is populated for XML/EDI
transactions as well as Order Import.
Inbound/Outbound Messages Parameter Names
Parameter Name INBOUND MESSAGES OUTBOUND MESSAGES
Parameter Populated Parameter Populated

(Electronic Message Types) (Electronic Message Types)
XMLG_INTERNAL_CONTR Y (XML, EDI, Order Import)

OL_NUMBER
XMLG_MESSAGE_ID Y (XML, if document sent

successfully)
XMLG_INTERNAL_TXN_TY Y (XML, EDI, Order Import) Y (XML, EDI)

PE
XMLG_INTERNAL_TXN_SU Y (XML, EDI, Order Import) Y (XML, EDI)

BTYPE
DOCUMENT_DIRECTION Y (XML, EDI)
XMLG_DOCUMENT_ID Y (XML, EDI)
TRADING_PARTNER_TYPE Y (XML, except CBOD)
TRADING_PARTNER_ID Y (XML, except CBOD)
TRADING_PARTNER_SITE Y (XML, except CBOD)
DOCUMENT_NO Y (XML, EDI, Order Import) Y (XML if import succeeds or

(if import succeeds) sales order already exists,
(information is also derived EDI)
for XML updates via 3A8/3A9
and processing stage
IMPORT_FAILURE)
ORG_ID Y (XML, EDI, Order Import) Y (XML, EDI)
PARTNER_DOCUMENT_NO Y (XML, EDI, Order Import) Y (XML, EDI)

DOCUMENT_REVISION_N Y (XML, EDI, Order Import) Y (XML, EDI)

O
DOCUMENT_STATUS Y (XML, EDI, Order Import) Y (XML, EDI)
ONT_DOC_STATUS Y (XML, EDI, Order Import) Y (XML, EDI)
MESSAGE_TEXT Y (XML, EDI, Order Import) Y (XML, EDI)
WF_ITEM_TYPE Y (XML except when Y (XML, EDI *)

PROCESSING_STAGE is
IMPORT_SUCCESS or
IMPORT_FAILURE)
WF_ITEM_KEY Y (XML except when Y (XML, EDI *)

PROCESSING_STAGE is
IMPORT_SUCCESS or
IMPORT_FAILURE)
ORDER_SOURCE_ID Y (XML, EDI, Order Import) Y (XML, EDI)
SOLD_TO_ORG_ID Y (XML, EDI, Order Import) Y (XML, EDI)
ORDER_TYPE_ID Y (XML, EDI, Order Import) Y (XML if import succeeds or

(information is also derived EDI)
IMPORT_FAILURE)
HEADER_ID Y (XML, EDI, Order Import) Y (XML, EDI)

(if import succeeds)
(information is also derived
IMPORT_FAILURE)
CONC_REQUEST_ID Y (XML, EDI, Order Import) Y (XML for 3A6 Show SO

generated via concurrent
program)


PROCESSING_STAGE Y (XML, EDI, Order Import) Y (XML, EDI)
SUBSCRIBER_LIST Y (XML, EDI, Order Import) Y (XML, EDI)
RESPONSE_FLAG Y (XML only for Change PO

response documents)
* The EDI support is only active when the 11.5.10/Pack J EDI workflow is being used
The following table maps the value of the event parameter PROCESSING_STAGE to the
message text for that stage:
PROCESSING_STAGE to the Message Text For That Stage
XML EDI Order Import Processing Sample

Stage Message Text
Description
(CODE)
Y (3A8 Change Data processed "Change PO -

PO Response by inbound Buyer response
only) gateway contained a
(INBOUND_GA rejected header
TEWAY) and was not
processed by
Order
Management"
"Change PO -
Buyer response
contained one or
more rejected
lines which were
not processed by
Order
Management"
Stage Message Text
Description
(CODE)
Y Y Data received in "Process PO –

Open Interface Data successfully
Tables entered into
(INBOUND_IFA Open Interface
CE) tables"
"850 POI – Data

successfully
entered into
Open Interface
tables"
Y Import mode "Process PO –

(PRE_IMPORT) Order Import
will be run in
Asynchronous
mode"
"Process PO –
Order Import
will be run in
Synchronous
mode"
Y Y Y Order Import "Process PO -

result Order Import
(IMPORT_SUCC successful"
ESS,
IMPORT_FAILU "Process PO –
RE) Order Import
failed"
Y (except CBOD) Outbound "OM is ready to

message send the
triggered Acknowledge
(OUTBOUND_T PO message"
RIGGERED)
"OM is ready to
send the Show
SO message"

Stage Message Text
Description
(CODE)
Y (except CBOD) Y* Outbound setup "Acknowledge

result PO – Setup
(OUTBOUND_S validation
ETUP) successful"
"Acknowledge
PO – Setup
validation failed"
Y Y Outbound sent "Acknowledge

(OUTBOUND_S PO message has
ENT) been sent"
"855 POAO
message has
been sent"
Note that for Outbound_Setup, the EDI support is only active when the 11.5.10/Pack J
EDI workflow is being used
Constraint-based Event Raise

The following table contains a Y if a particular parameter is populated for Processing
Constraint-based Event Raise:
Populated Parameters for Processing Constraint-based Event
Parameter Name Parameter Populated (Electronic Message

Types)
DOCUMENT_NO Y
ORG_ID Y
PARTNER_DOCUMENT_NO Y
DOCUMENT_REVISION_NO Y
ORDER_SOURCE_ID Y
Types)
SOLD_TO_ORG_ID Y
HEADER_ID Y
SUBSCRIBER_LIST Y ('DEFAULT')
LINE_IDS Y
'ALL' for header-level triggering
Colon-delimited string of Line Ids for

line-level triggering
Note: For colon-delimited string of Line Ids for line-level triggering: If

the values populating the line_id string exceeds 2000 characters, the
relevant business event will be raised multiple times. The Raise
Integration Event operation in the Processing Constraints window will
not fail because the line_id string can accommodate more characters.
Workflow Subprocess-based Event Raise

The following table contains a Y if a particular parameter is populated for Workflow
Subprocess-based Event Raise (using the 'Raise Show Sales Order Event Sub Process'):
Parameters Populated for Workflow Subprocess-based Event

Types)
DOCUMENT_NO Y
ORG_ID Y
PARTNER_DOCUMENT_NO Y
DOCUMENT_REVISION_NO Y
ORDER_SOURCE_ID Y

Types)
SOLD_TO_ORG_ID Y
ORDER_TYPE_ID Y
HEADER_ID Y
SUBSCRIBER_LIST Y ('DEFAULT')
LINE_IDS Y ('ALL')
User Procedures
To query electronic messages:
1. Navigate to the Access the Open Interface Tracking Find window.
2. Enter in the desired search criteria and execute the query.
3. To view all the electronic messages for a particular order, select that message and
click Details.
To view workflow, XML, and delete records:
1. Navigate to the Access the Open Interface Tracking Find window and query your
records.
2. To view the workflow or XML for a particular electronic message, click Details.
3. To view all the electronic messages for a particular order, select that message and
click Details.
Note: A concurrent program, Purge Open Interface Data, exists to

delete multiple records from the table. This purge procedure can
also be used to purge the Interface or Acknowledgment tables.
To purge records:
1. Navigate to the Concurrent Program Manager.
2. Choose the Purge Open Interface Data concurrent program. This concurrent
program can also be used to purge the Interface and Acknowledgment tables.
To purge workflows:
Each Open Interface Tracking event is consumed with corresponding information being
stored in the OE_EM_INFORMATION_ALL table using the Write History Entry
process of the Item Type OM: Open Interface Tracking. Once the workflow for an event
completes, the Workflow can be safely purged.

Since OM_PF J is a part of SCM_PF J (which includes CLN), the dependency below will
not be an issue.
NOTE: If the customer has Order Management Pack J, but is not on Oracle Applications
11.5.10, then Order Management's seeded subscription to the event
oracle.apps.ont.oi.xml_int.status (required by this feature) may not process correctly
due an issue with another seeded subscription to the same event. This issue can also
affect any other product or custom subscriptions to the above mentioned event. To
avoid this problem, customers can either:
• Apply 11i.CLN.B Patch #2734844
OR
• Manually disable the seeded event subscription to the event
oracle.apps.ont.oi.xml_int.status owned by Supply Chain Trading Connector
(CLN), if the customer is not using the CLN product. The issue with this event
subscription has been resolved in CLN patchset B.
5
Oracle Order Management XML
Transactions

• What is RosettaNet?
• Process_PO
• Acknowledge_PO
• Show_SalesOrder
• Change_salesorder
• Inbound Change PO Request
• Cancel Purchase Order
• CONFIRM BOD
• Seeded Workflow for Inbound XML Messages
• Message Details
• Extension Tags
• Open Interface Tracking
• Event/Event Subscription
• Seeded workflow OEEM/Open Interface Tracking
• Event Parameters & Population
What is RosettaNet?
RosettaNet is a consortium of more than 400 of the world's leading Electronic
Components (EC), Information Technology (IT), Semiconductor Manufacturing (SM),
and Solution Provider (SP) companies. It is a self-funded, non-profit organization
dedicated to creating, implementing and promoting open e-business standards. These
Oracle Order Management XML Transactions 5-1

standards form a common e-business language, aligning processes between trading
partners on a global basis.
RosettaNet standards offer a robust non-proprietary solution, encompassing data
dictionaries, implementation framework, and business message schemas and process
specifications, for e-business standardization.
RosettaNet Partner Interface Processes (PIPs) are specialized system-to-system
XML-based dialogs that define business processes between trading partners. The
message dialog PIPs apply to the following core processes: Administration; Partner,
Product and Service Review; Product Introduction; Order Management; Inventory
Management; Marketing Information Management; Service and Support; and
Manufacturing.
Oracle Order Management supports OAG transactions which correspond to Rosettanet
transactions. The following table shows the relation between Rosettanet transactions
and OAG transactions:
Rosettanet OAG Description
PIP 3A4 -Purchase Order Process_PO New purchase order from the
Request buyer to the seller
PIP 3A4- Purchase Order Acknowledge_PO Acknowledgement for the

confirmation new purchase order from the
seller to the buyer
PIP 3A9 - Request Purchase Cancel_PO Request for canceling a

Order Cancellation purchase order from the
buyer to the seller
PIP 3A6 - Distribute Order Show_Salesorder Sales order status sent to the
Status buyer from the seller.
The following diagram describes how Oracle Order Management supports Rosettanet
transactions in conjunction with B2B server.
Changes in Order Management for RosettaNet Native Payloads
Supply Chain Trading Connector (CLN) has included 3 transaction sub-types for
Process PO Acknowledgement, Change PO Acknowledgement, and Cancel PO
Acknowledgement.
The change enables the workflow to trigger a new event, in case user chooses
ROSETTANET as the protocol in the payload. Existing user of OAG doesn't have any
impact. The pre-condition is that if a customer uses either OAG or ROSETTANET for all
three messages.

The PL/SQL code for Is OAG or RosettaNet is:
select standard_code
into l_standard_code
from ecx_tp_details_v
where tp_header_id = (select tp_header_id from ecx_tp_headers
where party_id = l_party_id and
party_site_id = l_party_site_id
and party_type = 'C') and
transaction_type ='ONT' and transaction_subtype = 'POA';
if (l_standard_code = 'OAG')
then
-- Reached Here. Successful execution.
x_resultout := 'OAG';
else
x_resultout := 'RN';
end if;
Supply Chain Trading Connector (CLN) adds a deferred subscription to the event, so
that Order Management will not have any dependency on CLN code. In the deferred
subscription, CLN writes a workflow, which generates the appropriate
acknowledgement for 3A4, 3A8 and 3A9. After "Raise Rosettanet OM Ack" activity,
Generate XML Integration event is raised so that Order Managements XML Message
monitoring system can display appropriate status.
Process_PO
Process_PO is used between seller and buyer to exchange information including
pricing, availability and status of the order. Process_PO consists of the Inbound PO
request and the outbound Acknowledge PO message, which reports the status of the
order to the buyer. Typical users of this collaboration are high order volume industries,
such as high tech and electronics.
Major Features
Oracle Order Management supports the Process_PO transaction for Open Applications
Group (OAG) XML standard. The Process_PO transaction is between the buyer and
seller. The buyer can send a new purchase order using this transaction. The following
are the major features of this transaction within Oracle Order Management:
Consume the Process_PO Document

Oracle Order Management consumes the Process_PO (OAG) document from the buyer
and creates an order in Oracle Order Management. The internal control number (which
is unique for each message) of the incoming message is stored for later use to retrieve
the sender information of the original message. This information is mapped on the
outbound Acknowledgement message. Oracle Order Management consumes the
Process_PO (OAG) document from the buyer and creates an order in Oracle Order
Management.
Setup the Order Import Process in Synchronous or Asynchronous Mode

You can initiate Order Import for a single order or process multiple orders via
concurrent processing. The profile option, OM: Run Order Import for XML, can be set at
the user or site level. The possible values for this profile option will be Synchronous or
Asynchronous. In Synchronous mode, Order Import automatically runs when the XML
data is in the interface tables. In Asynchronous mode, Order Import needs to be run
manually. The default is Synchronous.
Error Handling
This diagram outlines the error handling process:

Three types of outcomes can result from running Order Import process:
1. Successful processing: The confirmation API is called to send the acknowledgment
to the sender with the Accept status. If the user chooses to book the order before
sending out an acknowledgment message, the Accept with Changes status may be
sent if there are changes that happened at the booking.
2. Failed processing: This status is occurs when there are validation errors or data
setup errors. The acknowledgment is sent to the sender with the Reject status. The
Order Import Concurrent program will complete normally.
3. Unexpected Errors: There can be some unexpected errors due to resource

constraints that will require you to manually reprocess Order Import upon fixing
those issues. The Order Import Concurrent program will not complete normally.
CONFIRM BOD
Upon successful receipt of an inbound XML document such as a Process_PO or
Cancel_PO, Oracle Order Management will send the outbound OAG Confirm BOD
message.
The major features of Confirm BOD are:
• This message contains information about the inbound XML message received, as
well as the status and description of the inbound message received.
• Unlike the Acknowledge PO message, the Confirm BOD message is sent before the
Order Import process is run. This is only a confirmation message.
Generate Confirm BOD (CBOD)

Upon receipt of the inbound Process_PO, Oracle Order Management can send out the
Confirm BOD message to the buyer, indicating that the data has reached the seller. The
Confirm BOD message is sent depending on the value of the <CONFIRMATION> tag in
the inbound document. The Confirm BOD message is not sent if the value of this tag is 0
or 1. It is sent if the value of this tag is 2. The Confirm BOD message is generated on the
successful insertion of the data in open interface tables. The message is generated by the
workflow process that begins after XML gateway has inserted the data successfully in
the interface tables of the destination application (Oracle Order Management). The
Confirm BOD message is sent only to notify the buyer who may request a confirmation

that the data has been successfully inserted in the interface tables.
Message Details - Message Map ONT_3A4R_OAG72_IN.xgm

The 'ONT_3A4R_OAG72_IN' message map is created using the Oracle XML Gateway
Message Designer tool.
Message Map Details
Name Description
Message Map Name: ONT_3A4R_OAG72_IN
Direction: Inbound
(Internal) Transaction Subtype: POI
External Transaction Subtype: PROCESS
Message Maps XGM File Name: ONT_3A4R_OAG72_IN.xgm
Standard: OAG
Release: 7.2
Format: DTD
DTD Name: PROCESS_PO_007
Columns Enabled for Code Conversion
Defaulted Column Default Value, and Condition (If Any)
<UOM> (in schedule level <QUANTITY Code Category – UOM, mapped to

qualifier="ORDERED>) OE_LINES_INTERFACE.ORDER_QUANTIT
Y_UOM
Key: H => OE_HEADER_INTERFACE, L => OE_LINES_INTERFACE
Defaulted Columns
Defaulted Columns Default Value, and Condition (If Any)
H.ORDER_SOURCE_ID 20
H.ORDER_TYPE Standard
H.XML_TRANSACTION_TYPE_CODE POI
H.HEADER DEFAULT 1-4
L.LINE DEFAULT 1-4
L.ORDER_SOURCE_ID 20
L.ORIG_SYS_DOCUMENT_REF H.ORIG_SYS_DOCUMENT_REF
L.XML_TRANSACTION_TYPE_CODE POI
Derived Columns
Derived Columns Source of Data, and Condition (If Any)
H.CREATED_BY FND_GLOBAL.USER_ID
H.CREATION_DATE SYSDATE

Derived Columns Source of Data, and Condition (If Any)
H.INVOICE_TO_ORG_ID PARTNRIDX of BillTo PARTNER
H.LAST_UPDATED_BY FND_GLOBAL.LOGIN_ID
H.LAST_UPDATE_DATE SYSDATE
H.LAST_UPDATE_LOGIN FND_GLOBAL.USER_ID
H.ORG_ID PARTNRIDX of SoldTo PARTNER, if this

value is not null
H.SOLD_TO_ORG_ID PARTNRIDX of SoldTo PARTNER
H.XML_MESSAGE_ID XML Gateway Internal Control Number
L.LAST_UPDATED_BY FND_GLOBAL.LOGIN_ID
L.LAST_UPDATE_DATE SYSDATE
L.LAST_UPDATE_LOGIN FND_GLOBAL.LOGIN_ID
L.ORDERED_QUANTITY, OAG Derivation from schedule level

L.ORDER_QUANTITY_UOM <QUANTITY qualifier="ORDERED"> tag
L.REQUEST_DATE OAG Derivation from schedule level

<DATETIME qualifier="NEEDDELV"> tag
L.SHIP_TO_ORG_ID PARTNRIDX of ShipTo PARTNER
Workflow Event Setup
Detail Value
Event Name oracle.apps.ont.oi.po_inbound.create
Detail Value
Event Description Order Management Generic Inbound Event
Subscription R_OEOI_ORDER_IMPORT
Subscription Description Oracle Order Management subscription to the

event oracle.apps.ont.oi.po_inbound.create
raised by the post process of the Process_PO
XML mapping
Process_PO Message Map
OAG Element Description/Comment Oracle OM OAG

Table/Column Requir
ed
CNTROLAREA The fields included in this area XMLG Y

provide information about the XML
document, for example, BSR,
SENDER, and DATETIME
described in this table.
<BSR> Shows the Business Service Request XMLG Y

name per OAGI:
<VERB> Y
Value is PROCESS.
<NOUN> Y
Value is PO.
<REVISON> Y
Value is 007.

Table/Column Requir
ed
<SENDER> Provides information on the system XMLG Y

that sends the document:
<LOGICALID> Y
Sender system identifier: value is 1.
<COMPONENT> Y
Sender application name: value is
<TASK> PURCHASING Y
<REFERENCEID> Event or Action: value is POISSUE Y
<CONFIRMATION> Unique reference ID for this doc. Y
<LANGUAGE> Confirmation when doc is received: Y
<CODEPAGE> value of 0 means that none is Y

required.
<AUTHID> Y
ISO language in which the text
fields are transmitted.
Character set used in this XML doc:

value is US7ASCII.
System ID of the sender: value is

APPS.
<DATETIME> Creation date and time of the XML XMLG Y

document.
DATAAREA The fields included in this area Y

provide information about the data
included in the XML document.
POORDERHDR This data type provides header Y

level purchase order information.
One Purchase Order Header data
type is required per document.
<POID> This identifies the unique ID for the OE_HEADERS_INT Y

purchase order. For Standard ERFACE.ORIG_SYS
Purchase Orders, the Purchase _DOCUMENT_REF
Order number from Oracle
Purchasing is entered here. For OE_HEADERS_INT
Blanket Releases, value should be ERFACE.CUSTOM
Blanket PO# - Release. It's the ER_PO_NUMBER
customer Purchase Order Number
for Oracle Order Management.
Table/Column Requir
ed
<POTYPE> This identifies various types of Y

Purchase Orders. Standard or
Blanket is used here. Oracle Order
Management does not have any
matching data for the Purchase
Order type. The Order Type on
Process PO is no longer
automatically set to Standard.
Oracle Order Management does
not need map.
<ACKREQUEST> Specifies to the supplier if an N

acknowledgment is expected.
Oracle does not support consuming

Ack PO so this field is used only to
indicate if acceptance for the
Purchase Order is required. Values
are:
0 - Not Required
2 – Required
Oracle Order Management does not

need map.
<CONTRACTS> Seller's contract document number . N

to be used only if this is a release
from the blanket order (as it is only
available for blanket orders and can
only be loaded through PDOI)
If this number is available populate

it.
Order Management does not need

map.
<DATETIME(DOCUME Timestamp for Purchase Order N

NT> (Standard or Release) creation.
Order Management does not need

map.

Table/Column Requir
ed
<DESCRIPTION> Description for PO Header. N
Order Order Management does not

need map.
<OPERAMT(EXTENTE Total amount of the Purchase N

D(T)> Order. Following are the fields
included in this segment. Order N
<VALUE> Management does not need map. N
<NUMOFDEC> Monetary amount of the PO. N
<SIGN> Indicates the number of decimals in N
<CURRENCY> the value field.
N
<UOMVALUE>1 '+'or '-' indicates whether the
amount is positive or negative. N
<UOMNUMDEC>
Three character ISO currency code. N
<UOM>1
Numeric value indicates the value
of the factor when the amount is
expressed in terms of multiples of
Units of Measure (UOM).
Represents number of decimals in

the UOMVALUE field.
Unit of Measure (UOM) indicates

the units of the quantitative
amount.
<PORELEASE> Indicates a new release number; N

used only when the PO Type is
Blanket. Order Management does
not need map.
Table/Column Requir
ed
<USERAREA> The following fields are provided OE_HEADERS_INT N

by Oracle in this user area: ERFACE.FOB_POI
<DATETIME> NT_CODE
Start Active Date for Blanket PO
<DATETIME> OE_HEADERS_INT
Not applicable for Oracle Order ERFACE.FREIGHT_
<FOB> Management. TERMS_CODE
<DESCRIPTN> End Active Date for Blanket PO:
<TERMID> Not applicable for Oracle Order
Management.
<FTTERM>
FOB shipping terms. This is the
<DESCRIPTN> FOB point code.
<TERMID> FOB Description.
<EXCHRATE> FOB Terms.
<DATETIME> Freight payment terms.
<DATETIME> Freight Description.
<CONFIRM> Freight Terms.
DFFPOHEADER Currency Exchange Rate.

<ATTR1 - ATTR16>
Date for the Exchange Rate
PCARDHDR
Acceptance Due By date (or Ack by
date when PO Ack functionality is
<MEMBERNAME> supported in Oracle Purchasing)
<PCARDNUM> Not applicable for Oracle Order
<DATETIME> Management.
<PCARDBRAND> Indicates if the supplier confirms

the Purchase Order: Y indicates
confirmation.
N indicates no confirmation. Not

applicable for Oracle Order
Management.
PO header level DFF attributes (16)

is not applicable for Oracle Order
Management.
This segment contains PCARD

details Not applicable for Oracle

Table/Column Requir
ed
Order Management
Member Name on the Pcard
Pcard Number
Expiration Date of the Pcard
Brand of the Pcard (EDI does the

mapping of the PCard brands, it is
not possible in XML)
<ORACLE.CHANGESE Change Sequence value OE_HEADERS_INT

QUENCE> ERFACE.CHANGE
Booked Flag _SEQUENCE
<ORACLE.BOOKEDFL
AG> Supplier's Ref for the PO OE_HEADERS_INT
ERFACE.BOOKED_
<ORACLE.SUPPLIERD FLAG
OCREF>
OE_HEADERS_INT
ERFACE.ORIG_SYS
_DOCUMENT_REF
<USERAREA>Continue
d..
<ORACLE.OWNER> Install Base Owner OE_HEADERS_INT N

ERFACE.CURRENT
_LOCATION
<ORACLE.CURRENTL Install Base Current Location OE_HEADERS_INT N

OCATION> ERFACE.CURRENT
_LOCATION
<ORACLE.INSTALLED Install Base Installed At Location OE_HEADERS_INT N

ATLOCATION> ERFACE.INSTALL
ED_AT_LOCATIO
N
<ORACLE.ORDERTYPE Order Type OE_HEADERS_INT N

> ERFACE.ORDER_T
YPE
Table/Column Requir
ed
PARTNER This data type provides Y

information about the trading
partner. Two occurrences of Partner
data type are required: Supplier
and SoldTo. Oracle ERP provides
two additional Partner occurrences:
BillTo and Carrier which are
optional per DTD.
PARTNER-Supplier Oracle Order Management does not Y

need to map this segment. This is
supplier information.
<NAME1> Name of the trading partner. Y
<ONETIME> Indicates if this partner is Y

established for this transaction
only.
<PARTNRID> Uniquely identifies the partner in Y

ERP.
<PARTNERTYPE> Identifies the type of partner. Value Y

is Supplier.
<CURRENCY> Preferred operating currency of the N

partner.
<DESCRIPTION> Not used. N
<NAME2 - NAME9> Not used. N
<PARTNRIDX> Unique identifier of the Partner N

Supplier
<TAXEXEMPT> Not used. N
<TAXID> Tax identifier of the partner. N

Table/Column Requir
ed
<USERAREA> PO Vendor level DFF attributes (16) N
DFFVENDOR <ATTR1 - Buyer's identifier in the supplier's

ATTR16> system (vendor's customer
number).
<CustomerNum>
ADDRESS This data type provides address Y

information for this partner. The
following rows list fields for
address data type related to partner
supplier site
<ADDRLINE1 - Lines of site address. Y

ADDRLINE9>
<ADDRTYPE> Not used. N
<CITY> City within the address. Y
<COUNTRY> Country within the address. N
<COUNTY> Not used. N
<DESCRIPTN> Supplier Site Name N
<FAX1 - FAX9> Fax numbers of the supplier site N
<POSTALCODE> Postal code within the address. N
<REGION> Not used. N
<STATEPROVN> State of Province within the Y

address.
<TAXJRSDCTN> Not used. N
<TELEPHONE1 - Telephone numbers for this N

TELEPHONE9> address.
<URL> Not used. N
Table/Column Requir
ed
<USERAREA> PO Vendor Site level DFF attributes N

(16)
DFFVENDORSITE
<ATTR1 - ATTR16>
CONTACT This data type provides contact Y

information for this supplier.
<NAME1> Contact name for the supplier. The Y

contact is entered for each Purchase
Order at the header. Use this as the
supplier contact. Use the contact
name and the telephone numbers
of this contact should be used.
<DESCRIPTN> Not used. N
<EMAIL> Email address of the contact N
<FAX1 - FAX9> Fax Number of the contact N
<NAME2 - NAME9> Not used. N
<TELEPHONE1 - Telephone number of the contact. N

TELEPHONE9>
PARTNER-SoldTo Y
<NAME1> Name of the buyer company name Y
Sold to name.

only.

ERP.This is the Sold_to customer
ID that is internal to the buyers
application.

Table/Column Requir
ed

is SoldTo.
<CURRENCY> Preferred operating currency of N

partner.
<PARTNRIDX> Unique identifier of the partner. OE_HEADERS_INT N

ERFACE.SOLD_TO
This is the EDI location code for the _ORG_ID
buyer. Use this code to derive the
information about this buyer.
ADDRESS The following rows list fields for N

the Address data type related to
Partner SoldTo. This is the Sold_to
address information.
<ADDRLINE1 - Lines of address. N

ADDRLINE9>
<CITY> City within the address. N
<COUNTRY> Country within the address. N
<FAX1 - FAX9> Fax number N
<POSTALCODE> Postal code within the address. N
<STATEPROVN> State of province within the N

address.

CONTACT The following rows list fields for Y

Contact data type related to Partner
SoldTo.
<NAME1> Name of Buyer e.g. Pat Stock Y
<DESCRIPTN> Not used. N
Table/Column Requir
ed
<EMAIL> Email address for the Contact. N
<FAX1 - FAX9> Fax Number of the contact N
<NAME2 - NAME9> Alternate contact names N
<TELEPHONE1 - Telephone number of the contact. N

TELEPHONE9>
<USERAREA> Not used. N
PARTNER-BillTo Bill to location in ERP. N
<NAME> Name of the trading partner. Bill to OE_HEADERS_INT Y

customer name. ERFACE.INVOICE_
CUSTOMER

only.
<PARTNRID> Uniquely identifies the Bill To Y

Location ID in ERP. This is the EDI
location code for the bill to
customer site.

is BillTo.

partner.
<PARTNRIDX> Unique identifier of the partner. OE_HEADERS_INT N

ERFACE.INVOICE_
TO_ORG_ID

the Address data type related to the
Partner Bill_To.

Table/Column Requir
ed
<ADDRLINE1 - Lines of address. OE_HEADERS_INT N

ADDRLINE9> ERFACE.INVOICE_
ADDRESS1/2/3
<ADDRTYPE> Not used. N
<CITY> City within the address. OE_HEADERS_INT N

ERFACE.INVOICE_
CITY
<COUNTRY> Country within the address. OE_HEADERS_INT N

ERFACE.INVOICE_
COUNTRY
<COUNTY> Not Used. OE_HEADERS_INT N

ERFACE.INVOICE_
COUNTY
<POSTALCODE> Postal code within the address. OE_HEADERS_INT N

ERFACE.INVOICE_
POSTAL_CODE
<STATEPROVN> State of province within the OE_HEADERS_INT N

address. ERFACE.INVOICE_
STATE

PARTNER-CARRIER Carrier information is passed in N

this segment. The carrier may
become a supplier in Oracle
Purchasing in patchset release H or
I which may impact how the carrier
tags are derived and the address or
contact segments may be used then.
This segment is not applicable to
Oracle Order Management.
<NAME1> Name of trading partner. Y
Table/Column Requir
ed

only.

ERP.

is Carrier.
ADDRESS The Address data type is not used N

for Partner Carrier.
CONTACT The Contact data type is not used N

for Partner Carrier.
PARTNER-End End Customer N
<NAME> Name of Trading Partner. Bill to OE_HEADERS_INT Y

customer name. ERFACE.END_CUS
TOMER_NAME

only.
<PARTNRID> Uniquely identifies the Bill To OE_HEADERS_INT Y

Location Id in ERP. This is the EDI ERFACE.END_CUS
location code for the bill to TOMER_NUMBER
customer site.
<PARTNRTYPE> Identifies the type of partner. Value Y

is End.

partner.
<PARTNRIDX> Unique identifier of the partner. N

Table/Column Requir
ed

Address data type related to the
End Customer.
<ADDRLINE1 – Lines of address. OE_HEADERS_INT N

ADDRLINE4> ERFACE.END_CUS
TOMER_ADDRESS
1/2/3/4
<ADDRTYPE> Not used N

ERFACE.END_CUS
TOMER_CITY

ERFACE.END_CUS
TOMER_COUNTR
Y
<COUNTY> County within the address OE_HEADERS_INT N

ERFACE.END_CUS
TOMER_COUNTY

ERFACE.END_CUS
TOMER_POSTAL_
CODE
<STATEPROVN> State of Province within the OE_HEADERS_INT N

address. ERFACE.END_CUS
TOMER_STATE

CONTACT N
Table/Column Requir
ed
<NAME> Contact Name OE_HEADERS_INT N

ERFACE.END_CUS
TOMER_CONTAC
T
POTERM POTERM data type represents Y

payment due dates and discounts.
<DESCRIPTN> Description of payment terms. Y
<TERMID>1 Identifier for payment terms. This Y

is the payment terms code for
example Net30. Can be mapped to
payment_terms in Order Order
management on the header level.
ATTCHREF Attachments at the header level. N

This will only support TO
SUPPLIER attachments.
<FILENAME> File name of the file attached if the Y

data type is file.
<URI> URL, if the data type is URL. Y
<DATETIME Creation date of the document. N
(CREATION)>
<DESCRIPTN> Description of the document. N
- <NOTES1- If the data type is Long text or short N

text then pass the notes to the
NOTES9> supplier in these elements.

Table/Column Requir
ed
<USERAREA> The following fields are provided Y

by Oracle in the USERAREA:
<SEQNUM> Y
Sequence Number of the
<DATATYPE> attachment.
Datatype Name: Short Text, Long

Text, Image, or OLE Object.
POORDERLIN This data type provides details of a Y

purchase order line. At least one
purchase order line data type is
required. This data type will occur
one or more times.
<POLINENUM> Line number of the purchase order. OE_LINES_INTERF Y

Original purchase order line ACE.ORIG_SYS_LI
number reference NE_REF
<QUANTITY(ORDERE Indicates the quantity of the item Y

D)> ordered.
Y
<VALUE> Numeric only, stores the value of
quantity. Y
<NUMOFDEC>
One character numeric only; Y
<SIGN> indicates the number of decimals in Y
<UOM>1 the value field.
A + or - indicates whether the

quantity is positive or negative.
The Unit of Measure indicates the

units of the quantity.
<ITEM> Identifier of the product. OE_LINES_INTERF Y

Concatenate all the segments to ACE.CUSTOMER_I
display the item This is the TEM_NAME
customer item number.
<DESCRIPTN> Description of the item. N
Table/Column Requir
ed
<ITEMX> Vendor's Item Number. This is the N

item number internal to the
supplier side (Oracle Order
Management).
<USERAREA>
<USERITEM User item description OE_LINES_INTERF N

DESCRIPTN> ACE.USER_ITEM_
DESCRIPTION
<DATETIME(NEEDDEL Need by date for the item. N

V>
<HAZRDMATL> Hazardous material class N

description.
<ITEMRV> Item revision number. This is the OE_LINES_INTERF N

customer item revision. ACE.CUSTOMER_I
TEM_REVISION
<ITEMRVX> Not used N
<NOTES1 - NOTES9> Note to supplier. N

Table/Column Requir
ed
<OPERAMT(UNIT)(T)> Unit price of the item. Following N

are the fields included in this
<VALUE> segment. N
<NUMOFDEC> Monetary unit amount of purchase N
<SIGN> order line. N
<CURRENCY> Indicates the number of decimals in N

the value field.
<UOMVALUE> N
A + or - indicates whether the
<UOMNUMDEC> amount is positive or negative. N
<UOM> Three character ISO currency code. N
Numeric value indicates the value

of the factor when amount is
expressed in terms of multiples of
UOM.
Represents number of decimals in

the UOMVALUE field.
Unit of measure indicates the units

of the quantitative amount.
<USERAREA> Oracle ERP provides the following

fields within this userarea:Not
<REQUESTOR> applicable for Oracle Order
<CATEGORYID> Management.
<CONTRACTPONUM> Requestor of this line. The

requester is at the distribution level
<CONTRACTPOLINEN and not at the line level. Need to
UM> find how EDI is deriving it as they
have it at the line level.
Item Category unique identifier.
Contract purchase order number

for this line
Contract purchase order line

number for this line. The contract
line numbers do not exist in Oracle
Purchasing.
Table/Column Requir
ed
<VENDORQUOTENU Vendor's quote number for this line N

M>
List price of the item
<LISTPRICE>
Market price of the item
<MARKETPRICE>
Unit price not to exceed this
<PRICENOTTOEXCEE amount.
D>
Negotiable Price Flag Y/N. Only
<NEGPRICE> applicable to Blankets and is called
Price Override in Oracle
<TAXABLE> Purchasing.
<TXNREASONCODE> If this item is taxable or not Y/N
<TYPE1099> Transaction Reason Code is used to
<LINEORDERTYPE> group requisition lines for
autocreating POs
<HAZRDUNNUM>
Type 1099 Y/N
<HAZRDUNDESC>
Line Order Type e.g. Goods,
DFFLINE Services etc.
<ATTR1-ATTR16> UN Hazard number
DFFITEM UN Hazard Description
<ATTR1-ATTR16> Desc Flex Fields at the line level
KFFITEM Desc Flex Fields at the item level
<ATTR1-ATTR16> Key Flex Fields at the item level
ATTCHREF-Item Level Item Level attachments from the

from Master Org master org
ATTCHREF-Item Level Item Level attachments from the

from Inventory Org inventory org
<USERAREA- Each occurrence of attachments in N

CONTD..> the userarea above at the item level
is treated as the ATTCHREF
<ATTCHREF> segment and has the following
elements. This will support
attachments TO SUPPLIER only.

Table/Column Requir
ed

data type is file.
(CREATION)>
<DESCRIPTN> Description of the document N
<NOTES1- If the data type is Long text or short N

<SEQNUM> Sequence number of the attachment Y
<DATATYPE> Datatype Name - Short Text, Long Y

Text, File, URL, Image or OLE
Object.
PARTNER Not used at line level. N
ATTCHREF Attachments at the line level. This N

will support TO SUPPLIER
attachments only.
<FILENAME> File name of the attached file if the Y

data type is file
(CREATION)>
<DESCRIPTN> Description of the document. N

Table/Column Requir
ed
<USERAREA> The following fields are provided Y

by Oracle in the USERAREA.
<SEQNUM> Y
Sequence Number of the
<DATATYPE> attachment.
Datatype Name - Short Text, Long

Text, Image or OLE Object.
POLINESCHD Data type for requested ship date N

information for this PO Line.
<<DATETIME(NEEDDE Needed By delivery date. This is OE_LINES_INTERF Y

LV>> the request date for the line. ACE.REQUEST_DA
TE
<QUANTITY(ORDERE Indicates quantity of item ordered. OE_LINES_INTERF Y

D)> ACE.ORDERED_Q
Numeric only, stores the value of UANTITY Y
<VALUE> quantity.
OE_LINES_INTERF Y
<NUMOFDEC> One character numeric only; ACE.ORDER_QUA
indicates the number of decimals in Y
<SIGN> NTITY_UOM
the value field. Y
<UOM>1 A + or - indicates whether the
quantity is positive or negative.
Unit of Measure indicates the units

of the quantity.
<PSCLINENUM> Identifies the line number on the OE_LINES_INTERF N

delivery schedule of the purchase ACE.ORIG_SYS_SH
order. IPMENT_REF
Shipment line reference from the

original purchase order line.

Table/Column Requir
ed
<USERAREA> Promise Date _LINES_INTERFAC N

E.SHIP_TO_ORG_I
<DATETIME> Last Acceptance Date D N
<DATETIME> Price Override, this is the new OE_LINES_INTERF N

price. Note that is a complete ACE.SHIP_TO_AD
<PRICEOVRRD> Amount field as per OAG specs N
DRESS1/2/3
<TAXABLE> Taxable Y/N N
OE_LINES_INTERF
<TAXCODE> Tax Code if Taxable is Y ACE.SHIP_TO_CIT N
Y
<REQUESTOR> Requestor for this shipment. N
OE_LINES_INTERF
PARTNER-ShipTo Oracle ERP provides the following ACE.SHIP_TO_CO N
<NAME1> fields related to ShipTo Partner UNTRY N

data type within this user area:
<ONETIME> OE_LINES_INTERF N
Name of the ShipTo partner. ACE.SHIP_TO_POS
<PARTNRID> TAL_CODE N
Indicates if this partner is
<PARTNERTYPE> established for this transaction OE_LINES_INTERF N
only. This is always 0. ACE.SHIP_TO_STA
<CURRENCY> N
TE
Uniquely identifies the partner in
<PARTNRIDX> ERP. N
ADDRESS Identifies the type of Partner. Value N
<ADDRLINE1 - is ShipTo. N
ADDRLINE9> Preferred operating currency of N
<CITY> Partner.
<COUNTRY> Unique identifier of the Partner.
<POSTALCODE> Lines of address for Partner ShipTo.
<STATEPROVN> City within the address.
<TELEPHONE1 - Country within the address.

TELEPHONE9> Postal code within the address.
State or province within the

address.
Telephone numbers for this

address.
Table/Column Requir
ed
<USERAREA- Attachments at the Shipment level. N

CONTD..> This will support TO SUPPLIER
attachments only. There could be
<ATTCHREF> multiple occurrences of this
segment for each shipment
schedule.

data type is file.
(CREATION)>
<DESCRIPTN> Description of the document N

<SEQNUM> Sequence number of the Y

attachment.
<DATATYPE> Y
Datatype Name - Short Text, Long
Text, Image or OLE Object.
<ORACLE.SUPPLIERS Suppliers reference for the N

HIPMENTREF> shipment.
PARTNER-End End Customer N
<NAME> Name of Trading Partner. Bill to OE_HEADERS_INT Y

customer name. ERFACE.END_CUS
TOMER_NAME

only.

Table/Column Requir
ed
<PARTNRID> Uniquely identifies the Bill To OE_HEADERS_INT Y

Location Id in ERP. This is the EDI ERFACE.END_CUS
location code for the bill to TOMER_NUMBER
customer site.
<PARTNRTYPE> Identifies the type of Partner. Value Y

is 'End'.

Partner.
<PARTNRIDX> Unique identifier of the Partner. N
<ADDRESS> The following rows list fields for N

Address data type related to the
End Customer.
<ADDRLINE1 – Lines of address. OE_HEADERS_INT N

ADDRLINE4> ERFACE.END_CUS
TOMER_ADDRESS
1/2/3/4
<ADDRTYPE> Not Used. N

ERFACE.END_CUS
TOMER_CITY

ERFACE.END_CUS
TOMER_COUNTR
Y
<COUNTY> County within the address OE_HEADERS_INT N

ERFACE.END_CUS
TOMER_COUNTY

ERFACE.END_CUS
TOMER_POSTAL_
CODE
Table/Column Requir
ed
<STATEPROVN> State of Province within the OE_HEADERS_INT N

address. ERFACE.END_CUS
TOMER_STATE

CONTACT N
<NAME> Contact Name OE_HEADERS_INT N

ERFACE.END_CUS
TOMER_CONTAC
T
<ORACLE.OWNER> Install Base Owner OE_HEADERS_INT N

ERFACE.IB_OWNE
R
<ORACLE.CURRENTL Install Base Current Location OE_HEADERS_INT N

OCATION> ERFACE.CURRENT
_LOCATION
<ORACLE.INSTALLED Install Base Installed At Location OE_HEADERS_INT N

ATLOCATION> ERFACE.INSTALL
ED_AT_LOCATIO
N
Note: Table Key

1Code conversion is required for this field or data type.
Oracle XML Gateway Message Designer - Properties

The source DTD used is 003_process_po_007.dtd, revision 7.2.1 of the Open Application
Group. Here are the other associated external reference DTD files:
• oagis_domains.dtd
• oagis_resources.dtd
• oagis_fields.dtd

• oagis_segments.dtd
• oagis_extensions.dtd
• oagis_entity_extensions.dtd
All the DTDs will be checked in ONT source area under $ont/xml/oag72
The targets for the Inbound XML Message are the Oracle Order Management Open
Interface tables OE_HEADERS_INTERFACE &OE_LINES_INTERFACE.
The PROCESS_PO DTD is a three level hierarchy with order lines split into one or more
shipment lines. The Oracle Order Management architecture, however, is a two level
hierarchy with Order Header and one or more Lines. The message map collapses the
three level XML Message into a two level structure when the data is inserted in the
Oracle Order Management Open Interface tables.
Please refer to the table Process_PO Message Map for a detailed analysis of the elements
mapped, actions, and derivation rules used by the Message Map.
Both the message maps created using the Message Designer and their associated DTDs
are stored in the database. The following Java programs are available to Load/Delete
Maps or Load/Delete DTD's into/from the XML Gateway repository. Please refer to the
Oracle XML Gateway User's Guide for more information.

• java LoadMap <DB username> <DB password> <Hostname>:<Port>:<SID>
<mymap.xgm>
• Example: java oracle.apps.ecx.loader.LoadMap apps apps ap505dbs:1521:dev115

• java DeleteMap <DB username> <DB password> <Hostname>:<Port>:<SID>

<mapname>
The Message Map is an .xgm file which will be stored in the Order Management
Source area under $ont/patch/115/xml/US/ ONT_3A4R_OAG72_IN.xgm
Note: Keep maps and DTDs in sync between the Message Designer
and the XML Gateway repository. When required, always reload
the map and DTD as a pair.
Extension Tags
Oracle Order Management adds the following tags as extensions on the Process_PO
XML documents sent to Oracle Order Management:
$ont/xml/oag72/oagis_extensions.dtd
• <!ELEMENT FTTERM (DESCRIPTN?, TERMID?)>
<!ELEMENT FOB (DESCRIPTN?, TERMID?)>
<!ELEMENT USERITEMDESCRIPTN %STRDOM;>
The following changes are made by Procurement as extensions to the XML
documents sent to Oracle Order Management. As a result, Oracle Order
Management must also modify the same OAG DTDs to prevent parse errors at the
XML gateway:
$ont/xml/oag72/oagis_entity_extensions.dtd
• Add the following tags:
<!ENTITY % DATETIME.EXCHRATEDATE "DATETIME">
Change <!ENTITY % SEG_DATETIME_QUALIFIERS_EXTENSION "OTHER"> to
<!ENTITY % SEG_DATETIME_QUALIFIERS_EXTENSION "OTHER |
EXCHRATEDATE">
• Add the following tags:
<!ELEMENT PAYMMETHOD (DESCRIPTN?, TERMID?)>
<!ELEMENT CREDTCRD (CARDID?,NAME?,(%DATETIME.EXPIRATION;)?)>
<!ELEMENT STARTACTIVEDATE %STRDOM;>
<!ELEMENT ENDACTIVEDATE %STRDOM;>
<!ELEMENT CATEGORYID %STRDOM;>
<!ELEMENT REVISIONNUM %STRDOM;>
<!ELEMENT ATTACHMENT (TEXT?)>
<!ELEMENT EXCHRATE %STRDOM;>
<!ELEMENT CONFIRM %STRDOM;>
<!ELEMENT PCARDHDR
(MEMBERNAME?,PCARDNUM?,(%DATETIME.EXPIRATION;)?,PCARDBRAND
?)>
<!ELEMENT MEMBERNAME %STRDOM;>
<!ELEMENT PCARDNUM %STRDOM;>

<!ELEMENT PCARDBRAND %STRDOM;>
<!ELEMENT CUSTOMERNUM %STRDOM;>
<!ELEMENT REQUESTOR %STRDOM;>
<!ELEMENT CONTRACTPONUM %STRDOM;>
<!ELEMENT CONTRACTPOLINENUM %STRDOM;>
<!ELEMENT VENDORQUOTENUM %STRDOM;>
<!ELEMENT LISTPRICE %STRDOM;>
<!ELEMENT MARKETPRICE %STRDOM;>
<!ELEMENT PRICENOTTOEXCEED %STRDOM;>
<!ELEMENT NEGPRICE %STRDOM;>
<!ELEMENT TAXABLE %STRDOM;>
<!ELEMENT TXNREASONCODE %STRDOM;>
<!ELEMENT TYPE1099 %STRDOM;>
<!ELEMENT LINEORDERTYPE %STRDOM;>
<!ELEMENT HAZRDUNNUM %STRDOM;>
<!ELEMENT HAZRDUNDESC %STRDOM;>
<!ELEMENT PRICEOVRRD %STRDOM;>
<!ELEMENT DISTPROJECT
(REQUESTOR?,DISTNUM?,PROJECTNUM?,PROJECTTYPE?,TASKNUM?,(%QUA
NTITY.ORDERED;)?,CONVRATE,(%DATETIME.EXCHRATEDATE;)?,DESTTYPE?
,DFFDISTRIBUTN?)>
<!ELEMENT PROJECTNUM %STRDOM;>
<!ELEMENT DISTNUM %STRDOM;>
<!ELEMENT PROJECTTYPE %STRDOM;>
<!ELEMENT TASKNUM %STRDOM;>
<!ELEMENT CONVRATE %STRDOM;>
<!ELEMENT DESTTYPE %STRDOM;>
<!ELEMENT DFFPOHEADER
(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRIBUTE5?,ATTR
IBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?,ATTRIBUTE10?,ATTRIBUT
E11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,ATTRIBUTE
16?)>
<!ELEMENT DFFVENDORSITE
16?)>
<!ELEMENT DFFVENDOR
16?)>
<!ELEMENT DFFLINE
16?)>
<!ELEMENT DFFITEM
16?)>
<!ELEMENT KFFITEM
16?,ATTRIBUTE17?,ATTRIBUTE18?,ATTRIBUTE19?,ATTRIBUTE20?)>
<!ELEMENT DFFDISTRIBUTN
16?)>
<!ELEMENT ATTRIBUTE1 %STRDOM;>

<!ELEMENT TANDC %STRDOM;>

<!ELEMENT GLOBALCONTRACT %STRDOM;>
<!ELEMENT GLOBALCONTRACTLIN %STRDOM;>
<!ELEMENT CONSIGNEDINV %STRDOM;>
<!ELEMENT DROPSHIPDETAILS (DROPSHIPMENT?, DROPSHIPCUSTNAME?,
SHIPINSTR?,
PACKINSTR?, SHIPMETHOD?, CUSTOMERPONUM?, CUSTOMERLINENUM?,
CUSTOMERSHIPNUM?,
CUSTOMERDESC?)>
<!ELEMENT DROPSHIPMENT %STRDOM;>
<!ELEMENT DROPSHIPCUSTNAME %STRDOM;>
<!ELEMENT SHIPINSTR %STRDOM;>
<!ELEMENT PACKINSTR %STRDOM;>
<!ELEMENT SHIPMETHOD %STRDOM;>
<!ELEMENT CUSTOMERPONUM %STRDOM;>
<!ELEMENT CUSTOMERLINENUM %STRDOM;>
<!ELEMENT CUSTOMERSHIPNUM %STRDOM;>
<!ELEMENT CUSTOMERDESC %STRDOM;>
<!ELEMENT SHIPPINGCONTROL %STRDOM;>
<!ELEMENT CONTRACTNUM %STRDOM;>
<!ELEMENT CONFIGID %STRDOM;>
<!ELEMENT PSCLNSTATUS %STRDOM;>
<!ELEMENT JOBTITLE %STRDOM;> -- HR Job title
<!ELEMENT CONTRACTORFIRSTNAME %STRDOM;> -- Contractor first name
<!ELEMENT CONTRACTORLASTNAME %STRDOM;> -- Contractor last name
<!ELEMENT PRICEDIFFERENTIAL
(NUMBER?,ENTITYTYPE?,MULTIPLIER?,PRICETYPE?)>
--repeatable segment
<!ELEMENT NUMBER %STRDOM;> --price differential line num
<!ELEMENT ENTITYTYPE %STRDOM;> -- Entity type
<!ELEMENT MULTIPLIER %STRDOM;> -- multiplier for the standard PO line
Acknowledge_PO
Overview
Oracle Order Management supports the Acknowledge_PO transaction for the OAG
XML standard.
Oracle Order Management generates the Acknowledge_PO message upon consuming
the Process_PO inbound message and sends an Acknowledge_PO message to the
buyer. The Acknowledge_PO message is sent in both the Synchronous and
Asynchronous processing of the incoming orders.
This outbound message carries the status of the order received via the inbound
Purchase Order request to the buyer. The message also contains the reason code for the
rejected orders.
Major Features
Major features of this transaction are as follows:
Generate and Send Acknowledge_PO Message Out
the Process_PO inbound message (by triggering the Order Import and entering the
order in Order Management tables). At this point Order Management must trigger the
workflow to send an Acknowledge_PO message to the buyer. This message should be
generated within the timeframe agreed upon in the Trading Partner Agreement.
The Acknowledge_PO message is generated in both the Synchronous and
Asynchronous processing of the incoming orders.
Acknowledge_PO message is populated with the information about the incoming
Process_PO request. The message ID of the incoming Purchase Order is stored and
retrieved later during the creation of the Acknowledge_PO.

For the details of this message and mapping to Order Management, please refer to the
table Acknowledge_PO OAG Message Map Details.
the Process_PO inbound message and sends an Acknowledge_PO message to the
buyer.
The Acknowledge_PO message is sent in both the Synchronous and Asynchronous
processing of the incoming orders.
Acknowledge_PO message has information about the incoming Process_PO request.
Possible Trigger Points for Acknowledge_PO Message

In the case of failure at the XML gateway processing BEFORE the order reaches the
Order Import tables, there is no action required by Oracle Order Management. The
XML gateway notification process handles the exception by notifying the System
Administrator on the buyer's side.
Possible Trigger Points

The following are the possible trigger points for the Acknowledge_PO message. These
points are exclusive to each other, which means that for an order only one
Acknowledge_PO message is generated at one of these points in the process.
After the Order import process runs, if there is a validation error and the Order import
process cannot create an order in the base order table, the Acknowledge_PO message is
sent to the buyer with a Reject status. If the Order Import process succeeds, the
Acknowledge_PO message is sent to the buyer with an Accepted status at order entry.
Message Map
Message Map
Name Description
Message Map Name ONT_3A4A_OAG72_OUT_PO
Direction Outbound
(Internal) Transaction Type ONT
(Internal) Transaction Subtype POA
External Transaction Type PO
External Transaction Subtype ACKNOWLEDGE
Name Description
Message Maps XGM File Name ONT_3A4A_OAG72_OUT_PO.xgm
Standard OAG
Release 7.2
Format DTD
DTD Name 004_acknowledge_po_008.dtd
Detail Value
Event Name oracle.apps.ont.oi.po_ack.create
Event Description Event for Process_PO Outbound

Acknowledgment
Subscription R_OEOA_SEND_ACKNOWLEDGMENT

event oracle.apps.ont.oi.po_ack.create raised
for sending acknowledgment for Process_PO.
Key: H => OE_HEADER_ACKS and L => OE_LINE_ACKS

Acknowledge_PO OAG Message Map Details
OAG Element Description Oracle OM OAG Req Y/N Code

/Comment Table /Column Conversion
Needed?
<ACKNOWLEDGE_
PO_008>
<CNTROLAREA>
<BSR>
<VERB>ACKNOWLE XMLG Y
DGE</VERB>
<NOUN>PO</NOUN XMLG Y
>
<REVISION>007</RE XMLG Y
VISION>
</BSR>
<SENDER>
<LOGICALID>CPAG XMLG Y
<LOGICALID>
<COMPONENT>OR XMLG Y
DERMGMT<COMPO
NENT>
<TASK>ACKPO<TAS XMLG Y
K>
<REFERENCEID>CP XMLG Y
AGPOBERLIN02<RE
FERENCEID>
<CONFIRMATION>0 XMLG Y
</CONFIRMATION>
Needed?
<LANGUAGE>ENG< XMLG Y
/LANGUAGE>
<CODEPAGE>CP000 XMLG Y
111</CODEPAGE>
<AUTHID>RSCHUL XMLG Y
TE</AUTHID>
<SENDER>
<DATETIME XMLG Y
qualifier="CREATIO
N">
<YEAR>1996</YEAR XMLG Y
>
<MONTH>06</MON XMLG Y
TH>
<DAY>30</DAY> XMLG Y
<HOUR>23</HOUR> XMLG Y
<MINUTE>59</MIN XMLG Y
UTE>
<SECOND>59</SECO XMLG Y
ND>
<SUBSECOND>0000< XMLG Y
/SUBSECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>

Needed?
<ACKNOWLEDGE_
PO>
<POORDERHDR>
<DATETIME Date time H.ORDERED_ Y

qualifier="DOCUME stamp of the DATE
NT"> Sales order
creation.
Derived using
Convert To
OAG Datetime.
<YEAR>1996</YEAR Y
>
<MONTH>06</MON Y
TH>
<DAY>30</DAY> Y
<HOUR>23</HOUR> Y
<MINUTE>59</MIN Y
UTE>
<SECOND>59</SECO Y
ND>
<TIMEZONE>+0100</ Y
TIMEZONE>
<SUBSECOND>0000< Y
/SUBSECOND>
</DATETIME>
Needed?
<OPERAMT Total amount H.ORDER_TOT Y

qualifier="EXTENDE for the Order. AL
D" type="T"> This is not
stored but
calculated
using Convert
To OAG
Amount.
<VALUE>670</VALU Total monetary Y

E> amount of the
order.
<NUMOFDEC>2</N Indicates the Y

UMOFDEC> number of
decimals in the
value field.
<SIGN>+</SIGN> A + or - Y
indicates
whether the
amount is
positive or
negative.
<CURRENCY>USD</ Three character Y

CURRENCY> ISO currency
code.
<UOMVALUE>1 indicates the
value of the
factor when
amount is
expressed in
terms of
multiples of
UOM.

Needed?
<UOMNUMDEC>0</ Represents Y
UOMNUMDEC> number of
decimals in the
UOMVALUE
field.
<UOM>EACH</UO Unit of Y
M> Measure
indicates the
units of the
quantitative
amount.
</OPERAMT> Y
<POID>12345678</PO Original H.CUSTOMER Y

ID> Customer PO _PO_NUMBER
number from
the inbound
process_PO
should be
populated here.
<POTYPE>224</POT 'STANDARD' Y
YPE>
Indicates the
type of the PO.
At the moment
only Standard
PO will be the
only type
supported. The
Order Type on
Process
Purchase Order
will no longer
automatically
be set to
Standard.
Needed?
<PORELEASE>1</PO PO release N
RELEASE> number. Is not
populated by
OM.
Purchasing will
split the Po
release number
from the PO
number which
has a format of
PO Number
release number
*See Notes
<ACKHEADER>
<SENDER> * See Notes Y
<LOGICALID>CPAG XML Gateway XML Gateway Y

</LOGICALID> API API
<COMPONENT>PU XML Gateway XML Gateway Y

RCHASING</COMP API API
ONENT>
<TASK>POCREATE< XML Gateway XML Gateway Y

/TASK> API API
<REFERENCEID>CP XML Gateway XML Gateway Y

AGPOBERLIN02</RE API API
FERENCEID>
<CONFIRMATION>0 XML Gateway XML Gateway Y

</CONFIRMATION> API API
<LANGUAGE>ENG< XML Gateway XML Gateway Y

/LANGUAGE> API API
<CODEPAGE>CP000 XML Gateway XML Gateway Y

111</CODEPAGE> API API

Needed?
<AUTHID>CMKURT XML Gateway XML Gateway Y

</AUTHID> API API
</SENDER>
<ACKCODE>1</ACK Status Code * H.FIRST_ACK_ Y

CODE> CODE
See Notes
<NOTES Reason Code * N

index="1">This is a
test See Notes
message</NOTES>
<SALESORDID>3232 Sales Order H.ORDER_NU N

5</SALESORDID> Number MBER
</ACKHEADER> N
<PARTNER> N
<NAME Trading partner

index="1">CPAG</N name . In this
AME> case Buyers
name. Derived
from
OE_XML_PRO
CESS_UTIL.GE
T_SOLD_TO_E
DI_LOC
<ONETIME>0</ONE 0
TIME>
<PARTNERID>A123< Internal H.SOLD_TO_O

/PARTNERID> customer RG_ID
number in the
sellers system
(OM).
Needed?
<PARTNERIDX>A12 Unique
3></PARTNERIDX> identifier for
the sold to
partner.
Value should
be EDI Location
code for the
sold-to partner.
Derived from
OE_XML_PRO
CESS_UTIL.GE
T_SOLD_TO_E
DI_LOC.
<PARTNERTYPE>Sol Partner Type.

dTo</PARTNERTYP
E> Value should
be 'Sold To'
</PARTNER>
<PARTNER> N
<NAME Trading partner H.SHIP_FROM

index="1">CPAG</N name. In this _ORG
AME> case Suppliers
name.
<ONETIME>0</ONE 0
TIME>
<PARTNERID>A123< Supplier H.SHIP_FROM

/PARTNERID> number This _ORG_ID
will be the
internal
location
number for the
seller.

Needed?
<PARTNERIDX>A12 Unique
3></PARTNERIDX> identifier for
the supplier.
EDI location
code for the
supplier. Setup
in
Inventory/setup
/Org/Location.
This code is
used by the
buyer (PO) to
identify the
supplier.
<PARTNERTYPE>Su Partner type.

pplier</PARTNERTY
PE> The value
should be
'Supplier'
</PARTNER>
<POTERM> N
<TERMID>XXX</TER Payment term H.PAYMENT_ Y Y

MID> code. TERM_ID
<DESCRIPTN>XXX</ Description of N
DESCRIPTION> the payment
term
</POTERM>
</POORDERHDR>
<POORDERLIN>
Needed?
<QUANTITY This is the L.ORDERED_Q Y

qualifier="ORDERED original UANTITY
"> ordered Qty.
Required by
OAG but will
be ignored by
Oracle
Purchasing.
This quantity
would need to
be stored from
the Original PO
(Process_PO
inbound).
Derived Using
Convert to
OAG Quantity.
<VALUE>1</VALUE Y
>
<NUMOFDEC>0</N Y
UMOFDEC>
<SIGN>+</SIGN> Y
<UOM>EACH</UO Y
M>
</QUANTITY> Y

Needed?
<OPERAMT Changed Unit L.UNIT_SELLI N

qualifier="UNIT" selling price. NG_PRICE
type="T"> This the new
price if any
changes are
made to the
price. If price is
not changed
this can be left
null. Derived
using Convert
to OAG
Operating
Amount.
<VALUE>6500000</V Y
ALUE>
<NUMOFDEC>2</N Y
UMOFDEC>
<SIGN>+</SIGN> Y
<CURRENCY>USD</ Y
CURRENCY>
<UOMVALUE>1
<UOMNUMDEC>0</ Y
UOMNUMDEC>
<UOM>EACH</UO Y
M>
</OPERAMT>
<POLINENUM>1 number of the NE_REF
original PO.
Needed?
<ITEMX>XXXXXX number. ITEM
<USERAREA>
<USERITEMDESCRI L.USER_ITEM_
PTN>item desc DESCRIPTION
</USERITEMDESCRI
PTN>
</USERAREA>
<ACKLINE>
<ACKCODE>1</ACK Status Code. L.FIRST_ACK_ Y

CODE> CODE
See Notes.
<NOTES Reason Code. N

index="1">This is a See Notes.
test
message</NOTES>
</ACKLINE>
<POLINESCHD>

Needed?
<DATETIME Needed by L.REQUEST_D Y

qualifier=" delivery date as ATE
NEEDDELV"> from the
Original
PO. Required
by OAG and
will be ignored
by Purchasing.
This should be
mapped to the
request date in
OM. Derived
using Convert
To OAG
Datetime.
<YEAR>1996</YEAR Y
>
<MONTH>07</MON Y
TH>
<DAY>01</DAY> Y
<HOUR>23</HOUR> Y
<MINUTE>59</MIN Y
UTE>
<SECOND>59</SECO Y
ND>
<SUBSECOND>0000< Y
/SUBSECOND>
</DATETIME>
Needed?
<QUANTITY Original Order L.ORDERED_Q Y

qualifier="ORDERED Quantity. UANTITY
">
This quantity
would need to
be stored from
the Original PO
(Process_PO
inbound).
Derived using
Convert To
OAG Quantity.
<VALUE>1</VALUE Y
>
<NUMOFDEC>0</N Y
UMOFDEC>
<SIGN>+</SIGN> Y
<UOM>EACH</UO Y Y
M>
</QUANTITY>
<PSCLINENUM>1 Schedule HIPMENT_REF
shipment line
number from
the original PO.
</USERAREA>
<ACKCODE>X</AC L.FIRST_ACK_ N
KCODE> CODE

Needed?
<DATETIME Promised L.SCHEDULE_ N

qualifier = " delivery date ARRIVAL_DA
PROMDELV"> from OM. TE
Derived using
Convert To
OAG Datetime.
<YEAR>1996</YEAR Y
>
<MONTH>07</MON Y
TH>
<DAY>01</DAY> Y
<HOUR>23</HOUR> Y
<MINUTE>59</MIN Y
UTE>
<SECOND>59</SECO Y
ND>
<SUBSECOND>0000< Y
/SUBSECOND>
</DATETIME>
<SALESORDID>123</ Sales Order H.ORDER_NU N

SALESORDID> number for this MBER
order line.
<SOLINENUM>1</S Sales order line L.LINE_NUMB N

OLINENUM> number *. ER
See Notes.
</USERAREA>
</POLINESCHD>
Needed?
</POORDERLIN>
</ACKNOWLEDGE_
PO>
</DATAAREA>
</ACKNOWLEDGE_
PO_008>
** XMLG – XML
gateway
Message Map Notes
Name Description
POHEADER/PORELASE This is the Purchase Order release number

that Order Management doesn't store.
Currently, the solution is provided by Oracle
Application Server 10g where the Purchase
Order release number is concatenated to the
Purchase Order number and sent in as a
Customer PO number. On the Purchasing side
this concatenated number is separated again
by Oracle Application Server 10g and
populated in to the release number columns
for Purchasing.
ACKHEADER / ACKCODE Status code –
• 0- Accepted
• 2- Reject

Name Description
ACKHEADER / NOTES Reason code – The value of the Ackcode field

determines the values of this text field:
Accept or Reject
When ACK PO is used as a confirmation for

Change PO or Cancel_PO the Reason code is
not required.
POLINE / ACKLINE / ACKCODE Status Code –
• Accept if all the shipment lines are accepted

(even with changes)
• Rejected if any of the shipment lines is

rejected.
POLINE / POLNSTATUS Line Status –
• Open - PO line is open to receiving.
• Closed - PO line has completed normally. It

is no longer available to receiving.
• Cancelled – PO line has completed

abnormally or has been deleted. The PO is no
longer open to receiving.
USERAREA / SOLINENUM This element contains sales order line number.

Its been added here to allow 3A4 transaction
to create multiple Sales orders from one PO.
POLINESCHD/ USERAREA/ ACKLINE Status code –

/ACKCODE
• 0- Accept
• 2- Reject
POLINESCHD / DATETIME(NEEDDELV) This date element will contain the

request_date.
POLINESCHD / QUANTITY (ORDERED) This quantity element will contain the

ordered_quantity.
Message Map 'ONT_3A4A_OAG72_OUT.xgm'

The message map 'ONT_3A4A_OAG72_OUT' is created using the Oracle XML Gateway
Message Designer tool. Please refer to Table, "Message Map" for the detailed map
analysis.
The source DTD used is 004_acknowledge_po_008.dtd, revision 7.2.1 of the Open
Application Group. The other associated external reference DTD files are;
oagis_resources.dtd
oagis_fields.dtd
oagis_segments.dtd
All the DTD's will be checked in ONT source area under $ont/xml/oag72
The target for the Outbound XML Message are the Order Management
Acknowledgment tables OE_HEADER_ACKS & OE_LINE_ACKS.
The ACKNOWLEDGE_PO_008 DTD is a three level hierarchy with Order Lines split
into one or more Shipment Lines. The Order Management architecture is however a two
level one with the order header and one or more lines. The message map will expand
the two level structure of the Order Management tables to three level XML Message.
Please refer to Table, "Message Map" for a detail analysis of the elements mapped,
actions and derivation rules used by the Message Map.
XML Gateway User's Guidefor more information.

<mymap.xgm>

ONT_3A4A_OAG72_OUT_PO.xgm

<mapname>
ONT_3A4A_OAG72_OUT_PO.xgm
The Message Map is a .xgm file which will be stored in the Order Management
Source area under $ont/patch/115/map/ ONT_3A4A_OAG72_OUT_PO.xgm


If the profile option OM: Run Order Import for XML is set to Synchronous, a
pre-defined Workflow event is seeded to run Order Import if the Profile Option OM:
Process Transaction is set to ONLINE. This Workflow subscribes to the event raised by
the Post Process of the XML Gateway. As part of the Workflow Process, Order Import is
run for the XML Message which is currently being consumed. After the Run Order
Import completes (Successfully or With Error), the next event is raised to continue
processing.
Seeded Workflow
Send XML PO Acknowledgment
Show_SalesOrder
The Show_SalesOrder message is used by the seller to send order status information, by
line item for an order to a buyer. This outbound message carries the status of the order
line.
Generate and send Show_salesorder message out

Oracle Order Management generates the outbound Show SO message at various trigger
points described in following sections. The Show SO message contains status
information about the order at the line item level. For the details of this message and
mappings refer to Table, "Message Map".
Periodical
The Show_salesorder message can be sent periodically depending on the period set in
the trading partner agreement between the buyer and the seller. Examples of this would
be daily, weekly, or at a particular time of the day.
Order Management provides the concurrent program called by the triggering
mechanism, scheduling the process of the concurrent program to generate the
show_salesorder message. This API has following parameters:
1. Trading partner ID (EDI Location code) – Order Management created the
Show_salesorder message for this trading partner.
2. Open Orders Only – This is the order status that Order Management creates the
show_salesorder message for. The API chooses between open or closed orders. If
Open Orders Only is set to Yes, only open orders will be picked up. If Open Orders
Only is set to No, only closed orders will be picked up.
3. Closed for Days – Order Management is currently not supporting the use of this
parameter. This would be number of days. Order Management would create a
show_salesorder message for all closed orders, which are closed within last 'N'
number of days.
4. Sales Order No From – Starting at sales order number.
5. Sales Order No To – End at sales order number.
6. Sales Order date from- From sales order creation date.
7. Sales Order date to – To sales order date.
8. Customer PO No From – Starting at Customer PO number.
9. Customer PO No To – End at Customer PO number.
Order Changes
Changes in the attributes of the order that occur during order processing. This could be
shipping or scheduling for example. If changes to any of these attributes occur in a
booked order, the Show Sales Order message is sent.
Changes in following attributes are supported at this point:
• Unit selling Price,
• Ordered Qty
• Scheduled arrival date
• Shipped Qty
• Scheduled Ship Date
Any time any of these attributes change for a booked order Order Management
generates a Show_Salesorder message.
Adding a new line to a booked order also generates a Show_Salesorder message.
Consequently, splitting a line also generates a Show_Salesorder message, due to the
quantity change and the generation of the new line.
• Status change due to business events – Booking the order, shipping, or scheduling
of lines - the Show_SalesOrder is generated when the order is booked. It will also,
due to detection of the corresponding attribute changes, be generated for
scheduling and shipping of lines.

Business Scenarios and Process Flow
The Show_SalesOrder message is created by the Order Management in response to
various trigger points. The period set by the customer is usually one of the key trigger
points. Additionally, you can initiate show_salesorder as a result of any or a
combination of the following scenarios:
1. The order is booked
2. If the Unit selling price, Schedule delivery date, or ordered quantity changed
systematically (for booked orders)
3. The line is scheduled
4. The line is shipped
5. The line is cancelled
6. The line is added to a booked order
The XML Gateway forms the SHOW_SO message.
Show_SalesOrder Message Map

Key: H => OE_HEADER_ACKS, L => OE_LINE_ACKS
Show_SalesOrder Message Map
OAG Element Desc/Comment Oracle OM O Code

Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<SHOW_SALESORDER_006>
<CNTROLAREA> Y
<BSR>
<VERB>SHOW</VERB> XMLG
<NOUN>SALESORDER</NOUN XMLG
>
Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<REVISION>006</REVISION> XMLG
</BSR>
<SENDER> N
<LOGICALID>XGRB1109</LOGI XMLG
CALID>
<COMPONENT>OM</COMPON XMLG
ENT>
<TASK>SO</TASK> XMLG
<REFERENCEID>9534223449</RE XMLG
FERENCEID>
<CONFIRMATION>1</CONFIR XMLG
MATION>
<LANGUAGE>ENG</LANGUAG XMLG
E>
<CODEPAGE>CP001001</CODEP XMLG
AGE>
<AUTHID>SMITHJ</AUTHID> XMLG
</SENDER>
<DATETIME XMLG Y
qualifier="CREATION">
<YEAR>1998</YEAR>
<MONTH>12</MONTH>

Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<DAY>29</DAY>
<HOUR>00</HOUR>
<MINUTE>25</MINUTE>
<SECOND>45</SECOND>
<SUBSECOND>0000</SUBSECO
ND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SHOW_SALESORDER>
<SOHEADER>
<SALESORDID>S0001</SALESOR Sales order number. H.ORDER_NUMB Y

DID> ER
<DATETIME Date time stamp of H.ORDERED_DA

qualifier="DOCUMENT"> sales order creation. TE
Derived using Convert
<YEAR>1998</YEAR> To OAG Datetime.
<MONTH>12</MONTH>
<DAY>29</DAY>
<HOUR>00</HOUR>
<MINUTE>25</MINUTE>
Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<SECOND>45</SECOND>
ND>
</DATETIME>
<POID>123<POID> Customer PO number. H.ORIG_SYS_DO N

CUMENT_REF
<SOSTATUS>XXX<SOSTATUS> Sales order status (see H.FIRST_ACK_C N

notes). ODE
<PARTNER> N
<NAME Trading partner name

index="1">ACME</NAME> . In this case Buyers
name. Derived from
OE_XML_PROCESS_
UTIL.GET_SOLD_TO_
EDI_LOC.
<ONETIME>0</ONETIME> 0
<PARTNRID>AC01234</PARTNR Internal customer H.SOLD_TO_ORG

ID> number in the sellers _ID
system (OM).
<PARTNRIDX>1234</PARTNRID Unique identifier for

X> the sold to partner.
Value should be EDI

Location code for the
sold-to partner.
Derived from
OE_XML_PROCESS_
UTIL.GET_SOLD_TO_
EDI_LOC.

Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<PARTNRTYPE>sold-to</PARTN Partner Type.

RTYPE>
Value should be 'Sold
To'
</PARTNER>
<PARTNER> N
<NAME Trading partner name.

index="1">ACME</NAME> In this case Suppliers
name
<ONETIME>0</ONETIME> 0
<PARTNRID>AC01234</PARTNR Supplier number H.SHIP_FROM_O

ID> RG_ID
This will be the
internal location
number for the seller.
<PARTNRIDX>1234</PARTNRID Unique identifier for ECX_OAG_CONT

X> the supplier. ROLAREA_TP_V.
SOURCE_TP_LOC
EDI location code for ATION_CODE
the supplier. Setup in (XMLG)
Inventory/setup/Org/L
ocation.
This code is used by

the buyer (PO) to
identify the supplier.
<PARTNRTYPE>Supplier</PART Partner type.

NRTYPE>
The value should be
Supplier.
</PARTNER>
Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<SALESINFO> N
<SALESPERSN>BOB</SALESPER Sales person name.

SN> Derived from
OE_XML_PROCESS_
UTIL.GET_SALES_PE
RSON
</SALESINFO>
</SOHEADER>
<USERAREA>
<REVISIONNUM>1</REVISION Po revision number.

NUM> Om does not need to
map this.
<PORELEASE>1</PORELEASE> Po release Number.

OM does not need to
map this.
<ORACLE.SUPPLIER.DOCREF>A Supplier reference for H.ORIG_SYS_DO N Must

123>/ORACLE.SUPPLIERDOCRE the Customer PO CUMENT_REF have
F>
< /USERAREA>
</SOHEADER>
<SOLINE>
<SOLINENUM>1</SOLINENUM Sales order line L.LINE_NUMBER Y Must

> number Have

Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<SOLNSTATUS>OPEN</SOLNST Sales Order Line L.FIRST_ACK_CO N Nice

ATUS> status (see notes) DE to
Have
< ITEM>XXX<ITEM> Supplier's item N Must

number This will be Have
the item number from
OM
<DESCRIPTN>ACME Item Description N Nice

WIDGET</DESCRIPTN> to
have
<ITEMX>XXX<ITEMX> Buyer's item number L.CUSTOMER_IT N Must

EM Have
<OPERAMT qualifier="UNIT" Unit selling price. L.UNIT_SELLING N Must

type="T"> Derived using Convert _PRICE have
to OAG Operating
Amount.
<VALUE>6500000</VALUE>
<NUMOFDEC>2</NUMOFDEC>
<SIGN>+</SIGN>
<CURRENCY>USD</CURRENCY
>
<UOMVALUE>1</UOMVALUE>
<UOMNUMDEC>0</UOMNUM
DEC>
<UOM>EACH</UOM>
Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
</OPERAMT>
<USERAREA>
<USERITEMDESCRIPTN>itemdes L.USER_ITEM_DE
c</USERITEMDESCRIPTN> SCRIPTION
<ORACLE.SUPPLIERLINEREF>1 Suppliers reference for L.ORIG_SYS_LIN N Must

</ORACLE.SUPPLIERLINEREF> the customer PO line E_REF have
</USERAREA>
<SOLINE>
<OPERAMT qualifier="UNIT" Unit selling price. L.UNIT_SELLING N

type="T"> Derived using Convert _PRICE
to OAG Operating
Amount.
<VALUE>6500000</VALUE>
<SIGN>+</SIGN>
<CURRENCY>USD</CURRENCY
>
<UOMVALUE>1</UOMVALUE>
<UOMNUMDEC>0</UOMNUM
DEC>
<UOM>EACH</UOM>
</OPERAMT>

Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<SOLINENUM>1</SOLINENUM Sales order line L.LINE_NUMBER Y

> number
<ITEMX>XXX<ITEMX> Buyer's item number L.CUSTOMER_IT N

EM
<SOLNSTATUS>OPEN</SOLNST Sales Order Line L.FIRST_ACK_CO N

ATUS> status (see notes) DE
<USERAREA>
<USERITEMDESCRIPTN>itemdes L.USER_ITEM_DE
c</USERITEMDESCRIPTN> SCRIPTION
</USERAREA>
<SOSCHEDULE>
<SOSLINENUM>123<SOSLINEN Schedule line number. L.SHIPMENT_NU N

UM> MBER
<POLINENUM>123<POLINENU Customer PO line L.ORIG_SYS_LIN N

M> number E_REF
<PSCLINENUM>123<PSCLINEN Customer PO schedule L.ORIG_SYS_SHIP N

UM> line number. MENT_REF
<QUANTITY qualifier=" Quantity ordered. L.ORDERED_QU N

ORDERED"> Derived using Convert ANTITY
To OAG Quantity.
<VALUE>1</VALUE>
<SIGN>+</SIGN>
Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<UOM>EACH</UOM>
</QUANTITY> Y
<DATETIME qualifier=" Needed by delivery L.REQUEST_DAT N

NEEDDELV"> date as from the E
Original PO. This
<YEAR>1998</YEAR> should be mapped to
the request date in
OM. Derived using
Convert To OAG
Datetime
<MONTH>12</MONTH>
<DAY>29</DAY>
<HOUR>00</HOUR>
<MINUTE>25</MINUTE>
<SECOND>45</SECOND>
ND>
</DATETIME>
<DATETIME qualifier=" Date time on which L.SCHEDULE_AR N

DELIVSCHED"> the goods are RIVAL_DATE
scheduled to be
<YEAR>1998</YEAR> delivered. Derived
using Convert To
OAG Datetime
<MONTH>12</MONTH>

Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
<DAY>29</DAY>
<HOUR>00</HOUR>
<MINUTE>25</MINUTE>
<SECOND>45</SECOND>
ND>
</DATETIME>
<USERAREA>
<ORACLE.SUPPLIERSHIPMENT Suppliers reference for L.ORIG_SYS_SHIP N Must

REF>1 customer Shipment MENT_REF have.
</ORACLE.SUPPLIERSHIPMENT
REF>
<ORACLE.SPLITLINE>N</ORAC Flag indicating that Derived N Must

LE.SPLITLINE> this line is split. have.
<ORACLE.SPLITFROMLINEREF Line reference for the L.SPLIT_FROM_LI N May

>10</ORACLE.SPLITFROMLINE original line that this NE_ID have
REF> shipment has split when
from line is
split.
</USERAREA>
</SOSCHEDULE>
</SOLINE>
</SHOW_SALESORDER>
Table/Column A Conv
G ersio
re n
qd Need
Y/ ed
N Y/N
</DATAAREA>
</SHOW_SALESORDER_006>
Message Map Notes
SO Status SO Line Status
Open- Any status other than the following Open- Any status other than the following
ones in Order Management. ones in Order Management.
Closed- Closed status in Order Management Shipped – Shipped status in Order

Management
Cancelled- Cancelled status in Order
Management Closed- Closed status in Order Management
Cancelled- Cancelled status in Order

Management
Message Map
Name Description
Message Map Name: ONT_3A6_OAG72_OUT_SSO
Direction: Outbound
(Internal) Transaction Subtype: SSO
External Transaction Type: SO
External Transaction Subtype: SHOW

Name Description
Message Maps XGM File Name: ONT_3A6_OAG72_OUT_SSO.xgm
Standard: OAG
Release: 7.2
Format: DTD
DTD Name: SHOW_SALESORDER_006
Detail Value
Event Name oracle.apps.ont.oi.show_so.create
Event Description Event for Outbound Show_SalesOrder
Subscription R_SHOW_SALES_ORDER
Subscription Description Event subscription for the

oracle.apps.ont.oi.show_so.create event for
Outbound Show_SalesOrder.
Message Set Up
To implement a message with a trading partner, use the XML Gateway message set up
to define the trading partner or hub, code conversion values, and internal to external
system administrator to relate system or process errors.
Message Map ONT_3A6_OAG72_OUT_SSO.xgm

The message map ONT_3A6_OAG72_OUT_SSO is created using the Oracle XML
Gateway Message Designer tool. Please refer to Message Map table for the detailed map
analysis.
The source DTD used is 091_show_salesorder_006.dtd, revision 7.2.1 of the Open
Application Group. The other associated external reference DTD files are:
• oagis_resources.dtd
• oagis_fields.dtd
• oagis_segments.dtd
All the DTD's are checked in ONT source area under $ont/xml/oag72.
The Source for the Outbound XML Show SO Message is the Order Management
Acknowledgment tables OE_HEADER_ACKS & OE_LINE_ACKS.
The 091_show_salesorder_006 DTD is a three level hierarchy with order lines split into
one or more shipment lines. The Order Management architecture is however a two level
one with the order header and one or more lines. The message map will expand the two
level structure of the Order Management tables to a three level XML Message.
Please refer to Table, "Message Map" for a detail analysis of the elements mapped,
actions and derivation rules used by the Message Map.
or Load/Delete DTD's into/from the XML Gateway repository. Make sure you change
your environment to your development environment and execute "source
/ecxdev/ecx/utils/ javaenv_wfidc.sh" to set up your Java environment.

<mymap.xgm>
ONT_3A6_OAG72_OUT_SSO.xgm

<mapname>
ONT_3A6_OAG72_OUT_SSO.xgm
The Message Map is a .xgm file which will be stored in the Order Management Source
area under $ont/patch/115/map/ ONT_3A6_OAG72_OUT_SSO.xgm

Pre-Defined Workflow: Order Management Show_SalesOrder

A pre-defined Workflow Process Show_SalesOrder is provided as part of OESO
Workflow, which generates the Outbound Show_SalesOrder.
This Workflow receives the event to Show_SalesOrder, then generates the data using
the Acknowledgment tables, and then use XML Gateway's SEND DOCUMENT
function to deliver the Show_SalesOrder XML to the trading partner.
The Show Sales Order concurrent program is available in the Concurrent Requests
window.
Seeded Workflow
The figure below displays the Show_SalesOrder Workflow:
Change_salesorder
Overview
Using the Change_salesorder, the seller can:
• Acknowledge acceptance of a pending purchase order line
• Initiate changes to a purchase order
You can set up a requirement for a response document for seller-initiated changes
within the Trading Partner Agreement. For example, the buyer must respond with
PIP3A8, Request Purchase Order Change, to accept the proposed changes. If the
changes are not accepted, PIP3A9, request Purchase Order Cancel must be sent by the
buyer.
Both Order Import of closed orders and HVOP are currently not supported for XML
orders.
Generate a Change_salesorder Message Outbound From Order Management

Oracle Order management generates a Change_salesorder message when the sales
order is changed either manually or by the process_order API. The change_salesorder
may also be generated in case of change of status of the sales order from Pending to
Accept or Reject, and notify to the buyer of the change.
The following are the assumed definitions for Accept, Reject, and Pending:
• Accept - Booked status
• Reject - Order cannot be Entered and is rejected.
• Pending - Entered status.
Note: While the RosettaNet standard allows Pending lines to go to

Reject, in Order Management, this implies that 3A7 would be sent
when an Entered order is rejected. However, since currently all of
the 3A7 (and 3A6) processing requires an Order to be Booked,
triggering 3A7 on the transition from Pending to Reject is not
supported.
Place an Order on Hold and Clear Holds

When changes occur, a Change_salesorder message notifies the buyer to put the order
on hold. This hold can be cleared as follows:
Changes are made to the order after booking and the order is put on hold before
sending 3A7 to the buyer
Purchasing sends a Request Purchase Order Change (3A8) transaction verifying the
acceptance of the proposed changes.
• The 3A8 Response is consumed and the order line attributes mentioned below are
compared. If any of these attributes do not match the current data on the order line,
the 3A8 Response is rejected.
If the attributes do match, then the 3A8 Response is accepted and the hold is
removed. The order progresses through the processing.
Note: If there is a 3A8 that comes in as an independent request

before 3A7 response then the hold is removed and the 3A8 request
will be acted upon. If there is a subsequent 3A8 that arrives as a
response for the same 3A7, 3A8is processed and depending if the
response has values that match the order attributes mentioned
below or it will be accepted or rejected.
• If purchasing rejects the 3A7 proposed changes, then purchasing sends a Request
Purchase Order Cancel (3A9) transaction, canceling the original purchase order.
Order Management receives and consumes the Request Purchase Order Cancel
(3A9) and cancels the purchase order within Order Management.
If Cancel PO is received for the lines on hold the lines are removed from hold and
cancelled.
If Oracle Purchasing rejects the 3A7 proposed changes, then Purchasing can also send
back a 3A8 Response using the ACKCODE tag with a value of 2 to communicate Reject.
Note that no value or a value of 0 in this tag implies Accept.
If the ACKCODE tag has a value of 2 at either Line or Shipment level for a Change PO
Response, Order Management does not consume that line. However, Order
Management does process the Accepted lines (i.e. ACKCODE tag has no value or a
value of 2).
If the ACKCODE tag has a value of 2 at Header level, Order Management doesn't
consume the entire document.
This feature of Accepting and Rejecting changes is not required - if the ACKCODE tag is
not populated, Order Management will automatically process every line to check if the
attributes match the values currently on the Sales Order.
For the implementations where the seller chooses not to require a response for 3A7
there is a setup to state that the response is not required for the 3A7 created by the
seller. In this case the order is put on hold. A profile option OM: Change SO Response
Required controls the response at site level with values Y or N.
Ability to Match Incoming Change_PO (3A8) or Cancel_PO (3A9) to The Original Change_salesorder (3A7)
Order Management must be able to match the incoming 3A8 (which can be a response
to the 3A7 originated by Order Management) or 3A9. The match can be done using the
following two criteria together:
• Customer purchase order number + Trading partner (buyer)id
• Inbound 3A8 will have a flag, that indicates if the specific 3A8 is a response (to 3A7)
or is a new request. This flag separates the responses from the independent 3A8
that may occur for the same order for which 3A7 was generated.
• 3A9 is processed and results in the removal of the hold and cancellation (partial or
full) of the lines.
Integration With Supply Chain Trading Connector (CLN)

Supply Chain Trading Connector records the transaction history when the trading
partners exchange messages. Order Management incorporates the API calls during the
processing of the XML messages.
The following point within the transaction dialog is recorded in the CLN module:
• Change sales order message sent
• One or more buyer rejected lines are received in the 3A8 Change PO response to an
earlier 3A7 Change Sales Order message.
• 3A8 Change PO response to an earlier 3A7 Change Sales Order message is rejected
by the buyer at the header level.
Message Map
3A7 Message Map

The message map is created using Oracle XML Gateway's message designer.
Map Name - ONT_3A7_OAG72_OUT_SO
DTD Name - 087_change_salesorder_008.dtd (Change Sales Order)
Note: Most data values in the message map are seeded.

The following steps are carried out only for customizations.
1. java LoadMap DB username> DB password> Hostname>:Port>:SID> mymap.xgm>
ONT_3A7R_OAG72_OUT_SO.xgm
2. java DeleteMap DB username> DB password> Hostname>:Port>:SID> mapname>

ONT_3A7R_OAG72_OUT_SO.xgm
Source area under $ont/patch/115/map/ ONT_3A7R_OAG72_OUT_SO.xgm.

Transaction
The following is the seeded data for the 3A7 transaction:
• Transaction Type – ONT
• Transaction Sub Type – CSO
• External Transaction Type – SALESORDER

• External Transaction Sub Type – CHANGE
ONT_3A7_OAG72_OUT_SO
OAG Comment/Descrip OAG Reqd Y/N OM table/Column

tion
<CHANGE_SALES
ORDER_008>
<CNTROLAREA> Y
<BSR> Y
<VERB>CHANGE< Y
/VERB>
<NOUN>SALESOR Y
DER</NOUN>
<REVISION>008</R Y
EVISION>
</BSR> Y
<SENDER> Y
<LOGICALID>XGR XMLG Y
B1109</LOGICALI
D>
tion
<COMPONENT>S XMLG Y
ALES</COMPONE
NT>
<TASK>OM</TAS XMLG Y
K>
<REFERENCEID>9 XMLG Y
534223449</REFER
ENCEID>
<CONFIRMATION XMLG Y
>1</CONFIRMATI
ON>
<LANGUAGE>EN XMLG Y
G</LANGUAGE>
<CODEPAGE>CP0 XMLG Y
01001</CODEPAG
E>
<AUTHID>SMITHJ XMLG Y
</AUTHID>
</SENDER> Y
<DATETIME XMLG Y
qualifier="CREATI
ON">
<YEAR>1998</YEA Y
R>
<MONTH>11</MO Y
NTH>
<DAY>21</DAY> Y

tion
<HOUR>00</HOU Y
R>
<MINUTE>25</MI Y
NUTE>
<SECOND>45</SE Y
COND>
<SUBSECOND>000 Y
0</SUBSECOND>
<TIMEZONE>-0600 Y
</TIMEZONE>
</DATETIME> Y
</CNTROLAREA> Y
<DATAAREA> Y
<CHANGE_SALES Y
ORDER>
<SOHEADER> Y
<SALESORDID>S0 Sales order number Y Oe_Header_Acks.O

001</SALESORDID RDER_NUMBER
>
<SALESORG Sales Organization Y

index="1">ORG123 code
45</SALESORG>
<NOTES1>Invalid Accept or Reject? N "Accepted"

ID</NOTES1> (See notes)
<POID>1234</POID Customer PO Y Oe_Header_Acks.C

> number USTOMER_PO_N
UMBER
tion
<SOSTATUS>Open Sales Order Status N Oe_Header_Acks.F

</SOSTATUS> (see notes) IRST_ACK_CODE
<USERAREA> N
<PORELEASE>1 No map to OM
column
<REVISIONNUM> PO revision N
2</REVISIONNUM number. No map to
> OM column
<ORACLE.SUPPLI Suppliers reference N Oe_header_Acks.

ERDOCREF>123</ for the PO ORIG_SYS_DOCU
ORACLE.SUPPLIE MEN_REF
RDOCREF>
<ORACLE.OWNER IB Owner N OE_HEADERS_IN

>ORACLE.OWNER TERFACE.IB_OW
>End Customer NER
<ORACLE.CURRE IB Current Location N OE_HEADERS_IN

NTLOCATION>Shi TERFACE.CURRE
p To NT_LOCATION
Location</ORACLE
.CURRENTLOCAT
ION>
<ORACLE.INSTAL IB Installed At N OE_HEADERS_IN

LEDATLOCATIO Location TERFACE.IB_INST
N>Bill To ALLED_AT_LOCA
Location</ORACLE TION
.INSTALLEDATLO
CATION>
</USERAREA> N
<PARTNER> N

tion
<NAME Name of Sold To Y Derived from

index="1">ACME</ Trading Partner Oe_Header_Acks.S
NAME> OLD_TO_ORG_ID
<ONETIME>0</ON Y
ETIME>
<PARTNRID>YYY Unique ID for Sold Y Oe_Header_Acks.S

Y</PARTNRID> To Trading Partner OLD_TO_ORG_ID
<PARTNRTYPE>So Y
ldTo</PARTNRTY
PE>
<PARTNRIDX>XX EDI Location Code N Derived from

XX</PARTNRIDX> for Sold To Trading Oe_Header_Acks.S
Partner OLD_TO_ORG_ID

</PARTNER>
<PARTNER>
<NAME Name of supplier

index="1">ACME</
NAME>
<ONETIME>0</ON N
ETIME>
<PARTNRID>AC01 Unique id for the Y Oe_Header_Acks.S

234</PARTNRID> supplier HIP_FROM_ORG_I
D
<PARTNRIDX>AC Location code of N Ecx_Oag_ControlA

01234</PARTNRID the supplier rea_Tp_V.SOURCE
X> _TP_LOCATION_
CODE
tion
<PARTNRTYPE>S Y
UPPLIER</PARTN
RTYPE>
</PARTNER> Y
</SOHEADER> Y
<SOLINE> Y
<OPERAMT Unit price N Derived from

qualifier="UNIT" Oe_Line_Acks.UNI
type="T"> T_SELLING_PRICE
<VALUE>1</VALU N
E>
<NUMOFDEC>0</ N
NUMOFDEC>
<SIGN>+</SIGN> N
<CURRENCY>USD
</CURRENCY>
<UOMVALUE>1</
UOMVALUE>
<UOMNUMDEC>0 N
</UOMNUMDEC>
<UOM>EACH</UO Y
M>
</OPERAMT> Y
<QUANTITY Ordered quantity Y

qualifier="ORDERE
D">

tion
<VALUE>1</VALU Y
E>
<NUMOFDEC>0</ Y
NUMOFDEC>
<SIGN>+</SIGN> Y
<UOM>EACH</UO Y
M>
</QUANTITY> Y
<SOLINENUM>1</ Sales order line Oe_Line_Acks.LIN

SOLINENUM> number E_NUMBER
<NOTES1/> Accept or Reject? N "Accepted"

(See notes)
<POLINENUM>1</ Customer po line Y Oe_Line_Ack.CUS

POLINENUM> number TOMER_LINE_NU
MBER
<SOLNSTATUS>O Sales Order Line Y Oe_Line_Acks.FIRS

pen</SOLNSTATU status (see notes) T_ACK_CODE
S>
<ITEM>123456</IT Supplier Item Y

EM> number
<ITEMX>123456 TOMER_ITEM
<USERAREA>
<ORACLE.SUPPLI Suppliers reference N Oe_Line_Acks.ORI

ERLINEREF>1 for customer PO G_SYS_LINE_REF
line
</ORACLE.SUPPLI
ERLINEREF>
tion
</USERAREA>
<SOSCHEDULE> N
<DATETIME Scheduled arrival N Derived from

qualifier=" date Oe_Line_Acks.SCH
DELIVSCHED"> EDULE_ARRIVAL
_DATE
<YEAR>1998</YEA N
R>
<MONTH>11</MO N
NTH>
<DAY>21</DAY>
<HOUR>00</HOU
R>
<MINUTE>25</MI
NUTE>
<SECOND>45</SE
COND>
<SUBSECOND>000 Y
0</SUBSECOND>
<TIMEZONE>-0600 Y
</TIMEZONE>
</DATETIME>
<DATETIME Requested ship Y Derived from

qualifier=" date Oe_Line_Acks.REQ
NEEDDELV"> UEST_DATE
<YEAR>1998</YEA
R>

tion
<MONTH>11</MO N
NTH>
<DAY>21</DAY> Y
<HOUR>00</HOU Y
R>
<MINUTE>25</MI Y
NUTE>
<SECOND>45</SE Y
COND>
<SUBSECOND>000
0</SUBSECOND>
<TIMEZONE>-0600 Y
</TIMEZONE>
</DATETIME> N
<QUANTITY Scheduled quantity N Derived from

qualifier=" Oe_Line_Acks.OR
ORDERED"> DERED_QUANTIT
Y,
ORDER_QUANTIT
Y_UOM
<VALUE>1</VALU Y
E>
<NUMOFDEC>0</ Y
NUMOFDEC>
<SIGN>+</SIGN> Y
<UOM>EACH</UO Y
M>
tion
</QUANTITY>
<SOSLINENUM>1< Sales Order Y Oe_Line_Acks.SHI

/SOSLINENUM> shipment number PMENT_NUMBER
<PSCLINENUM>1< Customer schedule N Oe_Line_Acks.CUS

/PSCLINENUM> line number TOMER_SHIPMEN
T_NUMBER
<USERAREA>
<ORACLE.SUPPLI Suppliers reference N Oe_line_Acks.ORI

ERSHIPMENTREF for customer G_SYS_SHIPMENT
>1 shipment _REF
</ORACLE.SUPPLI
ERSHIPMENTREF
>
<ORACLE.SPLITLI Indication that this N Derived

NE>N</ORACLE.S line is split
PLITLINE>
<ORACLE.SPLITFR Split from line N Oe_line_Acks.SPLI

OMLINEREF>1 reference T_FROM_LINE_ID
<ORACLE.SPLITFR
OMLINEREF>
<DATETIME Schedule ship date N Derived from

qualifier=" Oe_Line_Acks.SCH
SHIPSCHED"> EDULE_SHIP_DA
TE
<YEAR>1998</YEA N
R>
<MONTH>11</MO N
NTH>
<DAY>21</DAY> N

tion
<HOUR>00</HOU N
R>
<MINUTE>25</MI N
NUTE>
<SECOND>45</SE N
COND>
<SUBSECOND>000 N
0</SUBSECOND>
<TIMEZONE>-0600 N
</TIMEZONE>
</DATETIME> N
</USERAREA>
</SOSCHEDULE>
</SOLINE>
</CHANGE_SALE
SORDER>
Statuses and Descriptions
Status Description
So Status Open- Any status other than the following

ones in Order Management.
Cancelled- Cancelled status in OM
So Line Status Open- Any status other than the following
ones in Order Management. On Hold – Line is
on 3A7 Change Notification Hold Cancelled-
Cancelled status in Order Management
NOTES (Header and Line level) The Notes can be used in case of 3A7 being
sent in order to change Pending status to
either Accept or Reject. In case of Reject it is
necessary to populate this element. Possible
values - Accepted

If the profile option OM: Run Order Import for XML is set to Synchronous, a
pre-defined workflow event is seeded to run Order Import if the Profile Option OM:
Process Transaction is set to ONLINE. This workflow subscribes to the event raised by
the Post Process of the XML Gateway. As part of the workflow process, it runs Order
Import for the current XML Message. After Run Order Import completes (Successfully
or With Error), the process that raises the business event is called.
Seeded Workflow
Message Details
This table describes the data types and fields in the DTD used by the message map. The
message map may remove used fields so that empty data tags are neither generated for
outbound transactions nor examined by inbound transactions.

Message Map Details
Message Map Details
Message Map Name: ONT_3A7_OAG72_OUT_SO
Direction: OUT
(Internal) Transaction Subtype: CSO
External Transaction Type: SALESORDER
External Transaction Subtype: CHANGE
DTD Directory: ont/xml/oag72
Message Maps XGM File Name: ONT_3A7_OAG72_OUT_SO.xgm
Standard: OAG
Release: 7.2
Format: DTD
DTD Name: 087_change_salesorder_008.dtd

The same event/subscription/workflow that was developed for Show sales order is
reused for Change Sales Order.
Detail Value
Event Name oracle.apps.ont.oi.show_so.create
Detail Value
Event Description Event for 3A6 Outbound Show sales order
Subscription R_SHOW_SALES_ORDER
Subscription Description Event subscription for the

oracle.apps.ont.oi.show_so.create event for
Outbound Show sales order.
Workflow (oexwfoa.wft)
See figure. Process R_SHOW_SALES_ORDER
Lookups
Lookups
Lookup Type Code Meaning Enabled
HOLD_TYPE CHANGE_NOTIFIC Change Notification No

ATION_HOLD Hold for 3A7
RELEASE_REASON 3A7_RESPONSE_RE Response to 3A7 is No

CEIVED received. Hold
released
automatically.

3A7 Hold
Hold Name Hold Type Description Hold ID
3A7 Change CHANGE_NOTIFIC Line level hold - 56

Notification Hold ATION_HOLD Waiting for a
response on 3A7
Inbound Change PO Request
Overview
The Inbound Change PO Request enables a buyer to change a purchase order and the
seller to acknowledge if the changes are accepted, rejected, or pending. Depending on
the response, the trading partner can do the following:
• Change purchase orders
• Acknowledge whether the buyer accepts the changes made by the seller
Major Features
Consume the Change_PO Message Inbound From Purchasing

Oracle Order Management consumes the Change_PO message inbound from
Purchasing, thereby updating the purchase order previously entered.
Changes to the purchase order follow the same rules for changing a purchase order that
currently exist in Order Management.
Scenario 1: Redistribution of the quantity over shipments (Oracle Purchasing)
Original PO
Redistribution - Before
Line Shipment Qty
1 1 5
1 2 5
Line Shipment Qty
1 3 5
If the quantity of the 3 shipments in above example is redistributed over 2 shipments

Change PO looks as follows:
Redistribution - Two Shipments
Line Shipment Qty
1 1 7
1 2 8
1 3 0
Scenario 2: Cancellation of a shipment (Oracle Purchasing)

Cancellation of one of the shipments can cause a Change PO to start (Oracle
Purchasing).
Original PO
Cancellation of a Shipment
Line Shipment Qty
1 1 6
1 2 5
1 3 5
If Shipment 3 is cancelled Change PO would look as follows:

After Cancellation
Line Shipment Qty
1 3 0
Changes supported
Change PO supports change in the following elements:
• Bill to location
• Ship to location (Schedule level)
• Quantity (schedule level)
• Need by date (Schedule level)
• Price
• Payment terms
Set up the Order Import Process to be Run in Synchronous or Asynchronous Mode

You can setup a profile option to start Order Import for every order or wait and process
multiple orders via concurrent processing. The Profile Option is called OM: Run Order
Import for XML, and can be set up at the site level. The possible values for this profile
option are Asynchronous and Synchronous.
Integration With Supply Chain Trading Connector (CLN)

The Supply Chain Trading Connector module records the transaction history when the
trading partners exchange messages. To enable this Order Management has
incorporated the API calls during the processing of the XML messages. In the case of
3A8 Change PO request message collaboration history is recorded at the key points in
processing Change PO.
• When Change PO comes in and is consumed by Order Management by entering the
data into Order Import tables (and before running the Order Import Process)
• Before running Order Import (if Order Import is going to be run immediately)
OR
• If Order Import is not going to be run and is going to be run in batch mode later on
• Order Import completed successfully /Failed
Support For Split Lines
Order Management supports splitting of lines for multiple reasons. When the line is
split, new shipment information is created for the line and stored in Order
Management. In this case the 3A7 is sent to the buyer notifying of this change. Upon
receiving the information about the new line buyer's system sends the
acknowledgement either accepting or rejecting this new line. If the new line is accepted
by the buyer, the buyer sends the 3A8 (change PO) as a response with the new buyer
information as well as the reference for the new line sent by the seller.
If the line is rejected by the buyer, 3A8 can be sent by the buyer to cancel the split or
original line.
Error Handling
The error handling process deals with three possible types of outcomes that occur after
the order import process is run:
• Successful processing - In this case the confirmation API is called to send the
Acknowledgment out to the sender with the Accept status.
• Failed processing - This is the status when there are validation errors or data setup
errors. In this case the confirmation API is called to send the acknowledgment out
to the sender with the Reject Status.
• Unexpected Errors - There can be some unexpected errors due to resource

constraints and will require reprocessing of the Order Import upon fixing those
issues. This process is manual.

Message Map
OAG Comment/Desc Reqd Y/N Oracle OM Oracle PO

Table/Colu Table
mn /Column
<CHANGE_PO_006>
<CNTROLAREA>
<BSR> Y
<VERB value=" Y
CHANGE">CHANGE
</VERB>
<NOUN value="PO"> Y
PO</NOUN>
<REVISION value=" Y
006">006</REVISION>
</BSR> Y
Table/Colu Table
mn /Column
<SENDER> Y
<LOGICALID> Y
XX141HG09
</LOGICALID>
<COMPONENT>PUR Y
</COMPONENT>
<TASK>MAINT Y
</TASK>
<REFERENCEID> Y
95129945823449
</REFERENCEID>
<CONFIRMATION>1 Y
</CONFIRMATION>
<LANGUAGE>ENG Y
</LANGUAGE>
<CODEPAGE>test Y
</CODEPAGE>
<AUTHID>CMKURT< Y
/AUTHID>
</SENDER>
<DATETIME Timestamp for PO Y

qualifier="CREATION (Standard or Release)
"> creation
<YEAR>1998</YEAR> Y
<MONTH>11 Y
</MONTH>
<DAY>20</DAY> Y

Table/Colu Table
mn /Column
<HOUR>17</HOUR> Y
<MINUTE>06 Y
</MINUTE>
<SECOND>45 Y
</SECOND>
<SUBSECOND>0000 Y
</SUBSECOND>
<TIMEZONE>-0 Y
600</TIMEZONE>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<CHANGE_PO>
<POHEADER>
<POID>a</POID> Unique ID for the Y OE_HEADE PO_ECX_HE

PO.For Standard RS_INTERF ADER_ARCH
ACE.Cust_p _
POs, the PO number o_number
from Oracle V.contractb
PHA.SEGME
Purchasing is entered NT1
here. For Sales
Agreement
Releases, it should be
Sales Agreement
PO#-Release#.
< N
NOTES>Notes</NOTE
S>
Table/Colu Table
mn /Column
< Reason for the change N OE_HEADE

REASONCODE>Admi RS_INTERF
n ACE.change
Error</REASONCODE _reason
>
<USERAREA>
<ORGID> Org Id OE_HEADE

RS_INTERF
ACE.org_id
<ORACLE.CHANGES Change Sequence OE_HEADE

EQUENCE>12 RS_INTERF
ACE.change
</ORACLE.CHANGES _sequence
EQUENCE>
<ORACLE.BOOKEDF Booked Flag OE_HEADE

LAG>Y RS_INTERF
ACE.booked
</ORACLE.BOOKEDF _flag
LAG>
<MSGTYPE>Response Response Flag OE_HEADE

</MSGTYPE> RS_INTERF
ACE.respons
e_flag
<ACKCODE> A value of 2 for a 3A8

Change PO response
document implies a
header level buyer
rejection and will result
in the entire document
not being processed.

Table/Colu Table
mn /Column
<ORACLE.SUPPLIER Suppliers reference for N OE_HEADE

DOCREF>122 the Customer PO. RS_INTERF
Needs to be sent back ACE.ORIG_
</ORACLE.SUPPLIER by the buyer as a SYS_DOCU
DOCREF> reference for the newly MENT_REF
created line on 3A8
response as well as 3A9.
Also needed to be sent
on every new change
request for the new line.
</USERAREA>
<PARTNER> Supplier Y
This data type provides

information
about the trading

partner.
No need to map this

segment for OM
<NAME1>abcd</NAM Name of the trading PO_ECX_HE

E1> partner ADER_ARCH
_V.supp_org_
name
PO_VENDOR
S.VENDOR_N
AME
<ONETIME>a Indicator of whether Y PO_ECX_HE

</ONETIME> this partner is ADER_ARCH
Established for this _V.supp_otf
transaction only. DECODE
(PO_VENDO
RS.ONE_
TIME_FLAG,'
N','0','1')
Table/Colu Table
mn /Column
<PARTNRID>a Unique identifier for Y PO_ECX_HE

</PARTNRID> the partner in Oracle ADER_ARCH
Applications (Supplier _V.supplier_p
Number). artner_id
PO_VENDOR
S.SEGMENT1
<PARTNRTYPE> Y
Supplier
</PARTNRTYPE>
<CURRENCY>a</CUR Preferred operating PO_ECX_HE

RENCY> currency of the ADER_ARCH
_V.supp_Curr
partner. ency
PO_VENDOR
S.PAYMENT_
CURRENCY_
CODE
<PARTNRIDX>a Unique identifier of the Y PO_ECX_HE

</PARTNRIDX> partner Supplier. ADER_ARCH
_
V.supplier_pa
rtner_id_x
NVL(PO_VE
NDOR_SITES
_ALL_ECE_T
P_LOCATIN_
CODE,PHA.V
ENDOR_ID
<ADDRESS> Address of the partner
<ADDRLINE index="1
">a</ADDRLINE>
<CITY>a</CITY>

Table/Colu Table
mn /Column
<COUNTRY>a
</COUNTRY>
<DESCRIPTN>a
</DESCRIPTN>
<FAX index="1">a
</FAX>
<POSTALCODE>a
</POSTALCODE>
<STATEPROVN>a
</STATEPROVN>
<TELEPHONE index="
1">a</TELEPHONE>
</ADDRESS>
</PARTNER>
<PARTNER> Sold To Y
This data type provides

information
about the trading

partner
<NAME1>abcd</NAM Name of the buyer PO_ECX_HE

E1> company ADER_ARCH
_V.buying_or
g_name
HR_ALL_OR
GANIZATIO
N_UNITS_TL
.NAME
Table/Colu Table
mn /Column
<ONETIME>a Indicator of whether PO_ECX_HE

</ONETIME> this partner is ADER_ARCH
_V.buying_
Established for this
transaction only. org_otf '0
<PARTNRID>a Unique identifier for

</PARTNRID> the partner in Oracle
Applications (Supplier
Number).
<PARTNRTYPE>Sold Sold To
To</PARTNRTYPE>
<CURRENCY>a</CUR Preferred operating PO_ECX_HE

RENCY> currency of the partner. ADER_ARCH
_V.buying_or
g_currency
GL_SETS_OF_
BOOKS.CURR
ENCY_
CODE
<PARTNRIDX>a Unique identifier of the OE_HEADE PO_ECX_HE

</PARTNRIDX> partner. RS_INTERF ADER_ARCH
ACE.sold_to _V.partner_id
_org_id _x
HR_LOCATI
ONS_ALL.EC
E_TP_LOCAT
ION_CODE
<TAXID>a</TAXID> Tax identifier
<ADDRESS> Address of the partner.

This information needs
to be mapped for the
case where EDI location
code is not sent.

Table/Colu Table
mn /Column
<ADDRLINE index="1 HR_ORGANI

">a</ADDRLINE> ZATION_UNI
TS_
V.ADDRESS_
LINE_1-3
<CITY>a</CITY> HR_ORGANI
ZATION_UNI
TS_
V.TOWN_OR
_CI T Y
<COUNTRY>a PO_ECX_HE
</COUNTRY> ADER_ARCH
_V.buying_
org_country
<COUNTY>a OE_HEADER
</COUNTY> S_INTERFAC
E.INVOICE_C
OUNTY
<POSTALCODE>a HR_ORGANI
</POSTALCODE> ZATION_UNI
TS_
V.POS TAL
_CODE
<STATEPROVN>a HR_ORGANI
</STATEPROVN> ZATION_UNI
TS_
V.RE GI ON2
<TELEPHONE index=" HR_ORGANI

1">a</TELEPHONE> ZATION_UNI
TS_
V.TELEPHON
E_NUMBER_
1-3
Table/Colu Table
mn /Column
</ADDRESS>
</PARTNER>
<PARTNER> Bill to partner- This is

an optional segment
<NAME1>abcd</NAM Name of the bill to PO_ECX_HE

E1> partner ADER_ARCH
_V.buying_or
g_name
HR_ALL_OR
GANIZATIO
N_UNITS_TL
.NAME
<ONETIME>a PO_ECX_HE
</ONETIME> ADER_ARCH
_V.billto_
org_otf '0
<PARTNRID>a PO_ECX_HE
</PARTNRID> ADER_ARCH
_V.partner_id
PHA.ORG_ID
<PARTNRTYPE>Bill
to</PARTNRTYPE>
<CURRENCY>a</CUR FINANCIALS
RENCY> _SYSTEM_PA
RAMS_
ALL.PAYME
NT_CURREN
CY_CODE

Table/Colu Table
mn /Column
<PARTNRIDX>a OE_HEADE HR_LOCATI

</PARTNRIDX> RS_INTERF ONS_ALL.EC
ACE.invoice E_TP_
_to_org_id
LOCATION_
CODE
<ADDRESS> The address

information needs to be
mapped for the case
where EDI Location
code is not sent.
<ADDRLINE index="1 OE_HEADE HR_LOCATI

">a</ADDRLINE> RS_INTERF ONS_ALL.AD
ACE.INVOI DRESS_
CE_ADDRE
SS1-3 LINE_1-3
<CITY>a</CITY> OE_HEADE HR_LOCATI

RS_INTERF ONS_ALL.TO
ACE.INVOI WN_OR_
CE_CITY
CITY
<COUNTRY>a OE_HEADE HR_LOCATI

</COUNTRY> RS_INTERF ONS_ALL.CO
ACE.INVOI UNTRY
CE_COUNT
RY
<COUNTY>a OE_HEADER
</COUNTY> S_INTERFAC
E.SHIP_TO_C
OUNTY
<POSTALCODE>a OE_HEADE HR_LOCATI

</POSTALCODE> RS_INTERF ONS_ALL.PO
ACE.INVOI STAL_CODE
CE_POSTAL
_CODE
Table/Colu Table
mn /Column
<STATEPROVN>a OE_HEADE HR_LOCATI

</STATEPROVN> RS_INTERF ONS_ALL.RE
ACE.INVOI GION_2
CE_STATE
<TELEPHONE index=" HR_LOCATI

1">a</TELEPHONE> ONS_ALL.TE
LEPHONE_
NUMBER_1-3
</ADDRESS>
</PARTNER>
<PARTNER> Ship to partner- This is

an optional segment
<NAME1>abcd</NAM Name of the Ship to

E1> partner
<ONETIME>a
</ONETIME>
<PARTNRID>a
</PARTNRID>
<PARTNRTYPE>Ship
To</PARTNRTYPE>
<CURRENCY>a</CUR
RENCY>
<PARTNRIDX>a OE_HEADE
</PARTNRIDX> RS_INTERF
ACE.ship_to
_org_id

Table/Colu Table
mn /Column

mapped for the case
where EDI Location
code is not sent.
<ADDRLINE index="1 OE_HEADE

">a</ADDRLINE> RS_INTERF
ACE.SHIP_T
O_ADDRES
S1-3
<CITY>a</CITY> OE_HEADE
RS_INTERF
ACE.SHIP_T
O_CITY
<COUNTRY>a OE_HEADE
</COUNTRY> RS_INTERF
ACE.SHIP_T
O_COUNTR
Y
<POSTALCODE>a OE_HEADE
</POSTALCODE> RS_INTERF
ACE.SHIP_T
O_POSTAL_
CODE
<STATEPROVN>a OE_HEADE
</STATEPROVN> RS_INTERF
ACE.SHIP_T
O_STATE
<TELEPHONE index="
1">a</TELEPHONE>
</ADDRESS>
<Partner> End Customer - This is

an optional segment
Table/Colu Table
mn /Column
<NAME1>abcdNAME Name of the End OE_HEADE

1>abcd> Customer RS_INTERF
ACE.END_C
USTOMER_
NAME
<ONETIME>aONETI
ME>a>
<PARTNRID>aPARTN OE_HEADE
RID>a> RS_INTERF
ACE.END_C
USTOMER_
NUMBER
<PARTNRTYPE>EndP
ARTNRTYPE>End>
<CURRENCY>aCURR
ENCY>a>
<PARTNRIDX>aPART
NRIDX>a>
<ADDRESS>
<ADDRLINE OE_HEADE
index="1">aADDRLIN RS_INTERF
E index="1">a> ACE.END_C
USTOMER_
ADDRESS1-
4
<CITY>a</CITY> OE_HEADE
RS_INTERF
ACE.
END_CUST
OMER
_CITY

Table/Colu Table
mn /Column
<COUNTRY>a</COU OE_HEADE
NTRY> RS_INTERF
ACE.
END_CUST
OMER_COU
NTRY
<COUNTY>a</COUN OE_HEADE
TY> RS_INTERF
ACE.
END_CUST
OMER_COU
NTY
<POSTALCODE>a RS_INTERF
ACE.
END_CUST
OMER_POS
TAL_CODE
<STATEPROVN>a</ST OE_HEADE
ATEPROVN> RS_INTERF
ACE.
END_CUST
OMER
STATE
<TELEPHONE
index="1">a</TELEPH
ONE>
</ADDRESS>
<CONTACT>
<NAME> OE_HEADE
RS_INTERF
ACE.END_C
USTOMER_
CONTACT
Table/Colu Table
mn /Column
</CONTACT>
</PARTNER>
<POTERM> Payment term

information
<DESCRIPTN>a</DES Description of payment PO_ECX_HE

CRIPTN> terms. ADER_ARCH
_V.paymet_te
rms_descripti
on
AP_TERMS.D
ESCRIPTIN
<TERMID>Immediate Identifier for payment OE_HEADE PO_ECX_HE

</TERMID> terms. RS_INTERF ADER_ARCH
ACE. _V.payme
payment_ter t_terms_name
m AP_TERMS.N
AME
<DAYSNUM>a No mapping
</DAYSNUM> provided by
PO although
genrated XML
has these
elements.
</POTERM>
</POHEADER>
<POLINE> This data type provides

details of a POline.At
least one PO line data
type is required.This
data type will occur one
or more times.

Table/Colu Table
mn /Column
<OPERAMT Unit price of the item OE_LINES_I

qualifier="UNIT" NTERFACE.
type="T"> customer_ite
m_net_price
<VALUE>a</VALUE> Monetary unit amount PO_ECX_LIN

of the PO line. E_ARCH_V.p
rice
PO_LINES_A
RCHIVE_ALL
.UNIT_PRICE
<NUMOFDEC>a
</NUMOFDEC>
<SIGN>a</SIGN>
<CURRENCY>a Three-character ISO PO_ECX_HE

</CURRENCY> currency code. ADER_ARCH
_V.po_currenc
y
PHA.CURRE
NCY_CODE
<UOMVALUE>a</UO
MVALUE>
<UOMNUMDEC>a
</UOMNUMDEC>
<UOM>a</UOM>
</OPERAMT>
<QUANTITY Quantity of the item

qualifier="ORDERED ordered. This will be
"> the new qty if there is a
change in the qty on
schedule level.
Table/Colu Table
mn /Column
<VALUE>a</VALUE> Numeric Value of the PO_ECX_LIN

qty E_ARCH_V.q
uantity
PO_LINES_A
RCHIVE_
ALL.QUANTI
TY
<NUMOFDEC>a
</NUMOFDEC>
<SIGN>a</SIGN>
<UOM>a</UOM>
</QUANTITY>
<REASONCODE>abc< Reason Code. PO does N

/REASONCODE> not use this tag. If blank
this should be defaulted
as 'No Reason
Provided'
<POLINENUM>a Po Line number Y OE_LINES_I PO_ECX_LIN

</POLINENUM> NTERFACE. E_ARCH_V.li
customer_lin ne_num
e_number
PO_LINES_A
RCHIVE_ALL
.LINE_NUM
<DESCRIPTN>a Item Description. No PO_ECX_LIN

</DESCRIPTN> need to map for OM. E_ARCH_V.d
escription
PO_LINES_A
RCHIVE_ALL
.ITEM_DESC
RIPTION

Table/Colu Table
mn /Column
<ITEMRV>a Customer item revision PO_ECX_LIN

</ITEMRV> E_ARCH_V.it
emrv
PO_LINES_A
RCHIVE_ALL
.ITEM_REVISI
ON
<ITEMRVX>a</ITEMR Not used

VX>
<ITEM>a</ITEM> Identifier of the OE_LINES_I PO_ECX_LIN

product. This is the NTERFACE. E_ARCH_V.it
customer item number customer_ite em
m_name
MTL_SYSTE
M_ITEMS_B_
KFV.SEGME
NT1
<ITEMX>a</ITEMX> Supplier item number. PO_ECX_LIN

This is the item number E_ARCH_V.it
in OM emx
PO_LINES_A
RCHIVE_
ALL.VENDO
R_PRODUCT
_NUM
<ITEMTYPE>a
</ITEMTYPE>
<NOTES index="1">a Notes to supplier. OE_LINES_I PO_ECX_LIN

</NOTES> NTERFACE. E_ARCH_V.n
change_com ote_to_vendor
ments
PO_LINES_A
RCHIVE_ALL
.NOTE_TO_V
ENDOR
Table/Colu Table
mn /Column
<USERAREA>

Change PO response
document implies a line
level buyer rejection
and will result in that
line not being
processed.
<ORACLE.SUPPLIER_ Suppliers reference for N OE_LINES_I

LINE_REF>1 the Customer PO Line. NTERFACE.
Needs to be sent back orig_sys_lin
</ORACLE.SUPPLIER by the buyer as a e_ref
_LINE_REF> reference for the newly
created line on 3A8
response as well as 3A9.
Also needed to be sent
on every new change
request for the new line.
</USERAREA>
<SCHEDULE>
<USERAREA>
<PARTNER> Bill to partner- This is

an optional segment
<NAME1>abcd</NAM Name of the bill to

E1> partner
<ONETIME>a
</ONETIME>
<PARTNRID>a
</PARTNRID>
<PARTNRTYPE>Bill
to</PARTNRTYPE>

Table/Colu Table
mn /Column
<CURRENCY>a</CUR
RENCY>
<PARTNRIDX>a OE_LINES_I
</PARTNRIDX> NTERFACE.
invoice_to_o
rg_id

mapped for the case
where EDI Location
code is not sent.
<ADDRLINE index="1 OE_LINES_I

">a</ADDRLINE> NTERFACE.
INVOICE_T
O_ADDRES
S1-3
<CITY>a</CITY> OE_LINES_I
NTERFACE.
INVOICE_T
O_CITY
<COUNTRY>a OE_LINES_I
</COUNTRY> NTERFACE.
INVOICE_T
O_COUNTR
Y
<COUNTY>a OE_LINES_I
</COUNTY> NTERFACE.
INVOICE_T
O_COUNTY
<POSTALCODE>a OE_LINES_I
</POSTALCODE> NTERFACE.
INVOICE_T
O_POSTAL_
CODE
Table/Colu Table
mn /Column
<STATEPROVN>a OE_LINES_I
</STATEPROVN> NTERFACE.
INVOICE_T
O_STATE
<TELEPHONE index="
1">a</TELEPHONE>
</ADDRESS>
<PARTNER> Ship to partner
<NAME1>abcd</NAM Name of the Ship to PO_ECX_LIN

E1> partner E_LOC_ARC
H_V.Shipto_o
rg_name
HR__ORGAN
IZATION_UN
ITS_V .NAME
<ONETIME>a
</ONETIME>
<PARTNRID>a PO_ECX_LIN
</PARTNRID> E_LOC_ARC
H_V.partner_i
d
PO_LINE_LO
CATIONS_A
RCHIVE_ALL
.ORG_ID
<PARTNRTYPE>Ship Value ShipTo PO_ECX_LIN

to</PARTNRTYPE> E_LOC_ARC
H_V.shipto_o
rg_partner_ty
pe 'ShipTo'
<CURRENCY>a</CUR
RENCY>

Table/Colu Table
mn /Column
<PARTNRIDX>a EDI Location code OE_HEADE HR_LOCATI

</PARTNRIDX> RS_INTERF ONS_ALL.EC
ACE.ship_to E_TP_LOCAT
_org_id ION_CODE
<ADDRESS>
<ADDRLINE index="1 Address of the ship to OE_HEADE HR_LOCATI

">a</ADDRLINE> RS_INTERF ONS_ALL.AD
ACE.SHIP_T DRESS_LINE_
O_ADDRES 1,2,3
S1-3
<CITY>a</CITY> City OE_HEADE HR_LOCATI

RS_INTERF ONS_ALL.TO
ACE.SHIP_T WN_OR_CIT
O_CITY Y
<COUNTRY>a Country OE_HEADE HR_LOCATI

</COUNTRY> RS_INTERF ONS_ALL.CO
ACE.SHIP_T UNTRY
O_COUNTR
Y
<COUNTY>a OE_LINES_I
</COUNTY> NTERFACE.
SHIP_TO_C
OUNTY
<POSTALCODE>a Postal Code OE_HEADE HR_LOCATI

</POSTALCODE> RS_INTERF ONS_ALL.PO
ACE.SHIP_T STAL_CODE
O_POSTAL_
CODE
<STATEPROVN>a State OE_HEADE HR_LOCATI

</STATEPROVN> RS_INTERF ONS_ALL.RE
ACE.SHIP_T GION_2
O_STATE
Table/Colu Table
mn /Column
<TELEPHONE index=" Telephone HR_LOCATI

1">a</TELEPHONE> ONS_ALL.TE
LEPHONE_N
UMBER 1,2,3
</ADDRESS>
</PARTNER>
<OPERATION> Operation Code OE_LINES_I

NTERFACE.
operation_co
de

Change PO Response
document implies a line
level buyer rejection
and will result in that
line not being
processed.
<ORACLE.SUPPLIER_ Supplier's reference for N OE_LINES_I

SHIPMENT_REF>1 the customer PO NTERFACE.
shipment line. Needs to orig_sys_shi
</ORACLE.SUPPLIER be sent back by the pment_ref
_SHIPMENT_REF> buyer as a reference for
the newly created line
on 3A8 response as well
as 3A9. Also needed to
be sent on every new
change request for the
new line.
</USERAREA>

Table/Colu Table
mn /Column
<DATETIME Need by Delivery date. OE_LINES_I PO_ECX_LIN

qualifier=" This will be the new NTERFACE. E_LOC_ARC
NEEDDELV"> date if there are any request_date H_V.need_by
changes. _date
PO_LINE_LO
CATIONS_A
RCHIVE_ALL
.NEED_BY_D
ATE
<YEAR>1998</YEAR>
<MONTH>11
</MONTH>
<DAY>01</DAY>
<HOUR>00</HOUR>
<MINUTE>00</MINU
TE>
<SECOND>00</SECO
ND>
<SUBSECOND>0000
</SUBSECOND>
<TIMEZONE>-0600
</TIMEZONE>
</DATETIME>
Table/Colu Table
mn /Column
<QUANTITY Quantity of the item OE_LINES_I PO_ECX_LIN

qualifier="ORDERED ordered. This will be NTERFACE. E_LOC_ARC
"> the new qty. ordered_qua H_V.ordered_
ntity quantity
OE_LINES_I (PO_LINE_LO
NTERFACE. CATIONS_A
order_quanti RCHIVE_ALL
ty_uom .QUANTITY
-PO_LINE_LO
CATIONS_A
RCHIVE_ALL
.QUANTITY_
CANCELLED
)
<VALUE>a</VALUE>
<NUMOFDEC>a
</NUMOFDEC>
<SIGN>a</SIGN>
<UOM>a</UOM>
</QUANTITY>
<PSCLINENUM>a Line number of the Y OE_LINES_I PO_ECX_LIN

</PSCLINENUM> delivery schedule for NTERFACE. E_LOC_ARC
the PO. customer_sh H_V.shipment
ipment_num _um
ber
PO_LINE_LO
CATIONS_A
RCHIVE_ALL
.SHIPMENT_
NUM
<DESCRIPTN>

Table/Colu Table
mn /Column
<REASONCODE> Reason for cancellation OE_LINES_I

NTERFACE.
change_reas
on
</SCHEDULE>
</POLINE>
</CHANGE_PO>
</DATAAREA>
</CHANGE_PO_006>
Note: Note: When the columns customer_item_net_price and

customer_payment_term have values, the system calculates a different
value, and you will get a warning. You can also see those column's
values in the Sales Orders form.
Seeded Workflow for Inbound XML Messages

Option OM: Run Order Import for XML is set to 'Synchronous. This Workflow
workflow, Order Import is run for the XML message, that is currently being consumed.
The following Workflow is designed using Workflow Builder 2.6

Message Details
This table describes the data types and fields in the DTD used by the message map. The
message map may remove used fields so that empty data tags are neither generated for
outbound transactions nor examined by inbound transactions.
Message Map Name: ONT_3A8R_OAG72_IN.xgm
Direction: Inbound
(Internal) Transaction Subtype: CHO
External Transaction Subtype: CHANGE
DTD Directory: $ont/xml/oag72
Map Directory: $ont/patch/115/xml/US
Message Maps XGM File Name: ONT_3A8R_OAG72_IN
Standard: OAG
Release: 7.2
Format: DTD
DTD Name: 057_change_po_006.dtd
Tag Category
<TERMID> (in header level <POTERM> PAYMENT_TERMS
<MSGTYPE> (in header level <USERAREA>) DOC_PURPOSE_CODE
<UOM> (in schedule level <QUANTITY UOM

qualifier="ORDERED>)
<OPERATION> (in schedule level ACTION_CODE

USERAREA)

Defaulted Columns
Defaulted Columns Default Value, and Condition (if any)
H.XML_TRANSACTION_TYPE_CODE 'CHO'
H.CHANGE_REASON 'Not provided'
L.XML_TRANSACTION_TYPE_CODE 'CHO'
L.CHANGE_REASON 'Not provided'
Derived Columns
Derived Columns Source of Data, and Condition (if any)
H.CREATED_BY FND_GLOBAL.USER_ID
H.INVOICE_TO_ORG_ID PARTNRIDX of BillTo PARTNER
H.LAST_UPDATE_LOGIN FND_GLOBAL.USER_ID

value is not null
H.SHIP_TO_ORG_ID PARTNRIDX of ShipTo PARTNER
L.CALCULATE_PRICE_FLAG 'Y' if L.CUSTOMER_ITEM_NET_PRICE is

NOT NULL
L.CHANGE_SEQUENCE H.CHANGE_SEQUENCE
L.INVOICE_TO_ORG_ID PARTNRIDX of BillTo PARTNER
L.LAST_UPDATE_LOGIN FND_GLOBAL.LOGIN_ID

L.OPERATION_CODE Derived based on stored procedure if

<OPERATION> tag at schedule level is NULL
L.REQUEST_DATE OAG Derivation from schedule level

<DATETIME qualifier="NEEDDELV"> tag
L.SHIP_TO_ORG_ID PARTNRIDX of ShipTo PARTNER
Detail Value
Event Description OM Generic Inbound Event

Detail Value

raised by the post process of the Change PO
XML mapping
Extension Tags
Order Management added the following tags as extensions on the Process PO XML
documents sent to OM:
<!ELEMENT FTTERM (DESCRIPTN?, TERMID?)>
<!ELEMENT FOB (DESCRIPTN?, TERMID?)>
<!ELEMENT OPERATION %STRDOM;>
<!ELEMENT ORGID %STRDOM;>
<!ELEMENT USERITEMDESCRIPTN %STRDOM;>
<!ELEMENT ORACLE.CHANGESEQUENCE %STRDOM;>
<!ELEMENT ORACLE.BOOKEDFLAG %STRDOM;>
<!ELEMENT ORACLE.SUPPLIERDOCREF %STRDOM;>
<!ELEMENT ORACLE.SUPPLIERLINEREF %STRDOM;>
<!ELEMENT ORACLE.SUPPLIERSHIPMENTREF %STRDOM;>
<!ELEMENT ORACLE.SPLITFROMLINEREF %STRDOM;>
<!ELEMENT ORACLE.SPLITLINE %STRDOM;>
$ont/xml/oag72/oagis_entity_extensions.dtd
Added the following tags:
EXCHRATEDATE">
Added the following tags:
<!ELEMENT PCARDHDR
(MEMBERNAME?,PCARDNUM?,(%DATETIME.EXPIRATION;)?,PCARDBRAND?)><!
ELEMENT MEMBERNAME %STRDOM;>
(REQUESTOR?,DISTNUM?,PROJECTNUM?,PROJECTTYPE?,TASKNUM?,(%QUANTI
TY.ORDERED;)?,CONVRATE,(%DATETIME.EXCHRATEDATE;)?,DESTTYPE?,DFFDI
STRIBUTN?)>

<!ELEMENT
DFFPOHEADER(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRIB
UTE5?,ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?,ATTRIBUTE10?,A
TTRIBUTE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,ATTRI
BUTE16?)><!ELEMENT
DFFVENDORSITE(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRI
BUTE5?,ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?,ATTRIBUTE10?,
ATTRIBUTE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,ATT
RIBUTE16?)>
<!ELEMENT
DFFVENDOR(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRIBUT
E5?,ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?,ATTRIBUTE10?,ATT
RIBUTE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,ATTRIBU
TE16?)>
<!ELEMENT
DFFLINE(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRIBUTE5?,
ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?,ATTRIBUTE10?,ATTRIBU
TE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,ATTRIBUTE16
?)>
<!ELEMENT
DFFITEM(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRIBUTE5?,
TE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,A
TTRIBUTE16?)>
<!ELEMENT
KFFITEM(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRIBUTE5?,
TE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATTRIBUTE15?,ATTRIBUTE16
?,ATTRIBUTE17?,ATTRIBUTE18?,ATTRIBUTE19?,ATTRIBUTE20?)>
<!ELEMENT
DFFDISTRIBUTN(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,ATTRI
BUTE5?,ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?
,ATTRIBUTE10?,ATTRIBUTE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,ATT
RIBUTE15?,ATTRIBUTE16?)>
<!ELEMENT DROPSHIPDETAILS (DROPSHIPMENT?, DROPSHIPCUSTNAME?,
SHIPINSTR?, PACKINSTR?, SHIPMETHOD?, CUSTOMERPONUM?,
CUSTOMERLINENUM?, CUSTOMERSHIPNUM?, CUSTOMERDESC?)>
<!ELEMENT DROPSHIPMENT %STRDOM;>
<!ELEMENT DROPSHIPCUSTNAME %STRDOM;>
<!ELEMENT SHIPINSTR %STRDOM;>
<!ELEMENT PACKINSTR %STRDOM;>
<!ELEMENT SHIPMETHOD %STRDOM;>
<!ELEMENT CUSTOMERPONUM %STRDOM;>
<!ELEMENT CUSTOMERLINENUM %STRDOM;>
<!ELEMENT CUSTOMERSHIPNUM %STRDOM;>

<!ELEMENT CUSTOMERDESC %STRDOM;>
<!ELEMENT SHIPPINGCONTROL %STRDOM;>
<!ELEMENT CONTRACTNUM %STRDOM;>
<!ELEMENT CONFIGID %STRDOM;>
<!ELEMENT PSCLNSTATUS %STRDOM;>
Cancel Purchase Order
Overview
The Cancel Purchase Order message is used by the buyer to cancel a purchase order
that was previously created by the buyer. This is an inbound message from buyer to the
seller. Cancellation of the individual lines is allowed using this message. Cancellation of
the PO follows same rules for canceling a purchase order that currently exist in Order
Management. Partial cancellations of the line is allowed.
An Acknowledgement is sent to the buyer when the Cancel_PO message is consumed
by Order Management. Either an Accept or Reject status for the Cancel_PO request by
the buyer will be sent. The Acknowledge PO message is used for the acknowledgement
for the inbound Cancel_PO message.
Major Features
Consume the Cancel_PO Message Coming Inbound From Purchasing
Oracle Order Management consumes the Cancel_PO message inbound from
Purchasing, thereby canceling the Purchase order previously entered. The whole
purchase order is cancelled due to this inbound message. Cancellation of the individual
lines is allowed.
Cancellation of the PO should follow same rules for canceling a purchase order that
currently exist in Order Management. Partial cancellations of the line are allowed.
For example – If the order Qty is 10 on the original order and Cancel_PO comes in with
the order Qty of 6. After processing the transaction, the Order Qty of the order will
become 6 thereby cancelling 4 out of original Qty.
See Table, "Message Map Details" for the details and mapping of this message.
Acknowledge Cancellation of Purchase Order

You can confirm the deletion of the purchase order back to the buyer. Confirmation
back to the buyer is done via an Acknowledge_PO message outbound from Order
Management and will indicate that the purchase order has been canceled.
If the cancellation request cannot be fulfilled, in other words if the request falls outside
of the allowable rules for cancellation, then an Acknowledge_PO message outbound
from Order Management must be sent indicating that the purchase order deletion
cannot be completed at this time and has been rejected.
Generate Confirm BOD (CBOD)

Upon receipt of the inbound Cancel_PO, Order Management can send out the Confirm
BOD to the buyer indicating that the data has reached the seller. The confirm bod will
not be sent out every time. It will be sent depending on the value of the
<CONFIRMATION> tag in the inbound document. The CBOD will not be sent if the
value of that tag is 0 or 1. It will be sent if the value of that tag is 2. Confirm BOD should
be generated on the successful insertion of the data in open interface tables. It can be
part of the workflow that begins after XML Gateway has finished the insertion of the
data successfully. At this point only the 'Successful' status will be sent back on the
CBOD as its unlikely that failure will occur after Order Management receives the
control of the process. Any failure before this point will be trapped by XML gateway
and notification will be sent to the buyer. Confirm BOD is only generated if the inbound
document has required confirmation.
Set up the Order Import Process to Run in Synchronous or Asynchronous Mode

You can set the profile option to initiate Order Import for every order or wait and
process multiple orders via concurrent processing. The profile option is OM: Run Order
Import for XML, that is set at the user or site level. The possible values for this profile
option will be Synchronous or Asynchronous.
Error Handling
See figure on the Error Handling Process.

The error handling process deals with the three kinds of outcomes that occur as a result
of running order import.
• Successful processing - In this case the confirmation API will be called to send the
Acknowledgment out to the sender with the 'Accept' status.
• Failed processing - This will be the status when there are validation errors or data
setup errors. In this case the acknowledgment will be sent out to the sender with the
'Reject 'status.
• Unexpected errors - There can be some unexpected errors due to resource

constraints and such which will require reprocessing of the Order Import upon
fixing those issues. This process is manual.
Business and Process Flow

1. The CANCEL_PO OAG XML Message is placed on an AQ present in the E-Business
Suite Database.
2. The CANCEL_PO Message is consumed using XML Gateway.
3. The XML Gateway will raise the appropriate event.
4. A CBOD is generated based on the Confirm flag in the message or the trading
partner setup. See: Generate Confirm BOD (CBOD)
5. The seeded Order Management Workflow will receive this event and start the
Cancel Flow.
6. Order import is used to process the message. The Order Management Module
accepts the message based on set rules and tolerances previously agreed upon
between the trading partners. The customer order is Cancelled.
7. The Order Management Inbound Workflow will then raise an event that will be
subscribed by the Outbound Workflow, and in turn will generate the data for the
OAG Acknowledge PO.
8. The XML Gateway forms the ACKNOWLEDGE_PO message.
9. This message is placed on an AQ present on the e-Business Suite Database.
CONFIRM BOD
Upon receipt of an inbound XML document such as a Process_PO or Cancel_PO, Order
Management has implemented the outbound OAG Confirm BOD message to signal the
successful receipt of data.
Major features of this transaction are as follows:
• This message contains information about the inbound XML message received, as
well as the status and description of the inbound message received.
• Unlike the Acknowledge PO message, the Confirm BOD is sent before Order
Import is run – it is purely a confirmation.
Message Map
Most data values in the message map are seeded.
Message Map 'ONT_3A9R_OAG72_IN.xgm'

The message map 'ONT_3A9R_OAG72_IN' is created using the Oracle XML Gateway
Message Designer tool. Please refer to Table, "Message Map Details" for the detailed
map analysis.
The source DTD used is 058_cancel _po_006.dtd, revision 7.2.1 of the Open Application
Group. The other associated external reference DTD files are:
oagis_resources.dtd
oagis_fields.dtd
oagis_segments.dtd
oagis_extensions.dtd
oagis_entity_extensions.dtd

All the DTD's will be checked in ONT source area under $ont/xml/oag72.
The target for the Inbound XML Message are the Order Management Open Interface
tables OE_HEADERS_INTERFACE & OE_LINES_INTERFACE.
The CANCEL_PO DTD is a three level hierarchy with Order Lines split into one or
more Shipment Lines. The Order Management architecture is however a two level one
with Order Header and one or more Lines. The message map will collapse the three
level XML Message into a two level structure when the data is inserted in the Order
Management Open Interface tables.
Please refer to Table, "Message Map Details" for a detail analysis of the elements
mapped, actions and derivation rules used by the Message Map.
XML Gateway Manual for more information.
• java LoadMap DB username> DB password> Hostname>:Port>:SID> mymap.xgm>

• java DeleteMap DB username> DB password> Hostname>:Port>:SID> mapname>

Source area under $ont/patch/115/map/ ONT_3A9R_OAG72_IN.xgm
For details on how the Message Map will be delivered to Customers please refer to
the Table, "Business and Process Flow" Section.
key: H => OE_HEADERS_INTERFACE, L => OE_LINES_INTERFACE
Cancel_PO Message Map
OAG Element Description Oracle OM OAG Code Default Value

or Comment Table/Column Reqd Convers
ion
Target: Yes or Needed
OE_HEADERS No (Y/N) Y/N
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
<CANCEL_PO_006
>
<CNTROLAREA>
<BSR>
<VERB>CANCEL</
VERB>
<NOUN>PO</NO
UN>
<REVISION>006</
REVISION>
</BSR>
<SENDER>
<LOGICALID>XX1
41HG09</LOGICA
LID>
<COMPONENT>P
UR</COMPONEN
T>
<TASK>MAINT</T
ASK>

ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
<REFERENCEID>9
5129945823449</RE
FERENCEID>
<CONFIRMATION
>1</CONFIRMATI
ON>
<LANGUAGE>EN
G</LANGUAGE>
<CODEPAGE>test<
/CODEPAGE>
<AUTHID>CMKU
RT</AUTHID>
</SENDER>
<DATETIME
qualifier="CREATI
ON">
<YEAR>1998</YEA
R>
<MONTH>11</MO
NTH>
<DAY>21</DAY>
<HOUR>16</HOU
R>
ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
<MINUTE>46</MI
NUTE>
<SECOND>45</SE
COND>
<SUBSECOND>000
0</SUBSECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<CANCEL_PO>
Source
CANCEL_PO
<POHEADER>
POID H.CUSTOMER Y
_PO_NUMBER
SITELEVEL Y
DESCRIPTN H.CHANGE_R Not provided.

EASON
NOTES index="1" H.CHANGE_C

OMMENTS
<USERAREA>

ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
< PARTNER>
PARNTRTYPE
(SoldTo)
PARTNRIDX Derive H.SOLD_TO_ Y

Address Id ORG_ID
from Location
Code Execute
Procedure Call
</PARTNER>
<ORACLE.CHAN H.CHANGE_S
GESEQUENCE> EQUENCE
<ORACLE.SUPPLI H.ORIG_SYS_
ERDOCREF> DOCUMENT_
REF
</USERAREA>
Execute H.CREATION Y SYSDATE

Function Call. _DATE
Execute H.LAST_UPD Y FND_GLOBA

Function Call. ATED_BY L.LOGIN_ID
Execute H.LAST_UPD Y SYSDATE

Function Call. ATE_DATE
Execute H.CREATED_ Y FND_GLOBA

Function Call. BY L.USER_ID
ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
Get H.ORDER_SO Y 20
Pre-Defined URCE_ID
Variable
Value.
Derive Org Id H.ORG_ID Y

from (SoldTo)
Location
Code.
H.XML_TRAN Y CPO
SACTION_TY
PE_CODE
</POHEADER>
<POLINE>
POLINENUM L.CUSTOMER Y
_LINE_NUMB
ER
NOTES index="1" L.CHANGE_C

OMMENTS
<USERAREA>
<ORACLE.SUPPLI L.ORIG_SYS_L
ERLINEREF> INE_REF
</USERAREA>
<SCHEDULE>

ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
<QUANTITY Convert from L.ORDERED_

qualifier="ORDERE OAG using QUANTITY
D"> standard
function.
VALUE Convert from L.ORDERED_ 0

OAG using QUANTITY
standard
function.
NUMOFDEC Convert from L.ORDERED_

OAG using QUANTITY
standard
function.
SIGN Convert from L.ORDERED_

OAG using QUANTITY
standard
function.
UOM1 Convert from L.ORDER_QU

OAG using ANTITY_UOM
standard
function.
</QUANTITY>
PSCLINENUM L.CUSTOMER Y
_SHIPMENT_
NUMBER
DESCRIPTN L.CHANGE_R Not provided.

EASON
Execute L.CREATION_ Y SYSDATE

Function Call. DATE
ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
Execute L.LAST_UPDA Y FND_GLOBA

Function Call. TED_BY L.LOGIN_ID
Execute L.LAST_UPDA Y SYSDATE

Function Call. TE_DATE
Execute L.CREATED_B Y FND_GLOBA

Function Call. Y L.USER_ID
Get L.ORDER_SO Y 20
Pre-Defined URCE_ID
Variable
Value.
L.ORG_ID Y
L.XML_TRAN Y CPO
SACTION_TY
PE_CODE
<USERAREA>
<ORACLE.SUPPLI L.ORIG_SYS_S
ERSHIPMENTREF HIPMENT_RE
> F
</USERAREA>
</SCHEDULE>
</POLINE>
</CANCEL_PO>
</DATAAREA>

ion
_INTERFACE
(H)
OE_LINES_IN
TERFACE (L)
</CANCEL_PO_00
6>
Note: 1UOM: The code category for this source is UOM.
Cancel Reason Code: The cancel reason code is not mandatory for OAG
while it is mandatory for Order Management's column. If the reason
code is not sent by customer Order Management defaults it to No
Reason Provided. This is seeded in Cancel_code lookup codes
(OE_LOOKUP) as part of installation on Cancel_PO. The reason codes
populated by the customer must be valid lookup codes in Cancel_Code
lookup code.
Seeded Workflow for Inbound XML Messages

A pre-defined workflow event is seeded to run Order Import immediately if the profile
option OM: Run Order Import for XML is set to Synchronous. This workflow subscribes
to the event raised by the Post Process of the XML Gateway. As part of the workflow
process Order Import is run for the XML message, that is currently being consumed.
The following Workflow is designed using Workflow Builder.

Message Details
This table describes the data types and fields in the DTD used by the message map.
The message map may remove used fields so that empty data tags are neither generated
for outbound transactions nor examined by inbound transactions.
Message Map Details
Name Description
Message Map Name: ONT_3A9R_OAG72_IN
Direction: Inbound
(Internal) Transaction Subtype: CPO
External Transaction Subtype: CANCEL
Message Maps XGM File Name: ONT_3A9R_OAG72_IN.xgm
Name Description
Standard: OAG
Release: 7.2
Format: DTD
DTD Name: 058_cancel_po_006.dtd
For the next three tables, refer to Table, "Message Map Details".
Column Description
<UOM> (in schedule level <QUANTITY Code Category – UOM, mapped to

qualifier="ORDERED>) OE_LINES_INTERFACE.ORDER_QUANTIT
Y_UOM
Defaulted Columns
H.CHANGE_REASON 'Not provided' (if Header-level DESCRIPTN

tag is NULL>
H.OPERATION_CODE UPDATE'
H.XML_TRANSACTION_TYPE_CODE 'CPO'
L.CHANGE_REASON 'Not provided' (if Line-level DESCRIPTN tag

is NULL>
L.OPERATION_CODE 'UPDATE'

L.ORDERED_QUANTITY 0 (if derived ORDERED_QUANTITY is

NULL)
L.XML_TRANSACTION_TYPE_CODE 'CPO'
Derived Columns
H.CANCELLED_FLAG Set to 'Y', if no lines are passed
H.CREATED_BY FND_GLOBAL.LOGIN_ID

value is not null
L.CREATED_BY FND_GLOBAL.LOGIN_ID

Detail Value
Event Description Order Management Generic Inbound Event

raised by the post process of the Process_PO
XML mapping
Extension Tags
The following changes were made by Procurement as extensions on the XML
documents sent to Order Management.
• $ont/xml/oag72/oagis_entity_extensions.dtd
Add the following tags:
EXCHRATEDATE">
Add the following tags:

<!ELEMENT PCARDHDR
(MEMBERNAME?,PCARDNUM?,(%DATETIME.EXPIRATION;)?,PCARDBRAND
?)>
<!ELEMENT MEMBERNAME %STRDOM;>
(REQUESTOR?,DISTNUM?,PROJECTNUM?,PROJECTTYPE?,TASKNUM?,(%Q
UANTITY.ORDERED;)?,CONVRATE,(%DATETIME.EXCHRATEDATE;)?,DESTTY
PE?,DFFDISTRIBUTN?)>
<!ELEMENT DFFPOHEADER
16?)>
<!ELEMENT
DFFVENDORSITE(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,A
TTRIBUTE5?,ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?,ATTRIB
UTE10?,ATTRIBUTE11?,ATTRIBUTE12?,ATTRIBUTE13?
,ATTRIBUTE14?,ATTRIBUTE15?,ATTRIBUTE16?)>
<!ELEMENT DFFVENDOR
16?)>
<!ELEMENT DFFLINE
IBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?
,ATTRIBUTE10?,ATTRIBUTE11?,ATTRIBUTE12?,ATTRIBUTE13?,ATTRIBUTE14?,
ATTRIBUTE15?,ATTRIBUTE16?)>
<!ELEMENT DFFITEM
<!ELEMENT KFFITEM
ATTRIBUTE15?,ATTRIBUTE16?,ATTRIBUTE17?,ATTRIBUTE18?,ATTRIBUTE19?,
ATTRIBUTE20?)>
<!ELEMENT
DFFDISTRIBUTN(ATTRIBUTE1?,ATTRIBUTE2?,ATTRIBUTE3?,ATTRIBUTE4?,AT

TRIBUTE5?,ATTRIBUTE6?,ATTRIBUTE7?,ATTRIBUTE8?,ATTRIBUTE9?
Open Interface Tracking
Overview
The two main categories that comprise messages are Electronic Data Interchange (EDI)
flat files and Open Applications Group (OAG) XML. The Open Interface Tracking form
provides a unified view of Order Management's EDI and XML messages.
You can obtain the history of messages or delete historical records using a purge
procedure. The form provides you with the current status and a textual message
pertaining to processing of that message, or if using Oracle Workflow, you can view the
diagram. Similarly, for XML messages, you can view the XML document. You can
determine the specific outbound message (if any) triggered by a particular inbound
message and vice versa.
This functionality will impact Order Import and the EDI/XML transaction processing.
Both Order Import of closed orders and HVOP are not supported.
Order Management's Business Event System (BES)-based mechanism for other products
(such as the Supply Chain Trading Connector module) captures and records the
transaction history as XML messages exchanged between trading partners. The same
mechanism has been extended to include other electronic messages and to make this
information available via the form.
Major Features
Search For EDI/XML Electronic Messages

You can query up historical data for electronic messages received and processed by
Order Management based upon a variety of search criteria such as Transaction Type,
Order Source, etc.
View XML Data For a Particular Message

The XML document may convey important information, so you can navigate to the
corresponding XML for a particular message.
View Workflow for XML Messages

You can navigate to the corresponding workflow for Order Management's XML
messages.
Provides a Visual Cue To Associate Related Inbound and Outbound Messages

You can optionally group related Inbound and Outbound messages for a particular
order. For instance, you can visually associate the inbound Cancel PO XML message
with its corresponding outbound Confirm BOD and Acknowledgment. Similarly, an
850 Purchase Order Inbound EDI messages is associated with the corresponding 855
Purchase Order Acknowledgment Outbound.
Purge Procedure
You can purge the tracking data using a concurrent program. This concurrent program
can also be used to purge the interface or acknowledgment tables.

Business Scenarios and Process Flow
INBOUND
1. For EDI/XML, the inbound Electronic Message is consumed using the appropriate
Gateway and the Order Management Open Interface tables are populated. A record
is created for this message with the information that data has been entered into the
interface tables.
2. If the Electronic Message is processed using a workflow (i.e. for XML messages),
then the record is updated with information regarding the current workflow status
as the flow proceeds.
3. If Order Import (EDI/XML or standard) is run on the data, the record for the
message is updated with information regarding the completion of Order Import.
OUTBOUND
1. Outbound EDI/XML Electronic Messages are generated via a concurrent program
or when a business event is raised or when certain pre-determined attributes of the
order are updated. When the triggering condition occurs, a record is created for this
message with the information that the outbound Electronic Message will be
generated.
2. If the Electronic Message is processed using a workflow (i.e. for XML messages),
then the record is updated with information regarding the current workflow status
as the flow proceeds.
3. When the appropriate Gateway generates and transmits the outbound Electronic
Message, the record is updated with the information that the message has been
sent.
The messages are logged as follow: a business event (oracle.apps.ont.oi.xml_int.status)

is raised, and a seeded workflow subscription executes and writes the event
information to a table.
Messages
This table is for any form-related messages that are seeded.
Form Related Messages That Are Seeded
Code Meaning
OE_OI_IFACE &TRANSACTION - Data successfully entered

into Open Interface Tables
OE_OI_IMPORT_MODE_SYNC &TRANSACTION - Order Import will be run

in synchronous mode
OE_OI_IMPORT_MODE_ASYNC &TRANSACTION - Order Import will be run

in asynchronous mode
OE_OI_IMPORT_SUCCESS_GEN &TRANSACTION - Order Import successful
OE_OI_IMPORT_FAILURE &TRANSACTION - Order Import failed
OE_OI_OUTBOUND_TRIGGERRED OM is ready to send &TRANSACTION

message
OE_OI_OUTBOUND_SETUP &TRANSACTION - Setup Validation

successful
OE_OI_OUTBOUND_SETUP_ERR &TRANSACTION - Setup Validation failed
Profile Options
Profile Options
Function User Function Name Description Usage
ONT_EMINTEG_SO OM: Electronic Order Sources Profile option to

URCES Message Integration enabled for control Tracking
Event Sources Integration Business
Event
Electronic Message Status-Message Mapping

To provide a useful picture regarding the current processing status of an electronic
message, the following messages will be written to the history table:

Inbound XML Messages
Status Message
Active &TRANSACTION - Data successfully entered

Active &TRANSACTION - Order Import will be run

in synchronous mode
Active &TRANSACTION - Order Import will be run

in asynchronous mode
Success/Error &TRANSACTION - Order Import

successful/failed
Outbound XML Messages
Status Message
Active OM is ready to send &TRANSACTION

message
Active/Error &TRANSACTION - Setup Validation

Successful/Failed
Success/Error &TRANSACTION - message has been sent
Inbound EDI Messages
Status Message
Active &TRANSACTION - Data successfully entered


successful/failed
Outbound EDI Messages
Status Message
Active EDI Acknowledgment values derived
Success/Error &TRANSACTION - message has been sent
Standard Order Import
Standard Order Import
Status Message

successful/failed
Event/Event Subscription
The following event oracle.apps.ont.oi.xml_int.status is seeded
The following event subscription to the above event will also be seeded:
Seeded workflow OEEM/Open Interface Tracking

The workflow (item type code OEEM, name OM: Open Interface Tracking) will be
seeded. This workflow will write the data from the event
oracle.apps.ont.oi.xml_int.status to the table.
Event Parameters & Population
Event Parameters
The event oracle.apps.ont.oi.xml_int.status will contain the following parameters:

Event Parameters
XMLG_INTERNAL_CONTR Unique document number Overloaded to provide a

OL_NUMBER generated by XML Gateway unique id for EDI inbounds
for inbound messages and Order Import as well
XMLG_MESSAGE_ID Unique message id generated

by XML gateway for
outbound messages
XMLG_INTERNAL_TXN_TY Typically 'ONT' except for

PE Confirm BOD which is owned
by 'ECX'
XMLG_INTERNAL_TXN_SU Identifies XML transaction Overloaded to also contain

BTYPE type EDI and Order Import
transaction type, namely '850',
'860', '855', '865', 'GENERIC'
DOCUMENT_DIRECTION 'IN' or 'OUT'
XMLG_DOCUMENT_ID Unique ID provided by OM Overloaded to provide a

for outbound messages unique id for outbound EDI
transactions
TRADING_PARTNER_TYPE 'C'
TRADING_PARTNER_ID TP Party ID
TRADING_PARTNER_SITE TP Party Site ID
DOCUMENT_NO Sales Order Number
ORG_ID Organization ID
PARTNER_DOCUMENT_NO Purchase Order Number
DOCUMENT_REVISION_N Change Sequence

O
ONT_DOC_STATUS 'ACTIVE', 'SUCCESS',

'ERROR'
MESSAGE_TEXT FND MESSAGE detailing

what has occurred.
WF_ITEM_TYPE Workflow Info for XML

processing
WF_ITEM_KEY Workflow Info for XML

processing
ORDER_SOURCE_ID Order Source
SOLD_TO_ORG_ID Customer ID
ORDER_TYPE_ID Order Type ID
CONC_REQUEST_ID Processing Concurrent

Request ID
PROCESSING_STAGE Code to identify why this

event was raised. Sample
values include
'INBOUND_IFACE',
'OUTBOUND_SENT'.
SUBSCRIBER_LIST Comma delimited list of

product short names of the
intended subscribers e.g.
'ONT,CLN'
DOCUMENT_STATUS 'SUCCESS', 'ERROR'
HEADER_ID Order Header indentifier

ORDER_PROCESSED_FLAG Flag to indicate whether data

has been successfully
resolved to an order in the
system. This flag is needed
because even if Order Import
failed for XML transactions, it
is possible that order number,
order type id, and header id
are still derived for the events
raised by Acknowledge PO
(e.g. if Order Import failed
due to duplicate order source
and orig sys document ref).
Similarly, for 3A8, 3A9
inbounds, the order number,
header id, and order type id
are derived prior to running
Order Import, but Order
Import could subsequently
fail Thus, this flag is set to N
if Order Import has not run or
if Order Import failed for both
inbound and outbound
transactions to allow
subscribers to identify the
above cases.
Not every parameter will be populated in all cases. The following table contains a Y if a
particular parameter is populated
Populated Parameters
Parameter Name INBOUND - Parameter OUTBOUND - Parameter

Populated (Electronic Populated (Electronic
Message Types) Message Types)
XMLG_INTERNAL_CONTR Y (XML, EDI, Order Import)

OL_NUMBER
XMLG_MESSAGE_ID Y (XML, if document sent

successfully)
XMLG_INTERNAL_TXN_TY Y (XML, EDI, Order Import) Y (XML, EDI)

PE
XMLG_INTERNAL_TXN_SU Y (XML, EDI, Order Import) Y (XML, EDI)

BTYPE
DOCUMENT_DIRECTION Y (XML, EDI)
XMLG_DOCUMENT_ID Y (XML, EDI)
TRADING_PARTNER_TYPE Y (XML, except CBOD)
TRADING_PARTNER_ID Y (XML, except CBOD)
TRADING_PARTNER_SITE Y (XML, except CBOD)
DOCUMENT_NO Y (XML, EDI, Order Import) Y (XML if import succeeds or

EDI)
ORG_ID Y (XML, EDI, Order Import) Y (XML, EDI)
PARTNER_DOCUMENT_NO Y (XML, EDI, Order Import) Y (XML, EDI)
DOCUMENT_REVISION_N Y (XML, EDI, Order Import) Y (XML, EDI)

O
DOCUMENT_STATUS Y (XML, EDI, Order Import) Y (XML, EDI)
ONT_DOC_STATUS Y (XML, EDI, Order Import) Y (XML, EDI)
MESSAGE_TEXT Y (XML, EDI, Order Import) Y (XML, EDI)
WF_ITEM_TYPE Y (XML) Y (XML, EDI *)
WF_ITEM_KEY Y (XML except when Y (XML, EDI *)

PROCESSING_STAGE is
IMPORT_SUCCESS or
IMPORT_FAILURE)

ORDER_SOURCE_ID Y (XML, EDI, Order Import) Y (XML, EDI)
SOLD_TO_ORG_ID Y (XML, EDI, Order Import) Y (XML, EDI)
ORDER_TYPE_ID Y (XML, EDI, Order Import) Y (XML if import succeeds or

EDI)
CONC_REQUEST_ID Y (XML, EDI, Order Import) Y (XML if Conc Show SO)
PROCESSING_STAGE Y (XML, EDI, Order Import) Y (XML, EDI)
SUBSCRIBER_LIST Y (XML, EDI, Order Import) Y (XML, EDI)
RESPONSE_FLAG Y (XML only for Change PO

response)
The following table maps the value of the event parameter PROCESSING_STAGE to the
message text for that stage:
Processing_Stage
XML EDI Order Import Processing Stage Sample Message

Description Text
(CODE)
Y Y Data received "Process PO –

(INBOUND_IFA Data successfully
CE) entered into
Open Interface
tables"
"850 POI – Data

successfully
entered into
Open Interface
tables"
Y Import mode "Process PO –
(PRE_IMPORT) Order Import
will be run in
Asynchronous
mode"
"Process PO –
Order Import
will be run in
Synchronous
mode"
Y Y Y Order Import "Process PO -

result Order Import
(IMPORT_SUCC successful"
ESS,
IMPORT_FAILU "Process PO –
RE) Order Import
failed"
Y Y Outbound "OM is ready to

message send the
triggered Acknowledge
(OUTBOUND_T PO message"
RIGGERED)
"OM is ready to
send the Show
SO message"
Y Y* Outbound setup "Acknowledge

result PO – Setup
(OUTBOUND_S validation
ETUP) successful"
"Acknowledge
PO – Setup
validation failed"
"EDI
Acknowledgmen
t values derived"
Y Y Outbound sent "Acknowledge

(OUTBOUND_S PO message has
ENT) been sent"
"855 POAO
message has
been sent"

Note: For Outbound_Triggered and Outbound_Setup, the EDI support
is only active when the Pack J EDI workflow is being used.
6
Oracle Order Management EDI Transactions

• Oracle Order Management
• Inbound Purchase Order (POI/850/ORDERS)
• Order Import
• Review and Resolve Order Management Open Interface Exceptions
Oracle Order Management

Please refer to the following guides for more information on setting up and using EDI
Transactions in Oracle Order Management:
• Oracle e-Commerce Gateway Implementation Manual
• Oracle e-Commerce Gateway User's Guide
• Integration Repository for more information on the extensible EDI APIs: Purchase
Order Acknowledgments Extension Columns API and Purchase Order Change
Acknowledgments Extension Columns API.
The following table summarizes the EDI Transactions:
Release Management Transactions
Transaction Direction Tran. Code ASC X12 EDIFACT

Name
Purchase Order Inbound POI 850 ORDERS
Oracle Order Management EDI Transactions 6-1

Transaction Direction Tran. Code ASC X12 EDIFACT
Name
Purchase Order Inbound POCI 860 ORDCHG

Change
Purchase Order Outbound POAO 855 ORDRSP

Acknowledgeme
nt
Purchase Order Outbound POCO 865 ORDRSP

Change
Acknowledgeme
nt
Inbound Purchase Order (POI/850/ORDERS)

This transaction is the inbound purchase order from the customer's procurement
application into the Oracle Order Management application. This transaction uses the
Order Management Order Import open interface. Refer to the Oracle Manufacturing APIs
and Open Interface Manual and the Oracle e-Commerce Gateway Implementation Manual for
more details.
Trading Partner Link to Oracle e-Commerce Gateway

The EDI Location Code is the link between a Customer/Customer site in Oracle
Applications and the trading partner site definition in Oracle e-Commerce Gateway.
This enables Oracle e-Commerce Gateway to access the detailed data about the
Customer or Customer site in the base Oracle Applications without maintaining the
detail data in Oracle e-Commerce Gateway.
Refer to the Trading Partner chapter in the Oracle e-Commerce Implementation Manual for
recommendations on selecting the correct trading partner EDI Location Code for the
control record 0010 for the transaction in the transaction interface file.
Oracle e-Commerce Gateway Required Fields

The following is a list of the Oracle e-Commerce Gateway required fields. These fields
are required to authenticate the trading partner and transaction. If the required data is
not provided in the transaction, the Oracle e-Commerce Gateway import process fails
the transaction. Then an exception message is displayed in the View Staged Documents
window.
If the trading partner is valid and the transaction is enabled, the import process
proceeds to validate the transaction using the user-defined column rules. If no process
or column rule exceptions are detected, the Oracle e-Commerce Gateway import
program will write the transaction to the Order Management Open Interface tables to
be processed by the Order Management Open Interface API.
Control Record Details
Oracle e-Commerce Record Number Position Number Note

Gateway Column
Name for Required
Fields
TEST_INDICATOR 0010 20 T or P
TP_DOCUMENT_ID 0010 30 POI
TP_TRANSLATOR_C 0010 70 Translator identifier

ODE for this trading
partner
TP_LOCATION_CO 0010 80 The EDI Location

DE Code
Review and Resolve Oracle e-Commerce Gateway Exceptions

The View Staged Documents window enables you to review the Oracle e-Commerce
Gateway transaction exceptions as specified by the process and column rules in the
e-Commerce Gateway. To resolve Oracle e-Commerce Gateway exceptions, you can
either correct the set up data in Oracle e-Commerce Gateway or Oracle Applications, or
ask the Trading Partner to send a corrected transaction. Once the exceptions are
identified and resolved, you can submit the transaction for reprocessing, ignore the
exception during reprocessing, or delete the transaction. Select the preferred option in
the View Staged Documents window.
Relevant Oracle Order Management Profiles and Setup Steps

The required Order Management setup steps are the same whether the order is entered
on-line or through Order Import. The following is a sample list of the Order
Management setup steps needed to process orders through the e-Commerce Gateway
or entered on-line.
• Customer and Customer Sites must be defined in Order Management/ Oracle
Receivables.
• Order Types must be defined in Order Management.

• Item and appropriate customer items must be defined in Oracle Inventory.
Oracle Order Management Defaulting Functionality

Oracle Order Management provides powerful Defaulting functionality that is used by
the Order Import process, as well as by orders entered manually using the Order
Management forms. If a column is left null in the interface tables, then the Defaulting
Rules are invoked, to provide a value for those columns.
Order Import Open Interface Data Levels

The EDI standard transaction has three (3) key levels of data: Header, Line (item), and
Schedules (Shipments).
The Order Import open interface tables have a two level structure where the order line
and a single shipment are combined into one table entry for each combination. Order
Import requires that line and shipment data be consolidated into the LINE level table.
The e-Commerce Gateway transaction accommodated the three level transactions so
that the item data is written only once on Record 2000 (also records 2010/2020 if needed)
followed by all the shipment (schedules) in records 3000-4900. The process will combine
the item data to each set of its associated shipment data before writing the data to the
Order Import LINE level table.
Original System Reference Data in all Order Import Tables

Order Import requires a set of Original System reference fields. These are derived by the
e-Commerce Gateway transaction process if one is not found in the transaction.
The Original System reference fields are used to match change orders to original orders.
Thus, these values must be unique within all orders for a customer and entered with the
new orders.
The POI transaction program derives the header and line level Original System
reference fields, if data is not supplied in the transaction when the transaction was
created.
Original System Document Reference

Original System Document Reference is an identifier for the order within Order
Management to guarantee its uniqueness within one operating unit.
Most often, it is the purchase order number, plus release number (if appropriate). A
character such as the dash sign between each component improves readability.
The ORIG_SYS_DOCUMENT_REF is derived by the POI program or generated by a
process such as the EDI Translator before the order is imported into the Order Import
tables. It is not sent by the customer in the transaction as a field known as Original
System Document Reference.
Order Import
Flags
There are several flags in the interface tables of Order Management that affect the Order
Import processing. Valid values of these flags are Y, N, and null. Null means different
things depending on the particular flag. The Order Import process sets the defaults if a
code is not found in the transaction. These flags are: Booked, Cancelled, Closed, Error,
Ready, Rejected.
Most of the flag data elements are not activated on the transaction, since the defaults are
usually adequate. Their data elements are listed at the end of the activated data
elements in the Transaction Definition window.
Order Import Open Interface Data

The Order Management Order Import Open Interface is used by the Inbound Purchase
Order transaction. This validates the incoming data entered into the Order Management
Open Interface tables by the Oracle e-Commerce Gateway import program or any other
loading program.
The data for the Order Import tables have the following sources:
• Data in the transaction from the trading partner or determined by the EDI
Translator.
• Data derived or hard codes by the POI Program given the trading partner or the
presence of data in the transaction.
• Data derived by the Order Import process when it calls APIs to the Oracle tables.
Review and Resolve Order Management Open Interface Exceptions

At the completion of the Order Management Open Interface Order Import program, the
orders with exception can be viewed in the Order Import window.
There are three ways to resolve Order Management Open Interface exceptions as
follows:
Using the information given by the View Staging Documents window in the
e-Commerce Gateway, correct the set up data in Oracle Applications.
Correct erroneous entries in the Order Management Order Import window.
Request the customer to send a corrected transaction.
If you chose to update Oracle Applications data or change the erroneous entries using
the Order Import window in Order Management, you can resubmit the Order

Management Open Interface Order Import process to revalidate the transaction.
If you chose to have the customer send a corrected transaction, you must first delete the
rejected Order data in the Order Management Open Interface tables using the Order
Import window and then re-import the updated transaction using the Oracle
e-Commerce Gateway.
Refer to the Oracle Order Management User's Guide, and the Oracle Manufacturing APIs
and Open Interface Manual for more detail.
7
Oracle Order Management Open Interfaces
and APIs

• Integrating Oracle Order Management Using Order Import
• Process Order Application Open Interface
Integrating Oracle Order Management Using Order Import
Overview
You must manually submit the Order Import Statistics concurrent program prior to
submitting the Order Import concurrent program if you wish to optimize interface
record processing.
Order Import, like the rest of Oracle Applications, uses the Cost Based Optimizer of the
database for optimizing queries. The Cost Based Optimizer uses generated statistical
information to optimize queries. The Order Import Statistics concurrent program
gathers statistics that will be used by the cost based optimizer. This concurrent program
should be run after data is populated into the interface tables.
See: Order Import Concurrent Program.
Order Import is an Order Management Open Interface that consists of open interface
tables and a set of APIs. Order Import can import new, change, and completed sales
orders or returns from other applications such as a legacy system. You can also import
cancelled , closed and booked orders. The orders may come from any source such as
EDI transactions that are processed by the Oracle e-Commerce Gateway or internal
orders created for internal requisitions developed in Oracle Purchasing or returns.
Order Import features include validation and defaulting, processing constraint checks,
applying and releasing of order holds, scheduling of shipments, then ultimately
inserting, updating or deleting the orders in the base Order Management tables. Order
Management checks all the data during the import process to ensure its validity within
Oracle Order Management Open Interfaces and APIs 7-1

Order Management. Valid transactions are then converted into orders with lines,
reservations, payments, price adjustments, and sales credits in the base Order
Management tables.
You can use the Order Import Correction window to examine the order and optionally
correct data if it fails the import process. You can use the Error Message window to
determine the error if your data failed to import.
Each time you run Order Import, Order Management produces a summary of
information letting you know of the total number of orders that Order Import evaluates,
and succeeded or failed.
Prerequisites and Set-Up

Before using this program to import orders, you should:
• Set up every aspect of Order Management that you want to use with imported
orders, including customers, pricing, items, and bills.
• Define and enable your Order Import sources using the Order Import Sources
window.
• Determine if you should submit the Order Import Statistics concurrent program.
Multi-Org Access Control in Order Import

The Operating Unit is added as a new parameter to the Order Import concurrent
program. If you do not specify an Operating Unit then Order Import concurrent request
will allow you to import Orders into the different Operating Units that you have access
to.
If you do specify an Operating Unit, then the concurrent program will import Orders
only for the selected Operating Unit.
If there is no Operating Unit specified on the interface records, Order Import attempts
to process those records for the default Operating Unit. Order Import updates such
records (with no Org Id) with the Org ID for the Operating Unit that they were
processed for.
By default this parameter (Process Orders With No Org Specified) will be set to Y, to
maintain backward compatibility. If you always populate the Operating Unit field in
the interface table records then you should change it to N. It is recommended that you
always specify a value for the Operating Unit (Org ID) when you populate the interface
tables.
Order Management Parameters

The following Order Management parameters affects the operation of the Order Import
program:
• Item Validation Organization--Determines the organization used for validating items
and bill of material structures.
• Reservation Time Fence--This system parameter controls automatic reservations

during scheduling.
• Schedule Line on Hold-- This system parameter decides if Order Management

scheduling should schedule lines that are on hold.
Profile Options
• OM: Apply Automatic Attachments--This profile option determines whether
rule-based attachments are applied without user intervention.
• OM: AutoSchedule-- This profile decides whether the order line should be
automatically scheduled or not.
• OM: Authorized to Override ATP-- This profile provides the authorization to users to
override the scheduling results.
• OM: Import Multiple Shipments-- This profile option is used to import multiple
shipments via Order Import. If this profile option is set to Yes, the
orig_sys_shipment_ref will also be used in determining the uniqueness of the line
record in combination with order_source_id, orig_sys_document_ref and
orig_sys_line_ref.
• OM: Unique Order Source, Orig Sys Document Ref Combination for Each Customer--
This profile determines whether or not customer information will be utilized to
distinguish orders with the same reference information.
Items and Bills

Order Management uses the same customer, item pricing, and bill attribute validation
and logic for imported orders as for orders entered in the Sales Orders window.
You need to define items using Oracle Inventory for items to be orderable via Order
Import. You also need to define bills of material in Oracle Bills of Material for models if
you have any complex items that customers can order in various configurations.
Order Import provides the ability to import an item specified in the following supplier,
customer or generic formats:
• Supplier Specific Internal Part number
• Customer Specific Item number
• Generic (depending on what you have set up in Oracle Inventory as

cross-references):
• CLEI (Common Language Equipment Identifier)

• EAN (European Article Number) code
• ISBN (International Standard Book Number)
• JAN (Japanese Article Number) code
• UPC (Universal Product code) code
Customer Relationships
Site Level Customers and Sites for Bill_To, Ship_To and Deliver_To will be validated
based on the Customer Relationships profile.
This parameter has three setting:
Single Customer: Site Can only belong to the Sold to Customer. The Site level Customer
cannot be different than the Sold to Customer.
Related Customers: Site Can only belong to the Sold to Customer or a Customer Related
to the Sold To Customer . The Site level Customer can be different than the Sold to
Customer but the relationship should exist between the site level customer and the Sold
to Customer.
All Customers: Site Can only belong to the Sold to Customer or any other Customers.
The Site level Customer can be different than the Sold to Customer and it is not
required that relationship should exist between the site level customer and the Sold to
Customer.
When checking for relationship we also check the appropriate usage in the Relationship
also.
For example, customer "A" can be a valid related BillTO customer to Customer "B," only
if the relationship exists and the bill_to_Flag is checked in the relationship.
Similarly for ShipTO and Deliver_to we check the Ship_To flag.
Add Customer
Order Management provides the capability to add a new customer, the address and
contacts using Order Import. The table OE_CUSTOMER_INFO_IFACE_ALL needs to
be populated for this.
Based on the data available in the OE_HEADERS_IFACE_ALL the data from the table
OE_CUSTOMER_INFO_IFACE_ALL is processed to add a new customer. This table
can also be used to import a new address only or contact information of an existing
Customer.
The link between the header interface record and the customer interface record is made
through the column CUSTOMER_INFO_REF of the table
OE_CUSTOMER_INFO_IFACE_ALL and any one the columns mentioned below. The
link depends on the CUSTOMER_INFO_TYPE_CODE. When the order import is used
to create a new customer ( new account/address/contact etc ), the
CUSTOMER_INFO_TYPE_CODE should be either ('ACCOUNT', 'ADDRESS', or
'CONTACT') to denote the type of information in the record. The following table
explains the relationship between the various header interface table columns and the
column CUSTOMER_INFO_TYPE_CODE and the usage of the combination.
OE_HEADERS_IFACE_ALL
OE_HEADERS_IFAC Usage CUSTOMER_INFO_ Result

E_ALL TYPE_CODE
Orig_Sys_Customer_ ACCOUNT New Customer

Ref account will get
created
Orig_Ship_Address_ SHIP_TO ADDRESS New Ship to address

Ref will get created
Orig_Bill_Address_R BILL_TO ADDRESS New Bill to address

ef will get created
Orig_Deliver_Addres DELIVER_TO ADDRESS New Deliver to

s_Ref address will get
created
Sold_to_Contact_Ref SOLD_TO CONTACT New Sold to Contact

will get created
Ship_to_Contact_Ref SHIP_TO CONTACT New Ship to Contact

will get created
Bill_to_Contact_Ref BILL_TO CONTACT New Bill to Contact

will get created
Deliver_to_Contact_R DELIVER_TO CONTACT New Deliver to

ef Contact will get
created
The following profiles affect the add customer functionality.

• OM: Add Customer (Order Import)
This will decide whether the customer can be imported using order import. This
must be set to "ALL" for importing new customer account and to 'Address and
Contact only ' for importing addresses and contacts alone. The eligible values for
the profile are as follows:
N = None

P = Address and Contact only
Y = All
• OM: Email Required on New Customers

This will decide whether the records in the oe_customer_info_iface_all should have
the email or not. If the profile is set to "Yes" then you must enter a not null value in
the field EMAIL_ADDRESS of the table OE_CUSTOMER_INFO_IFACE_ALL.
• HZ: Generate Party Number = 'YES' or NULL

the party number or not. If the profile is set to Yes then you must enter a not null
value in the field PARTY_NUMBER of the table
OE_CUSTOMER_INFO_IFACE_ALL.
• HZ: Generate Contact Number = 'YES' or NULL.

If this is set to 'N' then Order Import program will generate the Contact Number. If
this is set to 'YES' or NULL then it will be generated later while creating the
Contact.
• HZ: Generate Party Site Number = 'YES' or NULL.

the site number or not. If the profile is set to Yes then you must enter a not null
value in the field SITE_NUMBER of the table OE_CUSTOMER_INFO_IFACE_ALL..
The value of the profile option 'Automatic Customer Numbering' and 'Automatic Site
Numbering' from the AR System Options are also important. If the flags are unchecked
in the option, then the following fields of the table OE_CUSTOMER_INFO_IFACE_ALL
must have a not null value.
CUSTOMER_NUMBER if Automatic Customer Numbering is unchecked
LOCATION_NUMBER if Automatic Site Numbering is unchecked
Order Import will respect the setting of the OM System Parameter – Customer
Relationships (Setup=>Parameters) and create customer-to-customer relationships if
needed and allowed. The parameter values will be interpreted as follows:
• Customer Relationships = 'Single Customer'
The Ship_To, Deliver_To and Bill_To addresses must belong to the Sold_To
customer on the order. If an attempt is made to import an order with a Bill_To,
Deliver_To or Ship_To from a different customer than the Sold_To, Order Import
will raise an error and the order will not be imported.
• Customer Relationships = 'Related Customers'

If a new customer is added for a Ship_To, Bill_To, or Deliver_To address, the
appropriate relationship will be created in the TCA (Trading Community
Architecture)
• Customer Relationships = 'All Customers'

A new customer can be added, but no relationship creation occurs.
Importing an order using a new Customer information will require you to add and also
to remove some data from the headers interface table depending on the kind of
information being imported. For example if a customer account alone is to be imported
then the Orig_Sys_Customer_Ref needs to be populated and the
sold_to_org/sold_to_org_id should be populated as null.
The some or all of the following data is to be populated in oe_headers_iface_all table,
• Orig_Sys_Customer_Ref
• Orig_Ship_Address_Ref
• Orig_Bill_Address_Ref
• Orig_Deliver_Address_Ref
• Sold_to_Contact_Ref
• Ship_to_Contact_Ref
• Bill_to_Contact_Ref
• Deliver_to_Contact_Ref
And some or all of the following data needs to be removed from the
oe_headers_iface_all tables depending upon the information being imported.
• sold_to_org / sold_to_org_id
• invoice_to_org / invoice_to_org_id
• ship_to_org / ship_to_org_id
Against this the oe_custome_info_iface_all table needs to be populated. The number of

records being populated will depend on what is being imported. For example while
importing only the customer account only one record will be populated and while
importing account, address and contacts three or more records will be populated.
If the customer addresses are to be different for ship, bill, and deliver, then three
different records need to be populated. Whether an address is for ship , bill, or deliver,
is decided by the following columns of the oe_customer_info_iface_all table-
• IS_SHIP_TO_ADDRESS,
• IS_BILL_TO_ADDRESS,

• IS_DELIVER_TO_ADDRESS
These take the values 'Y,' 'N' or null. So if the particular record needs to be only a bill to
address, then the IS_BILL_TO_ADDRESS should be set as 'Y' and the rest as 'N' or null.
If the same address needs to be Bill to , ship to and deliver to Address then the flag
should be set as 'Y' against all the three columns.
The link between the Account record and the address or contact record is through the
column PARENT_CUSTOMER_REF. This should be populated in the address or
contact record with the CUSTOMER_INFO_REF of the account record. For example, if
the CUSTOMER_INFO_REF in the record with the CUSTOMER_INFO_TYPE_CODE as
'ACCOUNT' is 'XXXX' then the PARENT_CUSTOMER_REF for the record with the
CUSTOMER_INFO_TYPE_CODE as 'ADDRESS' or 'CONTACT' should be 'XXXX.'
Defaulting Rules
You can setup your defaulting rules which allow you to default columns in the same
way as for orders entered online. You can pass the column value Null to Order Import
if you want the defaulting rules to populate the column. However, if the column is
defined as Not Null or Mandatory column and the defaulting rules fail to default the
column, for any reason, Order Import displays an error message without importing the
order.
Importing from External Systems

You can import orders with any external source defined in the Define Document
Sequences window.
Note: You cannot specify a value in the DROP_SHIP column of the

OE_HEADERS_IFACE_ALL. If you enter a value in this column, the
Order Import concurrent program will fail.
Internal Sales Orders

Oracle Purchasing uses Order Import to transfer requisitions for internally sourced
products to Order Management. Once imported, the internal sales orders are processed
as regular sales orders.
Returns
Returns can be imported like a regular sales order. Order Management utilizes
workflow activities to import returns.
Special Considerations for importing Return orders

Creation of a non-referenced RMA
To import a return order for a non referenced return, you must:
• Populate all required attributes for creating a return order
• Use an order category of RETURN or MIXED for the Order Header record.
• Populate all required attributes for creating a return order lines.

• For Order Line Record, you cannot specify a value for the line category_code
column. You need to populate the column ordered_quantity with a negative
value.
• Line_type _id is optional, provided a default line_type has been defined for the
specified Order Type.)
• Additionally, you will need to populate the column reason_code for all return
lines. Valid values are those values defined for the Order Management
QuickCode CREDIT_MEMO_REASON.
Note: If the Reason Code is not provided, Order Import errors

out. However we do not currently validate whether Reason
Code is entered correctly. Users need to enter Reason Code
when they populate the interface table, instead of the definition
of the reason. For example: if you enter 'No reason provided'
(definition) as reason but the system is expecting 'Not
provided' (code), that is why the reason was not properly
translated. If you enter 'Reason Code' and try again that works
as expected.
• You can send the ordered_quantity as a negative on the line record and the line
will be treated/created as an RMA line.
Creation of a Referenced RMA (if you want to return an existing outbound line)
If you create a referenced RMA, you should copy the Header Record for the return from
the referenced Order header record, modifying the Order Type to category RETURN or
MIXED (order_type_id from oe_transaction_types_all).
For the Order Line record, populate the following attributes only:
line_category_code: RETURN
1. return_context: ORDER
2. return_attribute1: header_id from the referenced order.
3. return_attribute2: line_id from the referenced order line.
4. calculate_price_flag: Set it to P if you want to retain the original price, the flag to Y
if you want to reprice the RMA line.
5. line_type_id: Assign a line_type_id from RMA line. Line_type _id is optional,

provided a default line_type has been defined for the specified Order Line Type.)
6. return_reason_code: Populate a reason code from lookup_type

CREDIT_MEMO_REASON
7. For sales credit info please populate the header_level/line level sales credits details
from the referenced order.
Import Types
The following enable you to import orders of various kinds.
Configurations
Order Management enables you to import ATO and PTO configurations. For EDI
orders, you can import valid and invalid configurations; however, you will not be able
to book orders with invalid configurations. Top model line reference needs to be
populated for all lines including the model.
Note: If the same option appears more than twice in the BOM of the
model, the component_code is used in the interface table to resolve the
ambiguity. If only the option line is sent without a class line, then the
system will derive and populate the class lines in the order.
Changes
You can import changes to orders that have been imported by passing all changed data
through Order Import. You can update or delete orders, order lines, price adjustments,
and sales credits. You can use change sequence numbers to control the sequence of
changes you want to make to orders. You can also split lines using Order Import.
Order Status
You can import new, booked, cancelled or closed orders. If an order is imported with an
entry status of Booked (OE_HEADERS_IFACE_ALL.BOOKED_FLAG=Y) the result
after import is that a Action Request of BOOK_ORDER is initiated. You may also pass
the Action Request to BOOK_ORDER; both methods are supported.
Order Import ensures that all required fields for entry or booking are validated
appropriately as the orders are imported. Order Import imports the order in as Entered
and attempts to book it. If any of the required fields for a booked order are not
supplied, Order Management retains the order in the Entered status and notifies you of
the error.
Line Sets
You can import grouped order lines, called sets, based on certain common attributes for
a new or existing order. You can also add a line to an existing set. You will need to
provide the set ID or name in the Order Import tables. If that set already exists, the line
will be included in the set. However, if the set does not already exist, a new set will be
created and the line will be added to the set. In addition, if any line attribute, which is
also a set attribute, does not match with the set attribute value, the set attribute value
will overwrite the line attribute.
Fulfillment Set Functionality Support for Order Import

Order Import functionality supports addition, removal, and moving lines to multiple
fulfillment sets. This can be achieved by populating the Actions table with
corresponding action code.
User Procedures
• Populate the Order Import Header Interface tables with Header Information
• Populate the Order Import Line Interface tables with Line Information
• There are three requirements Add the line to a Specified fulfillment Set (ADD) and
Remove the line from specified fulfillment Set (REMOVE) and Move the line to
new fulfillment set.
• Populate the Actions Interface table with Action code and Fulfillment set Name.
Consider the following example.

• There are two lines in table OE_ORDER_LINES_ALL with the lines in fulfillment
sets as shown.
Example 1
Line_id Fulfillment Set
1000 F1
2000 F2, F3
For adding, removing and moving lines from multiple fulfillment the following steps
can achieve sets.
Populate Order Import Lines Interface Table.

Example 2
Orig_Sys_line_Ref Operation Code
1000 UPDATE
2000 UPDATE
Populate Order Import Actions Interface Table.
Example 3
For Orig_sys_line_ref Operation Code Fulfillment Set Name
1000 ADD_FULFILLMENT_SET F3
1000 REMOVE_FULFILLMENT_S F1
ET
2000 REMOVE_FULFILLMENT_S F2
ET
After Order import the lines in the Order Lines table OE_ORDER_LINES_ALL
Example 4
Line_Id Fulfillment Set
1000 F3
2000 F3, F4, F5
Workflows
You can import an order within any valid order workflow activity. The order must be at
the initial activity of Entered, Booked, or Closed. Orders imported using Order Import
cannot be in the middle of a workflow activity.
Manual and Automatic Pricing
You can indicate whether you want to manually enter prices for imported orders or
allow Order Management to automatically price the order. You can use automatic
pricing or manual pricing for your imported orders. If you want to use automatic
pricing, you should set the column OE_LINES_INTERFACE.CALCULATE_PRICE_
FLAG to Y, and define all your pricing setup including discounts, promotions,
surcharges, free goods, etc. in Oracle Pricing and Order Management. However, if you
want to use the manual pricing, you should set the column OE_
LINES_INTERFACE.CALCULATE_PRICE_FLAG to N. In this case, you should define
all your discounts as line level, overridable, and not automatic.
Note: Order Import now allows you to import Coupons, Promotions,

Surcharges, and Pricing Attributes.
Pricing Agreements
You can specify an agreement name if you want to order against a specific customer
agreement for an order or order line.
Scheduling
Order Import enables you to reserve orders as they are imported, using the same rules
as online order entry. If the scheduling request is unsuccessful on an imported order,
the order import fails, and the scheduling exceptions can be viewed in the Error
Messages of the Order Import Corrections window. You can use Schedule, Unschedule,
Reserve or Unreserve as values for scheduling actions.
To override the line, Schedule Ship Date or Arrival Date has to be populated on the line
record. The dates populated are based on the Ordered Date Type. If the Ordered Date
Type is 'Ship' then populate the ship date otherwise populate the Arrival Date.
Validations
Process Order API

Process Order is the central application process interface (API) provided by Order
Management to perform all common operations such as inserting, updating, deleting,
and validating an order or order line. The API also performs the scheduling and returns
a promise date. This API is called by Order Import.
Order Import passes one order, with all lines and other entities, at a time to the Process
Order Interface, along with the operations that need to be completed on the order or
line such as, inserting or updating an order or line. Errors at any line or entity level will
cause the order to fail the importing of the entire order. In addition, Order Import
processes only those orders and lines which are not rejected and do not have the
ERROR_FLAG column set to Y from previous processes.

Attachments
Order Management applies any automatic attachments to imported orders that meet
your automatic note criteria based on the setting of the OM: Apply Automatic
Attachments profile option.
Credit Checking
Order Management performs credit checking on all imported orders or changes,
according to the credit checking rules you have defined in Order Management.
Defaulting Rules
You can pass the column value Null to Order Import if you want the defaulting rules to
populate the column. However, if the column is defined as Not Null or Mandatory
column and the defaulting rules fail to default the column, for any reason, Order Import
displays an error message without importing the order.
Holds and Releases

Order Management automatically applies all holds to imported orders and order lines
that meet hold criteria. Order Import allows you to apply holds on imported orders for
review, just as you would for orders entered through the Sales Orders window. You can
also apply holds or release holds using the actions interface table.
Price Comparisons
Order Import performs a price comparison on your imported orders. For example, if
you provide a selling price and also want the system to calculate a price, Order Import
warns you of the differences, if any, between the two prices as discrepancies. The
warning can be viewed in the Error Message window of the Order Import Corrections
window.
If there is a difference between your selling price and the system calculated price, Order
Import raises a warning of the difference. Order Import saves your customer-provided
value for the selling price in a column on the order line table, so you can have visibility
to what your customer sent in.
Note: You cannot copy or interface an order line having a price list with
a currency code different from the existing or newly created order
header's currency code. If you click the Error button, error messages are
displayed.
Payment Term Comparison

Order Import performs payment term comparisons. If there is a difference between
your payment terms, Order Import raises a warning of the difference. Order Import
saves your customer-provided value for payment terms in a column on the order line
table so that you can have visibility to what your customer sent in.
Processing Constraints
Order Import checks the processing constraints you have defined in Order Management
to assure that any operation such as insert, update, cancel, split and delete are
acceptable by your security standards. Order Import displays an error message if it
encounters a processing constraint that has been violated.
Corrected Data
Once the data is corrected, the ERROR_FLAG for the record is updated to N. You can
set the REJECT_FLAG to Y for headers and line in case your data cannot be corrected by
using the Order Import Corrections window.
Order Import Statistics Concurrent Program

The Order Import Statistics concurrent program performs a table analysis of all
interface tables related to Order Import for determining optimum record processing
should the Order Import concurrent program be submitted. You can choose to submit
this program (or not) prior to each submission of the Order Import concurrent program.
If you normally process a similar number of interface records, you typically do not need
to submit this program prior to submitting the Order Import concurrent program.
There are no parameters for the submission of the Order Import Statistics concurrent
program. See: Oracle Order Management User's Guide, Order Import Statistics Concurrent
Program
Request Submission
You can submit a request by selecting Order Import Request. You can run the Order
Import process in the validation-only mode.
This mode allows the transaction to be validated against all the Order Management
rules but not pass valid transactions to the base Order Management tables. If you
choose you can run production transactions in validation-only mode for a preview of
exceptions. Make necessary corrections to the transactions in the Order Import window,
then choose the Validate button to perform a validation check. The validation-only
mode may also facilitate testing of transactions through Order Import even in a
production environment to take advantage of all the setup is the production
environment.
Parameters
The Order Import program provides the following parameters:
• Operating Unit
By default Order Import processes records with no Org ID specified, when you run
Order Import and specify your default Operating Unit or if the Operating Unit
parameter is left blank. The records will be processed for your default Operating
Unit. However Order Import is more efficient if you explicitly populate the Org ID
on the interface table records and set the hidden parameter Process Orders with no

Org specified for the concurrent program to No (using the Application Developer
responsibility).
If you always specify the Org ID on your interface table records then you should set
the hidden parameter Process Orders with no Org specified for the concurrent
program to No (using the Application Developer responsibility).
• Order Source
Choose a specific Order Import source that you have defined in the Order Import
Sources window so that only records with that source are processed, or leave this
parameter blank so that all enabled sources are processed for data existing in the
interface tables.
• Order References
You can enter the System Document Reference if you want to run Order Import for
a specific order.
• Validate Only (Yes/No)

Choose whether to validate only the data in the interface tables. If Yes, the order
will be validated, but not imported into the base orders tables. The default value is
No. In the Order Import Concurrent Program window, the "Instances" parameter is
also displayed. This parameter determines the maximum number of child processes
you wish Order Import to spawn.
• Validate Descriptive Flex fields (Yes/No)

If the value selected is Yes then the flexfields will be validated; if the value of the
parameter is No then flexfields will not be validated.
Purge Open Interface Data Concurrent Program

The Purge Open Interface Data concurrent program allows you to delete records that
are no longer required from the interface tables.
Parameters
The Order Import program provides the following parameters:
• View Name (required)
Choose a view to be purged. When you choose a particular view, any child views
are automatically purged. For instance, if you select Headers Interface, all the child
records of the deleted Headers Interface records from the Lines Interface will also
be purged. Note that this concurrent program can also be used to purge
Acknowledgment or Open Interface Tracking data.
• Customer Number
You can optionally specify a Customer Number so that only records with the
Sold_To_Org_Id or Sold_To_Org corresponding to the Customer Number are
deleted.
• Order Source
You can optionally specify an Order Import source that you have defined in the
Order Import Sources window so that only records with that source are deleted.
• Order Reference To/Order Reference From

You can optionally enter a System Document Reference range so that only records
with order references within that range are deleted.
Order Import Corrections Window

The Order Import Corrections window consists of the Find and Summary windows.
The Find window allows you to find orders to be imported based on certain attributes
such as Operating Unit ID, Request ID, Order Source, Original System Document
Reference, Sold To Org ID, and Change Sequence. The Operating Unit ID field shows
your default operating unit. If you specify a value for Operating Unit, your search will
be restricted to the specified operating unit.
The Summary window displays order headers, lines, sales credits, price adjustments, lot
serials, payments, reservations and action requests information. You can enable or
disable the display of columns in the window using the folder functionality
The Order Import window displays all orders or selected orders based on the criteria
given in the Find window. You can modify the orders here. The orders that have errors
display in red.
You can insert, update, and delete the orders and lines in the interface tables. You can
update one or multiple orders or lines at the same time through the Summary window.
You can also mark an order or a line to be rejected by setting the REJECTED flag. There
are separate windows for the header and line level data. These windows have related
fields grouped as tabs.
Buttons
• Lines: Displays line level information for orders.
• Discounts: Displays discount information for orders.
• Validate: Validates the data but does not import it. Only the selected orders will be
validated and performed online.
• Import: Imports the orders. The data is validated before being imported. If an error
is encountered while importing, the order will be rejected and the error messages
can be viewed by choosing the Errors button. Only the selected orders will be
imported and the import is performed online. If an order is successfully imported, it
also gets deleted from the interface tables. If you attempt to re-query the window,

you will not be able to view that order in the Order Import Corrections window.
• Errors: Displays all the errors encountered while importing. The error messages are
stored context sensitive. If you choose the Errors button from the Order Headers
region, all the errors for that order are displayed. If you choose the Errors button
from the Lines region, all the errors are displayed for that line. If you encountered
errors while importing orders, you can also fix these errors in the window and try
importing the order again. You can navigate from the Errors window to the Order
Headers or Lines region where the error has occurred.
• Actions: Displays order actions for orders.
• Sales Credits: Displays sales credit information for orders.
• Add Customer: To add new Customer and Address during the Import process.
• Pricing Attributes: To add Pricing Attributes for Order/Line.
• Payments: To add payments details for orders.
Processing Results
Each time you run Order Import, Order Management automatically generates an Order
Import processing results summary log which identifies the total number of successful
and failed imported orders.
Oracle Order Management Interface Tables and Column Descriptions

Order Import uses the following interface tables during processing:
OE_CUSTOMER_INFO_IFACE_ALL
OE_LINES_IFACE_ALL
OE_PRICE_ADJS_IFACE_ALL
OE_PRICE_ATTS_IFACE_ALL
OE_CREDITS_IFACE_ALL
OE_LOTSERIALS_IFACE_ALL
OE_RESERVTNS_IFACE_ALL
OE_ACTIONS_IFACE_ALL
ONT.OE_PAYMENTS_IFACE_ALL
A table listing for each interface table is provided below.
OE_CUSTOMER_INFO_IFACE_ALL
Column Type Required Conditionally Derived Optio

Name Required for nal
(C = Conditionally Booking
Required)
CUSTOMER_ VARCHAR2(50) Yes

INFO_REF
CURRENT_C NUMBER Yes, if

USTOMER_N Customer_info_Type
UMBER _Code is ADDRESS
or CONTACT and
the corresponding
customer exists
already either
Current_Customer_
Number or
Current_Customer_I
d should be
populated. It must
not be populated if
the corresponding
customer is being
created
simultaneously.
CURRENT_C NUMBER Yes, if

USTOMER_I Customer_info_Type
D _Code is ADDRESS
or CONTACT and
the corresponding
customer exists
already either
Current_Customer_
Number or
Current_Customer_I
d should be
populated. It must
not be populated if
the corresponding
customer is being
created
simultaneously.

Required)
CUSTOMER_ VARCHAR2(30) No (Default value of

TYPE ORGANIZATION
will be used
CUSTOMER_ VARCHAR2(10) Yes

INFO_TYPE_
CODE
PARENT_CU VARCHAR2(50) Yes, if the

STOMER_RE corresponding
F customer is being
created
simultaneously
ORGANIZAT VARCHAR2(30) Yes, if

ION_NAME Customer_Info_Type
_Code is ACCOUNT
and Customer_Type
is ORGANIZATION
PERSON_FIR VARCHAR2(150) Yes, if

ST_NAME Customer_Type_Cod
e is ADDRESS and
Customer_Type is
PERSON
PERSON_MI VARCHAR2(60)
DDLE_NAM
E
PERSON_LA VARCHAR2(150) Yes, if

ST_NAME Customer_Type is
PERSON
PERSON_NA VARCHAR2(30)
ME_SUFFIX
PERSON_TIT VARCHAR2(60)
LE
Required)
CUSTOMER_ NUMBER Populate only if

NUMBER Customer_info_Type
_Code is ACCOUNT
and automatic
numbering is not set
to occur in Accounts
Receivable.
EMAIL_ADD VARCHAR2(2000 Yes, if the Order

RESS ) Management profile
option OM: Email
Required On New
Customer is set to
Yes and
Customer_Info_Type
_Code is ACCOUNT
PARTY_NUM VARCHAR2(30) Yes, if

BER Customer_Info_Type
_Code is ACCOUNT
and the customer
should be added to
an existing party,
populate tis field
with that
party_number. Must
be left null to create
a new party for the
new customer.
PHONE_CO VARCHAR2(10)
UNTRY_COD
E
PHONE_ARE VARCHAR2(10)
A_CODE
PHONE_NU VARCHAR2(40)
MBER
PHONE_EXT VARCHAR2(20)
ENSION

Required)
COUNTRY VARCHAR2(60) Yes, if

Customer_Info_Type
_Code is ADDRESS
ADDRESS1... VARCHAR2(240) Yes, if

ADDRESS4 Customer_Info_Type
_Code is ADDRESS
CITY VARCHAR2(60) Yes, if

Customer_Info_Type
_Code is ADDRESS
POSTAL_CO VARCHAR2(60) Yes, if

DE Customer_Info_Type
_Code is ADDRESS
STATE VARCHAR2(60) Yes, if

Customer_Info_Type
_Code is ADDRESS
PROVINCE VARCHAR2(60)
COUNTY VARCHAR2(60)
IS_SHIP_TO_ VARCHAR2(1) Yes, if

ADDRESS Customer_Info_Type
_Code is ADDRESS
and entering Ship To
Address
IS_BILL_TO_ VARCHAR2(1) Yes, if

ADDRESS Customer_Info_Type
_Code is ADDRESS
and entering Bill To
Address
IS_DELIVER_ VARCHAR2(1) Yes, if

TO_ADDRES Customer_Info_Type
S _Code is ADDRESS
and entering Deliver
To Address
Required)
SITE_NUMBE VARCHAR2(80) Yes, if

R Customer_Info_Type
_Code is ADDRESS
and the customer
should be added to
an existing site,
populate this field
with that
site_number.
LOCATION_ VARCHAR2(40)
NUMBER
NEW_PARTY NUMBER internal use only

_ID
NEW_PARTY NUMBER internal use only

_NUMBER
NEW_ACCO NUMBER internal use only

UNT_ID
NEW_ACCO NUMBER internal use only

UNT_NUMB
ER
NEW_CONT NUMBER internal use only

ACT_ID
NEW_ADDR NUMBER internal use only

ESS_ID_SHIP

ESS_ID_BILL

ESS_ID_DELI
VER
ATTRIBUTE_ VARCHAR2(30)
CATEGORY

Required)
ATTRIBUTE1. VARCHAR2(150)
..24
GLOBAL_AT VARCHAR2(30)
TRIBUTE_CA
TEGORY
GLOBAL_AT VARCHAR2(150)
TRIBUTE1.
..GLOBAL_A
TTRIBUTE20
CREATION_ DATE
DATE
CREATED_B NUMBER
Y
LAST_UPDA DATE
TE_DATE
LAST_UPDA NUMBER
TED_BY
LAST_UPDA NUMBER
TE_LOGIN
REQUEST_ID NUMBER
ERROR_FLA VARCHAR2(1
G
REJECTED_F VARCHAR2(1)
LAG
ORG_ID NUMBER
Table information:
Column Type Descripti Required Conditionall Derived Optional

Name on y Required
(C = for Booking
Conditio
nally
Required
)
ORDER_SO NUMBER REQUIRE

URCE_ID D
ORIG_SYS_ VARCHAR REQUIRE

DOCUMEN 2(50) D
T_REF
CHANGE_S VARCHAR X
EQUENCE 2(50)
CHANGE_ VARCHAR X
REQUEST_ 2(30)
CODE
ORDER_SO VARCHAR C
URCE 2(30)
ORG_ID NUMBER X
HEADER_I NUMBER X
D
ORDER_NU NUMBER X
MBER
VERSION_ NUMBER X
NUMBER
ORDERED_ DATE X
DATE
ORDER_CA VARCHAR
TEGORY 2(30)

Name on y Required
(C = for Booking
Conditio
nally
Required
)
ORDER_TY NUMBER C
PE_ID
ORDER_TY VARCHAR C
PE 2(30)
PRICE_LIST NUMBER C
_ID
PRICE_LIST VARCHAR C
2(30)
CONVERSI NUMBER C
ON_RATE
CONVERSI DATE C
ON_RATE_
DATE
CONVERSI VARCHAR C
ON_TYPE_ 2(30)
CODE
CONVERSI VARCHAR C
ON_TYPE 2(30)
TRANSACT VARCHAR X
IONAL_CU 2(15)
RR_CODE
TRANSACT VARCHAR X
IONAL_CU 2(30)
RR
SALESREP_ NUMBER X
ID
Name on y Required
(C = for Booking
Conditio
nally
Required
)
SALESREP VARCHAR X
2(30)
SALES_CH VARCHAR X
ANNEL_C 2(30)
ODE
RETURN_R VARCHAR C
EASON_CO 2(30)
DE
TAX_POIN VARCHAR For

T_CODE 2(30) future
use only
TAX_POIN VARCHAR X
T 2(30)
TAX_EXEM VARCHAR X
PT_FLAG 2(30)
TAX_EXEM VARCHAR X
PT_NUMBE 2(50)
R
TAX_EXEM VARCHAR C
PT_REASO 2(30)
N_CODE
TAX_EXEM VARCHAR C
PT_REASO 2(30)
N
AGREEME NUMBER X
NT_ID
AGREEME VARCHAR X
NT 2(50)

Name on y Required
(C = for Booking
Conditio
nally
Required
)
INVOICIN NUMBER X
G_RULE_ID
INVOICIN VARCHAR X
G_RULE 2(30)
ACCOUNTI NUMBER X
NG_RULE_I
D
ACCOUNTI VARCHAR X
NG_RULE 2(30)
PAYMENT_ NUMBER X
TERM_ID
PAYMENT_ VARCHAR X
TERM 2(30)
DEMAND_ VARCHAR X
CLASS_CO 2(30)
DE
DEMAND_ VARCHAR X
CLASS 2(30)
SHIPMENT VARCHAR X
_PRIORITY 2(30)
_CODE
SHIPMENT VARCHAR X
_PRIORITY 2(30)
SHIPPING_ VARCHAR X
METHOD_ 2(30)
CODE
Name on y Required
(C = for Booking
Conditio
nally
Required
)
SHIPPING_ VARCHAR X
METHOD 2(30
FREIGHT_C VARCHAR X
ARRIER_C 2(30)
ODE
FREIGHT_T VARCHAR X
ERMS_COD 2(30)
E
FREIGHT_T VARCHAR X
ERMS 2(30)
FOB_POIN VARCHAR X
T_CODE 2(30)
FOB_POIN VARCHAR X
T 2(30)
PARTIAL_S VARCHAR X
HIPMENTS 2(1)
_ALLOWE
D
SHIP_TOLE NUMBER X
RANCE_AB
OVE
SHIP_TOLE NUMBER X
RANCE_BE
LOW
SHIPPING_ VARCHAR X
INSTRUCTI 2(240)
ONS

Name on y Required
(C = for Booking
Conditio
nally
Required
)
PACKING_I VARCHAR X
NSTRUCTI 2(240)
ONS
ORDER_DA VARCHAR X
TE_TYPE_C 2(30)
ODE
EARLIEST_ NUMBER X
SCHEDULE
_LIMIT
LATEST_SC NUMBER X
HEDULE_L
IMIT
CUSTOME VARCHAR X
R_PO_NUM 2(50)
BER
CUSTOME
R_PAYMEN
T_TERM_ID
CUSTOME
R_PAYMEN
T_TERM
PAYMENT_ VARCHAR X
TYPE_COD 2(30)
E
PAYMENT_ NUMBER X
AMOUNT
CHECK_N VARCHAR X
UMBER 2(50)
Name on y Required
(C = for Booking
Conditio
nally
Required
)
CREDIT_C VARCHAR X
ARD_CODE 2(30)
CREDIT_C VARCHAR X
ARD_HOL 2(50)
DER_NAM
E
CREDIT_C VARCHAR X
ARD_NUM 2(50)
BER
CREDIT_C DATE X
ARD_EXPIR
ATION_DA
TE
CREDIT_C VARCHAR X
ARD_APPR 2(50)
OVAL_CO
DE
SOLD_FRO NUMBER C
M_ORG_ID
SOLD_FRO VARCHAR C
M_ORG 2(30)
SOLD_TO_ NUMBER C
ORG_ID
SOLD_TO_ VARCHAR C
ORG 2(30)
SOLD_TO_ NUMBER
PARTY_ID

Name on y Required
(C = for Booking
Conditio
nally
Required
)
SOLD_TO_ VARCHAR
PARTY_NU 2(30)
MBER
SHIP_FRO NUMBER X
M_ORG_ID
SHIP_FRO VARCHAR X
M_ORG 2(30)
SHIP_TO_O NUMBER X
RG_ID
SHIP_TO_O VARCHAR X
RG 2(30)
INVOICE_T NUMBER X
O_ORG_ID
INVOICE_T VARCHAR X
O_ORG 2(30)
DELIVER_T NUMBER X
O_ORG_ID
DELIVER_T VARCHAR X
O_ORG 2(30)
DELIVER_T VARCHAR X
O_CUSTO 2(30)
MER_NUM
BER
DELIVER_T VARCHAR X
O_CUSTO 2(30)
MER
Name on y Required
(C = for Booking
Conditio
nally
Required
)
SOLD_TO_ NUMBER X
CONTACT_
ID
SOLD_TO_ VARCHAR X
CONTACT 2(30)
SHIP_TO_C NUMBER X
ONTACT_I
D
SHIP_TO_C VARCHAR X
ONTACT 2(30)
INVOICE_T NUMBER X
O_CONTA
CT_ID
INVOICE_T VARCHAR X
O_CONTA 2(30)
CT
DELIVER_T NUMBER X
O_CONTA
CT_ID
DELIVER_T VARCHAR X
O_CONTA 2(30)
CT
CUSTOME NUMBER X
R_ID
CUSTOME VARCHAR C
R_NAME 2(30)

Name on y Required
(C = for Booking
Conditio
nally
Required
)
SHIPMENT VARCHAR X
_PRIORITY 2(30)
_CODE_IN
T
SHIP_TO_A VARCHAR C
DDRESS1 2(30)
SHIP_TO_A VARCHAR C
DDRESS2 2(30)
SHIP_TO_A VARCHAR C
DDRESS3 2(30)
SHIP_TO_A VARCHAR C
DDRESS4 2(30)
SHIP_TO_C VARCHAR C
ITY 2(30)
SHIP_TO_C VARCHAR X
ONTACT_F 2(30)
IRST_NAM
E
SHIP_TO_C VARCHAR X
ONTACT_L 2(30)
AST_NAME
SHIP_TO_C VARCHAR C
OUNTY 2(30)
SHIP_TO_C VARCHAR C
USTOMER 2(30)
SHIP_TO_C VARCHAR C
USTOMER_ 2(30)
NUMBER
Name on y Required
(C = for Booking
Conditio
nally
Required
)
SHIP_TO_P VARCHAR C
OSTAL_CO 2(30)
DE
SHIP_TO_P VARCHAR C
ROVINCE 2(30)
SHIP_TO_SI VARCHAR X
TE_INT 2(30)
SHIP_TO_S VARCHAR C
TATE 2(30)
SHIP_TO_C VARCHAR C
OUNTRY 2(30)
INVOICE_A VARCHAR C
DDRESS1 2(35)
INVOICE_A VARCHAR C
DDRESS2 2(35)
INVOICE_A VARCHAR C
DDRESS3 2(35)
INVOICE_A VARCHAR C
DDRESS4 2(35)
INVOICE_C VARCHAR C
ITY 2(30)
INVOICE_C VARCHAR C
OUNTRY 2(20)
INVOICE_C VARCHAR C
OUNTY 2(25)

Name on y Required
(C = for Booking
Conditio
nally
Required
)
INVOICE_C VARCHAR C
USTOMER 2(60)
INVOICE_C VARCHAR C
USTOMER_ 2(30)
NUMBER
INVOICE_P VARCHAR C
OSTAL_CO 2(15)
DE
INVOICE_P VARCHAR C
ROVINCE_I 2(30)
NT
INVOICE_S VARCHAR X
ITE 2(30)
INVOICE_S VARCHAR X
ITE_CODE 2(30)
INVOICE_S VARCHAR C
TATE 2(30)
INVOICE_T VARCHAR X
O_CONTA 2(30)
CT_FIRST_
NAME
INVOICE_T VARCHAR X
O_CONTA 2(30)
CT_LAST_
NAME
ORDERED_ VARCHAR X
BY_CONTA 2(30)
CT_FIRST_
NAME
Name on y Required
(C = for Booking
Conditio
nally
Required
)
ORDERED_ VARCHAR X
BY_CONTA 2(30)
CT_LAST_
NAME
DROP_SHI VARCHAR X
P_FLAG 2(1)
BOOKED_F VARCHAR X
LAG 2(1)
CLOSED_F VARCHAR X
LAG 2(1)
CANCELLE VARCHAR X
D_FLAG 2(1)
REJECTED_ VARCHAR X
FLAG 2(1)
CONTEXT VARCHAR X
2(30)
ATTRIBUTE VARCHAR X
1..20 2(240)
HEADER_P VARCHAR X
O_CONTEX 2(30)
T
PO_ATTRIB VARCHAR X
UTE_1..20 2(240)
PO_REVISI DATE X
ON_DATE

Name on y Required
(C = for Booking
Conditio
nally
Required
)
GLOBAL_A VARCHAR X
TTRIBUTE_ 2(30)
CATEGORY
GLOBAL_A VARCHAR X
TTRIBUTE1. 2(240)
.20
CREATED_ NUMBER REQUIRE

BY D
CREATION DATE REQUIRE

_DATE D
LAST_UPD NUMBER REQUIRE

ATED_BY D
LAST_UPD DATE REQUIRE

ATE_DATE D
LAST_UPD NUMBER X
ATE_LOGI
N
PROGRAM NUMBER X
_APPLICAT
ION_ID
PROGRAM NUMBER X
_ID
PROGRAM DATE X
_UPDATE_
DATE
REQUEST_I NUMBER X
D
Name on y Required
(C = for Booking
Conditio
nally
Required
)
REQUEST_ DATE X
DATE
SUBMISSIO DATE X
N_DATETI
ME
OPERATIO VARCHAR REQUIRE

N_CODE 2(30) D
ERROR_FL VARCHAR X
AG 2(1)
READY_FL VARCHAR X
AG 2(1)
STATUS_FL VARCHAR X
AG 2(1)
FORCE_AP VARCHAR X
PLY_FLAG 2(1)
CHANGE_ VARCHAR X
REASON 2(30)
CHANGE_ VARCHAR X
COMMENT 2(200)
S
TP_CONTE VARCHAR X
XT 2(30)
TP_ATTRIB VARCHAR X
UTE1..20 2(240)
BLANKET_ NUMBER
NUMBER

Name on y Required
(C = for Booking
Conditio
nally
Required
)
ORIG_SYS_ Varchar2(50 Yes, if the

CUSTOME ) customer
R_REF is being
created as
Sold To
for the
order
being
imported
ORIG_SHIP Varchar2(50 Yes, if

_ADDRESS ) Ship_To
_REF Address
is being
added for
a
customer.
ORIG_BILL Varchar2(50 Yes, if

_ADDRESS ) Bill_To
_REF Address
is being
added for
a
customer
ORIG_DELI Varchar2(50 Yes, if

VER_ADDR ) Deliver_T
ESS_REF o
Address
is being
added for
a
customer
Name on y Required
(C = for Booking
Conditio
nally
Required
)
SOLD_TO_ Varchar2(50 Yes, if

CONTACT_ ) Sold_To_
REF Contact is
being
added for
a
customer
SHIP_TO_C Varchar2(50 Yes, if

ONTACT_R ) Ship_To_
EF Contact is
being
added for
a
customer
BILL_TO_C Varchar2(50 Yes, if

ONTACT_R ) Bill_To_C
EF ontact is
being
added for
a
customer
DELIVER_T Varchar2(50 Yes, if

O_CONTA ) Deliver_T
CT_REF o_Contact
is being
added for
a
customer
XML_MESS Varchar2(30 X
AGE_ID )
XML_TRAN X
SACTION_
varchar2(30)
TYPE_COD
E

Name on y Required
(C = for Booking
Conditio
nally
Required
)
TRANSACT Varchar2(30 X
ION_PHAS )
E_CODE
SALES_DO Varchar2(24 X
CUMENT_ 0)
NAME
QUOTE_N Number X
UMBER
QUOTE_D Date X
ATE
USER_STAT Varchar2(30 X
US_CODE )
EXPIRATIO Date X
N_DATE
END_CUST VARCHAR X
OMER_NA 2(360)
ME
END_CUST VARCHAR X
OMER_NU 2(50)
MBER
END_CUST VARCHAR X
OMER_PAR 2(30)
TY_NUMBE
R
END_CUST NUMBER X
OMER_ID
Name on y Required
(C = for Booking
Conditio
nally
Required
)
END_CUST NUMBER X
OMER_PAR
TY_ID
END_CUST NUMBER X
OMER_OR
G_CONTA
CT_ID
END_CUST NUMBER X
OMER_CO
NTACT_ID
END_CUST VARCHAR X
OMER_CO 2(360)
NTACT
END_CUST VARCHAR X
OMER_LOC 2(240)
ATION
END_CUST NUMBER X
OMER_SITE
_USE_ID
END_CUST NUMBER X
OMER_PAR
TY_SITE_ID
END_CUST NUMBER X
OMER_PAR
TY_SITE_U
SE_ID
END_CUST VARCHAR X
OMER_AD 2(240)
DRESS1

Name on y Required
(C = for Booking
Conditio
nally
Required
)
END_CUST VARCHAR X
OMER_AD 2(240)
DRESS2
END_CUST VARCHAR X
OMER_AD 2(240)
DRESS3
END_CUST VARCHAR X
OMER_AD 2(240)
DRESS4
END_CUST VARCHAR X
OMER_CIT 2(60)
Y
END_CUST VARCHAR X
OMER_STA 2(60)
TE
END_CUST VARCHAR X
OMER_POS 2(60)
TAL_CODE
END_CUST VARCHAR X
OMER_CO 2(60)
UNTRY
END_CUST VARCHAR X
OMER_PRO 2(60)
VINCE
END_CUST VARCHAR X
OMER_CO 2(60)
UNTY
IB_OWNER VARCHAR X
2(60)
Name on y Required
(C = for Booking
Conditio
nally
Required
)
IB_OWNER VARCHAR X
_CODE 2(30)
IB_CURRE VARCHAR X
NT_LOCAT 2(60)
ION
IB_CURRE VARCHAR X
NT_LOCAT 2(30)
ION_CODE
IB_INSTAL VARCHAR X
LED_AT_L 2(60)
OCATION
IB_INSTAL VARCHAR X
LED_AT_L 2(30)
OCATION_
CODE
SOLD_TO_ NUMBER X
PARTY_ID
SOLD_TO_ NUMBER X
ORG_CON
TACT_ID
SHIP_TO_P NUMBER X
ARTY_ID
SHIP_TO_P NUMBER X
ARTY_SITE
_ID
SHIP_TO_P NUMBER X
ARTY_SITE
_USE_ID

Name on y Required
(C = for Booking
Conditio
nally
Required
)
DELIVER_T NUMBER X
O_PARTY_I
D
DELIVER_T NUMBER X
O_PARTY_
SITE_ID
DELIVER_T NUMBER X
O_PARTY_
SITE_USE_I
D
INVOICE_T NUMBER X
O_PARTY_I
D
INVOICE_T NUMBER X
O_PARTY_
SITE_ID
INVOICE_T NUMBER X
O_PARTY_
SITE_USE_I
D
SHIP_TO_O NUMBER X
RG_CONT
ACT_ID
DELIVER_T NUMBER X
O_ORG_CO
NTACT_ID
INVOICE_T NUMBER X
O_ORG_CO
NTACT_ID
Name on y Required
(C = for Booking
Conditio
nally
Required
)
SOLD_TO_ VARCHAR X
PARTY_NU 2(30)
MBER
SHIP_TO_P VARCHAR X
ARTY_NU 2(30)
MBER
INVOICE_T VARCHAR X
O_PARTY_ 2(30)
NUMBER
DELIVER_T VARCHAR X
O_PARTY_ 2(30)
NUMBER
OE_HEADERS_IFACE_ALL Derived Values

• TRANSACTIONAL_CURR_CODE = FND_CURRENCIES.CURRENCY_CODE
• SOLD_FROM_ORG_ID =
HR_ALL_ORGANIZATION_UNITS.ORGANIZATION_ID
• ACCOUNTING_RULE_ID = RA_RULES.RULE_ID
• INVOICING_RULE_ID = RA_RULES.RULE_ID
• SALESREP_ID = RA_SALESREPS_ALL.SALESREP_ID
• SALESREP = RA_SALESREPS_ALL.NAME
• PAYMENT_TERM_ID = RA_TERMS_B.TERM_ID
• CUSTOMER_PAYMENT_TERM_ID = RA_TERMS_B.TERM_ID
• PAYMENT_TERM = RA_TERMS_TL.NAME
• CUSTOMER_PAYMENT_TERM = RA_TERMS_TL.NAME

• AGREEMENT_ID = OE_AGREEMENTS_B.AGREEMENT_ID
• ORDER_SOURCE_ID = OE_ORDER_SOURCES.ORDER_SOURCE_ID
• HEADER_ID = OE_ORDER_HEADERS_ALL.HEADER_ID
• PRICE_LIST_ID = QP_LIST_HEADERS_TL.LIST_HEADER_ID
• PRICE_LIST = QP_LIST_HEADERS_TL.NAME
OE_HEADERS_IFACE_ALL Conditional Settings
Column Name Conditional Setting requirement
ORDER_SOURCE_ID Condition is that either one of the columns

should be populated
ORDER_SOURCE
ORDER_TYPE_ID Condition is that either one of the columns

should be populated
ORDER_TYPE
CONVERSION_RATE Condition is that either one of the columns

should be populated
CONVERSION_RATE_DATE
CONVERSION_TYPE_CODE Condition is that either one of the columns

should be populated
CONVERSION_TYPE
TAX_EXEMPT_REASON_CODE Condition is that either one of the columns

should be populated
TAX_EXEMPT_REASON
RETURN_REASON_CODE Required for returns only
PRICE_LIST_ID Condition is that either one of the columns

should be populated
PRICE_LIST
SOLD_FROM_ORG_ID Condition is that either one of the columns

should be populated
SOLD_FROM_ORG
SOLD_TO_ORG_ID Condition is that Sold_To_Org_ID and

Customer_Name are required.
SOLD_TO_ORG
CUSTOMER_NAME
SHIP_TO_ADDRESS1..4 These columns or Ship_to_Org_id should be

provided
SHIP_TO_CITY
SHIP_TO_COUNTY
SHIP_TO_CUSTOMER
SHIP_TO_CUSTOMER_NUMBER
SHIP_TO_POSTAL_CODE
SHIP_TO_PROVINCE
SHIP_TO_SITE_INT
SHIP_TO_STATE
SHIP_TO_COUNTRY
INVOICE_ADDRESS1..4 These columns or Invoice_To_Org_id should

be provided.
INVOICE_CITY
INVOICE_COUNTRY
INVOICE_COUNTY
INVOICE_CUSTOMER
INVOICE_CUSTOMER_NUMBER
INVOICE_POSTAL_CODE
INVOICE_PROVINCE_INT
INVOICE_STATE

DELIVER_TO_ADDRESS1..4 These columns or Deliver_To_Org_id should

be provided.
DELIVER_TO_CITY
DELIVER_TO_COUNTRY
DELIVER_TO_COUNTY
DELIVER_TO_CUSTOMER
DELIVER_TO_CUSTOMER_NUMBER
DELIVER_TO_POSTAL_CODE
DELIVER_TO_PROVINCE_INT
DELIVER_TO_STATE
Note: Attribute columns are for customer use only and will NEVER
be used by Oracle Development as a means to enable any type of
system functionality.
Table:
OE_LINES_IFACE_ALL
Column Type Descriptio Required Condition Derived Optional

n ally
Name (C = Required
Condition for
ally Booking
Required)
ORDER_S NUMBER REQUIRE

OURCE_ID D
ORIG_SYS VARCHAR REQUIRE

_DOCUME 2(50) D
NT_REF

_LINE_RE 2(50) D
F
n ally
Name (C = Required
Condition for
ally Booking
Required)

_SHIPMEN 2(50) D
T_REF
CHANGE_ VARCHAR X
SEQUENC 2(50)
E
CHANGE_ VARCHAR X
REQUEST_ 2(30)
CODE
ORG_ID NUMBER X
LINE_NU NUMBER X
MBER
SHIPMEN NUMBER X
T_NUMBE
R
LINE_ID NUMBER X
SPLIT_FR NUMBER X
OM_LINE_
ID
LINE_TYP NUMBER X
E_ID
LINE_TYP VARCHAR X
E 2(30)
ITEM_TYP VARCHAR X X
E_CODE 2(30)
INVENTO NUMBER C
RY_ITEM_I
D

n ally
Name (C = Required
Condition for
ally Booking
Required)
INVENTO VARCHAR REQUIRE

RY_ITEM 2(30) D
TOP_MOD VARCHAR C
EL_LINE_ 2(50)
REF
LINK_TO_ VARCHAR C
LINE_REF 2(50)
EXPLOSIO DATE X
N_DATE
ATO_LINE NUMBER X
_ID
COMPON NUMBER X
ENT_SEQ
UENCE_ID
COMPON VARCHAR X X
ENT_COD 2(50)
E
SORT_OR VARCHAR X
DER 2(240)
MODEL_G NUMBER X
ROUP_NU
MBER
OPTION_ NUMBER X
NUMBER
OPTION_F VARCHAR X
LAG 2(1)
n ally
Name (C = Required
Condition for
ally Booking
Required)
SHIP_MO VARCHAR X
DEL_COM 2(1)
PLETE_FL
AG
SOURCE_T VARCHAR X
YPE_COD 2(30)
E
SCHEDUL VARCHAR C
E_STATUS 2(30)
_CODE
SCHEDUL DATE C
E_SHIP_D
ATE
SCHEDUL DATE C
E_ARRIVA
L_DATE
ACTUAL_ DATE X
ARRIVAL_
DATE
REQUEST_ DATE REQUIRE

DATE D
PROMISE_ DATE C X
DATE
SCHEDUL DATE X
E_DATE
DELIVERY NUMBER REQUIRE

_LEAD_TI D
ME

n ally
Name (C = Required
Condition for
ally Booking
Required)
DELIVERY NUMBER REQUIRE

_ID D
ORDERED NUMBER REQUIRE

_QUANTI D
TY
ORDER_Q VARCHAR REQUIRE

UANTITY_ 2(3) D
UOM
SHIPPING NUMBER C
_QUANTI
TY
SHIPPING VARCHAR C
_QUANTI 2(3)
TY_UOM
SHIPPED_ NUMBER C
QUANTIT
Y
CANCELL NUMBER C
ED_QUAN
TITY
FULFILLE NUMBER C
D_QUANT
ITY
PRICING_ NUMBER C
QUANTIT
Y
PRICING_ VARCHAR C
QUANTIT 2(3)
Y_UOM
n ally
Name (C = Required
Condition for
ally Booking
Required)
SOLD_FR NUMBER C
OM_ORG_
ID
SOLD_FR VARCHAR C
OM_ORG 2(30)
SOLD_TO_ NUMBER C
ORG_ID
SOLD_TO_ VARCHAR C
ORG 2(30)
SHIP_FRO NUMBER X
M_ORG_I
D
SHIP_FRO VARCHAR X
M_ORG 2(30)
SHIP_TO_ NUMBER X
ORG_ID
SHIP_TO_ VARCHAR X
ORG 2(30)
DELIVER_ NUMBER X
TO_ORG_I
D
DELIVER_ VARCHAR X
TO_ORG 2(30)
INVOICE_ NUMBER C
TO_ORG_I
D
INVOICE_ VARCHAR C
TO_ORG 2(30)

n ally
Name (C = Required
Condition for
ally Booking
Required)
SHIP_TO_ VARCHAR C
ADDRESS1 2(30)
SHIP_TO_ VARCHAR C
ADDRESS2 2(30)
SHIP_TO_ VARCHAR C
ADDRESS3 2(30)
SHIP_TO_ VARCHAR C
ADDRESS4 2(30)
SHIP_TO_ VARCHAR C
CITY 2(30)
SHIP_TO_ VARCHAR C
COUNTY 2(30)
SHIP_TO_ VARCHAR C
STATE 2(30)
SHIP_TO_ VARCHAR C
POSTAL_C 2(30)
ODE
SHIP_TO_ VARCHAR C
COUNTRY 2(30)
SHIP_TO_ VARCHAR X
CONTACT 2(30)
_FIRST_N
AME
SHIP_TO_ VARCHAR X
CONTACT 2(30)
_LAST_NA
ME
n ally
Name (C = Required
Condition for
ally Booking
Required)
SHIP_TO_ VARCHAR X
CONTACT 2(30)
_JOB_TITL
E
SHIP_TO_ VARCHAR X
CONTACT 2(10)
_AREA_C
ODE1
SHIP_TO_ VARCHAR X
CONTACT 2(10)
_AREA_C
ODE2
SHIP_TO_ VARCHAR X
CONTACT 2(10)
_AREA_C
ODE3
SHIP_TO_ NUMBER X
CONTACT
_ID
SHIP_TO_ VARCHAR X
CONTACT 2(30)
DELIVER_ NUMBER X
TO_CONT
ACT_ID
DELIVER_ VARCHAR X
TO_CONT 2(30)
ACT
INVOICE_ NUMBER X
TO_CONT
ACT_ID

n ally
Name (C = Required
Condition for
ally Booking
Required)
INVOICE_ VARCHAR X
TO_CONT 2(30)
ACT
DROP_SHI VARCHAR X
P_FLAG 2(1)
VEH_CUS_ NUMBER X
ITEM_CU
M_KEY_ID
CUST_PRO NUMBER X
DUCTION
_SEQ_NU
M
LOAD_SE NUMBER X
Q_NUMBE
R
OVER_SHI VARCHAR X
P_REASO 2(30)
N_CODE
OVER_SHI VARCHAR X
P_RESOLV 2(1)
ED_FLAG
AUTHORI VARCHAR X
ZED_TO_S 2(1)
HIP_FLAG
SHIP_TOL NUMBER X
ERANCE_
ABOVE
SHIP_TOL NUMBER X
ERANCE_
BELOW
n ally
Name (C = Required
Condition for
ally Booking
Required)
SHIP_SET_ NUMBER X
ID
SHIP_SET_ VARCHAR X
NAME 2(30)
ARRIVAL_ NUMBER X
SET_ID
ARRIVAL_ VARCHAR X
SET_NAM 2(30)
E
INVOICE_ NUMBER X
SET_ID
INVOICE_ VARCHAR X
SET_NAM 2(30)
E
FULFILLM NUMBER X
ENT_SET_I
D
FULFILLM VARCHAR X
ENT_SET_ 2(30)
NAME
PRICE_LIS NUMBER C
T_ID
PRICE_LIS VARCHAR C
T 2(30)
PRICING_ DATE C
DATE
UNIT_LIST NUMBER C
_PRICE

n ally
Name (C = Required
Condition for
ally Booking
Required)
UNIT_LIST NUMBER
_PRICE_PE
R_PQTY
UNIT_SEL NUMBER C
LING_PRI
CE
UNIT_SEL NUMBER
LING_PRI
CE_PQTY
CALCULA VARCHAR X
TE_PRICE_ 2(1)
FLAG
TAX_COD VARCHAR X
E 2(50)
TAX VARCHAR X
2(50)
TAX_VAL NUMBER X
UE
TAX_DAT DATE X
E
TAX_POIN VARCHAR For future

T_CODE 2(30) use
TAX_POIN VARCHAR X
T 2(30)
TAX_EXE VARCHAR X
MPT_FLA 2(30)
G
n ally
Name (C = Required
Condition for
ally Booking
Required)
TAX_EXE VARCHAR X
MPT_NU 2(50)
MBER
TAX_EXE VARCHAR X
MPT_REA 2(30)
SON_COD
E
TAX_EXE VARCHAR X
MPT_REA 2(30)
SON
AGREEME NUMBER X
NT_ID
AGREEME VARCHAR X
NT 2(30)
INVOICIN NUMBER C
G_RULE_I
D
INVOICIN VARCHAR C
G_RULE 2(30
ACCOUN NUMBER C
TING_RUL
E_ID
ACCOUN VARCHAR C
TING_RUL 2(30)
E
PAYMENT NUMBER C
_TERM_ID
PAYMENT VARCHAR C
_TERM 2(30)

n ally
Name (C = Required
Condition for
ally Booking
Required)
DEMAND VARCHAR X
_CLASS_C 2(30)
ODE
DEMAND VARCHAR C X
_CLASS 2(30)
SHIPMEN VARCHAR X
T_PRIORIT 2(30)
Y_CODE
SHIPMEN VARCHAR X
T_PRIORIT 2(30)
Y
SHIPPING VARCHAR X
_METHOD 2(30)
_CODE
SHIPPING VARCHAR X
_METHOD 2(30)
SHIPPING VARCHAR X
_INSTRUC 2(240)
TIONS
PACKING VARCHAR X
_INSTRUC 2(240)
TIONS
FREIGHT_ VARCHAR X
CARRIER_ 2(30)
CODE
FREIGHT_ VARCHAR X
TERMS_C 2(30)
ODE
n ally
Name (C = Required
Condition for
ally Booking
Required)
FREIGHT_ VARCHAR X
TERMS 2(30)
FOB_POIN VARCHAR X
T_CODE 2(30)
FOB_POIN VARCHAR X
T 2(30)
SALESREP NUMBER X
_ID
SALESREP VARCHAR X
2(30)
RETURN_ VARCHAR C
REASON_ 2(30)
CODE
REFEREN VARCHAR C
CE_TYPE 2(30)
REFEREN NUMBER C
CE_HEAD
ER_ID
REFEREN VARCHAR C
CE_HEAD 2(30)
ER
REFEREN NUMBER C
CE_LINE_I
D
REFEREN VARCHAR C
CE_LINE 2(30)

n ally
Name (C = Required
Condition for
ally Booking
Required)
CREDIT_I NUMBER X
NVOICE_L
INE_ID
CUSTOME VARCHAR X
R_PO_NU 2(50)
MBER
CUSTOME VARCHAR X
R_LINE_N 2(50)
UMBER
CUSTOME VARCHAR X
R_SHIPME 2(50)
NT_NUMB
ER
CUSTOME NUMBER X
R_ITEM_I
D
CUSTOME VARCHAR X
R_ITEM_I 2(30)
D_TYPE
CUSTOME VARCHAR X
R_ITEM_N 2(200)
AME
CUSTOME VARCHAR X
R_ITEM_R 2(50)
EVISION
CUSTOME NUMBER X
R_ITEM_N
ET_PRICE
n ally
Name (C = Required
Condition for
ally Booking
Required)
CUSTOME
R_PAYME
NT_TERM
_ID
CUSTOME
R_PAYME
NT_TERM
DEMAND VARCHAR X
_BUCKET_ 2(30)
TYPE_CO
DE
DEMAND VARCHAR X
_BUCKET_ 2(50)
TYPE
SCHEDUL VARCHAR X
E_ITEM_D 2(30)
ETAIL
DEMAND VARCHAR X
_STREAM 2(30)
CUSTOME VARCHAR X
R_DOCK_ 2(30)
CODE
CUSTOME VARCHAR X
R_DOCK 2(50)
CUSTOME VARCHAR X
R_JOB 2(50)
CUSTOME VARCHAR X
R_PRODU 2(50)
CTION_LI
NE

n ally
Name (C = Required
Condition for
ally Booking
Required)
CUST_MO VARCHAR X
DEL_SERI 2(50)
AL_NUMB
ER
PROJECT_I NUMBER X
D
PROJECT VARCHAR X
2(30)
TASK_ID NUMBER X
TASK VARCHAR X
2(30)
END_ITE VARCHAR X
M_UNIT_ 2(30)
NUMBER
ITEM_REV VARCHAR X
ISION 2(3)
SERVICE_ NUMBER C
DURATIO
N
SERVICE_ DATE C
START_D
ATE
SERVICE_ DATE C
END_DAT
E
SERVICE_ VARCHAR C
COTERMI 2(1)
NATE_FL
AG
n ally
Name (C = Required
Condition for
ally Booking
Required)
UNIT_SEL NUMBER X
LING_PER
CENT
UNIT_LIST NUMBER X
_PERCENT
UNIT_PER NUMBER X
CENT_BAS
E_PRICE
SERVICE_ NUMBER X
NUMBER
SERVICED NUMBER X
_LINE_ID
FULFILLE VARCHAR X
D_FLAG 2(1)
CLOSED_F VARCHAR X
LAG 2(1)
CANCELL VARCHAR X
ED_FLAG 2(1)
REJECTED VARCHAR X
_FLAG 2(1)
CONTRAC VARCHAR X
T_PO_NU 2(150)
MBER
LINE_PO_ VARCHAR X
CONTEXT 2(30)
ATTRIBUT VARCHAR X
E1..20 2(240)

n ally
Name (C = Required
Condition for
ally Booking
Required)
INDUSTR VARCHAR X
Y_CONTE 2(30)
XT
INDUSTR VARCHAR X
Y_ATTRIB 2(240)
UTE1..30
PRICING_ VARCHAR X
CONTEXT 2(150)
PRICING_ VARCHAR X
ATTRIBUT 2(240)
E1..10
PRICING_ VARCHAR X
ATTRIBUT 2(240)
E10
GLOBAL_ VARCHAR X
ATTRIBUT 2(30)
E_CATEG
ORY
GLOBAL_ VARCHAR X
ATTRIBUT 2(240)
E1..20
RETURN_ VARCHAR X
ATTRIBUT 2(240)
E1..20
INVENTO VARCHAR X
RY_ITEM_ 2(240)
SEGMENT
_1...20
SERVICE_ VARCHAR X
CONTEXT 2(30)
n ally
Name (C = Required
Condition for
ally Booking
Required)
SERVICE_ VARCHAR X
ATTRIBUT 2(240)
E1..20
CREATED NUMBER REQUIRE

_BY D
CREATIO DATE REQUIRE

N_DATE D
LAST_UPD NUMBER REQUIRE

ATED_BY D
LAST_UPD DATE X
ATE_DAT
E
LAST_UPD NUMBER X
ATE_LOGI
N
PROGRA NUMBER X
M_APPLIC
ATION_ID
PROGRA NUMBER X
M_ID
PROGRA DATE X
M_UPDAT
E_DATE
REQUEST_ NUMBER REQUIRE

ID D
OPERATIO VARCHAR X
N_CODE 2(30)

n ally
Name (C = Required
Condition for
ally Booking
Required)
ERROR_FL VARCHAR X
AG 2(1)
STATUS_F VARCHAR X
LAG 2(1)
CHANGE_ VARCHAR X
REASON 2(30)
CHANGE_ VARCHAR X
COMMEN 2(2000)
TS
CONFIG_ NUMBER X X
HEADER_I
D
CONFIG_R NUMBER X X
EV_NBR
CONFIGU NUMBER X X
RATION_I
D
SERVICE_ VARCHAR X
TXN_REA 2(30)
SON_COD
E
SERVICE_ VARCHAR X
TXN_COM 2(2000)
MENTS
BLANKET NUMBER
_NUMBER
BLANKET NUMBER
_LINE_NU
MBER
n ally
Name (C = Required
Condition for
ally Booking
Required)
OVERRIDE Varchar2(3 No No No Y
_ATP_DAT 0)
E_CODE Conditiona Comment:
l Settings: Based on
Schedule_s the
hip_date, Ordered
Schedule_a Date Type,
rrival_date either of
the dates
should be
populated
to override
the line.
LATE_DE Number No No No Y
MAND_PE
NALTY_F Values
ACTOR should be
greater
than 0.
SHIP_TO_ Varchar2(3
CUSTOME 60)
R_NAME
SHIP_TO_ Varchar2(3
CUSTOME 0)
R_NUMBE
R
INVOICE_ Varchar2(3
TO_CUST 60)
OMER_NA
ME
INVOICE_ Varchar2(3
TO_CUST 0)
OMER_NU
MBER

n ally
Name (C = Required
Condition for
ally Booking
Required)
DELIVER_ Varchar2(3
TO_CUST 60)
OMER_NA
ME
DELIVER_ Varchar2(3
TO_CUST 0)
OMER_NU
MBER
DELIVER_ Varchar2(2
TO_ADDR 40)
ESS1
DELIVER_ Varchar2(2
TO_ADDR 40)
ESS2
DELIVER_ Varchar2(2
TO_ADDR 40)
ESS3
DELIVER_ Varchar2(2
TO_ADDR 40)
ESS4
DELIVER_ Varchar2(6
TO_CITY 0)
DELIVER_ Varchar2(6
TO_COUN 0)
TY
DELIVER_ Varchar2(6
TO_COUN 0)
TRY
DELIVER_ Varchar2(6
TO_STATE 0)
n ally
Name (C = Required
Condition for
ally Booking
Required)
DELIVER_ Varchar2(6
TO_PROVI 0)
NCE
DELIVER_ Varchar2(6
TO_POST 0)
AL_CODE
ORIG_SHI Varchar2(5 Yes, if

P_ADDRE 0) Ship_To_A
SS_REF ddress is
being
added for
the
customer at
the line
level
ORIG_BIL Varchar2(5 Yes, if

L_ADDRE 0) Bill_To_Ad
SS_REF dress is
being
added for
the
customer at
the line
level
ORIG_DEL Varchar2(5 Yes, if

IVER_ADD 0) Deliver_To
RESS_REF _Address is
being
added for
the
customer at
the line
level

n ally
Name (C = Required
Condition for
ally Booking
Required)
SHIP_TO_ Varchar2(5 Yes, if

CONTACT 0) Ship_To_C
_REF ontact is
being
added for
the
customer at
the line
level
BILL_TO_ Varchar2(5 Yes, if

CONTACT 0) Bill_To_Co
_REF ntact is
being
added for
the
customer at
the line
level
DELIVER_ Varchar2(5 Yes, if

TO_CONT 0) Deliver_To
ACT_REF _Contact is
being
added for
the
customer at
the line
level
XML_TRA
NSACTIO
N_TYPE_C
ODE
SHIP_TO_ NUMBER X
PARTY_ID
n ally
Name (C = Required
Condition for
ally Booking
Required)
SHIP_TO_ NUMBER X
PARTY_SI
TE_ID
SHIP_TO_ NUMBER X
PARTY_SI
TE_USE_I
D
DELIVER_ NUMBER X
TO_PART
Y_ID
DELIVER_ NUMBER X
TO_PART
Y_SITE_ID
DELIVER_ NUMBER X
TO_PART
Y_SITE_US
E_ID
INVOICE_ NUMBER X
TO_PART
Y_ID
INVOICE_ NUMBER X
TO_PART
Y_SITE_ID
INVOICE_ NUMBER X
TO_PART
Y_SITE_US
E_ID
SHIP_TO_ NUMBER X
ORG_CON
TACT_ID

n ally
Name (C = Required
Condition for
ally Booking
Required)
DELIVER_ NUMBER X
TO_ORG_
CONTACT
_ID
INVOICE_ NUMBER X
TO_ORG_
CONTACT
_ID
SHIP_TO_ VARCHAR X
PARTY_N 2(30)
UMBER
INVOICE_ VARCHAR X
TO_PART 2(30)
Y_NUMBE
R
DELIVER_ VARCHAR X
TO_PART 2(30)
Y_NUMBE
R
END_CUS VARCHAR X
TOMER_N 2(360)
AME
END_CUS VARCHAR X
TOMER_N 2(50)
UMBER
END_CUS VARCHAR X
TOMER_P 2(30)
ARTY_NU
MBER
n ally
Name (C = Required
Condition for
ally Booking
Required)
END_CUS NUMBER X
TOMER_I
D
END_CUS NUMBER X
TOMER_P
ARTY_ID
END_CUS NUMBER X
TOMER_O
RG_CONT
ACT_ID
END_CUS NUMBER X
TOMER_C
ONTACT_I
D
END_CUS VARCHAR X
TOMER_C 2(360)
ONTACT
END_CUS VARCHAR X
TOMER_L 2(240)
OCATION
END_CUS NUMBER X
TOMER_SI
TE_USE_I
D
END_CUS NUMBER X
TOMER_P
ARTY_SIT
E_ID

n ally
Name (C = Required
Condition for
ally Booking
Required)
END_CUS NUMBER X
TOMER_P
ARTY_SIT
E_USE_ID
END_CUS VARCHAR X
TOMER_A 2(240)
DDRESS1
END_CUS VARCHAR X
TOMER_A 2(240)
DDRESS2
END_CUS VARCHAR X
TOMER_A 2(240)
DDRESS3
END_CUS VARCHAR X
TOMER_A 2(240)
DDRESS4
END_CUS VARCHAR X
TOMER_CI 2(60)
TY
END_CUS VARCHAR X
TOMER_S 2(60)
TATE
END_CUS VARCHAR X
TOMER_P 2(60)
OSTAL_C
ODE
END_CUS VARCHAR X
TOMER_C 2(60)
OUNTRY
n ally
Name (C = Required
Condition for
ally Booking
Required)
END_CUS VARCHAR X
TOMER_P 2(60)
ROVINCE
END_CUS VARCHAR X
TOMER_C 2(60)
OUNTY
IB_OWNE VARCHAR X
R 2(60)
IB_CURRE VARCHAR X
NT_LOCA 2(60)
TION
IB_INSTAL VARCHAR X
LED_AT_L 2(60)
OCATION
IB_OWNE Varchar2(3 Install Base

R_CODE 0) Owner
Identifier
IB_INSTAL Varchar2(3 Install

LED_AT_L 0) Location
OCATION Identifier
_CODE
IB_CURRE Varchar2(3 Install

NT_LOCA 0) Current
TION_CO Location
DE Identifier
OE_LINES_IFACE_ALL Derived Values

• AGREEMENT_ID = OE_AGREEMENTS_TL.AGREEMENT_ID
• SHIP_FROM_ORG_ID =

• SOLD_FROM_ORG_ID =
• ACCOUNTING_RULE_ID = RA_RULES.RULE_ID
• INVOICING_RULE_ID = RA_RULES.RULE_ID
• SALESREP_ID = RA_SALESREPS_ALL.SALESREP_ID
• PRICE_LIST_ID = QP_LIST_HEADERS_TL.LIST_HEADER_ID
• PAYMENT_TERM_ID = RA_TERMS_B.TERM_ID
• CUSTOMER_PAYMENT_TERM_ID = RA_TERMS_B.TERM_ID
• SALESREP = RA_SALESREPS_ALL.NAME
• CUSTOMER_PAYMENT_TERM = RA_TERMS_TL.NAME
• PAYMENT_TERM = RA_TERMS_TL.NAME
• PRICE_LIST = QP_LIST_HEADERS_TL.NAME
• ORIG_SYS_DOCUMENT_REF =
• OE_HEADERS_IFACE_ALL.ORIG_SYS_DOCUMENT_REF
• LINK_TO_LINE_REF = OE_LINES_IFACE_ALL.ORIG_SYS_LINE_REF
• TOP_MODEL_LINE_REF = OE_LINES_IFACE_ALL.ORIG_SYS_LINE_REF
OE_LINES_IFACE_ALL Conditional Settings
INVENTORY_ITEM_ID Condition is that either column should be

populated
INVENTORY_ITEM
TOP_MODEL_LINE_REF Required for model items only
LINK_TO_LINE_REF
SHIPPING_QUANTITY Condition is that both columns should be

populated, if populated since they are not
SHIPPING_QUANTITY_UOM required.
PRICING_QUANTITY Condition is that both columns should be

PRICING_QUANTITY_UOM required.
RETURN_REASON_CODE Only required for returns.
REFERENCE_TYPE Reference_Type should be there to populate

either
REFERENCE_HEADER_ID
reference_header_id/reference_header and
REFERENCE_HEADER reference_line_id/reference_line
REFERENCE_LINE_ID (either id or value column should be
REFERENCE_LINE populated; not both)
SERVICE_DURATION Should be populated only for service items
SERVICE_START_DATE
SERVICE_END_DATE
SERVICE_COTERMINATE_FLAG
SOLD_FROM_ORG_ID Condition is that either column should be

populated
SOLD_FROM_ORG
SOLD_TO_ORG_ID Condition is that either column should be

populated
SOLD_TO_ORG
INVOICE_TO_ ORG_ID Condition is that either column should be

populated
INVOICE_TO_ORG

SHIP_TO_ADDRESS1..4 These columns or Ship_to_Org_id should be

present.
SHIP_TO_CITY
SHIP_TO_COUNTY
SHIP_TO_STATE
SHIP_TO_POSTAL_CODE
SHIP_TO_COUNTRY
PRICE_LIST_ID Condition is that either column should be

populated
PRICE_LIST
ACCOUNTING_RULE_ID Condition is that either column should be

populated
ACCOUNTING_RULE
PAYMENT_TERM_ID Condition is that either column should be

populated
PAYMENT_TERM
DEMAND_CLASS_CODE Condition is that either column should be

DEMAND_CLASS required.
SHIP_TO_CUSTOMER_NAME
SHIP_TO_CUSTOMER_NUMBER
INVOICE_TO_CUSTOMER_NAME
INVOICE_TO_CUSTOMER_NUMBER
DELIVER_TO_CUSTOMER_NAME
DELIVER_TO_CUSTOMER_NUMBER
DELIVER_TO_ADDRESS1
DELIVER_TO_ADDRESS2
DELIVER_TO_ADDRESS3
DELIVER_TO_ADDRESS4
DELIVER_TO_CITY
DELIVER_TO_COUNTY
DELIVER_TO_COUNTRY
DELIVER_TO_STATE
DELIVER_TO_PROVINCE
DELIVER_TO_POSTAL_CODE
Note: Attribute columns are for customer use only and will NEVER
be used by Oracle Development as a means to enable any type of
system functionality.
OE_PRICE_ADJS_IFACE_ALL
Column Type Required Conditionall Derived Optional

Name y Required
(C = for Booking
Conditionall
y Required)
AC_CONTEX VARCHAR2(
T 150)
AC_ATTIBU VARCHAR2(
TE1...15 240)
ATTRIBUTE1 VARCHAR2( X
...15 240)
ADJUSTED_ VARCHAR2( X
AMOUNT )

Name y Required
(C = for Booking
Conditionall
y Required)
ADJUSTED_ VARCHAR2( X
AMOUNT_P )
ER_PQTY
APPLIED_FL VARCHAR2( X
AG 1)
ARITHMETI VARCHAR2( X
C_OPERATO )
R
AUTOMATI VARCHAR2( X
C_FLAG 1)
CHANGE_R VARCHAR2( X
EQUEST_CO 30)
DE
CHANGE_SE VARCHAR2( X
QUENCE 50)
CHANGE_R VARCHAR2(
EASON_CO 30)
DE
CHANGE_R VARCHAR2(
EASON_TEX 2000)
T
CHARGE_SU VARCHAR2(
BTYPE_COD 30)
E
CHARGE_TY VARCHAR2(
PE_CODE 30)
CONTEXT VARCHAR2( X
30)
Name y Required
(C = for Booking
Conditionall
y Required)
COST_ID NUMBER
CREATED_B NUMBER REQUIRED

Y
CREATION_ DATE REQUIRED

DATE
CREDIT_OR_ VARCHAR2(
CHARGE_FL 1)
AG
DISCOUNT_I NUMBER
D
DISCOUNT_ NUMBER
LINE_ID
DISCOUNT_ VARCHAR2(
NAME 30
ERROR_FLA VARCHAR2( X
G 1)
ESTIMATED VARCHAR2(
_FLAG 1)
INC_IN_SAL VARCHAR2(
ES_PERFOR 1)
MANCE
INCLUDE_O VARCHAR2(
N_RETURNS 1)
_FLAG
INTERFACE_ VARCHAR2(
STATUS 1000)

Name y Required
(C = for Booking
Conditionall
y Required)
INVOICED_F VARCHAR2(
LAG 1)
LAST_UPDA DATE REQUIRED

TE_DATE
LAST_UPDA NUMBER X
TE_LOGIN
LAST_UPDA NUMBER REQUIRED

TED_BY
LIST_HEADE NUMBER
R_ID
LIST_LINE_I NUMBER
D
LIST_LINE_ NUMBER
NUMBER
LIST_LINE_T VARCHAR2(
YPE_CODE 30)
LIST_NAME VARCHAR2(
240)
MODIFIED_F VARCHAR2(
ROM 240)
MODIFIED_ VARCHAR2(
TO 240)
MODIFIER_ VARCHAR2(
MECHANIS 30)
M_TYPE_CO
DE
Name y Required
(C = for Booking
Conditionall
y Required)
MODIFIER_ VARCHAR2(
NAME 240)
OPERAND NUMBER
OPERAND_P NUMBER
ER_PQTY
OPERATION VARCHAR2( REQUIRED

_CODE 30)
ORDER_SOU NUMBER
RCE_ID
ORG_ID NUMBER X
ORIG_SYS_D VARCHAR2( REQUIRED

ISCOUNT_R 50)
EF

OCUMENT_ 50)
REF
ORIG_SYS_LI VARCHAR2( Conditional

NE_REF 50) or optional
(Required
only if line
level
adjustment/cr
edit)
ORIG_SYS_S VARCHAR2( OPTIONAL

HIPMENT_R 50)
EF
PARENT_AD NUMBER
JUSTMENT_I
D

Name y Required
(C = for Booking
Conditionall
y Required)
PERCENT NUMBER X
PRICING_PH NUMBER
ASE_ID
PROGRAM_ NUMBER X
APPLICATIO
N_ID
PROGRAM_I NUMBER X
D
PROGRAM_ DATE X
UPDATE_DA
TE
REQUEST_ID NUMBER X
SOLD_TO_O VARCHAR2( X
RG 360)
SOLD_TO_O NUMBER X
RG_ID
STATUS_FL VARCHAR2( X
AG 1)
TAX_CODE VARCHAR2(
50)
UPDATE_AL VARCHAR2(
LOWED 1)
UPDATED_F VARCHAR2(
LAG 1)
VERSION_N VARCHAR2(
UMBER 30)
OE_PRICE_ADJS_IFACE_ALL Derived Values
• ORIG_SYS_DISCOUNT_REF
=OE_ORDER_HEADERS_ALL.ORIG_SYS_DOCUMENT_REF
• ORIG_SYS_LINE_REF = OE_ORDER_LINES_ALL.ORIG_SYS_LINE_REF
• ORIG_SYS_SHIPMENT_REF =
OE_ORDER_LINES_ALL.ORIG_SYS_SHIPMENT_REF
• LIST_HEADER_ID = QP_LIST_HEADERS_B.LIST_HEADER_ID
• LIST_NAME = QP_LIST_HEADERS_TL.NAME
• LIST_LINE_ID = QP_LIST_LINES.LIST_LINE_ID
OE_PRICE_ATTS_IFACE_ALL
Column Type Required Conditiona Derived Optional

Name lly
(C = Conditionally Required
Required) for
Booking
ATTRIBUTE1. VARCHAR2( X
..15 240)
CHANGE_RE VARCHAR2( X
QUEST_COD 30)
E
QUENCE 50)
CONTEXT VARCHAR2( X
30)

Y

DATE

Name lly
Required) for
Booking
CREDIT_OR_ VARCHAR2(
CHARGE_FL 1)
AG
G 1)
FLEX_TITLE
INTERFACE_ VARCHAR2(
STATUS 1000)

TE_DATE
LAST_UPDA NUMBER X
TE_LOGIN

TED_BY

_CODE 30)
ORDER_SOU
RCE_ID
ORG_ID NUMBER X
ORIG_SYS_A VARCHAR2( REQUIRED

TT_REF 50)

OCUMENT_ 50)
REF
Name lly
Required) for
Booking
ORIG_SYS_LI VARCHAR2( Conditional or

NE_REF 50) optional (Required
only if line level
adjustment/credit)
ORIG_SYS_S VARCHAR2( OPTIONAL

HIPMENT_R 50)
EF
PRICING_AT
TIBUTE1...100
PROGRAM_ NUMBER X
APPLICATIO
N_ID
PROGRAM_I NUMBER X
D
PROGRAM_ DATE X
UPDATE_DA
TE
REQUEST_ID NUMBER X
RG 360)
SOLD_TO_O NUMBER X
RG_ID
STATUS_FLA VARCHAR2( X
G 1)
OE_PRICE_ATTS_IFACE_ALL Derived Values


OE_ORDER_HEADERS_ALL.ORIG_SYS_DOCUMENT_REF
OE_CREDITS_IFACE_ALL

y Required
Name (C= for Booking
Conditionall
y Required)
ORDER_SO NUMBER REQUIRED

URCE_ID
ORIG_SYS_ VARCHAR2 REQUIRED

DOCUMEN (50)
T_REF
ORIG_SYS_L VARCHAR2 Conditional

INE_REF (50) or optional
(Required
only if line
level
adjustment/c
redit)
ORIG_SYS_S VARCHAR2 OPTIONAL

HIPMENT_ (50)
REF

CREDIT_RE (50)
F
CHANGE_S VARCHAR2 X
EQUENCE (50)
CHANGE_R VARCHAR2 X
EQUEST_C (30)
ODE
ORG_ID NUMBER X
y Required
Conditionall
y Required)
SALESREP_I NUMBER X
D
SALESREP VARCHAR2 X
(30)
SALES_CRE NUMBER C
DIT_TYPE_I
D
SALES_CRE VARCHAR2 C
DIT_TYPE (30)
SOLD_TO_O VARCHAR2 X
RG (360)
SOLD_TO_O NUMBER X
RG_ID
QUOTA_FL VARCHAR2 X
AG (1)
PERCENT NUMBER REQUIRED
CONTEXT VARCHAR2 X
(30)
ATTRIBUTE VARCHAR2 X
1..15 (240)
CREATED_B NUMBER X
Y
CREATION_ DATE X
DATE
LAST_UPD NUMBER X
ATED_BY

y Required
Conditionall
y Required)
LAST_UPD DATE X
ATE_DATE
LAST_UPD NUMBER X
ATE_LOGIN
PROGRAM_ NUMBER X
APPLICATI
ON_ID
PROGRAM_ NUMBER X
ID
PROGRAM_ DATE X
UPDATE_D
ATE
REQUEST_I NUMBER X
D
OPERATIO VARCHAR2 REQUIRED

N_CODE (30)
ERROR_FLA VARCHAR2 X
G (1)
STATUS_FL VARCHAR2 X
AG (1)
Conditional Settings:
OE_CREDITS_IFACE_ALL Conditional Settings
SALES_CREDIT_TYPE_ID & Condition is that either one these columns

should be populated
SALES_CREDIT_TYPE
OE_CREDITS_IFACE_ALL Derived Values

OE_HEADERS_IFACE_ALL.ORIG_SYS_DOCUMENT_REF
• ORIG_SYS_LINE_REF = OE_LINES_IFACE_ALL.ORIG_SYS_LINE_REF
OE_LINES_IFACE_ALL.ORIG_SYS_SHIPMENT_REF
OE_LOTSERIALS_IFACE_ALL
Column Type Required Conditiona Derive Optional

lly d
Name (C= Conditionally Required
Required) for
Booking
ORDER_SOU NUMBER REQUIRED

RCE_ID

OCUMENT_ 50)
REF
ORIG_SYS_LI VARCHAR2( Conditional or

NE_REF 50) optional (Required
only if line level
adjustment/credit)
ORIG_SYS_S VARCHAR2( OPTIONAL X

HIPMENT_R 50)
EF

lly d
Required) for
Booking
ORIG_SYS_L VARCHAR2( REQUIRED

OTSERIAL_R 50)
EF
QUENCE 50)
CHANGE_RE VARCHAR2( X
QUEST_COD 30)
E
ORG_ID NUMBER X
LOT_NUMBE NUMBER C
R
FROM_SERI VARCHAR2( C
AL_NUMBE 30)
R
TO_SERIAL_ VARCHAR2( C
NUMBER 30)
QUANTITY NUMBER REQUIRED
RG 360)
SOLD_TO_O NUMBER X
RG_ID
CONTEXT VARCHAR2( X
30)
ATTRIBUTE1 VARCHAR2( X
..15 240)
lly d
Required) for
Booking

Y

DATE

TED_BY

TE_DATE

TE_LOGIN
PROGRAM_ NUMBER X
APPLICATIO
N_ID
PROGRAM_I NUMBER X
D
PROGRAM_ DATE X
UPDATE_DA
TE
REQUEST_ID NUMBER X

_CODE 30)
G 1)
STATUS_FLA VARCHAR2( X
G 1)

OE_LOTSERIALS_IFACE_ALL derived Values
OE_ORDER_LINES_ALL.ORIG_SYS_DOCUMENT_REF
OE_RESERVTNS_IFACE_ALL

Required for nal
Name (C= Booking
Conditionally
Required)
ORDER_SO NUMBER REQUIRED

URCE_ID
ORIG_SYS_ VARCHAR2(50) REQUIRED

DOCUMEN
T_REF

LINE_REF
ORIG_SYS_S VARCHAR2(50) X
HIPMENT_
REF

RESERVATI
ON_REF
CHANGE_S VARCHAR2(50) X
EQUENCE
ORG_ID NUMBER X
INVENTOR NUMBER REQUIRED

Y_ITEM_ID
Required for nal
Name (C= Booking
Conditionally
Required)
REVISION VARCHAR2(3) X
LOT_NUMB NUMBER X
ER_ID
LOT_NUMB VARCHAR2(30) X
ER
SOLD_TO_ VARCHAR2(360) X
ORG
SOLD_TO_ NUMBER X
ORG_ID
SUBINVENT NUMBER
ORY_ID
SUBINVENT VARCHAR2(10) X
ORY_CODE
LOCATOR_I NUMBER X
D
QUANTITY NUMBER REQUIRED
ATTRIBUTE VARCHAR2(30) X
_CATEGOR
Y
ATTRIBUTE VARCHAR2(240) X
1..15
OPERATIO VARCHAR2(30) REQUIRED

N_CODE
REQUEST_I NUMBER X
D

Required for nal
Name (C= Booking
Conditionally
Required)
ERROR_FLA VARCHAR2(1) X
G
OE_RESERVTNS_IFACE_ALL Derived Values

OE_ORDER_HEADERS_ALL.ORIG_SYS_DOCUMENT_REF
• INVENTORY_ITEM_ID = MTL_SYSTEM_ITEMS_B.INVENTORY_ITEM_ID
OE_ACTIONS_IFACE_ALL

y Required
Conditionall
y Required)
ORDER_SO NUMBER X
URCE_ID

DOCUMEN (50)
T_REF
ORIG_SYS_L VARCHAR2 X
INE_REF (50)
ORIG_SYS_S VARCHAR2 X
HIPMENT_ (50)
REF
y Required
Conditionall
y Required)
CHANGE_S VARCHAR2 X
EQUENCE (50)
ORG_ID NUMBER X
HOLD_ID NUMBER X
HOLD_TYP VARCHAR2 X
E_CODE (1)
HOLD_TYP NUMBER X
E_ID
HOLD_UNT DATE X
IL_DATE
RELEASE_R VARCHAR2 X
EASON_CO (30)
DE
SOLD_TO_O VARCHAR2 X
RG (360)
SOLD_TO_O NUMBER X
RG_ID
COMMENT VARCHAR2 X
S (240)
CONTEXT VARCHAR2 X
(240)
ATTRIBUTE VARCHAR2 X
1..15 (240)
REQUEST_I NUMBER X
D

y Required
Conditionall
y Required)
OPERATIO VARCHAR2 REQUIRED

N_CODE (30)
ERROR_FLA VARCHAR2 X
G (1)
STATUS_FL VARCHAR2 X
AG (1)
CHAR_PAR VARCHAR2
AM1 (2000)
CHAR_PAR VARCHAR2
AM2 (240)
CHAR_PAR VARCHAR2
AM3 (240)
CHAR_PAR VARCHAR2
AM4 (240)
CHAR_PAR VARCHAR2
AM5 (240)
DATE_PAR DATE
AM1
DATE_PAR DATE
AM2
DATE_PAR DATE
AM3
DATE_PAR DATE
AM4
DATE_PAR DATE
AM5
OE_ACTIONS_IFACE_ALL Derived Values
OE_HEADERS_IFACE_ALL.ORIG_SYS_DOCUMENT_REF
ONT.OE_PAYMENTS_IFACE_ALL
This is a multi-org table for payment records open interface. This table stores payment
information that is imported from a feeder system into Oracle Order Management using
Order Import. You can import a single payment record at the order level using the
existing oe_headers_iface_all.
Note: Note on CREDIT_CARD_APPROVAL_CODE/DATE: An order

can be created with the approval code and date interfaced using order
import. Order Management (OM) will not authorize such order.
Similarly, for data updates on approval code and date, OM will not
validate the data.
ONT.OE_PAYMENTS_IFACE_ALL Table
Name Data Type Length Mandatory Comments
ORDER_SOURC NUMBER NA No Order Source Id

E_ID
TRXN_EXTENSI NUMBER 22 No Transaction

ON_ID Extension ID
INSTRUMENT_ NUMBER 10 No Instrument

SECURITY_CO Security Code
DE
REQUEST_ID NUMBER NA No REQUEST ID
ORIG_SYS_DOC VARCHAR2 50 No Original system

UMENT_REF document
reference

ORIG_SYS_LINE VARCHAR2 50 No Original system
_REF line reference
ORIG_SYS_SHIP VARCHAR2 50 No Original system

MENT_REF shipment
reference
ORIG_SYS_PAY VARCHAR2 50 No Original system

MENT_REF payment
reference
CHANGE_SEQ VARCHAR2 50 No Change

UENCE sequence
CHANGE_REQ VARCHAR2 30 No Change Request

UEST_CODE Code
ORG_ID NUMBER NA No Organization ID
SOLD_TO_ORG NUMBER NA No Foreign key to

_ID HZ_CUST_ACC
OUNTS.CUST_
ACCOUNT_ID
SOLD_TO_ORG VARCHAR2 360 No NA
PAYMENT_TYP VARCHAR2 30 Yes Lookup type:

E_CODE OE_PAYMENT_
TYPE.
PAYMENT_NU NUMBER NA No For Insert

MBER actions, this
number will be
system
generated.
COMMITMENT VARCHAR2 240 No Commitment

name:
description of a
contractual
guarantee with a
customer for
future purchase.
PAYMENT_TRX NUMBER NA No Commitment ID,
_ID Customer Bank
Account ID or
NULL.
PAYMENT_ME VARCHAR2 30 No AR Payment

THOD Method name
RECEIPT_METH NUMBER NA No Foreign key

OD_ID reference to
AR_Receipt_Met
hod.
PAYMENT_COL VARCHAR2 30 No Lookup type:

LECTION_EVE OE_PAYMENT_
NT COLLECTION_
EVENT. Values
are Prepay or
Invoice.
PAYMENT_SET NUMBER NA No Foreign key

_ID reference to AR.
Unique ID to
identify receipts
created for an
order.
PREPAID_AMO NUMBER NA No Receipts created

UNT in AR.
CREDIT_CARD_ VARCHAR2 80 No A holder for

NUMBER credit card
number if
payment type
code is Credit
Card. If
ap_bank_accoun
t_id already
exists, do not
populate this
column and use
the
payment_trx_id
column instead.

HOLDER_NAM credit card
E holder name if
payment type
code is Credit
Card. If
ap_bank_accoun
t_id already
exists, do not
populate this
column and use
the
payment_trx_id
column instead.
CREDIT_CARD_ DATE NA No A holder for

EXPIRATION_D credit card
ATE expiration date if
payment type
code is Credit
Card. If
ap_bank_accoun
t_id already
exists, do not
populate this
column and use
the
payment_trx_id
column instead.
CREDIT_CARD_ VARCHAR2 80 No Lookup type:

CODE Credit_Card

APPROVAL_CO credit card
DE approval code if
payment type
code is Credit
Card.
CREDIT_CARD_ DATE NA No A holder for

APPROVAL_DA credit card
TE approval date if
payment type
code is Credit
Card.
CHECK_NUMB NUMBER NA No A holder for
ER check number if
payment type
code is Check.
PAYMENT_AM NUMBER NA No A holder for

OUNT payment amount
input by user, or
system
calculated from
payment_percen
tag; for example,
amount written
on check,
commitment
amount to be
promised, or
prepayment
amount to be
collected.
PAYMENT_PER NUMBER NA No Value is 1 to

CENTAGE 100. Do not
enter this
column if
Payment
Amount has
been populated.
DEFER_PAYME VARCHAR2 1 No Set this flag to 'Y'

NT_PROCESSIN if you want to
G_FLAG process payment
offline. This
applies to both
prepayment and
credit card
authorization.
CREATION_DA DATE NA No Standard Who

TE column
CREATED_BY NUMBER NA No Standard Who

column
LAST_UPDATE DATE NA No Standard Who

_DATE column

LAST_UPDATE NUMBER NA No Standard Who
D_BY column
LAST_UPDATE NUMBER NA No Standard Who

_LOGIN column
REQUEST_ID NUMBER NA No Concurrent

request that last
changed row
PROGRAM_AP NUMBER NA No Application of

PLICATION_ID concurrent
program that last
updated row.
PROGRAM_ID NUMBER NA No Concurrent

program that last
updated row.
PROGRAM_UP DATE NA No Last date

DATED_DATE changed by
concurrent
program
CONTEXT VARCHAR2 30 No Descriptive

flex-field context
ATTRIBUTE1 VARCHAR2 240 No Descriptive

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment
flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

flex-field
segment

OPERATION_C VARCHAR2 30 No Operation Code
ODE
STATUS_FLAG VARCHAR2 1 No Status Flag
INTERFACE_ST VARCHAR2 1000 No Interface Status

ATUS
ERROR_FLAG VARCHAR2 1 No Error Flag
Indexes
OE_PAYMENTS_IFACE_N1: Request_ID
OE_PAYMENTS_IFACE_N2: Order_Source_Id,
Orig_Sys_Document_Ref, Orig_Sys_Line_Ref, Orig_sys_shipment_ref,
orig_sys_payment_ref
Primary key: N2+Change Sequence
Process Order Application Open Interface

The Sales Order has been modeled as a business object that Oracle Order Management
owns. The Sales Order business object comprises of several entities, namely, Header,
Header Sales Credits, Header Price Adjustments, Header Pricing Attributes, Header
Adjustment Attributes, Header Adjustment Associations, Lines, Line Sales Credits, Line
Price Adjustments, Line Pricing Attributes, Line Adjustment Attributes, Line
Adjustment Associations, and Line Lot Serial Numbers.
The Process Order Application Program Interface (API) is designed as the mechanism
through which all data manipulation (inserts, updates and deletes) may be performed
on the Sales Order business object entities and their attributes, in a consistent manner.
Besides these, certain other action requests such as applying holds, attachments,
booking etc. can also be processed using the Sales Order API. Business logic in the API
not only takes care of updates to the attributes but also make calls to other functions
depending on the changes to attribute values.
The importance of using the Process Order API for all data manipulation to the Sales
Order Business object cannot be over stressed. It must be understood that by using the
Process Order API we not only avoid duplication of business logic in many functions
but also move towards the distributed solution approach.
Process Order API Features - Operations on the Sales Orders Object

The Process Order API can be used to create, update or delete the following entities that
the sales order business object consists of.
Process Orders Entities and Associated Tables
Entity Table Name
Order Header OE_ORDER_HEADERS_ALL
Order Price Adjustments OE_PRICE_ADJUSTMENTS
Order Sales Credits OE_SALES_CREDITS
Order Line OE_ORDER_LINES_ALL
Order Pricing Attributes OE_ORDER_PRICE_ATTRIBS
Order Adjustment Attributes OE_PRICE_ADJ_ATTRIBS
Order Adjustment Associations OE_PRICE_ADJ_ASSOCS
Line Sales Credits OE_SALES_CREDITS
Line Price Adjustments OE_PRICE_ADJUSTMENTS
Line Pricing Attributes OE_ORDER_PRICE_ATTRIBS
Line Adjustment Attributes OE_PRICE_ADJ_ATTRIBS
Line Adjustment Associations OE_PRICE_ADJ_ASSOCS
Lot Serial Numbers OE_LOT_SERIAL_NUMBERS
Passing Parameters By Values

Process Order API provides users the capability of passing the attributes on the order
entities by their display values instead of their internal identifiers (IDs or codes).
For example, to specify the customer on the order, the user can either pass in the
customer ID on the header record, p_header_rec.sold_to_org_id or send in the display
name of the customer on the header value record, p_header_val_rec.sold_to_org.
The values are internally resolved into the identifiers for all the entity records passed to
process order. For the value fields that could not be resolved, error messages are posted
to the OM message stack and none of the records are processed any further.
If both the value and the identifier fields are populated for the same attribute, then
information messages are posted to the OM message stack for such attributes. The

identifier field takes preference and further processing is based on this field.
Multi-Org Access Control

Process Order, Lock Order and Get Order APIs are enhanced to accept Operating Unit
as an optional input parameter so that you can specify the operating unit in which to
process the order. If an Operating Unit value is not passed explicitly to the API, then the
API uses the default Operating Unit derived from the security/Operating Unit profile
options. If no default Operating Unit is specified, an error will be raised. These APIs
also check if the current responsibility has access to the Operating Unit. If not, an error
is raised.
When calling Process Order, Lock Order or Get Order APIs, if you already know the
Operating Unit name or org_id, you may pass it so that the API doesn't need to derive
the OU from the profile options.
If you are enabling Multi-Org Access Control in your application:
In addition to calling FND_GLOBAL.APPS_INITIALIZE(), call the procedure
mo_global.init('ONT') procedure, before calling the Public API. This ensures that the
multi-org access control context is appropriately set. If this is not done, then an error
will be displayed as the logic that checks for OU access will fail.
If you pass in an org_id / operating unit name and you have access to that Operating
Unit, the org context is set accordingly. If you do not pass in an org_id / operating unit
name, then the call is processed for the default Operating Unit. If a default cannot be
derived the call fails.
If you are NOT enabling Multi-Org Access Control in your application:
The existing Process Order , Lock Order or Get Order API calls will work as before, and
will be validated and processed for the MO: Operating Unit for the applications context
set for that call.
Note: The MOAC validation API determines whether MOAC is

enabled or not based on whether MO Security Profile is set.
Though Order Management APIs do not seed any error messages, the Multi-Org API is
called and raises one of the following messages depending on the nature of the failure:
• FND_MO_NOINIT_SP_PUB_API: Raised if the Multi-Org initialization is not done.
• FND_MO_INVALID_OU_API: Raised if you pass an org_id that is invalid.
• FND_MO_INVALID_OU_PUB_API: Raised if you do not pass an org_id and it

cannot be derived.
Pricing an Order/Line
Pricing in process order API can be controlled using flag calculate_price_flag on order
line record. When set to Y (Yes), the process order API fetches the list price and applies
adjustments and charges. When set to N, the process order API would fetch a list price
if the list price is not passed and no adjustments would be applied. When set to P, all
the modifiers which are associated with phases having override freeze flag set to Y are
applied. That mainly includes freight charges.
You may use the Process Order Interface for order repricing, provided the order data
you are updating has an change that will trigger repricing. Once Process Order is
invoked and program logic determines an attribute that can trigger order repricing has
been updated, a call to the pricing engine is made to reprice the order.
The following order attributes (database columns) can trigger Process Order to reprice
an order or order line:
• agreement_id
• cust_po_number
• inventory_item_id
• invoice_to_org_id
• ordered_item_id
• ordered_item
• line_category_code
• line_type_id
• ordered_quantity
• ordered_quantity_uom
• preferred_grade
• payment_term_id
• price_list_id
• pricing_date
• request_date
• ship_to_org_id
• sold_to_org_id
• service_start_date

• service_end_date
• service_duration
• service_period
Along with the preceding attributes, a pricing call will be invoked when a change
occurs in the following attributes (from OEXULINB.pls):
• Cancelled_quantity on the sales order line.
• Ordered_quantity2 (Secondary order quantity): Ability to price by secondary order

quantity.
• Unit_selling_price on the sales order line is cleared.
You can also choose to update order pricing via the action Price Order from the Order
Organizer or Sales Orders window.
Note: You cannot interface an order line having a price list with a
currency code different from the existing or newly created order
header's currency code. An error message will be displayed in the
Process Messages window.
Scheduling/Reservations
Process order API can be used to perform scheduling actions on order lines. Scheduling
actions include: schedule, unschedule, reserve and unreserve.
The schedule_action_code field provided on the order line record (line_rec_type) can be
used to provide the action which needs to be performed on the order line.
Reservations can also be performed by passing the reserved_quantity on the order line
record. You do not need to send in the schedule action if reserved_quantity is passed.
Process Order API will also automatically schedule or re-schedule the lines if the
schedule_ship_date or schedule_arrival_date field is passed or updated respectively.
Alternatively, you can just set the profile option OM: AutoSchedule to Yes and all
standard lines will be automatically scheduled as they are created. This holds true only
if the lines are not part of any set.
Return Lines
Process order can be used to create and update return lines also. To create a return line,
you can either pass in the line category of RETURN on the order line record and the line
type would default to the inbound line type of the order type. Alternatively, you can
also provide a line type of the type Return on the order line record.
Additionally, if you want to specify a reference for the return line, you can pass in the
return flexfields (return_context, return_attribute1-2).
Column Return_Context can have the following values to determine the reference type:
• Sales Order
• Customer PO
• Invoice
• Serial Number
Return_Attribute1... Return_Attribute2 can have the following values depending on the

reference type:
• Sales Order
• return_Attribute1: Header ID
• return_Attribute2: Line ID
• Customer PO
• return_Attribute1: Header ID
• return_Attribute2: Line ID
• Invoice
• return_Attribute1: Invoice Header ID
• return_Attribute2: Invoice Line ID
• Serial Number
• return_Attribute1: Inventory Item ID
• return_Attribute2: Serial Number
Special Considerations for using Process Order for return orders

Creation of a non-referenced RMA: If you wish to process orders for a return order for
a non referenced return, you must
• populate all required attributes for creating a return order
• use an order category of RETURN or MIXED for the Order Header record.
• populate all required attributes for creating a return order lines.

• For Order Line Record, the line category should be set to RETURN, and specify
a RETURN LINE TYPE within column line_type_id.

• Line_type _id is optional, provided a default line_type has been defined for the
specified Order Type.)
• Additionally, you will need to populate the column reason_code for all return
lines. Valid values are those values defined for the Order Management
quickcode CREDIT_MEMO_REASON.
Creation of a Referenced RMA (if you want to return an existing outbound line): If
you create a referenced RMA, you should copy the Header Record for the return from
the referenced Order header record, modifying the Order Type to category RETURN or
MIXED (order_type_id from oe_transaction_types_all).
For the Order Line record, populate the following attributes only:
1. Line_category_code: RETURN
2. return_context: ORDER
3. return_attribute1: header_id from the referenced order.
4. return_attribute2: line_id from the referenced order line.
5. calculate_price_flag: Set it to P if you want to retain the original price, the flag to Y
if you want to reprice the RMA line.
6. line_type_id: Assign a line_type_id from RMA line. Line_type _id is optional,

provided a default line_type has been defined for the specified Order Line Type.)
7. return_reason_code: Populate a reason code from lookup_type =

CREDIT_MEMO_REASON.
8. Sales credit details: populate the header_level/line level sales credits from the
referenced order.
Capturing Customer Acceptance

To capture customer acceptance using Process Order, you need to use Action Requests.
You can attach these requests at the order level or at the line level. For each acceptance
or rejection, create a request record in the action request table. If the ID of the order or
line for which this action is requested on is not available (order or order line is being
created at the same time), assign the entity_index field with the index for the entity
record.
An example of how Process Order API is called to record Customer Acceptance:
Create acceptance records for order line id = 100. Quantity on the order = 10. Full
acceptance of quantity 10.
-- ACTION REQUEST RECORD for acceptance
-- line level action

l_request_rec.entity := G_ENTITY_LINE;
-- line id
l_request_rec.entity_id := 100;
-- action requested
l_request_rec.request_type := G_ACCEPT_FULFILLMENT;
-- parameters
-- acceptance type code
l_request_rec.param1 := 'Fulfillment';
-- quantity
l_request_rec.param2 := 10;
-- customer signature
l_request_rec.param4 := 'John Smith';
-- customer signature date

l_request_rec.date_param2 := '20-DEC-2004';
-- inserting request record into action request table
l_action_request_tbl := l_request_rec;
-- CALL TO PROCESS ORDER

OE_Order_PVT.Process_Order(
........
-- enabling validation of the request record parameters
p_validation_level => FND_API.G_VALID_LEVEL_FULL
......
-- action request table
x_action_request_tbl => l_action_request_tbl
........
-- OUT variables
........
);
TYPE Request_Rec_Type IS RECORD
(
Entity_code Varchar2(30):= NULL,

Entity_id Number := NULL,
Entity_index Number := NULL,
request_type Varchar2(30) := NULL,
return_status VARCHAR2(1) := FND_API.G_MISS_CHAR,
param1 Varchar2(2000) := NULL,

.
.
.
date_param1 DATE := NULL,
date_param2 DATE := NULL,
.
.
.
)
Acceptance Fulfillment
Lines waiting for fulfillment acceptance will be accepted for revenue recognition based

on the parameters sent in on the request record:
Parameter Description
request_type OE_GLOBALS.G_ACCEPT_FULFILLMENT
entity_code OE_GLOBALS.G_ENTITY_HEADER for

accepting all eligible lines waiting for
fulfillment acceptance in an order
param1 Acceptance Comments
param2 Acceptance Customer Signature
param3 Acceptance Reference Document
param4 Implicit acceptance
date_param1 Acceptance date
Rejection Fulfillment
Lines waiting for fulfillment acceptance will be rejected for revenue recognition based
on the parameters sent in on the request record:
request_type OE_GLOBALS.G_ACCEPT_FULFILLMENT

accepting all eligible lines waiting for
fulfillment acceptance in an order
param1 Acceptance Comments
param2 Acceptance Customer Signature
param3 Acceptance Reference Document
param4 Implicit rejection
date_param1 Rejection date
Holds/Releases
The existing hold sources are evaluated and if they are applicable, holds are applied
and released automatically on the orders or order lines when created/updated via the
process order API.
For e.g. if there is a hold source defined for the customer ABC, all orders for that
customer are placed on hold as they are entered.
Attachments
If the profile option OM: Apply Automatic Attachments is set to Yes and if attachment
rules are applicable, attachments are automatically applied to the order header or order
lines when they are created via the process order API.
Note: Attachments are NOT automatically deleted or re-applied if the

order or line is updated.
The caller can also send in an explicit action request to apply attachments. Please refer
to the section Action Requests for more details.
Sets
Process order can be used to add or delete order lines from ship sets, arrival sets or
fulfillment sets. Action Requests can be used to add or remove lines from fulfillment
sets. Please refer to Process Order and Action Requests sections for more details.
User can add a line into a new set by passing set name
(ship_set/arrival_set/fullfillment_set) on the line record or user can use set id
(ship_set_id/arrival_set_id/fulfillment_set_id) to add to an existing set.
Splits
Process order can be used to split an existing order line into shipments. User can
perform splits by calling process order with both the line records, one to reduce the
quantity on the existing line record with the action of SPLIT and another to create the
new line with the remaining quantity and a reference to the line that it was split from.
For e.g. if user wants to split a line with original quantity 10 into 6 and 4 he must
populate the table in the following manner. In the first update call to process order user
cannot update any other attributes other than ordered quantity.
line_tbl(1).split_action_code := 'SPLIT'
line_tbl(1).split_by := 'USER'
line_tbl(1).ordered_quantity := 6
line_tbl(1).operation = oe_globals.g_opr_update

line_tbl(2).split_action_code := 'SPLIT'
line_tbl(2).split_by := 'USER'
line_tbl(2).ordered_quantity := 4
line_tbl(2).operation = oe_globals.g_opr_create
line_tbl(2).split_from_line_id := line_tbl(1).line_id
User can also optionally pass in the change reason and change comments on the
original line record that is being updated.
Cancellation
Process order can be used to cancel orders and order lines. User should update the
cancelled flag to Y on the header record if user intends to cancel the entire order.
Cancellation on the line is performed by reducing the ordered quantity on the line
record. User has to supply change reason and optionally change comments on the line
record.
Tax Calculation
Process order will check whether the transaction type on the order line is taxable or
whether user has specified that tax should be calculated (set the tax exempt flag to
Required). The calculated tax is always an estimated value and is internally stored as a
price adjustment.
Freight and Special Charges

Freight and special charges can be setup in pricing as modifiers. When the order or line
is priced, these charges get applied on the order or line. These do not affect the unit
selling price and are also stored as price adjustments.
Users can also specify the freight and special charges to be applied by setting up the
price adjustment records appropriately. Such price adjustments should have the
list_line_type_code parameter set to CHARGE.
Cascading
Process Order will automatically cascade changes to other dependent entities. For
example,
• cascade quantity changes from model lines to all options lines
• if a set identifying attribute is changed on one line of the set, the change will be
automatically applied to all lines on the set.
The processing sequence is very important when considering automatic cascading.

Process Order will go by the following order when processing the line entity. First, all
standard lines and model lines are processed. These are followed by processing of
requests in their arrival order. The importance of declaring the processing sequence
may be depicted by the following example. Consider that a model M1 has O1 and M2 as
two of its options. M2 has O2 and O3 as two options defined for it. Graphically
represented, it would look like this.
Let us assume that the following requests are received by Process Order API:
• Request 1: Update the quantity of Option4 to 20.
• Request 2: Update the quantity of Model2 to 4.
If requests are processed in the order that they were received, the following would
occur:
Option 4 would be updated to 20 assuming that the new ratio between Model2 and
Option4 (1:10) falls within a valid range. Next Model2 would be updated to 4 (assuming
again that ratio of Model1 to Model2 is valid). That would then result in quantity
cascading, thereby updating Option3 to 8 and Option4 to 40. So the resulting quantities
are:
Model2 = 4, Option3 = 8, Option4 = 40.
If processing sequence of requests is based on item type (models first, classes next,
options after that etc.), the following would be the sequence in which the requests
would be processed:
Request 2 would be processed first, with quantity of Model2 to be updated to 4. Next
quantity of Option4 would be updated to 20 (assuming ratios fall in the right range). So
the resulting quantities are:
Model2 = 4, Option3 = 8 and Option4 = 20.

The above example highlights the differences with processing lines (termed in the
example as requests) in the sequential arrival order versus processing based on item
types.
As stated earlier, process order API will process Standard Lines and top level Model
lines first., then option classes and option lines and service lines in the end. For lines
in the same category, the requests would be processed in the order that they are
received.
Booking an Order
The following order and line level columns and fields are required for booking an
order:
Order Header
• The following fields are required at the order header level:
• Order_Number
• Sold_to_Org
• Invoice_to_Org_Id
• Price_list
• Tax_Exempt_Flag
• Salesrep_Id (Salesperson ID)
• Ordered_Date
• The following fields are required for regular or mixed orders, but not for return
orders:
• Ship_to_Org
• Payment_Term_Id
• If Conversion_Type_Code = User, then Conversion_Rate and

Conversion_Rate_Date are required.
• For checks based on Payment Type: If Payment_Type_Code is not null, then the
Payment_Amount is required. The Check_Number is required if the payment_type
is check .
Line
• Required fields:
• Order_Number
• Sold_to_Org
• Invoice_to_Org_Id
• Price_list
• Tax_Exempt_Flag
• Salesrep_Id (Salesperson ID)
• Ordered_Date
• Inventory_Item_Id
• Ordered_Quantity
• Ordered_Quantity_UOM
The following fields are required for regular or mixed orders, but not for return
orders:
• Ship_to_Org
• Payment_Term_Id
• Items that are not included items or configurable items--for example,

Item_Type_Code is INCLUDED or CONFIG, Price_List , Unit_Selling_Price , and
Unit_List_Price--are required.
• Warehouse, Schedule Date, and Tax_Date are required on return lines.
• If Tax_Exempt_Flag = R (Required), then the Tax_Code is needed.
• For Service Item Type (Item_Type_Code = SERVICE):

If the Service_Coterminate_Flag = Y (yes) and Service_Reference_Type_Code is
Customer Product, then the following fields are required: Service_Start_Date,
Service_End_Date, Service_Duration, and Service_Period.
Functional Overview - Public Procedures

Process Order API provides the following public procedures for operations and queries
on the entities for the sales order object.
• Process_Order
• This is the main procedure used to create, update and delete the entities on the sales
order. This procedure can also be used to perform other actions via the records or

explicit action requests.
Please refer to the next section on the details of the processing.
• Get_Order
This procedure queries and returns all records belonging to a single sales order
object.
• Lock_Order
Locks the entities of a sales order object. Use the get_order procedure to retrieve the
entity records and then call lock_order with the records to be locked.
Processing the Sales Order Business Object

Process order can only process entities belonging to one sales order in one i.e. in a single
call, it can accept one header record and a table of header adjustment, header sales
credits, lines, line adjustments, line sales credit and line lot serial numbers records for
processing. The entities are processed in the following sequence:
1. Process Header Record
2. Process Header Adjustments
3. Process Header Pricing Attributes
4. Process Header Adjustment Attributes
5. Process Header Adjustment Associations
6. Process Header Sales Credits
7. Check Entity context to make sure all lines belong to one header
8. Process Lines
9. Process Line Adjustments
10. Process Line Pricing Attributes
11. Process Line Adjustment Attributes
12. Process Line Adjustment Associations
13. Process Line Sales Credits
14. Process Line Lot Serial Numbers
15. Perform Cross Entity Logic for Sales Order business object
The procedure process_order performs the following actions for each entity on the
order object:
Attribute Level Security Check
If operation on the record is UPDATE or CREATE, then for all the attributes that have
changed between the old and the new record, constraints are evaluated to check if the
user is allowed to change the attribute. An error is raised if there was at least one
attribute that failed security check and the record is not processed further.
Attribute Validation
All the attributes that are passed in by the caller on the entity record are validated.
Errors are posted to the OM message stack for all attributes that are invalid. An error is
raised at the end if at least one attribute failed validation and the record is not processed
further.
Clear Dependent Attributes
If operation is UPDATE, then the fields dependent on the updated fields are cleared (or
set to MISSING values). This is done so that the dependent fields are re-defaulted. For
e.g. if the customer on the order is being updated, then the contacts, ship to and bill to
on the order should be re-defaulted.
Note: If the user is also trying to update the dependent fields in the
same call to the process order API, then the fields will not be cleared
and the user-specified value will be used instead.
Defaulting
Defaulting occurs for each missing attribute.
Attributes that are not explicitly passed by the user and therefore, retain the values on
the initialized record are defined as MISSING attributes. For e.g. all the number fields
on the entity records are initialized to the value FND_API.G_MISS_NUM and thus, all
number fields with this value are MISSING attributes.
• Check security if new default value is different from old value and if there is a valid
constraint, then an error is raised and abort processing of this record.
• Validate the default value if not null. If new default value is NOT valid, then set the
attribute to NULL.
• If default value is valid, clear the dependent attributes (set to MISSING values).
Note: If the user has specified the values of these dependent

attributes in the same call to process order, then the user-specified
values will take preference and will not be cleared.

• Re-default all the missing attributes (dependent attributes) till all attributes have a
value.
Record Validation
There are three main validation steps:
1. Check for Required Attributes. Validate that all the required attributes have been
specified on the entity and even if one required attribute is missing, raise an error
and quit. For e.g. inventory item is a required field on the order line entity.
2. Check for Conditionally Required Attributes. Validate that all attributes that are
required based on the status of the entity have been specified and if at least one is
not specified, raise an error and quit. For e.g. for a booked line, ship to location is
required.
3. Cross-Attribute Validation. Validate all those attributes that are dependent on the
value of another attribute. At the end of the validation, if at least one attribute is not
valid, then raise an error and quit. For e.g. verify that the ship to is valid for the
customer.
Entity Security Check

Entity level security check (constraints that are not attribute-specific) is done once again
before the entity record is posted to database as defaulting may have changed the
values of some attributes for e.g. ship set may have defaulted onto the line and there is a
constraint against inserting a line into a ship set where all lines in the ship set have been
invoiced.
Any constraints that may have been setup for DELETE operation on this entity are also
evaluated here.
Database Write
Write the changes to the database.
Cross Record Logic
After all the records have been processed for one entity, other cross record logic like
validations, automatic application of holds etc. is done. For e.g. after all records are
processed for the entity order sales credit, validate that the total percent adds up to 100.
Cross Entity Logic
After all the entities have been processed, cross entity logic is performed for the
business object as a whole.
Note: In addition to the above a check is made to validate entity context

for the line to ensure all lines belong to same header.
Start Processing Record
if operation if operation
DELETE CREATE or UPDATE
Attribute Security Check
error
Attribute Validation
if operation if operation error
CREATE UPDATE
Clear Dependent Attributes
Set the error
status on the record
Defaulting
errorRollback all changes.
Exit with error status
Record Validation
error
Entity Security Check
Database Write
Process
Next
Record Record Processed
Successfully
error
All records processed
Cross Record Logic error

All entities processed
Process Action Requests
Exit with Success Status
Setting Up the Process Order Procedure

Before using the API, set up and activate the following parameters:
• Operating Unit. For more information please refer to the section on Multi-Org
Access Control, page 7-112.
• Version number
• Initialize message list
• Initialize the IN record parameters to be interfaced to missing values
• Setup the parameters on the records to be interfaced
Parameter Descriptions
OE_ORDER_PUB.PROCESS_ORDER. All of the inbound and outbound parameters are
listed. The OUT parameters have to be assigned when calling the API and are therefore
marked as Required fields. Additional information on these parameters follows.
OE_ORDER_PUB.PROCESS_ORDER
Parameter Usage Type Required Optional Descriptio Default

n
P_Operatin IN VARCHAR X Operating

g_Unit 2 Unit Name
P_org_id IN NUMBER X Internal id

for
Operating
Unit
n
p_api_versi IN NUMBER X Used to

on_number compare
the
incoming
API call's
version
number
with the
current
version
number.
An error is
returned if
the version
numbers
are
incompatib
le
p_init_msg IN Varchar2 X Requests FND_API.

_list that the G_FALSE
API
initialize
the
message
list on your
behalf.
p_return_v IN Varchar2 X Requests FND_API.

alues that the G_FALSE
API send
back the
values on
your
behalf.

n
x_return_st OUT Varchar2 X Returns the

atus status,
indicates
whether
the request
was
processed
successfull
y or no
Success:
FND_API.
G_RET_ST
S_SUCCES
S
Error:
FND_API.
G_RET_ST
S_ERROR
Unexpecte
d Error:
FND_API.
G_RET_ST
S_UNEXP_
ERROR
n
x_msg_cou OUT NUMBER X Indicates

nt number of
error
messages
API has
encountere
d.
If the
x_msg_cou
nt is
greater
than 1,
then the list
of
messages
must be
retrieved
using the
call
OE_MSG_
PUB.GET.
This api
can be
called with
the
following
parameter
values:
p_msg_ind
ex => I
p_encoded
=> F
p_data =>
1_message
p_msg_ind
ex_out =>
1_msg_ind
ex_out
where
1_message
and

n
1_msg_ind
ex_out
should be
local
variables of
types
Varchar2(2
000 and
Number
respectivel
y
x_msg_dat OUT Varchar2 X Displays

a error
message
text. If the
x_msg_cou
nt is equal
to 1, then
this
contains
the actual
message
p_header_r IN PL/SQL X Use this G_MISS_H

ec Record parameter EADER_R
to send in EC
operations
on the
order
header
entity
p_old_hea IN PL/SQL X Use this G_MISS_H

der_rec Record parameter EADER_R
to send in EC
the old
record for
the order
header
entity.
n
p_header_ IN PL/SQL X Use this G_MISS_H

val_rec Record parameter EADER_V
to send in AL_REC
the display
values for
fields on
the order
header
entity.

der_val_rec Record parameter EADER_V
to send in AL_REC
display
values for
the fields
on the old
record for
the order
header
entity.
p_header_a IN PL/SQL X Use this G_MISS_H

dj_tbl Table parameter EADER_A
to send in DJ_TBL
operations
on the
order price
adjustment
entities

der_adj_tbl Table parameter EADER_A
to send in DJ_TB
the old
records for
the order
price
adjustment
entities.

n

dj_val_tbl Table parameter EADER_A
to send in DJ_VAL_T
the display BL
values for
fields on
the order
price
adjustment
entities

der_adj_val Table parameter EADER_A
_tbl to send in DJ_VAL_T
display BL
values for
the fields
on the old
records for
the order
price
adjustment
entities.

price_att_t Table parameter EADER_P
bl to send in RICE_ATT
operations _TBL
on the
order
pricing
Attributes
entities

der_price_ Table parameter EADER_P
att_tbl to send in RICE_ATT
the old _TBL
records for
the order
pricing
Attributes
entities
n

dj_att_tbl Table parameter EADER_A
to send in DJ_ATT_T
operations BL
on the
order
Adjustmen
t Attributes
entities.

der_adj_att Table parameter EADER_A
_tbl to send in DJ_ATT_T
the old BL
records for
the order
Adjustmen
t Attributes
entities.

dj_assoc_tb Table parameter EADER_A
l to send in DJ_ASSOC
operations _TBL
on the
order
Adjustmen
t
Association
s entities.

der_adj_ass Table parameter EADER_A
oc_tbl to send in DJ_ASSOC
the old _TBL
records for
the order
Adjustmen
t
Association
s entities.

n
p_header_s IN PL/SQL X Use this G_MISS_H

credit_tbl Table parameter EADER_SC
to send in REDIT_TB
operations L
on the
order sales
credits.

der_scredit Table parameter EADER_SC
_tbl to send in REDIT_TB
the old L
record for
the order
sales
credits.

credit_val_ Table parameter EADER_SC
tbl to send in REDIT_VA
the display L_TBL
values for
fields on
the order
sales
credits.

der_scredit Table parameter EADER_SC
_val_tbl to send in REDIT_VA
display L_TBL
values for
the fields
on the old
record for
order sales
credits.
n
p_Header_ IN Header_Pa
Payment_t yment_Tbl
bl _Type :=
G_MISS_H
EADER_P
AYMENT_
TBL
p_old_Hea IN Header_Pa
der_Payme yment_Tbl
nt_tbl _Type :=
G_MISS_H
EADER_Pa
yment_TBL
p_Header_ IN Header_Pa
Payment_v yment_Val
al_tbl _Tbl_Type
:=
G_MISS_H
EADER_Pa
yment_VA
L_TBL
p_old_Hea IN
der_Payme
nt_val_tbl
p_line_tbl IN PL/SQL X Use this G_MISS_LI

Table parameter NE_TBL
to send in
operations
on the
order lines.
p_old_line IN PL/SQL X Use this G_MISS_LI

_tbl Table parameter NE_TBL
to send in
the old
records for
the order
lines.

n
p_line_val_ IN PL/SQL X Use this G_MISS_LI

tbl Table parameter NE_VAL_T
to send in BL
the display
values for
fields on
the order
lines.

_val_tbl Table parameter NE_VAL_T
to send in BL
display
values for
the fields
on the old
records for
order lines.
p_line_adj_ IN PL/SQL X Use this G_MISS_LI

tbl Table parameter NE_ADJ_T
to send in BL
operations
on the line
price
adjustment
entities.

_adj_tbl Table parameter NE_ADJ_T
to send in BL
the old
records for
the line
price
adjustment
entities.
n

val_tbl Table parameter NE_ADJ_V
to send in AL_TBL
the display
values for
fields on
the line
price
adjustment
entities.

_adj_val_tb Table parameter NE_ADJ_V
l to send in AL_TBL
display
values for
the fields
on the old
records for
the line
price
adjustment
entities.

tbl Table parameter NE_PRICE
to send in _ATT_TBL
operations
on the Line
pricing
Attributes
entities.

_adj_tbl Table parameter NE_PRICE
to send in _ATT_TBL
the old
records for
the Line
pricing
Attributes
entities.

n

val_tbl Table parameter NE_ADJ_A
to send in TT_TBL
operations
on the Line
Adjustmen
t Attributes
entities.

_adj_val_tb Table parameter NE_ADJ_A
l to send in TT_TBL
the old
records for
the Line
Adjustmen
t Attributes
entities.
p_line_pric IN PL/SQL X
e_att_tbl Table
p_old_line IN PL/SQL X
_price_att_t Table
bl
p_line_adj_ IN PL/SQL X
att_tbl Table
p_old_line IN PL/SQL X
_adj_att_tbl Table

assoc_tbl Table parameter NE_ADJ_A
to send in SSOC_TBL
operations
on the Line
Adjustmen
t
Association
s entities.
n

_adj_assoc_ Table parameter NE_ADJ_A
tbl to send in SSOC_TBL
the old
records for
the Line
Adjustmen
t
Association
s entities.
p_line_scre IN PL/SQL X Use this G_MISS_LI

dit_tbl Table parameter NE_SCRE
to send in DIT_TBL
operations
on the line
sales
credits.

_scredit_tbl Table parameter NE_SCRE
to send in DIT_TBL
the old
record for
the line
sales
credits.

dit_val_tbl Table parameter NE_SCRE
to send in DIT_VAL_
the display TBL
values for
fields on
the line
sales
credits

n

_scredit_va Table parameter NE_SCRE
l_tbl to send in DIT_VAL_
display TBL
values for
the fields
on the old
record for
line sales
credits.
p_Line_Pa IN Line_Paym
yment_tbl ent_Tbl_Ty
pe :=
G_MISS_H
EADER_P
AYMENT_
TBL
p_old_Line IN Line_Paym
_Payment_ ent_Tbl_Ty
tbl pe :=
G_MISS_H
EADER_Pa
yment_TBL
p_Line_pa IN Line_Paym
yment_val_ ent_Val_Tb
tbl l_Type :=
G_MISS_LI
NE_Payme
nt_VAL_T
BL
p_old_Line IN
_Payment_
val_tbl
p_lot_serial IN PL/SQL X Use this G_MISS_L

_tbl Table parameter OT_SERIA
to send in L_TBL
operations
on the lot
serials.
n
p_old_lot_s IN PL/SQL X Use this G_MISS_L

erial_tbl Table parameter OT_SERIA
to send in L_TBL
the old
record for
the lot
serials.

_val_tbl Table parameter OT_SERIA
to send in L_VAL_TB
the display L
values for
fields on
the lot
serials.
p_old_lot_s IN PL/SQL X Use this G_MISS_L

erial_val_t Table parameter OT_SERIA
bl to send in L_VAL_TB
display L
values for
the fields
on the old
record for
lot serials.
p_action_re IN PL/SQL X Use this to G_MISS_R

quest_tbl Table send in EQUEST_T
requests to BL
process
other
actions on
the order
x_header_r OUT PL/SQL X Returns the

ec Table processed
order
header
record.

n
x_header_v OUT PL/SQL X Returns the

al_rec Table values for
the
processed
order
header
record for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_header_a OUT PL/SQL X Returns the

dj_tbl Table records for
the
processed
price
adjustment
s

dj_val_tbl Table values for
the
processed
header
price
adjustment
s if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_header_p OUT PL/SQL X Returns the

rice_att_tbl Table records for
the
processed
header
pricing
attributes
n

dj_att_tbl Table records for
the
processed
header
adjustment
attributes

dj_assoc_tb Table records for
l the
processed
header
adjustment
association
s
x_header_s OUT PL/SQL X Returns the

credit_tbl Table records for
the
processed
header
adjustment
association
s

credit_val_ Table values for
tbl the
processed
header
sales
credits if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_line_tbl OUT PL/SQL X Returns the

Table processed
order lines.

n
x_line_val_ OUT PL/SQL X Returns the

tbl Table values for
the
processed
order lines
if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_line_adj_ OUT PL/SQL X Returns the

tbl Table processed
line price
adjustment
s for the
sales order

val_tbl Table values for
the
processed
line price
adjustment
s for the
sales order
if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_line_pric OUT PL/SQL X Returns the

e_att_tbl Table records for
the
processed
line
adjustment
attributes
n

att_tbl Table records for
the
processed
line
adjustment
association
s

assoc_tbl Table records for
the
processed
line
adjustment
association
s
x_line_scre OUT PL/SQL X Returns the

dit_tbl Table processed
sales
credits.

dit_val_tbl Table values for
the
processed
sales
credits for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_lot_serial OUT PL/SQL X Returns the

_tbl Table processed
lot serials.

n

_val_tbl Table values for
the
processed
lot serials if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_action_re OUT PL/SQL X Returns the

quest_tbl Table status for
each of the
action
requests
that were
passed to
process
order.
Setting Up the Get_Order Procedure

• Version number
• Pass the header ID of the order to be queried
OE_ORDER_PUB.GET_ORDER. All of the inbound and outbound parameters are
listed. Additional information on these parameters follows.
OE_ORDER_PUB.GET_ORDER

n

g_Unit 2 Unit Name

for
Operating
Unit

on_number compare
the
incoming
API call's
version
number
with the
current
version
number.
An error is
returned if
the version
numbers
are
incompatib
le.

API
initialize
the
message
list on your
behalf.

n

API send
back the
values on
your
behalf.
p_commit IN Varchar2 X Requests FND_API.

that the G_FALSE
API update
informatio
n for you
after it
completes
its
function.
n

atus status,
indicates
whether
the request
was
processed
successfull
y or not.
Valid
values
include:
Success:
FND_API.
G_RET_ST
S_SUCCES
S
Error:
FND_API.
G_RET_ST
S_ERROR
Unexpected
Error:
FND_API.
G_RET_ST
S_UNEXP_
ERROR

n

nt number of
error
messages
API has
encountere
d.
If the
x_msg_cou
nt is
greater
than 1,
then the list
of
messages
must be
retrieved
using the
call
OE_MSG_
PUB.GET.
This api
can be
called with
the
following
parameter
values:
p_msg_ind
ex => I
p_encoded
=> F
p_data =>
1_message
p_msg_ind
ex_out =>
1_msg_ind
ex_out
where
1_message
and
n
1_msg_ind
ex_out
should be
local
variables of
types
Varchar2(2
000) and
Number
respectivel
y.
x_msg_dat OUT Varchar2 Displays

a error
message
text. If the
x_msg_cou
nt is equal
to 1, then
this
contains
the actual
message.
p_header_i IN NUMBER X Parameter FND_API.

d to identify G_MISS_N
the sales UM
order that
is to be
queried.
p_header IN Varchar2 X

ec Table queried
order
header
record for
the sales
order.

n

the queried
order
header
record for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE

dj_tbl Table queried
header
price
adjustment
s for the
sales order.

the queried
header
price
adjustment
s for the
sales order
if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_header_p OUT PL/SQL X

rice_att_tbl Table
x_header_a OUT PL/SQL X

dj_att_tbl Table
n
x_header_a OUT PL/SQL X

dj_assoc_tb Table
l

credit_tbl Table queried
header
sales
credits for
the sales
order.

tbl the queried
header
sales
credits for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_Header_ OUT Header_Pa

Payment_t yment_Tbl
bl _Type
x_Header_ OUT Header_Pa

Payment_v yment_Val
al_tbl _Tbl_Type

Table queried
order lines
for the
sales order.

n

the queried
order lines
for the
sales order
if
p_return_v
alues was
set to
FND_API.
G_TRUE

tbl Table queried
line price
adjustment
s for the
sales order

the queried
line price
adjustment
s for the
sales order
if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_line_pric OUT PL/SQL X

e_att_tbl Table
x_line_adj_ OUT PL/SQL X

att_tbl Table

assoc_tbl Table
n

dit_tbl Table queried
line sales
credits for
the sales
order.

the queried
line sales
credits for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_Line_Pay OUT OUT

ment_tbl Line_Paym
ent_Tbl_Ty
pe
x_Line_Pay OUT OUT

ment_val_t Line_Paym
b ent_Val_Tb
l_Type

_tbl Table queried lot
serials for
the sales
order.

n

the queried
lot serials
for the
sales order
if
p_return_v
alues was
set to
FND_API.
G_TRUE
Setting Up the Lock_Order Procedure

• Version number
• Query all the entities for the sales order using the Get_Order procedure.
• Set the operation parameter to OE_GLOBALS.G_OPR_LOCK only on the entity

records to be locked in this call.
OE_ORDER_PUB.LOCK_ORDER. All of the inbound and outbound parameters are
listed. The OUT parameters have to be assigned when calling the API and are therefore
marked as Required fields. Additional information on these parameters follows.
OE_ORDER_PUB.LOCK_ORDER

n

g_Unit 2 Unit Name

for
Operating
Unit

on_number compare
the
incoming
API call's
version
number
with the
current
version
number.
An error is
returned if
the version
numbers
are
incompatib
le.

API
initialize
the
message
list on your
behalf.

n

API send
back the
values on
your
behalf.

atus status,
indicates
whether
the request
was
processed
successfull
y or not.
Valid
values
include:
Success:
FND_API.
G_RET_ST
S_SUCCES
S
Error:
FND_API.
G_RET_ST
S_ERROR
Unexpected
Error:
FND_API.
G_RET_ST
S_UNEXP_
ERROR
n

nt number of
error
messages
API has
encountere
d.
If the
x_msg_cou
nt is
greater
than 1,
then the list
of
messages
must be
retrieved
using the
call
OE_MSG_
PUB.GET.
This api
can be
called with
the
following
parameter
values:
p_msg_ind
ex => I
p_encoded
=> F
p_data =>
1_message
p_msg_ind
ex_out =>
1_msg_ind
ex_out
where
1_message
and

n
1_msg_ind
ex_out
should be
local
variables of
types
Varchar2(2
000) and
Number
respectivel
y.
x_msg_dat OUT Varchar2 X Displays

a error
message
text. If the
x_msg_cou
nt is equal
to 1, then
this
contains
the actual
message.
p_header_r IN PL/SQL X Use this G_MISS_H

ec Record parameter EADER_R
to send in EC
operations
on the
order
header
entity.

val_rec Record parameter EADER_V
to send in AL_REC
the display
values for
fields on
the order
header
entity.
n

dj_tbl Table parameter EADER_A
to send in DJ_TBL
operations
on the
order price
adjustment
entities.

dj_val_tbl Table parameter EADER_A
to send in DJ_VAL_T
the display BL
values for
fields on
the order
price
adjustment
entities.

price_att_t Table parameter EADER_P
bl to send in RICE_ATT
operations _TBL
on the
order
pricing
Attributes
entities.

dj_att_tbl Table parameter EADER_A
to send in DJ_ATT_T
operations BL
on the
order
Adjustmen
t Attributes
entities.

n

dj_assoc_tb Table parameter EADER_A
l to send in DJ_ASSOC
operations _TBL
on the
order
Adjustmen
t
Association
s entities.

credit_tbl Table parameter EADER_SC
to send in REDIT_TB
operations L
on the
order sales
credits.

credit_val_ Table parameter EADER_SC
tbl to send in REDIT_VA
the display L_TBL
values for
fields on
the order
sales
credits.
p_line_tbl IN PL/SQL X Use this G_MISS_LI

Table parameter NE_TBL
to send in
operations
on the
order lines.
p_line_val_ IN PL/SQL X Use this G_MISS_LI

tbl Table parameter NE_VAL_T
to send in BL
the display
values for
fields on
the order
lines.
n

tbl Table parameter NE_ADJ_T
to send in BL
operations
on the line
price
adjustment
entities.

val_tbl Table parameter NE_ADJ_V
to send in AL_TBL
the display
values for
fields on
the line
price
adjustment
entities.

tbl Table parameter NE_PRICE
to send in _ATT_TBL
operations
on the Line
pricing
Attributes
entities.

val_tbl Table parameter NE_ADJ_A
to send in TT_TBL
operations
on the Line
Adjustmen
t Attributes
entities.

n

assoc_tbl Table parameter NE_ADJ_A
to send in SSOC_TBL
operations
on the Line
Adjustmen
t
Association
s entities.

dit_tbl Table parameter NE_SCRE
to send in DIT_TBL
operations
on the line
sales
credits.

dit_val_tbl Table parameter NE_SCRE
to send in DIT_VAL_
the display TBL
values for
fields on
the line
sales
credits.

_tbl Table parameter OT_SERIA
to send in L_TBL
operations
on the lot
serials.
p_lot_lot_s IN PL/SQL X Use this G_MISS_L

erial_val_t Table parameter OT_SERIA
bl to send in L_VAL_TB
the display L
values for
fields on
the lot
serials.
n

ec Table processed
order
header
record.

the
processed
order
header
record for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE

dj_tbl Table records for
the
processed
price
adjustment
s

the
processed
header
price
adjustment
s if
p_return_v
alues was
set to
FND_API.
G_TRUE

n
x_header_p OUT PL/SQL X Returns the

rice_att_tbl Table records for
the
processed
header
pricing
attributes

dj_att_tbl Table records for
the
processed
header
adjustment
attributes

dj_assoc_tb Table records for
l the
processed
header
adjustment
association
s

credit_tbl Table records for
the
processed
header
adjustment
association
s
n

tbl the
processed
header
sales
credits if
p_return_v
alues was
set to
FND_API.
G_TRUE

Table processed
order lines.

the
processed
order lines
if
p_return_v
alues was
set to
FND_API.
G_TRUE

tbl Table processed
line price
adjustment
s for the
sales order

n

the
processed
line price
adjustment
s for the
sales order
if
p_return_v
alues was
set to
FND_API.
G_TRUE
x_line_pric OUT PL/SQL X Returns the

e_att_tbl Table records for
the
processed
line
adjustment
attributes

att_tbl Table

assoc_tbl Table records for
the
processed
line
adjustment
association
s

dit_tbl Table processed
sales
credits.
n
x_line_scre OUT PL/SQL X X Returns the

the
processed
sales
credits for
the sales
order if
p_return_v
alues was
set to
FND_API.
G_TRUE

_tbl Table processed
lot serials.

the
processed
lot serials if
p_return_v
alues was
set to
FND_API.
G_TRUE
PL/SQL Record Structures

All the columns on the underlying order management tables are available on the record
types that can be passed to the process order API. However, callers cannot provide
values for certain columns via the public process order API. Such columns are marked
as Derived columns as these are derived internally and updated by the API. If user
provides values for these fields, it could result in data corruption.
For each column (if the record type is not a value record type, val_rec_type), the
following information has been documented:
• Datatype: data type for this field
• Required: X if required at entry, C if conditionally required

• Required at Booking: X if required at booking, C if required at booking based on
some other conditions.
• Derived: For internal use, users cannot update these fields.
• Optional: if users can either provide values for these fields or could be defaulted.
The value record structures have all fields that can be optionally passed instead of the
identifier. If the identifier field is not passed when required, the value field can be
passed instead and the value will be resolved into the identifier.
These record and table structures are defined in the specifications of the process order
API, OE_ORDER_PUB.
Header_Rec_Type
Please refer to the table below.
• Please note that columns attribute1 - attribute15 are currently defined as
VARCHAR2(240), but only the first 150 characters are passed to Oracle Receivables
during Invoice Interface. These columns contain Additional Header Information
Descriptive Flexfield data
OE_ORDER_HEADERS_ALL
Parameter Description Datatype Required Requir Deri Optio

ed at ved nal
Bookin
g
accounting NUMBER X
_rule_id
agreement NUMBER C - if X
_id order
type
require
s
attribute1... VARCHAR2(2 X
. 40)
attribute20
booked_fla VARCHAR2(1) X
g
ed at ved nal
Bookin
g
cancelled_f VARCHAR2(1) X
lag
context VARCHAR2(3 X
0)
conversion NUMBER C - if X
_rate convers
ion
type is
User
conversion DATE C - if X
_rate_date convers
ion
type is
User
conversion VARCHAR2(3 C - if X
_type_code 0) order
currenc
y not
same as
SOB
currenc
y
customer_ VARCHAR2(3 X
preference 0)
_set_code
created_by NUMBER X
creation_d DATE X
ate
cust_po_nu VARCHAR2(5 C - if X
mber 0) order
type
require
s

ed at ved nal
Bookin
g
deliver_to_ NUMBER X
contact_id
deliver_to_ NUMBER X
org_id
demand_cl VARCHAR2(3 X
ass_code 0)
earliest_sch NUMBER X
edule_limit
expiration_ DATE X
date
fob_point_ VARCHAR2(3 X
code 0)
freight_car VARCHAR2(3 X
rier_code 0)
freight_ter VARCHAR2(3 X
ms_code 0)
global_attri VARCHAR2(2 X
bute1...20 40)
global_attri VARCHAR2(3 X
bute_categ 0)
ory
tp_context VARCHAR2(3 X
0)
tp_attribut VARCHAR2(2 X
e1.... 40)
tp_attribut
e20
ed at ved nal
Bookin
g
header_id NUMBER C - for X

UPDATE &
DELETE
operations
invoice_to_ NUMBER X
contact_id
invoice_to_ NUMBER X
org_id
invoicing_r NUMBER X
ule_id
last_updat NUMBER X
ed_by
last_updat DATE X
e_date
last_updat NUMBER X
e_login
latest_sche NUMBER X
dule_limit
open_flag VARCHAR2(1) X
order_cate VARCHAR2(3 X
gory_code 0)
ordered_da DATE X X
te
order_date VARCHAR2(3 X
_type_code 0)

ed at ved nal
Bookin
g
order_num NUMBER C - for X

ber manual order
types
order_sour NUMBER X
ce_id
order_type NUMBER X
_id
org_id NUMBER X
orig_sys_d VARCHAR2(5 X
ocument_r 0)
ef
partial_shi VARCHAR2(1) X
pments_all
owed
payment_t NUMBER C - for X

erm_id order
lines,
not
return
lines
price_list_i NUMBER X X
d
pricing_dat DATE X X
e
program_a NUMBER X
pplication_
id
program_i NUMBER X
d
ed at ved nal
Bookin
g
program_u DATE X
pdate_date
request_da DATE X
te
request_id NUMBER X
return_reas VARCHAR2(3 X
on_code 0)
salesrep_id NUMBER X X
sales_chan VARCHAR2(3 X
nel_code 0)
shipment_ VARCHAR2(3 X
priority_co 0)
de
shipping_ VARCHAR2(3 X
method_co 0)
de
ship_from_ NUMBER C - for

org_id return
lines
ship_tolera NUMBER X
nce_above
ship_tolera NUMBER X
nce_below
ship_to_co NUMBER X
ntact_id

ed at ved nal
Bookin
g
ship_to_or NUMBER C - for

g_id order
lines,
not
return
lines
sold_from_ NUMBER X
org_id
sold_to_co NUMBER X
ntact_id
sold_to_or NUMBER X X
g_id
source_doc NUMBER X
ument_id
source_doc NUMBER X
ument_typ
e_id
tax_exempt VARCHAR2(3 X X
_flag 0)
tax_exempt VARCHAR2(5 X
_number 0)
tax_exempt VARCHAR2(3 C - if tax X

_reason_co 0) exempt flag is
de Exempt
tax_point_c VARCHAR2(3 for

ode 0) future
use
transaction VARCHAR2(3) X
al_curr_co
de
ed at ved nal
Bookin
g
version_nu NUMBER X
mber
return_stat VARCHAR2(1) X
us
db_flag VARCHAR2(1) X
operation VARCHAR2(3 X
0)
first_ack_c VARCHAR2(3 X
ode 0)
first_ack_d DATE X
ate
last_ack_co VARCHAR2(3 X
de 0)
last_ack_d DATE X
ate
change_rea VARCHAR2(3 C -if X

son 0) constraints
setup
requires
reason
change_co VARCHAR2(2 X
mments 000)
change_seq VARCHAR2(5 X
uence 0)
change_req VARCHAR2(3 X
uest_code 0)
ready_flag VARCHAR2(1) X

ed at ved nal
Bookin
g
status_flag VARCHAR2(1) X
force_appl VARCHAR2(1) X
y_flag
drop_ship_ VARCHAR2(1) X
flag
customer_ Obsolete Obsolete Obsolet Obso Obsole

payment_t e lete te
erm_id
payment_t VARCHAR2(3 X
ype_code 0)
payment_a NUMBER C - if
mount payme
nt type
other
than
Credit
Card
check_num VARCHAR2(5 C - if
ber 0) payme
nt type
is Check
credit_card VARCHAR2(8 X
_code 0)
credit_card VARCHAR2(8 C - if
_holder_na 0) payme
me nt type
is Credit
Card
ed at ved nal
Bookin
g
credit_card VARCHAR2(8 C - if
_number 0) payme
nt type
Credit
Card
credit_card DATE C - if
_expiration payme
_date nt type
Credit
Card
credit_card VARCHAR2(8 X X
_approval_ 0)
code
credit_card DATE X
_approval_
date
shipping_i VARCHAR2(2 X
nstructions 000)
packing_in VARCHAR2(2 X
structions 000)
flow_status VARCHAR2(3 X
_code 0)
booked_da DATE X
te
marketing_ NUMBER X
source_cod
e_id
xml_messa NUMBER X
ge_id

ed at ved nal
Bookin
g
xml_transa VARCHAR2(3 X
ction_type 0)
_code
IB_OWNE Install Base Varchar2(60)

R Owner
Identifier
IB_OWNE Varchar2(60)
R_CODE
IB_INSTAL Install Location Varchar2(60)

LED_AT_L Identifier
OCATION
IB_INSTAL Varchar2(60)
LED_AT_L
OCATION
IB_CURRE Install Current Varchar2(60)

NT_LOCA Location
TION Identifier
IB_CURRE Varchar2(60)
NT_LOCA
TION
END_CUS Customer Id of Number

TOMER_I End Customer
D
END_CUS Contact Id of Number

TOMER_C End Customer
ONTACT_ Contact
ID
END_CUS Site Use Id of Number

TOMER_SI End Customer
TE_USE_I Site
D
TYPE Header_Tbl_Type IS TABLE OF Header_Rec_Type
INDEX BY BINARY_INTEGER;
Header_Rec_Type
Header_Rec_Type
Parameter Value
ship_to_customer_id NUMBER
invoice_to_customer_id NUMBER
deliver_to_customer_id NUMBER
IB_OWNER VARCHAR2(60)
IB_INSTALLED_AT_LOCATION VARCHAR2(60)
IB_CURRENT_LOCATION VARCHAR2(60)
END_CUSTOMER_ID NUMBER
END_CUSTOMER_CONTACT_ID NUMBER
END_CUSTOMER_SITE_USE_ID NUMBER
sold_to_party_id NUMBER
sold_to_org_contact_id NUMBER
ship_to_party_id NUMBER
ship_to_party_site_id NUMBER
ship_to_party_site_use_id NUMBER
deliver_to_party_id NUMBER
deliver_to_party_site_id NUMBER
deliver_to_party_site_use_id NUMBER

Parameter Value
ship_to_customer_id NUMBER
invoice_to_party_id NUMBER
invoice_to_party_site_id NUMBER
invoice_to_party_site_use_id NUMBER
ship_to_customer_party_id NUMBER
deliver_to_customer_party_id NUMBER
invoice_to_customer_party_id NUMBER
ship_to_org_contact_id NUMBER
deliver_to_org_contact_id NUMBER
invoice_to_org_contact_id NUMBER
sold_to_party_number varchar2(30)
ship_to_party_number varchar2(30)
invoice_to_party_number varchar2(30)
deliver_to_party_number varchar2(30)
Header_Val_Rec_Type
For column descriptions, please refer to the Order Management e-TRM for the table:
Header_Val_Rec_Type
Parameter accounting_rule
agreement
conversion_type
deliver_to_address1
deliver_to_address2
deliver_to_address3
deliver_to_address4
deliver_to_contact
deliver_to_location
deliver_to_org
demand_class
fob_point
freight_terms
invoice_to_address1
invoice_to_address2
invoice_to_address3
invoice_to_address4
invoice_to_contact
invoice_to_location
invoice_to_org
invoicing_rule
order_source
order_type

payment_term
price_list
return_reason
salesrep
shipment_priority
ship_from_address1
ship_from_address2
ship_from_address3
ship_from_address4
ship_from_location
ship_from_org
ship_to_address1
ship_to_address2
ship_to_address3
ship_to_address4
ship_to_contact
ship_to_location
ship_to_org
sold_to_contact
sold_to_org
sold_from_org
tax_exempt
tax_exempt_reason
tax_point
customer_payment_term - obsolete
payment_type
credit_card
status
freight_carrier
shipping_method
order_date_type
customer_number
sales_channel
ship_to_customer_name VARCHAR2(360)
invoice_to_customer_name VARCHAR2(360)
ship_to_customer_number VARCHAR2(50)
invoice_to_customer_number VARCHAR2(50)
deliver_to_customer_number VARCHAR2(50)
deliver_to_customer_name VARCHAR2(360)
end_customer_name VARCHAR2(360)

end_customer_number VARCHAR2(50)
end_customer_contact VARCHAR2(360)
end_cust_contact_last_name VARCHAR2(240)
end_cust_contact_first_name VARCHAR2(240)
end_customer_site_address1 VARCHAR2(240)
end_customer_site_state VARCHAR2(240)
end_customer_site_country VARCHAR2(240)
end_customer_site_location VARCHAR2(240)
end_customer_site_zip VARCHAR2(240)
end_customer_site_county VARCHAR2(240)
end_customer_site_province VARCHAR2(240)
end_customer_site_city VARCHAR2(240)
end_customer_site_postal_code VARCHAR2(240)
ib_owner_dsp VARCHAR2(60)
ib_installed_at_location_dsp VARCHAR2(60)
ib_current_location_dsp VARCHAR2(60)
TYPE Header_Val_Tbl_Type IS TABLE OF Header_Val_Rec_Type

Header_Adj_Rec_Type
For column descriptions, please refer to the Order Management e-TRM for the table
OE_PRICE_ADJUSTMENTS
Parameter Datatype Required Derived Optional
attribute1 - VARCHAR2(240
attribute15 )
automatic_flag VARCHAR2(1) X qp_list_lines
context VARCHAR2(30) X
created_by NUMBER X
creation_date DATE X
discount_id NUMBER X
discount_line_id NUMBER X
header_id NUMBER X
last_updated_by NUMBER X
last_update_date DATE X
last_update_logi NUMBER X
n
percent NUMBER X
price_adjustmen NUMBER C -for update X

t_id and delete
program_applica NUMBER X
tion_id
program_id NUMBER X

program_update DATE X
_date
request_id NUMBER X
return_status VARCHAR2(1) X
operation VARCHAR2(30) X
line_index NUMBER X
orig_sys_discou VARCHAR2(50) X
nt_ref
change_request_ VARCHAR2(30) X
code
list_header_id NUMBER C - not required

only for tax
records
list_line_id NUMBER C - not required

only for tax
records
list_line_type_co VARCHAR2(30) X
de
modifier_mecha VARCHAR2(30) X
nism_type_code
modified_from NUMBER X
modified_to NUMBER X
updated_flag VARCHAR2(1) X
update_allowed VARCHAR2(1) X
applied_flag VARCHAR2(1)
change_reason_c VARCHAR2(30) X
ode
change_reason_t VARCHAR2(200 X
ext 0)
operand NUMBER X
operand_per_pq NUMBER X
ty
arithmetic_opera VARCHAR2(30) X
tor
cost_id NUMBER X
tax_code VARCHAR2(30)
tax_exempt_flag VARCHAR2(1)
tax_exempt_nu VARCHAR2(80)
mber
tax_exempt_reas VARCHAR2(30)
on_code
parent_adjustme NUMBER X -for update

nt_id and delete
invoiced_flag VARCHAR2(1) X
estimated_flag VARCHAR2(1) X
inc_in_sales_perf VARCHAR2(1) X
ormance

split_action_cod VARCHAR2(30) X
e
adjusted_amoun NUMBER X
t
t_per_pqty
pricing_phase_id NUMBER X
charge_type_cod VARCHAR2(30) X
e
charge_subtype_ VARCHAR2(30) X
code
list_line_no VARCHAR2(240 X
)
source_system_c VARCHAR2(30) X
ode
benefit_qty NUMBER X
benefit_uom_co VARCHAR2(3) X
de
print_on_invoice VARCHAR2(1) X
_flag
expiration_date DATE X
rebate_transactio VARCHAR2(30) X
n_type_code
n_reference
rebate_payment_ VARCHAR2(30) X
system_code
redeemed_date DATE X
redeemed_flag VARCHAR2(1) X
accrual_flag VARCHAR2(1) X
range_break_qua NUMBER X
ntity
accrual_conversi NUMBER X
on_rate
pricing_group_s NUMBER X
equence
modifier_level_c VARCHAR2(30) X
ode
price_break_type VARCHAR2(30) X
_code
substitution_attri VARCHAR2(30) X
bute
proration_type_c VARCHAR2(30) X
ode
credit_or_charge VARCHAR2(1) X
_flag
include_on_retur VARCHAR2(1) X
ns_flag
ac_attribute1... VARCHAR2(240 X
)
ac_attribute15
ac_context VARCHAR2(150 X
)
TYPE Header_Adj_Tbl_Type IS TABLE OF Header_Adj_Rec_Type


For column descriptions, please refer to the Order Management e-TRM for the
table:Header_Adj_Val_Rec_Type
Header_Adj_Val_Rec_Type
Header_Adj_Val_Rec_Type
Parameter
discount
list_name
TYPE Header_Adj_Val_Tbl_Type IS TABLE OF Header_Adj_Val_Rec_Type

Header_Price_Att_Rec_Type
For column descriptions, please refer to the Order Management table
OE_ORDER_PRICE_ATTRIBS
order_price_attri NUMBER X -for update X

b_id and delete
header_id NUMBER X
created_by NUMBER X
n
tion_id
program_id NUMBER X
_date
request_id NUMBER X
flex_title VARCHAR2(60) X
pricing_context VARCHAR2(30) X
pricing_attribute VARCHAR2(240 at least one of X

1... ) these columns
pricing_attribute should have a
100 value
)
attribute15
Override_Flag VARCHAR2(1) X
TYPE Header_Price_Att_Tbl_Type is TABLE of Header_Price_Att_rec_Type

INDEX by BINARY_INTEGER
Header_Adj_Att_Rec_Type
For column descriptions, please refer to the Order Management table
OE_PRICE_ADJ_ATTRIBS.

OE_PRICE_ADJ_ATTRIBS
price_adj_attrib_ NUMBER C -for update

id and delete
price_adjustmen NUMBER C - if adj_index

t_id not passed
cdj_index NUMBER C - if
price_adjustmen
t_id not passed
pricing_attribute VARCHAR2(30) X
created_by NUMBER X
n
tion_id
program_id NUMBER X
_date
request_id NUMBER X
pricing_attr_valu VARCHAR2(240 X
e_from )
e_to )
comparison_ope VARCHAR2(30) X
rator
operation VARCHAR2(30)
TYPE Header_Adj_Att_Rec_Type is TABLE of Header_Adj_Att_rec_Type

INDEX by BINARY_INTEGER;
Type Header_Adj_Assoc_Rec_Type is RECORD
For column descriptions, please refer to the Order Management TRM for the table:
OE_PRICE_ADJ_ASSOCS
OE_PRICE_ADJ_ASSOCS
price_adj_assoc_ NUMBER C - for update

id and delete
line_id NUMBER
Line_Index NUMBER

t_id not passed
Adj_index NUMBER C - if
price_adjustmen
t_id not passed
rltd_Price_Adj_I NUMBER X
d

Rltd_Adj_Index NUMBER X
created_by NUMBER X
n
tion_id
program_id NUMBER X
_date
request_id NUMBER X
TYPE Header_Adj_Assoc_Tbl_Type is TABLE of Header_Adj_Assoc_rec_Type

TYPE Header_Scredit_Rec_Type IS RECORD
For column descriptions, please refer to the Order Management TRM for the table:
OE_SALES_CREDITS
OE_SALES_CREDITS
)
attribute15
created_by NUMBER X
dw_update_advi VARCHAR2(1) X
ce_flag
header_id NUMBER X
n
percent NUMBER X
salesrep_id NUMBER X
sales_credit_type NUMBER X
_id
sales_credit_id NUMBER X
wh_update_date DATE X

orig_sys_credit_r VARCHAR2(50) X
ef
code
TYPE Header_Scredit_Tbl_Type IS TABLE OF Header_Scredit_Rec_Type

TYPE Header_Scredit_Val_Rec_Type IS RECORD
(salesrep, sales_credit_type);
TYPE Header_Scredit_Val_Tbl_Type IS TABLE OF Header_Scredit_Val_Rec_Type
Line_Rec_Type
OE_ORDER_LINES_ALL
• Please note that columns attribute1 - attribute15 are currently defined as
VARCHAR2(240), but only the first 150 characters are passed to Oracle Receivables
during Invoice Interface. These columns contain Additional Order Information
Descriptive Flexfield data
OE_ORDER_LINES_ALL
Paramete Datatype Description Required Requir De Option

r ed at riv al
Booki ed
ng
accountin NUMBER X
g_rule_id
actual_arri DATE X
val_date
r ed at riv al
Booki ed
ng
actual_shi DATE X
pment_dat
e
agreement NUMBER X
_id
arrival_set NUMBER X
_id
ato_line_i NUMBER X
d
attribute1.. VARCHAR2(24 X
.attribute2 0)
0
authorized VARCHAR2(1) X
_to_ship_f
lag
auto_selec NUMBER X
ted_quanti
ty
booked_fl VARCHAR2(1) X
ag
cancelled_ VARCHAR2(1) X
flag
cancelled_ NUMBER X
quantity
cancelled_ NUMBER X
quantity2
commitme NUMBER X
nt_id

r ed at riv al
Booki ed
ng
componen VARCHAR2(10 X
t_code 00)
componen NUMBER X
t_number
componen NUMBER X
t_sequenc
e_id
config_hea NUMBER X X
der_id
config_rev NUMBER X X
_nbr
config_dis NUMBER X
play_sequ
ence
configurat NUMBER X X
ion_id
context VARCHAR2(30 X
)
created_b NUMBER X
y
creation_d DATE X
ate
credit_inv NUMBER X
oice_line_i
d
dock_code )
r ed at riv al
Booki ed
ng
customer_j VARCHAR2(50 X
ob )
productio )
n_line
customer_ NUMBER X
trx_line_id
cust_mode VARCHAR2(50 X
l_serial_n )
umber
cust_po_n VARCHAR2(50 X
umber )
cust_prod VARCHAR2(50 X
uction_seq )
_num
delivery_l NUMBER X
ead_time
deliver_to NUMBER X
_contact_i
d
deliver_to NUMBER X
_org_id
demand_b VARCHAR2(30 X
ucket_typ )
e_code
demand_c VARCHAR2(30 X
lass_code )

r ed at riv al
Booki ed
ng
dep_plan_ VARCHAR2(1) X
required_f
lag
earliest_ac DATE X
ceptable_d
ate
end_item_ VARCHAR2(30 C - depends on X

unit_num ) the item
ber
explosion_ DATE X
date
fob_point_ VARCHAR2(30 X
code )
freight_car VARCHAR2(30 X
rier_code )
freight_ter VARCHAR2(30 X
ms_code )
fulfilled_q NUMBER X
uantity
fulfilled_q NUMBER X
uantity2
global_attr VARCHAR2(24 X
ibute1...20 0)
global_attr VARCHAR2(30 X
ibute_cate )
gory
header_id NUMBER X
r ed at riv al
Booki ed
ng
industry_a VARCHAR2(24 X
ttribute1... 0)
30
industry_c VARCHAR2(30 X
ontext )
tp_context VARCHAR2(30 X
)
tp_attribut VARCHAR2(24 X
e1...20 0)
intermed_ NUMBER X
ship_to_or
g_id
intermed_ NUMBER X
ship_to_co
ntact_id
inventory_ NUMBER X
item_id
invoice_in VARCHAR2(30 X X
terface_sta )
tus_code
invoice_to NUMBER X
_contact_i
d
invoice_to NUMBER X X
_org_id
invoicing_ NUMBER X
rule_id
ordered_it VARCHAR2(20 C: for Generic

em 00) Items

r ed at riv al
Booki ed
ng
item_revis VARCHAR2(3) X
ion
item_type VARCHAR2(30 X
_code )
last_updat NUMBER X
ed_by
last_updat DATE X
e_date
last_updat NUMBER X
e_login
latest_acce DATE X
ptable_dat
e
line_categ VARCHAR2(30 X X
ory_code )
line_id NUMBER C - for

UPDATE &
DELETE
operations
line_numb NUMBER X
er
line_type_ NUMBER X X
id
link_to_lin VARCHAR2(50 X
e_ref )
link_to_lin NUMBER X
e_id
r ed at riv al
Booki ed
ng
link_to_lin NUMBER X
e_index
model_gro NUMBER X
up_numbe
r
mfg_comp NUMBER X
onent_seq
uence_id
open_flag VARCHAR2(1) X
option_fla VARCHAR2(1) X
g
option_nu NUMBER X
mber
ordered_q NUMBER X X
uantity
ordered_q NUMBER X
uantity2
order_qua VARCHAR2(3) X X
ntity_uom
ordered_q VARCHAR2(3) X
uantity_uo
m2
org_id NUMBER X
orig_sys_d VARCHAR2(50 X
ocument_r )
ef

r ed at riv al
Booki ed
ng
orig_sys_li VARCHAR2(50 X
ne_ref )
over_ship VARCHAR2(30 X
_reason_c )
ode
over_ship VARCHAR2(1) X
_resolved_
flag
payment_t NUMBER C- for X

erm_id order
lines,
not
return
lines
planning_ NUMBER X
priority
preferred_ VARCHAR2(4) X
grade
price_list_i NUMBER X
d
pricing_att VARCHAR2(24 X
ribute1... 0)
pricing_att
ribute10
pricing_co VARCHAR2(24 X
ntext 0)
pricing_da DATE X
te
r ed at riv al
Booki ed
ng
pricing_qu NUMBER X
antity
pricing_qu VARCHAR2(3) X
antity_uo
m
program_ NUMBER X
applicatio
n_id
program_i NUMBER X
d
program_ DATE X
update_da
te
project_id NUMBER X
promise_d DATE X
ate
re_source_ VARCHAR2(1) X
flag
reference_ NUMBER X
customer_
trx_line_id
reference_ NUMBER X
header_id
reference_ NUMBER X
line_id
reference_ VARCHAR2(30 X
type )

r ed at riv al
Booki ed
ng
request_d DATE X
ate
request_id NUMBER X
reserved_ NUMBER X
quantity
return_attr VARCHAR2(24 X
ibute1... 0)
return_attr
ibute20
return_co VARCHAR2(30 X
ntext )
return_rea VARCHAR2(30 C - for return

son_code ) lines only
rla_schedu VARCHAR2(30 X
le_type_co )
de
salesrep_i NUMBER X
d
schedule_ DATE X
arrival_da
te
schedule_s DATE X
hip_date
schedule_ VARCHAR2(30 X
action_cod )
e
schedule_s VARCHAR2(30 X
tatus_code )
r ed at riv al
Booki ed
ng
shipment_ NUMBER X
number
shipment_ VARCHAR2(30 X
priority_c )
ode
shipped_q NUMBER X
uantity
shipped_q NUMBER X
uantity2
shipping_i VARCHAR2(1) X
nterfaced_
flag
shipping_ VARCHAR2(30 X
method_c )
ode
shipping_ NUMBER X
quantity
shipping_ NUMBER X
quantity2
shipping_ VARCHAR2(3) X
quantity_
uom
shipping_ VARCHAR2(3) X
quantity_
uom2
ship_from NUMBER C - for X

_org_id return
lines

r ed at riv al
Booki ed
ng
ship_mod VARCHAR2(30 X
el_complet )
e_flag
ship_set_i NUMBER X
d
fulfillment NUMBER X
_set_id
ship_toler NUMBER X
ance_abov
e
ship_toler NUMBER X
ance_belo
w
ship_to_co NUMBER X
ntact_id
ship_to_or NUMBER C - for X

g_id order
lines,
not
return
lines
sold_to_or NUMBER X
g_id
sold_from NUMBER X
_org_id
sort_order VARCHAR2(24 X
0)
source_do NUMBER X
cument_id
r ed at riv al
Booki ed
ng
source_do NUMBER X
cument_li
ne_id
source_do NUMBER X
cument_ty
pe_id
source_ty VARCHAR2(30 X
pe_code )
split_from NUMBER X
_line_id
task_id NUMBER C - depends on

the project
tax_code VARCHAR2(50 X X
)
tax_date DATE X X
tax_exemp VARCHAR2(30 X X
t_flag )
tax_exemp VARCHAR2(50 X
t_number )
tax_exemp VARCHAR2(30 C -if tax status X

t_reason_c ) is Exempt
ode
tax_point_ VARCHAR2(30 for

code ) future
use
tax_rate NUMBER X
tax_value NUMBER X

r ed at riv al
Booki ed
ng
top_model VARCHAR2(50 X
_line_ref )
top_model NUMBER X
_line_id
top_model NUMBER X
_line_inde
x
unit_list_p NUMBER X X
rice
unit_list_p NUMBER X
rice_per_p
qty
unit_sellin NUMBER X X
g_price
unit_sellin NUMBER X
g_price_p
er_pqty
veh_cus_it NUMBER X
em_cum_
key_id
visible_de VARCHAR2(1) X
mand_flag
return_sta VARCHAR2(1) X
tus
operation VARCHAR2(30 X
)
r ed at riv al
Booki ed
ng
first_ack_c VARCHAR2(30 X
ode )
first_ack_ DATE X
date
last_ack_c VARCHAR2(30 X
ode )
last_ack_d DATE X
ate
change_re VARCHAR2(30 X
ason )
change_co VARCHAR2(20 X
mments 00)
arrival_set VARCHAR2(30 X
)
ship_set VARCHAR2(30 X
)
fulfillment VARCHAR2(30 X
_set )
order_sou NUMBER X
rce_id
orig_sys_s VARCHAR2(50 X
hipment_r )
ef
change_se VARCHAR2(50 X
quence )

r ed at riv al
Booki ed
ng
change_re VARCHAR2(30 X
quest_cod )
e
drop_ship VARCHAR2(1) X
_flag
line_numb )
er
shipment_ )
number
customer_ NUMBER X
item_net_
price
customer_ Obsolete Obsolete Obsole Ob Obsolet

payment_t te sol e
erm_id ete
ordered_it NUMBER C: for

em_id Customer
Items
item_ident VARCHAR2(25 C: for customer X

ifier_type ) and generic
items
shipping_i VARCHAR2(20 X
nstruction 00)
s
packing_i VARCHAR2(20 X
nstruction 00)
s
r ed at riv al
Booki ed
ng
calculate_ VARCHAR2(1) X
price_flag
invoiced_ NUMBER X
quantity
service_tx VARCHAR2(30 X
n_reason_ )
code
service_tx VARCHAR2(20 X
n_comme 00)
nts
service_du NUMBER C - for X

ration service
lines
service_pe VARCHAR2(3) C - for service X

riod lines
service_sta DATE C - for service X

rt_date lines
service_en DATE C - for service X

d_date lines
service_co VARCHAR2(1) X
terminate_
flag
unit_list_p NUMBER X
ercent
unit_sellin NUMBER X
g_percent
unit_perce NUMBER X
nt_base_p
rice

r ed at riv al
Booki ed
ng
service_nu NUMBER X
mber
service_ref VARCHAR2(30 C - for service X

erence_typ ) lines
e_code
service_ref NUMBER C - for service X

erence_lin lines
e_id
service_ref NUMBER X
erence_sys
tem_id

_order_nu reference type
mber of Order

_line_num reference type
ber of Order
_shipment
_number
_option_n
umber
service_lin NUMBER X
e_index
Line_set_i NUMBER X
d
split_by VARCHAR2(24 X
0)
r ed at riv al
Booki ed
ng
Split_Acti VARCHAR2(30 X
on_Code )
shippable_ VARCHAR2(1) X
flag
model_re VARCHAR2(1) X
mnant_fla
g
flow_statu VARCHAR2(30 X
s_code )
fulfilled_fl VARCHAR2(1) X
ag
fulfillment VARCHAR2(30 X
_method_ )
code
revenue_a NUMBER X
mount
marketing NUMBER X
_source_c
ode_id
fulfillment DATE X
_date
semi_proc BOOLEAN X
essed_flag
override_a Varchar2(30) No No No Y
tp_date_co
de
late_dema Number No No No Y
nd_penalt
y_factor

r ed at riv al
Booki ed
ng
xml_trans Varchar2(30) Y
action_typ
e_code
IB_OWNE Varchar2(60) Install Base

R Owner
Identifier
IB_OWNE Varchar2(60) Install Base

R_CODE Owner
Identifier
IB_INSTA Varchar2(60) Install Location

LLED_AT Identifier
_LOCATI
ON
IB_INSTA Varchar2(60)
LLED_AT
_LOCATI
ON
IB_CURR Varchar2(60) Install Current

ENT_LOC Location
ATION Identifier
IB_CURR Varchar2(60) Install Current

ENT_LOC Location
ATION_C Identifier
ODE
END_CUS Number Customer Id of

TOMER_I End Customer
D
END_CUS Number Contact Id of

TOMER_C End Customer
ONTACT_ Contact
ID
r ed at riv al
Booki ed
ng
END_CUS Number Site Use Id of

TOMER_S End Customer
ITE_USE_I Site
D
TYPE Line_Tbl_Type IS TABLE OF Line_Rec_Type

Index BY BINARY_INTEGER;
Line_Rec_Type
Line_Rec_Type
Parameter Value
IB_OWNER VARCHAR2(60)
IB_INSTALLED_AT_LOCATION VARCHAR2(60)
IB_CURRENT_LOCATION VARCHAR2(60)
END_CUSTOMER_ID NUMBER
END_CUSTOMER_CONTACT_ID NUMBER
END_CUSTOMER_SITE_USE_ID NUMBER
ship_to_party_id NUMBER
ship_to_party_site_id NUMBER
ship_to_party_site_use_id NUMBER
deliver_to_party_id NUMBER
deliver_to_party_site_id NUMBER
deliver_to_party_site_use_id NUMBER

Parameter Value
invoice_to_party_id NUMBER
invoice_to_party_site_id NUMBER
invoice_to_party_site_use_id NUMBER
ship_to_customer_party_id NUMBER
deliver_to_customer_party_id NUMBER
invoice_to_customer_party_id NUMBER
ship_to_org_contact_id NUMBER
deliver_to_org_contact_id NUMBER
invoice_to_org_contact_id NUMBER
ship_to_party_number varchar2(30)
invoice_to_party_number varchar2(30)
deliver_to_party_number varchar2(30)
retrobill_request_id NUMBER
CONTINGENCY_ID NUMBER
REVREC_EVENT_CODE varchar2(30)
REVREC_EXPIRATION_DAYS NUMBER
ACCEPTED_QUANTITY NUMBER
ACCEPTED_BY NUMBER
REVREC_COMMENTS VARCHAR2(2000)
REVREC_REFERENCE_DOCUMENT VARCHAR2(240)
Parameter Value
REVREC_SIGNATURE VARCHAR2(240)
REVREC_SIGNATURE_DATE DATE
REVREC_IMPLICIT_FLAG VARCHAR2(1)
Line_Val_Rec_Type
Line_Val_Rec_Type
Parameter
accounting_rule
agreement
commitment
deliver_to_address1
deliver_to_address2
deliver_to_address3
deliver_to_address4
deliver_to_contact
deliver_to_location
deliver_to_org
demand_class
demand_bucket_type
fob_point
freight_terms

Parameter
inventory_item
invoice_to_address1
invoice_to_address2
invoice_to_address3
invoice_to_address4
invoice_to_contact
invoice_to_location
invoice_to_org
invoicing_rule
item_type
line_type
over_ship_reason
payment_term
price_list
project
return_reason
rla_schedule_type
salesrep
shipment_priority
ship_from_address1
Parameter
ship_from_address2
ship_from_address3
ship_from_address4
ship_from_location
ship_from_org
ship_to_address1
ship_to_address2
ship_to_address3
ship_to_address4
ship_to_contact
ship_to_location
ship_to_org
source_type
intermed_ship_to_address1
intermed_ship_to_contact
intermed_ship_to_location
intermed_ship_to_org

Parameter
sold_to_org
sold_from_org
task
tax_exempt
tax_exempt_reason
tax_point
veh_cus_item_cum_key
visible_demand
customer_payment_term - obsolete
ref_order_number
ref_line_number
ref_shipment_number
ref_option_number
ref_invoice_number
ref_invoice_line_number
credit_invoice_number
tax_group
status
freight_carrier
shipping_method
Parameter
ship_to_customer_name VARCHAR2(360)
invoice_to_customer_name VARCHAR2(360)
ship_to_customer_number VARCHAR2(50)
invoice_to_customer_number VARCHAR2(50)
deliver_to_customer_number VARCHAR2(50)
deliver_to_customer_name VARCHAR2(360)
end_customer_name VARCHAR2(360)
end_customer_number VARCHAR2(50)
end_customer_contact VARCHAR2(360)
end_cust_contact_last_name VARCHAR2(240)
end_cust_contact_first_name VARCHAR2(240)
end_customer_site_location VARCHAR2(240)
end_customer_site_state VARCHAR2(240)
end_customer_site_country VARCHAR2(240)
end_customer_site_zip VARCHAR2(240)
end_customer_site_county VARCHAR2(240)

Parameter
end_customer_site_province VARCHAR2(240)
end_customer_site_city VARCHAR2(240)
end_customer_site_postal_code VARCHAR2(240)
ib_owner_dsp VARCHAR2(60)
ib_current_location_dsp VARCHAR2(60)
ib_installed_at_location_dsp VARCHAR2(60)
CONTINGENCY_NAME VARCHAR2(240)
CONTINGENCY_DESCRIPTION VARCHAR2(240)
EXPIRATION_EVENT_ATTRIBUTE VARCHAR2(240)
REVREC_EVENT VARCHAR2(240)
ACCEPTED_BY_DSP VARCHAR2(100)
TYPE Line_Val_Tbl_Type IS TABLE OF Line_Val_Rec_Type

TYPE Line_Adj_Rec_Type IS RECORD
For column descriptions, please refer to the Order Management TRM for the table
attribute1.... VARCHAR2(240
attribute15 )
automatic_flag VARCHAR2(1) X X
created_by NUMBER X
discount_id NUMBER X
discount_line_id NUMBER X
header_id NUMBER X
n
line_id
percent NUMBER X
price_adjustmen NUMBER C -for update X

t_id and delete
tion_id
program_id NUMBER X
_date
request_id NUMBER X

line_index NUMBER X
orig_sys_discou VARCHAR2(50) X
nt_ref
code
list_header_id NUMBER C - not required

only for tax
records
list_line_id NUMBER C - not required

only for tax
records
list_line_type_co VARCHAR2(30) X
de
modifier_mecha VARCHAR2(30) X
nism_type_code
modified_from NUMBER X
modified_to NUMBER X
updated_flag VARCHAR2(1)
update_allowed VARCHAR2(1) X
applied_flag VARCHAR2(1) X
change_reason_c VARCHAR2(30) X
ode
change_reason_t VARCHAR2(200 X
ext 0)
operand NUMBER X
operand_per_pq NUMBER
ty
arithmetic_opera VARCHAR2(30) X
tor
cost_id NUMBER X
tax_code VARCHAR2(30)
tax_exempt_flag VARCHAR2(1)
tax_exempt_nu VARCHAR2(80)
mber
tax_exempt_reas VARCHAR2(30)
on_code
parent_adjustme NUMBER X -for update

nt_id and delete
invoiced_flag VARCHAR2(1) X
estimated_flag VARCHAR2(1) X
inc_in_sales_perf VARCHAR2(1) X
ormance
split_action_cod VARCHAR2(30) X
e
t
adjusted_amoun NUMBER
t_per_pqty
pricing_phase_id NUMBER X
charge_type_cod VARCHAR2(30) X
e

charge_subtype_ VARCHAR2(30) X
code
list_line_no VARCHAR2(240 X
)
source_system_c VARCHAR2(30) X
ode
benefit_qty NUMBER X
benefit_uom_co VARCHAR2(3) X
de
print_on_invoice VARCHAR2(1) X
_flag
expiration_date DATE X
n_type_code
n_reference
rebate_payment_ VARCHAR2(30) X
system_code
redeemed_date DATE X
redeemed_flag VARCHAR2(1) X
accrual_flag VARCHAR2(1) X
range_break_qua NUMBER X
ntity
accrual_conversi NUMBER X
on_rate
pricing_group_s NUMBER X
equence
modifier_level_c VARCHAR2(30) X
ode
price_break_type VARCHAR2(30) X
_code
substitution_attri VARCHAR2(30) X
bute
proration_type_c VARCHAR2(30) X
ode
credit_or_charge VARCHAR2(1) X
_flag
include_on_retur VARCHAR2(1) X
ns_flag
ac_attribute1...15 VARCHAR2(240 X
)
ac_context VARCHAR2(150 X
)
retrobill_request NUMBER
_id
tax_rate_id NUMBER
TYPE Line_Adj_Tbl_Type IS TABLE OF Line_Adj_Rec_Type

TYPE Line_Adj_Val_Rec_Type IS RECORD
(discount List_name)
TYPE Line_Adj_Val_Tbl_Type IS TABLE OF Line_Adj_Val_Rec_Type
Line_Price_Att_Rec_Type

order_price_attri NUMBER X
b_id
header_id NUMBER
line_id NUMBER
line_index NUMBER
created_by NUMBER X
n
tion_id
program_id NUMBER X
_date
request_id NUMBER X
flex_title VARCHAR2(60)
pricing_context VARCHAR2(30)
pricing_attribute VARCHAR2(240
1... )
pricing_attribute
100
context VARCHAR2(30)
attribute1..15 VARCHAR2(240
)
Override_Flag VARCHAR2(1)
operation X
TYPE Line_Price_Att_Tbl_Type is TABLE of Line_Price_Att_rec_Type

Line_Adj_Att_Rec_Type
price_adj_attrib_ NUMBER C -for update

id and delete

t_id not passed
price_adjustmen
t_id not passed

pricing_attribute VARCHAR2(30) X
created_by NUMBER X
n
tion_id
program_id NUMBER X
_date
request_id NUMBER X
e_from )
e_to )
comparison_ope VARCHAR2(30) X
rator
TYPE Line_Adj_Att_Tbl_Type is TABLE of Line_Adj_Att_rec_Type
Line_Adj_Assoc_Rec_Type
OE_PRICE_ADJ_ASSOCS
OE_PRICE_ADJ_ASSOCS
price_adj_assoc_ NUMBER C - for update

id and delete
line_id NUMBER C - if line_index

not passed
Line_Index NUMBER C - if line_id not

passed

t_id not passed
price_adjustmen
t_id not passed
rltd_Price_Adj_I NUMBER X
d
Rltd_Adj_Index NUMBER X
created_by NUMBER X
n

tion_id
program_id NUMBER X
_date
request_id NUMBER X
TYPE Line_Adj_Assoc_Tbl_Type is TABLE of Line_Adj_Assoc_rec_Type

TYPE Line_Scredit_Rec_Type IS RECORD
OE_SALES_CREDITS
attribute1....attri VARCHAR2(240 X
bute15 )
created_by NUMBER X
dw_update_advi VARCHAR2(1) X
ce_flag
header_id NUMBER X
n
line_id NUMBER X
percent NUMBER X
salesrep_id NUMBER X
sales_credit_type NUMBER X
_id
sales_credit_id NUMBER X
wh_update_date DATE X
line_index NUMBER X
orig_sys_credit_r VARCHAR2(50) X
ef
code
TYPE Line_Scredit_Tbl_Type IS TABLE OF Line_Scredit_Rec_Type

-- Line_Scredit value record type

TYPE Line_Scredit_Val_Rec_Type IS RECORD
( salesrep
, sales_credit_type
);
TYPE Line_Scredit_Val_Tbl_Type IS TABLE OF Line_Scredit_Val_Rec_Type

Lot_Serial_Rec_Type
OE_LOT_SERIAL_NUMBERS
attribute1....attri VARCHAR2(240 X
bute15 )
created_by NUMBER X
from_serial_num VARCHAR2(30) C - if lot number X

ber not passed
n
line_id NUMBER C - if line index X

not passed
lot_number VARCHAR2(30) C - if lot serial X

information not
available
lot_serial_id NUMBER C - for update X

and delete
operation
quantity NUMBER X X
to_serial_numbe VARCHAR2(30) C - if lot number X

r not passed
line_index NUMBER C - if line id not

passed
orig_sys_lotseria VARCHAR2(50) X
l_ref
code
line_set_id NUMBER X
TYPE Lot_Serial_Tbl_Type IS TABLE OF Lot_Serial_Rec_Type

TYPE Lot_Serial_Val_Rec_Type IS RECORD
(line lot_serial);
TYPE Lot_Serial_Val_Tbl_Type IS TABLE OF Lot_Serial_Val_Rec_Type
Process Order Usage

Process Order is a complex API and a number of operations on a single order object and
its entities can be performed via this API. This section is intended to help a user of the
process order API in identifying the required parameters for some common operations

and to give an understanding of the business flow behind each of these operations.
CREATE operation
For creating new order entities, the entity records and entity tables passed to
Process_Order should have the operation OE_GLOBALS.G_OPR_CREATE. Pass in the
known attributes on these records and Process Order will default the other missing
attributes.
Note: If you pass in NULL values for some attributes, process order
will interpret it as insertion of NULL into those attributes column and
will NOT get default values for those attributes.
Line adjustments, line sales credits and line lot serial numbers belong to an order line
and the ID of this parent line is stored on these records. When inserting the parent line
and the child entities of this line together, the ID of the parent line is unknown. In this
case, the line_index field on the child entity records indicates the index for the parent
entity record in the lines table. After the line is processed, the line ID is retrieved and
based on the line_index, the correct line_ID is populated on the child entity record.
Similarly for config items, the model line's ID is stored on the option lines. Again, when
inserting models and options in a configuration together, the line ID for the model line
will not be available. The top_model_line_index field on the option lines can be used to
indicate the index for this model line in the lines table. Since models and standard lines
are processed before the options, this line ID can then be populated before the option
lines are processed.
The following steps are executed for each entity within process order:
• Check security
• Attribute level validation
• Entity level validation
• Posted to the database
• Cross Record Logic
Create Operation Example 1

Creating a new order with 2 lines and 1 line adjustment and the adjustment belongs to
the second line.
-- SETTING UP THE HEADER RECORD
-- Initialize record to missing
mo_global.init('ONT');
l_header_rec := OE_ORDER_PUB.G_MISS_HEADER_REC;
-- Required attributes (e.g. Order Type and Customer)
l_header_rec.order_type_id := 1000;
l_header_rec.sold_to_org_id := 100;
-- Other attributes
l_header_rec.price_list_id := 10;
.........
-- Null attribute: no defaulting for freight terms
l_header_rec.freight_term_code = NULL;
-- Indicates to process order that a new header is being created
l_header_rec.operation := OE_GLOBALS.G_OPR_CREATE;
-- FIRST LINE RECORD
l_line_tbl(1) := OE_ORDER_PUB.G_MISS_LINE_REC;
-- Line attributes
l_line_tbl(1).inventory_item_id := 311;
l_line_tbl(1).ordered_quantity := 1;
l_line_tbl(1).operation := OE_GLOBALS.G_OPR_CREATE;
-- SECOND LINE RECORD
-- Line attributes
l_line_tbl(2)inventory_item_id := 312;

-- LINE ADJUSTMENT RECORD
l_line_adj_tbl(1) := OE_ORDER_PUB.G_MISS_LINE_ADJ_REC;
-- Attributes for the line adjustment
l_line_adj_tbl(1).discount_id := 1;
l_line_adj_tbl(1).percent := 5;
l_line_adj_tbl(1).operation := OE_GLOBALS.G_OPR_CREATE;
-- Indicator that this adjustment belongs to the second line
l_line_adj_tbl(1).line_index := 2;
OE_Order_PUB.Process_Order(
........
........
-- Passing just the entity records that are a part of this order
p_header_rec => l_header_rec
p_line_tbl=> l_line_tbl
p_line_adj_tbl=> l_line_adj_tbl
-- OUT variables
x_header_rec=> l_header_rec
x_header_scredit_tbl=> l_header_scr_tbl
x_header_adj_tbl=> l_header_adj_tbl
x_line_tbl=> l_line_tbl
x_line_scredit_tbl=> l_line_scredit_tbl
x_line_adj_tbl=> l_line_adj_tbl
................
x_return_status=> l_return_status
x_msg_count=> l_msg_count
x_msg_data=> l_msg_data);
-- Retrieve messages
if l_msg_count > 0 then
for l_index in 1..l_msg_count loop
l_msg_data := oe_msg_pub.get(p_msg_index => l_index, p_encoded => 'F');
end loop;
end if;
-- Check the return status
if x_return_status = FND_API.G_RET_STS_SUCCESS then
success;
else
failure;
end if;
Create Operation Example 2

Inserting a new line into an existing order.
Note: You cannot insert new lines (or, process any other entity)
belonging to different orders in one process order call
-- NEW LINE RECORD
-- Primary key of the parent entity (If not passed, this

will be retrieved from the parent record, p_header_rec, if
it was also passed to process order else there will be an
error in the processing of this line).

l_line_tbl(1).header_id := 1000;
-- Attributes for the new line
l_line_tbl(1).inventory_item_id := 311;
-- Indicator that a new line is being created
OE_ORDER_PUB.Process_Order(........
-- Passing just the entity records that are being created
-- OUT variables
......);
UPDATE operation
Update of any attributes on the entities of the order object should always go through
the process order API. For updates, the operations on the entity record being updated
should be OE_GLOBALS.G_OPR_UPDATE. Only the attributes that are being updated,
the primary key of this entity and the primary key of the parent entity, if any, need to be
passed and others can be set to missing. Process Order will query these missing
attributes from the database.
Note: To update an existing value to NULL, you can pass NULL for
that attribute on the record parameter passed to process order API.
There are some attributes, however, that are internally set by the
system (e.g. status columns like booked_flag, flow_status_code) and
should not be updated by the user.
Process Order can process entities belonging to one order object in one call. In a call
where one entity record is being updated, another entity record can also be created as
long as they belong to the same order object. For e.g. a line can be updated
(G_OPR_UPDATE) and another line inserted (G_OPR_CREATE) in the same process
order call if both lines have the same header_id.
The following processing steps are executed for each entity record that is updated:
• Check security for update of the changed attributes
• Validation of updated attributes
• Clearing of (or set to missing) attributes dependent on the updated attributes
• Defaulting of missing attributes
• Entity level validation
• Entity security check
• Posted to the database
Update Operation Example

Updating the bill to organization and order quantity on an order line.
-- LINE RECORD WITH THE CHANGES
-- Changed attributes
l_line_tbl(1) := OE_ORDER_PUB.G_MISS_LINE_REC.
l_line_tbl(1).invoice_to_org_id := 322;
-- Primary key of the entity i.e. the order line
l_line_tbl(1).line_id := 1000;
-- Indicates to process order that this is an update operation
l_line_tbl(1).operation := OE_GLOBALS.G_OPR_UPDATE;
OE_ORDER_PUB.Process_Order(........
-- Entity records
-- OUT variables
........);

DELETE operation
For deletes, the operations on the entity records being deleted should be
OE_GLOBALS.G_OPR_DELETE. Only the primary key of the entity being deleted
needs to be passed.
Deletes are cascaded down to the child entities for e.g. to delete an order, only the
header record with the header ID needs to be passed to process order and all the child
entities i.e. lines, header sales credits, header adjustments are deleted. Deleting the lines
results in the deletion of line adjustments, line sales credits and line lot serial numbers
as well. Also, it would delete delayed requests logged by or against this entity and its
child entities.
Deletes would also result in the deletion of any holds and attachments associated with
the deleted entity and its child entities. The workflow status information for this entity
is also purged.
The following processing steps are executed for each entity record that is deleted:
• Entity security check.
Note: Child entities will always be deleted if parent entity passes

security check. There will not be a separate security check for child
entities
• Entity level validation for deletes.
• Delete posted to the database. This will also delete child entities, holds and
attachments.
Delete Operation Example

-- Only the record for the parent entity needs to be passed. Since the
whole order is being deleted, only the header record needs to be passed.
-- Primary key of this order i.e. the header
l_header_rec := OE_ORDER_PUB.G_MISS_LINE_REC;
-- Indicate to process order that the order is to be deleted
l_header_rec.operation := OE_GLOBALS.G_OPR_DELETE;
OE_ORDER_PUB.Process_Order(................
-- Entity records
p_header_rec=> l_header_rec
-- OUT variables
........);
Process Order and Action Requests

Process order API can also process some other actions on the order object. For e.g.
booking the order, applying/releasing holds.
For each action request, a request record should be passed in the action request table
(p_action_request_tbl) to process order and the parameters of the request record can
provide additional information needed to carry out that action. The validation_level
parameter determines whether validation of the parameters of the request record needs
to be performed.
If the ID of the order or line for which this request needs to get executed is not known
as it is being created in the same call, the ENTITY_INDEX field on the request record
indicates the index for the entity record in the entity table passed to
Following are the action requests currently supported and the parameters on the
request record that are used in processing the request.
Book the order
This request is used to book the order.
Book Order
request_type OE_GLOBALS.G_BOOK_ORDER
entity_code This should be always set to

OE_GLOBALS.G_ENTITY_HEADER as
booking is an order level action.
entity_id Header ID of the order to be booked. If the

order is also being created in the same call to
process order, then the user does not need to
provide this value.
p_action_request_tbl IN parameter
x_action_request_tbl OUT parameter

Apply Automatic Attachments
The attachment rules will be evaluated for the entity and if applicable, documents will
be attached to the entity.
Apply Automatic Attachments
request_type OE_GLOBALS.G_APPLY_AUTOMATIC_AT
CHMT
entity_code OE_GLOBALS.G_ENTITY_HEADER if the

rules are to be evaluated for the order header
OE_GLOBALS.G_ENTITY_LINE if rules are

to be evaluated for the order line.
entity_id Header ID if the entity is

G_ENTITY_HEADER,
Line ID if the entity is G_ENTITY_LINE
entity_index If entity is G_ENTITY_LINE and the line is

being created in the same call to process order,
then send in the index position for this line in
the table, p_line_tbl.
Apply Hold
Holds will be applied based on the parameters sent in on the request record.
Apply Hold
request_type OE_GLOBALS.G_APPLY_HOLD

order or OE_GLOBALS.G_ENTITY_LINE for
line.
entity_id ID of the order or line to be held
param1 Hold ID to identify the type of hold that

should be applied. (HOLD_ID from
OE_HOLD_DEFINITIONS)
param2 Hold entity code for the hold source to be

created.
C: Customer hold source
S: Bill To or Ship To hold source
I: Item hold source
O: Order hold source
W: Warehouse Hold Source
param3 Hold entity ID
C, B, or S: for Org ID
O: Header ID
I: Inventory Item ID
param4 Hold comment
date_param1 Hold Until Date
parm6-param20 Attribute1-15 of the descriptive flexfield

associated with the hold source record.
Release Hold
Releases the holds associated with an order or line.
Release Hold
request_type OE_GLOBALS.G_RELEASE_HOLD

order or
OE_GLOBALS.G_ENTITY_LINE for line.

entity_id ID of the order or line to be released from hold
param1 Hold ID to specify the type of hold that is to

be removed.
param2 Hold entity code on the hold source associated

with the hold to be released
C: Customer hold source
S: Bill To or Ship To hold source
I: Item hold source
O: Order hold source
W: Warehouse Hold Source
param3 Hold entity ID:
C or S: for Org ID
O: Header ID
I: Inventory Item ID
param4 Release Reason Code
param5 Release Comment
Delink Config
This request deletes the configuration item.
Delink Config
request_type OE_GLOBALS.G_DELINK_CONFIG
entity_code OE_GLOBALS.G_ENTITY_LINE
entity_id Line ID of the top model line of the ATO

configuration
Match and Reserve
This request checks if an existing configuration item matches the configuration created
by the user and if configuration item is available, it reserves it.
Match and Reserve
request_type OE_GLOBALS.G_MATCH_AND_RESERVE
entity_code OE_GLOBALS.G_ENTITY_LINE
entity_id Line ID of the top model line of the ATO

configuration
Get Ship Method

The actions can be performed only if the system parameter Enable Ship Method is
enabled. Oracle Order Management will use the routing guides defined in product
transportation to get the most appropriate carrier and ship method, dependent on
defined business rules. The action always works on the entire order at a time. The action
ignores following type of lines while deriving the ship method,
1. Dropship lines
2. Return lines
3. Service lines
4. CONFIG lines (The line created after progressing ATO model once it is booked and
scheduled)
5. Lines that are already shipped
6. Lines that are already fulfilled
7. Lines that are already closed
8. Lines which do not have all required parameters. e.g. ship from, ship to.
Get Ship Method

request_type OE_GLOBALS. G_GET_SHIP_METHOD
entity_code OE_GLOBALS.G_ENTITY_HEADER or
OE_GLOBALS.G_ENTITY_HEADER
entity_id Header ID if entity is LINE
Line ID if entity is LINE
Add/Remove from Fulfillment Set

Add or remove lines from fulfillment sets. The Parameter Description is as follows:
request_type OE_GLOBALS.G_ADD_FULFILLMENT_SET or
OE_GLOBALS.G_REMOVE_FULFILLMENT_SET
entity_code OE_GLOBALS.G_ENTITY_LINE for line.
entity_id Line ID of the line
param5 Fulfillment Set Name
Action Request Example
Process order can also process other action requests on the order or line as has been
mentioned previously.
Apply a hold to an order line due to a defective item.
-- ACTION REQUEST RECORD
-- Indicates that it is a line level action
l_request_rec.entity := OE_GLOBALS.G_ENTITY_LINE;
-- primary key of the line on which the hold is to be applied
l_request_rec.entity_id := 100;
-- name of the action request
l_request_rec.request_name := OE_GLOBALS.G_APPLY_HOLD;
-- request record parameters
-- defective product hold (hold_id)
-- indicator that it is an item hold (hold_entity_code)
l_request_rec.param2 = 'I';
-- Id of the item (hold_entity_id)
-- inserting request record into the action request table
l_action_request_tbl := l_request_rec;
See:
Oracle Applications Message Reference Manual
Oracle Order Management User's Guide

8
Oracle Order Management: Integration with
Other Products
Integrating Oracle Order Management with Oracle Receivables and

Invoicing
Oracle Order Management provides functionality to integrate with Oracle Receivables.
Using AutoInvoice, you can create invoices, create credit memos and credits on account,
recognize revenue, and manage sales credits.
Basic Needs
Oracle Order Management and Oracle Receivables provide features you need to satisfy
the following integration needs:
• Create accurate and timely invoices, credit memos, and credits on account from
Order Management transactions
• Control when order transactions are invoiced
Major Features
Invoicing Activity
Order Management provides a program that automatically collects order and return
information and populates the Oracle Receivables AutoInvoice interface tables. Using
order management transaction types, profile options and system parameters, you
control certain accounting aspects of the information being transferred to Oracle
Receivables. Invoicing module is modeled using workflow and can happen after
shipping for shippable flows and any time after booking for non-shippable flows.
Invoicing can be placed at both order line level workflows as well as order header level
workflows. If placed at the order header level, all lines in an order are populated in
Oracle Order Management: Integration with Other Products 8-1

AutoInvoice interface tables at the same time.
Invoice Source
You must setup invoice sources in Oracle Receivables prior to using Oracle Order
Management. Order Management uses the invoice source setup at the transaction type
level or the system parameter Invoice Source when populating order line information
into AutoInvoice interface tables. When defining invoice sources in Oracle Receivables,
you must create at least one invoice source for Order Management's use if you want to
interface orders and returns for processing by AutoInvoice.
The following table shows the necessary field values for the Transaction Source window
in Oracle Receivables.
Transaction Sources Window: Required Settings
Field in Transaction Sources Window Necessary Value
Batch Source region
Type Imported
Status Active
Automatic Transaction Numbering Yes if OM: Invoice Numbering Method is set

to Automatic, No if set to Delivery Name
Customer Information region Customer Information region
Sold-to Customer Id
Bill-to Customer Id
Bill-to Address Id
Bill-to Contact Id
Ship-to Customer Id
Ship-to Address Id
Ship-to Contact Id
Payment Method Rule (any)
Customer Bank Account (any)
Accounting Information region Accounting Information region
Invoicing Rule Id
Accounting Rule Id
Accounting Flexfield (any)
Derive Date (any)
Payment Terms Id
Revenue Account allocation (any)
Other Information region Other Information region
Transaction Type Id
Memo Reason Id
Agreement Id
Memo Line Rule Id
Sales Territory (any)
Inventory Item Id
Unit of Measure Id
FOB Point Code
Freight Carrier Code
Related Document Id
Sales Credits Validation region Sales Credits Validation region

Salesperson Id
Sales Credit Type Id
Sales Credit Percent
Note: In the Batch Source region, you must define at least one
transaction source with automatic invoice numbering, regardless of
your setting for the OM: Invoice Numbering Method profile.
Automatic Tax Calculation

As orders from Order Management are processed, AutoInvoice automatically calculates
sales tax based on the Sales Tax Location flexfield combination. If you have designated
a customer as tax-exempt, AutoInvoice will not tax any items billed for the customer.
Similarly, if you have designated an item as non-taxable, AutoInvoice will not tax the
item.
Automatic Account Code Creation
Oracle Receivables uses AutoAccounting to determine the revenue account for all
transactions from Order Management. AutoAccounting lets you define what
information is used to define the various segments of your Accounting Flexfield.
Accounting and Invoicing Rules
Order Management uses accounting and invoicing rules. This information is transferred
to Oracle Receivables and used to determine the invoice date (invoicing rule) and
general ledger distribution records (accounting rule). Order Management passes an
invoicing rule and accounting rule for each order transaction interfaced to Oracle
Receivables, except for when the accounting rule is Immediate, in which case Order
Management does not pass any value (inserts null).
Credit Method for Accounting Rule
Order Management transfers a Credit Method for Accounting Rule for each return line.
This credit method is recognized only by invoices that use duration accounting rules.
You can assign a Credit Method for Accounting Rule to the order type of the return. If
the Credit Method for Accounting Rule field for the order type is null, then Order
Management transfers LIFO (Last In First Out).
Credit Method for Installments
Order Management transfers a Credit Method for Installments for each return line. This
credit method is used for crediting an invoice that uses split payment terms. You can
assign a Credit Method for Installments to the order type of the return. If the Credit
Method for Installments field for the order type is null, then Order Management
transfers LIFO (Last In First Out).
Internal Sales Orders
The Invoicing Activity does not process internal sales order lines, even if it is placed in
the internal sales order's workflow. However, freight charges associated with the
internal order lines are interfaced to Receivables.
Internal sales orders are orders that originate in Oracle Purchasing as internal
requisitions, and are imported to Order Management as internal sales orders using
Order Import.
See:
Using AutoAccounting, Oracle Receivables User's Guide
Accounting Rules, Oracle Receivables User's Guide
Entering Commitments, Oracle Receivables User's Guide
Defining Items, Oracle Inventory User's Guide
Accounting for Credit Memos, Oracle Receivables User's Guide
Invoicing of ATO Configurations
Invoicing Attributes
For ATO configurations, Order Management considers the base model's item attribute
of a configuration to see if it should consider passing invoice information to Oracle
Receivables for each order line in the configuration. If you have the item attributes
Invoiceable Item and Invoice Enabled set to Yes for the base model item, Order
Management then considers these item attributes for each component in the bill of
material for the model to see if they should be invoiced in Oracle Receivables. If the
item attributes Invoiceable Item or Invoice Enabled are set to No for the base model
item, Order Management does not pass invoicing information to Oracle Receivables for
any order lines for the components within the configuration, regardless of the item
attribute settings.
Required for Revenue Attribute
The bill of material attribute Required for Revenue allows you to define specific items in
a bill that must be shipped before their parent can be invoiced. In all cases the control
applies to only one level, the immediate parent. Except for classes, the control
relationship is the child affecting the parent.
For example: Included Item A has the Required for Revenue attribute set to Yes. Option
A is not eligible to interface to Oracle Receivables until Included Item A is shipped,
even if Option A is also shippable and has shipped. All other components, including
Model A and Model 1, are eligible to interface regardless of Included Item A's shipment
status.
Example #2: Included Item B has the Required for Revenue attribute set to Yes. Model 1
is not eligible to interface to Oracle Receivables until Included Item B is shipped. And
again, Option A is not eligible to interface until Included Item A is shipped.
Example #3: If any item below a class in a bill has the Required for Revenue attribute set

to Yes, then that item must be shipped before the parent item and the other items in the
class are eligible to interface. For example, in the figure above, Included Item C has the
Required for Revenue attribute set to Yes. Therefore, both Option C and Class C are not
eligible to interface until Included Item C is shipped.
See:
Item Attributes Used by Order Management, Oracle Order Management User's Guide
Overview of Bills of Material,Oracle Bills of Material User's Guide
Understanding the Receivables Interface Tables

Oracle Order Management inserts information into two of the three AutoInvoice
interface tables (RA_INTERFACE_LINES and RA_INTERFACE_SALES_CREDITS).
RA_INTERFACE_ DISTRIBUTIONS is not described in this essay because all account
code creation is done by AutoInvoice based on the AutoAccounting rules you have
defined. For customer acceptance, AR_INTERFACE_CONTS_ALL is populated for all
lines that have contingencies attached to them. This information is interfaced to
Receivables for lines and discount lines. This information is not passed for freight
charges. If the line has pre-billing customer acceptance and it is rejected then Oracle
Order Management does pass the invoicing information for this line to Receivables.
Associated freight charges also will not be interfaced to Receivables in this case.
The following describes what information Order Management interfaces for each order
and order line, each sales credit, and each freight charge.
Note: Order Management line numbers are populated in the following

manner within RA_INTERFACE_LINES.:
INTERFACE_LINE_ATTRIBUTE6 (line_id)
INTERFACE_LINE_ATTRIBUTE12 (shipment_number)
INTERFACE_LINE_ATTRIBUTE13 (option_number)
INTERFACE_LINE_ATTRIBUTE14 (service_number)
RA_INTERFACE_LINES
Column Name Null? Type Description What is inserted by

Invoicing Module
INTERFACE_LINE_ID NA NUMBER( Order Management None

15) does not insert a
value into this
column.
Invoicing Module
INTERFACE_LINE_C NA Varchar2(3 Order Management Profile option OM:

ONTEXT 0) inserts your value for Source Code
the OM: Source Code
profile option
INTERFACE_LINE_AT NA Varchar2(3 Order Management header.order_number

TRIBUTE1 0) inserts
OE_HEADERS.ORDE
R_NUMBER.
INTERFACE_LINE_AT NA Varchar2(3 Order Management type.name

TRIBUTE2 0) inserts
OE_ORDER_TYPES_
V.NAME in the base
language.
INTERFACE_LINE_AT NA Varchar2(3 For a Shipped order line The available values

TRIBUTE3 0) and for Freight Charges: are:
Order Management
• Shipped order
inserts substr
(wsh_new_deliveries. line: del.name
name1..30
• Non-Shipped
For a Non-shipped order line.1
order line or a Return
Line: Order • Return lines: 0
Management inserts 0
(zero)
(zero).
• Freight Charges:
delivery name
• Discount lines: 0
(zero)

Invoicing Module
INTERFACE_LINE_AT NA Varchar2(3 For a Shipped order line Shipped order line:

TRIBUTE4 0) and for Freight Charges: substr(del.waybill,1,3
Order Management 0)
inserts:
substr(wsh_new_deli Non-Shipped order
veries.waybill1..30 line: 0 (zero)
For a Non-shipped Return lines: 0 (zero)

order line or a Return Freight Charges:
Line: Order substr(del.waybill,1,3
Management inserts 0 0)
(zero).
Discount lines: 0
(zero)
INTERFACE_LINE_AT NA Varchar2(3 For a Sales order or Sales Order lines and

TRIBUTE5 0) return line: Order Return lines: the
Management inserts number of times the
the number of times order or return line
the order or return has been interfaced
line has been for invoice or credit.
interfaced for invoice
or credit. Freight Charges: 1
(one)
For Freight charges:
Order Management
inserts a value of 1
(one).
INTERFACE_LINE_AT NA Varchar2(3 For a Sales order or The available values

TRIBUTE6 0) return line: Order are:
Management inserts
• Sales Order lines
OE_ORDER_LINES.L
INE_ID. and Return lines:
line.line_id
OE_CHARGE_LINES • Discount lines:
_ V.CHARGE_ID. line.line_id
charge.charge _id
Invoicing Module
INTERFACE_LINE_AT NA Varchar2(3 For a shipped order line, The available values

TRIBUTE7 0) a return line, or for are:
Freight Charges: Order
• Shipped order
Management inserts
zero (0). line: 0
• Return lines: 0
(zero)
0 (zero)
INTERFACE_LINE_AT NA Varchar2(3 For a shipped order line: The available values

TRIBUTE8 0) Bill of Lading are:
For a non-shipped order • Shipped order

line, a return line, or for line:
Freight Charges: Order wsh_document_i
Management inserts nstances.sequenc
zero (0). e_number
• Non-Shipped
order line: 0
(zero)
• Return lines: 0
(zero)
0
• Discount lines: 0
(zero)
INTERFACE_LINE_AT NA Varchar2(3 Order Management Insert customer item

TRIBUTE9 0) inserts the customer number if one is
item number, if one is defined, otherwise
defined. Otherwise, it insert 0 (zero).
inserts 0 (zero).

Invoicing Module
INTERFACE_LINE_AT NA Varchar2(3 Order Management NA

TRIBUTE10 0) inserts
OE_ORDER_LINES.S
HIP_FROM_ORD_ID.
INTERFACE_LINE_AT NA Varchar2(3 Order Management Discount lines:

TRIBUTE11 0) inserts pa.price_adjustment_i
oe_price_adjustments. d
price_adjustment_id
for discount lines:
Note: System
Parameter Show
Discount Details on
Invoice must be Yes.
For all other lines the

value 0 is passed.
INTERFACE_LINE_AT NA Varchar2(3 Order Management The available values

TRIBUTE12 0) inserts are:
oe_order_lines_all.shi
• Sales Order lines,
pment_number
Return lines, and
Discount lines:
line.shipment_nu
mber
None

oe_order_lines_all.opt
ion_number
Return lines, and
Discount lines:
line.option_num
ber
None
Invoicing Module

oe_order_lines_all.ser
vice_number
Return lines, and
Discount line:
line.service_num
ber
None
INTERFACE_LINE_AT NA Varchar2(3 Order Management Null

TRIBUTE15 0) does not insert a
value into this
column

Invoicing Module
BATCH_SOURCE_NA Not Varchar2(5 Order Management Invoice Source from

ME Null 0) enters the invoice the hierarchy:
source name using
• Line type
the following rules:
If the profile option • Order type

OM: Invoice
Numbering Method is • System
set to Delivery Name,
Parameter
but line is
Invoice Source
non-shippable or a
return line, Order
Management passes
the value of the
system parameterOM:
Non-Delivery Invoice
Source.
For all other lines,

Order Management
uses the following
sequence to
determine the invoice
source:
1. Order Transaction
Type associated with
the order line being
interfaced to
AutoInvoice.
2. Order Line
Transaction Type
associated with the
order line being
interfaced to
AutoInvoice.
3. Value of the system

parameter Invoice
Source.
Invoicing Module
SET_OF_BOOKS_ID Not NUMBER Order Management OE_Sys_Parameters.v

Null (15) inserts the ID from alue
the OE: Set of Books (SET_OF_BOOKS_ID)
system parameter for
the operating unit of
the order line.
LINE _TYPE Not Varchar2(2 For a Sales order or The available values
Null 0) return line: Order are:
Management inserts
• Line: For sales
LINE.
order lines,
For Freight charges: return lines and
Order Management discount lines:
inserts FREIGHT for
shipment freight • Freight Charges:
charges if the system Can be either
parameterInvoice
Freight as Revenue is • Line: If the
set to No, otherwise system
the system inserts parameter
LINE. Invoice
Freight as
Revenue and
profile
option
EBTax:
Allow
Override of
Tax Code are
set to YES.
• Otherwise,
the value is
Freight
Charges.

Invoicing Module
DESCRIPTION Not Varchar2(2 For a Sales order or The available values

Null 40) return line: are:
Order Management • Sales Order lines

inserts and Return lines:
MTL_SYSTEM_ITEM Customer and
S.DESCRIPTION for generic items get
the item or if order customer and
line uses item generic item
identifiers descriptions if it
(item/generic item): exists. Otherwise,
the
• if a description mtl_system_it
exists, customer em.descriptio
item/generic item n for service
description is lines,
passed. concatenates the
following: service
• if the description item description,
is null then service quantity,
mtl_system_item serviced item
s_vl.description description,
is passed service start date,
and service end
For Freight date.
charges: Order
Management • Freight Charges:
inserts If passed as a
description of the revenue line,
change then the freight
(OE_CHARGE_T item description
YPES.description appears.
) for shipment Otherwise, the
freight charges. standard
description is
transferred from
the AR lookup.
Invoicing Module
CURRENCY_CODE Not Varchar2(3 oe_order_headers.tra Shipped order lines

Null 0) nsactiona_curr_code and Discount lines:
for all shipped/non header.transactional_
shipped order/return currency_code
lines.
Non-shipped line or
Return lines:
header.transactional_
currency_code
Freight Charges:
charge.transactional_c
urrency_code
AMOUNT NA NUMBER For a Sales order or Sales Order lines and

return line: Order Return lines: if the
Management inserts a system parameter
calculated amount Show discount details
(OE_ORDER_LINES. on Invoice is Yes, then
UNIT_SELLING_PRI quantity_to_invo
CE multiplied by ice *
line.list_price
OE_ORDER_LINES.O
Otherwise, the
RDERED_QUANTIT
following will be
Y) based on the
calculated quantity
calculated quantity. *
Order Management line.list_price.
rounds the amount For returns, the
based on the amount will be * -1.
minimum accounting
unit and precision Note: All prices
associated with the are based on
currency of the order. Ordered UOM.
The amount sign will
match the sign on the
quantity based on the
value of
RA_CUST_TRX_TYP
ES.CREATION_SIGN
.

Order Management
inserts:
oe_charge_lines_v.cha
rge_amount

Invoicing Module
CUST_TRX_TYPE_NA NA Varchar2(2 Order Management NA

ME 0) does not insert a
value into this
column
CUST_TRX_TYPE_ID NA NUMBER Please refer to the Shipped order line

(15) heading and Discount lines.
CUST_TRX_TYPE_ID
at the end of this table Return lines: See
for more information notes on
cust_trx_type_id
under defining OE
Transaction Type
form.
Freight Charges:
Same as order line.
TERM_NAME NA Varchar2(1 Order Management NA

value into this
column.
TERM_ID NUMBER For a Sales order line: The available values

(15) Order Management are:
inserts
• Sales order line,
OE_ORDER_LINES.P
AYMENT_TERM_ID. discount lines:
line.payment_ter
For a Return line: m_id
Order Management
does not insert a • Return lines:
value into this None
column.
Order Management line.payment_ter
inserts: m_id
oe_order_lines_all.pa
yment_term_id.
ORIG_SYSTEM_BILL_ NA Varchar2(2 Order Management NA

CUSTOMER_REF 40) does not insert a
value into this
column.
Invoicing Module
ORIG_SYSTEM_BILL_ NA NUMBER( Order Management customer_id

CUSTOMER_ID 15) inserts: associated with the
line.invoice_to_site_id
SELECT customer_id
FROM
oe_invoice_to_orgs_v
WHERE
organization_id =
oe_order_lines.invoic
e_to_org_id

ADDRESS_REF 40) does not insert a
value into this
column.
ORIG_SYSTEM_BILL_ NA NUMBER Order Management address_id associated

ADDRESS_ID (15) inserts: with the
line.invoice_to_site_id
SELECT address_id
FROM
oe_invoice_to_orgs_v
WHERE
organization_id =
e_to_org_id

CONTACT_REF 40) does not insert a
value into this
column.
ORIG_SYSTEM_BILL_ NA NUMBER Order Management line.invoice_to_contac

CONTACT_ID (15) inserts: t_id
e_to_contact_id
ORIG_SYSTEM_SHIP_ NA Varchar2(2 Order Management NA

CUSTOMER_REF 40) does not insert a
value into this
column

Invoicing Module
ORIG_SYSTEM_SHIP_ NA NUMBER Order Management customer_id

CUSTOMER_ID (15) inserts associated with
line.ship_to_site_use_
SELECT customer_id id
FROM
oe_ship_to_orgs_v
WHERE
organization_id =
oe_order_lines.ship_t
o_org_id

ADDRESS_REF 40) does not insert a
value into this
column.
ORIG_SYSTEM_SHIP_ NA NUMBER( For a Sales order or The address_id

ADDRESS_ID 15) return line: Order associated with
Management inserts ship_to_site_use_id of
RA_SITE_USES.ADD line.
RESS_ID FROM
RA_ADDRESSES
WHERE
RA_SITE_USES.SITE_
USE_ID =
NVL(OE_ORDER_LI
NES.SHIP_TO_SITE_
USE_ID,
OE_ORDER_HEADE
RS.SHIP_TO_SITE_U
SE_ID))).

Order Management
inserts
RA_SITE_USES.ADD
RESS_ID FROM
RA_ADDRESSES
WHERE
RA_SITE_USES.SITE_
USE_ID =
OE_ORDER_HEADE
RS.SHIP_TO_SITE_U
SE_ID).
Invoicing Module

CONTACT_REF 4) does not insert a
value into this
column.
ORIG_SYSTEM_SHIP_ NA NUMBER( Order Management The available values

CONTACT_ID 15) inserts: are:
oe_order_lines.ship_t
o_contact_id
and Return lines:
line.ship_to_cont
act_id.
line.ship_to_cont
act_id.
ORIG_SYSTEM_SOLD NA Varchar2(2 Order Management NA

_CUSTOMER_REF 40) does not insert a
value into this
column.
ORIG_SYSTEM_SOLD NA NUMBER( Order Management address_id associated

_CUSTOMER_ID 15) inserts with sold_to_org_id
OE_ORDER__HEAD of line
ERS.SOLD_TO_ORG_
ID.
LINK_TO_LINE_ID NA NUMBER( Order Management NA

value into this
column.
LINK_TO_LINE_CON NA Vharchar2( Order Management NA

TEXT 30) does not insert a
value into this
column.
LINK_TO_LINE_ATTR NA Vharchar2( Order Management NA

IBUTE1 - 15 30) does not insert any
values into any of
these columns.

Invoicing Module
RECEIPT_METHOD_ NA Vharchar2( Order Management NA

NAME 30) does not insert a
value into this
column.
RECEIPT_METHOD_I NA NUMBER( Order Management NA

D 15) does not insert a
value into this
column.
CONVERSION_TYPE Not Varchar2(3 Order Management nvl

NULL 0) inserts (header.conversion_ty
NVL(OE_ORDER_HE pe,'User')
ADERS.CONVERSIO
N_ TYPE, User).
CONVERSION_DATE NA Date Order Management header.conversion_da

inserts te
OE_ORDER_HEADE
RS.CONVERSION_D
ATE.
CONVERSION_RATE NA NUMBER Order Management header.conversion_rat

inserts e
OE_ORDER_HEADE
RS.CONVERSION_R
ATE.
CUSTOMER_TRX_ID NA NUMBER( Order Management NA

value into this
column.
TRX_DATE NA Date Order Management NA

does not insert a
value into this
column.
GL_DATE NA Date Order Management NA

does not insert a
value into this
column.
Invoicing Module
DOCUMENT_NUMBE NA NUMBER( Order Management NA

R 15) does not insert a
value into this
column.
TRX_NUMBER NA Varchar2(2 If the OM: Invoice If the OM: Invoice

40) Numbering Method Numbering Method is
profile is set to set to Delivery Name,
Automatic, then insert the
AutoInvoice delivery name.
determines a unique
number for this
transaction. If the
profile is set to
Delivery Name, Order
Management inserts a
delivery name. An
index is appended if
the delivery has more
than one invoice. For
example, Order
Management might
insert delivery for the
first invoice, delivery-1
for the second,
delivery-2 for the
third, and so on.
LINE_NUMBER NA NUMBER( Order Management NA

value into this
column.

Invoicing Module
QUANTITY NA NUMBER Order Management Use the following

inserts a calculated hierarchy for sales
quantity based on the order lines, return
type of line being lines, and discount
interfaced. This lines:
calculation is based
• Fulfilled quantity
on rules for
fulfillment, over and
under shipments, • Shipped quantity
required for revenue
and what was • Ordered quantity
previously invoiced.
For a Sales order line:
None
The quantity will be
either negative or
positive, depending
on the value of
RA_CUST_TRX_TYP
ES.CREATION_SIGN
associated with the
invoice type for the
sales order. If
RA_CUST_TRX_TYP
ES.
CREATION_SIGN is
N, then quantity
passed is -1
multiplied by the
quantity calculated.
QUANTITY_ORDERE NA NUMBER For a Sales order line or The available values

D return line: Order are:
Management inserts
OE_ORDER_LINES.O
RDERED_QUANTIT and Return lines:
Y. line.ordered_qua
ntity
Order Management • Freight Charges:
does not insert a None
value into this
column • Discount Lines:
line.ordered_qua
ntity
Invoicing Module
UNIT_SELLING_PRIC NA NUMBER For a Sales order line or Sales Order lines and
E return lines: Order Return lines: Depends
Management inserts on whether you want
OE_ORDER_LINES.U to show discount
NIT_SELLING_PRIC details:
E.
• Show discounts
For Freight charges: Y (Yes):
Order Management line.unit_list_pric
does not insert a e.
value into this
column. • Show discounts
N (No):
line.selling_price.
None.
• Discount lines:
Use pricing API.
Show discounts
Y (Yes).
UNIT_SELLING_PRIC NA NUMBER Unit Selling Price Per NA

E_PER_PQTY Pricing Quantity.
UNIT_STANDARD_P NA NUMBER For a Sales order line or The available values

RICE return line: Order are:
Management inserts
OE_ORDER_LINES.U
NIT_LIST_PRICE. and Return lines:
line.list_price.
does not insert a None.
value into this
column. • Discount lines:
Use pricing API.
Show discounts
Y (Yes).

Invoicing Module
PRINTING_OPTION NA Varchar2(2 Order Management NA

value into this
column.
INTERFACE_STATUS NA Varchar2(1 Order Management NA

) does not insert a
value into this
column.
REQUEST_ID NA NUMBER( Order Management NA

value into this
column.
RELATED_BATCH_S NA Varchar2(5 Order Management NA

OURCE_NAME 0) does not insert a
value into this
column.
RELATED_TRX_NUM NA Varchar2(2 Order Management NA

BER 0) does not insert a
value into this
column.
RELATED_CUSTOME NA NUMBER( Order Management NA

R_TRX_ID 15) does not insert a
value into this
column.
PREVIOUS_CUSTOME NA NUMBER( Order Management NA

R_TRX_ID 15) does not insert a
value into this
column.
Invoicing Module
CREDIT_METHOD_F NA Varchar2(3 For a Sales order line: The available values

OR_ACCT_RULE 0) Order Management are:
does not insert a
• Sales Order lines:
value into this
column. None
For a Return line: • Return lines

Order Management
inserts from based
upon the following
hierarchy:
1. Line transaction
type
2. Order transaction
type
3. else insert constant

value LIFO
CREDIT_METHOD_F NA Varchar2(3 For a Sales order line: The available values

OR_INSTALLMENTS 0) Order Management are:
does not insert a
• Sales order lines:
value into this
column. None
For a Return line: • Return lines

Order Management
inserts from based
upon the following
hierarchy:
1. Line transaction
type
2. Order transaction
type

Invoicing Module
REASON_CODE NA Varchar2(3 For a Sales order line: The available values

0 Order Management are:
does not insert a
• Sales order lines:
value into this
column. None
For a Return line: • Return lines:

Order Management line.return_reaso
inserts n_code
OE_ORDER_LINES.R
ETURN_
REASON_CODE
TAX_RATE NA NUMBER Order Management NA

does not insert a
value into this
column.
TAX_CODE NA Varchar2(5 If Tax: Allow Override The available values

0) of Tax Code = Yes, then are:
pass
• Sales order lines,
oe_order_lines.tax_co
de return lines, and
discount lines: if
profile option
EBTAX: Allow
Override of
Tax Code is set
to YES, then
interface
line.tax_code,
otherwise the
interface returns
a NULL value.
None
TAX_PRECEDENCE NA NUMBER( Order Management NA

value into this
column.
Invoicing Module
EXCEPTION_ID NA NUMBER( Order Management NA

value into this
column.
EXEMPTION_ID NA NUMBER( Order Management NA

value into this
column.
SHIP_DATE_ACTUAL NA Date For a Shipped order The available values

lines and for Freight are:
charge lines: Order
• Shipped order
Management inserts:
wsh_new_deliveries.i line and discount
nitial_pickup_date. lines:
line.actual_shipm
For a Non-shipped order ent_date
line: If profile OM: Set
Receivables • Non-shipped
Transaction Date as order line: If
Current Date for profile option
Non-Shippable Lines OM: Set
is Yes then sysdate Receivables
otherwise NULL Transaction Date
as Current Date
for
Order Management
Non-Shippable
inserts
Lines is Yes then
OE_ORDER_LINE_A
sysdate
CTUAL_SHIPMENT_
otherwise NULL.
DATE.
For Return line: • Freight charges:

rcv_transactions. line.actual_shipm
transaction_date ent_date
• Return line:
rcv_transactions.
transaction_date

Invoicing Module
FOB_POINT NA Varchar2(2 Order Management NA

0) only populates this
column if the order
line being invoiced
has been shipped.
For a Shipped order

line: Order
Management inserts
OE_ORDER_LINES.F
OB_POINT_CODE.
For a Non-shipped order

line: Order
Management does not
insert a value into this
column.

Order Management
inserts
OE_ORDER_LINES.F
OB_POINT_CODE.
SHIP_VIA NA Varchar2(2 Either The available values

0) nvl(wsh_carrier_ship are:
_methods_v.feight_co
• Shipped order
de or
oe_order_lines.freight line, discount
_carrier_code) line: nvl ( freight
carrier associated
with
del.shipping_met
hod_code,
line..freight_carri
er_code)
• Non-shipped
order line: None
same as line.
Invoicing Module
WAYBILL_NUMBER NA Varchar2(5 For a Shipped order line The available values

0) and For Freight charges: are:
Order Management
• Shipped order
inserts:
substr(wsh_new_deli line: delivery
veries.waybill,1,30) waybill
For a Non-shipped order • Non-shipped

line: Order order line: None
Management does not
insert a value into this • Freight charges:
column.
delivery waybill
• Discount lines:
None
INVOICING_RULE_N NA Varchar2(3 Order Management NA

AME 0) does not insert a
value into this
column.
INVOICING_RULE_ID NA NUMBER( For a Sales order line The available values

15) and for Freight charge are:
lines: Order
• Sales order lines
Management inserts
DECODE(ACCOUNT and discount
ING_RULE_ID,1, lines: decode
NULL,INVOICING_ (accounting_rule
RULE_ID). _id,1,NULL,invoi
cing_rule_id)
For a Non-shipped order
line: Order • Return lines:
Management does not None
insert a value into this
column. • Freight charges:
decode(accountin
g_rule_id,1,NUL
L,invoicing_rule_
id)

Invoicing Module
ACCOUNTING_RULE NA Varchar2(3 Order Management NA

_NAME 0) does not insert a
value into this
column.
ACCOUNTING_RULE NA NUMBER( For a Sales order line The available values

_ID 15) and for Freight charge are:
lines: Order
Management inserts
DECODE(ACCOUNT and Discount
ING_RULE_ID,1, lines:
NULL,ACCOUNTIN decode(accountin
G_RULE_ID). g_rule_id,1,NUL
L,accounting_rul
For a Return line: e_id)
Order Management
does not insert a • Return lines:
value into this None
column.
• Freight charges:
decode(accountin
g_rule_id,1,NUL
L,accounting_rul
e_id)
ACCOUNTING_RULE NA NUMBER( If the accounting rule The available values

_DURATION 15) is of type Variable are:
Duration then insert
• Service line: If
Service Duration for
Service lines. accounting_rule
is of type variable
duration
(ACC_DUR) then
insert service
duration.
• Other line: None.
RULE_START_DATE NA Date Order Management oe_order_lines.service

inserts _start_date
oe_order_lines.service
_start_date into this
column.
Invoicing Module
PRIMARY_SALESREP NA Varchar2(3 Order Management NA

_NUMBER 0) does not insert a
value into this
column.
PRIMARY_SALESREP NA NUMBER( Order Management nvl(line.salesrep_id,

_ID 15) inserts NVL header.salesrep_id)
(OE_ORDER_LINES.
SALESREP_ID,
OE_ORDER_HEADE
RS.SALESREP_ID.
SALES_ORDER NA Varchar2(5 Order Management header.order_number

0) inserts
OE_ORDER_HEADE
RS.ORDER_NUMBER
.
SALES_ORDER_LINE NA Varchar2(3 For a Sales order or The available values

0) return line: Order are:
Management inserts
OE_ORDER_LINES.L
INE_NUMBER. and return lines:
line.line_number
value into this
line.line_number
SALES_ORDER_DATE NA Date Order Management header.ordered_date

inserts
OE_ORDER_HEADE
RS.ORDERED_DATE.
SALES_ORDER_SOUR NA Varchar2(5 Order Management profile option OM:

CE 0) inserts your value for Source code
the OM: Source Code
profile option.

Invoicing Module
SALES_ORDER_REVIS NA NUMBER Order Management NA

ION does not insert a
value into this
column.
PURCHASE_ORDER NA Varchar2(5 Order Management line.cust_po_number

0) inserts
OE_ORDER_HEADE
RS.LINES.CUST_PO_
NUMBER.
PURCHASE_ORDER_ NA Varchar2(5 Order Management NA

REVISION 0) does not insert a
value into this
column.
PURCHASE_ORDER_ NA Date Order Management NA

DATE does not insert a
value into this
column.
AGREEMENT_NAME NA Varchar2(3 Order Management NA

value into this
column.
Invoicing Module
AGREEMENT_ID NA NUMBER( For a Sales order line: The available values

15) Order Management are:
inserts
OE_ORDER_LINES.A
GREEMENT_ID. and Discount
lines:
For a Return line with a line.agreement_i
purchase order or sales d
order reference: Order
Management inserts • Return lines:
the AGREEMENT_ID agreement_id
from the referenced from the
order line. referenced order
header.
For return lines with an
invoice reference: Order
Management does not
insert a value into this None
column.

Order Management
does not insert a
value into this
column.
MEMO_LINE_NAME NA Varchar2(5 Order Management NA

value into this
column.
MEMO_LINE_ID NA NUMBER( Order Management NA

value into this
column.

Invoicing Module
INVENTORY_ITEM_I NA NUMBER( For a Sales order or The available values

D 15) return line: Order are:
Management inserts
OE_ORDER_LINES.I
NVENTORY_ITEM_I and Return lines:
D. line.inventory_ite
m_id
does not insert a can be either:
value into this
column. If the system • NULL if the
parameter Invoice parameter
Freight As Revenue is Invoice
set to Yes, the value of Freight as
the system parameter Revenue is
Inventory Item For set to No, or
Freight is used. set by
system
parameter
Inventory
Item for
Freight
• Discount
lines: None
MTL_SYSTEM_ITEMS NA Varchar2(3 Order Management NA

_SEG1....20 0) does not insert values
into any of these
columns.
Invoicing Module
REFERENCE_LINE_ID NA NUMBER( For a Sales order line: The available values

15) Order Management are:
inserts
• Sales Order lines:
OE_ORDER_LINES.C
OMMITMENT_ID. cust_trx_id from
the
For a Return line: line.commitment
Order Management _id
inserts
OE_ORDER_LINES.C • Return lines:
REDIT_INVOICE_LI line.reference_lin
NE_ID. e_id
Order Management
value into this
pa.line_id
REFERENCE_LINE_C NA Varchar2(3 Order Management NA

ONTEXT 0) does not insert a
value into this
column.
REFERENCE_LINE_A NA Varchar2(3 Order Management NA

TTRIBUTE1....15 0) does not insert a
value into this
column.

Invoicing Module
TERRITORY_ID NA NUMBER( Order Management The value is derived

15) does not insert a from the following:
value into this
• Get default
column.
territory from AR
system
parameter.
• Get territory ID
from one of the
following tables.
If default
territory is
• SALES: join
ra_sales_rep
_territory
using the
sales rep id.
• BILL: join
ra_site_uses
using
line.invoice_
to_org_id
• SHIP: join
ra_site_uses
using
line.ship_to_
org_id.
TERRITORY_SEGMEN NA Varchar2(2 Order Management Join the territory ID

T1....20 5) does not insert a above with
value into this ra_territories to get
column. these segments.
Invoicing Module
ATTRIBUTE_CATEGO NA Varchar2(3 For a Sales order or The available values

RY 0) return line: Order are:
Management inserts
OE_ORDER_LINES.C
ONTEXT. and Return lines:
line.context
Order Management • Freight charges:
inserts charge.context
OE_CHARGE_LINES
_V.CONTEXT. • Discount lines:
pa.context
ATTRIBUTE1...15 NA Varchar2(1 For a Sales order or The available values

50) return line: Order are:
Management inserts
OE_ORDER_LINES.A
TTRIBUTE1-15. and return lines:
line.attribute1-15
Order Management • Freight charges:
inserts charge.attribute1-
OE_CHARGE_LINES 15
_V. ATTRIBUTE1-15.
• Discount lines:
pa.attribute1-15
HEADER_ATTRIBUTE NA Varchar2(3 For Sales order or header.context

_CATEGORY 0) return line: Order
Management inserts
OE_ORDER_HEADE
RS.CONTEXT.

Order Management
does not insert a
value into this
column.

Invoicing Module
HEADER_ATTRIBUTE NA Varchar2(1 For a Sales order or header.attribute1-15

1...15 50) return line: Order
Management inserts
OE_ORDER_LINES.A
TTRIBUTE1-15.

Order Management
inserts
oe_order_headers.attr
ibute1-15.
COMMENTS NA Varchar2(2 Order Management NA

value into this
column.
INTERNAL_NOTES NA Varchar2(2 Order Management NA

value into this
column.
INITIAL_CUSTOMER_ NA NUMBER( Order Management NA

TRX_ID 15) does not insert a
value into this
column.
USSGL_TRANSACTIO NA Varchar2(3 Order Management NA

N_CODE_CONTEXT 0) does not insert a
value into this
column.
USSGL_TRANSACTIO NA Varchar2(3 Order Management NA

N_CODE 0) does not insert a
value into this
column.
ACCTD_AMOUNT NA NUMBER Order Management NA

does not insert a
value into this
column.
Invoicing Module
CUSTOMER_BANK_A NA NUMBER( Order Management NA

CCOUNT_ID 15) does not insert a
value into this
column.
CUSTOMER_BANK_A NA Varchar2(2 Order Management NA

CCOUNT_NAME 5) does not insert a
value into this
column.
UOM_CODE NA Varchar2(3 For a Sales order or The available values

) return line: Order are:
Management inserts
• Sales order lines,
OE_ORDER_LINES.S
HIPPING_QUANTIT return lines, and
Y_UOM. discount lines:
line.order_quanti
For Freight charges: ty_UOM.
Order Management
does not insert a • Freight charges:
value into this if line type =
column. Freight, pass
NULL value;
otherwise the
freight item
UOM.
UOM_NAME NA Varchar2(2 Order Management NA

value into this
column.
DOCUMENT_NUMBE NA NUMBER( Order Management NA

R_SEQUENCE_ID 15) does not insert a
value into this
column.
REASON_CODE_NA NA Varchar2(3 Order Management NA

ME 0) does not insert a
value into this
column.

Invoicing Module
VAT_TAX_ID NA NUMBER( Order Management NA

value into this
column.
LOCATION_RATE_ID NA NUMBER( Order Management NA

value into this
column.
REASON_CODE_MEA NA Varchar2(8 Order Management NA

NING 0) does not insert a
value into this
column.
LAST_PERIOD_TO_C NA NUMBER Order Management NA

REDIT does not insert a
value into this
column.
PAYING_CUSTOMER NA NUMBER( Order Management NA

_ID 15) does not insert a
value into this
column.
PAYING_SITE_USE_I NA NUMBER( Order Management NA

D 15) does not insert a
value into this
column.
TAX_EXEMPT_FLAG NA Varchar2(1 Order Management The available values

0) inserts are:
OE_HEADERS.TAX_
• Freight: None
EXEMPT_FLAG for
order lines.
• Other:
nvl(line.tax_exem
pt_flag, S
SALES_TAX_ID NA NUMBER( Order Management NA

value into this
column.
Invoicing Module
CREATED_BY NA NUMBER( Order Management who id

15) enters an
identification number
to identify the user
who created the
record.
No Validation occurs
CREATION_DATE NA Date Order Management sysdate of creation

enters the current time
system date when a
record is created.
LAST_UPDATED_BY NA NUMBER( Order Management who id

15) enters an
identification number
to identify the user
who created or who
most recently
modified the record.
No Validation occurs
LAST_UPDATE_DATE NA Date Order Management sysdate of update

enters the current time
date when a record is
updated.
Standard Validation
occurs
LOCATION_SEGMEN NA NUMBER( Order Management NA

T_ID 15) does not insert a
value into this
column.
TAX_EXEMPT_REASO NA Varchar2(3 Order Management Freight: None

N_CODE 0) inserts
OE_ORDER_LINE.T Other:
AX_EXEMPT_REASO line.tax_exempt_reaso
N_ CODE for order n_code
lines.

Invoicing Module
TAX_EXEMPT_NUMB NA Varchar2(8 Order Management Freight: None

ER 0) inserts
OE_ORDER_LINE.T Other:
AX_EXEMPT_NUMB line.tax_exempt_num
ER for order lines.
TAX_EXEMPT_REASO NA Varchar2(8 Order Management NA

N_CODE_MEANING 0) does not insert a
value into this
column.
Line_Gdf_Attr_Categor NA NA NA Populated by
y Globalization API
called by OM.
Line_Gdf_Attr1-20, NA NA NA JG_ZZ_OM_Common
_PKG.Copy_Gdff
PARENT_LINE_ID NA NUMBER( For child line in a • For child line in a

15) configuration: Order configuration:
Management inserts oe_order_lines.to
oe_order_lines.top_m p_model_line_id
odel_line_id
• For Service Lines:
For Service Lines:
service parent
Order Management
line id
inserts service parent
line id
DEFERRAL_EXCLUSI NA VARCHA For freight lines: Y For freight lines: Y

ON_FLAG R2(1) otherwise NULL
PAYMENT_TRXN_EX NA NUMBER( Order Management Oe_payments.trxn_ex

TENSION_ID 15) inserts oe_payments. tension_id
trxn_extension_id
RULE_END_DATE NA DATE For service lines: If If accounting_rule is

order lines uses daily of type PP_DR_ALL
rate accounting rules or PP_DR_PP variable
then Order duration
Management inserts oe_order_lines.service
oe_order_lines.service _end_date
_end_date
Note: 1Non-Shipped order lines
The following information refers to the Interface_Line_Attribute3 attribute described in

the preceding table:
• No-Ship Cycle
All order lines should be interfaced with INTERFACE_LINE_ATTRIBUTE3 = 0.
• Ship Cycle
• All non-shippable STANDARD lines should be invoiced separately with
INTERFACE_LINE_ATTRIBUTE3 = 0.
• All non-shippable KIT lines that are not part of a PTO model should be
invoiced separately with INTERFACE_LINE_ATTRIBUTE3 = NVL(First
Delivery associated with included items. A 0 value appears if there are no
shippable included items.
Note: If there are shippable included items, the KIT line will be
Pick Release Released and Ship Confirm Confirmed.
• All non-shippable model components: Line Type = MODEL, CLASS, KIT, or

STANDARD without shippable included items should be invoiced with the
following:
INTERFACE_LINE_ATTRIBUTE3 = NVL(First Delivery of shippable model
invoiced with non-shippable model components. A 0 value appears if no
delivery is available.
• All non-shippable model components: Line Type = MODEL, CLASS, or KIT

with shippable included items should be invoiced with:
INTERFACE_LINE_ATTRIBUTE3 = NVL(Delivery associated with included
items).
• All shippable model components: Line Type = MODEL, CLASS, KIT, or

STANDARD should be invoiced with:
INTERFACE_LINE_ATTRIBUTE3 = Delivery.
Derived Values
CUST_TRX_TYPE_ID
Value is determined based upon the following hierarchy:
For a Sales order line:

Line transaction type
Order Transaction type
System ParameterInvoice Transaction type
For referenced return line:
Retrieve receivables transaction type from:
1. 1. Derive credit memo type based on return context and reference information (that
is, reference invoice or line type and order type of reference line)
2. Line transaction type
3. Order transaction type
4. System parameter Credit memo Transaction Type
For non-referenced return line:

1. Line transaction type
2. Order transaction type
3. Derive credit memo type based on return context and reference information.
4. System ParameterOM: Credit memo Transaction Type
For freight charges:

• The freight charges value is the same as the order/return line that is interfacing the
freight charge.
RA_INTERFACE_SALESCREDITS
Order Management inserts one row for each sales credit row according to the following
sequence:
1. Insert sales credits associated with the line; if none exists but the line is part of a
configuration (ITEM_TYPE_CODE is CLASS, KIT or STANDARD and
OPTION_FLAG is Y), then;
2. Insert sales credits associated with the model parent line; if none exists, then;
• Insert sales credits associated with the order header.
RA_INTERFACE_SALESCREDITS
Column Type Description Inserted by

Invoicing Module
INTERFACE_SALE NUMBER(15) Order Management None

SCREDIT_ID does not insert a
value into this
column.
INTERFACE_LINE NUMBER(15) Order Management None

_ID does not insert a
value into this
column.
INTERFACE_LINE Varchar2(30) Order Management Profile option OM:

_CONTEXT inserts your value Source Code
for the OM: Source
Code profile option.
INTERFACE_LINE Varchar2(30) Order Management Same as line

_ATTRIBUTE1 inserts inserted into
OE_ORDER_LINE. ra_interface_lines
ORDER_NUMBER.

OE_TRANSACTIO ra_interface_lines
N_TYPES.NAME.
INTERFACE_LINE Varchar2(30) For a Shipped order Same as line

_ATTRIBUTE3 line and for Freight inserted into
Charges: Order ra_interface_lines
Management
inserts
substr(wsh_new_d
eliveries.name1..30
For a Non-shipped
order line or a
Return Line: Order
Management
inserts 0 (zero).

Invoicing Module

_ATTRIBUTE4 line and for Freight inserted into
Charges: Order ra_interface_lines
Management
inserts:
substr(wsh_new_d
eliveries.waybill1..3
0
For a Non-shipped
order line or a
Return Line: Order
Management
inserts 0 (zero).
Order Management
inserts SUBSTR
(WSH_DELIVERY_
LINE_STATUS_V.
WAYBILL, 1, 30).

_ATTRIBUTE5 inserts the number inserted into
of times the order, ra_interface_lines
freight charge, or
return line has been
interfaced for
invoice or credit.
INTERFACE_LINE Varchar2(30) For a Sales order or Same as line

_ATTRIBUTE6 return line: Order inserted into
Management ra_interface_lines
inserts
OE_ORDER_LINES
.LINE_ID.

OE_CHARGE_LIN
ES_
V.CHARGE_ID.
Invoicing Module
INTERFACE_LINE Varchar2(30) For a Shipped Same as line

_ATTRIBUTE7 order line, a Return inserted into
line, or Freight ra_interface_lines
charges:
Order Management
inserts 0 (zero).

_ATTRIBUTE8 line: Order inserted into
Management ra_interface_lines
inserts
WSH_DEPARTUR
ES.
BILL_OF_LADING
.
For a Return line, or

Freight charges:
Order Management
inserts 0 (zero)

_ATTRIBUTE9 inserts the inserted into
customer item ra_interface_lines
number if one is
defined. Otherwise,
it inserts 0 (zero).

OE_ORDER_LINES ra_interface_lines
.
SHIP_FROM_ORG
_ID.

Invoicing Module
INTERFACE_LINE Varchar2(30) oe_price_adjustme Same as line

_ATTRIBUTE11 nts.price_adjustme inserted into
nt_id for discount ra_interface_lines
lines: system
paramter Show
Discount Details on
Invoice must be
Yes.
For all other lines

'0' is passed.

_ATTRIBUTE12....1 does not insert a inserted into
5 value into this ra_interface_lines
column.
SALESREP_NUMB Varchar2(30 Order Management None

ER does not insert a
value into this
column.
SALESREP_ID )NUMBER(15) Order Management oe_sales_credits.sal

inserts esrep_id
OE_SALES_CREDI
T.SALESREP_ID.
SALES_CREDIT_T NA Order Management None

YPE_NAME does not insert a
value into this
column.
SALES_CREDIT_T NUMBER(15) Order Management oe_sales_credits.sal

YPE_ID inserts es_credit_type_id
OE_SALES_CREDI
T.SALES_CREDIT_
TYPE_ID.
SALES_CREDIT_A NUMBER Order Management None

MOUNT_SPLIT does not insert a
value into this
column.
Invoicing Module
SALES_CREDIT_P NUMBER Order Management oe_sales_credits.pe

ERCENT_SPLIT inserts rcent
OE_SALES_CREDI
T.PERCENT.
INTERFACE_STAT Varchar(1) Order Management None

US does not insert a
value into this
column.
REQUEST_ID NUMBER(15) Order Management None

does not insert a
value into this
column.
ATTRIBUTE_CATE Varchar(30) Order Management oe_sales_credits.co

GORY inserts ntext
OE_SALES_CREDI
T.CONTEXT.
ATTRIBUTE1...15 Varchar(150) Order Management oe_sales_credits.Att

inserts ribute1-15
OE_SALES_CREDI
T.ATTRIBUTE1....1
5.
Org_Id NUMBER (15) Operating Unit line.org_id
Created_By NUMBER (15) Username who id
Creation_Date Date Date of creation creation date
Last_Updated_By NUMBER (15) User name who id
Last_Update_Date Date Last Update Date current date

Accounts Receivables Contingency Columns
AR_INTERFACE_CONTS

Invoicing Module
INTERFACE_CONT NA NUMBER Order None

INGENCY_ID Management
does not insert a
value into this
column.
INTERFACE_LINE_ NA Varchar2( Same as Same as

CONTEXT 30) RA_INTERFAC RA_INTERFACE_LI
E_LINES NES
INTERFACE_LINE_ NA Varchar2( Same as Same as

ATTRIBUTE1-15 30) RA_INTERFAC RA_INTERFACE_LI
E_LINES NES
CONTINGENCY_I Not null NUMBER( Order Oe_order_lines.conti

D 15) Management nency_id
inserts
Oe_order_lines.
continency_id
into this column
EXPIRATION_DAY NA NUMBER Order oe_order_lines.

S Management REVREC_EXPIRATI
inserts ON_DAYS
oe_order_lines.
REVREC_EXPIR
ATION_DAYS
into this column
EXPIRATION_DAT NA DATE Order None

E Management
does not insert a
value into this
column.
Invoicing Module
COMPLETED_FLA NA VARCHA Order 'Y' if contingency is

G R2(1) Management already removed
inserts value of
'Y' if the
contingency is
already
removed on the
order line.
COMPLETED_BY NA NUMBER Order None

Management
does not insert a
value into this
column.
EXPIRATION_EVE NA DATE Order None

NT_DATE Management
does not insert a
value into this
column.
CONTINGENCY_C NA VARCHA Order None

ODE R2(30) Management
does not insert a
value into this
column.
INTERFACE_LINE_ NA NUMBER Order None

ID Management
does not insert a
value into this
column.
INTERFACE_STAT NA VARCHA Order None

US R2(1) Management
does not insert a
value into this
column.

Invoicing Module
ATTRIBUTE_CATE NA VARCHA Order None

GORY R2(30) Management
does not insert a
value into this
column.
ATTRIBUTE1-15 NA VARCHA Order None

R2(30) Management
does not insert a
value into this
column.
Telecommunications Services Orders (MACD) Interfaces
Process_MACD_Order Application Program Interface

The Process_MACD_Order API can be used to:
• Create MACD orders from instances
• Process MACD actions
• Create and process MACD actions
The API accepts instances and header information (sold_to_org_id) to create MACD
orders. It also accepts MACD actions to process the order. Instances can be added to the
existing order by passing the header_id. To process actions on an existing order, you
can call the API with the lines table and an action. You can initiate agent actions that
need processing on order lines with Configurator attributes and Configurator extended
attributes.
Process_MACD_Order API Features

You can create MACD orders by passing instance information and Sold to org. You
need to pass customer related information to create the order before adding the MACD
lines to the order.
Process MACD Order API is also used to add MACD orders lines by passing the
instance information and order header information. The API will look for the root item
of the passed instances, and if the root instance is present in the order, then the new
instances are added to the existing root. Alternatively the API creates the complete top
structure to fit the passed in instances.
You can use the API to create and process MACD orders by passing the instance
information, Sold to org (Customer) information, and MACD action. The action can be
passed at the API level or at the instance level. First the API creates the order lines for
the instances and then the MACD action is applied.
You can use the Process MACD Order API to process actions on existing MACD orders
by passing in the line table with actions. The action can be passed at the API level or at
the line level.
Functional Overview
The steps to create and process MACD orders are described below.
Create a MACD order or Add instances to an existing order

To create MACD orders from instances or add instances to existing orders, the Process
MACD Order API accepts item instances and order header information (header_id or
sold_to_org_id), and extended attributes as input.
1. Instance table needs to be passed to the API.
2. Bill_to, ship_to passed by the calling entity will be validated against the sold_to
column on the new order.
3. P_instance_table and p_x_line_table are mutually exclusive. P_instance_table

should be passed to the API for create or create and process operation.
P_x_line_table should be passed if user needs to process the existing order.
4. Sold_to_org_id and header_id are mutually exclusive, only one of them should be
used as input. If a new order needs to be created, Sold_to_org_id is used as the
input or header_id needs to be passed to append the instances converted lines to
existing order.
5. All selected instances should belong to the same sold_to_org_id.
6. Order Management will validate and raise an error if the Install Base owner is not
same on the all instances passed to this API.
7. MACD Action should be passed through the parameter p_macd_action, if the same
action applies to all the instances passed in the instance table or lines passed in the
lines tables. If caller needs to perform multiple actions then pass the action on each
instance record or on the line record. API processing fails if the action is passed on
both instance/line table and p_macd_action.
8. This API accepts the Operating Unit as optional input. The instance or order header
information or extended attributes need to call the MOAC APIs if the orders need
to be processed or created in an operating unit apart from the default operating
unit. If an operating unit is not specified, the order lines will be created in the

default operating unit. Verify the operating unit value that is based on the Ship-to
and Bill-to on the item instances. If the operating unit of the Ship-to and Bill-to are
different then an error is raised. All the instances should belong to the same
operating unit.
9. If the header_id is passed, the system will append the instances to the existing order
and create container and child order lines in that order. The API searches for all
order lines in that sequence to verify if one referring to the parent container item of
the passed in item instances already exists. If such a container is found, instances
would be added to the existing container, otherwise a new container would be
created.
10. p_MACD_Action should not be passed to existing MACD Orders. We need to use
actions only if we need to process them.
11. If the API creates order lines for more than one network container, the first
container line_id is returned.
12. The API also returns the line table with order line records created as a result of the
API call.
Create and Process MACD orders

To create and process MACD order the Process MACD Order API accepts item
instances with action and the order header information (header_id and sold_to),
extended attributes, and p_macd_action as input.
You need to follow the steps listed in the section Create a MACD order or Add
instances to an existing order, page 8-53. After that, follow the steps given below to
process an order:
1. If the MACD action is passed (either in p_macd_action or in the instance record) it
calls the CZ public API CZ_CF_API.Validate and passes the first class CZ attributes
and extended CZ attributes along with the operations to the CZ API.
• Order Management will implicitly treat a UPDATE on ordered quantity = 0 as
DELETE and will take the following two rules into consideration.
• A DELETE operation on order lines sends DELETE operation to CZ if the

component does not have a base line rev number, that is if the component is a
new component that has been added to a completely new configuration or a
re-configuration.
• In case of DELETE operation on order line with a baseline rev number > 0 ,
Order Management will error out. This is because CZ will not support REVERT
action in this phase.
• DISCONTINUE operation on an order line with a component that has a base
line rev number > 0 (real MACD re-configuration) will send DELETE to CZ.
DISCONTINUE operation on a MACD order line without base line rev will
raise a Order Management error as you cannot discontinue a component which
is not yet in Install Base.
• DISCONTINUE operation on a non-MACD order line should raise error.
2. Synchronize the order lines to configuration changes resulted due to the

CZ_CF_API.Validate API call.
Process MACD Actions on existing orders

Process MACD Orders API accepts the following as input: line table (which includes
the CZ first class attributes), extended attributes tables, and MACD action.
1. Validate the input parameters.
• Validate the Header_id, line_id and operation passed on the line table e.g.
CREATE operation on order lines is not supported.
• Validate if the index pointing back to the line table exists on the CZ extended
attributes table.
2. Process the action that is passed to attribute OPERATION in the input line table,
which will determine the work done by the API.
• UPDATE and DELETE operations are supported on order lines. CREATE
operation of order lines is not supported. The DISCONTINUE operation on
order line will be sent to CZ (as below) without performing any operation on
that order line.
• UPDATE, DELETE, DISCONTINUE operations on CZ first class attributes is

supported. REVERT operation on CZ is out of scope.
• The only valid operation on the CZ extended attributes table is always

UPDATE.
3. Updates order lines for Order Management attributes using the Process Order API.
For example, Request Date may need to be updated in case of Disconnect operation.
4. API will call CZ API CZ_CF_API.Validate and pass the first class CZ attributes and
extended CZ attributes along with the operations to that API so that CZ can take
appropriate action.
• Update on ordered quantity of an order line would result in implicit call to
UPDATE the CZ first class attribute quantity.

• Similarly OM will implicitly treat a UPDATE on ordered quantity = 0 as
DELETE and will follow the rules below.
• DELETE operation on order line will send DELETE operation to CZ if the

component does not have a base line rev number if the component is new and
is added to a completely new configuration or a re-configuration.
• In case of DELETE operation on order line with a baseline rev number > 0 ,
Order Management will error out. This is because CZ will not support REVERT
action in this phase.
DISCONTINUE operation on an order line with a component with a base line
rev number > 0 (real MACD re-configuration) will send DELETE to CZ.
DISCONTINUE operation on a MACD order line without base line rev will
raise an Order Management error as you cannot discontinue a component that
is not in Install Base.
• DISCONTINUE operation on a non-MACD order line should raise an error.
Setting Up the Process_MACD_Order API

The following chart describes all parameters used by the public Process_MACD_Order
API. All of the inbound and outbound parameters are listed.
Parameter Usage Type Required Derived Optional
P_API_VERSION_NUMBER IN Number Yes
P_org_id IN Number Either

org_id or
operating
unit is
required
P_operating_unit IN Varchar2 Either

org_id or
operating
unit is
required
P_sold_to_org_id IN Number Either

header_id
or
XXsold_to_
org is
required
P_header_id IN Number Either

header_id
or
sold_to_or
g is
required
P_MACD_Action IN VARCH Null

AR2
P_Instance_Tbl IN CSI_DAT Null

ASTRUC
TURES_P
UB
.IB_Insta
nce_Tbl_
Type
P_X_Line_Tbl IN/OUT OE_Orde Null

r_Pub.Li
ne_Tbl_T
ype
P_Extended_Attrib_Tbl IN OE_Orde Null

r_Pub.Ext
ended_At
tribs_Tbl
_Type
x_container_line_id OUT NUMBE

R
X_RETURN_STATUS OUT Varchar2
X_MSG_COUNT OUT Number

X_MSG_DATA OUT Varchar2
Raising Business Events

The following custom events will be raised when you choose an action by clicking the
Actions button on the Contact Center window:
• OM_PRE_ACTION_EVENT
• OM_POST_ACTION_EVENT
The following custom events will be raised when you click Book Orders on the Contact
Center window:
• OM_PRE_BOOK_EVENT
• OM_PRE_BOOK_EVENT
9
Oracle Release Management XML
Transactions
Overview of Oracle Release Management XML

XML in Oracle Release Management uses a combination of the following Oracle
products:
• Oracle Advance Queuing
• Oracle Workflow / Business Event System (BES)
• Oracle Transportation Agent (OTA)
XML enables you to receive planning transactions from any trading partner that has the
capability of producing and transmitting OAG/XML based transactions. The following
sequence of actions are performed:
1. Receive XML planning transaction from various trading partners and origins.
2. Transactions are queued and processed by the XML Gateway Execution engine,
which performs the following:
• Validate the transaction: Transaction must be well formed and valid.
• Derive trading partner and determine the map to be applied.
• Apply code conversions, defaulting, and derivation logic on the data from the
XML transaction to the Release Management interface tables.
All successfully processed transactions appear in the Release Management Workbench

as Available to Process schedules. Similar to EDI or manual transactions, from this point
onwards, all Release Management processes are executed on these transactions
Oracle Release Management XML Transactions 9-1

The scope of the implementation is limited to Shipping Schedules with Actual
quantities. The following elements are considered to be out of scope:
• SSLNEXCPTN segment
• DATETIME.RSPDOCGEN segment
• All elements pertaining to response schedules, such as DOCUMENTRV,

RSPSCHEDID, RSPREVNUM, PSSTATUS, and RSPLINNUM
Receive message
The XML Gateway Execution Engine does the following during inbound processing:
• Dequeue Message from Inbound Queue
• Validate Message via XML Parser
Uses the XML Parser to validate the inbound message to determine if it is well–formed
and valid (based on DTD stored in DTD directory) before proceeding further.
• Validate Trading Partner or Hub
If the inbound message is both well–formed and valid, the Execution Engine proceeds
to validate that the Trading Partner and document are defined. If the Trading Partner is
not defined or the document is not defined for the Trading Partner, the XML message
will not be processed further.
• Get Message Map from Repository
If the message map associated with the Trading Partner is not available in the XML
Gateway repository, the XML message will not be processed further.
• Maps Data
If the Trading Partner is valid and the message map exists in the repository, the
Execution Engine maps the data in the XML message to its target data fields in Oracle e
–Business Suite tables and columns identified in the message map. These are often the
Application Open Interface tables. Mapping process also includes:
• Apply Code Conversion
• Apply Actions
• Detect and Report Processing Errors
Errors may be detected by the Oracle XML Gateway Execution Engine, Oracle
Advanced Queuing, Oracle Workflow, or Oracle Transport Agent. Information
regarding the error is enqueued onto the Error Queue. An e–mail notification is sent via
Oracle Workflow to notify the trading partner regarding data errors, or the XML
Gateway system administrator regarding system or process errors. In addition, for
system or process errors, a copy of the XML message is placed in the XML message
directory for use in troubleshooting the reported error. For trading partner–related data
errors, the trading partner can refer to the copy of the XML message.
Planning Schedule Transaction

The SYNCH_PLANSCHD_001 transaction is similar to the EDIFACT/DELFOR or ANSI
X12/830 transactions and is used to carry forecast or mixed firm/forecast requirements
from the customer to the supplier. The purpose of the SYNC PLANSCHD Business
Object Definition (BOD) is to communicate requirement information, for example part
number and quantity, between a customer and their supplier on a regular basis.
SYNC PLANSCHD enables the addition of new requirements and the modifications of
previously established requirements through various SYNC Indicator values. Existing
SYNC Indicator values from OAG release 6.2 include "A" for add, "C" or change, and "D
" for delete. In addition, a new SYNC indicator value "R" for replacement is defined for
this PLANSCHD. Some of the elements contained on the XML include the following.
• Schedule Generation Date
• Horizon Dates
• Schedule Reference Number
• Schedule Purpose
• ECE TP Location Code
• Supplier Name
• Document Description
• Customer PO Number
• Customer Name
• Customer PO Date
• Requirement Date
• Item Quantity and UOM
• Customer Dock Code
• Item Description
• Customer Item Revision

• Item Detail Type
• PO Line Number
• PO Release Number
• Ship To/bill To Partner Information
• Ship From Partner Information
Sample Document Type Definition (DTD) and XML for Planning Schedule
The scope of the implementation is limited to Planning Schedules with Actual
quantities. The following elements are considered to be out of scope (please refer to the
sample DTD and XML):
• PSLNEXCPTN and FEATVALDAT segments
• DATETIME.RSPDOCGEN, DATETIME.DOCUMENT segments
• All elements pertaining to response schedules like DOCUMENTRV, RSPSCHEDID,

RSPREVNUM, PSSTATUS, and RSPLINNUM
The following section includes a sample DTD and sample XML used for Planning
Schedule in Oracle Release Management.
Planning Schedule Sample DTD
<! - Structure Overview
SYNC_PLANSCHD (PSHEADER, PSLINE+, PSFLEXBKT*)
PSHEADER (PARTNER+)
PSLFLEXBKT()
PSLINE (PARTNER+, FEATVALDAT*, PLNSCHED*, PSLNEXCPTN*)
FEATVALDAT()
PLNSCHED()
PSLNEXCPTN()
PSLNEXCPTN()
- >
<! - ==================================================== - >
<!ENTITY % RESOURCES SYSTEM "oagis_resources.dtd">%RESOURCES;
<! - ==================================================== - >
<!ELEMENT SYNC_PLANSCHD_001 (CNTROLAREA, DATAAREA+)>

<!ATTLIST VERB value CDATA #FIXED "SYNC">
<!ATTLIST NOUN value CDATA #FIXED "PLANSCHD">
<!ATTLIST REVISION value CDATA #FIXED "001">
<!ELEMENT DATAAREA (SYNC_PLANSCHD)>
<!ELEMENT SYNC_PLANSCHD (PSHEADER, PSLINE+, PSFLEXBKT*)>
<!ELEMENT PSHEADER (
(%DATETIME.GENERATION;),
(%DATETIME.SCHSTART;),
(%DATETIME.SCHEND;),
(%DATETIME.DOCUMENT;)?, (%DATETIME.RSPDOCGEN;)?,
SCHEDULEID, SYNCIND, DATETYPE?,
DESCRIPTN?, DOCUMENTRV?, NOTES?,
POID?, PSSTATUS?, RSPSCHEDID?,
RSPREVNUM?, SCHDULETYP?,
USERAREA?, PARTNER+, PSFLEXBKT*
)>
<!ELEMENT PSFLEXBKT (
(%DATETIME.BKTEND;),
(%DATETIME.BKTSTART;),
FLEXBKTID, USERAREA?
)>
<!ELEMENT PSLINE (
(%DATETIME.DELIVACT;)?, (%DATETIME.ENGCHG;)?,
(%DATETIME.FROM;)?, (%DATETIME.PO;)?,
(%DATETIME.RECEIVED;)?, (%DATETIME.SHIP;)?,
(%DATETIME.TO;)?, (%QUANTITY.DELIVERED;)?,
(%QUANTITY.ITEM;)?, (%QUANTITY.MINIMUM;)?,
(%QUANTITY.MAXIMUM;)?, (%QUANTITY.PRIOR;)?,
(%QUANTITY.RECEIVED;)?, (%QUANTITY.SHIPPED;)?,
LINENUM, AUTHCODE?, DESCRIPTN?, DOCKID?,
DRAWING?, HAZRDMATL?, ITEMRV?, ITEMRVX?,
ITEMX?, LINETYPE?, NOTES?, PACKING?,
PACKNGDESC?, POID?, POLINENUM?, PORELEASE?,
PRIORITY?, PROJECT?, PSSTATUS?, RSPLINNUM?,
SALESORDID?, SHIPPERNUM?, TASK?, UPC?, USERAREA?,
((COMMODITY, FEATUREID?, ITEM?) |
(FEATUREID, COMMODITY?, ITEM?) |
(ITEM, COMMODITY?, FEATUREID?)),

PARTNER+, FEATVALDAT*, PLNSCHED*, PSLNEXCPTN*
)>
<!ELEMENT FEATVALDAT (
FEATUREID, ITMFTVAL, DESCRIPTN?,
ITEMRV?, NAME*, PARTNRID?, UOM?, USERAREA?
)>
<!ELEMENT PLNSCHED (
(%QUANTITY.ITEM;), (%DATETIME.FROM;),
(%DATETIME.TO;)?, (%QUANTITY.MINIMUM;)?,
(%QUANTITY.MAXIMUM;)?, (%QUANTITY.PRIOR;)?,
PSDLINENUM, BKTYPE, AUTHCODE?,
PRIORITY?, RSPSDLNUM?, USERAREA?, PSLNEXCPTN*
)>
<!ELEMENT PSLNEXCPTN (
(%DATETIME.FROM;)?, (%DATETIME.TO;)?,
ACTIONCODE?, DESCRIPTN?, EXCPLINNUM?,
EXCPTNCODE?, REASONCODE?, USERAREA?
)>
Sample XML for Planning Schedule
<?xml version="1.0" standalone="no"?>
<!DOCTYPE SYNC_PLANSCHD_001 SYSTEM "162_sync_planschd_001.dtd">
<SYNC_PLANSCHD_001>
<CNTROLAREA>
<BSR>
<VERB value="SYNC">SYNC</VERB>
<NOUN value="PLANSCHD">PLANSCHD</NOUN>
<REVISION value="001">001</REVISION>
</BSR>
<SENDER>
<LOGICALID>XX141HG09</LOGICALID>
<COMPONENT>PLANSCHD</COMPONENT>
<TASK>SYNC</TASK>
<LANGUAGE>ENG</LANGUAGE>
<CODEPAGE>0000</CODEPAGE>
<AUTHID>2817</AUTHID>
</SENDER>
<YEAR>2000</YEAR>
<MONTH>10</MONTH>
<DAY>15</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SYNC_PLANSCHD>
<PSHEADER>
<YEAR>2000</YEAR>
<MONTH>11</MONTH>
<DAY>16</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<DATETIME qualifier="SCHSTART">
<YEAR>2000</YEAR>
<MONTH>12</MONTH>
<DAY>17</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<DATETIME qualifier="SCHEND">
<YEAR>2000</YEAR>
<MONTH>01</MONTH>
<DAY>18</DAY>
<HOUR>12</HOUR>

<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<SCHEDULEID>XML-PLN-01</SCHEDULEID>
<SYNCIND>Replace</SYNCIND>
<DATETYPE>Date-type</DATETYPE>
<DESCRIPTN>document-desk</DESCRIPTN>
<NOTES>header-notes</NOTES>
<PSSTATUS>5</PSSTATUS>
<SCHDULETYP>DEMAND</SCHDULETYP>
<PARTNER>
<NAME index="1">Modern Truck</NAME>
<ONETIME>0</ONETIME>
<PARTNRID>MCL</PARTNRID>
<PARTNRTYPE>SoldTo</PARTNRTYPE>
<CURRENCY>USD</CURRENCY>
</PARTNER>
<PARTNER>
<NAME index="1">Federal Mogul</NAME>
<PARTNRID>FM</PARTNRID>
<PARTNRTYPE>Supplier</PARTNRTYPE>
</PARTNER>
</PSHEADER>
<PSLINE>
<LINENUM>1</LINENUM>
<AUTHCODE>Auth-code</AUTHCODE>
<ITEMRV>itemrv</ITEMRV>
<ITEMRVX>rvx</ITEMRVX>
<ITEMX>itemx</ITEMX>
<LINETYPE>Firm</LINETYPE>
<NOTES>notes</NOTES>
<PACKING>packcd</PACKING>
<PACKNGDESC>packingdesc</PACKNGDESC>
<POID>po-id</POID>
<POLINENUM>po-lnum</POLINENUM>
<PORELEASE>po-rel</PORELEASE>
<PROJECT>proj</PROJECT>
<PSSTATUS>2</PSSTATUS>
<RSPLINNUM>rsplinenum</RSPLINNUM>
<SALESORDID>salesordid</SALESORDID>
<SHIPPERNUM>10023</SHIPPERNUM>
<TASK>task</TASK>
<UPC>upc</UPC>
<COMMODITY index="1">CMDTY1</COMMODITY>
<FEATUREID>feat</FEATUREID>
<ITEM>item12</ITEM>
<PARTNER>
<NAME index="1">Federal Parts</NAME>
<PARTNRID>FP</PARTNRID>
<PARTNRTYPE>ShipTo</PARTNRTYPE>
</PARTNER>
<PARTNER>
<NAME index="1">Federal Parts II</NAME>
<PARTNRID>M2</PARTNRID>
<PARTNRTYPE>ShipFrom</PARTNRTYPE>
</PARTNER>
<PLNSCHED>
<QUANTITY qualifier="ITEM">
<VALUE>3</VALUE>
<SIGN>+</SIGN>
<UOM>EACH</UOM>
</QUANTITY>
<DATETIME qualifier="FROM">
<YEAR>2401</YEAR>
<MONTH>02</MONTH>
<DAY>23</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<PSDLINENUM>linenum2</PSDLINENUM>
<BKTYPE>Day</BKTYPE>
</PLNSCHED>
</PSLINE>
<PSFLEXBKT>
<DATETIME qualifier="BKTEND">
<YEAR>2002</YEAR>
<MONTH>03</MONTH>
<DAY>17</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<DATETIME qualifier="BKTSTART">
<YEAR>2002</YEAR>
<MONTH>03</MONTH>
<DAY>15</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<FLEXBKTID>Bi-monthly</FLEXBKTID>
</PSFLEXBKT>
</SYNC_PLANSCHD>
</DATAAREA>
</SYNC_PLANSCHD_001>
Planning Schedule XML to Database Mapping

The Planning Schedule contains information that is mapped to columns in the
RLM_INTERFACE_HEADERS_ALL and RLM_INTERFACE_LINES_ALL tables. A
one-to-one relation between the XML elements and the underlying database columns is
outlined below. Also included is a list of defaulting rules and additional validations that
are performed.

XML Element/Segment RLM_INTERFACE_HEADERS_ALL Column
DATETIME.GENERATION SCHED_GENERATION_DATE
DATETIME.SCHSTART SCHED_HORIZON_START_DATE
DATETIME.SCHEND SCHED_HORIZON_END_DATE
DATETIME.DOCUMENT Not Mapped
DATETIME.RSPDOCGEN Not Mapped
SCHEDULEID SCHEDULE_REFERENCE_NUM
SYNCIND SCHEDULE_PURPOSE_EXT
DATETYPE Line Level (DATE_TYPE_CODE_EXT)
DESCRIPTN DOCUMENT_DESCRIPTN
DOCUMENTRV Not Mapped
NOTES HEADER_NOTES_EXT
POID Line Level - CUST_PO_NUMBER
PSSTATUS Not Mapped
RSPSCHEDID Not Mapped
RSPREVNUM Not Mapped
SCHDULETYP Not Mapped
USERAREA Not Mapped
PARTNER
NAME CUST_NAME_EXT
PARTNRID ONE_TIME_CUST_FLAG_EXT
PARTNRTYPE Expected Value SoldTo
PARTNER
NAME SUPPLIER_NAME_EXT
ONETIME ONE_TIME_SUPPLIER_FLAG_EXT
PARTNRID
PARTNRTYPE Expected Value Supplier
Defaults applied to RLM_INTERFACE_HEADERS_ALL

• PROCESS_STATUS is set to 2, indicating that the schedule is Available to Process.
• Standard WHO columns are populated in the message map.
• HEADER_ID is generated by a sequence
• EDI_TEST_INDICATOR is set to 'P'.
• SCHEDULE_SOURCE is set to 'XML'.
• SCHEDULE_TYPE is set to 'PLANNING_RELEASE'.
• SCHEDULE_TYPE_EXT is defaulted to 'PLANSCHD'.
A value of DEMAND is expected for the element SCHDULETYP. If this element

contains any other value, then the XML message is rejected. At least two PARTNER
segments are expected at the header level, with PARTNRTYPE values of SoldTo and
Supplier. This information is used to identify the trading partners.
XML Element/Segment RLM_INTERFACE_LINES_ALL Column
DATETIME.DELIVACT Not Mapped
DATETIME.ENGCHG ITEM_ENG_CNG_LVL_DATE_EXT
DATETIME.FROM START_DATE_TIME (Depends on

LINETYPE)

DATETIME.PO CUST_PO_DATE
DATETIME.RECEIVED START_DATE_TIME (Depends on

LINETYPE)
DATETIME.SHIP START_DATE_TIME (Depends on

LINETYPE)
DATETIME.TO START_DATE_TIME (Depends on

LINETYPE)
QUANTITY.DELIVERED Not Mapped
QUANTITY.ITEM ITEM_DETAIL_QUANTITY (Depends on

LINETYPE)
QUANTITY.MINIMUM ITEM_DETAIL_QUANTITY_MIN_EXT
QUANTITY.MAXIMUM ITEM_DETAIL_QUANTITY_MAX_EXT
QUANTITY.PRIOR ITEM_DETAIL_QUANTITY_PRIOR_EXT
QUANTITY.RECEIVED ITEM_DETAIL_QUANTITY (Depends on

LINETYPE)
QUANTITY.SHIPPED ITEM_DETAIL_QUANTITY (Depends on

LINETYPE)
LINENUM Not Mapped
AUTHCODE AUTHORIZATION_CODE_EXT
DESCRIPTN ITEM_DESCRIPTION_EXT
DOCKID CUSTOMER_DOCK_CODE
DRAWING Not Mapped
HAZRDMATL HAZARD_CODE_EXT
ITEMRV Not Mapped
ITEMRVX CUSTOMER_ITEM_REVISION
ITEMX CUSTOMER_ITEM_EXT
LINETYPE ITEM_DETAIL_TYPE_EXT
NOTES ITEM_NOTE_EXT
PACKING PACKAGING_CODE_EXT
PACKNGDESC PACKAGING_DESC_EXT
POID CUST_PO_NUMBER
POLINENUM CUST_PO_LINE_NUM
PORELEASE CUST_PO_RELEASE_NUM
PRIORITY REQUIREMENT_PRIORITY_EXT
PROJECT PROJECT_NUMBER_EXT
PSSTATUS Not Mapped
RSPLINNUM Not Mapped
SALESORDID Not Mapped
SHIPPERNUM ITEM_DETAIL_REF_VALUE_1
TASK TASK_NUMBER_EXT
UPC Not Mapped
USERAREA Not Mapped
COMMODITY COMMODITY_EXT
FEATUREID Not Mapped

ITEM SUPPLIER_ITEM_EXT
PARTNER
NAME SHIP_TO_NAME_EXT
ONETIME ONE_TIME_SHIP_TO_FLAG_EXT
PARTNRID CUST_SHIP_TO_EXT
PARTNRTYPE Expected Value ShipTo
PARTNER
NAME BILL_TO_NAME_EXT
ONETIME ONE_TIME_BILL_TO_FLAG_EXT
PARTNRID CUST_BILL_TO_EXT
PARTNRTYPE Expected Value BillTo
PARTNER
NAME SHIP_FROM_NAME_EXT
ONETIME ONE_TIME_SHIP_FROM_FLAG_EXT
PARTNRID CUST_SHIP_FROM_ORG_EXT
PARTNRTYPE Expected Value ShipFrom
PLNSCHED Segment

LINETYPE)
DATETIME.FROM START_DATE_TIME (Depends on

LINETYPE)
DATETIME.TO END_DATE_TIME
QUANTITY.MINIMUM ITEM_DETAIL_QUANTITY_MIN_EXT
QUANTITY.MAXIMUM ITEM_DETAIL_QUANTITY_MAX_EXT
PSDLINENUM Not Mapped
BKTYPE Determines the value of

ITEM_DETAIL_SUBTYPE_EXT
RSPSDLNUM Not Mapped
USERAREA Not Mapped
PSFLEXBKT
DATETIME.BKTEND END_DATE_TIME (Based on

BKTYPE/FLEXBKTID)
DATETIME.BKTSTART START_DATE_TIME (Based on

BKTYPE/FLEXBKTID)
FLEXBKTID FLEX_BKT_CODE
Defaults applied to RLM_INTERFACE_LINES_ALL

• PROCESS_STATUS is defaulted to 2.
• LINE_SOURCE is set to XML.
• HEADER_ID is copied from RLM_INTERFACE_HEADERS_ALL
• Standard WHO columns are assigned values in the message map.
• QTY_TYPE_CODE_EXT and QTY_TYPE_CODE are set to ACTUAL.

• LINE_ID is generated by a sequence.
Conditional Mapping
1. Depending on the element LINETYPE, determine the line level information as
follows:
IF LINETYPE = 'PAST DUE'/'FIRM'/'FORECAST' or
LINETYPE is NULL /* not transmitted */THEN
• ITEM_DETAIL_TYPE_EXT: = LINETYPE/'Forecast'
• ITEM_DETAIL _SUBTYPE_EXT: = NVL (BKTYPE, 'Day')
• DATE_TYPE_CODE_EXT: = NVL (DATETYPE, 'Deliver')
• START_DATE_TIME: = NVL (DATETIME.FROM, SYSDATE);
• END_DATE_TIME: = DATETIME.TO
• ITEM_DETAIL_QUANTITY: = QUANTITY.ITEM
• CUST_UOM_EXT: = QUANTITY.ITEM.UOM
ELSIF LINETYPE = 'SHIPPED/RECEIVED' THEN

• ITEM_DETAIL_TYPE_EXT: = LINETYPE
• IF DATETIME.RECEIVED IS NOT NULL THEN

• ITEM_DETAIL _SUBTYPE_EXT: = 'RECEIPT'
• DATE_TYPE_CODE_EXT: = 'RECEIVED'
• START_DATE_TIME: = DATETIME.RECEIVED
• ITEM_DETAIL_QUANTITY: = QUANTITY.RECEIVED
• CUST_UOM_EXT: = QUANTITY.RECEIVED.UOM
ELSIF DATETIME.SHIPPED IS NOT NULL THEN

• ITEM_DETAIL _SUBTYPE_EXT: = 'SHIPMENT'
• DATE_TYPE_CODE_EXT: = 'SHIPPED'
• START_DATE_TIME: = DATETIME.SHIPPED
• ITEM_DETAIL_QUANTITY: = QUANTITY.SHIPPED
• CUST_UOM_EXT: = QUANTITY.SHIPPED.UOM
END IF;
ELSIF LINETYPE = 'AUTHORIZATION' THEN

• ITEM_DETAIL_TYPE_EXT:= LINETYPE
• ITEM_DETAIL_SUBTYPE_EXT: = NVL(BKTYPE, 'FINISHED')
• DATE_TYPE_CODE_EXT: = 'FROM_TO'
• START_DATE_TIME: = DATETIME.REQUIRED
ELSIF LINETYPE = 'OTHER' THEN

• ITEM_DETAIL_TYPE_EXT:= 'OTHER'
• ITEM_DETAIL_SUBTYPE_EXT: = NVL(BKTYPE, 'AHEAD_BEHIND')
• DATE_TYPE_CODE_EXT: = 'AS_OF' · START_DATE_TIME: =

DATETIME.REQUIRED
END IF
2. The start and end date times on the requirement line are also dependent on the
BKTYPE that is in on the PLNSCHED level. If the BKTYPE matches any of the
FLEXBKTID values on the PSFLEXBKT segments, then the DATETIME.BKTEND
and DATETIME.BKTSTART constitute the end and start date times respectively for
the requirement line.
3. If the POID on the PSLINE level is null, then the value of POID from PSHEADER is
used.
4. If ShipFrom Partner information is not present at the line level, then the Supplier
details from the header are copied to the line level.
Derivation of schedule_item_num
SCHEDULE_ITEM_NUM is needed to identify a group for the purpose of validating
the line level data. This value is derived based on the combination of the following
attributes from the XML message:

• Ship from
• Ship to
• Bill to
• Customer item
• Item description
• Dock code
• Hazard code
• Item revision
• Item notes
• Customer PO number
• Customer PO line number
• Customer PO release number
• Customer PO date
• Supplier item
After inserting the data in the database, a post process API groups the lines using the
above attributes and for each group, unique values are assigned to schedule_item_num.
Other issues/considerations
Data that comes in at the PLNSCHED level overrides the data on PSLINE level.
Shipping Schedule Transaction

The SYNC_SHIPSCHD_001 transaction is similar to the EDIFACT/DELJIT or ANSI
X12/862 transactions and is used to carry firm requirements with eventual related JIT
information (KANBAN) from the customer to the supplier.
The purpose of the SYNC SHIPSCHD BOD is to enable the exchange of shipment
schedule information, authorizing a shipment quantity and date for specific trading
partners and addresses.
The shipping schedule is commonly generated by a material planning application and
transmitted to an order or material planning application.
Some of the elements contained on the XML include the following.
• Schedule Generation Date
• Horizon Dates
• Schedule Reference Number
• Schedule Purpose
• ECE TP Location Code
• Supplier Name
• Document Description
• Customer PO Number
• Customer Name
• Customer PO Date
• Requirement Date
• Item Quantity and UOM
• Customer Dock Code
• Item Description
• Customer Item Revision
• Item Detail Type
• PO Line Number
• PO Release Number
• Ship To/bill To Partner Information
• Ship From Partner Information

Sample Document Type Definition (DTD) and XML for Shipment Schedule
<! - Structure Overview
SYNC_SHIPSCHD (SHIPSCHDHD, SHIPSCHDLN+)
SHIPSCHDHD (PARTNER+)
SHIPSCHDLN (PARTNER+, SSLNEXCPTN*) - >
<! - ==================================================== - >
<!ENTITY % RESOURCES SYSTEM "oagis_resources.dtd">%RESOURCES;
<! - ==================================================== - >
<!ELEMENT SYNC_SHIPSCHD_001 (CNTROLAREA, DATAAREA+)>

<!ATTLIST VERB value CDATA #FIXED "SYNC">
<!ATTLIST NOUN value CDATA #FIXED "SHIPSCHD">
<!ATTLIST REVISION value CDATA #FIXED "001">
<!ELEMENT DATAAREA (SYNC_SHIPSCHD)>
<!ELEMENT SYNC_SHIPSCHD (SHIPSCHDHD, SHIPSCHDLN+)>
<!ELEMENT SHIPSCHDHD (
(%DATETIME.GENERATION;),
(%DATETIME.SCHEND;),
(%DATETIME.SCHSTART;),
(%DATETIME.DOCUMENT;)?,
(%DATETIME.RSPDOCGEN;)?,
SCHEDULEID, SYNCIND,
DATETYPE?, DESCRIPTN?,
DOCUMENTRV?, NOTES?, PSSTATUS?,
RSPSCHEDID?, RSPREVNUM?,
SCHDULETYP?, USERAREA?, PARTNER+
)>
<!ELEMENT SHIPSCHDLN (
(%DATETIME.REQUIRED;), (%QUANTITY.ITEM;),
(%DATETIME.CUMULATIVE;)?, (%DATETIME.DELIVACT;)?,
(%DATETIME.ENGCHG;)?, (%DATETIME.PO;)?,
(%DATETIME.RECEIVED;)?, (%DATETIME.SHIP;)?,
(%QUANTITY.CUMULATIVE;)?, (%QUANTITY.DELIVERED;)?,
(%QUANTITY.PRIOR;)?, (%QUANTITY.RECEIVED;)?,
(%QUANTITY.SHIPPED;)?,
ITEM, LINENUM, AUTHCODE?,
DESCRIPTN?, DOCKID?, DRAWING?,
HAZRDMATL?, ITEMRV?, ITEMRVX?,
ITEMX?, KANBAN?, LINETYPE?, NOTES?,
PACKING?, PACKNGDESC?, POID?, POLINENUM?,
PORELEASE?, PRIORITY?, PROJECT?, RSPLINNUM?,
SALESORDID?, SHIPPERNUM?, TASK?, UPC?,
USERAREA?, PARTNER+, SSLNEXCPTN*
)>
<!ELEMENT SSLNEXCPTN (
(%DATETIME.FROM;)?, (%DATETIME.TO;)?,
ACTIONCODE?, DESCRIPTN?, EXCPLINNUM?,
EXCPTNCODE?, REASONCODE?, USERAREA?
)>
Sample XML for Shipment Schedule
<?xml version="1.0" standalone="no"?>
<!DOCTYPE SYNC_SHIPSCHD_001 SYSTEM "168_sync_shipschd_001.dtd">
<SYNC_SHIPSCHD_001>
<CNTROLAREA>
<BSR>
<VERB value="SYNC">SYNC</VERB>
<NOUN value="SHIPSCHD">SHIPSCHD</NOUN>
</BSR>
<SENDER>
<LOGICALID>XX141HG09</LOGICALID>
<COMPONENT>SHIPSCHD</COMPONENT>
<TASK>SYNC</TASK>
<LANGUAGE>ENG</LANGUAGE>
<CODEPAGE>0000</CODEPAGE>
<AUTHID>8821</AUTHID>
</SENDER>
<YEAR>2000</YEAR>
<MONTH>10</MONTH>
<DAY>15</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SYNC_SHIPSCHD>
<SHIPSCHDHD>
<YEAR>2002</YEAR>
<MONTH>01</MONTH>
<DAY>01</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<DATETIME qualifier="SCHEND">
<YEAR>2002</YEAR>
<MONTH>01</MONTH>
<DAY>31</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<DATETIME qualifier="SCHSTART">
<YEAR>2002</YEAR>
<MONTH>01</MONTH>
<DAY>01</DAY>
<HOUR>12</HOUR>

<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<SCHEDULEID>XML-SHP-01</SCHEDULEID>
<SYNCIND>REPLACE</SYNCIND>
<DESCRIPTN>xmldesc</DESCRIPTN>
<NOTES>header notes</NOTES>
<SCHDULETYP>DEMAND</SCHDULETYP> <PARTNER>
<NAME index="1">Modern Truck</NAME>
<PARTNRID>MCL</PARTNRID>
<PARTNRTYPE>SoldTo</PARTNRTYPE> </PARTNER>
<PARTNER>
<NAME index="1">Federal Parts</NAME>
<PARTNRID>A987123</PARTNRID>
<PARTNRTYPE>Supplier</PARTNRTYPE> </PARTNER>
</SHIPSCHDHD>
<SHIPSCHDLN>
<DATETIME qualifier="REQUIRED">
<YEAR>2001</YEAR>
<MONTH>11</MONTH>
<DAY>15</DAY>
<HOUR>12</HOUR>
<MINUTE>59</MINUTE>
<SECOND>59</SECOND>
</DATETIME>
<VALUE>200</VALUE>
<SIGN>+</SIGN>
<UOM>EA</UOM>
</QUANTITY>
<ITEM>MT100</ITEM>
<LINENUM>1</LINENUM>
<AUTHCODE>Auth-code</AUTHCODE>
<DESCRIPTN>Standard Mount</DESCRIPTN>
<DOCKID>Dock-code</DOCKID>
<DRAWING>Drawing</DRAWING>
<HAZRDMATL>hazard</HAZRDMATL>
<ITEMRV>item-rev</ITEMRV>
<ITEMRVX>EXT</ITEMRVX>
<ITEMX>CM99223</ITEMX>
<KANBAN>kanban</KANBAN>
<LINETYPE>Firm</LINETYPE>
<NOTES>line-notes</NOTES>
<PACKING>packingcd</PACKING>
<PACKNGDESC>packing-desc</PACKNGDESC>
<POID>po-id</POID>
<POLINENUM>po-linenum</POLINENUM>
<PORELEASE>PO-release</PORELEASE>
<PRIORITY>2</PRIORITY>
<PROJECT>proj</PROJECT>
<SALESORDID>T</SALESORDID>
<SHIPPERNUM>10023</SHIPPERNUM>
<TASK>task</TASK>
<UPC>UPC</UPC>
<PARTNER>
<NAME index="1">Boston Manu</NAME>
</PARTNER>
<PARTNER>
<NAME index="1">ACME2</NAME>
</PARTNER>
</SHIPSCHDLN>
</SYNC_SHIPSCHD>
</DATAAREA>
</SYNC_SHIPSCHD_001>
Shipping Schedule XML to Database Mapping

A one-to-one relation between the XML elements and the underlying database columns
is outlined below:
DATETIME.GENERATION SCHED_GENERATION_DATE
DATETIME.SCHEND SCHED_HORIZON_END_DATE
DATETIME.SCHSTART SCHED_HORIZON_START_DATE
DATETIME.DOCUMENT Not Mapped
DATETIME.RSPDOCGEN Not Mapped
SCHEDULEID SCHEDULE_REFERENCE_NUM
SYNCIND SCHEDULE_PURPOSE_EXT
DATETYPE Line Level (DATE_TYPE_CODE_EXT)
DESCRIPTN DOCUMENT_DESCRIPTION
DOCUMENTRV Not Mapped
NOTES HEADER_NOTES_TEXT

PSSTATUS Not Mapped
PSSTATUS Not Mapped
RSPSCHEDID Not Mapped
RSPREVNUM Not Mapped
SCHDULETYP Not Mapped
USERAREA Not Mapped
PARTNER
NAME CUST_NAME_EXT
ONETIME ONE_TIME_CUST_FLAG_EXT
PARTNRID ECE_TP_LOCATION_CODE_EXT
andCUSTOMER_EXT
PARTNRTYPE Expected Value SoldTo
PARTNER
NAME SUPPLIER_NAME_EXT
ONETIME ONE_TIME_SUPPLIER_FLAG_EXT
PARTNRID
PARTNRTYPE Expected Value Supplier
Defaults applied to RLM_INTERFACE_HEADERS_ALL

• PROCESS_STATUS is set to 2, indicating that the schedule is Available to Process.
• Standard WHO columns are populated in the message map.
• HEADER_ID is generated as a sequence
• EDI_TEST_INDICATOR is set to 'P', to indicate production schedules.
• SCHEDULE_SOURCE is set to 'XML'.
• SCHEDULE_TYPE is set to 'SHIPPING'.
• SCHEDULE_TYPE_EXT is defaulted to 'SHIPSCHD'.
A value of DEMAND is expected for the element SCHDULETYP. If this element

contains any other value, the XML message is rejected. At least two PARTNER
segments are expected at the header level, with PARTNRTYPE values of SoldTo and
Supplier. This information is used to identify the trading partners.
DATETIME.REQUIRED START_DATE_TIME (Depends on

LINETYPE)

LINETYPE)
DATETIME.CUMULATIVE Not Mapped
DATETIME.DELIVACT Not Mapped
DATETIME.ENGCHG ITEM_ENG_CNG_LVL_DATE_EXT
DATETIME.PO CUST_PO_DATE
DATETIME.RECEIVED START_DATE_TIME (Depends on

LINETYPE)
DATETIME.SHIP START_DATE_TIME (Depends on

LINETYPE)
QUANTITY.CUMULATIVE Not Mapped
QUANTITY.DELIVERED Not Mapped
QUANTITY.RECEIVED ITEM_DETAIL_QUANTITY (Depends on

LINETYPE)

QUANTITY.SHIPPED ITEM_DETAIL_QUANTITY (Depends on

LINETYPE)
ITEM SUPPLIER_ITEM_EXT
LINENUM LINE_NUMBER
DESCRIPTN ITEM_DESCRIPTION_EXT
DOCKID CUSTOMER_DOCK_CODE
DRAWING Not Mapped
HAZRDMATL HAZARD_CODE_EXT
ITEMRV Not Mapped
ITEMRVX CUSTOMER_ITEM_REVISION
ITEMX CUSTOMER_ITEM_EXT
KANBAN INDUSTRY_ATTRIBUTE4
LINETYPE ITEM_DETAIL_TYPE_EXT
NOTES ITEM_NOTE_TEXT
PACKING PACKAGING_CODE_EXT
PACKNGDESC PACKAGING_DESC_EXT
POID CUST_PO_NUMBER
POLINENUM CUST_PO_LINE_NUM
PORELEASE CUST_PO_RELEASE_NUM
PROJECT PROJECT_NUMBER_EXT
RSPLINNUM Not Mapped
SALESORDID Not Mapped
SHIPPERNUM ITEM_DETAIL_REF_VALUE_1
TASK TASK_NUMBER_EXT
UPC Not Mapped
USERAREA Not Mapped
PARTNER
NAME BILL_TO_NAME_EXT
ONETIME ONE_TIME_BILL_TO_FLAG_EXT
PARTNRID CUST_BILL_TO_EXT
PARTNRTYPE Expected Value BillTo
PARTNER
NAME SHIP_FROM_NAME_EXT
ONETIME ONE_TIME_SHIP_FROM_FLAG_EXT
PARTNRID CUST_SHIP_FROM_ORG_EXT
PARTNRTYPE Expected Value ShipFrom
PARTNER
NAME SHIP_TO_NAME_EXT
ONETIME ONE_TIME_SHIP_TO_FLAG_EXT

PARTNRID CUST_SHIP_TO_EXT
PARTNRTYPE Expected Value ShipTo
Defaults applied to RLM_INTERFACE_LINES_ALL

• PROCESS_STATUS is defaulted to 2.
• LINE_SOURCE is set to XML.
• HEADER_ID is copied from RLM_INTERFACE_HEADERS_ALL
• Standard WHO columns are assigned values in the message map.
• QTY_TYPE_CODE_EXT and QTY_TYPE_CODE are set to 'ACTUAL'.
• LINE_ID is generated by a sequence.
Conditional Mapping
1. Depending on the element LINETYPE, determine the line level information as
follows:
IF LINETYPE = 'PAST DUE' / 'FIRM'/'FORECAST' OR
LINETYPE is NULL /* not transmitted */ THEN
• ITEM_DETAIL_TYPE_EXT: = LINETYPE/'Firm'
• ITEM_DETAIL_SUBTYPE_EXT: = 'Day'
• DATE_TYPE_CODE_EXT: = NVL (DATETYPE, 'Deliver')
ELSIF LINETYPE='SHIPPED/RECEIVED' THEN

• ITEM_DETAIL_TYPE_EXT: = LINETYPE
• IF DATETIME.RECEIVED IS NOT NULL THEN

• ITEM_DETAIL_SUBTYPE_EXT: = 'RECEIPT'
• DATE_TYPE_CODE_EXT: = 'RECEIVED'
• START_DATE_TIME: = DATETIME.RECEIVED
• ITEM_DETAIL_QUANTITY: = QUANTITY.RECEIVED
• CUST_UOM_EXT: = QUANTITY.RECEIVED.UOM
ELSIF DATETIME.SHIPPED IS NOT NULL THEN

• ITEM_DETAIL_SUBTYPE_EXT: = 'SHIPMENT'
• DATE_TYPE_CODE_EXT: = 'SHIPPED'
• START_DATE_TIME: = DATETIME.SHIPPED
• ITEM_DETAIL_QUANTITY: = QUANTITY.SHIPPED
• CUST_UOM_EXT: = QUANTITY.SHIPPED.UOM
END IF;
ELSIF LINETYPE = 'AUTHORIZATION' THEN

• ITEM_DETAIL_TYPE_EXT:= LINETYPE
• ITEM_DETAIL_SUBTYPE_EXT: = 'FINISHED'
• DATE_TYPE_CODE_EXT: = 'FROM_TO'
ELSIF LINETYPE = 'OTHER' THEN

• ITEM_DETAIL_TYPE_EXT:= 'OTHER'
• ITEM_DETAIL_SUBTYPE_EXT: = 'AHEAD_BEHIND'
• DATE_TYPE_CODE_EXT: = 'AS_OF'

END IF
2. If ShipFrom Partner information doesn't come in at the line level, copy the Supplier
Partner data from the header to the lines level.
Derivation of schedule_item_num
SCHEDULE_ITEM_NUM is required to identify a group for the purpose of validating
the line level data. The Shipping Schedule has only two levels and there is no
corresponding element on the XML message to uniquely identify a group. Hence, this
value is derived based on the combination of the following attributes from the XML
message:
• Ship from
• Ship to
• Bill to
• Customer item
• Dock code
• Hazard code
• Item revision
• Item notes
• Customer PO line number
• Customer PO release number
• Customer PO date
• Supplier item (from the XML message)
After inserting data in the database, a post process API groups the lines using the above
attributes and for each group, a unique values is assigned to schedule_item_num.
10
Oracle Release Management EDI
Transactions

• Production Sequence EDI
• Shipping Schedule EDI
• Planning Schedule EDI
• Purpose Codes
• Transaction Descriptions
Production Sequence EDI

Production Sequence is used to import customer production sequence schedules into
Oracle Release Management, to provide a means to request the order in which the
shipment of goods arrives, and to specify the order in which the goods are unloaded,
enabling the sequence in which the goods enter the production process and are
consumed. The Demand Processor imports customer production sequence schedules to
Oracle Order Management and Oracle Planning.
Production Sequence is initiated from the Release Management or e-Commerce
Gateway responsibility.
Shipping Schedule EDI

The shipping schedule transaction set can be used by a customer to convey precise
shipping schedule requirements to a supplier, and is intended to supplement the
planning schedule transaction set (830). The shipping schedule transaction set will
supersede certain shipping and delivery information transmitted in a previous planning
schedule transaction, but it does not replace the 830 transaction set. The shipping
schedule transaction set shall not be used to authorize labor, materials, or other
resources.
Oracle Release Management EDI Transactions 10-1

The use of this transaction set will facilitate the practice of Just-In-Time (JIT)
manufacturing by providing the customer with a mechanism to issue precise shipping
schedule requirements on a more frequent basis than with the issuance of a planning
schedule transaction, e.g. daily shipping schedules versus weekly planning schedules.
The shipping schedule transaction also provides the ability for a customer location to
issue shipping requirements independent of other customer locations when planning
schedules are issued by a consolidated scheduling organization.
Planning Schedule EDI

Planning Schedule With Release Capability (830)
A Planning schedule with release capability transaction set provides for customary and
established business practice relative to the transfer of forecasting/material release
information between organizations.
The planning schedule transaction may be used in various ways or in a combination of
ways, such as:
• A simple forecast
• A forecast with the buyer's authorization for the seller to commit resources, such as
labor or material
• A forecast that is also used as an order release mechanism, containing such

elements as resource authorizations, period-to-date cumulative quantities, and
specific ship/delivery patterns for requirements that have been represented in
buckets, such as weekly, monthly, or quarterly
The order release forecast may also contain all data related to purchase orders, as
required, because the order release capability eliminates the need for discreet
generation of purchase orders.
Purpose Codes
EDI Demand Transaction Purpose Codes vs. Oracle Purpose Codes

For a customer demand transaction to be processed correctly in the Demand Processor,
the appropriate Oracle purpose codes must be associated with it.
EDI Gateway Code Conversion cross-references for RLM_TRX_PURP are pre-defined
for the standard purpose codes used in EDI transactions for ASC X12 and EDIFACT
standards.
You must define additional customer-specific code conversion cross-references in the
EDI Gateway that will uniquely map to the correct Oracle purpose code if:
• Your customer uses a different EDI standard whose purpose codes are not
pre-defined.
• You have EDI trading partner customers who send demand transactions with a
purpose code that differs in meaning from the pre-defined cross-reference to the
Oracle purpose code (external values 2-4 can contain Trading Partner Code,
Schedule Type, Schedule Type Qualifier, or other element as needed).
For example, your customer may use an Original purpose code for the first schedule of
a new model year, which is intended to replace all previously issued demand from the
prior model year. If customer-specific mapping is defined to link this schedule to an
Oracle Replace purpose code, the demand will be handled properly. However, if the
customer-specific mapping is not defined, the Oracle Original purpose code will be
assigned. This will result in overstated demand, because demand from the last schedule
of the prior model year will remain on file, and demand from the first schedule of the
new model year will be added.
Assuming that existing and new demand came from the same schedule type (for
example, 830, 862, or 866), the following chart describes Oracle purpose codes and their
functionality:
Oracle Purpose Code
Code Demand Processor Interpretation
Original The requirements on this schedule have not

been previously issued. They will all be
added, even if existing demand is on file.
Cancellation The requirements on this schedule will be

canceled.
Change This is a partial revision of a previous

schedule for selected items; the requirements
on this schedule will replace what was sent on
a previous schedule for these items within the
schedule horizon.
Replace The requirements on this schedule will replace

existing requirements from a previous
schedule, subject to the following exceptions:
for items not on the schedule, all existing

demand remains intact
for schedule items, existing demand dated

after the schedule horizon end date remains
intact.

Code Demand Processor Interpretation
Add The requirements on this schedule will be

added to existing requirements from a
previous schedule.
Delete The requirements on this schedule will be

deleted from existing requirements from a
previous schedule.
Confirmation The requirements on this schedule will be

archived but not processed, assuming that
changes were made manually before the
schedule was received. They are changes to a
previous schedule which confirm verbal
emergency requirements.
Transaction Descriptions
Delivery Schedule (DELFOR)

A message from buyer to supplier giving product requirements regarding details for
short term delivery instructions and/or medium to long term product/service forecast
for planning purposes according to conditions set out in a contract or order. The
message can be used to authorized the commitment of labor and materials resources;
however, authorizations are not actually used in Europe.
Delivery Just In Time (DELJIT)

A message provides the ability for a customer to convey precise delivery sequence and
Just In Time schedule requirements to a supplier, and is intended to supplement the
Delivery Schedule message (DELFOR). It provides a mechanism to issue precise
shipping schedule requirements in terms of a 24-hour clock and on a more frequent
basis than with the instance of a delivery schedule message, e.g. daily shipping
schedules versus weekly planning schedules.
Delivery Instruction (DELINS)

The Delivery Instruction Message is sent by a buyer and is intended to provide
information regarding details for both short term delivery instructions and medium to
long term requirements for planning purposes according to conditions set out in a
contract or order.
Note: The analysis is based upon the Odette message DELINS, version
4. The Odette Delivery Instruction message corresponds in purpose and
content to the ASC X12 830 - Planning Schedule with Release Capability
and the X12 862 - Shipping Schedule.
KANBAN Signal (KANBAN)

The KANBAN Signal Message is issued by a consignee giving authorization to the
consignor to ship material based upon receiving a kanban signal and following the
principles of the Just-In-Time philosophy.
Note: The analysis is based upon the Odette KANBAN message,

version 2. The Odette message corresponds in purpose and content to
the ASC X12 862 - Shipping Schedule when used as a kanban Signal.
For more information, see the Oracle XML Gateway User's Guide.

11
Oracle Release Management Open
Interfaces and APIs

• Understanding the Demand Processor Interface Tables
Understanding the Demand Processor Interface Tables

Oracle Release Management uses 2 tables in which the Demand Processor receives data
that you import from other systems.
• Release Management Schedule Headers: RLM_INTERFACE_HEADERS_ALL
• Release Management Schedule Lines: RLM_INTERFACE_LINES_ALL
When the Demand Processor receives data, it validates and converts your imported
data into customer demand schedules within Oracle Release Management and order
lines within Oracle Order Management.
Release Management Schedule Headers RLM_INTERFACE_HEADERS_ALL

This table stores the header level details of the Release Management schedules. It has
details pertaining to the specific schedule and customer level information. The Release
Management Demand Processor uses this table to maintain a current picture of demand
schedule headers.
RLM_INTERFACE_HEADERS_ALL
Column Name Type Required Derived Optional
HEADER_ID NUMBER X - -
Oracle Release Management Open Interfaces and APIs 11-1

CUST_ADDRES VARCHAR2(35) - - X
S_1_EXT
S_2_EXT
S_3_EXT
S_4_EXT
S_5_EXT
S_6_EXT
S_7_EXT
S_8_EXT
S_9_EXT
CUST_CITY_EX VARCHAR2(30) - - X
T
CUST_COUNTR VARCHAR2(3) - - X
Y_EXT
CUST_COUNTY VARCHAR2(25) - - X
_EXT
CUSTOMER_EX VARCHAR2(30) - - X
T
CUST_NAME_E VARCHAR2(20) - - X
XT
ONE_TIME_CU VARCHAR2(35) - - X
ST_FLAG_EXT
CURRENCY_EX VARCHAR2(35) - - X
T
TAX_EXEMPT_F VARCHAR2(35) - - X
LAG_EXT
TAX_ID_EXT VARCHAR2(35) - - X
CUST_POSTAL_ VARCHAR2(15) - - X
CD_EXT
CUST_PROVIN VARCHAR2(10) - - X
CE_EXT
CUST_STATE_E VARCHAR2(10) - - X
XT
CUSTOMER_ID NUMBER - - X
ECE_PRIMARY_ NUMBER - - X
ADDRESS_ID
ECE_TP_LOCAT VARCHAR2(35) - - X
ION_CODE_EX
T
ECE_TP_TRANS VARCHAR2(35) - - X
LATOR_CODE
EDI_CONTROL VARCHAR2(15) - - X
_NUM_1
_NUM_2
_NUM_3

EDI_TEST_INDI VARCHAR2(1) - - X
CATOR
HEADER_CON VARCHAR2(3) - - X
TACT_CODE_1
TACT_CODE_2
TACT_VALUE_
1
TACT_VALUE_
2
TACT_EMAIL_1
_EXT
TACT_EMAIL_2
_EXT
TACT_FAX_1_E
XT
TACT_FAX_2_E
XT
TACT_TEL_1_E
XT
TACT_TEL_2_E
XT
HEADER_NOTE VARCHAR2(400 - - X
_TEXT 0)
HEADER_REF_ VARCHAR2(3) - - X
CODE_1
CODE_2
CODE_3
VALUE_1
VALUE_2
VALUE_3
ORG_ID NUMBER - - X
PROCESS_STAT NUMBER - - X
US
SCHEDULE_HE NUMBER - - X
ADER_ID
SCHEDULE_TY VARCHAR2(30) - X -
PE
SCHEDULE_TY VARCHAR2(30) - - X
PE_EXT
SCHED_GENER DATE - - X
ATION_DATE
SCHED_HORIZ DATE - - X
ON_END_DATE
SCHED_HORIZ DATE - - X
ON_START_DA
TE

SCHEDULE_PU VARCHAR2(30) - X -
RPOSE
SCHEDULE_PU VARCHAR2(30) - - X
RPOSE_EXT
SCHEDULE_RE VARCHAR2(35) - - X
FERENCE_NUM
SCHEDULE_SO VARCHAR2(30) - - X
URCE
LAST_UPDATE DATE - X -
_DATE
LAST_UPDATE NUMBER - X -
D_BY
CREATION_DA DATE - X -
TE
CREATED_BY NUMBER - X -
ATTRIBUTE_CA VARCHAR2(30) - - X
TEGORY
ATTRIBUTE1 VARCHAR2(150 - - X
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
_LOGIN
REQUEST_ID NUMBER - X -
PROGRAM_AP NUMBER - X -
PLICATION_ID
PROGRAM_ID NUMBER - X -
PROGRAM_UP DATE - X -
DATE_DATE

TP_ATTRIBUTE VARCHAR2(150 - - X
1 )
2 )
3 )
4 )
5 )
6 )
7 )
8 )
9 )
10 )
11 )
12 )
13 )
14 )
15 )
TP_ATTRIBUTE VARCHAR2(30) - - X
_CATEGORY
CUST_FAX_EXT VARCHAR2(35) - - X
CUST_REGION_ VARCHAR2(35) - - X
EXT
CUST_TAX_JUR VARCHAR2(35) - - X
ISDICTION_EXT
CUST_TEL_EXT VARCHAR2(35) - - X
CUST_URL_EXT VARCHAR2(100 - - X
)
ORIGINAL_DO DATE - - X
CUMENT_DAT
E
RESP_DOCUME DATE - - X
NT_DATE
DOCUMENT_D VARCHAR2(50) - - X
ESCRIPTION
DOCUMENT_R VARCHAR2(35) - - X
EV_NUM
RESP_SCHEDU VARCHAR2(35) - - X
LE_ID
RESP_DOCUME VARCHAR2(35) - - X
NT_REV_NUM
BUCKET_END_ DATE - - X
DATE

BUCKET_STAR DATE - - X
T_DATE
FLEX_BUCKET_ VARCHAR2(30) - - X
CODE
SUPPLIER_NA VARCHAR2(60) - - X
ME_EXT
ONE_TIME_SUP VARCHAR2(35) - - X
PLIER_FLAG_E
XT
SUPPLIER_ID NUMBER - - X
SUPPLIER_CUR VARCHAR2(35) - - X
RENCY_EXT
SUPPLIER_DES VARCHAR2(35) - - X
CRIPTION_EXT
CUST_DESCRIP VARCHAR2(35) - - X
TION_EXT
SUPPLIER_TAX VARCHAR2(35) - - X
_EXEMPT_FLA
G_EXT
_ID_EXT
SUPPLIER_ADD VARCHAR2(35) - - X
RESS_1_EXT
RESS_2_EXT
RESS_3_EXT
RESS_4_EXT
RESS_5_EXT
SUPPLIER_ADD VARCHAR2(240 - - X
RESS_6_EXT )
RESS_7_EXT
RESS_8_EXT
RESS_9_EXT
SUPPLIER_CITY VARCHAR2(30) - - X
_EXT
SUPPLIER_COU VARCHAR2(35) - - X
NTY_EXT
SUPPLIER_FAX VARCHAR2(35) - - X
_EXT
SUPPLIER_POS VARCHAR2(15) - - X
TAL_CD_EXT
SUPPLIER_REGI VARCHAR2(35) - - X
ON_EXT
SUPPLIER_STA VARCHAR2(10) - - X
TE_EXT
SUPPLIER_PRO VARCHAR2(10) - - X
VINCE_EXT
_JURISDICTION
_EXT
SUPPLIER_TEL_ VARCHAR2(35) - - X
EXT

SUPPLIER_URL VARCHAR2(100 - - X
_EXT )
SUP_HEADER_ VARCHAR2(3) - - X
CONTACT_CO
DE_1
CONTACT_CO
DE_2
CONTACT_VAL
UE_1
CONTACT_VAL
UE_2
SUP_HEADER_ VARCHAR2(50 - - X
CONTACT_EM
AIL_1_EXT
SUP_HEADER_ VARCHAR2(50 - - X
CONTACT_EM
AIL_2_EXT
CONTACT_FAX
_1_EXT
CONTACT_FAX
_2_EXT
CONTACT_TEL
_1_EXT
CONTACT_TEL
_2_EXT
SUPPLIER_COU VARCHAR2(3) - - X
NTRY_EXT
Column Descriptions
HEADER_ID Number
Sequence generated unique identifier.
CUST_ADDRESS_1_EXT VARCHAR2(35)
Customer address line 1, as sent by the customer on the N3 segment.
Customer address line 8, As sent by the customer on the N3 segment.
CUST_CITY_EXT VARCHAR2(30)
Customer address city, as sent by the customer on the N4 segment.
CUST_COUNTRY_EXT VARCHAR2(3)
Customer country, as sent by the customer on the N4 segment.
CUST_COUNTY_EXT VARCHAR2(25)
Customer county, as sent by the customer on the N4 segment.

CUSTOMER_EXT VARCHAR2(30)
Trading Partner designator cross reference.
CUST_NAME_EXT VARCHAR2(60)
Customer name, as sent by the customer in the N1 or N2 segment.
ONE_TIME_CUST_FLAG_EXT VARCHAR2(35)
For future use.
CURRENCY_EXT VARCHAR2(35)
For future use.
TAX_EXEMPT_FLAG_EXT VARCHAR2(35)
For future use.
TAX_ID_EXT VARCHAR2(35)
For future use.
CUST_POSTAL_CD_EXT VARCHAR2(15)
Customer address postal code, as sent by the customer on the N4 segment.
CUST_PROVINCE_EXT VARCHAR2(10)
Customer province, as sent by the customer on the N4 segment.
CUST_STATE_EXT VARCHAR2(10)
Customer state, as sent by the customer on the N4 segment.
CUSTOMER_ID NUMBER
Customer identifier. FK to RA_CUSTOMERS.
ECE_PRIMARY_ADDRESS_ID NUMBER
Customer primary address ID; populated by e-Commerce Gateway code conversion of
external trading partner location code. FK to RA_ADDRESSES.
ECE_TP_LOCATION_CODE_EXT VARCHAR2(35)
For EDI transactions only, external trading partner location code assigned to the
location in the e-Commerce Gateway common control record.
ECE_TP_TRANSLATOR_CODE VARCHAR2(35)
For EDI transactions only, e-Commerce Gateway trading partner code assigned to the
transaction in the e-Commerce Gateway common control record.
EDI_CONTROL_NUM_1 VARCHAR2(15)
EDI control number 1 (ISA) assigned by the customer's EDI translator for audit.
EDI control number 2 (GS) assigned by the customer's EDI translator for audit.
EDI control number 3 (ST) assigned by the customer's EDI translator for audit.
EDI_TEST_INDICATOR VARCHAR2(1)
EDI Test/Production transaction indicator (T or P), assigned by the customer's EDI
translator. E-Commerce Gateway rules determine the handling of test transactions
within the Demand Processor.
HEADER_CONTACT_CODE_1 VARCHAR2(3)
Contact code 1 included in customer's EDI transaction (not validated).
HEADER_CONTACT_CODE_2 VARCHAR2(3)
Contact code 2 included in customer's EDI transaction (not validated).
HEADER_CONTACT_VALUE_1 VARCHAR2(80)
Values associated with contact code 1: concatenation of name, communication code,
and communication number.
HEADER_CONTACT_VALUE_2 VARCHAR2(80)
HEADER_CONTACT_EMAIL_1_EXT VARCHAR2(50)
For future use.
HEADER_CONTACT_EMAIL_2_EXT VARCHAR2(50)
For future use.
HEADER_CONTACT_FAX_1_EXT VARCHAR2(35)
For future use.
HEADER_CONTACT_FAX_2_EXT VARCHAR2(35)
For future use.
HEADER_CONTACT_TEL_1_EXT VARCHAR2(50)
For future use.
HEADER_CONTACT_TEL_2_EXT VARCHAR2(50)
For future use.
HEADER_NOTE_TEXT VARCHAR2(240)
Free form note text included in the schedule at the header level.
HEADER_REF_CODE_1 VARCHAR2(3)
Reference code 1 included in customer's EDI transaction.

HEADER_REF_VALUE_1 VARCHAR2(35)
Value associated with reference code 1.
ORG_ID NUMBER
Operating unit unique ID. FK to HR_ORGANIZATION_UNITS.
PROCESS_STATUS NUMBER
Indicates the current processing status of a record for headers with lines in error:
1= Available to be processed
2= Processed with error
3= Processed successfully
4= Line is frozen firm
5= Partially processed with error(s)
SCHEDULE_HEADER_ID NUMBER
Schedule header unique identifier. FK to RLM_SCHEDULE_HEADERS.
SCHEDULE_TYPE VARCHAR2(30)
Schedule Type: planning, shipping or sequenced. Validated against
FND_LOOKUPS.LOOKUP_TYPE = RLM_SCHEDULE_TYPE.
SCHEDULE_TYPE_EXT VARCHAR2(30)
External value from which RLM_SCHEDULE_TYPE was derived in EDI Gateway code
conversion.
SCHED_GENERATION_DATE DATE
Date customer generated either the schedule or the planning information on the
schedule.
SCHED_HORIZON_END_DATE DATE
Schedule horizon end date, to be derived based on demand contained within the
schedule if not specified.
SCHED_HORIZON_START_DATE DATE
Schedule horizon start date, to be derived based on demand contained within the
schedule if not specified.
SCHEDULE_PURPOSE VARCHAR2(30)
Schedule purpose code, i.e. original, replace, cancellation, etc. Validated against
FND_LOOKUPS.LOOKUP_TYPE =RLM_SCHEDULE_PURPOSE
SCHEDULE_PURPOSE_EXT VARCHAR2(30)
External value from which SCHEDULE_PURPOSE was derived in e-Commerce
Gateway code conversion.
SCHEDULE_REFERENCE_NUM VARCHAR2(35)
Customer assigned schedule reference or release number.
SCHEDULE_SOURCE VARCHAR2(30)
EDI or manual transaction source for this schedule, i.e. 830, 862, 866, DELFOR,
MANUAL, etc.
LAST_UPDATE_DATE DATE
Standard Who column.
LAST_UPDATED_BY NUMBER
CREATION_DATE DATE
CREATED_BY NUMBER
ATTRIBUTE_CATEGORY VARCHAR2(30)
Descriptive flexfield context column.
ATTRIBUTE1 VARCHAR2(150)
Descriptive flexfield segment column.

LAST_UPDATE_LOGIN NUMBER
REQUEST_ID NUMBER
PROGRAM_APPLICATION_ID NUMBER
PROGRAM_ID NUMBER
PROGRAM_UPDATE_DATE DATE
TP_ATTRIBUTE1 VARCHAR2(150)
Trading Partner flexfield column.
TP_ATTRIBUTE_CATEGORY VARCHAR2(30)
Trading Partner flexfield context column.
CUST_FAX_EXT VARCHAR2(35)
For future use.

CUST_REGION_EXT VARCHAR2(35)
For future use.
CUST_TAX_JURISDICTION_EXT VARCHAR2(35)
For future use.
CUST_TEL_EXT VARCHAR2(35)
For future use.
CUST_URL_EXT VARCHAR2(100)
For future use.
ORIGINAL_DOCUMENT_DATE DATE
For future use.
RESP_DOCUMENT_DATE DATE
For future use.
DOCUMENT_DESCRIPTION VARCHAR2(50)
For future use.
DOCUMENT_REV_NUM VARCHAR2(35)
For future use.
RESP_SCHEDULE_ID VARCHAR2(35)
For future use.
RESP_DOCUMENT_REV_NUM VARCHAR2(35)
For future use.
BUCKET_END_DATE DATE
For future use.
BUCKET_START_DATE DATE
For future use.
FLEX_BUCKET_CODE VARCHAR2(30)
For future use.
SUPPLIER_NAME_EXT VARCHAR2(60)
For future use.
ONE_TIME_SUPPLIER_FLAG_EXT VARCHAR2(35)
For future use.
SUPPLIER_ID NUMBER
For future use.
SUPPLIER_CURRENCY_EXT VARCHAR2(35)
For future use.
SUPPLIER_DESCRIPTION_EXT VARCHAR2(35)
For future use.
CUST_DESCRIPTION_EXT VARCHAR2(35)
For future use.
SUPPLIER_TAX_EXEMPT_FLAG_EXT VARCHAR2(35)
For future use.
SUPPLIER_TAX_ID_EXT VARCHAR2(35)
For future use.
SUPPLIER_ADDRESS_1_EXT VARCHAR2(35)
For future use.
For future use.
For future use.
For future use.
For future use.
For future use.
For future use.
For future use.
For future use.
SUPPLIER_CITY_EXT VARCHAR2(30)
For future use.
SUPPLIER_COUNTY_EXT VARCHAR2(35)
For future use.

SUPPLIER_FAX_EXT VARCHAR2(35)
For future use.
SUPPLIER_POSTAL_CD_EXT VARCHAR2(15)
For future use.
SUPPLIER_REGION_EXT VARCHAR2(35)
For future use.
SUPPLIER_STATE_EXT VARCHAR2(10)
For future use.
SUPPLIER_PROVINCE_EXT VARCHAR2(10)
For future use.
SUPPLIER_TAX_JURISDICTION_EXT VARCHAR2(35)
For future use.
SUPPLIER_TEL_EXT VARCHAR2(35)
For future use.
SUPPLIER_URL_EXT VARCHAR2(100)
For future use.
SUP_HEADER_CONTACT_CODE_1 VARCHAR2(3)
For future use.
SUP_HEADER_CONTACT_CODE_2 VARCHAR2(3)
For future use.
SUP_HEADER_CONTACT_VALUE_1 VARCHAR2(80)
For future use.
SUP_HEADER_CONTACT_VALUE_2 VARCHAR2(80)
For future use.
SUP_HEADER_CONTACT_EMAIL_1_EXT VARCHAR2(50)
For future use.
SUP_HEADER_CONTACT_EMAIL_2_EXT VARCHAR2(50)
For future use.
SUP_HEADER_CONTACT_FAX_1_EXT VARCHAR2(35)
For future use.
SUP_HEADER_CONTACT_FAX_2_EXT VARCHAR2(35)
For future use.
SUP_HEADER_CONTACT_TEL_1_EXT VARCHAR2(50)
For future use.
SUP_HEADER_CONTACT_TEL_2_EXT VARCHAR2(50)
For future use.
SUPPLIER_COUNTRY_EXT VARCHAR2(3)
For future use.
Release Management Schedule Lines RLM_INTERFACE_LINES_ALL

This table stores the item and item detail level information associated with customer
planning, shipping, or production sequenced schedules. For production sequence
schedules, the item represents the feature, not the configuration.
This table stores all details for scheduled items: dated demand, authorizations, and
customer shipment/receipt information. It has a child relationship to
RLM_INTERFACE_HEADERS_ALL.
RLM_INTERFACE_LINES_ALL
LINE_ID NUMBER X - -
HEADER_ID NUMBER X - -
AGREEMENT_I NUMBER - - X
D
ATO_DATA_TY VARCHAR2(30) - - X
PE
BILL_TO_ADDR VARCHAR2(35) - - X
ESS_1_EXT
ESS_2_EXT
ESS_3_EXT
ESS_4_EXT

BILL_TO_ADDR NUMBER - - X
ESS_ID
INVOICE_TO_O NUMBER - - X
RG_ID
BILL_TO_CITY_ VARCHAR2(30) - - X
EXT
BILL_TO_COU VARCHAR2(3) - - X
NTRY_EXT
BILL_TO_COU VARCHAR2(25) - - X
NTY_EXT
BILL_TO_NAM VARCHAR2(60) - - X
E_EXT
BILL_TO_POST VARCHAR2(15) - - X
AL_CD_EXT
BILL_TO_PROV VARCHAR2(10) - - X
INCE_EXT
BILL_TO_SITE_ NUMBER - - X
USE_ID
BILL_TO_STAT VARCHAR2(10) - - X
E_EXT
CARRIER_ID_C VARCHAR2(35) - - X
ODE_EXT
CARRIER_QUA VARCHAR2(3) - - X
LIFIER_EXT
COMMODITY_ VARCHAR2(35) - - X
EXT
COUNTRY_OF_ VARCHAR2(35) - - X
ORIGIN_EXT
CUST_ASSEMB VARCHAR2(30) - - X
LY_EXT
CUST_ASSIGNE VARCHAR2(20) - - X
D_ID_EXT
CUST_BILL_TO VARCHAR2(35) - - X
_EXT
CUST_CONTRA VARCHAR2(35) - - X
CT_NUM_EXT
CUSTOMER_D VARCHAR2(50) - - X
OCK_CODE
CUST_INTRMD VARCHAR2(35) - - X
_SHIP_TO_EXT
CUST_ITEM_PR NUMBER - - X
ICE_EXT
CUST_ITEM_PR VARCHAR2(3) - - X
ICE_UOM_EXT
CUSTOMER_IT VARCHAR2(3) - - X
EM_REVISION
CUSTOMER_JO VARCHAR2(50) - - X
B
CUST_MANUF VARCHAR2(35) - - X
ACTURER_EXT
CUST_MODEL_ VARCHAR2(35) - - X
NUMBER_EXT
CUST_MODEL_ VARCHAR2(35) - - X
SERIAL_NUMB
ER
CUST_ORDER_ VARCHAR2(35) - - X
NUM_EXT

CUST_PROCESS VARCHAR2(35) - - X
_NUM_EXT
CUST_PRODUC VARCHAR2(50) - - X
TION_LINE
TION_SEQ_NU
M
CUST_SET_NU VARCHAR2(35) - - X
M_EXT
CUST_SHIP_FR VARCHAR2(80) - - X
OM_ORG_EXT
CUST_SHIP_TO VARCHAR2(35) - - X
_EXT
CUST_UOM_EX VARCHAR2(10) - - X
T
CUSTOMER_IT VARCHAR2(50) - - X
EM_EXT
CUSTOMER_IT NUMBER - - X
EM_ID
REQUEST_DAT DATE - - X
E
SCHEDULE_DA DATE - - X
TE
DATE_TYPE_C VARCHAR2(30) - X -
ODE
DATE_TYPE_C VARCHAR2(30) - - X
ODE_EXT
DELIVERY_LEA NUMBER - - X
D_TIME
END_DATE_TI DATE - - X
ME
EQUIPMENT_C VARCHAR2(3) - - X
ODE_EXT
EQUIPMENT_N VARCHAR2(35) - - X
UMBER_EXT
HANDLING_C VARCHAR2(3) - - X
ODE_EXT
HAZARD_COD VARCHAR2(10) - - X
E_EXT
HAZARD_COD VARCHAR2(3) - - X
E_QUAL_EXT
HAZARD_DESC VARCHAR2(80) - - X
RIPTION_EXT
IMPORT_LICEN DATE - - X
SE_DATE_EXT
IMPORT_LICEN VARCHAR2(35) - - X
SE_EXT
INDUSTRY_AT VARCHAR2(150 - - X
TRIBUTE1 )
TRIBUTE10 )
TRIBUTE11 )
TRIBUTE12 )
TRIBUTE13 )

TRIBUTE14 )
TRIBUTE15 )
TRIBUTE2 )
TRIBUTE3 )
TRIBUTE4 )
TRIBUTE5 )
TRIBUTE6 )
TRIBUTE7 )
TRIBUTE8 )
TRIBUTE9 )
INDUSTRY_CO VARCHAR2(30) - - X
NTEXT
INTRMD_SHIP_ NUMBER - - X
TO_ID
SHIP_TO_ORG_ NUMBER - - X
ID
INTRMD_ST_A VARCHAR2(35) - - X
DDRESS_1_EXT
DDRESS_2_EXT
DDRESS_3_EXT
DDRESS_4_EXT
INTRMD_ST_CI VARCHAR2(30) - - X
TY_EXT
INTRMD_ST_C VARCHAR2(3) - - X
OUNTRY_EXT
INTRMD_ST_C VARCHAR2(25) - - X
OUNTY_EXT
INTRMD_ST_N VARCHAR2(60) - - X
AME_EXT
INTRMD_ST_P VARCHAR2(15) - - X
OSTAL_CD_EX
T
INTRMD_ST_PR VARCHAR2(10) - - X
OVINCE_EXT
INTRMD_ST_ST VARCHAR2(10) - - X
ATE_EXT
INTRMD_ST_SI NUMBER - - X
TE_USE_ID
INVENTORY_IT NUMBER - - X
EM_ID
INVENTORY_IT VARCHAR2(40) - - X
EM_SEGMENT1

EM_SEGMENT1
0
EM_SEGMENT1
1
EM_SEGMENT1
2
EM_SEGMENT1
3
EM_SEGMENT1
4
EM_SEGMENT1
5
EM_SEGMENT1
6
EM_SEGMENT1
7
EM_SEGMENT1
8
EM_SEGMENT1
9
EM_SEGMENT2
EM_SEGMENT2
0
EM_SEGMENT3
EM_SEGMENT4
EM_SEGMENT5
EM_SEGMENT6
EM_SEGMENT7
EM_SEGMENT8
EM_SEGMENT9
ITEM_CONTAC VARCHAR2(3) - - X
T_CODE_1
T_CODE_2
T_VALUE_1
T_VALUE_2
ITEM_DESCRIP VARCHAR2(80) - - X
TION_EXT
ITEM_DETAIL_ NUMBER - - X
QUANTITY

ITEM_DETAIL_ VARCHAR2(3) - - X
REF_CODE_1
REF_CODE_2
REF_CODE_3
REF_VALUE_1
REF_VALUE_2
REF_VALUE_3
ITEM_DETAIL_ VARCHAR2(30) - X -
SUBTYPE
SUBTYPE_EXT
ITEM_DETAIL_ VARCHAR2(30) - X -
TYPE
TYPE_EXT
ITEM_ENG_CN VARCHAR2(35) - - X
G_LVL_EXT
ITEM_MEASUR VARCHAR2(240 - - X
EMENTS_EXT )
ITEM_NOTE_TE VARCHAR2(240 - - X
XT )
ITEM_REF_COD VARCHAR2(3) - - X
E_1
E_2
E_3
ITEM_REF_VAL VARCHAR2(35) - - X
UE_1
UE_2
UE_3
ITEM_RELEASE VARCHAR2(3) - - X
_STATUS_EXT
LADING_QUA NUMBER - - X
NTITY_EXT
LETTER_CREDI DATE - - X
T_EXPDT_EXT
LETTER_CREDI VARCHAR2(35) - - X
T_EXT
LINE_REFEREN VARCHAR2(50) - - X
CE
LINK_TO_LINE VARCHAR2(50) - - X
_REF
ORDER_HEADE NUMBER - - X
R_ID
ORG_ID NUMBER - - X
OTHER_NAME VARCHAR2(3) - - X
_CODE_1

_CODE_2
_VALUE_1
_VALUE_2
PACK_SIZE_EX NUMBER - - X
T
PACK_UNITS_P NUMBER - - X
ER_PACK_EXT
PACK_UOM_C VARCHAR2(3) - - X
ODE_EXT
PACKAGING_C VARCHAR2(10) - - X
ODE_EXT
PARENT_LINK_ VARCHAR2(50) - - X
LINE_REF
PRICE_LIST_ID NUMBER - - X
PRIMARY_QUA NUMBER - - X
NTITY
PRIMARY_UO VARCHAR2(3) - - X
M_CODE
PRIME_CONTR VARCHAR2(35) - - X
CTR_PART_EXT
PROCESS_STAT NUMBER - - X
US
CUST_PO_RELE VARCHAR2(35) - - X
ASE_NUM
CUST_PO_DAT DATE - - X
E
CUST_PO_LINE VARCHAR2(35) - - X
_NUM
CUST_PO_NUM VARCHAR2(50) - - X
BER
QTY_TYPE_CO VARCHAR2(30) - X -
DE
QTY_TYPE_CO VARCHAR2(30) - - X
DE_EXT
RETURN_CONT VARCHAR2(35) - - X
AINER_EXT
SCHEDULE_LI NUMBER - - X
NE_ID
ROUTING_DES VARCHAR2(35) - - X
C_EXT
ROUTING_SEQ VARCHAR2(3) - - X
_CODE_EXT
SCHEDULE_ITE NUMBER - - X
M_NUM
SHIP_DEL_PAT VARCHAR2(3) - - X
TERN_EXT
SHIP_DEL_TIM VARCHAR2(3) - - X
E_CODE_EXT
SHIP_DEL_RUL VARCHAR2(30) - - X
E_NAME
SHIP_FROM_A VARCHAR2(35) - - X
DDRESS_1_EXT

DDRESS_2_EXT
DDRESS_3_EXT
DDRESS_4_EXT
SHIP_FROM_CI VARCHAR2(30) - - X
TY_EXT
SHIP_FROM_C VARCHAR2(3) - - X
OUNTRY_EXT
SHIP_FROM_C VARCHAR2(25) - - X
OUNTY_EXT
SHIP_FROM_N VARCHAR2(60) - - X
AME_EXT
SHIP_FROM_O NUMBER - - X
RG_ID
SHIP_FROM_PO VARCHAR2(15) - - X
STAL_CD_EXT
SHIP_FROM_PR VARCHAR2(10) - - X
OVINCE_EXT
SHIP_FROM_ST VARCHAR2(10) - - X
ATE_EXT
SHIP_LABEL_I VARCHAR2(80) - - X
NFO_LINE_1
NFO_LINE_10
NFO_LINE_2
NFO_LINE_3
NFO_LINE_4
NFO_LINE_5
NFO_LINE_6
NFO_LINE_7
NFO_LINE_8
NFO_LINE_9
SHIP_TO_ADD VARCHAR2(35) - - X
RESS_1_EXT
RESS_2_EXT
RESS_3_EXT
RESS_4_EXT
SHIP_TO_ADD NUMBER - - X
RESS_ID
DELIVER_TO_O NUMBER - - X
RG_ID
SHIP_TO_CITY_ VARCHAR2(30) - - X
EXT

SHIP_TO_COU VARCHAR2(3) - - X
NTRY_EXT
SHIP_TO_COU VARCHAR2(25) - - X
NTY_EXT
SHIP_TO_NAM VARCHAR2(60) - - X
E_EXT
SHIP_TO_POST VARCHAR2(15) - - X
AL_CD_EXT
SHIP_TO_PROV VARCHAR2(10) - - X
INCE_EXT
SHIP_TO_SITE_ NUMBER - - X
USE_ID
SHIP_TO_STAT VARCHAR2(10) - - X
E_EXT
START_DATE_T DATE - - X
IME
SUBLINE_ASSI VARCHAR2(20) - - X
GNED_ID_EXT
SUBLINE_CON VARCHAR2(3) - - X
FIG_CODE_EXT
SUBLINE_CUST VARCHAR2(50) - - X
_ITEM_EXT
SUBLINE_CUST NUMBER - - X
_ITEM_ID
SUBLINE_MOD VARCHAR2(35) - - X
EL_NUM_EXT
SUBLINE_QUA NUMBER - - X
NTITY
SUBLINE_UOM VARCHAR2(3) - - X
_CODE
SUPPLIER_ITE VARCHAR2(35) - - X
M_EXT
TRANSIT_TIME VARCHAR2(22) - - X
_EXT
TRANSIT_TIME VARCHAR2(3) - - X
_QUAL_EXT
TRANSPORT_L VARCHAR2(3) - - X
OC_QUAL_EXT
TRANSPORT_L VARCHAR2(35) - - X
OCATION_EXT
TRANSPORT_M VARCHAR2(3) - - X
ETHOD_EXT
UOM_CODE VARCHAR2(3) - - X
WEIGHT_EXT NUMBER - - X
WEIGHT_QUAL VARCHAR2(3) - - X
IFIER_EXT
WEIGHT_UOM_ VARCHAR2(3) - - X
EXT
FBO_CONFIGU VARCHAR2(35) - - X
RATION_KEY_1
RATION_KEY_2
RATION_KEY_3
RATION_KEY_4

RATION_KEY_5
MATCH_KEY_A VARCHAR2(150 - - X
CROSS )
MATCH_KEY_ VARCHAR2(150 - - X
WITHIN )
CRITICAL_KEY VARCHAR2(150 - - X
_ATTRIBUTES )
LAST_UPDATE DATE - X -
_DATE
D_BY
CREATION_DA DATE - X -
TE
CREATED_BY NUMBER - X -
ATTRIBUTE_CA VARCHAR2(30) - - X
TEGORY
)
)
)
)
)
)
)
)
)
)
)
)
)
)
)
_LOGIN
REQUEST_ID NUMBER - X -
PROGRAM_AP NUMBER - X -
PLICATION_ID
PROGRAM_ID NUMBER - X -
PROGRAM_UP DATE - X -
DATE_DATE

1 )
2 )
3 )
4 )
5 )
6 )
7 )
8 )
9 )
10 )
11 )
12 )
13 )
14 )
15 )
TP_ATTRIBUTE VARCHAR2(30) - - X
_CATEGORY
LINE_NUMBER NUMBER - - X
INTMED_SHIP_ NUMBER - - X
TO_ORG_ID
LINE_SOURCE VARCHAR2(30) - - X
PREFERRED_G VARCHAR2(4) - - X
RADE
TION_SEQ_NU
M_BEG
TION_SEQ_NU
M_END
QUANTITY_MI
N_EXT
QUANTITY_MA
X_EXT
QUANTITY_PRI
OR_EXT
REQUIREMENT NUMBER - - X
_PRIORITY_EXT
PROJECT_NUM VARCHAR2(50) - - X
BER_EXT

RESP_LINE_NU VARCHAR2(35) - - X
MBER
TASK_NUMBER VARCHAR2(50) - - X
_EXT
UPC_EXT VARCHAR2(50) - - X
ITEM_ENG_CN DATE - - X
G_LVL_DATE_E
XT
AUTHORIZATI VARCHAR2(50) - - X
ON_CODE_EXT
PACKAGING_D VARCHAR2(80) - - X
ESC_EXT
ESS_5_EXT
ESS_6_EXT
ESS_7_EXT
ESS_8_EXT
ESS_9_EXT
ONE_TIME_BIL VARCHAR2(35) - - X
L_TO_FLAG_EX
T
BILL_TO_DESC VARCHAR2(50) - - X
RIPTION_EXT
BILL_TO_FAX_ VARCHAR2(35) - - X
EXT
BILL_TO_REGI VARCHAR2(35) - - X
ON_EXT
BILL_TO_JURIS VARCHAR2(35) - - X
DICTION_EXT
BILL_TO_TEL_E VARCHAR2(35) - - X
XT
DDRESS_5_EXT
DDRESS_6_EXT
DDRESS_7_EXT
DDRESS_8_EXT
DDRESS_9_EXT
ONE_TIME_INT VARCHAR2(35) - - X
RMD_ST_FLAG
_EXT
INTRMD_ST_D VARCHAR2(50) - - X
ESCRIPTION_E
XT
INTRMD_ST_FA VARCHAR2(35) - - X
X_EXT
INTRMD_ST_RE VARCHAR2(35) - - X
GION_EXT
INTRMD_ST_JU VARCHAR2(35) - - X
RISDICTION_E
XT

INTRMD_ST_TE VARCHAR2(35) - - X
L_EXT
RESS_5_EXT
RESS_6_EXT
RESS_7_EXT
RESS_8_EXT
RESS_9_EXT
ONE_TIME_SHI VARCHAR2(35) - - X
P_TO_FLAG_EX
T
SHIP_TO_DESC VARCHAR2(50) - - X
RIPTION_EXT
SHIP_TO_FAX_ VARCHAR2(35) - - X
EXT
SHIP_TO_REGI VARCHAR2(35) - - X
ON_EXT
SHIP_TO_JURIS VARCHAR2(35) - - X
DICTION_EXT
SHIP_TO_TEL_E VARCHAR2(35) - - X
XT
DDRESS_5_EXT
DDRESS_6_EXT
DDRESS_7_EXT
DDRESS_8_EXT
DDRESS_9_EXT
ONE_TIME_SHI VARCHAR2(35) - - X
P_FROM_FLAG
_EXT
SHIP_FROM_DE VARCHAR2(50) - - X
SCRIPTION_EX
T
SHIP_FROM_FA VARCHAR2(35) - - X
X_EXT
SHIP_FROM_RE VARCHAR2(35) - - X
GION_EXT
SHIP_FROM_JU VARCHAR2(35) - - X
RISDICTION_E
XT
SHIP_FROM_TE VARCHAR2(35) - - X
L_EXT
Column Descriptions
LINE_ID NUMBER
Sequence generated unique identifier.
HEADER_ID NUMBER
Sequence generated unique identifier foreign key to the
RLM_INTERFACE_HEADERS_ALL.
AGREEMENT_ID NUMBER
Unique identifier for agreement on which customer purchase order is associated. FK to
RA_AGREEMENTS

ATO_DATA_TYPE VARCHAR2(30)
Code to describe what type of data is included for the ATO item:
1=Model and Options
2=Model
3=Options
Validated against FND_LOOKUPS.LOOKUP_TYPE =RLM_ITEM_METHOD_TYPE
BILL_TO_ADDRESS_1_EXT VARCHAR2(35)
Bill to address line 1, as sent by the customer on the N3 segment.
BILL_TO_ADDRESS_ID NUMBER
Bill to address identifier. FK to RA_ADDRESSES.
INVOICE_TO_ORG_ID NUMBER
Unique identifier for invoice-to organization which relates to BILL_TO_ADDRESS_ID.
FK in R12 customer-org data model to HR_ORGANIZATIONS.
BILL_TO_CITY_EXT VARCHAR2(30)
Bill to address city, as sent by the customer on the N4 segment.
BILL_TO_COUNTRY_EXT VARCHAR2(3)
Bill to country, as sent by the customer on the N4 segment.
BILL_TO_COUNTY_EXT VARCHAR2(25)
Bill to county, as sent by the customer on the N4 segment.
BILL_TO_NAME_EXT VARCHAR2(60)
Bill to name, as sent by the customer in the N1 and/or N2 segment.
BILL_TO_POSTAL_CD_EXT VARCHAR2(15)
Bill to address postal code, as sent by the customer on the N4 segment.
BILL_TO_PROVINCE_EXT VARCHAR2(10)
Bill to province, as sent by the customer on the N4 segment.
BILL_TO_SITE_USE_ID NUMBER
Bill to site use identifier. FK to RA_SITE_USES.
BILL_TO_STATE_EXT VARCHAR2(10)
Bill to state, as sent by the customer on the N4 segment.
CARRIER_ID_CODE_EXT VARCHAR2(35)
The carrier id, as sent by the customer on the TD5 segment.
CARRIER_QUALIFIER_EXT VARCHAR2(3)
The carrier qualifier, as sent by the customer on the TD5 segment.
COMMODITY_EXT VARCHAR2(35)
Customer specified commodity code.
COUNTRY_OF_ORIGIN_EXT VARCHAR2(35)
Customer-specified country of origin.
CUST_ASSEMBLY_EXT VARCHAR2(30)
The customer's assembly identification, as sent on the LIN segment of the 866
transaction.
CUST_ASSIGNED_ID_EXT VARCHAR2(20)
Customer assigned identification for differentiation within a transaction set, from
LIN01.
CUST_BILL_TO_EXT VARCHAR2(35)
External customer bill to cross reference.
CUST_CONTRACT_NUM_EXT VARCHAR2(35)
The customer's contract number, as sent on the LIN segment of the 830 transaction.
CUSTOMER_DOCK_CODE VARCHAR2(50)
Customer dock code.
CUST_INTERMD_SHIP_TO_EXT VARCHAR2(35)
External intermediate ship to cross reference.
CUST_ITEM_PRICE_EXT NUMBER
Price included on the customer's EDI transaction.
CUST_ITEM_PRICE_UOM_EXT VARCHAR2(3)
UOM corresponding to the price included on the customer's EDI transaction.
CUSTOMER_ITEM_REVISION VARCHAR2(35)
Customer part revision included on schedule.
CUSTOMER_JOB VARCHAR2(50)
Customer job number.

CUST_MANUFACTURER_EXT VARCHAR2(35)
The manufacturer, as sent by the customer on the LIN segment of the 866 transaction.
CUST_MODEL_NUMBER_EXT VARCHAR2(35)
Customer's model number for this sequenced detail.
CUST_MODEL_SERIAL_NUMBER VARCHAR2(35)
Customer's vehicle identification number for this sequenced detail, e.g. VIN or Chassis
ID.
CUST_ORDER_NUM_EXT VARCHAR2(35)
The order number, as sent by the customer on the LIN segment of the 866 and 830
transaction.
CUST_PROCESS_NUM_EXT VARCHAR2(35)
The process number, as sent by the customer on the LIN segment of the 866 and 862
transaction.
CUST_PRODUCTION_LINE VARCHAR2(50)
Customer production line.
CUSTOMER_PROD_SEQ_NUM VARCHAR2(350)
Customer production sequence number, or delivery number.
CUST_SET_NUM_EXT VARCHAR2(35)
The customer's set number, as sent on the LIN segment of the 862 and 866 transactions.
CUST_SHIP_FROM_ORG_EXT VARCHAR2(80)
External inventory organization cross reference.
CUST_SHIP_TO_EXT VARCHAR2(35)
External ship to address cross reference.
CUST_UOM_EXT VARCHAR2(10)
External customer unit of measure cross reference.
CUSTOMER_ITEM_EXT VARCHAR2(50)
External customer part number cross reference.
CUSTOMER_ITEM_ID NUMBER
Customer item identifier. FK to MTL_CUSTOMER_ITEMS.
REQUEST_DATE DATE
The date and time the customer wants the material delivered or shipped, based on
whether the requirements are delivery based or ship based.
SCHEDULE_DATE DATE
Planned shipment date and time (request_date - delivery lead time if delivery based).
DATE_TYPE_CODE VARCHAR2(30)
Type of start/end date, e.g. ship, deliver, Pull signal, Cumulative. Validated against
FND_LOOKUPS.LOOKUP_TYPE =RLM_DATE_TYPE_CODE
DATE_TYPE_CODE_EXT VARCHAR2(30)
External value from which DATE_TYPE_CODE was derived in EDI Gateway code
conversion.
DELIVERY_LEAD_TIME NUMBER
For demand lines, the difference between arrival and shipment dates, based on default
shipping method between the ship-from and ship-to locations. This is determined by
the calculate ship date routine and passed into Order Import.
END_DATE_TIME DATE
Customer-specified optional end date/time, applicable for flexible bucketed
requirements, and cumulative information such as authorizations and
shipped/received.
EQUIPMENT_CODE_EXT VARCHAR2(3)
The equipment code, as sent by the customer on the TD3 segment.
EQUIPMENT_NUMBER_EXT VARCHAR2(35)
The equipment number, as sent by the customer on the TD3 segment.
HANDLING_CODE_EXT VARCHAR2(3)
Special handling code as sent by the customer in the TD4 segment.
HAZARD_CODE_EXT VARCHAR2(10)
Hazardous material code corresponding to the hazardous material code qualifier as sent
by the customer in the TD4 segment.
HAZARD_CODE_QUAL_EXT VARCHAR2(3)
Hazardous material code qualifier as sent by the customer in the TD4 segment.
HAZARD_DESCRIPTION_EXT VARCHAR2(80)
Hazardous material description as sent by the customer in the TD4 segment.
IMPORT_LICENSE_DATE_EXT DATE
Customer's import license date.
IMPORT_LICENSE_EXT VARCHAR2(35)
Customer's import license for shipment destination country.
INDUSTRY_ATTR IBUTE1 VARCHAR2(150)
Record keeping or model year.

INDUSTRY_ATTRIBUTE10 VARCHAR2(150)
Industry descriptive flexfield.
INDUSTRY_CONTEXT VARCHAR2(30)
Industry descriptive context flexfield.
INTERMEDIATE_SHIP_TO_ID NUMBER
Customer intermediate ship-to destination unique identifier. FK to RA_ADDRESSES
SHIP_TO_ORG_ID NUMBER
Unique identifier for ship-to organization which relates to SHIP_TO_ADDRESS_ID if
there is no intermediate ship-to address, or to INTERMEDIATE_SHIP_TO_ID if
intermediate ship-to address is specified. FK in R12 customer-org data model to
HR_ORGANIZATIONS.
INTRMD_ST_ADDRESS_1_EXT VARCHAR2(35)
Intermediate ship to address line 1, as sent by the customer on the N3 segment.
INTRMD_ST_CITY_EXT VARCHAR2(30)
Intermediate ship to address city, as sent by the customer on the N4 segment.
INTRMD_ST_COUNTRY_EXT VARCHAR2(3)
Intermediate ship to country, as sent by the customer on the N4 segment.
INTRMD_ST_COUNTY_EXT VARCHAR2(25)
Intermediate ship to county, as sent by the customer on the N4 segment.
INTRMD_ST_NAME_EXT VARCHAR2(60)
Intermediate ship to name, as sent by the customer in the N1 and/or N2 segment.
INTRMD_ST_POSTAL_CD_EXT VARCHAR2(15)
Intermediate ship to address postal code, as sent by the customer on the N4 segment.
INTRMD_ST_PROVINCE_EXT VARCHAR2(10)
Intermediate ship to province, as sent by the customer on the N4 segment.
INTRMD_ST_STATE_EXT VARCHAR2(10)
Intermediate ship to state, as sent by the customer on the N4 segment.
INTRMD_ST_SITE_USE_ID NUMBER
Intermediate ship to site use identifier, FK to RA_SITE_USES.
INVENTORY_ITEM_ID NUMBER
Inventory item identifier. FK to MTL_SYSTEM_ITEMS.
INVENTORY_ITEM_SEGMENT1 VARCHAR2(40)
Accounting flexfield.

ITEM_CONTACT_CODE_1 VARCHAR2(3)
Contact code 1 included in customer's EDI transaction.
ITEM_CONTACT_CODE_2 VARCHAR2(3)
Contact code 2 included in customer's EDI transaction.
ITEM_CONTACT_VALUE_1 VARCHAR2(80)
ITEM_CONTACT_VALUE_2 VARCHAR2(80)
Values associated with contact code 2 : concatenation of name, communication code,
ITEM_DESCRIPTION_EXT VARCHAR2(80)
Item description included on schedule.
ITEM_DETAIL_QUANTITY NUMBER
Requested quantity.
If Item_Detail_Type = 0,1,2, this is the demand quantity.
If Item_Detail_Type = 3, this is the authorization quantity.
If Item_Detail_Type = 4, this is the shipped, received or cum quantity.
If Item_Detail_Type = 5, this is a miscellaneous quantity, such as ahead/behind,
inventory balance, etc.
ITEM_DETAIL_REF_CODE_1 VARCHAR2(3)
ITEM_DETAIL_REF_VALUE_1 VARCHAR2(35)

ITEM_DETAIL_SUBTYPE VARCHAR2(30)
Schedule item detail row sub-type:
for firm or forecast demand, Bucket type associated with the demand date/quantity;
for authorizations, the type of authorization;
for shipment/receipt, cumulative or last.
Validated against FND_LOOKUPS.
ITEM_DETAIL_SUBTYPE_EXT VARCHAR2(30)
External value from which ITEM_DETAIL_SUBTYPE was derived in EDI Gateway
Code Conversion.
ITEM_DETAIL_TYPE VARCHAR2(30)
Schedule item detail row type: 0 = Past Due Firm1 = Firm Demand, 2 = Forecast
Demand, 3 = Authorization, 4 = Shipment/Receipt Info, 5 = OtherValidated against
FND_LOOKUPS.LOOKUP_TYPE =RLM_DETAIL_TYPE_CODE
ITEM_DETAIL_TYPE_EXT VARCHAR2(30)
External value from which ITEM_DETAIL_TYPE was derived in EDI Gateway Code
Conversion.
ITEM_ENG_CNG_LVL_EXT VARCHAR2(35)
Customer part engineering change level included on schedule
ITEM_MEASUREMENTS_EXT VARCHAR2(240)
Item measurement information as sent by the customer on the MEA segments.
ITEM_NOTE_TEXT VARCHAR2(240)
Free form item note text included in the schedule.
ITEM_REF_CODE_1 VARCHAR2(3)
Reference code 1 included in customer's EDI transaction (not validated).
ITEM_REF_VALUE_1 VARCHAR2(35)
ITEM_RELEASE_STATUS_EXT VARCHAR2(3)
Customer part release status included on schedule.
LADING_QUANTITY_EXT NUMBER
The lading quantity as sent by the customer on the TD1 segment.
LETTER_CREDIT_EXPDT_EXT DATE
Customerís letter of credit expiration date.
LETTER_CREDIT_EXT VARCHAR2(35)
Customerís letter of credit with international bank guaranteeing payment for
international shipments.
LINE_REFERENCE VARCHAR2(50)
Unique line identifier within an order for a transmission identifier.
LINK_TO_LINE_REF VARCHAR2(50)
Link to Immediate Parent_line_reference within an order for a transmission identifier.
ORDER_HEADER_ID NUMBER
Order header identifier. FK to OE_ORDER_HEADERS.
ORG_ID NUMBER
Operating unit unique id. FK to HR_ORGANIZATION_UNITS.
OTHER_NAME_CODE_1 VARCHAR2(3)
Other name code 1 included in customer's EDI transaction (not validated).
OTHER_NAME_CODE_2 VARCHAR2(3)
Other name code 2 included in customer's EDI transaction (not validated).
OTHER_NAME_VALUE_1 VARCHAR2(80)
Values associated with other name code 1: concatenation of name, code, and number.
OTHER_NAME_VALUE_2 VARCHAR2(80)
Values associated with other name code 2: concatenation of name, code, and number.
PACK_SIZE_EXT NUMBER
Size of supplier units in pack, as sent by the customer on the PO4 segment.

PACK_UNITS_PER_PACK_EXT NUMBER
Number of inner pack units per out pack unit, as sent by the customer on the PO4
segment.
PACK_UOM_CODE_EXT VARCHAR2(3)
Unit of measure of supplier units in the pack, as sent by the customer in the PO4
segment.
PACKAGING_CODE_EXT VARCHAR2(10)
The packaging code as sent by the customer on TD1 segment.
PARENT_LINK_LINE_REF VARCHAR2(50)
Line reference of top model for a transmission identifier for an order.
PRICE_LIST_ID NUMBER
Unique identifier for price list associated with customer item or agreement on which
customer purchase order is associated. FK to RA_PRICE_LISTS
PRIMARY_QUANTITY NUMBER
Quantity in the primary UOM.
PRIMARY_UOM_CODE VARCHAR2(3)
Primary unit of measure. FK to MTL_UNITS_OF_MEASURE
PRIME_CONTRCTR_PART_EXT VARCHAR2(35)
The prime contractor part number, as sent by the customer on the LIN segment of the
862 segment.
PROCESS_STATUS NUMBER
Indicates the current processing status of a the demand line
1= Waiting to be processed
2= Processed with error
3= Processed successfully
4= Processed with error(s) for headers with lines in-error
CUST_PO_RELEASE_NUM VARCHAR2(35)
Customer purchase order release number included on schedule.
CUST_PO_DATE DATE
Customer purchase order line number included on schedule.
CUST_PO_LINE_NUM VARCHAR2(35)
Customer-specified effectivity date of purchase order number included on schedule.
CUST_PO_NUMBER VARCHAR2(50)
Customer purchase order number.
QTY_TYPE_CODE VARCHAR2(30)
Actual or Cumulative. Validated against FND_LOOKUPS.LOOKUP_TYPE
=RLM_QTY_TYPE_CODE
QTY_TYPE_CODE_EXT VARCHAR2(30)
External value from which QTY_TYPE_CODE was derived in EDI Gateway Code
Conversion.
RETURN_CONTAINER_EXT VARCHAR2(35)
Returnable container specified by customer for item shipment.
RLM_SCHEDULE_LINE_ID NUMBER
Schedule line unique identifier. FK to RLM_SCHEDULE_LINES_ALL, except for
aggregated schedule lines.
ROUTING_DESC_EXT VARCHAR2(35)
The routing description, as sent by the customer on the TD5 segment.
ROUTING_SEQ_CODE_EXT VARCHAR2(3)
Code describing the relationship of a carrier to a specific shipment movement, as sent
by the customer on the TD5 segment.
SCHEDULE_ITEM_NUM NUMBER
Schedule Item Number, the means to identify how item demand and information is
grouped by the customer within the schedule. For sequenced schedules, it is equal to
CUSTOMER_PROD_SEQ_NUM. For EDI planning and shipping schedules, it is
incremented in the EDI Gateway when each 2000 record is encountered on an inbound
SPSI or SSSI transaction. This number is assigned for manually entered schedules. All
interface lines with the same schedule item number are validated together, and pass or
fail validation as a group.
SHIP_DEL_PATTERN_EXT VARCHAR2(3)
Customer ship delivery pattern code for this item; not integrated with delivery rules for
date/quantity calculation.
SHIP_DEL_TIME_CODE_EXT VARCHAR2(3)
Customer ship delivery time code for this item; not integrated with delivery rules for
date/quantity calculation.
SHIP_DEL_RULE_NAME VARCHAR2(30)
Shipment/delivery rule name for this schedule item. Initially populated only if a
successful code conversion in the EDI Gateway has occurred. FK to
RLM_SHIP_DELIVERY_CODES
SHIP_FROM_ADDRESS_1_EXT VARCHAR2(35)

Ship from address line 1, as sent by the customer on the N3 segment.
SHIP_FROM_CITY_EXT VARCHAR2(30)
Ship from address city, as sent by the customer on the N4 segment.
SHIP_FROM_COUNTRY_EXT VARCHAR2(3)
Ship from country, as sent by the customer on the N4 segment.
SHIP_FROM_COUNTY_EXT VARCHAR2(25)
Ship from county, as sent by the customer on the N4 segment.
SHIP_FROM_NAME_EXT VARCHAR2(60)
Ship from name, as sent by the customer in the N1 or N2 segment.
SHIP_FROM_ORG_ID NUMBER
Ship from organization identifier. FK to MTL_PARAMETERS and
HR_ORGANIZATIONS.
SHIP_FROM_POSTAL_CD_EXT VARCHAR2(15)
Ship from address postal code, as sent by the customer on the N4 segment.
SHIP_FROM_PROVINCE_EXT VARCHAR2(10)
Ship from province, as sent by the customer on the N4 segment.
SHIP_FROM_STATE_EXT VARCHAR2(10)
Ship from state, as sent by the customer on the N4 segment.
SHIP_LABEL_INFO_LINE_1 VARCHAR2(80)
Pull signal bar-code label routing information - line 1.
SHIP_TO_ADDRESS_1_EXT VARCHAR2(35)
Ship to address line 1, as sent by the customer on the N3 segment.
SHIP_TO_ADDRESS_ID NUMBER
Ship to address identifier. FK to RA_ADDRESSES.
DELIVER_TO_ORG_ID NUMBER
Unique identifier for deliver-to organization which relates to SHIP_TO_ADDRESS_ID.
FK in R12 customer-org data model to HR_ORGANIZATIONS
SHIP_TO_CITY_EXT VARCHAR2(30)
Ship to address city, as sent by the customer on the N4 segment.
SHIP_TO_COUNTRY_EXT VARCHAR2(3)
Ship to country, as sent by the customer on the N4 segment.
SHIP_TO_COUNTY_EXT VARCHAR2(25)
Ship to county, as sent by the customer on the N4 segment.
SHIP_TO_NAME_EXT VARCHAR2(60)

Ship to name, as sent by the customer on the N1 or N2 segment.
SHIP_TO_POSTAL_CD_EXT VARCHAR2(15)
Ship to address postal code, as sent by the customer on the N4 segment.
SHIP_TO_PROVINCE_EXT VARCHAR2(10)
Ship to province, as sent by the customer on the N4 segment.
SHIP_TO_SITE_USE_ID NUMBER
Ship to site use identifier. FK to RA_SITE_USES.
SHIP_TO_STATE_EXT VARCHAR2(10)
Ship to state, as sent by the customer on the N4 segment.
START_DATE_TIME DATE
Customer-specified date and time, as transmitted by the customer on the EDI
transaction.
SUBLINE_ASSIGNED_ID_EXT VARCHAR2(20)
Subline customer assigned identification from the SLN01. Related to but not necessarily
equivalent to the baseline number, assigned identification from LIN01. For example, 1.1
or 1A might be used as a subline number to relate to baseline number 1.
SUBLINE_CONFIG_CODE_EXT VARCHAR2(3)
The Subline Configuration Code, as sent by the customer on the SLN segment,
indicating the relationship of the subline item to the baseline item.
SUBLINE_CUST_ITEM_EXT VARCHAR2(50)
Subline customer item number, as sent by the customer on the SLN segment.
SUBLINE_CUST_ITEM_ID NUMBER
Customer item unique identifier. FK to RLM_SHIP_FROM_CUST_ITEM.
SUBLINE_MODEL_NUM_EXT VARCHAR2(35)
Subline customer model number, as sent by the customer on the SLN segment.
SUBLINE_QUANTITY NUMBER
The subline quantity, as sent by the customer on the SLN segment.
SUBLINE_UOM_CODE VARCHAR2(3)
The subline unit of measure (internal) cross-referenced from the UOM sent by the
customer on the SLN segment. FK to MTL_UNITS_OF_MEASURE.
SUPPLIER_ITEM_EXT VARCHAR2(35)
Supplier item number specified by customer.
TRANSIT_TIME_EXT VARCHAR2(22)
The transit time, as sent by the customer on the TD5 segment.
TRANSIT_TIME_QUAL_EXT VARCHAR2(3)
The transit time qualifier, as sent by the customer on the TD5 segment.
TRANSPORT_LOC_QUAL_EXT VARCHAR2(3)
The shipping location qualifier, as sent by the customer on the TD5 segment. This
identifies the type of location which specified in the corresponding shipping location.
TRANSPORT_LOCATION_EXT VARCHAR2(35)
The specific shipping location (such as pool point or airport) corresponding to the
shipping location qualifier, as sent by the customer on the TD5 segment. This
corresponds to the shipping location qualifier.
TRANSPORT_METHOD_EXT VARCHAR2(3)
The transportation method, as sent by the customer on the TD5 segment.
UOM_CODE VARCHAR2(3)
Abbreviated unit of measure code. FK to MTL_UNITS_OF_MEASURE.
WEIGHT_EXT NUMBER
The weight, as sent by the customer on the TD1 segment.
WEIGHT_QUALIFIER_EXT VARCHAR2(3)
The weight qualifier, as sent by the customer on the TD1 segment.
WEIGHT_UOM_EXT VARCHAR2(3)
The unit of measure corresponding to shipment weight, as sent by the customer on the
TD1 segment.
FBO_CONFIGURATION_KEY_1 VARCHAR2(35)
For FBO Production Sequence schedules, the 1st sort key for identifying configurations
indicated by the customer.
For FBO Production Sequence schedules, the 2nd sort key for identifying configurations
For FBO Production Sequence schedules, the 3rd sort key for identifying configurations
For FBO Production Sequence schedules, the 4th sort key for identifying configurations
For FBO Production Sequence schedules, the 5th sort key for identifying configurations

MATCH_ACROSS_KEY VARCHAR2(150)
Audit trail of match across key used when this schedule was processed.
MATCH_WITHIN_KEY VARCHAR2(150)
Audit trail of match within key used when this schedule was processed.
CRITICAL_KEY_ATTRIBUTES VARCHAR2(150)
Audit trail of critical attributes key used when this schedule was processed. An
exception (warning) is generated if one of these is missing on Firm demand.
LAST_UPDATE_DATE DATE
LAST_UPDATED_BY NUMBER
CREATION_DATE DATE
CREATED_BY NUMBER
ATTRIBUTE_CATEGORY VARCHAR2(30)
Descriptive flexfield context column.
Descriptive flexfield segment column
Descriptive flexfield segment column
LAST_UPDATE_LOGIN NUMBER
REQUEST_ID NUMBER
PROGRAM_APPLICATION_ID NUMBER
Standard Who column
PROGRAM_ID NUMBER
PROGRAM_UPDATE_DATE DATE
Trading partner flexfield segment column.

TP_ATTRIBUTE_CATEGORY VARCHAR2(30)
Trading partner flexfield context column.
LINE_NUMBER NUMBER
Unique identifier of a line within a schedule.
INTMED_SHIP_TO_ORG_ID NUMBER
Unique identifier for intermediate ship-to organization which relates to
INTERMEDIATE_SHIP_TO_ID if intermediate ship-to address is specified. FK to
HR_ORGANIZATIONS
LINE_SOURCE VARCHAR2(30)
Schedule Source at line level since lines can also be manually entered.
PREFERRED_GRADE VARCHAR2(4)
Preferred grade.
CUST_PRODUCTION_SEQ_NBR_BEG VARCHAR2(35)
For future use.
CUST_PRODUCTION_SEQ_NBR_END VARCHAR2(35)
For future use.
ITEM_DETAIL_QUANTITY_MIN_EXT NUMBER
For future use.
ITEM_DETAIL_QUANTITY_MAX_EXT NUMBER
For future use.
ITEM_DETAIL_QUANTITY_PRIOR_EXT NUMBER
For future use.
REUIREMENT_PRIORITY_EXT NUMBER
For future use.
PROJECT_NUMBER_EXT VARCHAR2(50)
For future use.
RESP_LINE_NUMBER VARCHAR2(35)
For future use.
TASK_NUMBER_EXT VARCHAR2(50)
For future use.
UPC_EXT VARCHAR2(50)
For future use.
ITEM_ENG_CNG_LVL_DATE_EXT DATE
For future use.
AUTHORIZATION_CODE_EXT VARCHAR2(50)
For future use.
PACKAGING_DESC_EXT VARCHAR2(80)
For future use.
For future use.
For future use.

For future use.
For future use.
For future use.
ONE_TIME_BILL_TO_FLAG VARCHAR2(35)
For future use.
BILL_TO_DESCRIPTION_EXT VARCHAR2(50)
For future use.
BILL_TO_FAX_EXT VARCHAR2(35)
For future use.35
BILL_TO_REGION_EXT VARCHAR2(35)
For future use.
BILL_TO_JURISDICTION_EXT VARCHAR2(35)
For future use.
BILL_TO_TEL_EXT VARCHAR2(35)
For future use.
For future use.
For future use.
For future use.
For future use.
For future use.
ONE_TIME_INTRMD_ST_FLAG_EXT VARCHAR2(35)
For future use.
INTRMD_ST_DESCRIPTION_EXT VARCHAR2(50)
For future use.
INTRMD_ST_FAX_EXT VARCHAR2(35)
For future use.
INTRMD_ST_REGION_EXT VARCHAR2(35)
For future use.
INTRMD_ST_JURISDICTION_EXT VARCHAR2(35)
For future use.
INTRMD_ST_TEL_EXT VARCHAR2(35)
For future use.
For future use.
For future use.
For future use.
For future use.
For future use.
ONE_TIME_SHIP_TO_FLAG_EXT VARCHAR2(35)
For future use.
SHIP_TO_DESCRIPTION_EXT VARCHAR2(50)
For future use.
SHIP_TO_FAX_EXT VARCHAR2(35)
For future use.
SHIP_TO_REGION_EXT VARCHAR2(35)
For future use.
SHIP_TO_JURISDICTION_EXT VARCHAR2(35)
For future use.
SHIP_TO_TEL_EXT VARCHAR2(35)
For future use.
For future use.

For future use.
For future use.
For future use.
For future use.
ONE_TIME_SHIP_FROM_FLAG_EXT VARCHAR2(35)
For future use.
SHIP_FROM_DESCRIPTION_EXT VARCHAR2(50)
For future use.
SHIP_FROM_FAX_EXT VARCHAR2(35)
For future use.
SHIP_FROM_REGION_EXT VARCHAR2(35)
For future use.
SHIP_FROM_JURISDICTION_EXT VARCHAR2(35)
For future use.
SHIP_FROM_TEL_TEXT VARCHAR2(35)
For future use
12
Oracle Shipping Execution Open Interfaces
and APIs

• Overview of API Information
• Shipment Processing Using APIs
• Actions, APIs, and Parameters
• Application Parameter Initialization
• Trip Public Application Program Interface
• Stop Public Application Program Interface
• Deliveries Public Application Program Interface
• Exceptions Application Program Interface
• Delivery Details Public Application Program Interface
• Container Public Application Program Interface
• Freight Costs Public Application Program Interface
• Pick Release Application Program Interface
• Document Public Application Program Interface
• Custom Public Application Program Interface
• Example of API Packages and Procedures
Overview of API Information

This chapter contains the following information about Oracle Shipping Execution
Public Application Program Interfaces (APIs)::
• Shipment Processing Using APIs: Correlation between common Shipping
Oracle Shipping Execution Open Interfaces and APIs 12-1

Transaction Form tasks and Public APIs and some sample scenarios that you can
use to process shipments through ship confirmation using APIs.
• API Package and Procedures Example: An example of two simple procedures in the
same package that use the APIs.
• Public Application Program Interfaces: Descriptions of the APIs.

• Actions, APIs, and Parameters: Descriptions of the APIs used for various
functions and the API parameters.
• Application Parameter Initialization: Description of the application parameter

initialization call.
• Trip API: Create and update trip records and perform actions on trips.
• Exceptions API: Retrieve information on exceptions and carry out actions on

exceptions.
• Stop API: Create and update stop records and perform actions on stops.
• Deliveries API: Create and update trip stop records and perform actions on trip
stops.
• Delivery Details API: Assign and unassign delivery details to and from
deliveries, split a delivery detail, update a delivery detail with new information,
and create trips and deliveries for multiple delivery lines.
• Container API: Create container records, update container records, autopack

containers, perform actions on containers.
• Freight Cost APIs: Create freight cost records, update freight cost records,
validate freight cost types, delete freight cost records.
• Picking API: Creates a record of all pick release batches.
• Custom API: Customize delivery window calculations and tailor how the
location information is displayed in the Oracle Shipping Execution forms and
reports.
• Document API: Creates a record of the attributes of an open document, such as

a bill of lading or packing slip.
Note: For details about migrating your shipping process from the
Release 10.7 and Release 11 delivery-based Ship Confirm Open
Interface to the Release 12 public APIs, see OracleMetaLink note
422084.1.
Shipment Processing Using APIs

This section contains:
• The Shipping Transaction Form/Public API Correlation table: This table specifies
the public APIs that correspond to common actions that you perform on the
Shipping Transactions Form.
• Sample flow scenarios: These scenarios show different paths to ship confirmation
using APIs. Each step in the flow refers to a reference number (Ref) in the API
Table.
Note: As a general rule, if an attribute is not updatable from the

Shipping Transactions Form, then it is not updateable from the
public API. If you pass a value for a non-updateable attribute, then
the code ignores the value and the existing value in the database is
retained.
The shipping flow scenarios refer to the reference numbers shown in this table.
Shipping Transaction Form/Public API Correlation
Ref Function STF Package. API Action Data

Equivalent Procedure Codes Requirements
1 Select Find Not a specific - -

delivery window > API. To do
lines for Search for this, populate
processing Lines > API input
Enter search parameter
criteria tables before
submitting
the API.
2.1 Create Data Entry, WSH_TRIPS_ CREATE If known, provide

trips Trip Data PUB. information such as
Entry > CREATE_UP trip name, ship
Enter data DATE_TRIP method, carrier ID,
and vehicle
number.

2.2 Update Find WSH_TRIPS_ UPDATE If known, provide

trips window > PUB. vehicle type and
Search for CREATE_UP vehicle number
Trips > Enter DATE_TRIP
trip name >
Add/change
/delete data
2.3 Perform Find WSH_TRIPS_ PLAN, -

actions on window > PUB.TRIP_A UNPLAN,
trips Search for CTION DELETE,
Trips > WT-VOL,
Select action PICK-
RELEASE,
PRINT-DOC-S
ETS, FIRM,
TRIP-CONFIR
M,
PRINT-MBOL,
UNASSIGN-A
LL
3.1 Create Data Entry, WSH_TRIP_S CREATE Provide trip ID or

stops Stop Data TOPS_PUB. trip name, stop
Entry > CREATE_UP location ID or stop
Enter data DATE_STOP location code,
planned departure
date, and planned
arrival date.
3.2 Update Find WSH_TRIP_S UPDATE Provide change

stops window > TOPS_PUB. information, for
Search for CREATE_UP example, planned
Stops > DATE_STOP dates.
Add/change
/delete data
3.3 Perform Find WSH_TRIP_S PLAN, -

actions on window > TOPS_PUB. UNPLAN,
stops Search for STOP_ACTIO ARRIVE,
Stops > N CLOSE,
Select action DELETE,
PICK-
RELEASE,
WT-VOL
4.1 Create Data Entry, WSH_DELIV CREATE Provide

deliveries Delivery ERIES_PUB.C organization, initial
Data Entry > REATE_UPD ship-from, and
Enter data ATE_DELIVE ultimate ship-to
RIES information.
4.2 Update Find WSH_DELIV UPDATE -

deliveries window > ERIES_PUB.
Search for CREATE_UP
Deliveries > DATE_DELIV
Add/change ERIES
/ delete data

4.3 Perform Find WSH_DELIV PLAN, -

actions on window > ERIES_PUB. UNPLAN,
deliveries Search for DELIVERY_A DELETE,
Deliveries > CTION WT-VOL,
Select action PICK-
RELEASE,
RE-OPEN,
CLOSE,
PICK-PACK-S
HIP,
OUTBOUND-
DOCUMENT,
PRINT-DOC-S
ETS, FIRM,
AUTO-PACK,
AUTO-PACK-
MASTER,
GEN-LOAD-SE
Q,
SELECT-CARR
IER,
CANCEL-SHIP
-METHOD,
PRINT-PACK-
SLIP,
PRINT-BOL
4.4 Assign and Find WSH_DELIV ASSIGN-TRIP, For ASSIGN-TRIP,

cancel the window > ERIES_PUB. UNASSIGN- provide a trip
assignmen Search for DELIVERY_A TRIP, name.
t of Deliveries > CTION AUTOCREATE
deliveries Select action -TRIP
to and
from trips
and stops
4.5 Ship Find WSH_DELIV CONFIRM Provide the actual

confirmed window > ERIES_PUB. ship date.
deliveries Search for DELIVERY_A
Deliveries > CTION
Action: Ship
Conform
4.6 Pick and Find WSH_DELIV PICK-SHIP -

Ship window > ERIES_PUB.
confirm Search for DELIVERY_A
delivery Deliveries > CTION
Action: Pick
and Ship
5.1 Assign and Find WSH_DELIV ASSIGN, Provide a delivery

cancel the window > ERY_DETAIL UNASSIGN ID or delivery
assignmen Search for S_PUB. name.
t of Lines > DETAIL_TO_
delivery Enter DELIVERY
lines to delivery line
and from number >
deliveries Select action
5.2 Split Find WSH_DELIV - Provide a split

delivery window > ERY_DETAIL quantity.
lines Search for S_PUB.SPLIT
Lines > _LINE
Enter
delivery line
number >
Action: Split
Line
5.3 Confirm Find WSH_DELIV UPDATE -

actual window > ERY_DETAIL
shipped Search for S_PUB.
quantities Lines > UPDATE_SHI
Enter PPING_ATTR
Shipped IBUTES
Quantity
and
add/change/
delete data

5.4 Create Find WSH_DELIV - -

deliveries window > ERY_DETAIL
automatica Search for S_PUB.
lly Lines > AUTOCREAT
Enter criteria E_DELIVERIE
> Action: S
Auto-create
Delivery
5.5 Create Find WSH_DELIV - -

deliveries window > ERY_DETAIL
and trips Search for S_PUB.
automatica Lines > AUTOCREAT
lly Enter criteria E_DEL_TRIP
> Action:
Auto-create
Trip
6.1 Create Data Entry, WSH_CONT - Provide the

containers LPN Data AINER_PUB. container item ID
Entry > CREATE_CO (prefix, base, and
Enter data NTAINERS suffix)
6.2 Update Find WSH_CONT - -

containers window > AINER_PUB.
Search for UPDATE_CO
Lines/LPN > NTAINER
Add/
change/
delete data
6.3 Pack and Find WSH_CONT PACK, For PACK, provide

unpack window > AINER_PUB. UNPACK the container ID or
delivery Search for CONTAINER the container name
lines into Lines > _ACTIONS and delivery line
and from Enter ID.
containers delivery line
number >
Select action
> Select
target LPN
6.4 Assign and Find WSH_CONT ASSIGN, -

cancel the window > AINER_PUB. UNASSIGN
assignmen Search for CONTAINER
t of LPN > Enter _ACTIONS
containers LPN > Select
to and action
from
deliveries
6.5 Create Find WSH_CONT - Provide delivery

containers window > AINER_PUB. line ID
and Search for AUTO_PACK
auto-pack Lines >
Enter
delivery line
number >
Action:
Auto-pack
6.6 Enter serial Find WSH_DELIV UPDATE Provide delivery

numbers window > ERY_DETAIL line ID and Serial
for serial Search for S_PUB.UPDA Number(s).
controlled Lines > Go TE_SHIPPIN
item at SO to Tools > G_ATTRIBUT
Issue Serial ES
Numbers > (Overloaded)
Enter the
Serial
Number(s) >
Save

7.1 Create and Find WSH_FREIG CREATE, For trip, stop,

update window > HT_COSTS_P UPDATE delivery, and
freight Search for UB.CREATE_ delivery line,
costs entity (Trip, UPDATE_FR provide the entity
Stop, EIGHT_COST name or entity ID.
Delivery, or
Delivery
Line) > Enter
entity name>
Action:
Freight Cost
> Enter or
add/change/
delete data
7.2 Validate Find WSH_FREIG - -

freight window > HT_COSTS_P
costs Search for UB.
entity (Trip, VALIDATE_F
Stop, REIGHT_COS
Delivery, or T_TYPE
Delivery
Line) > Enter
entity name>
Action:
Freight Cost
> Open
Freight
Name LOV
and select
one
7.3 Delete Find WSH_FREIG - -

freight window > HT_COSTS_P
costs Search for UB.DELETE_
entity (Trip, FREIGHT_CO
Stop, STS
Delivery, or
Delivery
Line) > Enter
entity name>
Action:
Freight Cost
> Delete row
Sample Flow Scenarios
The following scenarios show the different paths to ship confirmation using APIs. Each
step in a flow refers to a reference number in the API Table:
• Scenario 1: Pick Release, Ship Confirm/Pick Release with Auto-Ship Confirm as a
rule.
• Scenario 2: Pick Release, Ship Confirm with Serial Numbers (for single and multiple
serial numbers)
• Scenario 3: Create Delivery, Auto-create Trip, Pick Release Trip
• Scenario 4: Create Trip, Stop, and Delivery; Assign Entities; Pack Items into
Containers
• Scenario 5: Auto-create Delivery and Trip, Auto-pack Lines/Manual Pack, Add

Freight Costs

Actions, APIs, and Parameters
This section specifies the APIs you use to perform actions on shipping entities and lists
the parameters that the APIs use.
Each time you call an API, include the parameters listed in the Required Parameters
column and, in addition, include the standard parameters p_api_version_number,
p_init_msg_list, p_commit, p_validation_level, x_return_status, x_msg_count, and
x_msg_data.
Some of the parameters may have default values in their API signatures. Refer to the
Record Parameter Description section for each API to see if a parameter has a default
value.
Some of the parameters are Table type or Record type. Refer to the Record Parameter
Description section for each API to see its table and record definitions.
Trips
The following table shows trip actions, APIs, and parameters:
Trip Actions, APIs, and Parameters
Action API Required Optional Comments

Parameters Parameters
Plan WSH_TRIPS_PU p_action_code = - -

B.Trip_Action PLAN
p_trip_id or
p_trip_name
Unplan WSH_TRIPS_PU p_action_code = - -

B.Trip_Action UNPLAN
p_trip_id or
p_trip_name
Launch pick WSH_TRIPS_PU p_action_code = - -

release B.Trip_Action PICK- RELEASE
p_trip_id or
p_trip_name
Calculate weight WSH_TRIPS_PU p_action_code = p_wv_override_f -

and volume B.Trip_Action WT-VOL lag
p_trip_id or
p_trip_name

Delete WSH_TRIPS_PU p_action_code = - -

B.Trip_Action DELETE
p_trip_id or
p_trip_name
Create WSH_TRIPS_PU p_action_code = p_trip_name -

B.Create_Update CREATE
_Trip
p_trip_info
x_trip_id
x_trip_name
Update WSH_TRIPS_PU p_action_code = p_trip_name For p_trip_info,

B.Create_Update UPDATE pass only the
_Trip attributes that
p_trip_info need updating.
x_trip_id
x_trip_name
Print Document WSH_TRIPS_PU p_action_code = - -

Sets B.TRIP_ACTION PRINT-DOC-SE
TS
p_report_set_na
me
or
p_trip_name
Firm Routing WSH_TRIPS_PU p_action_code = - -

B.TRIP_ACTION FIRM
p_trip_id
or
p_trip_name
Ship Confirm WSH_TRIPS_PU p_action_code = - -

B.TRIP_ACTION TRIP-CONFIRM
p_trip_id
or
p_trip_name
Print Master WSH_TRIPS_PU p_action_code = - -

BOL B.TRIP_ACTION PRINT-MBOL
p_trip_id
or
p_trip_name
Unassign All WSH_TRIPS_PU p_action_code = - -

Deliveries B.TRIP_ACTION UNASSIGN-AL
L
p_trip_id
or
p_trip_name
Stops
The following table shows stop actions, APIs, and parameters:

Stop Actions, APIs, and Parameters

Plan WSH_TRIP_STO p_action_code = - You can

PS_PUB. PLAN substitute all of
Stop_Action the following for
p_stop_id p_stop_id:
p_trip_name or
p_trip_id
p_stop_location_
code or
p_stop_location_
id
p_planned_dep_
date
Unplan WSH_TRIP_STO p_action_code = - You can

PS_PUB. UNPLAN substitute all of
p_trip_name or
p_trip_id
p_stop_location_
code or
p_stop_location_
id
p_planned_dep_
date
Update Status - WSH_TRIP_STO p_action_code = p_actual_date You can

Arrive PS_PUB. ARRIVE substitute all of
Stop_Action p_defer_interfac the following for
p_stop_id e_flag p_stop_id:
p_trip_name or
p_trip_id
p_stop_location_
code or
p_stop_location_
id
p_planned_dep_
date
Update Status - WSH_TRIP_STO p_action_code = p_actual_date You can

Close PS_PUB. CLOSE substitute all of
Stop_Action p_defer_interfac the following for
p_stop_id e_flag p_stop_id:
p_trip_name or
p_trip_id
p_stop_location_
code or
p_stop_location_
id
p_planned_dep_
date
Launch pick WSH_TRIP_STO p_action_code = - You can

release PS_PUB. PICK- RELEASE substitute all of
p_trip_name or
p_trip_id
p_stop_location_
code or
p_stop_location_
id
p_planned_dep_
date

Delete WSH_TRIP_STO p_action_code = - You can

PS_PUB. DELETE substitute all of
p_trip_name or
p_trip_id
p_stop_location_
code or
p_stop_location_
id
p_planned_dep_
date
Create WSH_TRIP_STO p_action_code = - -

PS_PUB. CREATE
Create_Update_
Stop p_stop_info
x_stop_id
Update WSH_TRIP_STO p_action_code = p_trip_id For p_stop_info,

PS_PUB. UPDATE pass only the
Create_Update_ p_trip_name attributes that
Stop p_stop_info need updating.
p_stop_location_
x_stop_id id
p_stop_location_
code
p_planned_dep_
date
Reset WSH_TRIP_STO p_action_code = - You can

Weight/Vol PS_PUB. WT-VOL substitute all of
p_trip_name or
p_trip_idp_stop_
location_code or
p_stop_location_
id
Deliveries
The following table shows delivery actions, APIs, and parameters:
Delivery Actions, APIs, and Parameters

Plan wsh_deliveries_ p_action_code = - -

pub. PLAN
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Unplan wsh_deliveries_ p_action_code = - -

pub. UNPLAN
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name

Ship confirm wsh_deliveries_ p_action_code = p_sc_action_flag -

pub. CONFIRM
delivery_action p_sc_close_trip_f
p_delivery_id or lag
p_delivery_nam
e p_sc_create_bol
x_trip_id p_sc_stage_del_f
lag
x_trip_name
p_sc_trip_ship_
method
p_sc_actual_dep
_date
p_sc_report_set_
id
p_sc_report_set_
name
p_sc_defer_inter
face
Reopen wsh_deliveries_ p_action_code = - -

pub. RE-OPEN
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Close wsh_deliveries_ p_action_code = - -

pub. CLOSE
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Assign to trip wsh_deliveries_ p_action_code = p_asg_pickup_st -

pub. ASSIGN-TRIP op_id
delivery_action
p_delivery_id or p_asg_pickup_lo
p_delivery_nam c_id
e
p_asg_pickup_st
p_asg_trip_id or op_seq
p_asg_trip_name
p_asg_pickup_lo
x_trip_id c_code
x_trip_name p_asg_pickup_ar
r_date
p_asg_pickup_d
ep_date
p_asg_dropoff_s
top_id
p_asg_dropoff_l
oc_id
p_asg_dropoff_s
top_seq
p_asg_dropoff_l
oc_code
p_asg_dropoff_a
rr_date
p_asg_dropoff_d
ep_date
Unassign from wsh_deliveries_ p_action_code = - -

trip pub. UNASSIGN-
delivery_action TRIP
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name

Auto-create trip wsh_deliveries_ p_action_code = - -

pub. AUTOCREATE-
delivery_action TRIP
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Calculate weight wsh_deliveries_ p_action_code = p_wv_override_f -

and volume pub. WT-VOL lag
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Launch pick wsh_deliveries_ p_action_code = - -

release pub. PICK- RELEASE
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Delete wsh_deliveries_ p_action_code = - -

pub. DELETE
delivery_action
p_delivery_id or
p_delivery_nam
e
x_trip_id
x_trip_name
Create wsh_deliveries_ p_action_code = p_delivery_nam -

pub. CREATE e
create_update_d
elivery p_delivery_info
x_delivery_id
x_name
Update wsh_deliveries_ p_action_code = p_delivery_nam For

pub. UPDATE e p_delivery_info,
create_update_d pass only the
elivery p_delivery_info attributes that
x_delivery_id need updating.
x_name
Auto-pack WSH_CONTAI p_entity_tab - -

NER_PUB.Auto_
Pack p_entity_type
p_group_id_tab
p_pack_cont_fla
g
x_cont_inst_tab
Pick and Ship wsh_deliveries_ p_action_code = - -

pub. PICK- SHIP
delivery_action
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name

Pick, Pack and wsh_deliveries_ p_action_code = - -

Ship pub. PICK-PACK-SHI
delivery_action P
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Send Outbound wsh_deliveries_ p_action_code = - -

Message pub. OUTBOUND-D
delivery_action OCUMENT
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Print Document wsh_deliveries_ p_action_code = - -

Sets pub. PRINT-DOC-SE
delivery_action TS
p_delivery_id
p_delivery_nam
e
p_sc_report_set_
name
or
p_sc_report_set_
idx_trip_idx_trip
_name
Firm Routing wsh_deliveries_ p_action_code = - -

and Contents pub. FIRM
delivery_action
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Auto-Pack wsh_deliveries_ p_action_code = - -

pub. AUTO-PACK
delivery_action
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Auto-Pack wsh_deliveries_ p_action_code = - -

Master pub. AUTO-PACK-M
delivery_action ASTER
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Generate wsh_deliveries_ p_action_code = - -

Loading pub. GEN-LOAD-SE
Sequence delivery_action Q
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name

Select Carrier wsh_deliveries_ p_action_code = - -

pub. SELECT-CARRI
delivery_action ER
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Cancel Ship wsh_deliveries_ p_action_code = - -

Method pub. CANCEL-SHIP-
delivery_action METHOD
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Print Pack Slip wsh_deliveries_ p_action_code = - -

pub. PRINT-PACK-S
delivery_action LIP
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Print BOL wsh_deliveries_ p_action_code = - -

pub. PRINT-BOL
delivery_action
p_delivery_id
p_delivery_nam
e
x_trip_idx_trip_
name
Delivery Details
The following table shows delivery detail actions, APIs, and parameters:
Delivery Detail Actions, APIs, and Parameters

Assign to wsh_delivery_de p_TabOfDelDets - -

delivery tails_pub.
detail_to_deliver p_action =
y ASSIGN,
p_delivery_id
p_delivery_nam
e
Unassign from wsh_delivery_de p_TabOfDelDets - -

delivery tails_pub.
detail_to_deliver p_action =
y UNASSIGN
p_delivery_id
p_delivery_nam
e
Split line wsh_delivery_de p_from_detail_id - -

tails_pub.
split_line x_split_quantity
x_new_detail_id
x_split_quantity
2
Update wsh_delivery_de p_changed_attri p_container_flag For

tails_pub. butes p_changed_attri
Update_Shippin butes, pass only
g_Attributes p_source_code the attributes
that need
updating.
Autocreate wsh_delivery_de p_line_rows - -

delivery tails_pub.
Autocreate_Deli x_del_rows
veries

Autocreate trip wsh_delivery_de p_line_rows - -

tails_pub.
Autocreate_del_t x_del_rows
rip x_trip_id
x_trip_name
Pack into a WSH_CONTAI p_detail_tab p_container_flag -

container NER_PUB.
Container_Actio p_action_code p_delivery_flag
ns =PACK
p_container_na
me or
p_cont_instance_
id
Unpack from a WSH_CONTAI p_detail_tab p_container_flag -

container NER_PUB.
Container_Actio p_action_code p_delivery_flag
ns =UNPACK
p_container_na
me or
p_cont_instance_
id
Auto-pack WSH_CONTAI p_entity_tab - -

NER_PUB.Auto_
Pack p_entity_type
p_group_id_tab
p_pack_cont_fla
g
x_cont_inst_tab
Create container WSH_CONTAI p_container_ite - -

NER_PUB.Creat m_id
e_Containers
p_container_ite
m_name
p_container_ite
m_seg
p_organization_i
d
p_organization_c
ode
p_name_prefix
p_name_suffix
p_base_number
p_num_digits
p_quantity
p_container_na
me
x_container_ids
Update WSH_CONTAI p_container_rec - For

container NER_PUB. p_container_rec,
Update_Contain pass only the
er attributes that
need updating.
Assign container WSH_CONTAI p_detail_tab p_container_flag -

to a delivery NER_PUB.Conta
iner_Actions p_action_code = p_delivery_flag
ASSIGN
p_delivery_id or
p_delivery_nam
e

Unassign WSH_CONTAI p_detail_tab p_container_flag -

container from a NER_PUB.Conta
delivery iner_Actions p_action_code = p_delivery_flag
UNASSIGN
p_delivery_id or
p_delivery_nam
e
Enter serial WSH_DELIVER p_changed_attri p_container_flag For

numbers at Sales Y_DETAILS_PU butes p_changed_attri
Order issue. B.Update_Shippi butes, pass only
ng_Attributes p_source_code the attributes
(overloaded) p_serial_range_t that need
ab update. For
p_serial_range_t
ab pass the
delivery_detail_i
d,
from_serial_num
ber,
to_serial_numbe
r and quantity.
Application Parameter Initialization

In your scripts that call Public APIs, include a call to fnd_global.apps_initialize
immediately after the BEGIN. The call syntax is
fnd_global.apps_initialize(user_id => l_user_id,
resp_id => l_resp_id,
resp_appl_id => l_resp_appl_id,
security_group_id => l_security_group_id);
Finding Variable Values

To find the values for the variables, perform these steps:
1. Navigate to the Transaction form.
Help > Diagnostics > Examine.
2. In Block, enter $PROFILES$
3. In Field, enter USER_ID and press Tab. Use the value in Value for l_user_id.
4. In Field, enter RESP_ID and press Tab. Use the value in Value for l_resp_id.
5. In Field, enter RESP_APPL_ID and press Tab. Use the value in Value for
l_resp_appl_id.
6. In Field, enter SECURITY_GROUP_ID and press Tab. Use the value in Value for
l_security_group_id.
Trip Public Application Program Interface

The Trip Public Application Program Interface (API) is a public API that consists of the
following two procedures in package WSH_TRIPS_PUB:
Create_Update_Trip: Enables you to create a new trip record and update an existing
trip record.
Trip_Action: Enables you to perform certain actions on a trip.
This section describes how to use the Trip Public API and how it functions in Oracle
Shipping Execution.
Create_Update_Trip API Features

The Create_Update_Trip API has the following features.
The Create_Update_Trip procedure enables you to create a new trip record or update
an existing trip record in the WSH_TRIPS table. The TRIP_ID, NAME and return status
of a new trip are passed as OUT parameters, while the trip NAME of an existing trip for
update is passed as an IN parameter.
Functional Overview
This API creates a new trip record in WSH_TRIPS as specified by IN parameter
p_action_code value CREATE. It inserts the trip information into WSH_TRIPS and
returns the TRIP_ID and NAME of the new trip. It also updates an existing trip record
in WSH_TRIPS as specified by IN parameter p_action_code value UPDATE. The NAME
of the trip being updated is passed through IN parameter p_trip_name.
The API validates trip information such as Trip Name, Arrive After Trip Name, and
Ship Method before performing the actions of creating or updating a trip record. It also
checks that the insert or update statements were successful, and if not returns an error.
Procedure Parameter Descriptions

The following chart describes all parameters used by the public procedure
WSH_TRIPS_PUB.CREATE_UPDATE_TRIP. All of the inbound and outbound
parameters are listed. Additional information on these parameters follows.

WSH_TRIPS_PUB.CREATE_UPDATE_TRIP Parameters
Parameter Usage Type Required
p_api_version_numb IN Number x
er
p_init_msg_list IN Varchar2 -
x_return_status OUT Varchar2 -
x_msg_count OUT Number -
x_msg_data OUT Varchar2 -
p_action_code IN Varchar2 x
p_trip_info IN OUT Record x
p_trip_name IN Varchar2 -
x_trip_id OUT Number -
x_trip_name OUT Varchar2 -
Compares the incoming API call's version number with the current version number. An
error is returned if the version numbers are incompatible.
p_init_msg_list
Requests that the API initialize the message list on your behalf. If the x_msg_count is
greater than 1, then the list of messages must be retrieved using the call FND_
MSG_PUB.GET. The values are:
• p_msg_index => I
• p_encoded => F
• p_data => 1_message
• p_msg_index_out => 1_msg_index_out
where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and
Number respectively.
x_return_status
Requests that the API return the status of the data for you after it completes its function.
Values include:
• Success: FND_API.G_RET_STS_SUCCESS
• Error: FND_API.G_RET_STS_ERROR
• Unexpected Error: FND_API.G_RET_STS_UNEXP_ERROR
x_msg_count
Indicates number of error messages API has encountered.
x_msg_data
Returns error message text. If the x_msg_count is equal to 1, then this contains the
actual message.
p_action_code
Specifies whether API should create a new trip or update existing trip information
based on its values CREATE or UPDATE.
p_trip_info
Attributes of the trip entity of type Trip_Pub_Rec_Type. These attributes are
inserted/updated in WSH_TRIPS. Definition of Trip_Pub_Rec_Type follows.
p_trip_name
IN parameter to specify the Name of trip to be updated.
x_trip_id
Trip ID of new trip being created.
x_trip_name
Name of new trip being created.
Record Parameter Descriptions

TRIP_PUB_REC_TYPE RECORD DEFINITION
To encapsulate WSH_TRIPS table definition and Value column equivalents for ID
columns in a PL/SQL record, define TRIP_PUB_REC_TYPE to pass trip information to
the Create_Update_Trip routine.

TRIP_PUB_REC_TYPE Record Definition
Attribute Type Default Value
trip_id Number fnd_api.g_miss_num
name Varchar2(30) fnd_api.g_miss_char
arrive_after_trip_id Number fnd_api.g_miss_num
arrive_after_trip_name Varchar2(30) fnd_api.g_miss_char
vehicle_item_id Number fnd_api.g_miss_num
vehicle_item_desc Varchar2(240) fnd_api.g_miss_char
vehicle_organization_id Number fnd_api.g_miss_num
vehicle_organization_code Varchar2(3) fnd_api.g_miss_char
vehicle_number Varchar2(30) fnd_api.g_miss_char
vehicle_num_prefix Varchar2(10) fnd_api.g_miss_char
carrier_id Number fnd_api.g_miss_num
ship_method_code Varchar2(30) fnd_api.g_miss_char
ship_method_name Varchar2(80) fnd_api.g_miss_char
route_id Number fnd_api.g_miss_num
routing_instructions Varchar2(2000) fnd_api.g_miss_char
seal_code Varchar2(30) fnd_api.g_miss_char
attribute_category Varchar2(150) fnd_api.g_miss_char
attribute1 Varchar2(150) fnd_api.g_miss_char
creation_date Date fnd_api.g_miss_char
created_by Number fnd_api.g_miss_num
last_update_date Date fnd_api.g_miss_date
last_updated_by Number fnd_api.g_miss_num
last_update_login Date fnd_api.g_miss_date
program_application_id Number fnd_api.g_miss_num
program_id Number fnd_api.g_miss_num

program_update_date Date fnd_api.g_miss_date
request_id Number fnd_api.g_miss_num
service_level Varchar2(30 fnd_api.g_miss_char
mode_of_transport Varchar2(30) fnd_api.g_miss_char
operator Varchar2(150) fnd_api.g_mis_char
Record Parameter Attribute Validations

trip_id
Should be a valid unique element of wsh_trips.trip_id.
name
Should be a valid unique element of wsh_trips.name
arrive_after_trip_id
Should be a valid element of wsh_trips.trip_id.
arrive_after_trip_name
Should be a valid element of wsh_trips.name
vehicle_item_id
Should be a valid vehicle item in mtl_system_items.inventory_item_id as designated by
mtl_system_items.vehicle_tem_flag.
vehicle_item_desc
Key flex field description for vehicle item.
vehicle_organization_id
Should be a valid element of org_organization_definitions.organization_id and be
assigned to the specific item in mtl_system_items.organization_id.
vehicle_organization_code
Should be a valid element of org_organization_definitions.organization_code for that
specific organization_id.
ship_method_code
Should be a valid element of fnd_lookup_values_vl.lookup_code for lookup_type
SHIP_METHOD.
ship_method_name
Should be a valid element of fnd_lookup_values_vl.meaning for lookup_type
SHIP_METHOD.
seal_code
Indicates the Departure seal code of the trip stops.
Error Handling
Refer to parameters p_init_msg_list, x_msg_count, and x_msg_data on retrieving error
messages.
Trip_Action API Features

The Trip_Action API has the following features:
The Trip_Action procedure enables you to carry out actions on a trip. For IN
parameters, it accepts the trip identifiers, an action code, and any additional parameters
needed for specific actions, and returns a completion status.
Functional Overview
This API validates the trip identifiers and performs the following actions specified in
p_action_code by calling the corresponding private procedures.
• PLAN/UNPLAN: Called to plan or unplan trips.
• WT-VOL: Called to calculate weight and volume for the trip.
• PICK-RELEASE: Called to launch pick release to release lines related to the trip.
• PRINT-DOC-SETS: Called to print document sets.
• DELETE: Called to delete trips.

WSH_TRIPS_PUB.TRIP_ACTION
The following table describes all parameters used by the public procedure
WSH_TRIPS_PUB.TRIP_ACTION. All of the inbound and outbound parameters are
listed. Additional information about these parameters follows the table.

WSH_TRIPS_PUB.TRIP_ACTION Parameters
p_api_version_numb IN Number Y
er
p_init_msg_list IN Varchar2 N
x_return_status OUT Varchar2 N
x_msg_count OUT Number N
x_msg_data OUT Varchar2 N
p_action_code IN Varchar2 Y
p_trip_id IN OUT Record N
p_trip_name IN Varchar2 N
p_wv_override_flag IN Varchar2 N
Compares the version number of the incoming API call to the current version number.
An error is returned if the version numbers are incompatible.
p_init_msg_list
MSG_PUB.GET. Values are:
• p_encoded => F
x_return_status
Values include:
x_msg_count
x_msg_data
Returns error message text. If the x_msg_count is equal to 1, then this text contains the
actual message.
p_action_code
Specifies which of the actions (PLAN, UNPLAN, WT-VOL, PICK RELEASE, or
DELETE) the API should perform.
p_trip_id
ID of the trip on which actions are being performed.
p_trip_name
Name of the trip on which actions are being performed.
p_wv_override_flag
Additional parameter for WT-VOL. Regardless of whether this is set to Y or N, the
system recalculates weight and volume for all deliveries on the trip. The default value is
N.
Error Handling
messages.
Trip_Action (overloaded version) API features

The WSH_TRIPS_PUB.TRIP_ACTION API consists of the following entities:
The Trip_Action procedure enables you to carry out actions on a trip. This overloaded
API accepts a record of parameters for various actions. The Valid action codes are
PLAN , UNPLAN, WT-VOL, PICK-RELEASE , TRIP-CONFIRM, PRINT-DOC-SETS,
GENERATE-ROUTING-RESPONSE, FIRM, IGNORE_PLAN, INCLUDE_PLAN,
GENERATE-PACK-SLIP, PRINT-PACK-SLIP, GENERATE-BOL, PRINT-BOL,
PRINT-MBOL, REMOVE-CONSOL, UNASSIGN-ALL, CREATE, UPDATE, and
DELETE.

Functional Overview
This API validates the trip identifiers and performs the following actions specified in
p_action_param_rec by calling the corresponding private procedures.
• PLAN/UNPLAN: Is called to plan or unplan trips.
• WT-VOL: Is called to calculate weight and volume for the trip.
• PICK-RELEASE: Is called to launch pick release to release lines related to the trip.
• TRIP-CONFIRM : Is called to Confirm the Trip
• PRINT-DOC-SETS: Is called to print document sets.
• GENERATE-PACK-SLIP :Is called to generate the Packing Slip Number.
• PRINT-PACK-SLIP : Is called to generate the Packing Slip Report.
• GENERATE-BOL : Is called to generate the Bill of Lading Number.
• PRINT-BOL : Is called to print the Bill of Lading report.
• PRINT-MBOL : : Is called to print the Master Bill of Lading report.
• CREATE : Is called to create trips.
• UPDATE : Is called to update trips.
• DELETE: Is called to delete trips.
Procedure Parameters Descriptions

The following table lists all parameters used by the public
WSH_TRIPS_PUB.TRIP_ACTION. All of the inbound and outbound parameters are
listed. Additional information on these parameters follows the table.
Parameter Name Usage Type Required Derived
p_api_version_nu IN NUMBER x No
mber
p_init_msg_list IN VARCHAR2 - No
x_return_status OUT VARCHAR2 - No
x_msg_count OUT NUMBER - No
x_msg_data OUT NUMBER - No
p_action_param_r IN WSH_TRIPS_PUB. x No
ec Action_Param_Re
ctype
p_trip_id IN NUMBER - No
No
p_trip_name IN VARCHAR2 -
p_init_msg_list
• p_encoded => F
x_return_status
Valid values include:

x_msg_count
x_msg_data
actual message.
p_action_param_rec Specifies which of the actions of PLAN , UNPLAN, WT-VOL,
PICK-RELEASE, TRIP-CONFIRM, PRINT-DOC-SETS,
GENERATE-ROUTING-RESPONSE, FIRM, IGNORE_PLAN, INCLUDE_PLAN,
GENERATE-PACK-SLIP, PRINT-PACK-SLIP, GENERATE-BOL, PRINT-BOL,
PRINT-MBOL, REMOVE-CONSOL, UNASSIGN-ALL, CREATE, UPDATE and
DELETE the API should perform.
p_trip_id
Trip ID of trip on which actions are being performed.
p_trip_name
Name of trip on which actions are being performed.

ACTION_PARAM_RECTYPE RECORD DEFINITION
To encapsulate WSH_TRIP table definition and Value column equivalents for ID
columns in a PL/SQL record, define ACTION_PARAM_RECTYPE to pass trip
information to the trip_action routine.
Parameter p_action_param_rec of type Action_Param_Rectype.
Parameter Name Type Required Derived
action_code VARCHAR2 x No
Organization_id NUMBER x No
report_set_name VARCHAR2 - No
report_set_id NUMBER - No
Override_flag VARCHAR2 - No
actual_date DATE - No
Parameter Name Type Required Derived
action_flag VARCHAR2 - No
-
Autointransit_flag VARCHAR2 No
autoclose_flag VARCHAR2 - No
stage_del_flag VARCHAR2 - No
ship_method VARCHAR2 - No
bill_of_lading_flag VARCHAR2 - No
defer_interface_flag VARCHAR2 - No
actual_departure_date Date - No
action_code
Specifies which of the actions of PLAN , UNPLAN, WT-VOL, PICK-RELEASE ,
TRIP-CONFIRM, PRINT-DOC-SETS, GENERATE-ROUTING-RESPONSE, FIRM,
IGNORE_PLAN, INCLUDE_PLAN, GENERATE-PACK-SLIP, PRINT-PACK-SLIP,
GENERATE-BOL, PRINT-BOL, PRINT-MBOL, ,REMOVE-CONSOL, UNASSIGN-ALL,
CREATE, UPDATE and DELETE the API should perform.
organization_id
Should be a valid element of org_organization_definitions.organization_id.
report_set_name
Should be a valid element of wsh_report_sets.report_set_name.
report_set_id
Should be a valid element of wsh_report_sets.report_set_id.
override_flag
Should be a valid value 'Y' or 'N'.
actual_date
Actual date of arrival/departure of trip stop. Should be a valid date.

action_flag
Should be a valid value 'S', 'B', 'L', 'T', 'A', 'C' or 'O'.
'S' => Ship Entered, Ship Unspecified Full
'B' => Ship Entered, Backorder Unspecified
'L' => cycle count unspecified quantities
'T' => stage unspecified quantities
'A' => Ship all
'O' => Cycle count all
'C' => Backorder all.
autointransit_flag
autoclose_flag
stage_del_flag
ship_method
SHIP_METHOD.
bill_of_lading_flag
defer_interface_flag
Ship Confirm flag to submit/defer concurrent requests to INV and OE interfaces.
Default Value: Y.
Standard Validation
Oracle Shipping Execution validates all required columns in the
WSH_TRIPS_PUB.TRIP_ACTION API. For specific information on the data referenced
by these columns, see Oracle Electronic Technical Reference Manual (eTRM).
Error Handling
If any validation fails, the API will return the error status to the calling module. The
WSH_TRIPS_PUB.TRIP_ACTION API processes the rows and reports the following
values for every record:
Condition Message Return Description
Success S Process succeeded.
Failure E Expected error.
Failure U Unexpected error.
Stop Public Application Program Interface

The Stop public API consists of the following procedures in package
WSH_TRIP_STOPS_PUB:
Create_Update_Stop: Enables you to create a new stop record and update an existing
stop record.
Stop_Action: Enables you to perform certain actions on a stop.
This section describes how to use the Stop Public API and how it functions in Oracle
Shipping Execution.
Create_Update_Stop API Features

The Create_Update_Stop API has the following features.
The Create_Update_Stop procedure enables you to create a new stop record or update
an existing stop record in the WSH_TRIP_STOPS table. The STOP_ID and return status
of a new stop are passed as OUT parameters, while the TRIP_ID of an existing stop for
update is passed as an IN parameter.
Functional Overview
This API creates a new stop record in WSH_TRIP_STOPS as specified by the IN
parameter p_action_code value CREATE. It inserts stop information into
WSH_TRIP_STOPS and returns the STOP_ID of the new stop. It also updates an
existing stop record in WSH_TRIP_STOPS as specified by IN parameter p_action_code
value UPDATE. The updated stop record is identified by the Stop Id or Trip Id and
Name, Stop Location Id and Code and Planned Departure Date. Additional IN
parameters are provided to update Trip Id and Name, Stop Location Id and Code and
Planned Departure Date values.
The API validates information such as Trip Name, Location Code, and units of measure
before creating or updating a stop record. It also checks that the insert or update
statements were successful and, if not successful, it returns an error.

WSH_TRIP_STOPS_PUB.CREATE_UPDATE_STOP
The following table describes all parameters used by the public procedure
WSH_TRIP_STOPS_PUB.CREATE_UPDATE_STOP. All of the inbound and outbound
parameters are listed. Additional information about these parameters follows.
WSH_TRIP_STOPS_PUB.CREATE_UPDATE_STOP Parameters
er
p_action_code IN Varchar2 Y
p_stop_info IN OUT Record Y
p_trip_id IN Number N
p_trip_name IN Varchar2 N
p_stop_location_id IN Number N
p_location_code IN Varchar2 N
p_planned_dep_date IN Varchar2 N
x_stop_id OUT Number N
Compares the version number of the incoming API call to the current version number.
An error is returned if the version numbers are incompatible.
p_init_msg_list
• p_encoded => F
x_return_status
Values include:
x_msg_count
Indicates the number of error messages API has encountered.
x_msg_data
Displays an error message text. If the x_msg_count is equal to 1, then x_msg_data
contains the actual message.
p_action_code
Specifies whether the API should create a new stop or update existing stop information
depending on its CREATE and UPDATE values.
p_stop_info
Attributes of the stop entity of type Trip_Stop_Pub_Rec_Type. These attributes are
inserted/updated in WSH_TRIP_STOPS. Definition of Trip_Stop_Pub_Rec_Type
follows.
p_trip_id
IN parameter to specify trip ID of trip stop record being updated.
p_trip_name

IN parameter to specify trip name of trip stop record that needs to be updated.
p_stop_location_id
IN parameter to specify stop location ID of trip stop record being updated.
p_location_code
IN parameter to specify stop location code of stop record that needs to be updated.
p_planned_dep_date
IN parameter to specify the planned date of departure.
x_stop_id
OUT parameter to specify the new stop ID of the new stop record being created.

TRIP_STOP_PUB_REC_TYPE RECORD DEFINITION
To encapsulate WSH_TRIP_STOPS table definition and Value column equivalents for
ID columns in a PL/SQL record, define TRIP_STOP_PUB_REC_TYPE to pass trip
information to the Create_Update_Stop routine.
stop_id Number fnd_api.g_miss_num
trip_name Varchar2(30) fnd_api.g_miss_char
stop_location_id Number fnd_api.g_miss_num
stop_location_code Varchar2(20) fnd_api.g_miss_char
planned_arrival_date Date fnd_api.g_miss_date
planned_departure_date Date fnd_api.g_miss_date
actual_arrival_date Date fnd_api.g_miss_date
actual_departure_date Date fnd_api.g_miss_date
departure_gross_weight Number fnd_api.g_miss_num
departure_net_weight Number fnd_api.g_miss_num
weight_uom_code Varchar2(3) fnd_api.g_miss_char
weight_uom_desc Varchar2(25) fnd_api.g_miss_char
departure_volume Number fnd_api.g_miss_num
volume_uom_code Varchar2(3) fnd_api.g_miss_char
volume_uom_desc Varchar2(25) fnd_api.g_miss_char
departure_seal_code Varchar2(30) fnd_api.g_miss_char
departure_fill_percent Number fnd_api.g_miss_char
tp_attribute_category Varchar2(150) fnd_api.g_miss_char
tp_attribute1 Varchar2(150) fnd_api.g_miss_char

creation_date Date fnd_api.g_miss_date

stop_id
Should be a valid unique element of wsh_trip_stops.stop_id.
trip_id
trip_name
stop_location_id
Should be a valid element of hr_locations.location_id
stop_location_code
Should be a valid element of hr_locations.location_code.
weight_uom_code

Should be a valid element of mtl_units_of_measure.uom_code for a weight uom class.
weight_uom_desc
Should be a valid element of mtl_units_of_measure.unit_of_measure for a weight uom
class.
volume_uom_code
Should be a valid element of mtl_units_of_measure.uom_code for a volume uom class.
volume_uom_desc
Should be a valid element of mtl_units_of_measure.unit_of_measure for a volume uom
class.
Error Handling
messages.
Stop_Action API Features

The Stop_Action API has the following features:
The Trip_Action procedure enables you to carry out actions on a stop. It accepts as IN
parameters the trip identifiers, an action code and any additional parameters needed for
specific actions, and it returns a completion status.
Functional Overview
This API validates the stop identifiers and performs the following actions specified in
p_action_code by calling the corresponding private procedures.
• PLAN/UNPLAN: Called to plan or unplan stops.
• ARRIVE/CLOSE: Called to update departure or arrival dates and to close a stop.

This action needs an additional parameter P_ACTUAL_DATE for actual departure
or arrival updates.
• PICK-RELEASE: Launches pick release to release lines related to a stop.
• DELETE: Called to delete stops.

WSH_TRIP_STOP_PUB.STOP_ACTION
WSH_TRIP_STOP_PUB.STOP_ACTION. All of the inbound and outbound parameters
are listed. Additional information on these parameters follows.
WSH_TRIP_STOP_PUB.STOP_ACTION Parameters
er
p_stop_id in Number -
p_trip_id IN Number -
p_trip_name IN Varchar2 -
p_stop_location_id IN Varchar2 -
p_stop_location_code IN Varchar2 -
p_planned_dep_date IN Date -
p_actual_date IN Date -
p_defer_interface_fla IN Varchar2 -
g
p_init_msg_list

• p_encoded => F
x_return_status
x_msg_count
x_msg_data
actual message.
p_action_code
Specifies which of the actions of PLAN, UNPLAN, ARRIVE, CLOSE, PICK RELEASE,
p_stop_id
Stop ID of trip stop on which actions need to be performed.
p_stop_id
Stop ID of trip stop on which actions need to be performed.
p_trip_id
Trip ID of trip stop on which actions need to be performed.
p_trip_name
Trip name of trip stop on which actions need to be performed.
p_stop_location_id
Stop location ID of trip stop on which actions need to be performed.
p_stop_location_code
Stop location code of trip stop on which actions need to be performed.
p_planned_dep_date
Planned departure date of trip stop on which actions need to be performed.
p_actual_date
Actual date of arrival/departure of trip stop.
p_defer_interface_flag
Flag to submit/defer concurrent requests to INV and OE interfaces.
Deliveries Public Application Program Interface

The Deliveries Public Application Program Interface (API) is a public API that consists
of the following procedures in WSH_DELIVERIES_PUB:
• Create_Update_Delivery: Enables you to create a new trip stop record and update
an existing trip stop record.
• Delivery_Action: Enables you to perform certain actions on a trip stop.
• Generate_Documents: Generates the document set for a delivery.
This section describes how to use the Deliveries Public API and how it functions in
Oracle Shipping Execution.
Create_Update_Delivery API Features

The Create_Update_Delivery API has the following features.
The Create_Update_Delivery procedure enables you to create a new delivery record or
update an existing delivery record in WSH_NEW_DELIVERIES table. The
DELIVERY_ID, NAME and return status of a new delivery are passed as OUT
parameters, while the DELIVERY_ID or NAME of an existing delivery for update is
passed as an IN parameter.
Functional Overview
This API creates a new delivery record in WSH_NEW_DELIVERIES as specified by IN
parameter p_action_code value CREATE. Inserts delivery information into
WSH_NEW_DELIVERIES and returns the DELIVERY_ID of the new delivery. It also
updates an existing delivery record in WSH_NEW_DELIVERIES as specified by IN
parameter p_action_code value UPDATE. Delivery record being updated is identified
by Delivery Name. An additional IN parameter is provided to identify delivery by
Name for update.
The API validates delivery information such as Name, Customer Number, and Ship

Method before performing the actions CREATE or UPDATE. It also checks that the
insert or update statements were successful, and if not, returns an error.

WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY
WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY. All of the inbound and
outbound parameters are listed. Additional information on these parameters follows.
WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY Parameters
er
p_delivery_info IN OUT Record x
p_delivery_name IN Varchar2 -
x_delivery_id OUT Number -
x_name OUT Varchar2 -
p_init_msg_list
• p_encoded => F
x_return_status
x_msg_count
x_msg_data
Displays error message text. If the x_msg_count is equal to 1, then this contains the
actual message.
p_action_code
Specifies whether API should create a new delivery or update existing delivery
information depending on its values CREATE and UPDATE.
p_delivery_info
Attributes of the delivery entity of type Delivery_Pub_Rec_Type. These attributes are
inserted/updated in WSH_NEW_DELIVERIES. Definition of Delivery_Pub_Rec_Type
follows.
p_delivery_name
IN parameter to specify name of delivery record being updated.
x_delivery_id
OUT parameter to specify delivery ID of new delivery record being created.
x_name
OUT parameter to specify name of new delivery record being created.

DELIVERY_PUB_REC_TYPE RECORD DEFINITION
To encapsulate WSH_NEW_DELIVERIES table definition and Value column
equivalents for ID columns in a PL/SQL record, define DELIVERIES_PUB_REC_TYPE
to pass delivery information to the Create_Update_Delivery routine.
DELIVERY_PUB_REC_TYPE RECORD DEFINITION
Attribute Type Default
delivery_id Number fnd_api.g_miss_num
name Varchar2(30) fnd_api.g_miss_char
delivery_type Varchar2(30) fnd_api.g_miss_char
loading_sequence Number fnd_api.g_miss_num
loading_order_flag Varchar2(2) fnd_api.g_miss_char
loading_order_desc Varchar2(20) fnd_api.g_miss_char
initial_pickup_date Date fnd_api.g_miss_date
initial_pickup_location_id Number fnd_api.g_miss_num
initial_pickup_location_code Varchar2(20) fnd_api.g_miss_char
organization_id Number fnd_api.g_miss_num
organization_code Varchar2(3) fnd_api.g_miss_char
ultimate_dropoff_location_id Number fnd_api.g_miss_num
ultimate_dropoff_location_co Varchar2(20) fnd_api.g_miss_char

de
ultimate_dropoff_date Date fnd_api.g_miss_date
customer_id Number fnd_api.g_miss_num
customer_number Varchar2(30) fnd_api.g_miss_char
intmed_ship_to_location_id Number fnd_api.g_miss_num
intmed_ship_to_location_cod Varchar2(20) fnd_api.g_miss_char

e
pooled_ship_to_location_id Number fnd_api.g_miss_num
pooled_ship_to_location_cod Varchar2(20) fnd_api.g_miss_char

e
carrier_code Varchar2(25) fnd_api.g_miss_char
ship_method_code Varchar2(30) fnd_api.g_miss_char
ship_method_name Varchar2(80) fnd_api.g_miss_char
freight_terms_code Varchar2(30) fnd_api.g_miss_char
freight_terms_name Varchar2(80) fnd_api.g_miss_char
fob_code Varchar2(30) fnd_api.g_miss_char
fob_name Varchar2(80) fnd_api.g_miss_char
fob_location_id Number fnd_api.g_miss_num
fob_location_code Varchar2(20) fnd_api.g_miss_char
waybill Varchar2(30) fnd_api.g_miss_char
dock_code Varchar2(30) fnd_api.g_miss_char
acceptance_flag Varchar2(1) fnd_api.g_miss_char
accepted_by Varchar2(150) fnd_api.g_miss_char
accepted_date Date fnd_api.g_miss_date

acknowledged_by Varchar2(150) fnd_api.g_miss_char
confirmed_by Varchar2(150) fnd_api.g_miss_char
confirm_date Date fnd_api.g_miss_date
asn_date_sent Date fnd_api.g_miss_date
asn_status_code Varchar2(15) fnd_api.g_miss_char
asn_seq_number Number fnd_api.g_miss_num
gross_weight Number fnd_api.g_miss_num
net_weight Number fnd_api.g_miss_num
volume Number fnd_api.g_miss_num
additional_shipment_info Varchar2(500) fnd_api.g_miss_char
currency_code Varchar2(15) fnd_api.g_miss_char
currency_name Varchar2(80) fnd_api.g_miss_char
prorate_wt_flag Varchar2(1) fnd_api.g_miss_char
tp_attribute_category Varchar2(150) fnd_api.g_miss_char

global_attribute_category Varchar2(30) fnd_api.g_miss_char
global_attribute1 Varchar2(150) fnd_api.g_miss_char
last_update_login Number fnd_api.g_miss_num

delivery_id

Should be a valid unique element of wsh_new_deliveries.delivery_id.
delivery_name
Should be a valid unique element of wsh_new_deliveries.name.
delivery_type
Should be either STANDARD.
loading_order_flag
LOADING_ORDER.
loading_order_desc
LOADING_ORDER.
initial_pickup_location_id
Should be a valid element of hr_locations.location_id.
initial_pickup_location_code
organization_id
organization_code
Should be a valid element of org_organization_definitions.organization_code.
ultimate_dropoff_location_id
ultimate_dropoff_location_code
customer_id
Should be a valid element of ra_customers.customer_id.
customer_code
Should be a valid element of ra_customers.customer_code.
intmed_ship_to_location_id
intmed_ship_to_location_code
pooled_ship_to_location_id
pooled_ship_to_location_code
ship_method_code
SHIP_METHOD.
ship_method_name
SHIP_METHOD.
freight_terms_code
FREIGHT_TERMS.
freight_terms_name
FREIGHT_TERMS.
fob_code
Should be a valid element of fnd_lookup_values_vl.lookup_code for lookup_type FOB.
fob_terms_name
Should be a valid element of fnd_lookup_values_vl.meaning for lookup_type FOB.
fob_location_id
fob_location_code
weight_uom_code
Should be a valid element of mtl_units_of_measure.uom_code for a weight uom class
weight_uom_desc
class.
volume_uom_code
volume_uom_desc
class.
currency_code
Should be a valid element of fnd_currencies_vl.currency_code.

currency_name
Should be a valid element of fnd_currencies_vl.currency_name.
prorate_wt_flag
Should be Y or N as per proration of weight required or not.
Error Handling
messages.
Delivery_Action API Features

The Delivery_Action API has the following features:
The Delivery_Action procedure enables you to carry out actions on a delivery. It accepts
as IN parameters the delivery identifiers, an action code and any additional parameters
needed for specific actions, and it returns a completion status.
Note: Before you call this public API, initialize your environment
(using fnd_global.apps_initialize) in the script or package that you use
to call it.
Functional Overview
This API validates the delivery identifiers and performs the following actions specified
in p_action_code by calling the corresponding private procedures:
• PLAN/UNPLAN: Is called to plan or unplan deliveries.
• WT-VOL: Is called to calculate weight and volume for the delivery. This action
needs an additional parameter P_WV_OVERRIDE_FLAG. Regardless if this is set to
Y or N, weight and volume re-calculations are done for all deliveries on the trip.
• CONFIRM: Is called to confirm delivery. Requires additional parameters starting

with P_SC
• RE-OPEN, CLOSE: Is called to update status of delivery. This action needs an

additional parameter P_ACTUAL_DATE for actual departure or arrival updates.
• ASSIGN-TRIP: Is called to assign a trip to delivery. It requires additional

parameters starting with P_ASG.
• UNASSIGN-TRIP: Is called to unassign trip from delivery.
• AUTOCREATE-TRIP: Is called to autocreate trip for the delivery.
• PICK-RELEASE: Launches pick release to release lines related to a delivery.
• DELETE: Is called to delete a delivery.

WSH_DELIVERIES_PUB.DELIVERY_ACTION
WSH_DELIVERIES_PUB.DELIVERY_ACTION. All of the inbound and outbound
WSH_DELIVERIES_PUB.DELIVERY_ACTION Parameters
er
p_delivery_id IN Number -
p_asg_trip_id IN Number x
p_asg_trip_name IN Varchar2 -
p_asg_pickup_stop_i IN Number -
d
p_asg_pickup_loc_id IN Number -
p_asg_pickup_loc_co IN Varchar2 -
de

p_asg_pickup_arr_da IN Date -
te
p_asg_pickup_dep_d IN Number -
ate
p_asg_dropoff_stop_i IN Number -
d
p_asg_dropoff_loc_id IN Number -
p_asg_dropoff_loc_co IN Varchar2 -
de
p_asg_dropoff_arr_d IN Date -
ate
p_asg_dropoff_dep_d IN Date -
ate
p_sc_action_flag IN Varchar2 -
p_sc_close_trip_flag IN Varchar2 -
p_sc_create_bol_flag IN Varchar2 -
p_sc_stage_del_flag IN Varchar2 -
p_sc_trip_ship_metho IN Varchar2 -
d
p_sc_actual_dep_date IN Varchar2 -
p_sc_report_set_id IN Number -
p_sc_report_set_nam IN Varchar2 -
e
p_sc_rule_id IN Number -
p_sc_rule_name IN Varchar2 -
p_sc_defer_interface_ IN Varchar2 -
flag
p_wv_override_flag IN Varchar2 -
x_trip_id OUT Varchar2 -
x_trip_name OUT Varchar2 -
p_actual_date IN Date -
p_init_msg_list
• p_encoded => F
x_return_status
x_msg_count

x_msg_data
actual message.
p_action_code
Specifies which of the actions of PLAN, UNPLAN, CONFIRM, RE-OPEN, CLOSE,
ASSIGN-TRIP, UNASSIGN-TRIP, AUTOCREATE-TRIP, WT-VOL, PICK RELEASE,
p_delivery_name
Name of delivery on which actions need to be performed.
p_delivery_id
Delivery ID on which actions need to be performed.
Default Value: NULL.
p_asg_trip_id
Trip identifier for assignment of trip to delivery. Used when assigning and un-assigning
a delivery to a trip.
p_trip_name
Name of trip for assignment to delivery. Used when assigning a trip.
p_asg_pickup_stop_id
Stop ID for pickup assignment. Used when assigning a trip.
p_asg_pickup_loc_id
Stop location for pickup assignment. Used when assigning a trip.
p_asg_pickup_loc_code
Stop location code for pickup assignment. Used when assigning a trip.
p_asg_pickup_arr_date
Stop location arrival date for pickup assignment. Used when assigning a trip.
p_asg_pickup_dep_date
Stop location departure date for pickup assignment. Used when assigning a trip.
p_asg_dropoff_stop_id
Stop ID for dropoff assignment. Used when assigning a trip.
p_asg_dropoff_loc_id
Stop location for dropoff assignment. Used when assigning a trip.
p_asg_dropoff_loc_code
Stop location code for dropoff assignment. Used when assigning a trip.
p_asg_dropoff_arr_date
Stop location arrival date for dropoff assignment. Used when assigning a trip.
p_asg_dropoff_dep_date
Stop location departure date for dropoff assignment. Used when assigning a trip.
p_sc_action_flag
Ship Confirm option - S, B, T, A, C. Used when ship confirming a delivery.
Default Value: S
p_sc_close_trip_flag
Ship Confirm close trip flag. Used when ship confirming a delivery.
Default Value: N
p_sc_create_bol_flag
Ship Confirm create Bill of Lading flag. Used when ship confirming a delivery.
Default Value: N.
p_sc_rule_id
Used when action is CONFIRM.
Default Value: Null.
p_sc_rule_name
Used when action is CONFIRM.
Default Value: Null.

p_sc_stage_del_flag
Ship Confirm create delivery for stage quantity flag. Used when ship confirming a
delivery.
Default Value: Y.
p_sc_trip_ship_method
Ship Confirm trip ship method. Used when ship confirming a delivery.
p_defer_interface_flag
Ship Confirm flag to submit/defer concurrent requests to INV and OE interfaces.
Default Value: Y
p_wv_override_flag
Override flag for weight volume calculations. Regardless if this is set to Y or N, weight
and volume re-calculations are done for all deliveries on the trip
Default Value: N
x_trip_id
ID of autocreated trip.
x_trip_name
Name of autocreated trip.
Error Handling
Refer to the parameters p_init_msg_list, x_msg_count, and x_msg_data for information
on retrieving error messages.
Generate_Documents API Features

The Generate_Documents API generates the document set for a delivery. It takes the
report_set_name, organization_code, and a table of delivery_names as the input
parameter and passes the return_status, message_data and message_count as the
output parameters.
Functional Overview
This API is for backward compatibility. A call to this API generates the document set
specified in the IN parameter report_set_name for all the deliveries in the IN parameter
delivery_names.
Setting Up the Generate_Documents API
The following chart describes all parameters used by the public Generate_Documents
API. All of the inbound and outbound parameters are listed. Additional information on
Generate_Documents Parameters
p_report_set_name IN VARCHAR2 -
p_organization_code IN VARCHAR2 -
p_delivery_name IN WSH_UTIL_CORE. -
Column_Tab_Type
x_msg_count OUT NUMBER -
x_msg_data OUT VARCHAR2 -
x_return_status OUT VARCHAR2 -
p_report_set_name
This is the report_Set that needs to be generated for all the deliveries specified in
p_delivery_name parameter.
p_organization_code
This is the organization code for which the document _set needs to be generated.
p_delivery_name
This is the list of delivery_names for which the document set needs to be generated.
x_msg_count
x_msg_data
Contains error message text. If X_msg_count is 1, then this contains the complete
message.
x_return_status

Valid values include the following:
Exceptions Application Program Interface

Exceptions Application Program Interface (API) is a public API that consists of the
following procedure in the package WSH_EXCEPTIONS_PUB.
Exception_Action: Enables you to carry out actions on an exception. It accepts as IN
parameters the exception identifiers, an action code and returns a completion status.
Get_Exceptions: Enables you to access detailed information about an exception and
stores it in an exception table.
Exception_Action API Features

The Exception_Action procedure enables you to carry out actions on an exception. It
accepts as IN parameters the exceptions identifiers in a table and an action, and it
returns a completion status.
Note: Before you call this public API, initialize your environment
(using fnd_global.apps_initialize) in the script or package that you use
to call it.
Functional Overview
This API validates its input parameters p_action and performs the following actions
depending on its value:
• PURGE: Used to purge existing exceptions
• LOG: Used to log an exception based on the values in the input exceptions record
(p_exception_rec)
• CHANGE_STATUS: Used to change the status of an exception
Setting Up the Exception_Actions API
The following chart describes all parameters used by the public Exception_Actions API.
Exception_Actions Parameters
p_api_versio IN NUMBER x - -
n_number
p_init_msg_li IN VARCHAR2 - - x
st
p_commit IN VARCHAR2 - - x
p_action IN VARCHAR2 x - -
p_validation_ IN NUMBER - - x
level
p_exceptions IN OUT XC_ACTION x - -

_rec _REC_TYPE
x_msg_count OUT NUMBER - x -
x_msg_data OUT VARCHAR2 - x -
x_return_stat OUT VARCHAR2 - x -

us
Used to compare the version number of the incoming API call to the current version
number. An error is returned if the version numbers are incompatible.
p_init_msg_list
greater than 1, then the list of messages must be retrieved using the call FND_MSG_
PUB.GET. The values are:

• p_encoded => F
where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and
• Default Value: FND_API.G_FALSE
p_commit
Requests that the API update information for you after it completes its function. Default
Value: FND_API.G_FALSE
x_return_status
x_msg_count
x_msg_data
actual message.
p_validation_level
This parameter is not currently used.
p_action
This parameter specifies the actions that needs to be performed on the exception. Valid
values for this parameter are 'LOG', 'PURGE' and 'CHANGE_STATUS'.
p_exception_rec
This record structure has all the exception specific entries.
The table below describes all parameters that are used by the XC_ACTION_REC_TYPE
TYPE record. Additional information on these parameters follows.
XC_ACTION_REC_TYPE
XC_ACTION_REC_TYPE Parameters
Parameter Type Default Value
request_id NUMBER
batch_id NUMBER
exception_id NUMBER
exception_name VARCHAR2
logging_entity VARCHAR2
logging_entity_id NUMBER
manually_logged VARCHAR2
message VARCHAR2
logged_at_location_code VARCHAR2
exception_location_code VARCHAR2
severity VARCHAR2
delivery_name VARCHAR2
trip_name VARCHAR2
stop_location_id NUMBER
delivery_detail_id NUMBER
container_name VARCHAR2
ord_id NUMBER
inventory_item_id NUMBER
lot_number VARCHAR2

sublot_number VARCHAR2
revision VARCHAR2
serial_number VARCHAR2
unit_of_measure VARCHAR2
quantity NUMBER
unit_of_measure2 VARCHAR2
quantity2 NUMBER
subinventory VARCHAR2
locator_id NUMBER
error_message VARCHAR2
attribute_category VARCHAR2
attribute1 VARCHAR2
attribute2 VARCHAR2
attribute3 VARCHAR2
attribute4 VARCHAR2
attribute5 VARCHAR2
attribute6 VARCHAR2
attribute7 VARCHAR2
attribute8 VARCHAR2
attribute9 VARCHAR2
attribute10 VARCHAR2
departure_date DATE
arrival_date DATE
exception_type VARCHAR2
status VARCHAR2
departure_date_to DATE
arrival_date_to DATE
creation_date DATE
creation_date_to DATE
data_older_no_of_days NUMBER
new_status VARCHAR2
caller VARCHAR2
phase NUMBER
The purge action uses the following fields:

• exception_type: Specifies which type of exception needs to be purged.
• status: Specifies the status of exceptions that should be selected to be purged

• departure_date_to: Specifies that exceptions with departure_dates before this date
should be purged
• arrival_date_to: Specifies that exceptions with arrival_dates before this date should
be purged
• creation_date: Specifies that exceptions with creation_date same as this date should
be purged
• creation_date_to: Specifies that exceptions with creation_dates before this date

should be purged
• data_older_no_of_days: Specifies the maximum age of exceptions that should be

purged
• departure_date: Specifies the departure_date of exceptions that should be purged
• arrival_date: Specifies the arrival date of exceptions that should be purged
• logged_at_location_code: Specifies the location_code where the exceptions have

been logged that should be purged
• exception_location_code: Specifies the location_code of the exceptions that should

be purged
• severity: Specifies the severity of the exceptions that should be purged
• delivery_name: Specifies the delivery name of the exception that should be purged
• exception_name: Specifies the name of the exception that should be purged
• logging_entity: Specifies the entity whose exceptions need to be purged
• request_id: Specifies the request_id whose exceptions needs to be purged
The following fields are used for the change_status action:

• exception_name: Specifies the exception_name whose status needs to be changed
• logging_entity: Specifies the logging entity whose exceptions need to change status
• logging_entity_id: Specifies the logging entity id whose exceptions need to change

status
• new_status: Specifies the new status of the exceptions that satisfy the previous
fields
Logging exceptions use the following fields. The value of these fields is directly
assigned to the corresponding columns in the WSH_EXCEPTION table when the new
exception record is created.
• request_id
• batch_id
• exception_id
• exception_name
• logging_entity
• logging_entity_id
• manually_logged
• message
• logged_at_location_code
• exception_location_code
• severity
• delivery_name
• trip_name
• stop_location_id
• delivery_detail_id
• container_name
• org_id
• inventory_item_id
• lot_number
• sublot_number
• revision
• serial_number
• unit_of_measure
• quantity

• unit_of_measure2
• quantity2
• subinventory
• locator_id
• error_message
• attribute_category
• attribute1
• attribute2
• attribute3
• attribute4
• attribute5
• attribute6
• attribute7
• attribute8
• attribute9
• attribute10
• attribute11
• attribute12
• attribute13
• attribute14
• attribute15
• departure_date
• arrival_date
Get_Exceptions API Features
The Get_Exceptions API fetches the exceptions based on the entity_name and the
entity_id passed to it. The fetched details are stored in the table x_exceptions_tab which
is the output parameter of the API.
Functional Overview
The Get_Exceptions API takes in p_logging_entity_id and p_logging_entity_name as IN
parameters and passes out the exceptions that have been logged for this entity. The
valid values of p_logging_entity_name are 'DELIVERY', 'TRIP' , 'STOP' ,'CONTAINER'
and 'DETAIL'. Thus, if p_logging_entity is 'DELIVERY', then p_logging_entity_id
should be a valid delivery_id.
Setting Up the Get_Exceptions API
The following table describes all parameters used by the Get_Exceptions publicAPI. All
of the inbound and outbound parameters are listed. Additional information about these
parameters follows the table.
Get_Exceptions Parameters
p_api_versio IN NUMBER x - -
n_number
p_init_msg_li IN VARCHAR2 - - x
st
x_return_stat OUT VARCHAR2 - - x

us
x_msg_count OUT NUMBER - - x
x_msg_data OUT VARCHAR2 - x -
p_logging_en IN NUMBER x - -
tity_id

p_logging_en IN VARCHAR2 x - -
tity
x_excptions_t OUT XC_TAB_TY x - -

ab PE
Used to compare the version number of the incoming API call with the current version
p_init_msg_list
greater than 1, then the list of messages must be retrieved using the call FND_MSG_
PUB.GET. The values are:
• p_encoded => F
where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and
x_return_status
x_msg_count
x_msg_data
actual message.
p_logging_entity_name
Specifies the entity for which we are querying the exception. Valid values are
'DELIVERY', 'TRIP', 'STOP','CONTAINER' and 'DETAIL'.
P_logging_entity_id
The entity Id for which the exceptions details are being fetched.
x_exceptions_tab
The OUT parameter where the details of the exception are stored.
The x_exceptions_tab fields are as follows:
x_exceptions_tab Fields
exception_id NUMBER -
exception_name VARCHAR2 -
status VARCHAR2 -
Delivery Details Public Application Program Interface

The Delivery Details public API consists of the following procedures in package
WSH_DELIVERY_DETAILS_PUB:
Detail_To_Delivery: Enables you to assign or cancel the assignment of a delivery detail
to or from a delivery
Split_Line: Splits a delivery detail into 2 delivery details with the requested quantity
summed up to the original delivery detail.
Update_Shipping_Attributes: Updates a delivery detail with new information with the
Autocreate_Deliveries and Autocreate_Del_Trip procedures.
Autocreate_Deliveries:Automatically creates deliveries for multiple delivery lines.
Autocreate_Del_Trip:Automatically creates trips and deliveries for multiple delivery
lines.
Get_Detail_Status: Provides one of the following statuses for a delivery detail passed:
SIC (ship confirmed), PK (packed), or OK (other).
Note: The creation of a delivery detail is not provided in the open API
since it should be part of the order entry process.

This section describes how to use the Delivery Details Public API and how it functions
in Oracle Shipping Execution.
Detail_To_Delivery API Features

The Detail_To_Delivery procedure performs 2 actions: assign delivery details to a
delivery and cancel the assignment of delivery details from a delivery.
Functional Overview
This procedure assigns delivery details to a delivery as specified by IN parameter
p_action value ASSIGN. If the action is ASSIGN, either the Delivery ID or the Delivery
Name need to be specified. It also cancels delivery details from a delivery based on the
IN parameter p_action value UNASSIGN. If the action is UNASSIGN, then you do not
need to pass a Delivery ID or a Delivery Name because the procedure will cancel all of
the delivery details from the deliveries.
For ASSIGN, the procedure checks the delivery detail status, delivery status, group by
attributes defined in Shipping Parameters, Ship To Locations and Ship From Locations.
If one of the delivery details is assigned to a delivery, then the procedure continues to
the next delivery detail, performs the ASSIGN action to the delivery details, which are
not already assigned, and returns an error in the return status. The calling procedure
decides whether to commit or rollback. ASSIGN is allowed only for the deliveries in the
status of OPEN or PACKED and not Planned. Security rules check to ensure that ship-to
and ship-from location information and other optional group by attributes are common
between the delivery details and the delivery.
If one of the delivery details is unassigned, then the UNASSIGN return status posts a
warning, and the action continues to the next delivery detail. To allow UNASSIGN
action, the delivery status must be OPEN and not planned. If there is freight cost for the
delivery detail, then a warning is posted in the return status.

WSH_DELIVERY_DETAILS_PUB.DETAIL_TO_DELIVERY
WSH_DELIVERY_DETAILS_PUB.DETAIL_TO_DELIVERY. All of the inbound and
WSH_DELIVERY_DETAILS_PUB.DETAIL_TO_DELIVERY Parameters
er
p_TabOfDelDets IN Table Y
p_action IN Varchar2 Y
p_delivery_id OUT Number N
p_delivery_name OUT Varchar2 N
Compares the version number of the incoming API call with the current version
p_init_msg_list
• p_encoded => F
x_return_status
Values include:

x_msg_count
Indicates the number of error messages that the API has encountered.
x_msg_data
Returns an error message text. If the x_msg_count is equal to 1, then this contains the
actual message.
p_TabOfDelDets
Table of Delivery Detail ID's of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table
of type Number indexed by binary integers.
p_action
Valid values for the Action are ASSIGN and UNASSIGN.
If the action is ASSIGN, the user needs to pass either the Delivery ID or the Delivery
Name to identity which Delivery the Delivery Details are assigned to. If both the
Delivery ID and Delivery Name are passed in, only the Delivery ID will be used to
identify the Delivery, the Delivery Name will be ignored.
p_delivery_id
The Delivery ID to identify the Delivery, not needed if the action is UNASSIGN.
p_delivery_name
The Delivery Name to identify the Delivery, not needed if the action is UNASSIGN
Error Handling
messages.
Split_Line API Features

The Split_Line API has the following features:
The Split_Line procedure enables you to split a Delivery Detail into two Delivery
Details. A Delivery Detail needs to be split when ship partially, or when a backorder
occurs.
Functional Overview
This API splits a Delivery Detail into two Delivery Details. Most of the fields in the new
Delivery Detail have the same values except that the requested quantity is the split
quantity, the shipped quantity is NULL, the backorder quantity is NULL and that the
split_from_detail_id points to the original Delivery Detail. After the split, the calling
procedure needs to make another call to update the shipped quantity and backordered
quantity to complete the whole transaction.
This procedure checks that the Delivery Detail is valid, the split quantity is not greater
than the requested quantity before calling
WSH_DELIVERY_DETAILS_ACTIONS.Split_Delivery_Details. Most of the validation
is performed in WSH_DELIVERY_DETAILS_ACTIONS.Split_Delivery_Details, which
checks that the quantity meets the decimal quantity standard.

WSH_DELIVERY_DETAILS_PUB.SPLIT_LINE
WSH_DELIVERY_DETAILS_PUB.SPLIT_LINE. All of the inbound and outbound
WSH_DELIVERY_DETAILS_PUB.SPLIT_LINE Parameters
er
p_commit IN Varchar2 -
p_validation_level IN Number -
p_from_detail_id IN Varchar2 x
x_new_detail_id OUT Number -
x_split_quantity IN OUT Number -
p_init_msg_list

Requests that the API initialize the message list. If the x_msg_count is greater than 1,
then the list of messages must be retrieved using the call FND_ MSG_PUB.GET. The
values are:
• p_encoded => F
Default Value: FND_API.G_FALSE.
p_commit
Commits the transaction if this parameter is set to TRUE.
x_return_status
x_msg_count
x_msg_data
actual message.
p_from_detail_id
The Delivery Detail ID of the line to be split.
x_new_detail_id
Delivery Detail ID of the new line being created after splitting the original line.
x_split_quantity
Quantity out of the original Delivery Detail quantity allocated to the new Delivery
Detail created after the split.
Error Handling
messages.
Update_Shipping_Attributes API Features

The Update_Shipping API has the following features:
The Update_Shipping_Attributes procedure enables you to modify data in
wsh_delivery_details.
Functional Overview
This procedure is called from the source system to modify data in wsh_delivery_details
to reflect any changes made by the source system including pick release, ship confirm,
split source line, and other update activities.
The procedure validates the input parameters and updates the delivery details.

WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES
WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES. All of the
parameters follows.
WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES Parameters
er
p_commit IN Varchar2 N

p_changed_attributes IN Record Y
p_source_code IN Varchar2 Y
p_serial_range_tab IN wsh_delivery_details N
_grp.serialrangetype
p_init_msg_list
• p_encoded => F
p_commit
x_return_status
x_msg_count
x_msg_data
actual message.
p_changed_attributes
Attributes of ChangedAttributesTabType that are updated in wsh_delivery_details.
WSH_DELIVERY_DETAILS_PUB.ChangedAttributesTabType is a table of
ChangedAttributeRecType indexed by Binary_Integer. Definition of
ChangedAttributeRecType follows.
p_source_code
Code for source system which updates wsh_delivery_details table. Source system can
only update delivery details that are created by the same source system. For
Update_Shipping_Attributes this should be OE.
p_serial_range_tab
This is of type wsh_glbl_var_strct_grp.ddSerialRangeTabType.
Where, wsh_glbl_var_strct_grp.ddSerialRangeTabType is of type
TYPE ddSerialRangeTabType IS TABLE OF ddSerialRangeRecType
p_serial_range_tab
delivery_detail_id NUMBER NULL
from_serial_number VARCHAR2 NULL
to_serial_number VARCHAR2 NULL
quantity NUMBER NULL
delivery_detail_id
The delivery detail id for which the serial numbers are entered.
from_serial_number
The starting serial number.
to_serial_number
The ending serial number.

quantity
The serial quantity, between the from_serial_number and the to_serial_number.

ChangedAttributeRecType RECORD DEFINITION
To encapsulate WSH_DELIVERY_DETAILS table definition and Value column
equivalents for ID columns in a PL/SQL record, define ChangedAttributeRecType.
ChangedAttributesRecType RECORD DEFINITION
source_header_id Number fnd_api.g_miss_num
source_line_id Number fnd_api.g_miss_num
sold_to_org_id Number fnd_api.g_miss_num
customer_number Number fnd_api.g_miss_char
sold_to_contact_id Number fnd_api.g_miss_num
ship_from_org_id Number fnd_api.g_miss_char
ship_from_org_code Varchar2(3) fnd_api.g_miss_char
ship_to_org_id Number fnd_api.g_miss_ num
ship_to_org_code Varchar2(3) fnd_api.g_miss_char
ship_to_contact_id Number fnd_api.g_miss_ num
deliver_to_org_id Number fnd_api.g_miss_num
deliver_to_org_code Varchar2(3) fnd_api.g_miss_char
deliver_to_contact_id Number fnd_api.g_miss_ num
intmed_ship_to_org_id Number fnd_api.g_miss_num
intmed_ship_to_org_code Varchar2(3) fnd_api.g_miss_char
intmed_ship_to_contact_id Number fnd_api.g_miss_ num
ship_tolerance_above Number fnd_api.g_miss_ num
ship_tolerance_below Number fnd_api.g_miss_ num
ordered_quantity Number fnd_api.g_miss_ num
ordered_quantity2 Number fnd_api.g_miss_num
order_quantity_uom Varchar2(3) fnd_api.g_miss_char
ordered_quantity_uom2 Varchar2(25) fnd_api.g_miss_char
ordered_qty_unit_of_measure Varchar2(25) fnd_api.g_miss_char

2
subinventory Varchar2(10) fnd_api.g_miss_char
prefered_grade Varchar2(4) fnd_api.g_miss_char
revision Varchar2(3) fnd_api.g_miss_char
lot_number Varchar2(30) fnd_api.g_miss_char
sublot_number Varchar2(30) fnd_api.g_miss_char
customer_requested_lot_flag Varchar2(1) fnd_api.g_miss_char
serial_number Varchar2(30) fnd_api.g_miss_char
locator_id Number fnd_api.g_miss_ num
date_requested Date fnd_api.g_miss_date
date_scheduled Date fnd_api.g_miss_date
master_container_item_id Number fnd_api.g_miss_ num

detail_container_item_id Number fnd_api.g_miss_ num
shipping_method_code Varchar2(30) fnd_api.g_miss_char
freight_carrier_code Varchar2(30) fnd_api.g_miss_char
shipment_priority_code Varchar2(30) fnd_api.g_miss_char
dep_plan_required_flag Varchar2(1) fnd_api.g_miss_char
customer_prod_seq Varchar2(50) fnd_api.g_miss_char
customer_dock_code Varchar2(30) fnd_api.g_miss_char
top_model_line_id Number fnd_api.g_miss_num
ship_set_id Number fnd_api.g_miss_num
ato_line_id Number fnd_api.g_miss_num
arrival_set_id Number fnd_api.g_miss_num
ship_model_complete_flag Varchar2(1) fnd_api.g_miss_char
cust_po_number Varchar2(50) fnd_api.g_miss_char
released_status Varchar2(1) fnd_api.g_miss_char
packing_instructions Varchar2(2000) fnd_api.g_miss_char
shipping_instructions Varchar2(2000) fnd_api.g_miss_char
container_name Varchar2(50) fnd_api.g_miss_char
container_flag Varchar2(1) fnd_api.g_miss_char
delivery_detail_id Number fnd_api.g_miss_num
shipped_quantity Number fnd_api.g_miss_num
shipped_quantity2 Number fnd_api.g_miss_num
cycle_count_quantity Number fnd_api.g_miss_num
cycle_count_quanity2 Number fnd_api.g_miss_num
tracking_number Varchar2(30) fnd.api.g_miss_char

to_serial_number Varchar2(30) fnd_api.g_miss_char

source_header_id
Should indicate the source of the header content, for example OM or OKE.
sold_to_org_id
Should be a valid unique element of ra_customers.customer_id.
customer_number
Should be a valid unique element of ra_customers.customer_number.
sold_to_contact_id
Should indicate the person to contact at the sold to location.
ship_from_org_id
ship_from_org_code
ship_to_org_id
ship_to_org_code
ship_to_contact_id
Should indicate the person to contact at the ship to location.
deliver_to_org_id
deliver_to_org_code
deliver_to_contact_id
Should indicate the person to contact at the delivery to location.
intmed_ship_to_org_id
intmed_ship_to_org_code
intmed_ship_to_contact_id
Should indicate the person to contact at the intermediate ship to location.
ship_tolerance_above
Should be a non-negative number.
ship_tolerance_below
ordered_quantity
Should be a non-negative whole number.
ordered_quantity2
order_quantity_uom
Should be a valid element of mtl_items_uoms_view.uom_code.
ordered_quantity_uom2
preferred_grade

Should indicate the preferred grade for the line item.
ordered_qty_unit_of_measure
Should be a valid element of mtl_items_uoms_view.unit_of_measure.
ordered_qty_unit_of_measure2
subinventory
Should indicate the subinventory from which the line item is picked.
revision
Should indicate the revision number for the line item.
lot_number
Should indicate the lot number for the line item.
customer_requested_lot_flag
Should indicate that the line item requires a customer requested lot number.
serial_number
Should indicate the serial number for the line item.
locator_id
Should indicate the inventory locator from which the line item is picked.
date_requested
Should indicate the date requested for the line item.
date_scheduled
Should indicate the date scheduled for the line item.
master_container_item_id
Should indicate the master container name into which the line is packed.
detail_container_item_id
Should indicate the parent container name into which the line is packed.
shipping_method_code
SHIP_METHOD.
carrier_id
Should indicate the carrier name transporting the line item.
freight_terms_code
FREIGHT_TERMS.
freight_terms_name
FREIGHT_TERMS.
freight_carrier_code
Should indicate the freight carrier code for the carrier transporting the line item.
shipment_priority_code
Should indicate the shipment priority assigned to the line item.
fob_code
fob_name
dep_plan_required_flag
Should be Y or N.
customer_prod_seq
Should indicate the customer production sequence number assigned to the line item.
customer_dock_code
Should indicate the customer dock code for the line item.
gross_weight
net_weight
weight_uom_code
weight_uom_desc
class.
volume
volume_uom_code
volume_uom_desc
class.

top_model_line_id
If the item is included as part of a model, this should indicate the top model line name
for the line item.
ship_set_id
If the item is included as part of a ship set, this should indicate the ship set number to
which the line item is assigned.
ato_line_id
If the item is included as part of a ATO model, this should indicate the model line name
to which the line item is assigned.
arrival_set_id
If the item is included as part of a arrival ship set, this should indicate the arrival set
number to which the line item is assigned.
ship_model_complete_flag
Should be Y or N.
cust_po_number
Should indicate the purchase order number for the line item.
released_status
Should be one of R, S, Y, or X.
packing_instructions
Should indicate the packing instructions included for the line item.
shipping_instructions
Should indicate the shipping instructions included for the line item.
container_name
Should indicate the container name of the container.
container_flag
Should indicate that the line item is a container.
delivery_detail_id
Should indicate the delivery detail id for the line.
tracking_number
Should indicate the tracking number for the line item.
shipped_quantity
shipped_quantity2
cycle_count_quantity
cycle_count_quantity2
Error Handling
messages.
Autocreate_Deliveries API Features

The Autocreate_Deliveries API has the following features:
The Autocreate_Deliveries procedure is called from the source system to automatically
create deliveries for multiple delivery lines.
The procedure checks that the attribute parameters passed in are valid and perform
value to ID conversion while validating.

WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DELIVERIES
WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DELIVERIES. All of the inbound
and outbound parameters are listed. Additional information on these parameters
follows.
WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DELIVERIES Parameters
er

p_line_rows IN Table x
x_del_rows OUT Table -
p_init_msg_list
Requests that the API initializes the message list on your behalf. If the x_msg_count is
• p_encoded => F
p_commit
x_return_status
x_msg_count
x_msg_data
actual message.
p_line_rows
Table of Delivery Details of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table of
type Number indexed by binary integers.
x_del_rows
Table of Deliveries of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table of type
Number indexed by binary integers.
Error Handling
messages.
Autocreate_Del_Trip API Features

The Autocreate_Del_Trip API has the following features:
The Autocreate_Del_Trip procedure is called from the source system to automatically
create trips and deliveries for multiple delivery lines.
The procedure also checks that the attribute parameters passed in are valid and perform

WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP
WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP. All of the inbound and
WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP Parameters
er

x_del_rows OUT Table x
x_trip_id OUT Number x
x_trip_name OUT Varchar2 x
p_init_msg_list
• p_encoded => F
p_commit
x_return_status
x_msg_count
x_msg_data
actual message.
p_line_rows
Table of Delivery Details of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table of
x_del_rows
x_trip_id
ID of autocreated trip.
x_trip_name
Name of autocreated trip.
Error Handling
messages.
Get_Detail_Status API Features

The GET_DETAIL_STATUS API consists of the following feature:
Get_Detail_Status API provides the status of delivery detail.
Functional Overview
Get_Detail_Status procedure provides any one of the following statuses for a delivery
detail passed:
• SIC (Ship Confirmed) - If a delivery detail is assigned to
Confirmed/In-Transit/Closed delivery
• PK (Packed) - If a delivery detail is packed

• OK - Other than above two condtions

WSH_DELIVERY_DETAILS_PUB.Get_Detail_Status
WSH_DELIVERY_DETAILS_PUB.Get_Detail_Status. All of the inbound and outbound
p_delivery_detail_id IN Number x
x_line_status OUT VARCHA -

R2
x_return_status OUT VARCHA -

R2
p_delivery_detail_id
Delivery detail id for which the status is required.
x_line_status
Status of delivery (SIC/PK/OK)
x_return_status
Requests that the API return the status of the data after it completes its function. Valid
values include:
Standard Validation
No Validation done for input parameter passed.
Error Handling
None.
The API returns the following return statuses to the calling module:
Condition Message return Description
Update_Shipping_Attributes (overloaded version) API

The Update_Shipping_Attributes API consists of the following features:
The Update_Shipping_Attributes procedure allows you to modify data in
wsh_delivery_details table for delivery detail(s) passed.
Functional Overview
The Update_Shipping_Attributes (overloaded version) API allows you to update the
delivery detail information in wsh_delivery_details table.

WSH_DELIVERY_DETAILS.Update_Shipping_Attributes
WSH_DELIVERY_DETAILS.Update_Shipping_Attributes. All of the inbound and
p_api_version_nu IN NUMBER x
mber
p_init_msg_list IN VARCHAR2 -
p_commit IN VARCHAR2 -
x_return_status OUT VARCHAR2 -
x_msg_count OUT NUMBER -
x_msg_data OUT VARCHAR2 -

WSH_DELIVERY_ x
p_changed_attribu IN DETAILS_PUB.Ch
tes angedAttributeTa
bType
p_source_code IN VARCHAR2 x
p_container_flag IN VARCHAR2 -
p_serial_range_tab IN WSH_GLBL_VAR -
_STRCT_GRP.ddS
erialRangeTabTyp
e
p_init_msg_list
MSG_PUB.GET. The values are: where 1_message and 1_msg_index_out are local
variables of types Varchar2(2000) and Number respectively. Default Value:
FND_API.G_FALSE
• p_encoded => F
p_commit
x_return_status
values include:
x_msg_count
Indicates the number of error messages the API has encountered.
x_msg_data
actual message.
p_changed_attributes
Attributes of ChangedAttributesTabType that are updated in wsh_delivery_details.
WSH_DELIVERY_DETAILS_PUB.ChangedAttributesTabType is a table of
ChangedAttributesRecType indexed by Binary_Integer. Definition of
ChangedAttributesRecType follows.
p_source_code
Code for source system which updates wsh_delivery_details table. Source system can
only update delivery details that are created by the same source system. For
Update_Shipping_Attributes this should be OE.
p_container_flag
Y or N depending on whether the delivery detail is Container/content line.
ChangedAttributesRecType RECORD DEFINITION. To encapsulate
WSH_DELIVERY_DETAILS table definition and Value column equivalents for ID
columns in a PL/SQL record, define ChangedAttributesRecType.


2

attribute8
Varchar2(150) fnd_api.g_miss_char
attribute10
Varchar2(150) fnd_api.g_miss_char


source_header_id
Should indicate the unique element of oe_order_headers_all.header_id
source_line_id
Should indicate the unique element of oe_order_lines_all.line_id
sold_to_org_id
Should be a valid unique element of hz_cust_accounts.cust_account_id.
customer_number
Should be a valid unique element of hz_cust_accounts.account_number
sold_to_contact_id
Should indicate contact person at the sold to location.
ship_from_org_id
ship_from_org_code
ship_to_org_id
ship_to_org_code
ship_to_contact_id
Should indicate contact person at the ship to location.
deliver_to_org_id Should be a valid element of
org_organization_definitions.organization_id.
deliver_to_org_code
Should indicate contact person at the delivery to location.
Should indicate contact person at the intermediate ship to location.
ordered_quantity
ordered_quantity2
order_quantity_uom
preferred_grade
ordered_qty_unit_of_measure Should be a valid element of
mtl_items_uoms_view.unit_of_measure.
subinventory
Should indicate the subinventory from which the line item is picked. revision Should
indicate the revision number for the line item.
lot_number
serial_number
locator_id

date_requested
date_scheduled
SHIP_METHOD.
carrier_id
Should indicate the name of the carrier transporting the line item.
freight_terms_code
FREIGHT_TERMS.
freight_terms_name
FREIGHT_TERMS.
fob_code
fob_nameShould be a valid element of fnd_lookup_values_vl.meaning for lookup_type
FOB.
Should be Y or N.
customer_prod_seq
customer_dock_code
gross_weight
net_weight
weight_uom_code
Should be a valid element of mtl_units_of_measure.uom_code for a weight uom class.
weight_uom_desc
class.
volume
volume_uom_code
volume_uom_desc
class.
top_model_line_id
If the item is included as part of a model, this should indicate the top model line name
for the line item.
ship_set_id
ato_line_id
arrival_set_id
ship_model_complete_flag Should be Y or N.
cust_po_number
released_status

shipping_instructions
Should indicate the shipping instructions included for the line item.
container_name
Should indicate the container name of the container.
container_flag
Should indicate that the line item is a container.
delivery_detail_id
Should indicate the delivery detail id for the line.
tracking_number
Should indicate the tracking number for the line item.
shipped_quantity
shipped_quantity2
cycle_count_quantity
cycle_count_quantity2
Standard Validation
Update_Shipping_Attributes API. For specific information on the data referenced by
these columns, see Oracle Electronic Technical Reference Manual (eTRM)
API checks whether delivery detail information passed can be updated in
wsh_delivery_details table. If delivery details passed to the API are valid then API
updates the same in wsh_delivery_details table. If any invalid data is passed to the API
appropriate Warning/Error is returned from API.
Error Handling
messages.
If any validation fails, the API returns the error status to the calling module. API return
the following return statuses to the calling module :
Init_Changed_Attribute_Rec API Features

The INIT_CHANGED_ATTRIBUTE_REC API consists of the following feature:
The API is used to initialize the attributes of Changed_Attribute_Rec record type to
FND_API_G_MISS values.
Functional Overview
The API is used to initialize the attributes of Changed_Attribute_Rec record type to
FND_API_G_MISS values. This API is used before calling
WSH_DELIVERY_DETAILS_PUB.update_shipping_attributes. Pass
Changed_Attribute_Rec record type to this API for initializing the values with
FND_API.G_MISS_CHAR/ FND_API.G_MISS_NUM/ FND_API.G_MISS_DATE.

The following table lists all parameters used by the public API
INIT_CHANGED_ATTRIBUTE_REC. All of the inbound and outbound parameters are
listed. Additional information on these parameters follows the table.
p_init_rec IN OUT WSH_DELIVERY x -

_DETAILS_PUB.C
hangedAttributeR
ecType
x_return_status OUT VARCHAR2 - -
p_init_rec
Attributes of ChangedAttributesRecType that has to be initialized. Definition of
ChangedAttributesRecType follows.
x_return_status

values include:

ChangedAttributesRecType RECORD DEFINITION. To encapsulate
WSH_DELIVERY_DETAILS table definition and Value column equivalents for ID
columns in a PL/SQL record, define ChangedAttributesRecType.
ordered_qty_unit_of_measure2 Varchar2(25) fnd_api.g_miss_char



source_header_id
Should be a valid unique element of oe_order_headers_all.header_id.
source_line_id
Should be a valid unique element of oe_order_lines_all.line_id.
sold_to_org_id
Should be a valid unique element of hz_cust_accounts.cust_account_id.
customer_number
Should be a valid unique element of hz_cust_accounts.account_number.
sold_to_contact_id
Should indicate contact person at the sold to location.
ship_from_org_id

ship_from_org_code
ship_to_org_id
ship_to_org_code
ship_to_contact_id
Should indicate the contact person to contact at the ship to location.
deliver_to_org_id
deliver_to_org_code
Should indicate contact person at the delivery to location.
intmed_ship_to_org_code Should be a valid element of
org_organization_definitions.organization_code.
Should indicate contact person at the intermediate ship to location.
ordered_quantity
ordered_quantity2
order_quantity_uom
preferred_grade
ordered_qty_unit_of_measure
subinventory
Should indicate the subinventory from which the line item is picked.
revision
Should indicate the revision number for the line item.
lot_number
serial_number
locator_id
date_requested
date_scheduled
shipping_method_code Should be a valid element of
fnd_lookup_values_vl.lookup_code for lookup_type SHIP_METHOD.
carrier_id
Should indicate the name of the carrier name transporting the line item.
freight_terms_code
FREIGHT_TERMS.

freight_terms_name
FREIGHT_TERMS.
fob_code
fob_name
Should be Y or N.
customer_prod_seq
customer_dock_code
gross_weight
net_weight
weight_uom_code
weight_uom_desc
class.
volume
volume_uom_code
volume_uom_desc
class.
top_model_line_id
If the item is included as part of a model, this should indicate the top moel line name for
the line item.
ship_set_id
ato_line_id
arrival_set_id
Should be Y or N.
cust_po_number
released_status
Error Handling
If any Oracle Exception occurs, the API will return the error status to the calling
module.
The API returns the following statuses to the calling module:

AUTOCREATE_DEL_TRIP (overloaded version) API Features
The WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP API consists of the
following features:
• It is called from the source system to automatically create trips and deliveries for
multiple delivery lines.
• It also checks that the attribute parameters passed in are valid and perform the
• The procedure also returns all deliveries and trips created for all delivery detail
lines passed to the API.
Functional Overview
AUTOCREATE_DEL_TRIP (overloaded version) API is called from the source system
to automatically create trips and deliveries for multiple delivery lines. The procedure
also checks that the attribute parameters passed in are valid and perform value to ID
conversion while validating. It returns all deliveries and trips created for all delivery
detail lines passed to the API

WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP. All of the inbound and
outbound parameters are listed. Additional information on these parameters follows
the table.
p_api_version_number IN Number x
x_del_rows OUT Table -
x_trip_rows OUT Table -
p_init_msg_list
• p_encoded => F
p_commit
x_return_status
x_msg_count
x_msg_data

actual message.
p_line_rows
Table of Delivery Details of type WSH_UTIL_CORE.ID_TAB_TYPE, which is a table of
x_del_rows
x_trip_rows
Table of trips of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table of type
Standard Validation
Oracle Transportation Execution validates all required columns in the the API
WSH_DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP. For specific information
on the data referenced by these columns, see:
Oracle Electronic Technical Reference Manual (eTRM)
API checks that the attribute parameters passed in are valid and perform value to ID
conversion while validating.
Error Handling
If any validation fails, the API will return the error status to the calling module. The API
processes the rows and reports the following values for every record:
Container Public Application Program Interface

The Container Public Application Program Interface (API) is a public API that consists
of the four following procedures in package WSH_CONTAINER_PUB:
Create_Containers: Enables you to create a new container record.
Update_Container: Updates an existing container record.
Auto_Pack: Lets you autopack containers.
Container_Actions: Enables you to perform certain actions on a container.
This section describes how to use the Container Public API and how it functions in
Create_Containers API Features

The Create_Containers API has the following features.
The Create_Containers procedure takes in a container item id or container item name
and other necessary parameters to create one or more containers and creates the
required containers. It returns a table of container instance ids (delivery detail ids)
along with the standard out parameters.
Functional Overview
This API creates a new container record in WSH_DELIVERY_DETAILS. It Inserts
container information into WSH_DELIVERY_DETAILS and returns a table of the newly
created container IDs.

WSH_CONTAINER_PUB.CREATE_CONTAINERS
WSH_CONTAINER_PUB.CREATE_CONTAINERS. All of the inbound and outbound
WSH_CONTAINER_PUB.CREATE_CONTAINERS Parameters
er

p_container_item_id IN Number -
p_container_item_na IN Varchar2 x
me
p_organization_id IN Number -
p_organization_code IN Varchar2 -
p_name_prefix IN Varchar2 -
p_name_suffix IN Varchar2 -
p_base_number IN Number x
p_num_digits IN Number -
p_quantity IN Number -
p_container_name IN Varchar2 -
p_action IN Varchar2 -
x_container_ids OUT Table -
p_init_msg_list
• p_encoded => F
x_return_status
x_msg_count
x_msg_data
actual message.
p_container_item_id
Key flexfield Id for the container.
p_container_item_name
Flexfield name for the container.
p_organization_id
Organization ID for the container.
p_organization_code
Organization code for the container.
p_name_prefix
Prefix of the container name.
p_name_suffix
Suffix of the container name.
p_name_prefix
Prefix of the container name.
p_base_number
Starting number for the numeric portion of the container name.
p_num_digits

Precision for the number of digits.
p_quantity
Number of containers created.
p_container_name
Container name if creating just one container.
x_container_ids
Table of the newly created container IDs of type WSH_UTIL_CORE.ID_TAB_TYPE
which is a table of type Number indexed by binary integers.
Error Handling
messages.
Update Container API Features

The Trip_Action API has the following features:
The Update_Container procedure enables you to update an existing container. It
accepts as IN parameters the container information and the name/ID of the container
being updated.
Functional Overview
The API updates an existing container record in WSH_DELIVERY_DETAILS with the
attributes input in the container rec type. The name or the ID of the container being
updated is passed as IN parameters p_container_name and p_cont_instance_id
respectively.
The API validates the input record attributes before updating a container record.
WSH_DELIVERY_DETAILS
er
p_validation_level IN Varchar2 -
p_container_rec IN Record x
p_init_msg_list
• p_encoded => F
x_return_status
x_msg_count
x_msg_data

actual message.
p_container_rec
Attributes of the container entity of type ChangedAttributeRecType. These attributes
are updated in WSH_DELIVERY_DETAILS. Definition of ChangedAttributeRecType
follows.

To encapsulate WSH_DELIVERY_DETAILS table definition and Value column
equivalents for ID columns in a PL/SQL record, define ChangedAttributeRecType and
use this to pass trip information to the Update_Container routine.


sold_to_org_id
Should be a valid unique element of ra_customers.customer_id.
customer_number
Should be a valid unique element of ra_customers.customer_number
ship_from_org_id
ship_from_org_code
ship_to_org_id
ship_to_org_code
delier_to_org_id
deliver_to_org_code

ordered_quantity
order_quantity_uom
ordered_quantity_unit_of_measure
SHIP_METHOD.
freight_terms_code
FREIGHT_TERMS.
freight_terms_name
FREIGHT_TERMS.
fob_code
fob_name
Should be Y or N.
gross_weight
net_weight
weight_uom_code
weight_uom_desc
class.
volume
volume_uom_code
volume_uom_desc
class.
Should be Y or N.
released_status
Should be one of R, S, Y or X.
Error Handling
messages.
Auto_Pack API Features

The Auto_Pack API has the following features.
The Auto_Pack procedure takes in a table of ids of either delivery lines or container or
deliveries and autopacks the lines/containers/deliveries into detail containers and
returns a table of container instance ids created during the autopacking process
Functional Overview
This API takes in a table of ids of either delivery lines or container or deliveries and
autopacks the lines/containers/deliveries into detail containers. The grouping id table is
used only if the input table of entities are lines or containers only. The packing of lines
and containers into parent containers is determined by the grouping id for each
line/container.
If the grouping id table is not input, the API determines the grouping ids for the
lines/containers based on the grouping attributes of the lines/containers. The
lines/containers are then autopacked into detail containers and the detail containers are

packed into parent/master containers based on whether the p_pack_cont_flag is set to
'Y' or 'N'. The API returns a table of container instance ids created during the
autopacking operation. If the detail containers are packed into parent containers, the
output table of ids will contain both the detail and parent containers' delivery detail ids.

WSH_CONTAINER_PUB.AUTO_PACK
WSH_CONTAINER_PUB.AUTO_PACK. All of the inbound and outbound parameters
are listed. Additional information on these parameters follows.
WSH_CONTAINER_PUB.AUTO_PACK Parameters
er
p_entity_tab IN Table -
p_entity_type IN Varchar2 x
p_group_id_tab IN Table -
p_pack_cont_flag IN Varchar2 x
x_cont_inst_tab IN Table -
p_init_msg_list
• p_encoded => F
x_return_status
x_msg_count
x_msg_data
actual message.
p_entity_tab
Table of ids of either lines or containers or deliveries that need to be autopacked of type
WSH_UTIL_CORE.ID_TAB_TYPE which is a table of type Number indexed by binary
integers.
p_entity_type
Type of entity id contained in the entity_tab that needs to be autopacked ('L' - lines, 'C' -
containers or 'D' - deliveries).
p_group_id_tab
Table of ids (numbers that determine the grouping of lines for packing into containers)
of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table of type Number indexed by
binary integers.

p_pack_cont_flag
A 'Y' or 'N' value to determine whether to autopack the detail containers that are
created into parent containers.
x_cont_inst_tab
Table of container IDs created during the autopacking process of type
WSH_UTIL_CORE.ID_TAB_TYPE which is a table of type Number indexed by binary
integers.
Error Handling
messages.
Container_Actions API Features

The Container_Actions API has the following features.
The Container_Actions procedure enables you to carry out actions on a container. It
accepts as IN parameters a table of delivery detail ids, an action code, and any
additional parameters needed for specific actions, and returns a completion status.
Functional Overview
This API takes in a table of delivery detail ids and name and/or delivery detail id of the
container to pack. If the action code is assigned then delivery id and delivery name
must be specified. The API determines what action to perform based on the action code
and then calls appropriate private pack/assign/unpack/unassign API. The input table of
ids could be lines or containers. The delivery lines and containers are separated from
the input table and validated before the appropriate private APIs are called.

WSH_CONTAINER_PUB.CONTAINER_ACTIONS
WSH_CONTAINER_PUB.CONTAINER_ACTIONS. All of the inbound and outbound
WSH_CONTAINER_PUB.CONTAINER_ACTIONS Parameters
er
p_detail_tab IN Table x
p_container_instance IN Number -
_id
p_container_flag IN Table -
p_delivery_flag IN Varchar2 -
p_delivery_id IN Number -
p_action_code IN Varchar2 -
p_init_msg_list
• p_encoded => F

x_return_status
x_msg_count
x_msg_data
actual message.
p_detail_tab
Input table of delivery detail ids of type WSH_UTIL_CORE.ID_TAB_TYPE which is a
table of type Number indexed by binary integers.
p_container_instance_id
Delivery detail ID of parent container being packed
p_container_name
Container name if ID is not known
p_container_flag
Y or N depending on whether to unpack or not respectively.
p_delivery_flag
Y or N depending on whether the container needs to be unassigned from a delivery or
not respectively.
p_delivery_id
Delivery ID the container is assigned to.
p_delivery_name
Delivery name the container is assigned to.
p_action_code
Action code Pack, Assign, Unpack, or Unassign to specify which action to perform.
Error Handling
messages.
Freight Costs Public Application Program Interface

The Freight Costs Public Application Program Interface (API) is a public API that
consists of the following three procedures in package WSH_FREIGHT_COSTS_PUB:
Create_Update_Freight_Costs: Enables you to create a new freight cost record and
update an existing freight cost record.
Validate_Freight_Cost_Type: Validates that the freight cost type exists.
Delete_Freight_Costs: Enables you to delete a freight cost record.
This section describes how to use the Freight Costs Public API and how it functions in
Create_Update_Freight_Costs API Features

The Create_Update_Freight_Cost API has the following features.
The Create_Update_Freight_Costs procedure enables you to create a new freight cost
record or update an existing freight cost record in WSH_FREIGHT_COSTS table. The
FREIGHT_COST_ID, and return status of a new freight cost record are passed as OUT
parameters, while a freight cost record of freight cost information is passed as an IN
parameter.
Functional Overview
This API creates a new freight cost record in WSH_FREIGHT_COSTS as specified by IN
parameter p_action_code value CREATE. It inserts the freight cost information into
WSH_FREIGHT_COSTS and returns the FREIGHT_COST_ID of the new freight cost
record. It also updates an existing freight cost record in WSH_FREIGHT_COSTS as
specified by IN parameter p_action_code value UPDATE.
The API validates freight information such as freight cost type, unit amount, conversion
rate, and currency before performing the actions of creating or updating a freight cost
record. It also checks that the insert or update statements were successful, and if not
returns an error.
Also, ensure that only one shipping entity—a trip, stop, delivery, delivery leg, or
delivery detail—is passed in to be associated with a freight cost record. Each freight cost
must be associated with only one shipping entity.

WSH_FREIGHT_COSTS _PUB.CREATE_UPDATE_FREIGHT_COSTS
WSH_FREIGHT_COSTS _PUB.CREATE_UPDATE_FREIGHT_COSTS. All of the
parameters follows.
WSH_FREIGHT_COSTS _PUB.CREATE_UPDATE_FREIGHT_COSTS Parameters
er
p_pub_freight_costs IN OUT Record x
x_freight_cost_id OUT Number -
p_init_msg_list
• p_encoded => F
x_return_status
x_msg_count
x_msg_data
actual message.
p_pub_freight_costs
Attributes of the freight cost entity of type PubFreightCostRecType. These attributes are
inserted/updated in WSH_FREIGHT_COSTS. Definition of PubFreightCostRecType
follows.
p_action_code
Specifies whether API should create a new freight cost record or update existing freight
cost record information based on its values CREATE or UPDATE.
x_freight_cost_id
ID of new freight cost record being created.

PubFreightCostRecType RECORD DEFINITION
To encapsulate WSH_FREIGHT_COSTS table definition and Value column equivalents
for ID columns in a PL/SQL record, define PubFreightCostRecType and use this to pass
freight cost record information to the Create_Update_Freight_Cost routine.

freight_cost_id Number fnd_api.g_miss_num
freight_cost_type_id Number fnd_api.g_miss_num
unit_amount Number fnd_api.g_miss_num
conversion_date Date fnd_api.g_miss_date
conversion_rate Number fnd_api.g_miss_num
conversion_type_code Varchar2(30) fnd_api.g_miss_char
planned_dep_date Date fnd_api.g_miss_date
delivery_name Varchar2(30) fnd_api.g_miss_char
delivery_leg_id Number fnd_api.g_miss_num

freight_cost_type Varchar2(30) fnd_api.g_miss_char
action_code Varchar2(30) fnd_api.g_miss_char

freight_cost_id
Should be a unique valid element of wsh_freight_cost_types.freight_cost_id.
freight_cost_type_id
Should be a valid element of wsh_freight_cost_types.freight_cost_type_id.
unit_amount
currency_code
conversion_rate
trip_id
trip_name
stop_id
stop_location_id
Should be a valid element of wsh_trip_stops.stop_location_id.
planned_dep_date
Should be a valid element of wsh_trip_stops.planned_departure_date.
delivery_id
delivery_name
Should be a valid unique element of wsh_new_deliveries.name
delivery_leg_id
Should be a valid element of wsh_delivery_legs.delivery_leg_id.
delivery_detail_id
Should be a valid element of wsh_delivery_details.delivery_detail_id.
freight_cost_type
Should be a valid element of wsh_freight_cost_types.name.
Error Handling
messages.
Validate_Freight_Cost_Type API Features

The Validate_Freight_Cost_Type API has the following features.
The Validate_Freight_Cost_Type procedure enables you to validate an existing freight
cost type from the WSH_FREIGHT_COST_TYPES table. The freight cost type is passed
as an IN parameter, while the freight cost id and a return status are passed as an OUT
parameter.

WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS
WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS. All of the inbound and
WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS Parameters
p_freight_cost_type IN Varchar2 x
x_freight_cost_type_i IN OUT Varchar2 -

d
p_freight_cost_type

Freight coat type that needs to be validated.
x_freight_cost_type_id
Type Id of the freight cost being validated.
x_return_status
• Unexpected Error: FND_API.G_RET_STS_UNEXP_ERROR.
Delete_Freight_Costs API Features

The Delete_Freight_Costs API has the following features.
The Delete_Freight_Costs procedure enables you to delete an existing freight cost
record from the WSH_FREIGHT_COSTS table. A freight cost record of freight cost
information of the freight cost record being deleted is passed as an IN parameter.
Functional Overview
The Delete_Freight_Costs procedure enables you to delete a new freight cost record
from WSH_FREIGHT_COSTS table. It identifies the freight record being deleted by
using the freight_cost_id attribute in the freight cost record that is being passed as an IN
parameter.

WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS
WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS. All of the inbound and
WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS Parameters
er
p_pub_freight_costs IN OUT Record x
p_init_msg_list
• p_encoded => F
x_return_status
values include:
x_msg_count
x_msg_data

actual message.
p_pub_freight_costs
Attributes of the freight cost entity of type PubFreightCostRecType. These attributes are
inserted/updated in WSH_FREIGHT_COSTS. Definition of PubFreightCostRecType
follows.

To encapsulate WSH_FREIGHT_COSTS table definition and Value column equivalents
for ID columns in a PL/SQL record, we define PubFreightCostRecType and use this to
pass Freight Cost information to the Delete_Freight_Cost routine.
freight_cost_id Number fnd_api.g_miss_num
freight_cost_type_id Number fnd_api.g_miss_num
unit_amount Number fnd_api.g_miss_num
conversion_date Date fnd_api.g_miss_date
conversion_rate Number fnd_api.g_miss_num
conversion_type_code Varchar2(30) fnd_api.g_miss_char
planned_dep_date Date fnd_api.g_miss_date
delivery_name Varchar2(30) fnd_api.g_miss_char
delivery_leg_id Number fnd_api.g_miss_num

freight_cost_type Varchar2(30) fnd_api.g_miss_char
action_code Varchar2(30) fnd_api.g_miss_char

freight_cost_id
Should be a valid element of wsh_freight_cost_types.freight_cost_id.
freight_cost_type_id
Should be a valid element of wsh_freight_cost_types.freight_cost_type_id.
unit_amount
currency_code
conversion_rate
trip_id
trip_name
stop_id
stop_location_id
Should be a valid element of wsh_trip_stops.stop_location_id.
planned_dep_date
Should be a valid element of wsh_trip_stops.planned_departure_date.
delivery_id
delivery_name
Should be a valid unique element of wsh_new_deliveries.name
delivery_leg_id
Should be a valid element of wsh_delivery_legs.delivery_leg_id.
delivery_detail_id
Should be a valid element of wsh_delivery_details.delivery_detail_id.
freight_cost_type
Should be a valid element of wsh_freight_cost_types.name.
Error Handling
messages.
Pick Release Application Program Interface

The Pick Release public consists of the following procedures in package
WSH_PICKING_BATCHES_PUB:
Create_Batch: Enables you to create a new pick release batch.
Release_Batch: Enables you to release a batch.
Get_Batch_Record: Takes in a batch_id or batch_name and retrieves the batch record
from wsh_picking_batches.
This section describes how to use the Pick Release Public API and how it functions in
Note: When pick releasing using the

WSH_PICKING_BATCHES_PUB.CREATE_BATCH API, the default
value for the attribute append_flag is N. To enable Append Deliveries
during pick release from the API, the value of append_flag must be set
to Y or NULL. If append_flag is NULL, and the batch_id is specified,
then WSH_PICKING_BATCHES_PUB.CREATE_BATCH will get the
value of append_flag from the picking batch.
If append_flag is NULL or Y, then all of the following conditions must
be met:
• The organization_id is specified and append_limit of the
organization in the Shipping Parameters window is not Do Not
Append.
• The autocreate_delivery_flag is Y and ac_delivery_criteria is N.
• The auto_pick_confirm_flag is N
• The ship_confirm_rule_id is NULL.
• The autopack_flag is N.
Also, if you run this API with p_release_mode ONLINE, when calling
WSH_PICKING_BATCHES_PUB.Release_Batch, it is not recommended
that you run pick release on the same set of delivery lines with
append_flag set to Y because may result in unpredictable results. The
existing deliveries selected for appending may differ.
Create_Batch API Features

The Create_Batch API enables you to create a new pick release batch.
Functional Overview
This API creates a new pick release batch with a unique batch ID that is then used by
the Release_Batch API to release the batch.

WSH_PICKING_BATCHES_PUB.CREATE_BATCH
WSH_PICKING_BATCHES_PUB.CREATE_BATCH. All of the inbound and outbound
WSH_PICKING_BATCHES_PUB.CREATE_BATCH Parameters
er
x_msg_data Out Varchar2 -
p_rule_id IN Number -
p_rule_name IN Varchar2 -
p_batch_rec IN Record x
p_batch_prefix IN Varchar2 -
x_batch_id OUT Number -
p_init_msg_list
• p_encoded => F

p_commit
x_return_status
values include:
x_msg_count
x_msg_data
actual message.
p_rule_id
Indicates the picking rule identification.
p_rule_name
Indicates the picking rule name.
p_batch_rec
Contains all picking batch parameters.
p_batch_prefix
Used to add a prefix to the batch id.
x_batch_id
Returns the batch id that is created.

Batch_Info_Rec Type RECORD DEFINITION
To encapsulate WSH_PICKING_BATCHES table definition and Value column
equivalents for ID columns in a PL/SQL record, we define Batch_Info_Rec Type and use
this to pass Pick Release information to the Create_Batch routine.
Attribute Type
Allocation_Method Varchar2(1)
Cross_Dock_Criteria_ID Number
Backorders_Only_Flag Varchar2(1)
Document_Set_Id Number
Document_Set_Name Varchar2(30)
Existing_Rsvs_Only_Flag Varchar2(1)
Shipment_Priority_Code Varchar2(30)
Ship_Method_Code Varchar2(30)
Ship_Method_Name Varchar2(80)
Customer_Id Number
Customer_Number Varchar2(30)
Order_Header_Id Number
Order_Number Number
Ship_Set_Id Number
Ship_Set_Number Varchar2(30)
Inventory_Item_Id Number
Order_Type_Id Number
From_Requested_Date Date
To_Requested_Date Date

Attribute Type
From_Scheduled_Ship_Date Date
To_Scheduled_Ship_Date Date
Ship_To_Location_Id Number
Ship_To_Location_code Varchar2(30)
Ship_From_Location_Id Number
Ship_From_Location_code Varchar2(30)
Trip_Name Varchar2(30)
Delivery_Id Number
Delivery_Name Varchar2(30)
Include_Planned_Lines Varchar2(1)
Pick_Grouping_Rule_Id Number
Pick_Grouping_Rule_Name Varchar2(30)
Pick_Sequence_Rule_Id Number
Pick_Sequence_Rule_Name Varchar2(30)
Autocreate_Delivery_Flag Varchar2(1)
Attribute_Category Varchar2(30)
attribute1 Varchar2(150)
Attribute Type
Autodetail_Pr_Flag Varchar2(1)
Trip_Stop_Id Number
Trip_Stop_location_id Number
Default_Stage_Subinventory Varchar2(10)
Default_Stage_Locator_Id Number
Pick_From_Subinventory Varchar2(10)
Pick_From_locator_Id Number
Auto_Pick_Confirm_Flag Varchar2(1)
Delivery_Detail_Id Number

Attribute Type
Project_Id Number
Task_Id Number
Organization_Id Number
Organization_Code Varchar2(3)
Ship_Confirm_Rule_Id Number
Ship_Confirm_Rule_Name Varchar2(30)
Autopack_Flag Varchar2(1)
Autopack_Level Number
Task_Planning_Flag Varchar2(1)
Category_Set_ID Number
Category_ID Number
Ship_Set_Smc_Flag Varchar2(1)
region_ID Number
zone_ID Number
ac_Delivery_Criteria Varchar2(2)
rel_subinventory Varchar2(10)
append_flag Varchar2(1)
task_priority Number

allocation_method
Should be a method to allocate items. Valid entries are X: Cross Dock, I: Inventory, C:
Prioritize Cross Dock, and N: Prioritize Inventory
cross_dock_criteria_ID
Should be a valid element of wms_crossdock_criteria_b.criteria_id. Translation table:
wms_crossdock_criteria_tl, and it can be used to search for the criterion_id based on the
criterion_name.
backorders_only_flag
Should be a valid element of wsh_picking_batches.Backorders_Only_Flag. Valid entries
are I, E, and O.
document_set_id
Should be a valid element of wsh_picking_batches.Document_Set_Id.
document_set_name
Should be a valid element of wsh_report_sets.name.
existing_rsvs_only_flag
Should be a valid element of wsh_picking_batches.Existing_Rsvs_Only_Flag.
Should be a valid element of oe_lookups.lookup_code.
ship_method_code
Should be a valid unique element of wsh_picking_batches.Ship_Method_Code.
ship_method_name
Should be a valid unique element of fnd_lookup_values_vl.meaning.
customer_id
Should be a valid unique element of wsh_picking_batches.Customer_Id.
customer_number
Should be a valid element of ra_customers.customer_number.
order_header_id
Should be a valid element of wsh_picking_batches.Order_Header_Id.
order_number
Should be a valid unique element of oe_order_headers_all.Order_Number.
ship_set_id
Should be a valid unique element of wsh_picking_batches.Ship_Set_Number
ship_set_number
Should be a valid element of oe_sets.set_name.
inventory_item_id

Should be a valid element of wsh_picking_batches.Inventory_Item_Id.
order_type_id
Should be a valid element of wsh_picking_batches.Order_Type_Id.
order_type_name
Should be a valid element of oe_transaction_types_tl.name.
from_requested_date
Starting request date to release.
to_requested_date
Ending request date to release.
from_scheduled_ship_date
Starting schedule date to release.
to_scheduled_ship_date
Ending schedule date to release.
ship_to_location_id
Should be a valid element of wsh_picking_batches.Ship_To_Location_Id.
ship_to_location_code
Should be a valid element of hr_locations_all_tl.location_code.
ship_from_location_id
Should be a valid unique element of wsh_picking_batches.Ship_From_Location_Id.
ship_from_location_code
Should be a valid unique element of hr_locations_all_tl.location_code.
trip_id
Should be a valid element of wsh_picking_batches.Trip_Id.
trip_name
Should be a valid element of wsh_trips.name.
delivery_id
Should be a valid element of wsh_picking_batches.Delivery_Id.
delivery_name
Should be a valid element of wsh_new_deliveries.name.
include_planned_lines
Should be a valid unique element of wsh_picking_batches.Include_Planned_Lines.
pick_grouping_rule_id
Should be a valid unique element of wsh_picking_batches.Pick_Grouping_Rule_Id.
pick_grouping_rule_name
Should be a valid element of wsh_pick_grouping_rules.name.
pick_sequence_rule_id
Should be a valid element of wsh_picking_batches.Pick_Sequence_Rule_Id.
pick_sequence_rule_name
Should be a valid element of wsh_pick_sequence_rules.name.
auto_create_delivery_flag
Should be a valid element of wsh_picking_batches.Autocreate_Delivery_Flag.
attribute_category
Should be a valid unique element of wsh_picking_batches.Attribute_Category.
autodetail_pr_flag
Should be a valid unique element of wsh_picking_batches.Autodetail_Pr_Flag.
trip_stop_id
Should be a valid element of wsh_picking_batches.Trip_Stop_Id.
trip_stop_location_id
Should be a valid element of wsh_trip_stops.Stop_Id.
default_stage_subinventory
Should be a valid element of wsh_picking_batches.Default_Stage_Subinventory.
default_stage_locator_id
Should be a valid element of wsh_picking_batches.Default_Stage_Locator_Id.
pick_from_subinventory
Should be a valid unique element of wsh_picking_batches.Pick_From_Subinventory.
pick_from_locator_id
Should be a valid unique element of wsh_picking_batches.Pick_From_locator_Id.
auto_pick_confirm_flag
Should be a valid element of wsh_picking_batches.Auto_Pick_Confirm_Flag. Valid
entries are Y or N.
delivery_detail_id
Should be a valid element of wsh_picking_batches.Delivery_Detail_Id.
project_id
Should be a valid element of wsh_picking_batches.Project_Id.

task_id
Should be a valid element of wsh_picking_batches.Task_Id.
organization_id
Should be a valid unique element of wsh_picking_batches.Organization_Id.
organization_code
Should be a valid unique element of org_organization_definitions.organization_code.
ship_confirm_rule_id
Should be a valid element of wsh_picking_batches.Ship_Confirm_Rule_Id.
ship_confirm_rule_name
Should be a valid element of wsh_Ship_Confirm_rules.name.
autopack_flag
Should be a valid element of wsh_picking_batches.Autopack_Flag.
autopack_level
Should be a valid element of wsh_picking_batches.Autopack_Level. Valid entries are 0,
1, or 2.
task_planning_flag
Should be a valid unique element of wsh_picking_batches.Task_Planning_Flag.
category_set_id
Should be a valid unique element of wsh_picking_batches.Category_Set_ID.
category_id
Should be a valid element of wsh_picking_batches.Category_ID.
ship_set_smc_flag
Should be a valid element of wsh_picking_batches.Ship_Set_Smc_Flag.
region_id
Should be a valid element of wsh_picking_batches.region_id.
zone_id
Should be a valid element of wsh_picking_batches.zone_id.
ac_delivery_criteria
Should be a valid unique element of wsh_picking_batches.ac_delivery_criteria.
rel_subinventory
Should be a valid unique element of wsh_picking_batches.rel_subinventory.
append_flag
Should be a valid element of wsh_picking_batches.append_flag.
task_priority
Should be a valid element of wsh_picking_batches.task_priority.
Error Handling
messages.
Release_Batch API Features

The Release_Batch API enables you to release a newly created pick release batch.
Functional Overview
This API enables you to release a pick release batch that was generated by the
Create_Batch API.

WSH_PICKING_BATCHES_PUB.RELEASE_BATCH
WSH_PICKING_BATCHES_PUB.RELEASE_BATCH. All of the inbound and outbound
WSH_PICKING_BATCHES_PUB.RELEASE_BATCH Parameters
er
p_batch_id IN Number -

p_batch_name IN Varchar2 -
p_log_level IN Number -
p_release_mode IN Varchar2 -
x_request_id OUT Number -
p_init_msg_list
• p_encoded => F
p_commit
x_return_status
values include:
x_msg_count
x_msg_data
actual message.
p_batch_id
Indicates the picking batch identification which is used to get the batch information
from wsh_picking_batches.
p_batch_name
Indicates the picking batch name which is used to get the batch information from
wsh_picking_batches.
p_log_level
Controls the log message generated by the concurrent pick release process.
p_release_mode
Controls the release mode of either Concurrent or Online. Default = Concurrent.
x_request_id
Returns the request id for the concurrent pick release request.
Get_Batch_Record API Features

The WSH_PICKING_BATCHES_PUB.GET_BATCH_RECORD API consists of the
following entities: API retrives data from wsh_picking_batches table for the given
batch_id or batch_name.
Functional Overview
The API takes in a Batch_id or Batch_name and retrieves the batch record from
wsh_picking_batches. It considers batch_name value only when the parameter batch_id
is not being passed to the API. The API validates p_batch_id and p_batch_name values.
For the valid values, information is retrieved and passed back to the calling API
through the OUT parameter x_batch_rec. API passes NULL values for all read only
fields, such as customer name, item name, document set name, as per release sales
order form.

WSH_PICKING_BATCHES_PUB.GET_BATCH_RECORD. All of the inbound and
outbound parameters are listed. Additional information on these parameters follows
the table.

p_api_version In NUMBER x
p_init_msg_list In VARCHAR2 -
p_commit In VARCHAR2 -
x_return_status Out VARCHAR2 -
x_msg_count Out NUMBER -
x_msg_data Out VARCHR2 -
-
p_batch_id IN NUMBER

p_batch_name IN NUMBER -
x_batch_rec OUT WSH_PICKING_B -

ATCHES_PUB.Bat
ch_Info_Rec
Important: Either of Batch Id or Batch name is required.
p_init_msg_list
• p_encoded => F
p_commit
x_return_status
values include:
x_msg_count
x_msg_data
actual message.
p_batch_id
Picking batch id value corresponds to batch_id column of WSH_PICKING_BATCHES
table.
p_batch_name
Picking batch name value corresponds to name column of WSH_PICKING_BATCHES
table.

To encapsulate WSH_PICKING_BATCHES table definition and Value column
equivalents for ID columns in a PL/SQL record. API retrives all database column values
present in WSH_PICKING_BATCHES table. It returns NULL for all read only
(NAME/CODE) fields present in the record group (Example. Document Set Name,
Customer Name etc).
Attribute Type
Backorders_Only_Flag Varchar2(1)

Attribute Type
Document_Set_Id Number
Document_Set_Name Varchar2(30)
Existing_Rsvs_Only_Flag Varchar2(1)
Shipment_Priority_Code Varchar2(30)
Ship_Method_Code Varchar2(30)
Ship_Method_Name Varchar2(80)
Customer_Id Number
Customer_Number Varchar2(30)
Order_Header_Id Number
Order_Number Number
Ship_Set_Id Number
Ship_Set_Number Varchar2(30)
Inventory_Item_Id Number
Order_Type_Id Number
From_Requested_Date Date
To_Requested_Date Date
From_Scheduled_Ship_Date Date
To_Scheduled_Ship_Date Date
Ship_To_Location_Id Number
Ship_To_Location_code Varchar2(30)
Attribute Type
Ship_From_Location_Id Number
Ship_From_Location_code Varchar2(30)
Trip_Name Varchar2(30)
Delivery_Id Number
Delivery_Name Varchar2(30)
Include_Planned_Lines Varchar2(1)
Pick_Grouping_Rule_Id Number
Pick_Grouping_Rule_Name Varchar2(30)
Pick_Sequence_Rule_Id Number
Pick_Sequence_Rule_Name Varchar2(30)
Autocreate_Delivery_Flag Varchar2(1)
Attribute_Category Varchar2(30)

Attribute Type
Autodetail_Pr_Flag Varchar2(1)
Trip_Stop_Id Number
Trip_Stop_location_id Number
Default_Stage_Subinventory Varchar2(10)
Default_Stage_Locator_Id Number
Pick_From_Subinventory Varchar2(10)
Pick_From_locator_Id Number
Attribute Type
Auto_Pick_Confirm_Flag Varchar2(1)
Delivery_Detail_Id Number
Project_Id Number
Task_Id Number
Organization_Id Number
Organization_Code Varchar2(3)
Ship_Confirm_Rule_Id Number
Ship_Confirm_Rule_Name Varchar2(30)
Autopack_Flag Varchar2(1)
Autopack_Level Number
Task_Planning_Flag Varchar2(1)
Category_Set_ID Number
Category_ID Number
Ship_Set_Smc_Flag Varchar2(1)
region_ID Number
zone_ID Number

Attribute Type
ac_Delivery_Criteria Varchar2(2)
rel_subinventory Varchar2(10)
append_flag Varchar2(1)
task_priority Number
actual_departure_date Date
allocation_method Varchar2(1)
crossdock_criteria_id Number
crossdock_criteria_name Varchar2(80)

backorders_only_flag
Corresponds to wsh_picking_batches.Backorders_Only_Flag.
document_set_id
Corresponds to wsh_picking_batches.Document_Set_Id.
document_set_name
Returns NULL value.
existing_rsvs_only_flag
Corresponds to wsh_picking_batches.Existing_Rsvs_Only_Flag.
Corresponds to wsh_picking_batches. Shipment_Priority_Code.
ship_method_code
Corresponds to wsh_picking_batches.Ship_Method_Code.
ship_method_name
Returns NULL value.
customer_id
Corresponds to wsh_picking_batches.Customer_Id.
customer_number
Returns NULL value.
order_header_id
Corresponds to wsh_picking_batches.Order_Header_Id.
order_number
Returns NULL value.
ship_set_id
Returns NULL value.
ship_set_number
Corresponds to wsh_picking_batches. ship_set_number.
inventory_item_id
Corresponds to wsh_picking_batches.Inventory_Item_Id.
order_type_id
Corresponds to wsh_picking_batches.Order_Type_Id
order_type_name
Returns null value.
from_requested_date
Corresponds to wsh_picking_batches.from_requested_date.
to_requested_date
Corresponds to wsh_picking_batches.to_requested_date.
from_scheduled_ship_date
Corresponds to wsh_picking_batches.from_scheduled_ship_date.
to_scheduled_ship_date
Corresponds to wsh_picking_batches.to_scheduled_ship_date.
ship_to_location_id
Corresponds to wsh_picking_batches.Ship_To_Location_Id.
ship_to_location_code
Returns null value.
ship_from_location_id

Corresponds to wsh_picking_batches.Ship_From_Location_Id.
ship_from_location_code
Returns null value.
trip_id
Corresponds to wsh_picking_batches.Trip_Id.
trip_name
Returns null value.
delivery_id
Corresponds to wsh_picking_batches.Delivery_Id.
delivery_name
Returns null value.
include_planned_lines
Corresponds to wsh_picking_batches.Include_Planned_Lines.
pick_grouping_rule_id
Corresponds to wsh_picking_batches.Pick_Grouping_Rule_Id.
pick_grouping_rule_name
Returns null value.
pick_sequence_rule_id
Corresponds to wsh_picking_batches.Pick_Sequence_Rule_Id.
pick_sequence_rule_name
Returns null value.
auto_create_delivery_flag
Corresponds to wsh_picking_batches.Autocreate_Delivery_Flag.
attribute_category
Corresponds to wsh_picking_batches.Attribute_Category.
autodetail_pr_flag
Corresponds to wsh_picking_batches.Autodetail_Pr_Flag.
trip_stop_id
Corresponds to wsh_picking_batches.Trip_Stop_Id.
trip_stop_location_id
Should be a valid element of wsh_trip_stops.Stop_Id.
default_stage_subinventory
Corresponds to wsh_picking_batches.Default_Stage_Subinventory.
default_stage_locator_id
Corresponds to wsh_picking_batches.Default_Stage_Locator_Id.
pick_from_subinventory
Corresponds to wsh_picking_batches.Pick_From_Subinventory.
pick_from_locator_id
Corresponds to wsh_picking_batches.Pick_From_locator_Id.
auto_pick_confirm_flag
Corresponds to wsh_picking_batches.Auto_Pick_Confirm_Flag.
delivery_detail_id
Corresponds to wsh_picking_batches.Delivery_Detail_Id.
project_id
Should be a valid element of wsh_picking_batches.Project_Id.
task_id
Corresponds to wsh_picking_batches.Task_Id.
organization_id
Corresponds to wsh_picking_batches.Organization_Id.
organization_code
Returns null value.
ship_confirm_rule_id
Corresponds to wsh_picking_batches.Ship_Confirm_Rule_Id.
ship_confirm_rule_name
Returns null value.
autopack_flag
Corresponds to wsh_picking_batches.Autopack_Flag.
autopack_level
Corresponds to wsh_picking_batches.Autopack_Level.
task_planning_flag
Corresponds to wsh_picking_batches.Task_Planning_Flag.
category_set_id
Corresponds to wsh_picking_batches.Category_Set_ID.
category_id

Corresponds to wsh_picking_batches.Category_ID.
ship_set_smc_flag
Corresponds to wsh_picking_batches.Ship_Set_Smc_Flag.
region_id
Corresponds to wsh_picking_batches.region_id.
zone_id
Corresponds to wsh_picking_batches.zone_id.
ac_delivery_criteria
Corresponds to wsh_picking_batches.ac_delivery_criteria.
rel_subinventory
Corresponds to wsh_picking_batches.rel_subinventory.
append_flag
Corresponds to wsh_picking_batches.append_flag.
task_priority
Corresponds to wsh_picking_batches.task_priority.
actual_departure_date
Corresponds to wsh_picking_batches.actual_departure_date.
allocation_method
Corresponds to wsh_picking_batches.allocation_method.
crossdock_criteria_id
Corresponds to wsh_picking_batches.crossdock_criteria_id.
crossdock_criteria_name
Returns NULL value.
Standard Validation
WSH_PICKING_BATCHES_PUB.GET_BATCH_RECORD API. For specific information
on the data referenced by these columns, see Oracle Electronic Technical Reference Manual
(eTRM) .
It validates batch_id and batch_name values passed to the API. Either batch_id or
Batch_name or both can be passed to API. If both are passed without any value, then
API raises the error. API validates p_batch_id and p_batch_name parameter values
against wsh_picking_batches table. If no record is found then API returns error status.
Error Handling
If any validation fails, the API will return the error status to the calling module. The
WSH_PICKING_BATCHES_PUB.GET_BATCH_RECORD API processes the rows and
reports the following values for every record:
Document Public Application Program Interface

The WSH_DOCUMENT_PUB.GET_DOCUMENT API consists of the following entities:
Retrives the information from wsh_document_instances table for the given document
type and for the given sales order line id. Document type can be 'PACK_TYPE' or 'BOL'.
The API does not return any value either JB- open issue-Lynn if document corresponds
to the sales order line passed is CLOSED or parameter p_document_type contains any
value other than 'PACK_TYPE' /'BOL'.
Functional Overview
Returns as a record containing all attributes of the currently open document of the
specified type, for example Packing slip or Bill of lading, for a sales order line. There
should be only one open document of a specific type for a delivery. If more than one
open doc is available, then the API returns the first available one.

The following table lists all parameters used by the public API GET_DOCUMENT. All
of the inbound and outbound parameters are listed. Additional information on these
parameters follows the table.
p_api_version In NUMBER x
p_init_msg_list In VARCHAR2 -

p_commit In VARCHAR2 -
p_validation_level In VARCHAR2 -
x_return_status Out VARCHAR2 -
x_msg_count Out NUMBER -
x_msg_data Out VARCHR2 -
p_order_line_id IN NUMBER x
p_document_type IN VARCHAR2 x
x_document_rec OUT WSH_Document_ -

PUB.
document_rectype
p_init_msg_list
• p_encoded => F
p_commit
Requests that the API update information for you after it completes its function.
x_return_status
values include:
x_msg_count
x_msg_data
actual message.
p_order_line_id
Valid sales order line id which is associated to one or more delivery detail lines.
p_document_type
Document type represents the type of the document for which information needs to be
retrived. Possible values for the this parameter are 'PACK_TYPE' (for Packing slip
report) and 'BOL' ( for Bill of lading report).

document_rectype Type RECORD DEFINITION
To encapsulate WSH_DOCUMENT_INSTANCES table definition and Value column
equivalents for ID columns in a PL/SQL record. API retrives all database column values
present in WSH_DOCUMENT_INSTANCES table. It returns NULL for all read only
(NAME/CODE) fields present in the record group (Example. Document Set Name,
Customer Name etc).
Attribute Type
document_instance_id Number

Attribute Type
document_type Varchar2(30)
entity_name Varchar2(50)
entity_id Number
doc_sequence_category_id Number
sequence_number Varchar2(50)
status Varchar2(30)
final_print_date Date
created_by Number
creation_date Date
last_updated_by Number
last_update_date Date
last_update_login Number
program_application_id Number
program_id Number
program_update_date Date
request_id Number
attribute_category Varchar2(150)
Attribute2 Varchar2(150)
Attribute Type
Record Parameter Attribute Descriptions

document_instance_id
Corresponds to wsh_document_instances.document_instance_id.
document_type
Corresponds to wsh_document_instances.document_type.
entity_name
Corresponds to wsh_document_instances.entity_name.
entity_id
Corresponds to wsh_document_instances.entity_id.
doc_sequence_category_id
Corresponds to wsh_document_instances.doc_sequence_category_id.
sequence_number

Corresponds to wssh_document_instances.
sequence_number. status
Corresponds to wsh_document_instances.status.
final_print_date
Corresponds to wsh_document_instances.
final_print_date created_by
Corresponds to wsh_document_instances.
created_by creation_date
Corresponds to wsh_document_instances.creation_date
last_updated_by
Corresponds to wsh_document_instances.last_updated_by
last_update_date
Corresponds to wsh_document_instances.last_update_date
last_update_login
Corresponds to wsh_document_instances.last_update_login
Corresponds to wsh_document_instances.program_application_id
program_id
Corresponds to wsh_document_instances.program_id
program_update_date
Corresponds to wsh_document_instances.program_update_date
request_id
Corresponds to wsh_document_instances.request_id
attribute_category
Corresponds to wsh_document_instances.attribute_category
attribute1 to attribute15
Corresponds to wsh_document_instances.attribute1 to
wsh_document_instances.attribute15.
Standard Validation
WSH_DOCUMENT_PUB.GET_DOCUMENT API. For specific information on the data
referenced by these columns, see Oracle Electronic Technical Reference Manual (eTRM).
API checks the p_document_type value passed to the API. If parameter
p_document_type contains any value other than 'PACK_TYPE' /'BOL' then API do not
return any document instance information for the sales order line id passed to the API.
The API returns the following return statuses to the calling module:
Custom Public Application Program Interface

The Custom Application Program Interface (API) is a public API that consists of the
following two procedures in the package WSH_CUSTOM_PUB:
• UI_Location_Code : Enables the user to tailor how the location (ui_location_code)
information is displayed in the Shipping forms.
• Calculate_TP_Dates : Enables the user to select the delivery window dates based on
different parameters from order management. Customers can ciustomize their
calculation of the delivery window dates (Earliest/Latest Ship Dates and
Earliest/Latest Delivery Dates). These will then be used for population at the
delivery detail level and will get propagated to the container or delivery levels at
action points such as assign/pack.
UI_Location_Code API Features

The UI_Location_Code API enables you to tailor how the location information is
displayed in the Shipping forms and reports based on the attributes passed to API. The
API is called from the package, WSH_LOCATIONS_PKG. The tables involved are
WSH_LOCATIONS, HZ_LOCATIONS ,HZ_PARTY_SITES, HZ_PARTIES,
HR_LOCATIONS_ALL ,HR_LOCATIONS_ALL_TL and
HR_ORGANIZATION_UNITS. The external location information is retrieved from the
HZ tables and the internal locations is retrieved from the HR tables before inserting or
updating the record in WSH_LOCATIONS table.
Functional Overview
This API is designed for you to tailor the display of the location (ui_location_code)
information displayed in the Shipping forms and reports. The API is called when a new
location is created or an existing location is updated. To use the API for the location, the

value of variable x_use_custom_ui_location in WSH_CUSTOM_PUB.ui_location_code
must be set to 'Y'.

The following table lists all of the parameters used by the public
WSH_CUSTOM_PUB.UI_Location_Code. Additional information on these parameters
follows in the table.
Parameter Usage Type Required Derived

Name
p_location_type IN VARCHAR2 x No
p_location_idTbl IN WSH_LOCATIO - No
NS_PKG.ID_Tbl
_Type
p_address_1Tbl IN WSH_LOCATIO - No
NS_PKG.Addres
s_Tbl_Type
p_address_2Tbl IN WSH_LOCATIO - No
NS_PKG.Addres
s_Tbl_Type
p_countryTbl IN WSH_LOCATIO -
NS_PKG.Addres
s_Tbl_Type
p_stateTbl IN WSH_LOCATIO -
NS_PKG.Addres
s_Tbl_Type
p_provinceTbl IN WSH_LOCATIO -
NS_PKG.Addres
s_Tbl_Type
p_countyTbl IN WSH_LOCATIO -
NS_PKG.Addres
s_Tbl_Type
p_cityTbl IN WSH_LOCATIO -
NS_PKG.Addres
s_Tbl_Type
Parameter Usage Type Required Derived
Name
p_postal_codeTb IN WSH_LOCATIO -
l NS_PKG.Addres
s_Tbl_Type
p_party_site_nu IN WSH_LOCATIO -
mberTbl NS_PKG.Locatio
nCode_Tbl_Typ
e
p_location_code IN WSH_LOCATIO -
Tbl NS_PKG.Locatio
nCode_Tbl_Typ
e
x_use_custom_ui OUT VARCHAR2 x No

_location
x_custom_ui_loc OUT WSH_LOCATIO - Yes

_codeTbl NS_PKG.Locatio
nCode_Tbl_Typ
e
p_location_type
The parameter can have value 'HR' for internal location and 'HZ' for external location.
p_location_idTbl
The parameter corresponds to source location id in wsh_locations table.
p_address _1Tbl
Should be valid element of wsh_locations, hz_locations and hr_locations_all table.
p_address _2Tbl
p_countryTbl
p_StateTbl
p_provinceTbl

p_countyTbl
p_cityTbl
p_postal_codeTbl
Should be valid element of wsh_locations,hz_locations and hr_locations_all table.
p_party_site_numberTbl
Should be valid element of wsh_locations,hz_party_sites table.
p_location_codeTbl
Should be valid element of wsh_locations or hr_locations_all table.
x_use_custom_ui_location
Should have a valid value 'Y' or 'N'
p_custom _ui_loc_codeTbl
Should be a valid value and not more then 500 characters.
---Sample code start--
IF p_location_type = 'HZ' THEN
FOR i IN p_location_idTbl.FIRST..p_location_idTbl.LAST
LOOP
x_custom_ui_loc_codeTbl(i) := substrb((p_party_site_numberTbl(i)||'
:
'||p_address_1Tbl(i)||'-'||p_address_2Tbl(i)||'-'||p_cityTbl(i)||'-'||nv
l(p_stateTbl(i),p_provinceTbl(i))||'-'||
p_postal_codeTbl(i)||'-'||p_countryTbl(i)),1,500);
END LOOP;
ELSIF p_location_type = 'HR' THEN
FOR i IN p_location_idTbl.FIRST..p_location_idTbl.LAST
LOOP
x_custom_ui_loc_codeTbl(i) := substrb((p_location_codeTbl(i)||' :
'||p_address_1Tbl(i)||'-'||p_address_2Tbl(i)||'-'||p_cityTbl(i)||'-'||p_
stateTbl(i)||'-'|| p_postal_codeTbl(i)||'-'||p_countryTbl(i)),1,500);
END LOOP;
END IF;
EXCEPTION
WHEN others THEN
l_sqlcode := SQLCODE;
l_sqlerr := SQLERRM;
WSH_UTIL_CORE.printmsg('In the Others Exception of
WSH_CUSTOM_PUB.ui_location_code');
WSH_UTIL_CORE.printmsg(l_sqlcode);
WSH_UTIL_CORE.printmsg(l_sqlerr);
---Sample code end --
Standard Validation
There is no validation done for parameters passed as it is a custom procedure. For
specific information on the data referenced by these columns, see
Oracle Electronic Technical Reference Manual (eTRM).
This API cannot be used alone. The API is always called from the package
WSH_LOCATIONS_PKG. All validations are done in package
WSH_LOCATIONS_PKG.
Calculate_TP_Dates API Features

The Calculate_TP_Dates API consists of the following entities:
This API enables to set the delivery window dates based on different parameters from
Oracle Order Management. Customers can customize their calculation of the delivery
window dates (Earliest/Latest Ship Dates and Earliest/Latest Delivery Dates). These
dates will be then used for the population of values at the delivery detail level and will
get propagated to the container or delivery levels at action points such as assign/pack
etc.
Functional Overview
This API enables the user to set the delivery window dates based on different
parameters from order management. Customers can customize their calculation of the
delivery window dates (Earliest/Latest Ship Dates and Earliest/Latest Delivery Dates).
These will be then used for population of values at the delivery detail level and will get
propagated to the container or delivery levels at action points such as assign/pack etc.

The following table lists all parameters used by the public
WSH_CUSTOM_PUB.Calculate_TP_Dates. All of the inbound and outbound
parameters are listed. Additional information on these parameters follows in the table.
p_source_line_id IN Number - No
p_source_code IN VARCHAR2 - No
x_earliest_pickup_ OUT DATE - Yes

date
x_latest_pickup_d OUT DATE - Yes

ate
x_earliest_dropoff OUT DATE - Yes

_date

x_latest_dropoff_d OUT DATE - Yes

ate
x_modified OUT VARCHAR2 x No
p_source_line_id
Should be valid element of wsh_delivery_details.source_line_id
p_source_code
Should be valid element of wsh_delivery_details.source_code.
x_earliest_pickup_date
Should be a valid date.
x_latest_pickup_date
x_earliest_dropoff_date
x_latest_dropoff_date
x_modified
Should be a valid value 'N' or 'Y'. The default value is 'N'.
Standard Validation
There is no validation done for parameters passed as it is a custom procedure. For
specific information on the data referenced by these columns, see Oracle Electronic
Technical Reference Manual (eTRM).
Example of API Packages and Procedures

The following examples demonstrate 5 procedures that use the Shipping public APIs.
For more information about using the package, see the Script section following the
Procedures section.
Package
Create or replace package WSH_SHIP_API as
procedure SHIP_CONFIRM_EXAMPLE1(
x_return_status OUT VARCHAR2,
x_msg_count OUT NUMBER,
x_msg_data OUT VARCHAR2);
procedure UPDATE_SERIAL_EXAMPLE(
procedure MANUAL_PACK_EXAMPLE(
END WSH_SHIP_API;
/
-- show errors package WSH_SHIP_API;

Procedures
Create or replace package body WSH_SHIP_API as
/*
Example 1:
This procedure is used as an example of how to ship confirm a
delivery consisting of delivery details that have already been
pick released and assigned to a delivery:
Call WSH_DELIVERY_DETAILS_PUB.Update_Shipping_Attributes API to
update the corresponding delivery details to ship all quantities
in the first delivery detail; to back order all in the second;
to stage all in the third delivery detail.
Call WSH_FREIGHT_COSTS_PUB.Create_Update_Freight_Costs API to
create freight costs for the delivery that the details have been
assigned to.
Call WSH_CONTAINER_PUB.Auto_Pack to pack the delivery lines into
a container.
Call WSH_DELIVERIES_PUB.Delivery_Action API to ship confirm the
delivery.
*/
x_msg_data OUT VARCHAR2) IS
/*
--Standard Parameters.
p_api_version_number NUMBER;
init_msg_list VARCHAR2(30);
x_msg_details VARCHAR2(3000);
x_msg_summary VARCHAR2(3000);
p_validation_level NUMBER;
p_commit VARCHAR2(30);
--Parameters for WSH_DELIVERY_DETAILS_PUB.Update_Shipping_Attributes.
source_code VARCHAR2(15);
changed_attributes
WSH_DELIVERY_DETAILS_PUB.ChangedAt
tributeTabType;
--Parameters for WSH_CONTAINER_PUB.Auto_Pack.
p_entity_tab
WSH_UTIL_CORE.id_tab_type;
p_entity_type VARCHAR2(30);
p_group_id_tab
p_pack_cont_flag varchar2(30);
x_cont_inst_tab
--Parameters for WSH_FREIGHT_COSTS_PUB.Create_Update_Freight_Costs.
action_code VARCHAR2(15);
pub_freight_costs
WSH_FREIGHT_COSTS_PUB.PubFreightCo
stRecType;
freight_cost_id NUMBER;
--Parameters for WSH_DELIVERIES_PUB.Delivery_Action.
p_action_code VARCHAR2(15);
p_delivery_id NUMBER;
p_delivery_name VARCHAR2(30);
p_asg_trip_id NUMBER;
p_asg_trip_name VARCHAR2(30);

p_asg_pickup_stop_id NUMBER;
p_asg_pickup_loc_id NUMBER;
p_asg_pickup_loc_code VARCHAR2(30);
p_asg_pickup_arr_date DATE;
p_asg_pickup_dep_date DATE;
p_asg_dropoff_stop_id NUMBER;
p_asg_dropoff_loc_id NUMBER;
p_asg_dropoff_loc_code VARCHAR2(30);
p_asg_dropoff_arr_date DATE;
p_asg_dropoff_dep_date DATE;
p_sc_action_flag VARCHAR2(10);
p_sc_close_trip_flag VARCHAR2(10);
p_sc_create_bol_flag VARCHAR2(10);
p_sc_stage_del_flag VARCHAR2(10);
p_sc_trip_ship_method VARCHAR2(30);
p_sc_actual_dep_date VARCHAR2(30);
p_sc_report_set_id NUMBER;
p_sc_report_set_name VARCHAR2(60);
p_wv_override_flag VARCHAR2(10);
x_trip_id VARCHAR2(30);
x_trip_name VARCHAR2(30);
/*Handle exceptions*/
fail_api EXCEPTION;
BEGIN
/* Initialize return status*/

x_return_status := WSH_UTIL_CORE.G_RET_STS_SUCCESS;
Call this procedure to initialize applications parameters. To determine

parameter values, refer to the Application Parameter Initialization
section of this chapter.*/
FND_GLOBAL.APPS_INITIALIZE(user_id => 1001594
,resp_id =>52892
,resp_appl_id =>660);
/* Values for updating delivery details to ship all quantities in the

first line, stage everything in the second line, and back order all in
the third. It is assumed that the user knows the quantities in each
line.
*/
source_code := 'OE'; -- The only source code that should be used by the
API
changed_attributes(1).delivery_detail_id := 13431; -- Ship All
quantities in this detail.
changed_attributes(1).shipped_quantity := 1;
changed_attributes(2).source_line_id := 13432; -- Back Order All in
this -- detail.
changed_attributes(2).cycle_count_quantity := 2;
changed_attributes(3).source_line_id := 13433; -- Stage All in this
detail.
changed_attributes(3).cycle_count_quantity := 0;
--Call to WSH_DELIVERY_DETAILS_PUB.Update_Shipping_Attributes.
WSH_DELIVERY_DETAILS_PUB.Update_Shipping_Attributes(
p_api_version_number => 1.0,
p_init_msg_list => init_msg_list,
p_commit => p_commit,
x_return_status => x_return_status,
x_msg_count => x_msg_count,
x_msg_data => x_msg_data,
p_changed_attributes => changed_attributes,

p_source_code => source_code);
if (x_return_status <> WSH_UTIL_CORE.G_RET_STS_SUCCESS) then

raise fail_api;
end if;
/* Values for creating freight costs for the delivery created for the
above delivery details. The delivery can be queried for the respective
delivery detail through wsh_delivery_assignments.
*/
pub_freight_costs.freight_cost_typ := 1;
e_id
pub_freight_costs.unit_amount := 20;
pub_freight_costs.currency_code := 'USD';
pub_freight_costs.delivery_id := 5341;
--Call to WSH_FREIGHT_COSTS_PUB.Create_Update_Freight_Costs.
WSH_FREIGHT_COSTS_PUB.Create_Update_Freight_Costs(
p_pub_freight_costs => pub_freight_costs,
p_action_code => 'CREATE',
x_freight_cost_id => freight_cost_id);
raise fail_api;
end if;
/* Values for autopacking the delivery details to a container.
*/
p_entity_tab(1) := 13431;
--Call to WSH_CONTAINER_PUB.Auto_Pack
WSH_CONTAINER_PUB.Auto_Pack(
p_api_version => 1.0,
p_validation_level => p_validation_level,
p_entity_tab => p_entity_tab,
p_entity_type => 'L',
p_group_id_tab => p_group_id_tab,
p_pack_cont_flag => p_pack_cont_flag,
x_cont_inst_tab => x_cont_inst_tab);

raise fail_api;
end if;
/* Values for Ship Confirming the delivery.

*/
p_action_code := 'CONFIRM'; -- The action code

for ship confirm
p_delivery_id := 5341; -- The delivery that

needs to be confirmed

p_delivery_name := '5341'; -- The delivery name,
p_sc_action_flag := 'S'; -- Ship entered quantity.
p_sc_close_trip_flag := 'Y'; -- Close the trip after

ship confirm
p_sc_trip_ship_method := 'GROUND'; -- The ship method

code
-- Call to WSH_DELIVERIES_PUB.Delivery_Action.
WSH_DELIVERIES_PUB.Delivery_Action(
p_action_code => p_action_code,
p_delivery_id => p_delivery_id,
p_delivery_name => p_delivery_name,
p_asg_trip_id => p_asg_trip_id,
p_asg_trip_name => p_asg_trip_name,
p_asg_pickup_stop_id => p_asg_pickup_stop_id,
p_asg_pickup_loc_id => p_asg_pickup_loc_id,
p_asg_pickup_loc_code => p_asg_pickup_loc_code,
p_asg_pickup_arr_date => p_asg_pickup_arr_date,
p_asg_pickup_dep_date => p_asg_pickup_dep_date,
p_asg_dropoff_stop_id => p_asg_dropoff_stop_id,
p_asg_dropoff_loc_id => p_asg_dropoff_loc_id,
p_asg_dropoff_loc_code => p_asg_dropoff_loc_code,
p_asg_dropoff_arr_date => p_asg_dropoff_arr_date,
p_asg_dropoff_dep_date => p_asg_dropoff_dep_date,
p_sc_action_flag => p_sc_action_flag,
p_sc_close_trip_flag => p_sc_close_trip_flag,
p_sc_create_bol_flag => p_sc_create_bol_flag,
p_sc_stage_del_flag => p_sc_stage_del_flag,
p_sc_trip_ship_method => p_sc_trip_ship_method,
p_sc_actual_dep_date => p_sc_actual_dep_date,
p_sc_report_set_id => p_sc_report_set_id,
p_sc_report_set_name => p_sc_report_set_name,
p_wv_override_flag => p_wv_override_flag,
x_trip_id => x_trip_id,
x_trip_name => x_trip_name);

raise fail_api;
end if;
exception
when fail_api then

WSH_UTIL_CORE.get_messages('Y', x_msg_summary, x_msg_details,
x_msg_count);
if x_msg_count > 1 then
x_msg_data := x_msg_summary || x_msg_details;
else
x_msg_data := x_msg_summary;
end if;
END SHIP_CONFIRM_EXAMPLE1;
/**Example 2
This procedure is used as an example to ship confirm delivery details
that were not assigned to a delivery.
Call WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY to create a new delivery.

Call WSH_DELIVERY_DETAILS_PUB.Detail_to_Delivery to assign the delivery
details to the new delivery.
Call WSH_DELIVERIES_PUB.Delivery_Action to ship confim.
**/
-- Standard Parameters.
p_api_version_number NUMBER;
init_msg_list VARCHAR2(30);
commit VARCHAR2(30);
-- Parameters for WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY
action_code VARCHAR2(15);
delivery_id NUMBER;
delivery_info WSH_DELIVERIES_PUB.Delivery_Pub_Re
c_Type;
name VARCHAR2(30);
-- Parameters for WSH_DELIVERY_DETAILS_PUB.Detail_to_Delivery
delivery_name VARCHAR2(30);
p_TabOfDelDet WSH_DELIVERY_DETAILS_PUB.id_tab_ty
pe;
p_action VARCHAR2(30);
-- Parameters for WSH_DELIVERIES_PUB.Delivery_Action.
p_delivery_name VARCHAR2(30);
p_asg_trip_id NUMBER;
p_asg_trip_name VARCHAR2(30);
p_asg_pickup_stop_id NUMBER;
p_asg_pickup_loc_id NUMBER;
p_asg_pickup_loc_code VARCHAR2(30);
p_asg_pickup_arr_date DATE;
p_asg_pickup_dep_date DATE;
p_asg_dropoff_stop_id NUMBER;

p_asg_dropoff_loc_id NUMBER;
p_asg_dropoff_loc_code VARCHAR2(30);
p_asg_dropoff_arr_date DATE;
p_asg_dropoff_dep_date DATE;
p_sc_action_flag VARCHAR2(10);
p_sc_close_trip_flag VARCHAR2(10);
p_sc_create_bol_flag VARCHAR2(10);
p_sc_stage_del_flag VARCHAR2(10);
p_sc_trip_ship_method VARCHAR2(30);
p_sc_actual_dep_date VARCHAR2(30);
p_sc_report_set_id NUMBER;
p_sc_report_set_name VARCHAR2(60);
p_wv_override_flag VARCHAR2(10);
x_trip_id VARCHAR2(30);
x_trip_name VARCHAR2(30);
fail_api EXCEPTION;
BEGIN
-- Initialize return status
-- Values for WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY
-- Create a new delivery for the following
delivery_info.initial_pickup_locat := 204;
ion_id
delivery_info.ultimate_dropoff_loc := 840;
ation_id
delivery_info.gross_weight := 10;
delivery_info.ship_method_code := 'UPS';
p_action_code := 'CREATE';
-- Call to WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY
WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY(
x_return_status => return_status,
x_msg_count => msg_count,
x_msg_data => msg_data,
p_delivery_info => delivery_info,
p_delivery_name => delivery_name,
x_delivery_id => delivery_id,
x_name => name );

raise fail_api;
end if;
p_delivery_id := delivery_id;
pub_freight_costs.delivery_id := delivery_id;
-- Values for WSH_DELIVERY_DETAILS_PUB.Detail_to_Delivery

-- Call Detail_to_Delivery with an action code of ASSIGN to
assign details to a

-- delivery.
p_TabOfDelDets(1) := 13463;
p_TabOfDelDets(2) := 13464;
p_action := 'ASSIGN';
-- Call to WSH_DELIVERY_DETAILS_PUB.Detail_to_Delivery.
WSH_DELIVERY_DETAILS_PUB.Detail_to_Delivery(
p_api_version => 1.0,
p_commit => commit,
p_validation_level => p_validation_level,
x_return_status => return_status,
x_msg_count => msg_count,
x_msg_data => msg_data,
p_TabOfDelDets => p_TabOfDelDets,
p_action => p_action,
p_delivery_name => delivery_name);

raise fail_api;
end if;
-- Values for Ship Confirming the delivery.
p_action_code := 'CONFIRM'; -- The action code

for ship confirm
p_delivery_id := 5341; -- The delivery that

needs to be confirmed
p_delivery_name := '5341'; -- The delivery name,
p_sc_action_flag := 'S'; -- Ship entered quantity.
p_sc_close_trip_flag := 'Y'; -- Close the trip after

ship confirm
p_sc_trip_ship_method := 'UPS'; -- The ship method code
-- Call to WSH_DELIVERIES_PUB.Delivery_Action.
p_delivery_name => p_delivery_name,
p_asg_trip_id => p_asg_trip_id,
p_asg_trip_name => p_asg_trip_name,
p_asg_pickup_stop_id => p_asg_pickup_stop_id,
p_asg_pickup_loc_id => p_asg_pickup_loc_id,
p_asg_pickup_loc_code => p_asg_pickup_loc_code,
p_asg_pickup_arr_date => p_asg_pickup_arr_date,
p_asg_pickup_dep_date => p_asg_pickup_dep_date,
p_asg_dropoff_stop_id => p_asg_dropoff_stop_id,
p_asg_dropoff_loc_id => p_asg_dropoff_loc_id,

p_asg_dropoff_loc_code => p_asg_dropoff_loc_code,
p_asg_dropoff_arr_date => p_asg_dropoff_arr_date,
p_asg_dropoff_dep_date => p_asg_dropoff_dep_date,
p_sc_action_flag => p_sc_action_flag,
p_sc_close_trip_flag => p_sc_close_trip_flag,
p_sc_create_bol_flag => p_sc_create_bol_flag,
p_sc_stage_del_flag => p_sc_stage_del_flag,
p_sc_trip_ship_method => p_sc_trip_ship_method,
p_sc_actual_dep_date => p_sc_actual_dep_date,
p_sc_report_set_id => p_sc_report_set_id,
p_sc_report_set_name => p_sc_report_set_name,
p_wv_override_flag => p_wv_override_flag,
x_trip_id => x_trip_id,
x_trip_name => x_trip_name);
raise fail_api;
end if;
exception
when fail_api then

x_msg_count);
else
end if;
END SHIP_CONFIRM_EXAMPLE2;
/** Example 3:
This procedure can be used as an example on how to pick and ship confirm
a delivery in a single process.
Call WSH_DELIVERIES_PUB.DELIVERY_ACTION for the delivery to pick and

ship confirm the delivery in a single process.
**/
p_init_msg_list VARCHAR2(30) ;
-- Parameters for WSH_DELIVERIES_PUB.DELIVERY_ACTION
p_delivery_name VARCHAR2(2000) ;

p_asg_trip_id NUMBER ;
p_asg_trip_name VARCHAR2(2000) ;
p_asg_pickup_stop_id NUMBER ;
p_asg_pickup_loc_id NUMBER ;
p_asg_pickup_stop_seq NUMBER ;
p_asg_pickup_loc_code VARCHAR2(2000) ;
p_asg_pickup_arr_date DATE ;
p_asg_pickup_dep_date DATE ;
p_asg_dropoff_stop_id NUMBER ;
p_asg_dropoff_loc_id NUMBER ;
p_asg_dropoff_stop_seq NUMBER ;
p_asg_dropoff_loc_code VARCHAR2(2000) ;
p_asg_dropoff_arr_date DATE ;
p_asg_dropoff_dep_date DATE ;
p_sc_action_flag VARCHAR2(2000) ;
p_sc_intransit_flag VARCHAR2(2000) ;
p_sc_close_trip_flag VARCHAR2(2000) ;
p_sc_create_bol_flag VARCHAR2(2000) ;
p_sc_stage_del_flag VARCHAR2(2000) ;
p_sc_trip_ship_method VARCHAR2(2000) ;
p_sc_actual_dep_date DATE ;
p_sc_report_set_id NUMBER ;
p_sc_report_set_name VARCHAR2(2000) ;
p_sc_defer_interface_flag VARCHAR2(2000) ;
p_sc_send_945_flag VARCHAR2(2000) ;
p_sc_rule_id NUMBER ;
p_sc_rule_name VARCHAR2(2000) ;
p_wv_override_flag VARCHAR2(2000) ;
x_trip_id VARCHAR2(2000) ;
x_trip_name VARCHAR2(2000) ;
fail_api EXCEPTION;
Begin

/* Call this procedure to initialize applications parameters. To

determine parameter values, refer to the Application Paramater
Initialization section of this chapter. */
,resp_id =>52892
-- Values for WSH_DELIVERIES_PUB.DELIVERY_ACTION

-- Pick and Ship the delivery in a single step
p_action_code := 'PICK-SHIP';
p_delivery_id := 176120;
-- Call to WSH_DELIVERIES_PUB.DELIVERY_ACTION
p_api_version_number => 1.0
,p_init_msg_list => p_init_msg_list
,x_return_status => x_return_status
,x_msg_count => x_msg_count
,x_msg_data => x_msg_data
,p_action_code => p_action_code

,p_delivery_id => p_delivery_id
,p_delivery_name => p_delivery_name
,p_asg_trip_id => p_asg_trip_id
,p_asg_trip_name => p_asg_trip_name
,p_asg_pickup_stop_id => p_asg_pickup_stop_id
,p_asg_pickup_loc_id => p_asg_pickup_loc_id
,p_asg_pickup_stop_seq => p_asg_pickup_stop_seq
,p_asg_pickup_loc_code => p_asg_pickup_loc_code
,p_asg_pickup_arr_date => p_asg_pickup_arr_date
,p_asg_pickup_dep_date => p_asg_pickup_dep_date
,p_asg_dropoff_stop_id => p_asg_dropoff_stop_id
,p_asg_dropoff_loc_id => p_asg_dropoff_loc_id
,p_asg_dropoff_stop_seq => p_asg_dropoff_stop_seq
,p_asg_dropoff_loc_code => p_asg_dropoff_loc_code
,p_asg_dropoff_arr_date => p_asg_dropoff_arr_date
,p_asg_dropoff_dep_date => p_asg_dropoff_dep_date
,p_sc_action_flag => p_sc_action_flag
,p_sc_intransit_flag => p_sc_intransit_flag
,p_sc_close_trip_flag => p_sc_close_trip_flag
,p_sc_create_bol_flag => p_sc_create_bol_flag
,p_sc_stage_del_flag => p_sc_stage_del_flag
,p_sc_trip_ship_method => p_sc_trip_ship_method
,p_sc_actual_dep_date => p_sc_actual_dep_date
,p_sc_report_set_id => p_sc_report_set_id
,p_sc_report_set_name => p_sc_report_set_name
,p_sc_defer_interface_flag => p_sc_defer_interface_flag
,p_sc_send_945_flag => p_sc_send_945_flag
,p_sc_rule_id => p_sc_rule_id
,p_sc_rule_name => p_sc_rule_name
,p_wv_override_flag => p_wv_override_flag
,x_trip_id => x_trip_id
,x_trip_name => x_trip_name
);

raise fail_api;
end if;
exception
when fail_api then

x_msg_count);
else
end if;
End SHIP_CONFIRM_EXAMPLE3;
/** Example 4:
This procedure can be used as an example on how to update serial numbers
for a delivery detail.
Call WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES to update
serial numbers for a delivery detail.
**/
procedure UPDATE_SERIAL_EXAMPLE(
x_msg_data OUT VARCHAR2)IS

-- Parameters for WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES

(Overloaded)
p_changed_attributes WSH_DELIVERY_DETAILS_PUB.CHANGEDAT
TRIBUTETABTYPE ;
p_source_code VARCHAR2(2000);
p_container_flag VARCHAR2(2000) ;
p_serial_range_tab WSH_GLBL_VAR_STRCT_GRP.ddSerialRan
geTabType;
fail_api EXCEPTION;
Begin


determine parameter values,refer to the Application Paramater

,resp_id =>52892
-- Values for WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES

p_source_code := 'OE';
p_changed_attributes(1).delivery_detail_id := 320484;
p_changed_attributes(1).shipped_quantity := 10;
p_serial_range_tab(1).delivery_detail_id := 320484 ;
p_serial_range_tab(1).from_serial_number := 'A01';
p_serial_range_tab(1).to_serial_number := 'A10';
p_serial_range_tab(1).quantity := 10;
-- Call to WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES
WSH_DELIVERY_DETAILS_PUB.UPDATE_SHIPPING_ATTRIBUTES(
p_api_version_number => 1.0
,p_commit => p_commit
,p_changed_attributes => p_changed_attributes
,p_source_code => p_source_code
,p_container_flag => p_container_flag
,p_serial_range_tab => p_serial_range_tab
);
if (l_x_return_status <> WSH_UTIL_CORE.G_RET_STS_SUCCESS) then

raise fail_api;
end if;
exception
when fail_api then

x_msg_count);
else
end if;
End UPDATE_SERIAL_EXAMPLE;
/** Example 5:
This procedure can be used as an example on how to create a container

and then manually pack a delivery detail.
Call WSH_CONTAINER_PUB.CREATE_CONTAINERS API to create container(s)
Call WSH_CONTAINER_PUB. CONTAINER_ACTIONS to pack the delivery lines
into the container.
**/
procedure MANUAL_PACK_EXAMPLE (

x_msg_data OUT VARCHAR2)IS
-- Parameters for WSH_CONTAINER_PUB.CREATE_CONTAINERS
p_container_item_id NUMBER;
p_container_item_name VARCHAR2(2000) ;
p_container_item_seg FND_FLEX_EXT.SEGMENTARRAY ;
p_organization_id NUMBER;
p_organization_code VARCHAR2(2000) ;
p_name_prefix VARCHAR2(2000) ;
p_name_suffix VARCHAR2(2000) ;
p_base_number NUMBER ;
p_num_digits NUMBER ;
p_quantity NUMBER ;
p_container_name VARCHAR2(2000) ;
x_container_ids WSH_UTIL_CORE.ID_TAB_TYPE ;
-- Parameters for WSH_CONTAINER_PUB.CONTAINER_ACTIONS
p_detail_tab WSH_UTIL_CORE.ID_TAB_TYPE ;
p_container_name VARCHAR2(2000);
p_cont_instance_id NUMBER ;
p_container_flag VARCHAR2(2000) ;
p_delivery_flag VARCHAR2(2000) ;
p_delivery_id NUMBER ;
p_delivery_name VARCHAR2(2000) ;
fail_api EXCEPTION;
Begin

determine parameter values, refer to the Application Paramater

,resp_id =>52892
-- Values for WSH_CONTAINER_PUB.CREATE_CONTAINERS

p_container_item_id := 4556;
p_organization_id := 207;
p_quantity number := 1
-- Call to WSH_CONTAINER_PUB.CREATE_CONTAINERS
WSH_CONTAINER_PUB.CREATE_CONTAINERS(
p_api_version => 1.0
,p_validation_level => p_validation_level

,p_container_item_id => p_container_item_id
,p_container_item_name => p_container_item_name
,p_container_item_seg => p_container_item_seg
,p_organization_id => p_organization_id
,p_organization_code => p_organization_code
,p_name_prefix => p_name_prefix
,p_name_suffix => p_name_suffix
,p_base_number => p_base_number
,p_num_digits => p_num_digits
,p_quantity => p_quantity
,p_container_name => p_container_name
,x_container_ids => x_container_ids
);

raise fail_api;
end if;
/*Get the container id (X_CONTAINER_IDS) generated by CREATE_CONTAINER
API then run CONTAINER_ACTIONS to Pack it in the generated container.*/
-- Values for WSH_CONTAINER_PUB.CONTAINER_ACTIONS

p_container_name := X_CONTAINER_IDS(1); --Container_name
p_action_code := 'PACK'
p_detail_tab(1) := 320496; --Delivery detail to be packed
-- Call to WSH_CONTAINER_PUB.CONTAINER_ACTIONS
WSH_CONTAINER_PUB.CONTAINER_ACTIONS(
p_api_version => 1.0
,p_validation_level => p_validation_level
,p_detail_tab => p_detail_tab
,p_container_name => p_container_name
,p_cont_instance_id => p_cont_instance_id
,p_container_flag => p_container_flag
,p_delivery_flag => p_delivery_flag
,p_delivery_id => p_delivery_id
,p_delivery_name => p_delivery_name
,p_action_code => p_action_code
);
if (l_x_return_status <> WSH_UTIL_CORE.G_RET_STS_SUCCESS) then

raise fail_api;
end if;
exception
when fail_api then

x_msg_count);
else
end if;
End MANUAL_PACK_EXAMPLE;
END WSH_SHIP_API;
/
--show errors package body WSH_SHIP_API;
--COMMIT;
Script

set serveroutput on
Declare
x_return_status VARCHAR2(15);
x_msg_count NUMBER;
x_msg_data VARCHAR2(3000);
Begin
WSH_SHIP_API.SHIP_CONFIRM_EXAMPLE1(
x_return_status => x_return_status;
x_msg_count => x_msg_count;
x_msg_data => x_msg_data);
dbms_output.put_line('The return status:'|| x_return_status);

dbms_output.put_line(x_msg_data);
End;
13
Oracle Shipping Execution XML
Transactions

• XML Overview
• Oracle XML Gateway Setup
• Using XML Messaging with Carrier Manifesting
• Using XML Messaging with Third Party Warehousing
• Using XML Messaging with International Trade Management
XML Overview
XML messaging is used to transact data between Oracle Shipping Execution and
trading partners, including carrier manifesting systems and third party warehouses. In
order to use XML messaging for Oracle Shipping Execution transactions, the following
are required:
• Oracle XML Gateway setup, including Advanced Queuing, is required .
(See: Oracle XML Gateway User's Guide.)
• Oracle Workflow must be used to move the XML data from and to Oracle Shipping
Execution. Workflows are seeded as part of Oracle Applications.
(See: Oracle Workflow User's Guide.)
• Business events must be subscribed to by each application using Oracle Workflow

in order to move the XML data. Business events are seeded as part of Oracle
Applications.
(See: Oracle Workflow User's Guide.)
Each Oracle Shipping Execution function that uses XML transactions requires
Oracle Shipping Execution XML Transactions 13-1

additional setup in Oracle XML Gateway, where trading partners must be defined.
The following graphic represents the Oracle XML transaction flow, including Oracle
Workflow and Oracle XML Gateway.
XML Messaging Process
Oracle XML Gateway Setup

Oracle XML Gateway is a set of services that enables integration with Oracle
Applications to support XML messaging. Open Applications Group (OAG) Data Type
Definitions (DTDs) are used to map the XML messages. These DTDs are modified to
meet Oracle-specific requirements and are seeded within the Oracle XML Gateway. You
select the DTDs (or Maps in the Trading Partner Setup window) and assign them to
each transaction during the trading partner setup.
Oracle XML Gateway processes events raised by the Oracle Applications and subscribes
to inbound events for processing. Oracle XML Gateway uses Oracle Advanced Queuing
to integrate with the Oracle Transport Agent to deliver messages to and receive
messages from other applications.
Any application that receives XML messages from Oracle Shipping Execution or sends
XML messages to Oracle Shipping Execution must be defined as a trading partner
within Oracle XML Gateway.
You select XML transactions and enable them for each trading partner during the
trading partner setup.
Code conversions are also seeded and defined in Oracle XML Gateway. Code
conversions enable you to effectively communicate with trading partners by converting
your codes (such as TON) into your trading partners' codes (such as TONS) by
cross-referencing the codes.
As part of XML Gateway setup, Advanced Queuing is defined for the following:
• For outbound messages: A Queue is defined to hold complete XML messages
created by Oracle XML Gateway. An XML message is picked up by the
middleware, and then transmitted.
• For inbound messages: A Queue is defined to hold inbound XML messages that
have no errors.
• For inbound messages: A Queue is defined to hold inbound XML error information.
Trading Partners
You must define trading partners in Oracle XML Gateway before their XML
transactions can be processed. A trading partner is an entity (such as a customer,
supplier, carrier, or internal organization) with which you exchange XML messages.
Because a given entity may have several locations, you must define one trading partner
for each entity location (that is, one trading partner for each customer address, supplier
site, or carrier location).
Trading Partner data is used to:
• Link a particular address location in Oracle Applications to the trading partner
definition in the Oracle XML Gateway.
• Provide a means of telling the Execution Engine which trading partner message
map to use.
Note: A message map represents the relationship between the DTD

and the XML message.
• Enable specific transactions for trading partners
• Determine how to deliver the message
Related Topics
Code Conversions
reference the codes defined in Oracle Applications, for example Unit of Measure, to
codes used by trading partners, the XML standard, or other standard codes in the
transactions.
For example, assume that Business World transmits a manifest to the XYZ Corporation
and one of the values used is EACH. The XYZ Corporation processes the incoming data
using its own values and instead of using EACH, XYZ uses EA. However, XYZ is

required to return the information to Business World using Business World's code
values. Business World receives the response transactions with their own values based
on the code conversion in Oracle XML Gateway. The value EA is converted to EACH
when the data is received by Business World.
Oracle Applications provides seeded code conversion categories. The following seeded
code conversion categories are provided to support the seeded code conversions:
• INVENTORY_ITEM
• UOM
• CUSTOMER_ITEM
• FOB
• SHIPMENT_PRIORITY
• CURRENCY_CODE
• CHARGE_TYPE
• WSH_SUBINVENTORY
• CARRIER_CODE
• CONTAINER_TYPE
• CUSTOMER_LOCATION_CODE
• FREIGHT_TERMS
• SERVICE_LEVEL
• WAREHOUSE_LOCATION_CODE
• WAREHOUSE_ORG
• WSH_TRANS_METHOD
Related Topics
Using XML Messaging with Carrier Manifesting

Oracle Shipping Execution enables you to send XML messages to carrier manifesting
systems. These transactions contain delivery details to determine freight costs and to
print the required labels and paperwork. You can manually or automatically extract the
delivery details and send them to a manifesting system. Once the carrier manifesting
system responds, the delivery is automatically confirmed in Oracle Shipping Execution.
Before using XML messages for carrier manifesting, you must:
• Define your carriers (See: Oracle Order Management Implementation Guide)
• Enable manifesting for your carriers
• Enable manifesting for your organization
• Define your carrier manifesting system as a trading partner
• Define your organization as a trading partner
The following business events are used for carrier manifesting XML transactions:
• oracle.apps.wsh.sup.ssro: Business event to send the Shipment Request Outbound
• oracle.apps.wsh.sup.ssai: Business event to receive the Shipment Advice Inbound
The XML transactions used for carrier manifesting are:

• ShowShipment Request for outbound messages
• ShowShipment Advice for inbound messages
ShowShipment Request Transaction for Carrier Manifesting

Show Shipment Request transaction (the XML equivalent of the ASC X12 940
transaction) is a modified version of the Open Applications Group (OAG) document
type definition (DTD) show_shipment_005. This DTD is used to send shipment
information from Oracle Shipping Execution to a carrier manifest system.
These transactions contain information such as:
• Delivery Name
• Customer
• Ship To Address
• Ship To Contact
• Requested Pick Up Date and Time
• Requested Delivery Date and Time
• Weight

• Carrier
• Service Level
ShowShipment Request for Carrier Manifesting
ShowShipment Advice Transaction for Carrier Manifesting

Show Shipment Advice transaction (the XML equivalent of the ASC X12 945
transaction) is a modified version of the OAG DTD show_shipment_005. This DTD is
used to send shipment information from a carrier manifest system to Oracle Shipping
Execution.
The ShowShipment Advice transaction supplies the actual carrier and service level used
for the shipment, the tracking numbers assigned to the shipment or packages on the
shipment, and the total weight, among other information.
ShowShipment Advice (show_shipment_005) for Carrier Manifesting
Defining Trading Partners for Carrier Manifesting

All organizations that send and receive XML transactions as part of carrier manifesting
within Oracle Shipping Execution, must be defined as trading partners.
Trading partners are defined in Oracle XML Gateway.
To define organizations as trading partners to generate and send outbound messages:
1. Log into the Oracle applications using the XML Gateway responsibility.
2. Navigate to the Trading Partner Setup window.
3. Select Internal from the list of values in the Trading Partner Type field.
4. Select the organization's location code using the list of values in the Trading Partner
Name field.
5. Select the concatenated address of the organization's location from the list of values
in the Trading Partner Site field.
6. Enter the email address in the Company Admin Email field.
7. In the Trading Partner Details region, use the list of values in the Transaction Type
field to choose FTE with the Transaction Sub Type of SSNO.
8. Use the list of values to select WSH_SSNO_OAG721_OUT in the Map field.
9. In the Connection/Hub field, select Direct or select a Hub through which to

communicate with the carrier manifesting application.
Note: A DIRECT connect and a hub are the methods by which the

message can be communicated. The XML message can be sent
directly to a trading partner, or sent to a trading partner using a
hub. The hub then communicate the message to the trading
partner. Select DIRECT to conduct business directly with a trading
partner, or select a hub from the list of values. If a hub is selected,
then select a trading partner from that hub.
See: Oracle XML User's Guide

If you choose to connect to a carrier manifesting application using Direct, the XML
Gateway will require that you provide information in the following fields:
• Protocol Type
• Username
• Password
• Protocol address
If you choose to connect to a carrier manifesting application using a hub, Oracle

XML Gateway will require that you select only a Username from the list of values.
The rest of the information will default based on the information entered during the
creation of the hub.
See: Oracle XML Gateway User's Guide for detailed information on defining a hub.
The Connection/Hub field is only required when the direction of the XML is OUT.
10. Enter a Source Trading Partner Location Code.
Note: If you are using a predefined hub, the Source Trading Partner
Location Code is automatically populated.
11. Save your work.
12. Click Code Conversion to define new code conversions.
See: Oracle XML Gateway User's Guide for detailed information on defining code
conversions.
Note: Code conversion categories are seeded. These include OAG

and Oracle standard code conversions.
To define organizations as trading partners to receive inbound messages:

4. Select the organization's location using the list of values in the Trading Partner
Name field.
5. Select the organization location's address from the list of values in the Trading
Partner Site field.
field to choose FTE with the Transaction Sub Type of SSNI.
8. Use the list of values to select WSH_SSNI_OAG721_IN in the Map field.
10. Save your work.
conversions.

To define Transaction Type for Confirm Business Object Document (CBOD)

1. Start a new Trading Partner Detail line.
2. Use the list of values in the Transaction Type field to select ECX with External
Transaction Type of BOD, Transaction Subtype as Confirm, and the Direction IN.
3. Use the list of values to select ECX_CBODI_OAG72_IN_CONFIRM in the Map

field.
4. Enter source partner location code.

The source partner location code is identical to the source partner location code
specified in the setup for outbound transactions.
5. Save your work.

Overview of XML and DTD for Carrier Manifesting
The following contains a sample DTD and a sample XML used for carrier manifesting in
Oracle Shipping Execution . Also, a table is available that displays all required
element/attributes, a description of each, and the Oracle table and column for each
element/attribute, where applicable.
Document Type Definition (DTD) for Carrier Manifesting

The following is the DTD used for carrier manifesting in Oracle Shipping Execution.
Carrier Manifesting DTD
<! - ==================================================== - >
<!ENTITY % RESOURCES SYSTEM "oagis_resources.dtd">
%RESOURCES;
<! - ==================================================== - >
<!ELEMENT SHOW_SHIPMENT_005 (CNTROLAREA, DATAAREA+)>
<!ATTLIST VERB
value CDATA #FIXED "SHOW">
<!ATTLIST NOUN
value CDATA #FIXED "SHIPMENT">
<!ATTLIST REVISION
value CDATA #FIXED "005">
<!ELEMENT DATAAREA (SHOW_SHIPMENT)>
<!ELEMENT SHOW_SHIPMENT (SHIPMENT, SHIPUNIT*)>
<!ELEMENT SHIPMENT ((%DATETIME.DOCUMENT;), (%AMOUNT.DECLAREVAL;)?,
(%AMOUNT.DOCUMENT.T;)?, (%AMOUNT.ESTFREIGHT;)?, (%AMOUNT.FREIGHT.T;)?,
(%AMOUNT.ITEM.T;)?, (%DATETIME.CREATION;)?, (%DATETIME.DELIVACT;)?,
(%DATETIME.DELIVSCHED;)?,(%DATETIME.EARLSTSHIP;)?,
(%DATETIME.LOADING;)?, (%DATETIME.NEEDDELV;)?, (%DATETIME.PROMDELV;)?,
(%DATETIME.PROMSHIP;)?, (%DATETIME.SHIP;)?, (%DATETIME.SHIPSCHED;)?,
(%OPERAMT.FREIGHT.T;)?, (%QUANTITY.ESTWEIGHT;)?,
(%QUANTITY.LOADINGWT;)?, (%QUANTITY.NETWEIGHT;)?,
(%QUANTITY.SHIPUNIT;)?, (%QUANTITY.TOTWEIGHT;)?, (%QUANTITY.VOLUME;)?,
(%TEMPRATURE.ACTUAL;)?, (%TEMPRATURE.DELIVERY;)?,
(%TEMPRATURE.LOADING;)?, DOCUMENTID, SHIPPERID, SYNCID, CARRIER?,
CARRSRVLVL?, COUNTRYDST?, COUNTRYORG?, DESCRIPTN?, DISTCENTER?, DOCKID?,
DOCTYPE?, DOCUMENTRV?, DROPSHIP?, EXPORTLIC?, FRGHTCLS?, FRGHTTERMS?,
HAZRDMATL?, HDRSTATUS?, IMPORTLIC?, LOADPOINT?, NOTES*, PARTIALSHP?,
PRIORITY?, ROUTEID?, SHIPNOTES?, SHIPPOINT?, SHIPPRIOR?, SHIPSRVLVL?,
SPECIALHND?, STAGEPOINT?, TRANSMETHD?, TRANSTERMS?, WAREHOUSE?,
USERAREA?, PARTNER+, SHIPITEM*, ATTCHREF*, CHARGE*, DOCUMNTREF*)>
<!ELEMENT SHIPITEM ((%QUANTITY.ITEM;), (%AMOUNT.EXTENDED.T;)?,
(%AMOUNT.ITEM.T;)?, (%QUANTITY.BACKORDERD;)?, (%QUANTITY.OPEN;)?,
(%QUANTITY.ORDERED;)?, (%QUANTITY.SHIPPED;)?, (%QUANTITY.VOLUME;)?,
(%QUANTITY.WEIGHT;)?, ITEM, COUNTRYORG?, DISPOSITN?, EXPORTLIC?,
FRGHTCLS?, FRGHTITEM?, HAZRDMATL?, IMPORTLIC?, ITEMDESC?, ITEMRV?,
ITEMRVX?, ITEMX?, LOTLEVEL*, NOTES*, OWNRSHPCDE?, PACKING?, PARTIALSHP?,
SHIPNOTES?, SHIPPRIOR?, UPC?, USERAREA?, DOCUMNTREF*, INVDETAIL*,
CHARGE*)
>
<!ELEMENT INVDETAIL ((%QUANTITY.ITEM;)?, DESCRIPTN?, DISPOSITN?,
LOTLEVEL*, NOTES*, SERIALNUM?, USERAREA?)
>
<!ELEMENT SHIPUNIT ((%AMOUNT.DECLAREVAL;)?, (%AMOUNT.FREIGHT.T;)?,
(%AMOUNT.ITEM.T;)?, (%AMOUNT.TOTAL.T;)?, (%DATETIME.DELIVACT;)?,
(%DATETIME.DELIVSCHED;)?, (%DATETIME.LOADING;)?, (%DATETIME.SHIP;)?,
(%OPERAMT.FREIGHT.T;)?, (%QUANTITY.ESTWEIGHT;)?, (%QUANTITY.HEIGHT;)?,
(%QUANTITY.LENGTH;)?, (%QUANTITY.LOADINGWT;)?, (%QUANTITY.NETWEIGHT;)?,
(%QUANTITY.TOTWEIGHT;)?, (%QUANTITY.VOLUME;)?, (%QUANTITY.WIDTH;)?,
(%TEMPRATURE.LOADING;)?, CARRIER, SHIPPERID, TRACKINGID, CARRSRVLVL?,
CONTAINRID?, CONTNRSEAL?, CONTNRTYPE?, COUNTRYDST?, COUNTRYORG?,
DESCRIPTN?, EXPORTLIC?, FRGHTCLS?, FRGHTITEM?, FRGHTTERMS?, HAZRDMATL?,
IMPORTLIC?, LOADPOINT?, NOTES*, SHIPMATLID?, SHIPNOTES?, SHIPPOINT?,
SHIPSRVLVL?, SHPMTLDESC?, SHPUNITSEQ?, SHPUNITSTS?, SHPUNITTOT?,
SPECIALHND?, STAGEPOINT?, TRANSMETHD?, TRANSTERMS?, USERAREA?, PARTNER+,
ATTCHREF*, CHARGE*, CONTAINER*, DOCUMNTREF*, INVITEM*)
>
<!ELEMENT CONTAINER (CONTAINRID?, CONTNRSEAL?, CONTNRTYPE?, DESCRIPTN?,

NOTES*, PACKING?, PACKNGDESC?, PARCNTNRID?, SHIPMATLID?, SHPMTLDESC?,
USERAREA?, DOCUMNTREF*, INVITEM*, CHARGE*)
>
<!ELEMENT INVITEM ((%QUANTITY.ITEM;), (%AMOUNT.EXTENDED.T;)?,
(%AMOUNT.ITEM.T;)?, (%QUANTITY.VOLUME;)?, (%QUANTITY.WEIGHT;)?, ITEM,
COUNTRYORG?, FRGHTCLS?, FRGHTITEM?, HAZRDMATL?, ITEMDESC?, ITEMRV?,
ITEMRVX?, ITEMX?, LOTLEVEL*, NOTES*, OWNRSHPCDE?, SHIPNOTES?, UPC?,
USERAREA?, DOCUMNTREF*, INVDETAIL*)>
@
115.1.11510.1
log
@'mkbranch'
@
text
@d1 1
a1 1
<! - $Header: 161_show_shipment_005.dtd 115.1 2002/03/28 22:47:30
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.1.1159.1
log
@mkbranch
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.1.1158.1
log
@mkbranch
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.0
log
@initial version
@
text
@d1 1
a1 1
rvishnuv noship $ - >
d6 2
a7 2
$Revision: 7.2.1 $
$Date: 31 October 2001 $
d11 1
a11 1
$Name: 161_show_shipment_005.dtd $
d22 1
a22 1
SHIPMENT ( PARTNER+, SHIPITEM+, ATTCHREF*, CHARGE*, DOCUMNTREF*,)
d59 1
a59 1
(%DATETIME.DELIVSCHED;)?, (%DATETIME.EARLSTSHIP;)?,
USERAREA?, PARTNER+, SHIPITEM+, ATTCHREF*, CHARGE*, DOCUMNTREF*)
@
Sample XML Transaction for Carrier Manifesting
Carrier Manifesting Sample XML

The following table lists each of the ShowShipment elements/attributes, whether they
are required or optional, and whether they are used for inbound, outbound, or both. A
sample OUTBOUND ShowShipment Request XML transaction for carrier manifesting
follows the table and a sample INBOUND ShowShipment Request XML transaction for
carrier manifesting follows the OUTBOUND sample.
The Required? column indicates whether the element/attribute is required or optional
for INBOUND (I), OUTBOUND (O), or BOTH (B).
Carrier Manifesting XML Field Information
Field Name Required? Transaction Description

Table.Column
CNTROL AREA Required (B) The fields included in

this area provide
information about the
XML document

Table.Column
BSR Required (B) Shows the Business

Service Request name
per OAGI
VERB Required (B) Value is SHOW
NOUN Required (B) Value is SHIPMENT
REVISION Required (B) Value is 006
SENDER Required (B) Provides information

on the system that
sends the document
LOGICALID Required (B) Sender system

identifier
COMPONENT Required (B) Sender application

name. Value is FTE
TASK Required Event or Action
REFERENCEID Required (B) Unique reference ID

for this document
CONFIRMATION Required (B) Confirmation when

document is received
LANGUAGE Required (B) Language in which

the text fields are
transmitted
CODEPAGE Required (B) Character set used in

this XML document
AUTHID Required (B) System ID of sender.

Value is APPS
DATETIME Required (B) Creation date and

(CREATION)(T) time of the XML
document
Table.Column
DATAAREA.SHOW_ Required (B) Contains the general

SHIPMENT.SHIPME document
NT information for goods
being transported to a
particular partner
destination
SHIPMENT.DATETT Required (B) Sys date time Contains date and

IME time stamp of the
latest update to the
XML document
SHIPMENT.DOCUM Required (B) WSH_TRANSACTIO Shipment document

ENTID (Shipment) NS_HISTORY.DOCU ID
MENT_ID
SHIPMENT.SHIPPER Required (B) LOCATION_CODE Ship From ID

ID from
HR_LOCATIONS_A
LL_TL based on the
WSH_NEW_DELIVE
RIES.INITIAL_PICK
UP_LOCATION_ID
SHIPMENT.SYNCID Required (B) XML: "A" = Add, "D"

= Delete
"C" = Change
EDI: "N" for Add, "F"

for Delete
EDI code conversions:

"N" for Add, "R" for
Change, "F" for
Cancel
SHIPMENT.AMOUN Not used Not used Not used

T (DECLAREVAL)

T (DOCUMENT) (T)

Table.Column

T (ESTFREIGHT)
SHIPMENT.AMOUN Optional (B) WSH_FREIGHT_COS Total freight charge

T (FREIGHT) (T) TS.TOTAL_AMOUN
T

T (ITEM) (T)
SHIPMENT.CARRIE Required (B) PARTY_NAME Carrier ID

R FROM HZ_PARTIES
based on the column
WSH_NEW_DELIVE
RIES.CARRIER_ID
SHIPMENT.CARRIE Optional (B) WSH_NEW_DELIVE Carrier service level

RSRVLVL RIES.SERVICE_LEVE
L
SHIPMENT.COUNT Required (O) WSH_NEW_DELIVE Destination country

RYDST RIES.
ULTIMATE_DROPO
FF_LOCATION_ID,
SHIPMENT.COUNT Not Used Not Used Not Used

RYORG
SHIPMENT.DATETI Required (O) WSH_NEW_DELIVE Creation date and

ME (CREATION) RIES.CREATION_DA time
TE
SHIPMENT.DATETI Optional (I) WSH_TRIP_STOPS.A Actual delivery date

ME (DELIVACT) CTUAL_ARRIVAL_D
ATE
SHIPMENT.DATETI Optional (B) WSH_NEW_DELIVE Delivery scheduled

ME (DELIVSCHED) RIES. date and time
.ULTIMATE_DROPO
FF_DATE
Table.Column
SHIPMENT.DATETI Not used Not used Not used

ME (EARLSTSHIP)

ME (LOADING)
SHIPMENT.DATETI Optional (O) WSH_NEW_DELIVE Date and time the

ME (NEEDDELV) RIES. delivery is needed
.ULTIMATE_DROPO
FF_DATE

ME (PROMDELV)

ME (PROMSHIP)
SHIPMENT.DATETI Optional (I) WSH_TRIP_STOPS.A Actual ship date/time

ME (SHIP) CTUAL_DEPARTUR
E_DATE
SHIPMENT.DATETI Optional (O) WSH_NEW_DELIVE Shipment scheduled

ME (SHIPSCHED) RIES.INITIAL_PICK date and time
UP_DATE
SHIPMENT.DESCRIP Optional (B) WSH_NEW_DELIVE Shipment description

TN RIES.DESCRIPTION
SHIPMENT.DISTCE Not used Not used Not used

NTER
SHIPMENT.DOCKID Not used Not used Not used
SHIPMENT.DOCTYP Required (B) 'SR' ( SHIPMENT The OAG document

E REQUEST FOR name
OUTBOUND) AND
'SA' (SHIMENT SR (SHIPMENT
ADVICE FOR REQUEST) outbound
INBOUND) at the transactions and SA
Supplier Instance. (SHIPMENT
ADVICE) for inbound
transactions

Table.Column
SHIPMENT.DOCUM Optional (B) Revision number of

ENTRV this document
'001' for 'Add' and

'002' for 'Delete'
SHIPMENT.DROPSH Not used Not used Not used

IP
SHIPMENT.EXPORT Not used Not used Not used

LIC
SHIPMENT.FRGHTC Not used Not used Not used

LS
SHIPMENT.FRGHTT Optional (B) WSH_NEW_DELIVE Describes how the

ERMS RIES.FREIGHT_TER freight cost for a
MS_CODE shipment of goods
should be billed
SHIPMENT.HAZRD Not used Not used Not used

MATL
SHIPMENT.HDRSTA Not used Not used Not used

TUS
SHIPMENT.IMPORT Not used Not used Not used

LIC
SHIPMENT.LOADP Not used Not used Not used

OINT
SHIPMENT.NOTES1 Not used Not used Not used

– NOTES9
SHIPMENT.PARTIA Not used Not used Not used

LSHP
SHIPMENT.PRIORIT Not used Not used Not used

Y
Table.Column
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE The estimated weight

TY (ESTWEIGHT) RIES.GROSS_WEIGH of an item or
T container
WSH_NEW_DELIVE
RIES.WEIGHT_UOM
_CODE
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE The net weight at the

TY (LOADINGWT) RIES.GROSS loading time of the
WEIGHT – container in which
WSH_NEW_DELIVE the materials are
RIES.NET WEIGHT being shipped
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE The net weight of the

TY (NETWEIGHT) RIES.NET_WEIGHT goods or materials
being shipped
WSH_NEW_DELIVE
RIES.WEIGHT_UOM
_CODE
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE This segment

TY (SHIPUNIT) RIES.NUMBER_OF_L contains the quantity
PN of units shipped. This
represents the
container(s), not the
product shipped. An
example of this is "4
truck loads" or "2
wooden crates".

TY (TOTWEIGHT) RIES.GROSS_WEIGH quantifies the total
T weight of an item, or
shipment
WSH_NEW_DELIVE
RIES.WEIGHT_UOM
_CODE

TY (VOLUME) RIES.VOLUME quantifies the
volume, or amount of
WSH_NEW_DELIVE space, that is
RIES.VOLUME_UO occupied by an item,
M_CODE container or shipment

Table.Column
SHIPMENT.ROUTEI Not used Not used Not used

D
SHIPMENT.RELEAS Not used Not used Not used

ENUM

ENUMTOT
SHIPMENT.ROUTET Not used Not used Not used

YPE
SHIPMENT.SHIPNO Optional (B) WSH_NEW_DELIVE This is a free form

TES RIES.SHIPPING_MA area that contains
RKS special instructions
SHIPMENT.SHIPPOI Optional (B) LOCATION FROM Indicates the ship to

NT HZ_CUST_SITE_USE location
S_ALL based on the
WSH_NEW_DELIVE
RIES.ULTIATE_DRO
POFF_LOCATION_I
D converted to code
SHIPMENT.SHIPPRI Not used Not used Not used

OR
SHIPMENT.SHIPSRV Optional (B) WSH_NEW_DELIVE Shipment service

LVL RIES.SHIP_SERVICE level
_LEVEL
SHIPMENT.SPECIAL Not used Not used Not used

HND
SHIPMENT.STAGEP Not used Not used Not used

OINT
SHIPMENT.TEMPRA Not used Not used Not used

TURE (ACTUAL)

TURE (DELIVERY)
Table.Column

TURE (LOADING)
SHIPMENT.TRANS Optional (B) WSH_NEW_DELIVE Identifies the general

METHD RIES.SHIP_MODE_O type of carrier
F_TRANSPORT transportation used to
deliver goods
SHIPMENT.TRANST Optional (B) WSH_NEW_DELIVE Ownership transfer

ERMS RIES.FOB_CODE terms
SHIPMENT.WAREH Optional (B) WSH_NEW_DELIVE The storage facility

OUSE RIES.ORGANIZATIO for inventory
N_ID converted to
code

Table.Column
SHIPMENT.USERAR Optional (B) WSH_NEW_DELIVE The USERAREA is

EA RIES.DELIVERY_NA defined by
ME (required) embedding elements
ORACLE.DELIVERY and attributes for
_NAME WSH_NEW_DELIVE each new Field
RIES.LOADING_SEQ Identifier or Segment
ORACLE.LOADING_ UENCE
SEQUENCE needed within the
WSH_TRIPS.VEHICL USERAREA. When a
ORACLE.VEHICLE_ E_NUM_PREFIX new Field Identifier
NUM_PREFIX or a new Segment is
WSH_TRIPS.VEHICL determined to be
ORACLE.VEHICLE_ E_NUMBER necessary, and it is
NUMBER not included in the
WSH_TRIPS.ROUTE_ OAGIS specification,
ORACLE.ROUTE_ID ID new tags can be
ORACLE.ROUTING_ WSH_TRIPS.ROUTI developed by the
INSTRUCTIONS NG_INSTRUCTIONS project team for the
specific integration
ORACLE.DEPARTU WSH_TRIP_STOPS.D project. These new
RE_SEAL_CODE EPARTURE_SEAL_C tags can then be used
ORACLE.ORIG_DOC ODE to describe the fields
ID and segments within
WSH_TRANSACTIO
the USERAREA. The
ORACLE.CUSTOME NS_HISTORY.ORIG_
USERAREA may
R_NAME DOCUMENT_NUMB
contain multiple
ER storing the parent
fields or segments
ORACLE.CUSTOME message's
coded in this way.
R_NUMBER DOCUMENTID
These are all
(Required for
ORACLE.WAYBILL embedded within the
Inbound)
one special field
ORACLE.INTMED_S HZ_PARTIES.PARTY called USERAREA.
HIP_TO_LOCATION _NAME based on the
ORACLE.MANUAL_ WSH_NEW_DELIVE
WV RIES.CUSTOMER_ID
ORACLE.SHIPMENT HZ_CUST_ACCOUN
_DIRECTION TS.ACCOUNT_NUM
BER based on the
ORACLE.OPERATO WSH_NEW_DELIVE
R RIES.customer_id
ORACLE.DESCRIPTI WSH_NEW_DELIVE
VE_FLEXFIELDS RIES.WAYBILL
LOCATION FROM
HZ_CUST_SITE_USE
Table.Column
S_ALL based on the

WSH_NEW_DELIVE
RIES.INTMED_SHIP_
TO_LOCATION_ID
WSH_NEW_DELIVE
RIES.WV_FROZEN_F
LAGWSH_NEW_DE
LIVERIES.SHIPMEN
T_DIRECTIONWSH_
TRIPS.OPERATOR
WSH_NEW_DELIVE
RY descriptive flex
fields
PARTNER. Required (O) This area is for the

partner information

Table.Column
PARTNER.NAME Required (O) If this partner Corporate name of a

segment is the Ship business entity in the
To segment, get the shipment address
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.ULTIMATE_DR
OPOFF_LOCATION_
ID
If this partner
segment is the Ship
from segment, get the
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.ORGANIZATIO
N_ID
If this partner
segment is the
Customer segment,
get the
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.CUSTOMER_ID
If this partner
segment is the
Supplier segment, get
the
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.ORGANIZATIO
N_ID
PARTNER.ONETIME Not used Not used Not used
Table.Column
PARTNER.PARTNRI Required (O) LOCATION FROM The partner ID

D HZ_CUST_SITE_USE
S_ALL based on
WSH_NEW_DELIVE
RIES.ULTIMATE_DR
OPOFF_LOCATION_
ID converted to
external value, or
LOCATION_CODE
FROM
HR_LOCATIONS_A
LL_TL based on
WSH_NEW_DELIVE
RIES.INITIAL_PICK
UP_LOCATION_ID
AND
ORGANIZATION_ID
converted to external
value.
PARTNER.PARTNRT Required (O) WSH_LOOKUPS.ME Indicates the type of

YPE ANING based on partner entity
lookup type =
'WSH_PARTNER_TY
PE' (Values are
'ShipFrom' or
'ShipTo')
PARTNER.ACTIVE Not used Not used Not used
PARTNER.DESCRIP Not used Not used Not used

TN
PARTNER.DUNSNU Not Used Not Used Not Used

MBER
PARTNER.GLENTIT Not Used Not Used Not Used

YS
PARTNER.NAME2- Not used Not used Not used

NAME9

Table.Column
PARTNER.PARENTI Not used Not used Not used

D
PARTNER.PARTNR Not used Not used Not used

RATG

ROLE
PARTNER.PAYMET Not used Not used Not used

HOD
PARTNER.TAXEXE Not used Not used Not used

MPT
PARTNER.TAXID Not used Not used Not used
PARTNER.TERMID Not used Not used Not used
PARTNER – Required (O) This area is for the

ADDRESS. partner address
information
PARTNER– Required (O) Extracted from the Partner address

ADDRESS.ADDRLIN WSH_LOCATIONS
E1-ADDRLINE9 using the location id
that matches the Ship
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Not used Not used Not used

ADDRESS.ADDRTYP
E
Table.Column
PARTNER– Required (O) Extracted from the Partner city

ADDRESS.CITY WSH_LOCATIONS
using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Required (O) Extracted from the Partner country

ADDRESS.COUNTR WSH_LOCATIONS
Y using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Optional (O) Extracted from the Partner county

ADDRESS.COUNTY WSH_LOCATIONS
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.

ADDRESS.DESCRIPT
N

Table.Column
PARTNER– Optional (O) HZ_CONTACT_POI Partner fax numbers

ADDRESS.FAX1-FAX NTS.RAW_PHONE_
9 NUMBER for the
PARTY_ID, and
CONTACT_POINT_T
YPE = "FAX" for "Ship
To" and
HR_LOCATIONS_A
LL.TELEPHONE_NU
MBER_2 for "Ship
From"
PARTNER– Required (O) Extracted from the Partner postal code

ADDRESS.POSTALC WSH_LOCATIONS
ODE using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Optional (O) Extracted from the Partner region

ADDRESS.REGION WSH_LOCATIONS
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Required (O) Extracted from the Partner state or

ADDRESS.STATEPR WSH_LOCATIONS province
OVN using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
Table.Column

ADDRESS.TAXJRSD
CTN
PARTNER– Required (O) HZ_CONTACT_POI Partner telephone

ADDRESS.TELEPHO NTS.RAW_PHONE_ numbers
NE1-TELEPHONE9 NUMBER for the
PARTY_ID, and
CONTACT_POINT_T
YPE = "GEN" for "
Ship To" and
HZ_LOCATIONS_A
LL.TELEPHONE_NU
MBER_1 for "Ship
From".
PARTNER– Optional (O) HZ_CONTACT_POI Partner web site URL

ADDRESS.URL NTS.URL for the
PARTY_ID and
CONTACT_POINT_T
YPE = "GEN" for "
Ship To"

ADDRESS.USERARE
A
PARTNER – Optional (O) Partner contact

CONTACT. information
PARTNER– Optional (O) HZ_PARTIES.PERSO Partner contact name

CONTACT.NAME1 N_FIRST_NAME +
PERSON_MIDDLE_
NAME +
PERSON_LAST_NA
ME based on
customer and ship to
location on
WSH_NEW_DELIVE
RIES and based on
SHIP_TO_CONTACT
_ID on
WSH_DELIVERY_DE
TAILS.

Table.Column

CONTACT.CONTCT
TYPE

CONTACT.DESCRIP
TN

CONTACT.EMAIL

CONTACT.FAX1 -
FAX9

CONTACT.NAME2 -
NAME9
PARTNER– Required (O) HZ_CONTACT_POI Partner contact phone

CONTACT.TELEPH NTS.RAW_PHONE_ numbers
ONE1 NUMBER based on
-TELEPHONE9 customer and ship to
location on
WSH_NEW_DELIVE
RIES and based on
SHIP_TO_CONTACT
_ID on
WSH_DELIVERY_DE
TAILS.

CONTACT.USERAR
EA
DOCUMNTREF. Required (O) This area contains the

details of the
document type
Table.Column
DOCUMNTREF.DOC Required (O) 'SR' (SHIPMENT The document type.

TYPE REQUEST FOR SHIPMENT
OUTBOUND) AND REQUEST
'SA' (SHIMENT
ADVICE FOR
INBOUND) at the
Supplier Instance.
DOCUMNTREF.DOC Required (O) WSH_TRANSACTIO The document ID

UMENTID NS_HISTORY.ORIG_
DOCUMENT_NUMB
ER
DOCUMNTREF.PAR Required (O) ORGANIZATION_C The partner ID

TNRID ODE based on
WSH_NEW_DELIVE
RIES.ORGANIZATIO
N_ID
DOCUMNTREF.PAR Not used Not used Not used

TNRTYPE
DOCUMNTREF.DES Not used Not used Not used

CRIPTN
DOCUMNTREF.DOC Not used Not used Not used

UMENTRV
DOCUMNTREF.LIN Not used Not used Not used

ENUM
DOCUMNTREF.NOT Not used Not used Not used

ES1 – NOTES9
DOCUMNTREF.SCH Not used Not used Not used

LINENUM
DOCUMNTREF.SUB Not used Not used Not used

LINENUM
DOCUMNTREF.USE Not used Not used Not used

RAREA

Table.Column
SHIPITEM. Required (O) Represents the

request to ship
specific quantity of
goods
SHIPITEM.AMOUNT Not used Not used Not used

(EXTENDED)

(ITEM)
SHIPITEM.COUNTR Required (O) WSH_DELIVERY_DE Country of origin

YORG TAILS.COUNTRY_O
F_ORIGIN
SHIPITEM.DISPOSIT Not used Not used Not used

N
SHIPITEM.EXPORTL Not used Not used Not used

IC
SHIPITEM.FRGHTCL Optional (O) MTL_CATEGORY_S Qualifies goods for

S ETS_VL.CATEGORY purposes of freight
_SET_NAME based cost calculation
on
WSH_DELIVERY_DE
TAILS.FREIGHT_CL
ASS_CAT_ID
SHIPITEM.FRGHTIT Not used Not used Not used

EM
SHIPITEM.HAZRDM Optional (O) PO_HAZARD_CLAS Contains a hazardous

ATL SES_VL . material code or
HAZARD_CLASS description that can
based on be a free form area or
WSH_DELIVERY_DE an agreed upon set of
TAILS.HAZARD_CL codes for the
ASS_ID applications
SHIPITEM.IMPORTL Not used Not used Not used

IC
Table.Column
SHIPITEM.LINENU Not used Not used Not used

M
SHIPITEM.NOTES1 – Optional (O) WSH_DELIVERY_DE Item notes

NOTES9 TAILS.PACKING_IN
STRUCTIONS
SHIPITEM.OWNRSH Optional (O) WSH_DELIVERY_DE Used to identify who

PCDE TAILS.FOB_CODE or which organization
owns the item or part.
The content of this
Field ID is user
defined based on a
specific Customer or
Supplier
SHIPITEM.PACKING Not used Not used Not used

DESC
SHIPITEM.QUANTIT Optional (I) WSH_DELIVERY_DE Quantity of items

Y (BACKORDERD) TAILS.BACKORDER backordered
ED_QUANTITY
SHIPITEM.QUANTIT Not used Not used Not used

Y (OPEN)
SHIPITEM.QUANTIT Required (B) WSH_DELIVERY_DE This represents the

Y (SHIPPED) TAILS.SHIPPED_QU actual quantity
ANTITY shipped
SHIPITEM.QUANTIT Optional (B) WSH_DELIVERY_DE The volume, or

Y (VOLUME) TAILS.VOLUME amount of space, that
is occupied by an
item, container or
shipment
SHIPITEM.QUANTIT Optional (B) WSH_DELIVERY_DE The weight of an

Y (WEIGHT) TAILS.NET_WEIGHT item, container, or
shipment

Table.Column
SHIPITEM.SHIPMAT Not used Not used Not used

LID
SHIPITEM.SHIPNOT Optional (B) WSH_DELIVERY_DE Notes area used for

ES TAILS.SHIPPING_IN any additional
STRUCTIONS information
SHIPITEM.SHIPPRIO Not used Not used Not used

R
SHIPITEM.SHIPMTL Not used Not used Not used

DESC
SHIPITEM.UPC Not used Not used Not used
Table.Column
SHIPITEM.USERARE Optional (I) WSH_DELIVERY_DE Ship item user area

A TAILS.DELIVERY_D
ETAIL_ID
ORACLE.DELIVERY
_DETAIL_NUMBER WSH_DELIVERY_AS
SIGNMENTS.PAREN
ORACLE.PARENT_D T_DELIVERY_DETAI
ELIVERY_DETAIL_N L_ID
UMBER
WSH_DELIVERY_DE
ORACLE.SHIP_TOLE TAILS.SHIP_TOLER
RANCE_ABOVE ANCE_ABOVE
ORACLE.SHIP_TOLE WSH_DELIVERY_DE
RANCE_BELOW TAILS.SHIP_TOLER
ORACLE.LOAD_SEQ ANCE_BELOW
UENCE_NUMBER WSH_DELIVERY_DE
ORACLE.SHIP_SET_ TAILS.LOAD_SEQU
NUMBER ENCE_NUMBER
ORACLE.SUBINVEN WSH_DELIVERY_DE
TORY TAILS descriptive
flexfields
ORACLE.TOP_MOD
EL_LINE_NUMBER WSH_DELIVERY_DE
TAILS.SHIP_SET_ID
ORACLE.SHIP_MOD
EL_COMPLETE_FLA WSH_DELIVERY_DE
G TAILS.SUBINVENTO
RY
ORACLE.COMMODI
TY_CODE_CATEGO WSH_DELIVERY_DE
RY TAILS.TOP_MODEL
_LINE_ID
ORACLE.SHIPMENT
_PRIORITY_CODE WSH_DELIVERY_DE
TAILS.SHIP_MODEL
ORACLE.DELIVER_ _COMPLETE_FLAG
TO_LOCATION
WSH_DELIVERY_DE
ORACLE.CUSTOME TAILS.COMMODITY
R_NAME _CODE_CAT_ID
converted to code
ORACLE.CUSTOME
R_NUMBER WSH_DELIVERY_DE
TAILS.SHIPMENT_P
ORACLE.TXN_SRC_ RIORITY_CODE
LINE_NUMBERQUA converted to "01", "02"

Table.Column
NTITY , or "03" for XML,.

(TOTWEIGHT)
WSH_DELIVERY_DE
ORACLE.MANUAL_ TAILS.DELIVER_TO
WV _LOCATION_ID
ORACLE.LINE_DIRE CONTACT segment

CTION sends CONTACT
NAME and PHONE
ORACLE.REQUEST_ NUMBER of the
DATE_TYPE_CODE contact based on the
DATETIME ship_to_contact_id on
(ORACLE.EARLSTPI wsh_delivery_details.
CK)
DATETIME
(ORACLE.LATESTPI
CK)
SHIPITEM.USERARE
A (continued)
DATETIME
(ORACLE.EARLSTD
ROP)
DATETIME
(ORACLE.LATESTD
ROP)
DATETIME
(ORACLE.SCHEDUL
ED)
DATETIME
(ORACLE.REQUEST
ED)CONTACT
Segment
CHARGE. Optional (B) Represents additional

freight or
transportation
charges associated
with the SHPITEM
Table.Column
CHARGE.CHARGEI Required (B) WSH_FREIGHT_COS Charge ID.

D T_TYPES.NAME
based on
WSH_FREIGHT_COS
TS.FREIGHT_COST_
TYPE_ID converted
to external value
CHARGE.OPERAMT Required (B) WSH_FREIGHT_COS Extended operating

(EXTENDED) (T) TS.UNIT_AMOUNT cost amount
WSH_FREIGHT_COS
TS.CURRENCY_COD
E
CHARGE.AMOUNT Not used Not used Not used

(EXTENDED) (T)
CHARGE.CHARGET Optional (B) WSH_FREIGHT_COS Charge type

YPE T_TYPES.NAME
based on
WSH_FREIGHT_COS
TS.FREIGHT_COST_
TYPE_ID
CHARGE.CHGLINE Not used Not used Not used

NUM
CHARGE.DESCRIPT Not used Not used Not used

N
CHARGE.USERARE Optional (B) WSH_FREIGHT_COS User area

A TS descriptive
flexfields
INVDETAIL. Optional (B) Inventory item

attribute detail
associated with the
SHIPITEM
INVDETAIL.DISPOSI Not used Not used Not used

TN

Table.Column
INVDETAIL.NOTES1 Not used Not used Not used

- NOTES9
DISTRIBUTION. Not used Not used Not used
DISTRIBUTION.BUS Not used Not used Not used

NAREA
DISTRIBUTION.COS Not used Not used Not used

TCENTER
DISTRIBUTION.DEP Not used Not used Not used

ARTMENT
DISTRIBUTION.DIVI Not used Not used Not used

SION
DISTRIBUTION.ELE Not used Not used Not used

MENT1 - ELEMENT
999
DISTRIBUTION.FUN Not used Not used Not used

D
DISTRIBUTION.GEO Not used Not used Not used

GRAPHY
DISTRIBUTION.GLE Not used Not used Not used

NTITYS
DISTRIBUTION.GLN Not used Not used Not used

OMACCT
DISTRIBUTION.OPE Not used Not used Not used

RAMT (EXTENDED)
(T)
DISTRIBUTION.PRO Not used Not used Not used

FITCTR
Table.Column

JECT
DISTRIBUTION.UNI Not used Not used Not used

T
DISTRIBUTION.WA Not used Not used Not used

REHOUSE
DISTRIBUTION.USE Not used Not used Not used

RAREA
SHIPUNIT. Required (B) Represents a single

trackable shipping
unit. A shipping unit
is a uniquely
identifiable assembly
or container that
holds one or more
items to be shipped
SHIPUNIT.CARRIER Required (B) WSH_DELIVERY_DE Carrier of the ship

TAILS.CARRIER_ID unit
value
SHIPUNIT.SHIPPERI Required (I) WSH_DELIVERY_DE The identifier of the

D TAILS.SHIP_FROM_ partner who is
LOCATION_ID responsible for
converted to external packaging inventory
value. goods for shipment
SHIPUNIT.TRACKIN Optional (B) WSH_DELIVERY_DE A unique identifier

GID TAILS.TRACKING_ for the purpose of
NUMBER tracking an
individual package or
shipment
SHIPUNIT.AMOUN Not used Not used Not used

T (DECLAREVAL)

Table.Column

T (FREIGHT( (T)

T (ITEM) (T)

T (TOTAL) (T)
SHIPUNIT.CARRSR Optional (B) WSH_NEW_DELIVE Service level for the

VLVL RIES.SERVICE_LEVE ship unit
L
SHIPUNIT.CONTNR Optional (B) WSH_DELIVERY_DE Seal number on the

SEAL TAILS.SEAL_CODE ship unit
SHIPUNIT.COUNTR Not used Not used Not used

YDST
SHIPUNIT.COUNTR Optional (B) WSH_DELIVERY_DE Container country

YORG TAILS.COUNTRY_O organization
F_ORIGIN
SHIPUNIT.DATETIM Optional (B) WSH_TRIP_STOPS.A Actual delivery date

E (DELIVACT) CTUAL_ARRIVAL_D and time
ATE
SHIPUNIT.DATETIM Optional (I) WSH_DELIVERY_DE Delivery schedule

E (DELIVSCHED) TAILS.DATE_SCHE date and time
DULED
SHIPUNIT.DATETIM Not used Not used Not used

E (LOADING)

E (SHIP)
SHIPUNIT.DESCRIP Not used Not used Not used

TN
Table.Column
SHIPUNIT.EXPORTL Not used Not used Not used

IC
SHIPUNIT.FRGHTC Optional (B) MTL_CATEGORY_S Freight class of the

LS ETS_VL.CATEGORY ship unit
_SET_NAME based
on
WSH_DELIVERY_DE
TAILS.FREIGHT_CL
ASS_CAT_ID
value
SHIPUNIT.FRGTHTE Optional (B) WSH_DELIVERY_DE Ship unit freight

RMS TAILS.FREIGHT_TE terms
RMS_CODE
value
SHIPUNIT.HAZRDM Optional (B) WSH_DELIVERY_DE Contains a hazardous

ATL TAILS.HAZARD_CL material code or
ASS_ID converted to description that can
external value be a free form area or
an agreed upon set of
codes for the
applications involved
in an integration
scenario
SHIPUNIT.IMPORTL Not used Not used Not used

IC
SHIPUNIT.LOADPOI Not used Not used Not used

NT
SHIPUNIT.NOTES1 - Not used Not used Not used

NOTES9
SHIPUNIT.OPERAM Not used Not used Not used

T (FREIGHT) (T)
SHIPUNIT.PACKIN Not used Not used Not used

G

Table.Column

GDESC
SHIPUNIT.QUANTI Not used Not used Not used

TY (ESTWEIGHT)
SHIPUNIT.QUANTI Optional (B) Populate from Height of the ship

TY (HEIGHT) MTL_SYSTEM_ITEM unit
S
SHIPUNIT.QUANTI Optional (B) Populate from Length of the ship

TY (LENGTH) MTL_SYSTEM_ITEM unit
S
SHIPUNIT.QUANIT Optional (B) Calculate Loading weight of the

TY (LOADINGWT) ship unit
WSH_DELIVERY_DE
TAILS.GROSS
WEIGHT -
WSH_DELIVERY_DE
TAILS.NET WEIGHT
SHIPUNIT.QUANTI Optional (B) WSH_DELIVERY_DE Net weight of the

TY (NETWEIGHT) TAILS.NET_WEIGHT ship unit
+
WSH_DELIVERY_DE
TAILS.WEIGHT_UO
M_CODE for delivery
lines = container item
SHIPUNIT.QUANTI Required (B) WSH_DELIVERY_DE Total weight of the

TY (TOTWEIGHT) TAILS.GROSS_WEIG ship unit
HT +
WSH_DELIVERY_DE
TAILS.WEIGHT_UO
M_CODE
Table.Column
SHIPUNIT.QUANTI Optional (B) WSH_DELIVERY_DE Volume of the ship

TY (VOLUME) TAILS.VOLUME + unit
WSH_DELIVERY_DE
TAILS.VOLUME_UO
M_CODE for delivery

TY (WIDTH)
SHIPUNIT.SHIPMAT Optional (B) WSH_DELIVERY_DE The delivery detail id

LID TAILS.INVENTORY_ of the container
ITEM_ID converted record
to Item Number by
joining to
mtl_system_items
SHIPUNIT.SHIPNOT Optional (B) WSH_DELIVERY_DE The shipping

ES TAILS.SHIPPING_IN instructions or notes
STRUCTIONS
SHIPUNIT.SHIPPOI Optional (B) WSH_DELIVERY_DE Identifies the location

NT TAILS.DELIVER_TO the goods are to be
_LOCATION_ID shipped
SHIPUNIT.SHIPSRV Optional (B) WSH_DELIVERY_DE A generic code that

LVL TAILS.SHIP_METHO specifies a particular
D_CODE type or quality of
carrier delivery
service to be used for
transporting goods
SHIPUNIT.SHPMTL Optional (B) WSH_DELIVERY_DE Describes the material

DESC TALS.ITEM_DESCRI or container a
PTION product or item is
shipped in
SHIPUNIT.SHPUNIT Not used Not used Not used

SEQ

STS

Table.Column

TOT
SHIPUNIT.SPECIAL Not used Not used Not used

HND
SHIPUNIT.STAGEPO Not used Not used Not used

INT
SHIPUNIT.TEMPRA Not used Not used Not used

TURE (ACTUAL)

TURE (DELIVERY)

TURE (LOADING)
SHIPUNIT.TRACKIN Not used Not used Not used

GIDTYPE
SHIPUNIT.TRANSM Optional (B) WSH_DELIVERY_DE Transportation

ETHD TAILS.MODE_OF_T method
RANSPORT
SHIPUNIT.TRANSTE Optional (B) WSH_NEW_DELIVE A contractual code

RMS RIES.FOB_CODE used to describe the
point where delivery
occurs (goods
ownership is
transferred) in a
contract of sale

Table.Column
SHIPUNIT.USERARE Optional (I) WSH_DELIVERY_DE User area for the ship

A TAILS.DELIVERY_D unit
ETAIL_ID
(To be called as
DELIVERY_DETAIL_
NUMBER)
WSH_DELIVERY_DE
TAILS.PACKING_IN
STRUCTIONS
WSH_DELIVERY_DE
TAILS.DESCRIPTIVE
_FLEXFIELDS
WSH_DELIVERY_DE
TAILS.LOT_NUMBE
R
WSH_DELIVERY_DE
TAILS.SUBLOT_NU
MBER
WSH_DELIVERY_DE
TAILS.REVISION
WSH_DELIVERY_DE
TAILS.SERIAL
NUMBER
WSH_DELIVERY_DE
TAILS.TO_SERIAL
NUMBER
CONTAINER. Optional (I) Represents

information about an
intermediate
packaging level
within the shipping
unit. A CONTAINER
may or may not have
INVITEM inventory
associated with it

Table.Column
CONTAINER.CONT Optional (B) WSH_DELIVERY_DE Container ID

AINRID TAILS.CONTAINER_
NAME
CONTAINER.CONT Optional (B) WSH_DELIVERY_DE Identifies the

NRSEAL TAILS.SEAL_CODE tamper-proof seal
placed on a shipping
container to prevent
pilfering of the
contents
CONTAINER.CONT Optional (B) WSH_DELIVERY_DE A classification of

NRTYPE TAILS.CONTAINER_ containers
TYPE_CODE

CONTAINER.DESCR Not used Not used Not used

IPTN
CONTAINER.NOTES Not used Not used Not used

1 - NOTES 9
CONTAINER.PACKI Not used Not used Not used

NG

NGDESC
CONTAINER.PARC Not used Not used Not used

NTNRID
CONTAINER.SHIPM Optional (B) WSH_DELIVERY_DE Container part

ATLID TAILS.INVENTORY_ number
ITEM_ID converted
to ITEM NUMBER by
joining to
mtl_system_items
CONTAINER.SHPM Optional (B) WSH_DELIVERY_DE Container description

TLDESC TAILS.ITEM_DESCRI – used most often for
PTION returnable containers
Table.Column
CONTAINER.USERA Optional (B) WSH_DELIVERY_AS User area for

REA SIGNMENTS.DELIV additional
ERY_DETAIL_ID information on the
container
(To be called as
DELIVERY_DETAIL_
NUMBER)
WSH_DELIVERY_AS
SIGNMENTS.PAREN
T_DELIVERY_DETAI
L_ID
(To be called as
PARENT_DELIVERY
_DETAIL_NUMBER)
HEIGHT – From
mtl_system_items
LENGTH - From
mtl_system_items
WEIGHT-
WSH_DELIVERY_DE
TAILS.
GROSS_WEIGHT
WSH_DELIVERY_DE
TAILS.
NET_WEIGHT
VOLUME –
WSH_DELIVERY_DE
TAILS. VOLUME
WIDTH- From
mtl_system_items
LOT-
WSH_DELIVERY_DE
TAILS.
LOT_NUMBER
SUBLOT-WSH_DELI
VERY_DETAILS.
SUBLOT_NUMBER
WSH_DELIVERY_DE

Table.Column
TAILS. REVISION
WSH_DELIVERY_DE
TAILS. SERIAL
NUMBER
WSH_DELIVERY_DE
TAILS. TO_SERIAL
NUMBER
Table.Column
CONTAINER.USERA WSH_DELIVERY_DE
REA (continued) TAILS.
SHIP_FROM_LOCAT
ION_ID converted to
code
(To be called as
SHIP_FROM_LOCAT
ION LOCATION)
WSH_DELIVERY_DE
TAILS.
DELIVER_TO_LOCA
TION_ID
(To be called as
DELIVER_TO_LOCA
TION)
WSH_DELIVERY_DE
TAILS.
TRACKING_NUMBE
R
WSH_DELIVERY_DE
TAILS.
COUNTRY_OF_ORI
GIN
WSH_TRIP_STOPS.A
CTUAL_
ARRIVAL_DATE
WSH_DELIVERY_DE
TAILS.
DATE_SCHEDULED
WSH_TRIP_STOPS.A
CTUAL_
DEPARTURE_DATE
WSH_DELIVERY_DE
TAILS.
SHIP_METHOD_CO
DE
WSH_DELIVERY_DE
TAILS.
FREIGHT_CLASS_C

Table.Column
AT_ID converted to
external value
(To be called as
FREIGHT_CLASS_C
ATEGORY)
WSH_DELIVERY_DE
TAILS.
FREIGHT_TERMS_C
ODE converted to
external value
WSH_DELIVERY_DE
TAILS.
HAZARD_CLASS_ID
value
(To be called as
HAZARD_CLASS or
as
HAZARD_CLASS_C
ODE)
REA (continued) TAILS. FOB_CODE
WSH_DELIVERY_DE
TAILS.
SHIPPING_INSTRUC
TIONS
WSH_DELIVERY_DE
TAILS.
PACKING_INSTRUC
TIONS
WSH_DELIVERY_DE
TAILS. Descriptive
Flexfields
Table.Column
CHARGE. Required (I) This CHARGE

section is for a
CONTAINER.
Represents additional
freight or
transportation
charges associated
with the shipment
CHARGE.CHARGEI Required (I) WSH_FREIGHT_COS Charge ID

D TS.FREIGHT_COST_
TYPE_ID converted
to external value
CHARGE.OPERAMT Required (I) WSH_FREIGHT_COS Operating amount

(EXTENDED) (T) TS.TOTAL_AMOUN
T
WSH_FREIGHT_COS
TS.CURRENCY_COD
E
CHARGE.AMOUNT Required (I) Extended charge

(EXTENDED) (T) amount
CHARGE.CHARGET Required (I) WSH_FREIGHT_COS Charge type

YPE TS.FREIGHT_COST_
TYPE_ID converted
to
FREIGHT_COST_TY
PE
CHARGE.CHGLINE Required (I) Line number of the

NUM charge
CHARGE.DESCRIPT Required (I) Description of the

N charge
CHARGE.USERARE Optional (I) WSH_FREIGHT_COS

A TS descriptive
flexfields

Table.Column
INVITEM. Required (B) Represents the

occurrence of a
goods inventory
packed within the
SHIPUNIT or
CONTAINER. The
inventory item
occurrence typically
refers to a line item or
shipping schedule
line of a sales order,
purchase order or
other business
document
INVITEM.ITEM Required (B) MTL_SYSTEM_ITEM Item number

S_KFV.
CONCATENATED_S
EGMENTS
INVITEM.QUANTIT Not used Not used Not used

Y (ITEM)
INVITEM.AMOUNT Not used Not used Not used

(EXTENDED) (T)

(ITEM) (T)
INVITEM.FRGHTCL Not used Not used Not used

S
INVITEM.FRGHTITE Not used Not used Not used

M
INVITEM.HAZRDM Not used Not used Not used

ATL
INVITEM.ITEMDESC Not used Not used Not used
INVITEM.ITEMRV Not used Not used Not used
Table.Column
INVITEM.ITEMRVX Not used Not used Not used
INVITEM.LOTLEVEL Not used Not used Not used

1 - LOTLEVEL2
INVITEM.NOTES 1 - Not used Not used Not used

NOTES 9
INVITEM.OWNRSH Not used Not used Not used

PCDE

Y (VOLUME)

Y (WEIGHT)
INVITEM.SHIPNOTE Not used Not used Not used

S
INVITEM.UPC Not used Not used Not used
INVITEM.USERARE Not used Not used Not used

A
CHARGE. Required (I) This CHARGE Represents additional

section is for freight or
SHIPUNIT. transportation
charges associated
with the shipment

D TS.FREIGHT_COST_
TYPE_ID
CHARGE.OPERAMT Required (I) WSH_FREIGHT_COS Charge total amount

(EXTENDED) (T) TS.TOTAL_AMOUN
T
WSH_FREIGHT_COS
TS.CURRENCY_COD
E

Table.Column
CHARGE.AMOUNT Required (I) Extended charge

(EXTENDED) (T) amount
CHARGE.CHARGET Required (I) WSH_FREIGHT_COS Charge type

TYPE_ID converted
to
FREIGHT_COST_TY
PE
CHARGE.CHGLINE Required (I) Charge line number

NUM
CHARGE.DESCRIPT Required (I) Description of the

N charge
The following represents the SHOW_SHIPMENT REQUEST XML data for carrier
manifesting in Oracle Shipping Execution.
<?xml version = '1.0' encoding = 'UTF-8' standalone = 'no'?>
<! - Oracle eXtensible Markup Language Gateway Server - >
<!DOCTYPE SHOW_SHIPMENT_005 SYSTEM "161_show_shipment_005.dtd">
<SHOW_SHIPMENT_005>
<CNTROLAREA>
<BSR>
<VERB value="SHOW">SHOW</VERB>
<NOUN value="SHIPMENT">SHIPMENT</NOUN>
</BSR>
<SENDER>
<COMPONENT>WSH</COMPONENT>
<TASK>SSNO</TASK>
<REFERENCEID>P11510C2.US.ORACLE.COM:oracle.apps.wsh.sup.ssro:TPW346</REF
ERENCEID>
</SENDER>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>09</HOUR>
<MINUTE>44</MINUTE>
<SECOND>41</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SHOW_SHIPMENT>
<SHIPMENT>
<DATETIME qualifier="DOCUMENT">
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>09</HOUR>
<MINUTE>44</MINUTE>
<SECOND>41</SECOND>
</DATETIME>
<AMOUNT qualifier="DECLAREVAL">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<AMOUNT qualifier="DOCUMENT" type="T">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<AMOUNT qualifier="ESTFREIGHT">

<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<AMOUNT qualifier="FREIGHT" type="T">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<AMOUNT qualifier="ITEM" type="T">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>09</HOUR>
<MINUTE>43</MINUTE>
<SECOND>57</SECOND>
</DATETIME>
<DATETIME qualifier="DELIVACT">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<DATETIME qualifier="DELIVSCHED">
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>23</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<DATETIME qualifier="EARLSTSHIP">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<DATETIME qualifier="LOADING">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<DATETIME qualifier="NEEDDELV">
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>23</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<DATETIME qualifier="PROMDELV">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<DATETIME qualifier="PROMSHIP">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<DATETIME qualifier="SHIP">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<DATETIME qualifier="SHIPSCHED">
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>23</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<OPERAMT qualifier="FREIGHT" type="T">
<VALUE/>

<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<QUANTITY qualifier="ESTWEIGHT">
<VALUE>180</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<QUANTITY qualifier="LOADINGWT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="NETWEIGHT">
<VALUE>180</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<QUANTITY qualifier="SHIPUNIT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="TOTWEIGHT">
<VALUE>180</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<QUANTITY qualifier="VOLUME">
<VALUE>12</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<TEMPRATURE qualifier="ACTUAL" type="FAHRENHEIT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<TEMPRATURE qualifier="DELIVERY" type="FAHRENHEIT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<TEMPRATURE qualifier="LOADING" type="FAHRENHEIT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<DOCUMENTID>340</DOCUMENTID>
<SHIPPERID>V1- New York City</SHIPPERID>
<SYNCID>A</SYNCID>
<CARRIER/>
<CARRSRVLVL/>
<COUNTRYDST>US</COUNTRYDST>
<COUNTRYORG/>
<DESCRIPTN/>
<DISTCENTER/>
<DOCKID/>
<DOCTYPE>SR</DOCTYPE>
<DOCUMENTRV/>
<DROPSHIP/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTTERMS/>
<HAZRDMATL/>
<HDRSTATUS/>
<IMPORTLIC/>
<LOADPOINT/>
<NOTES index="1"/>
<PARTIALSHP/>
<PRIORITY/>
<ROUTEID/>
<SHIPNOTES/>
<SHIPPOINT>Chattanooga (OPS)</SHIPPOINT>
<SHIPPRIOR/>
<SHIPSRVLVL/>
<SPECIALHND/>
<STAGEPOINT/>
<TRANSMETHD/>
<TRANSTERMS/>
<WAREHOUSE>V1</WAREHOUSE>
<USERAREA/>
<PARTNER>
<NAME index="1">Phoenix Manufacturing</NAME>
<ONETIME/>
<PARTNRID>V1- New York City</PARTNRID>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER>0</DUNSNUMBER>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRLINE index="1">3200 East Camelback</ADDRLINE>
<ADDRLINE index="2">Suite 255</ADDRLINE>
<ADDRLINE index="3"/>
<ADDRTYPE/>
<CITY>Phoenix</CITY>
<COUNTRY>US</COUNTRY>
<COUNTY/>

<DESCRIPTN/>
<FAX index="1">602-224-6250</FAX>
<POSTALCODE>85018</POSTALCODE>
<REGION/>
<STATEPROVN>AZ</STATEPROVN>
<TAXJRSDCTN/>
<TELEPHONE index="1">602-224-6200</TELEPHONE>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<QUANTITY qualifier="FILESIZE">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<TELEPHONE index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<PARTNER>
<NAME index="1">Computer Service and Rentals</NAME>
<ONETIME/>
<PARTNRID/>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRLINE index="1">301 Summit Hill Drive</ADDRLINE>
<ADDRTYPE/>
<CITY>Chattanooga</CITY>
<COUNTY>Hamilton</COUNTY>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<STATEPROVN>TN</STATEPROVN>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1">Gerry Brown</NAME>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<TELEPHONE index="1">+1 (703) 8441212</TELEPHONE>
<USERAREA/>

</CONTACT>
</PARTNER>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<AMOUNT qualifier="EXTENDED" type="T">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<QUANTITY qualifier="BACKORDERD">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="OPEN">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="ORDERED">
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<QUANTITY qualifier="SHIPPED">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<QUANTITY qualifier="WEIGHT">
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMDESC>Sentinel Standard Desktop</ITEMDESC>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<LOTLEVEL index="1"/>
<NOTES index="1"/>
<OWNRSHPCDE>Destination</OWNRSHPCDE>
<PACKING/>
<PARTIALSHP>0</PARTIALSHP>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCTYPE>PURCHASEORDER</DOCTYPE>
<DOCUMENTID/>
<PARTNRID>Chattanooga (OPS)</PARTNRID>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DESCRIPTN>Sentinel Standard Desktop</DESCRIPTN>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>

</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>

<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>

<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>

<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>

<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<DOCUMNTREF>
<DOCUMENTID/>
<PARTNRID>V1</PARTNRID>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
</SHIPMENT>
</SHOW_SHIPMENT>
</DATAAREA>
</SHOW_SHIPMENT_005>
Carrier Manifesting INBOUND Sample XML

The following represents the SHOW_SHIPMENT ADVICE XML data for carrier
manifesting in Oracle Shipping Execution.

<SHOW_SHIPMENT_005>
<CNTROLAREA>
<BSR>
</BSR>
<SENDER>
<LOGICALID/>
<TASK>SSNO</TASK>
<REFERENCEID>HM000A:oracle.apps.wsh.sup.ssro:CMS437</REFERENCEID>
</SENDER>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>15</HOUR>
<MINUTE>18</MINUTE>
<SECOND>41</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SHOW_SHIPMENT>
<SHIPMENT>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>15</HOUR>
<MINUTE>18</MINUTE>
<SECOND>40</SECOND>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>54</MINUTE>
<SECOND>57</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>10</MINUTE>
<SECOND>17</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>

<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>10</MINUTE>
<SECOND>17</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>10</MINUTE>
<SECOND>17</SECOND>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<DOCUMENTID>367-I</DOCUMENTID>
<SHIPPERID>M3- Dallas</SHIPPERID>
<SYNCID>A</SYNCID>
<CARRIER>WSH-DHL</CARRIER>

<CARRSRVLVL>1DM</CARRSRVLVL>
<COUNTRYORG/>
<DESCRIPTN/>
<DISTCENTER/>
<DOCKID/>
<DOCTYPE>SA</DOCTYPE>
<DOCUMENTRV/>
<DROPSHIP/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTTERMS>Paid</FRGHTTERMS>
<HAZRDMATL/>
<HDRSTATUS/>
<IMPORTLIC/>
<LOADPOINT/>
<NOTES index="1"/>
<PARTIALSHP/>
<PRIORITY/>
<ROUTEID/>
<SHIPNOTES/>
<SHIPPRIOR/>
<SHIPSRVLVL>1DM</SHIPSRVLVL>
<SPECIALHND/>
<STAGEPOINT/>
<TRANSMETHD>PARCEL</TRANSMETHD>
<TRANSTERMS>Destination</TRANSTERMS>
<WAREHOUSE>M3</WAREHOUSE>
<USERAREA/>
<PARTNER>
<NAME index="1">Dallas Manufacturing</NAME>
<ONETIME/>
<PARTNRID>M3- Dallas</PARTNRID>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRLINE index="1">222 West Las Colinas
Blvd</ADDRLINE>
<ADDRTYPE/>
<CITY>Irving</CITY>
<COUNTY/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<STATEPROVN/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<PARTNER>
<ONETIME/>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>

<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRTYPE/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CHARGE>
<OPERAMT qualifier="EXTENDED" type="T">
<VALUE>75</VALUE>
<SIGN>+</SIGN>
<UOMVALUE>D</UOMVALUE>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<CHARGEID>Handling</CHARGEID>
<CHARGETYPE>Handling</CHARGETYPE>
<CHGLINENUM/>
<DESCRIPTN/>
<USERAREA/>
<DISTRIBUTN>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<BUSNAREA/>
<COSTCENTER/>
<DEPARTMENT/>
<DIVISION/>
<ELEMENT index="1"/>
<FUND/>
<GEOGRAPHY/>
<GLENTITYS/>

<GLNOMACCT/>
<PROFITCTR/>
<PROJECT/>
<UNIT/>
<WAREHOUSE/>
<USERAREA/>
</DISTRIBUTN>
</CHARGE>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
</SHIPMENT>
<SHIPUNIT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<AMOUNT qualifier="TOTAL" type="T">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="HEIGHT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="LENGTH">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>

<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE>1001</VALUE>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE>1</VALUE>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<QUANTITY qualifier="WIDTH">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<TRACKINGID>1Z4444441500000227</TRACKINGID>
<CONTAINRID>118081</CONTAINRID>
<CONTNRSEAL/>
<CONTNRTYPE>ALC</CONTNRTYPE>
<COUNTRYDST/>
<COUNTRYORG/>
<DESCRIPTN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<LOADPOINT/>
<NOTES index="1"/>
<SHIPMATLID>A1 DOM</SHIPMATLID>
<SHIPNOTES/>
<SHPMTLDESC>A1 Domestic Airline Container</SHPMTLDESC>
<SHPUNITSEQ/>
<SHPUNITSTS/>
<SHPUNITTOT/>
<SPECIALHND/>
<STAGEPOINT/>
<USERAREA/>
<PARTNER>
<ONETIME/>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER/>
<GLENTITYS/>
<NAME index="1"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRTYPE/>
<COUNTY/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>

<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<DOCUMNTREF>
<DOCTYPE/>
<DOCUMENTID/>
<PARTNRID/>
<PARTNRTYPE/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVITEM>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<ITEM/>
<COUNTRYORG/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<ITEMDESC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<OWNRSHPCDE/>
<SHIPNOTES/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCTYPE/>
<DOCUMENTID/>
<PARTNRID/>
<PARTNRTYPE/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>

<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DESCRIPTN/>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</INVITEM>
</SHIPUNIT>
</SHOW_SHIPMENT>
</DATAAREA>
Using XML Messaging with Third Party Warehousing

Third party warehouse transactions support communications between you and a
separate distribution warehouse. Oracle Shipping Execution enables you to send an
outbound order to the separate warehouse indicating what the warehouse needs to ship
inventory on your behalf. After the third party warehouse has completed the shipment,
the details of the shipment are sent back to Oracle Shipping Execution.
These transactions contain shipment details to determine what to ship, where to ship,
and to print the required labels and paperwork. Once the third party warehouse
responds, the delivery is automatically confirmed in Oracle Shipping Execution.
Before using XML messages for third party warehousing, you must:
• Define a Distributed organization
• Define your third party warehouses as trading partners
• Define your organization as a trading partner
The following business events are used for Third Party Warehouse XML transactions:
• oracle.apps.wsh.sup.ssro: Business event to send the Shipment Request Outbound
• oracle.apps.wsh.sup.ssai: Business event to receive the Shipment Advice Inbound
• oracle.apps.fte.ssno.confirm: Business event to receive the Confirm Business Object

Document (CBOD) (acceptance or rejection)
• oracle.apps.wsh.tpw.ssri: Business event to receive the Shipment Request Inbound
• oracle.apps.wsh.tpw.ssao: Business event to send the Shipment Advice Outbound
• oracle.apps.wsh.tpw.spwf: Business event to bring the Shipment Request workflow

instance to a closure when the cancellation is accepted at the third party instance
• oracle.apps.wsh.tpw.scbod: Business event to send the CBOD Outbound

(acceptance or rejection)
ShowShipment Request Transaction for Third Party Warehousing

Show Shipment Request transaction (the XML equivalent of the ASC X12 940
transaction) is a modified version of the OAG DTD show_shipment_005. This DTD is
used to send shipment information from Oracle Shipping Execution to a third party
warehouse system.
These transactions contain information such as:
• Delivery Name
• Customer
• Ship To Address
• Ship To Contact
• Requested Pick Up Date and Time
• Requested Delivery Date and Time
• Weight

ShowShipment Request (show_shipment_005) for Third Party Warehousing
ShowShipment Advice Transaction for Third Party Warehousing

Show Shipment Advice transaction (the XML equivalent of the ASC X12 945
transaction) is a modified version of the OAG DTD. This DTD is used to send shipment
information from a third party warehouse to Oracle Shipping Execution.
ShowShipment Advice (show_shipment_005) for Third Party Warehousing
Defining Trading Partners for Third Party Warehousing

All third party warehouses that receive XML transactions must be defined as trading
partners. If there are multiple locations for the third party warehouse, each location
must be defined as a trading partner.
All organizations that send and receive XML transactions must be defined as trading
partnersin Oracle XML Gateway.
To define a warehouse as a trading partner for third party warehousing:
4. Select the warehouse name using the list of values in the Trading Partner Name
field.
5. Select the warehouse address using the list of values in the Trading Partner Site
field.
field to choose WSH with the Transaction Sub Type of SSNO.
10. Begin a new Trading Partner Detail line.
11. Use the list of values in the Transaction Type field to choose WSH with the External
Transaction Type of SHIPMENT and the Direction OUT.
13. In the Connection/Hub field, select Direct or select a hub through which to
communicate with your third party warehouse.
Note: DIRECT enables you to communicate with your third party

warehouse directly. A hub is an integration point within your
network (either your intranet or the Internet).
If you choose to connect to your third party warehouse using Direct, the XML
• Protocol Type
• Username
• Password
• Protocol Address
If you choose to connect to your third party warehouse using a hub, Oracle XML
Gateway will require that you select a Username from the list of values only. The

rest of the information will default based on the information entered during the
16. Use the list of values in the Transaction Type field to choose ECX with the External
Transaction Type of BOD, Transaction Subtype as CONFIRM and the Direction
OUT.
17. Use the list of values to select ECX_CBODO_OAG721_OUT_CONFIRM in the Map

field.
18. In the Connection/Hub field, select Direct or select a hub through which to

If you choose to connect to your third party warehouse using Direct, Oracle XML
• Protocol Type
• Username
• Password
If you choose to connect to your third party warehouse using a hub, Oracle XML
Gateway will require that you select a Username from the list of values only. The
rest of the information will default based on the information entered during the
20. Save your work.
22. See: Oracle XML Gateway User's Guide for detailed information on defining code
conversions.

To define organizations as trading partners for third party warehousing:

4. Select the organization's location using the list of values in the Trading Partner
Name field.
5. Select the organization's location address using the list of values in the Trading
Partner Site field.
field to choose FTE with the Transaction Sub Type of SSNI.
11. Use the list of values in the Transaction Type field to choose FTE with the
Transaction Sub Type of SSNO.
13. Within the Connection/Hub field, select Direct or select a hub through which to
communicate with your carrier.
Note: DIRECT enables you to communicate with your carrier

directly. A hub is an integration point within your network (either
your intranet or the Internet).
If you choose to connect to your organization using Direct, Oracle XML Gateway
will require that you provide information in the following fields:

• Protocol Type
• Username
• Password
If you choose to connect to your organization using a hub, Oracle XML Gateway
will require that you select only a Username from the list of values. The rest of the
information will default based on the information entered during the creation of the
hub.
15. Enter 2 in document confirmation field.
17. Use the list of values in the Transaction Type field to choose ECX with the External
Transaction Type of BOD, Transaction Subtype as CONFIRM, and the Direction IN.
18. Use the list of values to select ECX_CBODO_OAG721_IN_CONFIRM in the Map

field.
19. Within the Connection/Hub field, select Direct or select a hub through which to

If you choose to connect to your organization using Direct, Oracle XML Gateway
will require that you provide information in the following fields:
• Protocol Type
• Username
• Password
If you choose to connect to your organization using a hub, Oracle XML Gateway
will require that you select only a Username from the list of values. The rest of the
information will default based on the information entered during the creation of the
hub.
21. Save your work.
conversions.

Overview of XML and DTD for Third Party Warehousing

The following is a sample DTD and a sample XML used for third party warehousing in
Oracle Shipping Execution. Also, a table is available that displays all required
element/attributes, a description of each, and the Oracle table and column for each
Sample Document Type Definitions (DTD) for Third Party Warehousing

The following section includes a sample DTD used for third party warehousing in

Third Party Warehousing Sample DTD
<! - ==================================================== - >
%RESOURCES;
<! - ==================================================== - >
<!ATTLIST VERB
value CDATA #FIXED "SHOW"
>
<!ATTLIST NOUN
value CDATA #FIXED "SHIPMENT"
>
<!ATTLIST REVISION
value CDATA #FIXED "005"
>
<!ELEMENT DATAAREA (SHOW_SHIPMENT)
>
<!ELEMENT SHOW_SHIPMENT (SHIPMENT, SHIPUNIT*)
>
USERAREA?, PARTNER+, SHIPITEM*, ATTCHREF*, CHARGE*, DOCUMNTREF*)
>
CHARGE*)
>
>
>
>
USERAREA?, DOCUMNTREF*, INVDETAIL*)
>
@
115.1.11510.1
log
@'mkbranch'
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.1.1159.1
log
@mkbranch
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.1.1158.1
log
@mkbranch
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2

$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.0
log
@initial version
@
text
@d1 1
a1 1
d6 2
a7 2
$Revision: 7.2.1 $
d11 1
a11 1
d22 1
a22 1
d59 1
a59 1
@
Sample XML Transactions for Third Party Warehousing
Third Party Warehousing Sample XML

The following table lists each of the ShowShipment elements/attributes, whether they
are required or optional, and whether they are for inbound, outbound, or both. A
sample OUTBOUND ShowShipment Request XML transaction for third party
warehousing follows the table and a sample INBOUND ShowShipment Request XML
transaction for third party warehousing follows the OUTBOUND sample.
The Required? column indicates whether the element/attribute is required or optional
for INBOUND (I), OUTBOUND (O), or BOTH (B).
Third Party Warehousing XML Field Information

Table.Column
CNTROL AREA Required (B) The fields included in

this area provide
XML document
BSR Required (B) Shows the Business

per OAGI
VERB Required (B) Value is Show
NOUN Required (B) Value is Shipment
REVISION Required (B) Value is 005
SENDER Required (B) Provides information

on the system that
sends the document
LOGICALID Required (B) Sender system

identifier
COMPONENT Required (B) Sender application

name. Value is FTE
TASK Required (B) Event or Action
REFERENCEID Required (B) Unique reference ID

for this document
CONFIRMATION Required (B) Confirmation when

document is received
LANGUAGE Required (B) Language in which

the text fields are
transmitted
CODEPAGE Required (B) Character set used in

this XML document

Table.Column
AUTHID Required (B) System ID of sender.

Value is APPS
DATETIME Required (B) Creation date and

(CREATION)(T) time of the XML
document
SHIPMENT Required (B) Contains the general

document
information for
goods being
transported to a
particular partner
destination
SHIPMENT.DATETT Required (B) Sys date time Contains date and

IME time stamp of the
latest update to the
SHIPMENT
document
SHIPMENT.DOCUM Required (B) WSH_TRANSACTIO Document ID

ENTID (SHIPMENT) NS_HISTORY.DOCU
MENT_ID
SHIPMENT.SHIPPER Required (B) LOCATION_CODE Ship From party

ID from
HR_LOCATIONS_AL
L_TL based on
theWSH_NEW_DELI
VERIES.INITIAL_PIC
KUP_LOCATION_ID
Table.Column
SHIPMENT.SYNCID Required (B) EDI code

conversions: "N" for
Add, "R" for Change,
"F" for Cancel.
XML: "A" = Add, "D"

= Delete
"C" = Change
EDI: "N" for Add, "F"

for Delete

T (DECLAREVAL)

T (DOCUMENT)

T (ESTFREIGHT)

T (FREIGHT)

T (ITEM)
SHIPMENT.CARRIE Optional (B) WSH_NEW_DELIVE Freight carrier

R RIES.CARRIER_ID,
SHIPMENT.CARRIE Optional (B) WSH_NEW_DELIVE Carrier service level

RSRVLVL RIES.SERVICE_LEVE
L
SHIPMENT.COUNT Required (B) WSH_NEW_DELIVE Destination country

RYDST RIES.
ULTIMATE_DROPO
FF_LOCATION_ID,
SHIPMENT.COUNT Not used Not used Not used

RYORG

Table.Column
SHIPMENT.DATETI Optional (O) WSH_NEW_DELIVE Date and time of

ME (CREATION) RIES.CREATION_DA delivery creation
TE
SHIPMENT.DATETI Optional (B) WSH_TRIP_STOPS.A Actual delivery date

ME (DELIVACT) CTUAL_ARRIVAL_D and time
ATE
SHIPMENT.DATETI Optional (B) WSH_NEW_DELIVE Scheduled delivery

ME (DELIVSCHED) RIES. date and time
.ULTIMATE_DROPO
FF_DATE

ME (EARLSTSHIP)

ME (LOADING)

ME (NEEDDELV)

ME (PROMDELV)

ME (PROMSHIP)
SHIPMENT.DATETI Optional (B) WSH_TRIP_STOPS.A Actual ship date/time

ME (SHIP) CTUAL_DEPARTUR
E_DATE
SHIPMENT.DATETI Optional (B) WSH_NEW_DELIVE Scheduled ship date

ME (SHIPSCHED) RIES.INITIAL_PICKU and time
P_DATE
SHIPMENT.DESCRIP Optional (B) WSH_NEW_DELIVE Description of the

TN RIES.DESCRIPTION shipment
SHIPMENT.DISTCE Not used Not used Not used

NTER
Table.Column
SHIPMENT.DOCKID Not used Not used Not used
SHIPMENT.DOCTYP Required (B) 'SR' ( SHIPMENT The OAG document

E REQUEST FOR name. SHIPMENT
OUTBOUND) AND REQUEST for
'SA' (SHIMENT outbound and
ADVICE FOR SHIPMENT ADVICE
INBOUND) at the for inbound
Supplier Instance. 'SA'
( SHIPMENT
ADVICE FOR
OUTBOUND) AND
'SR' (SHIMENT
REQUEST FOR
INBOUND) at the
Third Party
Warehouse Instance.
SHIPMENT.DOCUM Optional (B) Revision number of

ENTRV this document.
'001' for 'Add' and

'002' for 'Delete'
SHIPMENT.DROPSH Not used Not used Not used

IP
SHIPMENT.EXPORT Not used Not used Not used

LIC
SHIPMENT.FRGHTC Not used Not used Not used

LS
SHIPMENT.FRGHTT Optional (B) WSH_NEW_DELIVE Indicates how the

ERMS RIES.FREIGHT_TER freight cost for a
MS_CODE shipment of goods
should be billed
SHIPMENT.HAZRD Not used Not used Not used

MATL
SHIPMENT.HDRSTA Not used Not used Not used

TUS

Table.Column
SHIPMENT.IMPORT Not used Not used Not used

LIC
SHIPMENT.LOADP Not used Not used Not used

OINT
SHIPMENT.NOTES1 Not used Not used Not used

– NOTES9
SHIPMENT.OPERA Not used Not used Not used

MT (FREIGHT)
SHIPMENT.PARTIA Not used Not used Not used

LSHP
SHIPMENT.PRIORIT Not used Not used Not used

Y
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE The estimated weight

TY (ESTWEIGHT) RIES.GROSS_WEIGH of a shipment
T
WSH_NEW_DELIVE
RIES.WEIGHT_UOM
_CODE
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE Indicates the weight

TY (LOADINGWT) RIES.GROSS of the shipment at
WEIGHT – loading time
WSH_NEW_DELIVE
RIES.NET WEIGHT
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE Indicates the net

TY (NETWEIGHT) RIES.NET_WEIGHT weight of the
shipment
WSH_NEW_DELIVE
RIES.WEIGHT_UOM
_CODE
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE Indicates the quantity

TY (SHIPUNIT) RIES.NUMBER_OF_L of units shipped,
PN such as containers or
boxes
Table.Column
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE Indicates the total

TY (TOTWEIGHT) RIES.GROSS_WEIGH weight of a shipment
T
WSH_NEW_DELIVE
RIES.WEIGHT_UOM
_CODE
SHIPMENT.QUANTI Optional (B) WSH_NEW_DELIVE Indicates the volume

TY (VOLUME) RIES.VOLUME of the shipment
WSH_NEW_DELIVE
RIES.VOLUME_UOM
_CODE
SHIPMENT.ROUTEI Not used Not used Not used

D

ENUM

ENUMTOT
SHIPMENT.ROUTET Not used Not used Not used

YPE
SHIPMENT.SHIPNO Optional (B) WSH_NEW_DELIVE This is a free form

TES RIES.SHIPPING_MA area that contains
RKS special instructions
SHIPMENT.SHIPPOI Required (O) LOCATION FROM Ship to location

NT HZ_CUST_SITE_USE
S_ALL based on
theWSH_NEW_DELI
VERIES.ULTIATE_D
ROPOFF_LOCATION
_ID
SHIPMENT.SHIPPRI Not used Not used Not used

OR

Table.Column
SHIPMENT.SHIPSRV Optional (B) WSH_NEW_DELIVE Service level of the

LVL RIES.SERVICE_LEVE shipment
L
SHIPMENT.SPECIAL Not used Not used Not used

HND
SHIPMENT.STAGEP Not used Not used Not used

OINT

TURE (ACTUAL)

TURE (DELIVERY)

TURE (LOADING)
SHIPMENT.TRANS Optional (B) WSH_NEW_DELIVE Identifies the general

METHD RIES.MODE_OF_TRA type of carrier
NSPORT transportation used
to deliver goods
SHIPMENT.TRANST Optional (B) WSH_NEW_DELIVE Ownership transfer

ERMS RIES.FOB_CODE terms
SHIPMENT.WAREH Optional (B) WSH_NEW_DELIVE The storage facility

OUSE RIES.ORGANIZATIO for inventory
N_ID
Table.Column
SHIPMENT.USERAR Optional (B) WSH_NEW_DELIVE The USERAREA is

EA RIES.DELIVERY_NA defined by
ME embedding elements
ORACLE.DELIVERY and attributes for
_NAME WSH_NEW_DELIVE each new Field
RIES.LOADING_SEQ Identifier or Segment
ORACLE.LOADING_ UENCE
SEQUENCE needed within the
WSH_NEW_DELIVE USERAREA. When a
ORACLE.VEHICLE_ RY descriptive flex new Field Identifier
NUM_PREFIX fields or a new Segment is
determined to be
ORACLE.VEHICLE_ WSH_TRIPS.VEHICL necessary, and it is
NUMBER E_NUM_PREFIX not included in the
ORACLE.ROUTE_ID OAGIS specification,
WSH_TRIPS.VEHICL new tags can be
ORACLE.ROUTING_ E_NUMBER developed by the
INSTRUCTIONS WSH_TRIPS.ROUTE_ project team for the
ID specific integration
ORACLE.DEPARTU
project. These new
RE_SEAL_CODE WSH_TRIPS.ROUTIN tags can then be used
ORACLE.ORIG_DOC G_INSTRUCTIONS to describe the fields
ID and segments within
WSH_TRIP_STOPS.D
the USERAREA. The
ORACLE.CUSTOME EPARTURE_SEAL_C
USERAREA may
R_NAME ODE
contain multiple
fields or segments
ORACLE.CUSTOME
coded in this way.
R_NUMBER
These are all
ORACLE.WAYBILL embedded within the
one special field
ORACLE.INTMED_S called USERAREA.
HIP_TO_LOCATION
ORACLE.MANUAL_
WV
ORACLE.SHIPMENT
_DIRECTION
ORACLE.OPERATO
R
ORACLE.DESCRIPTI
VE_FLEXFIELDS

Table.Column
PARTNER. Required (O) Partner area for

Customer, Supplier,
Ship From, or Ship
To
PARTNER.NAME Required (O) - If this partner Corporate name of a

segment is the Ship business entity in the
To segment, get the shipment address
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.ULTIMATE_DR
OPOFF_LOCATION_
ID
- If this partner
segment is the Ship
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.ORGANIZATIO
N_ID
- If this partner
segment is the
Customer segment,
get the
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.CUSTOMER_ID
- If this partner
segment is the
Supplier segment, get
the
HZ_PARTIES.NAME
for the
WSH_NEW_DELIVE
RIES.ORGANIZATIO
N_ID
PARTNER.ONETIME Not used Not used Not used
Table.Column
PARTNER.PARTNRI Required (O) LOCATION FROM Partner ID

D HZ_CUST_SITE_USE
S_ALL based on
WSH_NEW_DELIVE
RIES.ULTIMATE_DR
OPOFF_LOCATION_
ID converted to
external value, or
LOCATION_CODE
FROM
HR_LOCATIONS_AL
L_TL based on
WSH_NEW_DELIVE
RIES.INITIAL_PICKU
P_LOCATION_ID
AND
ORGANIZATION_ID
value.

Table.Column
PARTNER.PARTNRT Required (O) WSH_LOOKUPS.ME Indicates the type of

YPE ANING based on partner entity.
lookup type =
'WSH_PARTNER_TY Valid values are:
PE' (Values are 1) "ShipTo" - The
'ShipFrom' or delivery location of
'ShipTo') the customer.
2) "BillTo" - The
customer location the
bill goes to.
3) "SoldTo" - The
customer who is
responsible for
ordering the goods or
services.
4) "Supplier" - The
partner who is
responsible for
providing the goods
or services.
5) "Carrier" - The

partner responsible
for delivering the
goods or services.
6) "ShipFrom" - The
shipping location of
the partner who is
responsible for
providing the goods
or services. Ship from
can be at multiple
organizational levels
PARTNER.ACTIVE Not used Not used Not used
PARTNER.CURREN Optional (O) WSH_NEW_DELIVE Indicates the

CY RIES.CURRENCY_C currency
ODE
PARTNER.DESCRIP Optional (O) Partner description

TN
Table.Column
PARTNER.DUNSNU Optional (O) HZ_PARTIES.DUNS_ Partner Dun and

MBER NUMBER for Ship To Bradstreet number
PARTNER.GLENTIT Not used Not used Not used

YS
PARTNER.NAME2- Not used Not used Not used

NAME9
PARTNER.PARENTI Not used Not used Not used

D
PARTNER.PARTNID Not used Not used Not used

X

RATG

ROLE
PARTNER.PAYMET Not used Not used Not used

HOD
PARTNER.TAXEXE Not used Not used Not used

MPT
PARTNER.TAXID Not used Not used Not used
PARTNER.TERMID Not used Not used Not used
PARTNER.USERARE Optional (O) WSH_NEW_DELIVE Partner data user

A RIES.INTMED_SHIP_ area
TO_LOCATION_ID
WSH_
NEW_DELIVERIES.P
OOLED_SHIP_TO_L
OCATION_ID

Table.Column
PARTNER – Required (O) This area is for the

ADDRESS. partner address
information
PARTNER– Required (O) Extracted from the Partner address

ADDRESS.ADDRLIN WSH_LOCATIONS
E1-ADDRLINE9 using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.

ADDRESS.ADDRTYP
E
PARTNER– Required (O) Extracted from the Partner city

ADDRESS.CITY WSH_LOCATIONS
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Required (O) Extracted from the Partner country

ADDRESS.COUNTR WSH_LOCATIONS
Y using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
Table.Column
PARTNER– Optional (O) Extracted from the Partner county

ADDRESS.COUNTY WSH_LOCATIONS
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Optional (O) Partner address

ADDRESS.DESCRIPT description
N
PARTNER– Optional (O) HZ_CONTACT_POI Partner fax numbers

ADDRESS.FAX1-FAX NTS.RAW_PHONE_
9 NUMBER for the
PARTY_ID, and
CONTACT_POINT_T
YPE = "FAX" for "Ship
To" and
HR_LOCATIONS_AL
L.TELEPHONE_NU
MBER_2 for "Ship
From"
PARTNER– Required (O) Extracted from the Partner postal code

ADDRESS.POSTALC WSH_LOCATIONS
ODE using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.

Table.Column
PARTNER– Optional (O) Extracted from the Partner region

ADDRESS.REGION WSH_LOCATIONS
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.
PARTNER– Required (O) Extracted from the Partner state or

ADDRESS.STATEPR WSH_LOCATIONS province
OVN using the location id
From, Ship TO,
Customer and
Supplier from the
WSH_NEW_DELIVE
RIES table.

ADDRESS.TAXJRSD
CTN
PARTNER– Required (O) HZ_CONTACT_POI Partner telephone

ADDRESS.TELEPHO NTS.RAW_PHONE_ numbers
NE1-TELEPHONE9 NUMBER for the
PARTY_ID, and
CONTACT_POINT_T
YPE = "GEN" for "
Ship To" and
HZ_LOCATIONS_AL
L.TELEPHONE_NU
MBER_1 for "Ship
From".
PARTNER– Optional (O) HZ_CONTACT_POI Partner web site URL

ADDRESS.URL NTS.URL for the
PARTY_ID and
CONTACT_POINT_T
YPE = "GEN" for "
Ship To"
Table.Column

ADDRESS.USERARE
A
PARTNER – Required (O) Partner contact

CONTACT. information
PARTNER– Required (O) HZ_PARTIES.PERSO Partner contact name

CONTACT.NAME1 N_FIRST_NAME +
PERSON_MIDDLE_N
AME +
PERSON_LAST_NA
ME based on
location on
wsh_new_deliveries
and based on
ship_to_contact_id on
wsh_delivery_details

CONTACT.CONTCT
TYPE

CONTACT.DESCRIP
TN

CONTACT.EMAIL

CONTACT.FAX1 -
FAX9

Table.Column
PARTNER– Optional (O) HZ_PARTIES.PERSO Additional partner

CONTACT.NAME2 - N_FIRST_NAME + contact names
NAME9 PERSON_MIDDLE_N
AME +
PERSON_LAST_NA
ME based on
location on
wsh_new_deliveries
and based on
PARTNER– Optional (O) HZ_CONTACT_POI Partner contact

CONTACT.TELEPH NTS.RAW_PHONE_ phone numbers
ONE1 NUMBER based on
-TELEPHONE9 customer and ship to
location on
wsh_new_deliveries
and based on

CONTACT.USERAR
EA

details of the
document type
Table.Column
DOCUMNTREF.DOC Required (O) 'SR' ( SHIPMENT The document type:

TYPE REQUEST FOR SHIPMENT_REQUE
OUTBOUND) AND ST
'SA' (SHIMENT
ADVICE FOR
INBOUND) at the
Supplier Instance. 'SA'
( SHIPMENT
ADVICE FOR
OUTBOUND) AND
'SR' (SHIMENT
REQUEST FOR
INBOUND) at the
Third Party
Warehouse Instance.
DOCUMNTREF.DOC Required (O) WSH_TRANSACTIO The document ID

UMENTID NS_HISTORY.ORIG_
DOCUMENT_NUMB
ER
DOCUMNTREF.PAR Optional (O) ORGANIZATION_C The partner ID

TNRID ODE based
onWSH_NEW_DELI
VERIES.ORGANIZA
TION_ID

TNRTYPE

CRIPTN

UMENTRV

ENUM

ES1 – NOTES9

Table.Column

LINENUM

LINENUM

RAREA
SHIPITEM. Required (O) Represents the

request to ship
goods
SHIPITEM.ITEM Required (O) WSH_DELIVERY_DE Contains the

TAILS.INVENTORY_ identifier of the item
ITEM_ID (foreign key
to
MTL_SYSTEM_ITEM
S)
Derive Item_Number
from
MTL_SYSTEM_ITEM
S
SHIPITEM.QUANTIT Required (O) WSH_DELIVERY_DE Indicates the quantity

Y (ITEM) TAILS.REQUESTED_ of items to be
QUANTITY shipped

(EXTENDED)

(ITEM)
SHIPITEM.COUNTR Required (O) WSH_DELIVERY_DE Country of origin

YORG TAILS.COUNTRY_O
F_ORIGIN
SHIPITEM.DISPOSIT Not used Not used Not used

N
Table.Column
SHIPITEM.EXPORTL Not used Not used Not used

IC
SHIPITEM.FRGHTCL Optional (O) MTL_CATEGORY_SE Qualifies goods for

S TS_VL.CATEGORY_S purposes of freight
ET_NAME based on cost calculation
WSH_DELIVERY_DE
TAILS.FREIGHT_CL
ASS_CAT_ID
value
SHIPITEM.FRGHTIT Not used Not used Not used

EM
SHIPITEM.HAZRDM Optional (O) PO_HAZARD_CLAS Contains a hazardous

ATL SES_VL . material code or
HAZARD_CLASS description that can
based on be a free form area or
WSH_DELIVERY_DE an agreed upon set of
TAILS.HAZARD_CL codes for the
ASS_ID converted to applications
external value.
SHIPITEM.IMPORTL Not used Not used Not used

IC
SHIPITEM.ITEMDES Optional (O) WSH_DELIVERY_DE Item description

C TAILS.ITEM_DESCRI
PTION
SHIPITEM.ITEMRV Optional (O) WSH_DELIVERY_DE Item revision code

TAILS.REVISION
SHIPITEM.ITEMRVX Not used Not used Not used
SHIPITEM.ITEMX Optional (O) MTL_CUSTOMER_IT Customer's item

EMS.CUSTOMER_IT number
EM_NUMBER based
on
WSH_DELIVERY_DE
TAILS.CUSTOMER_I
TEM_ID

Table.Column
SHIPITEM.LINENU Not used Not used Not used

M
SHIPITEM.LOTLEVE Not used Not used Not used

L1 – LOTLEVEL2
SHIPITEM.NOTES1 – Optional (O) Notes 1 Item notes

NOTES9 WSH_DELIVERY_DE
TAILS.PACKING_IN
STRUCTIONS
SHIPITEM.OWNRSH Optional (O) WSH_DELIVERY_DE Used to identify who

PCDE TAILS.FOB_CODE or which
organization owns
the item or part. The
content of this Field
ID is user defined
based on a specific
Customer or Supplier

DESC
SHIPITEM.PARTIAL Not used Not used Not used

SHIP
SHIPITEM.QUANTIT Required (I) Calculate Quantity of items

Y (BACKORDERD) WSH_DELIVERY_DE backordered
TAILS.BACKORDER
ED_QUANTITY.
SHIPITEM.QUANTIT Not used Not used Not used

Y (OPEN)
SHIPITEM.QUANTIT Required (B) WSH_DELIVERY_DE The quantity of a

Y (ORDERED) TAILS.SRC_REQUES material or product
TED_QUANTITY ordered by the
customer
Table.Column
SHIPITEM.QUANTIT Required (B) WSH_DELIVERY_DE Represents the actual

Y (SHIPPED) TAILS.SHIPPED_QU quantity shipped
ANTITY
SHIPITEM.QUANTIT Optional (B) WSH_DELIVERY_DE The volume, or

Y (VOLUME) TAILS.VOLUME amount of space, that
is occupied by an
item, container or
shipment
SHIPITEM.QUANTIT Required (B) WSH_DELIVERY_DE The weight of an

Y (WEIGHT) TAILS.NET_WEIGHT item, container, or
shipment
SHIPITEM.SHIPMAT Not used Not used Not used

LID
SHIPITEM.SHIPNOT Optional (B) WSH_DELIVERY_DE Notes area used for

ES TAILS.SHIPPING_IN any additional
STRUCTIONS information
SHIPITEM.SHIPPRIO Not used Not used Not used

R
SHIPITEM.SHIPMTL Not used Not used Not used

DESC
SHIPITEM.UPC Not used Not used Not used

Table.Column
SHIPITEM.USERARE Optional (B) WSH_DELIVERY_DE Ship item user area

A TAILS.DELIVERY_D
ETAIL_ID
ORACLE.DELIVERY
_DETAIL_NUMBER WSH_DELIVERY_AS
SIGNMENTS.PAREN
ORACLE.PARENT_D T_DELIVERY_DETAI
ELIVERY_DETAIL_N L_ID
UMBER
WSH_DELIVERY_DE
ORACLE.SHIP_TOLE TAILS.SHIP_TOLER
RANCE_ABOVE ANCE_ABOVE
ORACLE.SHIP_TOLE WSH_DELIVERY_DE
RANCE_BELOW TAILS.SHIP_TOLER
ORACLE.LOAD_SEQ ANCE_BELOW
UENCE_NUMBER WSH_DELIVERY_DE
ORACLE.SHIP_SET_ TAILS.LOAD_SEQUE
NUMBER NCE_NUMBER
ORACLE.SUBINVEN WSH_DELIVERY_DE
TORY TAILS descriptive
flexfields
ORACLE.TOP_MOD
EL_LINE_NUMBER WSH_DELIVERY_DE
TAILS.SHIP_SET_ID
ORACLE.SHIP_MOD
EL_COMPLETE_FLA WSH_DELIVERY_DE
G TAILS.SUBINVENTO
RY
ORACLE.COMMODI
TY_CODE_CATEGO WSH_DELIVERY_DE
RY TAILS.TOP_MODEL_
LINE_ID
ORACLE.SHIPMENT
_PRIORITY_CODE WSH_DELIVERY_DE
TAILS.SHIP_MODEL
ORACLE.DELIVER_ _COMPLETE_FLAG
TO_LOCATION
WSH_DELIVERY_DE
ORACLE.CUSTOME TAILS.COMMODITY
R_NAME _CODE_CAT_ID
converted to code
ORACLE.CUSTOME
R_NUMBER WSH_DELIVERY_DE
TAILS.SHIPMENT_P
ORACLE.TXN_SRC_ RIORITY_CODE
LINE_NUMBERQUA converted to "01", "02"
Table.Column
NTITY , or "03" for XML,.

(TOTWEIGHT)
WSH_DELIVERY_DE
ORACLE.MANUAL_ TAILS.DELIVER_TO_
WV LOCATION_ID
ORACLE.LINE_DIRE CONTACT segment

CTION sends CONTACT
NAME and PHONE
ORACLE.REQUEST_ NUMBER of the
DATE_TYPE_CODE contact based on the
DATETIME ship_to_contact_id on
(ORACLE.EARLSTPI wsh_delivery_details.
CK)
SHIPITEM.USERARE
A (continued)
DATETIME
(ORACLE.LATESTPI
CK)
DATETIME
(ORACLE.EARLSTD
ROP)
DATETIME
(ORACLE.LATESTD
ROP)
DATETIME
(ORACLE.SCHEDUL
ED)
DATETIME
(ORACLE.REQUEST
ED)
CONTACT Segment
CHARGE. Optional (B) Represents additional

freight or
transportation
charges associated
with the SHPITEM

Table.Column
CHARGE.CHARGEI Required (B) WSH_FREIGHT_COS Charge ID

D T_TYPES.NAME
based on
WSH_FREIGHT_COS
TS.FREIGHT_COST_
TYPE_ID converted to
external value
CHARGE.OPERAMT Required (B) WSH_FREIGHT_COS Extended operating

(EXTENDED) (T) TS.UNIT_AMOUNT cost amount
WSH_FREIGHT_COS
TS.CURRENCY_COD
E
CHARGE.AMOUNT Not used Not used Not used

(EXTENDED) (T)
CHARGE.CHARGET Optional (B) WSH_FREIGHT_COS Charge type

YPE T_TYPES.NAME
based on
WSH_FREIGHT_COS
TS.FREIGHT_COST_
FREIGHT_COST_TYP
E
CHARGE.CHGLINE Not used Not used Not used

NUM
CHARGE.DESCRIPT Not used Not used Not used

N
CHARGE.USERARE Optional (I) WSH_FREIGHT_COS User area

A TS descriptive
flexfields
INVDETAIL. Required (I) Inventory item

attribute detail
associated with the
SHIPITEM
Table.Column
INVDETAIL.DESCRI Optional (I) WSH_DELIVERY_DE Inventory item

PTN TAILS.ITEM_DESCRI description
PTION
INVDETAIL.DISPOSI Not used Not used Not used

TN
INVDETAIL.LOTLEV Optional (B) WSH_DELIVERY_DE Lot is the identifier

EL1 – LOTLEVEL2 TAILS.LOT_NUMBE that is assigned to a
R specific
manufactured or
WSH_DELIVERY_DE purchased
TAILS.SUBLOT_NU item/product in a
MBER specific quantity and
is used to track that
grouping of
item/product. The
Field Identifiers
LOTLEVEL1 -
LOTLEVEL2 are used
to identify lots and
subdivisions of lots
Use of Field Identifier

LOTLEVEL2 requires
that LOTLEVEL1
must exist and have
value
INVDETAIL.NOTES1 Not used Not used Not used

- NOTES9
INVDETAIL.QUANT Required (B) WSH_DELIVERY_DE Item quantity

ITY (ITEM) TAILS.REQUESTED
QUANTITY/WSH_D
ELIVERY_DETAILS.R
EQUESTED_QUANTI
TY_UOM
INVDETAIL.SERIAL Optional (B) WSH_DELIVERY_DE Item serial number

NUM TAILS.SERIAL_NUM
BER

Table.Column
INVDETAIL.USERA Optional (B) WSH_DELIVERY_DE Item user area

REA TAILS.TO_SERIAL_N
UMBER
WSH_DELIVERY_DE
TAILS.PREFERRED_
GRADE

details of the
document type
DOCUMNTREF.DOC Required (O) Literal Purchase The document type:

TYPE Order SHIPMENT_REQUE
ST
DOCUMNTREF.DOC Optional (O) WSH_DELIVERY_DE The document ID

UMENTID TAILS.CUST_PO_NU
MBER
DOCUMNTREF.PAR Optional (O) DELIVER TO The partner ID

TNRID LOCATION based on
the
WSH_DELIVERY_DE
TAILS.DELIVER_TO_
LOCATION_ID

TNRTYPE

CRIPTN

UMENTRV

ENUM

ES1 – NOTES9
Table.Column

LINENUM

LINENUM

RAREA
CHARGE. Required (I) Represents additional

freight or
transportation
charges associated
with the shipment

D TS.FREIGHT_COST_
external value
CHARGE.OPERAMT Required (I) WSH_FREIGHT_COS Total operations

(EXTENDED) TS.TOTAL_AMOUN charges
T
WSH_FREIGHT_COS
TS.CURRENCY_COD
E
CHARGE.AMOUNT Required (I) Total charges

(EXTENDED) (T)
CHARGE.CHARGET Optional (I) WSH_FREIGHT_COS Charge type

FREIGHT_COST_TYP
E
CHARGE.CHGLINE Optional (I) Line number that the

NUM charge is in reference
to
CHARGE.DESCRIPT Optional (I) Description of the

N charge

Table.Column
CHARGE.USERARE Optional (I) WSH_FREIGHT_COS Charge user area

A TS descriptive
flexfields
DISTRIBUTION. Not used Not used Not used
DISTRIBUTION.BUS Not used Not used Not used

NAREA
DISTRIBUTION.COS Not used Not used Not used

TCENTER
DISTRIBUTION.DEP Not used Not used Not used

ARTMENT
DISTRIBUTION.DIVI Not used Not used Not used

SION
DISTRIBUTION.ELE Not used Not used Not used

MENT1 - ELEMENT
999
DISTRIBUTION.FUN Not used Not used Not used

D
DISTRIBUTION.GEO Not used Not used Not used

GRAPHY
DISTRIBUTION.GLE Not used Not used Not used

NTITYS
DISTRIBUTION.GLN Not used Not used Not used

OMACCT
DISTRIBUTION.OPE Not used Not used Not used

RAMT (EXTENDED)
(T)

FITCTR
Table.Column

JECT
DISTRIBUTION.UNI Not used Not used Not used

T
DISTRIBUTION.WA Not used Not used Not used

REHOUSE
DISTRIBUTION.USE Not used Not used Not used

RAREA
SHIPUNIT. Required (B) Represents a single

trackable shipping
unit. A shipping unit
is a uniquely
identifiable assembly
or container that
holds one or more
items to be shipped
SHIPUNIT.CARRIER Optional (B) WSH_DELIVERY_DE Carrier of the ship

TAILS.CARRIER_ID unit
value
SHIPUNIT.SHIPPERI Required (B) HR_LOCATIONS_TL The identifier of the

D _ALL.LOCATION_C partner who is
ODE based on responsible for
WSH_DELIVERY_DE packaging inventory
TAILS.SHIP_FROM_ goods for shipment
LOCATION_ID
value.
SHIPUNIT.TRACKIN Optional (B) WSH_DELIVERY_DE A unique identifier

GID TAILS.TRACKING_N for the purpose of
UMBER tracking an
individual package or
shipment

T (DECLAREVAL)

Table.Column

T (FREIGHT( (T)

T (ITEM) (T)

T (TOTAL) (T)
SHIPUNIT.CARRSR Optional (B) WSH_NEW_DELIVE Service level for the

VLVL RIES.SERVICE_LEVE ship unit
L
SHIPUNIT.CONTNR Optional (B) WSH_DELIVERY_DE Seal number on the

SEAL TAILS.SEAL_CODE ship unit
SHIPUNIT.COUNTR Not used Not used Not used

YDST
SHIPUNIT.COUNTR Optional (B) WSH_DELIVERY_DE Container country

YORG TAILS.COUNTRY_O organization
F_ORIGIN
SHIPUNIT.DATETIM Optional (B) WSH_TRIP_STOPS.A Actual delivery date

E (DELIVACT) CTUAL_ARRIVAL_D and time
ATE
SHIPUNIT.DATETIM Optional (B) WSH_DELIVERY_DE Delivery schedule

E (DELIVSCHED) TAILS.DATE_SCHED date and time
ULED

E (LOADING)
SHIPUNIT.DATETIM Required (I) WSH_TRIP_STOPS.A Shipment date and

E (SHIP) CTUAL_DEPARTUR time
E_DATE
SHIPUNIT.DESCRIP Not used Not used Not used

TN
Table.Column
SHIPUNIT.EXPORTL Not used Not used Not used

IC
SHIPUNIT.FRGHTC Optional (B) MTL_CATEGORY_SE Freight class of the

LS TS_VL.CATEGORY_S ship unit
ET_NAME based on
WSH_DELIVERY_DE
TAILS.FREIGHT_CL
ASS_CAT_ID
value
SHIPUNIT.FRGTHTE Optional (B) WSH_DELIVERY_DE Ship unit freight

RMS TAILS.FREIGHT_TER terms
MS_CODE converted
to external value
SHIPUNIT.HAZRDM Optional (B) WSH_DELIVERY_DE Contains a hazardous

ATL TAILS.HAZARD_CL material code or
ASS_ID converted to description that can
external value be a free form area or
an agreed upon set of
codes for the
applications involved
in an integration
scenario
SHIPUNIT.IMPORTL Not used Not used Not used

IC
SHIPUNIT.LOADPOI Not used Not used Not used

NT
SHIPUNIT.NOTES1 - Optional (B) WSH_DELIVERY_DE Notes for the ship

NOTES9 TAILS.PACKING_IN unit
STRUCTIONS
SHIPUNIT.OPERAM Not used Not used Not used

T (FREIGHT)

G

Table.Column

GDESC

TY (ESTWEIGHT)
SHIPUNIT.QUANTI Optional (B) Populate from Height of the ship

TY (HEIGHT) MTL_SYSTEM_ITEM unit
S
SHIPUNIT.QUANTI Optional (B) Populate from Length of the ship

TY (LENGTH) MTL_SYSTEM_ITEM unit
S
SHIPUNIT.QUANIT Optional (B) Calculate Loading weight of

TY (LOADINGWT) the ship unit
WSH_DELIVERY_DE
TAILS.GROSS
WEIGHT -
WSH_DELIVERY_DE
TAILS.NET WEIGHT
SHIPUNIT.QUANTI Optional (B) WSH_DELIVERY_DE Net weight of the

TY (NETWEIGHT) TAILS.NET_WEIGHT ship unit
+
WSH_DELIVERY_DE
TAILS.WEIGHT_UO
M_CODE for delivery
SHIPUNIT.QUANTI Required (B) WSH_DELIVERY_DE Total weight of the

TY (TOTWEIGHT) TAILS.GROSS_WEIG ship unit
HT +
WSH_DELIVERY_DE
TAILS.WEIGHT_UO
M_CODE
Table.Column
SHIPUNIT.QUANTI Optional (B) WSH_DELIVERY_DE Volume of the ship

TY (VOLUME) TAILS.VOLUME + unit
WSH_DELIVERY_DE
TAILS.VOLUME_UO
M_CODE for delivery

TY (WIDTH)
SHIPUNIT.SHIPMAT Optional (B) WSH_DELIVERY_DE The delivery detail id

LID TAILS.INVENTORY_ of the container
ITEM_ID converted to record
Item Number by
joining to
mtl_system_items
SHIPUNIT.SHIPNOT Optional (B) WSH_DELIVERY_DE The shipping

ES TAILS.SHIPPING_IN instructions or notes
STRUCTIONS
SHIPUNIT.SHIPPOI Optional (B) WSH_DELIVERY_DE Identifies the location

NT TAILS.DELIVER_TO_ the goods are to be
LOCATION_ID shipped
converted to
LOCATION_CODE
SHIPUNIT.SHIPSRV Optional (B) WSH_NEW_DELIVE A generic code that

LVL RIES.SERVICE_LEVE specifies a particular
L type or quality of
carrier delivery
service to be used for
transporting goods
SHIPUNIT.SHPMTL Optional (B) WSH_DELIVERY_DE Describes the

DESC TALS.ITEM_DESCRI material or container
PTION a product or item is
shipped in

SEQ

Table.Column

STS

TOT
SHIPUNIT.SPECIAL Not used Not used Not used

HND
SHIPUNIT.STAGEPO Not used Not used Not used

INT

TURE (ACTUAL)

TURE (DELIVERY)

TURE (LOADING)
SHIPUNIT.TRACKIN Not used Not used Not used

GIDTYPE
SHIPUNIT.TRANSM Optional (B) WSH_NEW_DELIVE Transportation

ETHD RIES.MODE_OF_TRA method
NSPORT
SHIPUNIT.TRANSTE Optional (B) WSH_NEW_DELIVE A contractual code

RMS RIES.FOB_CODE used to describe the
point where delivery
occurs (goods
ownership is
transferred) in a
contract of sale
Table.Column
SHIPUNIT.USERARE Optional (B) WSH_DELIVERY_DE User area for the ship

A TAILS.DELIVERY_D unit
ETAIL_ID
(To be called as
DELIVERY_DETAIL_
NUMBER)
WSH_DELIVERY_DE
TAILS.PACKING_IN
STRUCTIONS
WSH_DELIVERY_DE
TAILS.DESCRIPTIVE
_FLEXFIELDS
WSH_DELIVERY_DE
TAILS.LOT_NUMBE
R
WSH_DELIVERY_DE
TAILS.SUBLOT_NU
MBER
WSH_DELIVERY_DE
TAILS.REVISION
WSH_DELIVERY_DE
TAILS.SERIAL
NUMBER
WSH_DELIVERY_DE
TAILS.TO_SERIAL
NUMBER
CONTAINER. Optional (B) Represents

information about an
intermediate
packaging level
within the shipping
unit. A CONTAINER
may or may not have
INVITEM inventory
associated with it

Table.Column
CONTAINER.CONT Optional (B) WSH_DELIVERY_DE Container ID

AINRID TAILS.CONTAINER_
NAME
CONTAINER.CONT Optional (B) WSH_DELIVERY_DE Identifies the

NRSEAL TAILS.SEAL_CODE tamper-proof seal
placed on a shipping
container to prevent
pilfering of the
contents
CONTAINER.CONT Optional (B) WSH_DELIVERY_DE A classification of

NRTYPE TAILS.CONTAINER_ containers
TYPE_CODE
CONTAINER.DESCR Not used Not used Not used

IPTN
CONTAINER.NOTES Not used Not used Not used

1 - NOTES 9

NG

NGDESC
CONTAINER.PARC Not used Not used Not used

NTNRID
CONTAINER.SHIPM Optional (B) WSH_DELIVERY_DE Container part

ATLID TAILS.INVENTORY_ number
ITEM_ID converted to
ITEM NUMBER by
joining to
mtl_system_items
Table.Column
CONTAINER.USERA Optional (B) WSH_DELIVERY_AS User area for

REA SIGNMENTS.DELIVE additional
RY_DETAIL_ID (To information on the
be called as container
DELIVERY_DETAIL_
NUMBER)
WSH_DELIVERY_AS
SIGNMENTS.PAREN
T_DELIVERY_DETAI
L_ID (To be called as
PARENT_DELIVERY
_DETAIL_NUMBER)
HEIGHT – From
mtl_system_items
LENGTH - From
mtl_system_items
WEIGHT-
WSH_DELIVERY_DE
TAILS.
GROSS_WEIGHTWS
H_DELIVERY_DETA
ILS. NET_WEIGHT
VOLUME –
WSH_DELIVERY_DE
TAILS.VOLUME
WIDTH- From
mtl_system_items
LOT-
WSH_DELIVERY_DE
TAILS.LOT_NUMBE
R
SUBLOT-WSH_DELI
VERY_DETAILS.SUB
LOT_NUMBER
WSH_DELIVERY_DE
TAILS. REVISION

Table.Column
REA (continued) TAILS.SERIAL
NUMBER
WSH_DELIVERY_DE
TAILS.TO_SERIAL
NUMBER
WSH_DELIVERY_DE
TAILS.SHIP_FROM_
LOCATION_ID
converted to code (To
be called as
SHIP_FROM_LOCAT
ION LOCATION)
WSH_DELIVERY_DE
TAILS.DELIVER_TO_
LOCATION_ID (To
be called as
DELIVER_TO_LOCA
TION)
WSH_DELIVERY_DE
TAILS.TRACKING_N
UMBER
WSH_DELIVERY_DE
TAILS.COUNTRY_O
F_ORIGIN
WSH_TRIP_STOPS.A
CTUAL_ARRIVAL_D
ATE
WSH_DELIVERY_DE
TAILS.DATE_SCHED
ULED
WSH_TRIP_STOPS.A
CTUAL_DEPARTUR
E_DATE
WSH_DELIVERY_DE
TAILS.SHIP_METHO
D_CODE
Table.Column
REA (continued) TAILS.FREIGHT_CL
ASS_CAT_ID
value (To be called as
FREIGHT_CLASS_C
ATEGORY)
WSH_DELIVERY_DE
TAILS.FREIGHT_TER
MS_CODE converted
to external value
WSH_DELIVERY_DE
TAILS.HAZARD_CL
ASS_ID converted to
external value (To be
called as
HAZARD_CLASS or
as
HAZARD_CLASS_C
ODE)
WSH_DELIVERY_DE
TAILS.FOB_CODE
WSH_DELIVERY_DE
TAILS.SHIPPING_IN
STRUCTIONS
WSH_DELIVERY_DE
TAILS.PACKING_IN
STRUCTIONS
WSH_DELIVERY_DE
TAILS. Descriptive
Flexfields

Table.Column
INVITEM. Optional (B) Represents the

occurrence of a
goods inventory
packed within the
SHIPUNIT or
CONTAINER. The
inventory item
occurrence typically
refers to a line item or
shipping schedule
line of a sales order,
purchase order or
other business
document
INVITEM.ITEM Required (I) MTL_SYSTEM_ITEM Item number

S_KFV.
CONCATENATED_S
EGMENTS

Y (ITEM)

(EXTENDED) (T)

(ITEM) (T)
INVITEM.FRGHTCL Not used Not used Not used

S
INVITEM.FRGHTITE Not used Not used Not used

M
INVITEM.HAZRDM Not used Not used Not used

ATL
INVITEM.ITEMDESC Not used Not used Not used
INVITEM.ITEMRV Not used Not used Not used
Table.Column
INVITEM.ITEMRVX Not used Not used Not used
INVITEM.LOTLEVEL Not used Not used Not used

1 - LOTLEVEL2
INVITEM.NOTES 1 - Not used Not used Not used

NOTES 9
INVITEM.OWNRSH Not used Not used Not used

PCDE

Y (VOLUME)

Y (WEIGHT)
INVITEM.SHIPNOTE Not used Not used Not used

S
INVITEM.UPC Not used Not used Not used
INVITEM.USERARE Not used Not used Not used

A
The following represents the SHOW_SHIPMENT REQUEST XML data for third party
warehousing in Oracle Shipping Execution.

<SHOW_SHIPMENT_005>
<CNTROLAREA>
<BSR>
</BSR>
<SENDER>
<COMPONENT>FTE</COMPONENT>
<TASK>SSNO</TASK>
<REFERENCEID>P11510C2.US.ORACLE.COM:oracle.apps.wsh.sup.ssro:TPW346</REF
ERENCEID>
</SENDER>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>09</HOUR>
<MINUTE>44</MINUTE>
<SECOND>41</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SHOW_SHIPMENT>
<SHIPMENT>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>09</HOUR>
<MINUTE>44</MINUTE>
<SECOND>41</SECOND>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>09</HOUR>
<MINUTE>43</MINUTE>
<SECOND>57</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>23</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>

<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>23</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2005</YEAR>
<MONTH>04</MONTH>
<DAY>15</DAY>
<HOUR>23</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<VALUE>180</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>180</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>180</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE>12</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<SHIPPERID>V1- New York City</SHIPPERID>
<SYNCID>A</SYNCID>

<CARRIER/>
<CARRSRVLVL/>
<COUNTRYORG/>
<DESCRIPTN/>
<DISTCENTER/>
<DOCKID/>
<DOCUMENTRV/>
<DROPSHIP/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTTERMS/>
<HAZRDMATL/>
<HDRSTATUS/>
<IMPORTLIC/>
<LOADPOINT/>
<NOTES index="1"/>
<PARTIALSHP/>
<PRIORITY/>
<ROUTEID/>
<SHIPNOTES/>
<SHIPPRIOR/>
<SHIPSRVLVL/>
<SPECIALHND/>
<STAGEPOINT/>
<TRANSMETHD/>
<TRANSTERMS/>
<WAREHOUSE>V1</WAREHOUSE>
<USERAREA/>
<PARTNER>
<NAME index="1">Phoenix Manufacturing</NAME>
<ONETIME/>
<PARTNRID>V1- New York City</PARTNRID>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRLINE index="1">3200 East Camelback</ADDRLINE>
<ADDRLINE index="2">Suite 255</ADDRLINE>
<ADDRTYPE/>
<CITY>Phoenix</CITY>
<COUNTY/>
<DESCRIPTN/>
<FAX index="1">602-224-6250</FAX>
<REGION/>
<STATEPROVN>AZ</STATEPROVN>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<PARTNER>
<ONETIME/>
<PARTNRID/>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>

<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRTYPE/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1">Gerry Brown</NAME>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<TELEPHONE index="1">+1 (703) 8441212</TELEPHONE>
<USERAREA/>
</CONTACT>
</PARTNER>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>

<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>

<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>

<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>

<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<SHIPITEM>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>

<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>2</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>30</VALUE>
<NUMOFDEC/>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<COUNTRYORG/>
<DISPOSITN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<PACKING/>
<SHIPNOTES/>
<SHIPPRIOR/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</SHIPITEM>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<DOCUMNTREF>

<DOCUMENTID/>
<PARTNRID>V1</PARTNRID>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
</SHIPMENT>
</SHOW_SHIPMENT>
</DATAAREA>
Third Party Warehousing INBOUND Sample XML

The following represents the SHOW_SHIPMENT ADVICE XML data for third party
warehousing in Oracle Shipping Execution.
<SHOW_SHIPMENT_005>
<CNTROLAREA>
<BSR>
</BSR>
<SENDER>
<LOGICALID/>
<TASK>SSNO</TASK>
<REFERENCEID>HM000A:oracle.apps.wsh.sup.ssro:CMS437</REFERENCEID>
</SENDER>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>15</HOUR>
<MINUTE>18</MINUTE>
<SECOND>41</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SHOW_SHIPMENT>
<SHIPMENT>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>15</HOUR>
<MINUTE>18</MINUTE>
<SECOND>40</SECOND>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>

<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>54</MINUTE>
<SECOND>57</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>10</MINUTE>
<SECOND>17</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>10</MINUTE>
<SECOND>17</SECOND>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR>2003</YEAR>
<MONTH>01</MONTH>
<DAY>15</DAY>
<HOUR>14</HOUR>
<MINUTE>10</MINUTE>
<SECOND>17</SECOND>
</DATETIME>
<VALUE/>
<NUMOFDEC/>

<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<DOCUMENTID>367-I</DOCUMENTID>
<SYNCID>A</SYNCID>
<COUNTRYORG/>
<DESCRIPTN/>
<DISTCENTER/>
<DOCKID/>
<DOCTYPE>SA</DOCTYPE>
<DOCUMENTRV/>
<DROPSHIP/>
<EXPORTLIC/>
<FRGHTCLS/>
<HAZRDMATL/>
<HDRSTATUS/>
<IMPORTLIC/>
<LOADPOINT/>
<NOTES index="1"/>
<PARTIALSHP/>
<PRIORITY/>
<ROUTEID/>
<SHIPNOTES/>
<SHIPPRIOR/>
<SPECIALHND/>
<STAGEPOINT/>
<WAREHOUSE>M3</WAREHOUSE>
<USERAREA><ORACLE.SHOW_SHIPMENT_005.SHIPMENT.USERAREA><ORACLE.DELIVERY_N
AME>16401</ORACLE.DELIVERY_NAME><ORACLE.LOADING_SEQUENCE/><ORACLE.VEHICL
E_NUM_PREFIX/><ORACLE.VEHICLE_NUMBER/><ORACLE.ROUTE_ID/><ORACLE.ROUTING_
INSTRUCTIONS/><ORACLE.DEPARTURE_SEAL_CODE/><ORACLE.ORIG_DOCID>367</ORACL
E.ORIG_DOCID><ORACLE.CUSTOMER_NAME>Computer Service and
Rentals</ORACLE.CUSTOMER_NAME><ORACLE.CUSTOMER_NUMBER>1006</ORACLE.CUSTO
MER_NUMBER><ORACLE.WAYBILL/><ORACLE.INTMED_SHIP_TO_LOCATION/><ORACLE.DES
CRIPTIVE_FLEXFIELD><ORACLE.ATTRIBUTE_CATEGORY/><ORACLE.ATTRIBUTE1/><ORAC
LE.ATTRIBUTE2/><ORACLE.ATTRIBUTE3/><ORACLE.ATTRIBUTE4/><ORACLE.ATTRIBUTE
5/><ORACLE.ATTRIBUTE6/><ORACLE.ATTRIBUTE7/><ORACLE.ATTRIBUTE8/><ORACLE.A
TTRIBUTE9/><ORACLE.ATTRIBUTE10/><ORACLE.ATTRIBUTE11/><ORACLE.ATTRIBUTE12
/><ORA
CLE.ATTRIBUTE13/><ORACLE.ATTRIBUTE14/><ORACLE.ATTRIBUTE15/></ORACLE.DESC
RIPTIVE_FLEXFIELD></ORACLE.SHOW_SHIPMENT_005.SHIPMENT.USERAREA></USERARE
A>
<PARTNER>
<NAME index="1">Dallas Manufacturing</NAME>
<ONETIME/>
<PARTNRID>M3- Dallas</PARTNRID>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>

<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA><ORACLE.SHOW_SHIPMENT_005.SHIPMENT.PARTNER.USERAREA><ORACLE.IN
TMED_SHIP_TO_LOCATION/><ORACLE.POOLED_SHIP_TO_LOCATION/></ORACLE.SHOW_SH
IPMENT_005.SHIPMENT.PARTNER.USERAREA></USERAREA>
<ADDRESS>
<ADDRLINE index="1">222 West Las Colinas
Blvd</ADDRLINE>
<ADDRTYPE/>
<CITY>Irving</CITY>
<COUNTY/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<STATEPROVN/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<PARTNER>
<ONETIME/>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER/>
<GLENTITYS/>
<NAME index="2"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA><ORACLE.SHOW_SHIPMENT_005.SHIPMENT.PARTNER.USERAREA><ORACLE.IN
TMED_SHIP_TO_LOCATION/><ORACLE.POOLED_SHIP_TO_LOCATION/></ORACLE.SHOW_SH
IPMENT_005.SHIPMENT.PARTNER.USERAREA></USERAREA>
<ADDRESS>
<ADDRTYPE/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>

<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>
<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CHARGE>
<VALUE>75</VALUE>
<SIGN>+</SIGN>
<UOMVALUE>D</UOMVALUE>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<CHARGEID>Handling</CHARGEID>
<CHARGETYPE>Handling</CHARGETYPE>
<CHGLINENUM/>
<DESCRIPTN/>
<USERAREA><ORACLE.SHOW_SHIPMENT_005.SHIPMENT.CHARGE.USERAREA><ORACLE.DES
CRIPTIVE_FLEXFIELD><ORACLE.ATTRIBUTE_CATEGORY/><ORACLE.ATTRIBUTE1/><ORAC
LE.ATTRIBUTE2/><ORACLE.ATTRIBUTE3/><ORACLE.ATTRIBUTE4/><ORACLE.ATTRIBUTE
5/><ORACLE.ATTRIBUTE6/><ORACLE.ATTRIBUTE7/><ORACLE.ATTRIBUTE8/><ORACLE.A
TTRIBUTE9/><ORACLE.ATTRIBUTE10/><ORACLE.ATTRIBUTE11/><ORACLE.ATTRIBUTE12
/><ORACLE.ATTRIBUTE13/><ORACLE.ATTRIBUTE14/><ORACLE.ATTRIBUTE15/></ORACL
E.DESCRIPTIVE_FLEXFIELD></ORACLE.SHOW_SHIPMENT_005.SHIPMENT.CHARGE.USERA
REA></USERAREA>
<DISTRIBUTN>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<BUSNAREA/>
<COSTCENTER/>
<DEPARTMENT/>
<DIVISION/>
<ELEMENT index="1"/>
<FUND/>
<GEOGRAPHY/>
<GLENTITYS/>
<GLNOMACCT/>
<PROFITCTR/>
<PROJECT/>
<UNIT/>
<WAREHOUSE/>
<USERAREA/>
</DISTRIBUTN>
</CHARGE>
<DOCUMNTREF>
<DOCUMENTID/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
</SHIPMENT>
<SHIPUNIT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>

</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<AMOUNT qualifier="TOTAL" type="T">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<UOMVALUE/>
<UOMNUMDEC/>
<UOM/>
</OPERAMT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="HEIGHT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="LENGTH">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE>1</VALUE>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE>1001</VALUE>
<SIGN>+</SIGN>
<UOM>Lbs</UOM>
</QUANTITY>
<VALUE>1</VALUE>
<SIGN>+</SIGN>
<UOM>FT3</UOM>
</QUANTITY>
<QUANTITY qualifier="WIDTH">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>

<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
</TEMPRATURE>
<TRACKINGID>1Z4444441500000227</TRACKINGID>
<CONTAINRID>118081</CONTAINRID>
<CONTNRSEAL/>
<CONTNRTYPE>ALC</CONTNRTYPE>
<COUNTRYDST/>
<COUNTRYORG/>
<DESCRIPTN/>
<EXPORTLIC/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<IMPORTLIC/>
<LOADPOINT/>
<NOTES index="1"/>
<SHIPMATLID>A1 DOM</SHIPMATLID>
<SHIPNOTES/>
<SHPMTLDESC>A1 Domestic Airline Container</SHPMTLDESC>
<SHPUNITSEQ/>
<SHPUNITSTS/>
<SHPUNITTOT/>
<SPECIALHND/>
<STAGEPOINT/>
<USERAREA><ORACLE.SHOW_SHIPMENT_005.SHIPUNIT.USERAREA><ORACLE.DELIVERY_D
ETAIL_NUMBER>118081</ORACLE.DELIVERY_DETAIL_NUMBER><ORACLE.LOT_NUMBER/><
ORACLE.SUBLOT_NUMBER/><ORACLE.REVISION/><ORACLE.SERIAL_NUMBER/><ORACLE.T
O_SERIAL_NUMBER/><ORACLE.PACKING_INSTRUCTIONS/><ORACLE.DESCRIPTIVE_FLEXF
IELD><ORACLE.ATTRIBUTE_CATEGORY/><ORACLE.ATTRIBUTE1/><ORACLE.ATTRIBUTE2/
><ORACLE.ATTRIBUTE3/><ORACLE.ATTRIBUTE4/><ORACLE.ATTRIBUTE5/><ORACLE.ATT
RIBUTE6/><ORACLE.ATTRIBUTE7/><ORACLE.ATTRIBUTE8/><ORACLE.ATTRIBUTE9/><OR
ACLE.ATTRIBUTE10/><ORACLE.ATTRIBUTE11/><ORACLE.ATTRIBUTE12/><ORACLE.ATTR
IBUTE13/><ORACLE.ATTRIBUTE14/><ORACLE.ATTRIBUTE15/></ORACLE.DESCRIPTIVE_
FLEXFIELD></ORACLE.SHOW_SHIPMENT_005.SHIPUNIT.USERAREA></USERAREA>
<PARTNER>
<ONETIME/>
<SYNCIND/>
<ACTIVE/>
<CURRENCY/>
<DESCRIPTN/>
<DUNSNUMBER/>
<GLENTITYS/>
<NAME index="1"/>
<PARENTID/>
<PARTNRIDX/>
<PARTNRRATG/>
<PARTNRROLE/>
<PAYMETHOD/>
<TAXEXEMPT/>
<TAXID/>
<TERMID/>
<USERAREA/>
<ADDRESS>
<ADDRTYPE/>
<COUNTY/>
<DESCRIPTN/>
<FAX index="1"/>
<REGION/>
<TAXJRSDCTN/>
<URL/>
<USERAREA/>
</ADDRESS>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<CONTACT>
<NAME index="1"/>
<CONTCTTYPE/>
<DESCRIPTN/>
<EMAIL/>
<FAX index="1"/>

<NAME index="1"/>
<USERAREA/>
</CONTACT>
</PARTNER>
<ATTCHREF>
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
<SUBSECOND/>
<TIMEZONE/>
</DATETIME>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<CMPRSNTYPE/>
<CMPRSNID/>
<DESCRIPTN/>
<FILETYPE/>
<NOTES index="1"/>
<TITLE/>
<FILENAME/>
<USERAREA/>
</ATTCHREF>
<DOCUMNTREF>
<DOCTYPE/>
<DOCUMENTID/>
<PARTNRID/>
<PARTNRTYPE/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVITEM>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<ITEM/>
<COUNTRYORG/>
<FRGHTCLS/>
<FRGHTITEM/>
<HAZRDMATL/>
<ITEMDESC/>
<ITEMRV/>
<ITEMRVX/>
<ITEMX/>
<NOTES index="1"/>
<OWNRSHPCDE/>
<SHIPNOTES/>
<UPC/>
<USERAREA/>
<DOCUMNTREF>
<DOCTYPE/>
<DOCUMENTID/>
<PARTNRID/>
<PARTNRTYPE/>
<DESCRIPTN/>
<DOCUMENTRV/>
<LINENUM/>
<NOTES index="1"/>
<SCHLINENUM/>
<SUBLINENUM/>
<USERAREA/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<DESCRIPTN/>
<DISPOSITN/>
<NOTES index="1"/>
<SERIALNUM/>
<USERAREA/>
</INVDETAIL>
</INVITEM>
</SHIPUNIT>
</SHOW_SHIPMENT>

</DATAAREA>
Using XML Messaging with International Trade Management

Oracle Shipping Execution enables you to send and receive XML messages to and from
third party international trade management (ITM) systems. ITM systems provide
up-to-date information on country specific rules and regulations for importing and
exporting goods.
Oracle International Trade Management Adapter is an open interface that enables the
communication of Oracle Applications with third party ITM systems
Before using XML messaging with ITM, you must:
• Set up Oracle XML Gateway
• Set up Oracle ITM Adapter
• Set up Oracle XML Transport Agent
The XML transactions used for ITM are:

• Item Synchronization Request
• Party Synchronization Request
• Order Compliance Request
• Delivery Compliance Request
• Export Compliance Response
ItemSynchronization Request Transaction for ITM

Item Synchronization Request transaction is a modified version of the Open
Applications Group (OAG) document type definition (DTD). This DTD is used to send
item information from Oracle Shipping Execution to a third party international trade
management system, which is used for classification of the item. The ITM system does
not send a response to the ItemSyncronization Request.
This transaction contains information such as:
• Item number
• Hazard classification
• Unit of measure
PartySynchronization Request Transaction for ITM
Party Synchronization Request is a modified version of the Open Applications Group
(OAG) document type definition (DTD). This DTD is used to send export screening data
elements from Oracle Shipping execution to a third party international trade
management system. The ITM system does not send a response to the
PartySyncronization Request.
• Customer number
• Supplier number
• Federal tax ID number
• State tax ID number
• Operating unit
OrderCompliance Request for ITM

Order Compliance Request transaction is a modified version of the Open Applications
Group (OAG) document type definition (DTD). This DTD is used to send order and
order line information to a third party international trade management system for
verification of compliance. Each order line is evaluated for export compliance. Upon
completion of the evaluation, the ITM system sends verification information (pass or
fail) back to Oracle Shipping Execution.
• Order number
• Order type
• Item type
DeliveryCompliance Request Transaction for ITM

Delivery Compliance Request transaction is a modified version of the Open
Applications Group (OAG) document type definition (DTD) show_shipment_005. This
DTD is used by Oracle Shipping Execution to send delivery compliance information to
the third party international trade management system.

• Delivery name
• Customer
• Ship to address
• Ship to contact
• Requested pick up date and time
• Requested delivery date and time
• Weight
• Carrier
• Service level
ExportCompliance Response Transaction for ITM

Export Compliance Response transaction is a modified version of the Open
Applications Group (OAG) document type definition (DTD) show_shipment_005. This
DTD is used to receive export compliance status information (order and order line)
from a third party international trade management system to Oracle Shipping
Execution. This transaction is sent in response to the Delivery Compliance Request and
Order Compliance Request transactions.
• Delivery name
• Customer
• Ship to address
• Ship to contact
• Requested pick up date and time
• Requested delivery date and time
• Weight
• Carrier
• Service level
Overview of XML and DTD for ITM
The following contains the DTD and a sample XML used for each of the international
trade management XML transactions in Oracle Shipping Execution . Also, a table is
detailed for each ITM XML transaction, which displays all required element/attributes,
a description of each element, and the Oracle table and column for each
ITM DTDs
The following is the Item Synchronization Request DTD used for ITM in Oracle
Shipping Execution.

<!ENTITY % TYPEREQ "TYPE CDATA #REQUIRED">
<!ENTITY % LABELREQ "LABEL CDATA #REQUIRED">
<!ELEMENT ITEM_SYNC (CNTROLAREA, DATAAREA+)>
<!ELEMENT CNTROLAREA (BSR, SENDER, DATETIME)>
<!ELEMENT BSR (VERB, NOUN, REVISION)>
<!ELEMENT VERB (#PCDATA)>
<!ELEMENT NOUN (#PCDATA)>
<!ELEMENT REVISION (#PCDATA)>
<!ELEMENT SENDER (LOGICALID, COMPONENT, TASK, REFERENCEID, CONFIRMATION,
LANGUAGE, CODEPAGE, AUTHID)>
<!ELEMENT LOGICALID (#PCDATA)>
<!ELEMENT COMPONENT (#PCDATA)>
<!ELEMENT TASK (#PCDATA)>
<!ELEMENT REFERENCEID (#PCDATA)>
<!ELEMENT CONFIRMATION (#PCDATA)>
<!ELEMENT AUTHID (#PCDATA)>
<!ELEMENT LANGUAGE (#PCDATA)>
<!ELEMENT CODEPAGE (#PCDATA)>
<!ELEMENT TIMEZONE (#PCDATA)>
<!ELEMENT DATETIME (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, SUBSECOND,
TIMEZONE)>
<!ATTLIST DATETIME
qualifier CDATA #REQUIRED
type CDATA #IMPLIED
index CDATA #IMPLIED
>
<!ELEMENT YEAR (#PCDATA)>
<!ELEMENT MONTH (#PCDATA)>
<!ELEMENT DAY (#PCDATA)>
<!ELEMENT HOUR (#PCDATA)>
<!ELEMENT MINUTE (#PCDATA)>
<!ELEMENT SECOND (#PCDATA)>
<!ELEMENT SUBSECOND (#PCDATA)>
<!ELEMENT DATAAREA (ITEM+)>
<!ELEMENT ITEM (ITEM_ID, ITEM_CODE?, DESCRIPTION, HAZARD_CLASS?,
ORGANIZATION_ID?, SRC_ORGANIZATION_ID?,
ITEM_TYPE?, UNIT_OF_MEASURE?, ITEM_VALUE?, CURRENCY?, COUNTRY*,
USERAREA?)>
<!ELEMENT ITEM_ID (#PCDATA)>
<!ELEMENT ITEM_CODE (#PCDATA)>
<!ELEMENT DESCRIPTION (#PCDATA)>
<!ELEMENT HAZARD_CLASS (#PCDATA)>
<!ELEMENT ORGANIZATION_ID (#PCDATA)>
<!ELEMENT SRC_ORGANIZATION_ID (#PCDATA)>
<!ELEMENT ITEM_TYPE (#PCDATA)>
<!ELEMENT UNIT_OF_MEASURE (#PCDATA)>
<!ELEMENT ITEM_VALUE (#PCDATA)>
<!ELEMENT CURRENCY (#PCDATA)>
<!ELEMENT COUNTRY (#PCDATA)>
<!ELEMENT USERAREA ANY>
<!ELEMENT ORACLE.ITEM_SYNC.ITEM.USERAREA (ORACLE.LONG_DESCRIPTION?,
ORACLE.OPERATING_UNIT?, ORACLE.PARAMETERS*)>
<!ELEMENT ORACLE.LONG_DESCRIPTION (#PCDATA)>
<!ELEMENT ORACLE.OPERATING_UNIT (#PCDATA)>
<!ELEMENT ORACLE.PARAMETERS (ORACLE.PARAMETER*)>
<!ATTLIST ORACLE.PARAMETERS
TYPE (VENDOR | SERVICE | DATA) #REQUIRED
>
<!ELEMENT ORACLE.PARAMETER EMPTY>
<!ATTLIST ORACLE.PARAMETER
INDEX CDATA #REQUIRED
>
<!ATTLIST ORACLE.PARAMETER
NAME CDATA #IMPLIED
VALUE CDATA #REQUIRED
> d
The following is the Party Synchronization Request DTD used for ITM in Oracle
Shipping Execution.
sync_customerdt
<! - $Revision: 7.2.1 $
Open Applications Group DTD
Copyright 1998-2001, All Rights Reserved
$Name: 007_sync_customer_005.dtd $
Structure Overview
SYNC_CUSTOMER (PARTNER)
PARTNER ()
Notes:
- >
<! - ==================================================== - >
%RESOURCES;
<! - ==================================================== - >
<!ELEMENT SYNC_CUSTOMER_005 (CNTROLAREA, DATAAREA+)>
<!ATTLIST VERB
value CDATA #FIXED "SYNC"
>
<!ATTLIST NOUN
value CDATA #FIXED "CUSTOMER"
>
<!ATTLIST REVISION
value CDATA #FIXED "005"
>
<!ELEMENT DATAAREA (SYNC_CUSTOMER)>
<!ELEMENT SYNC_CUSTOMER (PARTNER)>
The following is the Order Compliance Request DTD used for ITM in Oracle Shipping
Execution.

<! -
$Author - Joe Smith$
$Date: 10 April 2003 $
Oracle
All Rights Reserved
- >
<!ELEMENT request (message_id?,admin, parameters?, transaction_date?,
addl_info?, (dp_request | order_line)+)>
<!ELEMENT message_id (#PCDATA)>
<!ELEMENT admin (subscriber_id, password, request_generator, revision)>
<!ELEMENT subscriber_id (#PCDATA)>
<!ELEMENT password (#PCDATA)>
<!ELEMENT request_generator (#PCDATA)>
<!ELEMENT revision (#PCDATA)>
<!ELEMENT parameters (parameter+)>
<!ATTLIST parameter name CDATA #REQUIRED>
<!ATTLIST parameter value CDATA #REQUIRED>
<!ELEMENT transaction_date (#PCDATA)>
<!ELEMENT addl_info (info*)>
<!ELEMENT info (#PCDATA) >
<!ATTLIST info index CDATA #REQUIRED>
<!ATTLIST info name CDATA #REQUIRED>
<!ELEMENT order_line (transaction_key, order_number?, order_type?,
org_id?, cust_po_num?,
transactional_curr_code?,
conversion_type_code?, conversion_rate?, ordered_date?,
shipping_method_code?,
request_date?, freight_terms_code?, paymet_terms_name?,
payment_term_id?, ordered_quantity?,
unit_selling_price?, line_number?, unit_list_price?,
parameters?,
item_id, party+ )>
<!ELEMENT transaction_key (#PCDATA)>
<!ELEMENT order_number (#PCDATA)>
<!ELEMENT order_type (#PCDATA)>
<!ELEMENT org_id (#PCDATA)>
<!ELEMENT cust_po_num (#PCDATA)>
<!ELEMENT transactional_curr_code (#PCDATA)>
<!ELEMENT conversion_type_code (#PCDATA)>
<!ELEMENT conversion_rate (#PCDATA)>
<!ELEMENT ordered_date (#PCDATA)>
<!ELEMENT shipping_method_code (#PCDATA)>
<!ELEMENT request_date (#PCDATA)>
<!ELEMENT freight_terms_code (#PCDATA)>
<!ELEMENT paymet_terms_name (#PCDATA)>
<!ELEMENT payment_term_id (#PCDATA)>
<!ELEMENT ordered_quantity (#PCDATA)>
<!ELEMENT unit_selling_price (#PCDATA)>
<!ELEMENT line_number (#PCDATA)>
<!ELEMENT unit_list_price (#PCDATA)>
<!ELEMENT item_id (#PCDATA)>
<!ELEMENT dp_request (ship_from_country, ship_to_country?, parameters,
party+ )>
<!ELEMENT ship_from_country (#PCDATA)>
<!ELEMENT ship_to_country (#PCDATA)>
<! - Note: that ONLY PARTY ID is mandatory. Hence only ID would be

used for Normal
parties and the details would be filled up for One-Time parties - >
<!ELEMENT party (party_id, type?, name?, address1?, address2?,
address3?, address4?, address5?,city?,
state_or_province?, country, postal_code?, contact_name?, email?,
phone?, fax?,
web?, addl_info?)>
<!ELEMENT party_id (#PCDATA)>
<!ELEMENT type (#PCDATA)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT address1 (#PCDATA)>
<!ELEMENT city (#PCDATA)>
<!ELEMENT state_or_province (#PCDATA)>
<!ELEMENT country (#PCDATA)>
<!ELEMENT postal_code (#PCDATA)>
<!ELEMENT contact_name (#PCDATA)>
<!ELEMENT email (#PCDATA)>
<!ELEMENT phone (#PCDATA)>
<!ELEMENT fax (#PCDATA)>
<!ELEMENT web (#PCDATA)>
The following is the Delivery Compliance Request DTD used for ITM in Oracle
Shipping Execution.

<! - ==================================================== - >
%RESOURCES;
<! - ==================================================== - >
<!ATTLIST VERB
value CDATA #FIXED "SHOW">
<!ATTLIST NOUN
value CDATA #FIXED "SHIPMENT">
<!ATTLIST REVISION
value CDATA #FIXED "005">
<!ELEMENT DATAAREA (SHOW_SHIPMENT)>
<!ELEMENT SHOW_SHIPMENT (SHIPMENT, SHIPUNIT*)>
(%DATETIME.DELIVSCHED;)?,(%DATETIME.EARLSTSHIP;)?,
USERAREA?, PARTNER+, SHIPITEM*, ATTCHREF*, CHARGE*, DOCUMNTREF*)>
CHARGE*)
>
>
>
>
USERAREA?, DOCUMNTREF*, INVDETAIL*)>
@
115.1.11510.1
log
@'mkbranch'
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.1.1159.1
log
@mkbranch
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.1.1158.1
log
@mkbranch
@
text
@d1 1
a1 1
rvishnuv ship $ - >
d6 2
a7 2
$Revision: 115.1 $
$Date: 2002/03/28 22:47:30 $
@
115.0
log
@initial version
@
text
@d1 1
a1 1
d6 2
a7 2
$Revision: 7.2.1 $

d11 1
a11 1
d22 1
a22 1
d59 1
a59 1
@
The following is the Export Compliance Response DTD used for ITM in Oracle
Shipping Execution.
<! -
$Author - Joe Smith$
$Date: 16 April 2003 $
Oracle Cooperation
All Rights Reserved
- >
<!ELEMENT EXPORT_COMPL_RESPONSE ( CNTROLAREA, DATAAREA+)>
<!ELEMENT CNTROLAREA (BSR, SENDER, DATETIME)>
<!ELEMENT BSR (VERB, NOUN, REVISION)>
<!ELEMENT VERB (#PCDATA)>
<!ELEMENT NOUN (#PCDATA)>
<!ELEMENT REVISION (#PCDATA)>
<!ELEMENT SENDER (LOGICALID, COMPONENT, TASK, REFERENCEID,
CONFIRMATION, LANGUAGE, CODEPAGE, AUTHID)>
<!ELEMENT LOGICALID (#PCDATA)>
<!ELEMENT COMPONENT (#PCDATA)>
<!ELEMENT TASK (#PCDATA)>
<!ELEMENT REFERENCEID (#PCDATA)>
<!ELEMENT CONFIRMATION (#PCDATA)>
<!ELEMENT LANGUAGE (#PCDATA)>
<!ELEMENT CODEPAGE (#PCDATA)>
<!ELEMENT AUTHID (#PCDATA)>
<!ELEMENT DATETIME (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, SUBSECOND,
TIMEZONE)>
<!ELEMENT YEAR (#PCDATA)>
<!ELEMENT MONTH (#PCDATA)>
<!ELEMENT DAY (#PCDATA)>
<!ELEMENT HOUR (#PCDATA)>
<!ELEMENT MINUTE (#PCDATA)>
<!ELEMENT SECOND (#PCDATA)>
<!ELEMENT SUBSECOND (#PCDATA)>
<!ELEMENT TIMEZONE (#PCDATA)>
<!ELEMENT DATAAREA ( MESSAGE+)>
<!ELEMENT MESSAGE (TRANSACTION_KEY, TRIGGERING_POINT,STATUS,
EXPORT_COMP_RESULT*, ERROR*)>
<!ELEMENT TRANSACTION_KEY (#PCDATA)>
<!ELEMENT TRIGGERING_POINT (#PCDATA)>
<!ELEMENT STATUS (#PCDATA)>
<!ELEMENT EXPORT_COMP_RESULT (TYPE, SUCCESS, DESCRIPTION)>
<!ELEMENT TYPE (#PCDATA)>
<!ELEMENT SUCCESS (#PCDATA)>
<!ELEMENT DESCRIPTION (#PCDATA)>
<!ELEMENT ERROR (TYPE, CODE, DESCRIPTION)>
<!ELEMENT CODE (#PCDATA)>
Sample ITM XML Transactions
ITM Sample Party Synchronization XML

The following table lists each of the ITM Party Synchronization XML
elements/attributes and whether they are required or optional. A sample XML
transaction follows the table.

ITM XML Field Information

Table.Column
CNTROL.AREA Required The fields included in

this area provide
XML document
CNTROLAREA..BSR Required Shows the Business

per OAGI
CNTROLAREA.VER Required Value is SYNC

B
CNTROLAREA.NOU Required Value is CUSTOMER

N
CNTROLAREA.REVI Required Value is 005

SION
CNTROLAREA.SEN Required Provides information

DER on the system that
sends the document
CNTROLAREA.SEN Required Sender system

DER.LOGICALID identifier
CNTROLAREA.SEN Required Sender application

DER.COMPONENT name. Value is WSH
CNTROLAREA.SEN Required Event or Action

DER.TASK
CNTROLAREA.SEN Required Unique reference ID

DER.REFERENCEID for this document
CNTROLAREA.SEN Required Confirmation when

DER.CONFIRMATIO document is received
N
CNTROLAREA.SEN Required Language in which
DER.LANGUAGE the text fields are
transmitted
CNTROLAREA.SEN Required Character set used in

DER.CODEPAGE this XML document
CNTROLAREA.SEN Required System ID of sender.

DER.AUTHID Value is APPS
CNTROLAREA.DAT Required Creation date and

ETIME time of the XML
qualifier="CREATIO document
N"
CNTROLAREA.DAT Required Creation year of the

ETIME.YEAR XML document
CNTROLAREA.DAT Required Creation month of the

ETIME.MONTH XML document
CNTROLAREA.DAT Required Creation day of the

ETIME.DAY XML document
CNTROLAREA.DAT Required Creation hour of the

ETIME.HOUR XML document
CNTROLAREA.DAT Required Creation minute of

ETIME.MINUTE the XML document
CNTROLAREA.DAT Required Creation second of

ETIME.SECOND the XML document
CNTROLAREA.DAT Required Creation subsecond

ETIME.SUBSECOND of the XML document
CNTROLAREA.DAT Required Creation timezone of

ETIME.TIMEZONE the XML document
DATAAREA
DATAAREA.SYNC_
CUSTOMER

DATAAREA.SYNC_
CUSTOMER.PARTN
ER
DATAAREA.SYNC_ HZ_PARTIES.party_ Partner name

CUSTOMER.PARTN name
ER.NAME index="1"
DATAAREA.SYNC_ HZ_CUST_SITE_USE PARTNRID is the

CUSTOMER.PARTN S_ALL.Site_use_id identifier of the
ER.PARTNRID partner that the
PARTNRTYPE
defines. (Site Use Id
in Oracle
Applications)
DATAAREA.SYNC_ FND_LOOKUPS.mea Indicates the type of
CUSTOMER.PARTN ning partner entity or the
ER.PARTNRTYPE (ForFND_LOOKUPS. site use code. Valid
code = values are:
HZ_CUST_SITE_USE
S.Site_Use_Code = Bill To: The customer
fnd_lookups.lookup_ location where the
code) invoice goes to.
Ship To: Location of

the customer where
goods are sent.
Sold To: The

customer who is
responsible for
ordering the goods or
services.
Drawee: A customer
account site
responsible for
paying bills.
Dunning: The
location where the
customers dunning
letters are sent.
Invoices Legal: Acts

as the customer
account's legal site. A
legal site is
responsible for all
government reporting
requirements.
Marketing: Marketing
collateral is sent to
this address.
Self Service User

Statements: The
Customer location
where the customers
statements are sent.
Bills of Lading
Credit Memos
Credit Contact

Deliver To
Acknowledgments
DATAAREA.SYNC_ HZ_CUST_ACCOUN The identifier of the

CUSTOMER.PARTN TS.Account_Number partner that the
ER.PARTNRIDX receiving application
may use to identify
the PARTNER. The
Customer Number
will be sent here.
Synonyms include:
Customer Number,
Supplier Number,
Customer ID, and
Supplier ID
DATAAREA.SYNC_ Hz_parties.tax_refere The tax identifier of

CUSTOMER.PARTN nce the business partner.
ER.TAXID
Synonyms include:
VAT ID, Federal Tax

ID, and State Tax ID
DATAAREA.SYNC_ PARTNER LEVEL

CUSTOMER.PARTN
ER.USERAREA
DATAAREA.SYNC_ HZ_PARTY_SITES.Pa Site number

CUSTOMER.PARTN rty_Site_Number
ER.USERAREA.SITE_
NUMBER
DATAAREA.SYNC_ HZ_Cust_Acct_sites_ Operating unit

CUSTOMER.PARTN all.OrgID
ER.USERAREA.OPE
RATING_UNIT
DATAAREA.SYNC_ This element bounds
CUSTOMER.PARTN any additional
ER.USERAREA.PAR parameters that are to
AMETERS be sent. This element
has an attribute
named TYPE, which
can have any of the
following values:
VENDOR, SERVICE,
or DATA.
DATAAREA.SYNC_ Parameters of type Every Parameter has

CUSTOMER.PARTN 'VENDOR'WSH_ITM attributes Index,
ER.USERAREA.PAR _VENDOR_PARAME Name, and Value
AMETERS. TERS.Parmeter_name
PARAMETER ,
WSH_ITM_VENDOR
_PARAMETERS.Par
meter_value
Parameters of type
'SERVICE'WSH_ITM
_SERVICE_PARAME
TERS.Prameter_name
,
WSH_ITM_SERVICE
_PARAMETERS.Pra
meter_value
Parameters of type
'DATA'HZ_CUST_A
CCOUNTS.Attribute1
..15
DATAAREA.SYNC_ The Data Type

CUSTOMER.PARTN ADDRESS represents
ER.ADDRESS the data concerning
the location of the
business partner.
DATAAREA.SYNC_ HZ_LOCATIONS.AD The lines needed to

CUSTOMER.PARTN DRESS1..ADDRESS4 describe street
ER.ADDRESSADDRL address or post office
INE index="1" - "4" box information.
DATAAREA.SYNC_ HZ_CUST_SITE_USE A qualification of the

CUSTOMER.PARTN S_ALL.Primary_Flag address of the
ER.ADDRESSADDRT business partner
YPE

DATAAREA.SYNC_ HZ_LOCATIONS.CI The city or town of
CUSTOMER.PARTN TY the business partner.
ER.ADDRESSCITY
DATAAREA.SYNC_ HZ_LOCATIONS.CO The country within

CUSTOMER.PARTN UNTRY an address. The list of
ER.ADDRESSCOUN valid codes can be
TRY found in ISO
Standard number
3166.
DATAAREA.SYNC_ HZ_LOCATIONS.PO The postal code

CUSTOMER.PARTN STAL_CODE within a mailing
ER.ADDRESSPOSTA address.
LCODE
Synonym: Zip code
DATAAREA.SYNC_ HZ_LOCATIONS.ST The state or province

CUSTOMER.PARTN ATE within the mailing
ER.ADDRESSSTATE address.
PROVN
DATAAREA.SYNC_ ADDRESS LEVEL

CUSTOMER.PARTN
ER.ADDRESSUSERA
REA
DATAAREA.SYNC_ This element bounds

CUSTOMER.PARTN any additional
ER.ADDRESSUSERA parameters to be sent.
REA.PARAMETERS This element has an
attribute named
TYPE which has
value DATA -
Additional Data
Information /
Descriptive Flexfield
Information. All of
the Descriptive
Flexfield attributes
(attribute1 through
attribute15) of the
Customer Site Level
can be passed in this
region.
DATAAREA.SYNC_ HZ_CUST_ACCT_SI Every Parameter has
CUSTOMER.PARTN TES_ALL.attribute1 attributes 'Index,
ER.ADDRESSUSERA through 15 Name, and Value
REA.PARAMETERS.
PARAMETER
DATAAREA.CONTA Represents people

CT associated with the
PARTNER and
various ways to
contact them, such as
telephone or fax.
DATAAREA.CONTA HZ_PARTIES.Party_ First Name and the

CT.NAME name (Having a Last Name
record in
HZ_PARTY_RELATI
ONSHIPS with
relationship_type =
'CONTACT_OF'
DATAAREA.CONTA Describes the contact

CT.NAME.CONTCT person's
TYPE responsibilities.
Synonym: Job Title
DATAAREA.CONTA HZ_CONTACT_POI Contact email address

CT.NAME.EMAIL NTS.Email
DATAAREA.CONTA HZ_CONTACT_POI Contact fax number

CT.NAME.FAX NTS.PHONE_NUMB
ER(With
Phone_Line_Type =
'FAX')
DATAAREA.CONTA HZ_CONTACT_POI Contact phone

CT.NAME.TELEPHO NTS.PHONE_NUMB number
NE ER(With
Phone_Line_Type =
'PHONE')

<?xml version="1.0" encoding = "UTF-8"?><SYNC_CUSTOMER_005>
<CNTROLAREA>
<BSR>
<VERB>SYNC</VERB>
<NOUN>PARTY</NOUN>
<REVISION>001</REVISION>
</BSR>
<SENDER>
<COMPONENT>ITM Application</COMPONENT>
<TASK>PARTY SYNCHRONIZATION</TASK>
<REFERENCEID>111~PARTY_SYNC~61</REFERENCEID>
<CONFIRMATION>Y</CONFIRMATION>
<AUTHID>vsathiya-venkat</AUTHID>
</SENDER>
<YEAR>2004</YEAR>
<MONTH>04</MONTH>
<DAY>16</DAY>
<HOUR>12</HOUR>
<MINUTE>00</MINUTE>
<SECOND>54</SECOND>
<TIMEZONE>+00:00</TIMEZONE>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SYNC_CUSTOMER>
<PARTNER>
<NAME index="1">SV200</NAME>
<PARTNRTYPE>BILL_TO</PARTNRTYPE>
<PARTNRIDX>R2000</PARTNRIDX>
<TAXID/>
<USERAREA>
<ORACLE.SYNC_CUSTOMER_005.PARTNER.USERAREA>
<ORACLE.SITE_NUMBER>10595</ORACLE.SITE_NUMBER>
<ORACLE.OPERATING_UNIT>204</ORACLE.OPERATING_UNIT>
<ORACLE.PARAMETERS TYPE="VENDOR">
<ORACLE.PARAMETER INDEX="1" NAME="Para1"
VALUE="Para1"/>
VALUE="para5"/>
VALUE="Para3"/>
</ORACLE.PARAMETERS>
<ORACLE.PARAMETERS TYPE="SERVICE"/>
<ORACLE.PARAMETERS TYPE="DATA"/>
</ORACLE.SYNC_CUSTOMER_005.PARTNER.USERAREA>
</USERAREA>
<ADDRESS>
<ADDRLINE index="1">139</ADDRLINE>
<ADDRTYPE>N</ADDRTYPE>
<CITY>Atlanta</CITY>
<STATEPROVN>GA</STATEPROVN>
<USERAREA>
<ORACLE.SYNC_CUSTOMER_005.PARTNER.ADDRESS.USERAREA>
</ORACLE.SYNC_CUSTOMER_005.PARTNER.ADDRESS.USERAREA>
</USERAREA>
</ADDRESS>
</PARTNER>
</SYNC_CUSTOMER>
</DATAAREA>
<DATAAREA>
<SYNC_CUSTOMER>
<PARTNER>
<PARTNRTYPE>SHIP_TO</PARTNRTYPE>
<TAXID/>
<USERAREA>
<ORACLE.SITE_NUMBER>10595</ORACLE.SITE_NUMBER>
VALUE="Para1"/>
VALUE="para5"/>
VALUE="Para3"/>
</USERAREA>
<ADDRESS>
<ADDRTYPE>N</ADDRTYPE>
<USERAREA>
</USERAREA>
</ADDRESS>
</PARTNER>
</SYNC_CUSTOMER>
</DATAAREA>
<DATAAREA>
<SYNC_CUSTOMER>
<PARTNER>
<PARTNRTYPE>BILL_TO</PARTNRTYPE>

<TAXID/>
<USERAREA>
<ORACLE.SITE_NUMBER>SR1</ORACLE.SITE_NUMBER>
VALUE="Para1"/>
VALUE="para5"/>
VALUE="Para3"/>
</USERAREA>
<ADDRESS>
<ADDRTYPE>Y</ADDRTYPE>
<USERAREA>
</USERAREA>
</ADDRESS>
</PARTNER>
</SYNC_CUSTOMER>
</DATAAREA>
<DATAAREA>
<SYNC_CUSTOMER>
<PARTNER>
<TAXID/>
<USERAREA>
<ORACLE.SITE_NUMBER>SR1</ORACLE.SITE_NUMBER>
VALUE="Para1"/>
VALUE="para5"/>
VALUE="Para3"/>
</USERAREA>
<ADDRESS>
<ADDRTYPE>Y</ADDRTYPE>
<USERAREA>
</USERAREA>
</ADDRESS>
</PARTNER>
</SYNC_CUSTOMER>
</DATAAREA>
</SYNC_CUSTOMER_005>
ITM Sample Item Synchronization XML

The following table lists each of the ITM Item Synchronization XML elements/attributes
and whether they are required or optional. A sample XML transaction follows the table.

Table.Column
CNTROL.AREA Required The fields included in

this area provide
XML document
CNTROLAREA..BSR Required Shows the Business

per OAGI
CNTROLAREA.VER Required Value is SYNC

B
CNTROLAREA.NOU Required Value is CUSTOMER

N
CNTROLAREA.REVI Required Value is 005

SION

CNTROLAREA.SEN Required Provides information
DER on the system that
sends the document
CNTROLAREA.SEN Required Sender system

DER.LOGICALID identifier
CNTROLAREA.SEN Required Sender application

DER.COMPONENT name. Value is WSH
CNTROLAREA.SEN Required Event or Action

DER.TASK
CNTROLAREA.SEN Required Unique reference ID

DER.REFERENCEID for this document
CNTROLAREA.SEN Required Confirmation when

DER.CONFIRMATIO document is received
N
CNTROLAREA.SEN Required Language in which

DER.LANGUAGE the text fields are
transmitted
CNTROLAREA.SEN Required Character set used in

DER.CODEPAGE this XML document
CNTROLAREA.SEN Required System ID of sender.

DER.AUTHID Value is APPS
CNTROLAREA.DAT Required Creation date and

ETIME time of the XML
qualifier="CREATIO document
N"
CNTROLAREA.DAT Required Creation year of the

ETIME.YEAR XML document
CNTROLAREA.DAT Required Creation month of the

ETIME.MONTH XML document
CNTROLAREA.DAT Required Creation day of the

ETIME.DAY XML document
CNTROLAREA.DAT Required Creation hour of the
ETIME.HOUR XML document
CNTROLAREA.DAT Required Creation minute of

ETIME.MINUTE the XML document
CNTROLAREA.DAT Required Creation second of

ETIME.SECOND the XML document
CNTROLAREA.DAT Required Creation subsecond

ETIME.SUBSECOND of the XML document
CNTROLAREA.DAT Required Creation timezone of

ETIME.TIMEZONE the XML document
DATAAREA
DATAAREA.ITEM
DATAAREA.ITEM.IT MTL_SYSTEM_ITEM Unique Identifier of

EM_ID S_B.inventory_item_i an Item
d (Inventory_item_id)
DATAAREA.ITEM.IT MTL_SYSTEM_ITEM Product Code.

EM_CODE S_B.segment1..segme Concatenated
nt15 segments of the Item
Flexfield.
DATAAREA.ITEM.D MTL_SYSTEM_ITEM Description of the

ESCRIPTION S_TL.Description item
DATAAREA.ITEM.H PO_HAZARD_CLAS Hazard class

AZARD_CLASS SES_TL.(For classification
PO_HAZARD_CLAS
SES_TL.hazard_class_
id =
MTL_SYSTEM_ITEM
S_B.hazard_class_id)
DATAAREA.ITEM.O MTL_SYSTEM_ITEM Organization to

RGANIZATION_ID S_B.Organization_id which this item is
assigned

DATAAREA.ITEM.S MTL_SYSTEM_ITEM Master Organization
RC_ORGANIZATIO S_B.src_organization_ of the item.
N_ID id
DATAAREA.ITEM.IT FND_COMMON_LO User Defined Item

EM_TYPE OKUPS.meaning Type
(forLookup_type
='ITEM_TYPE
andFND_COMMON
_LOOKUPS.lookup_c
ode =
MTL_SYSTEM_ITEM
S_B.item_type
DATAAREA.ITEM.U MTL_SYSTEM_ITEM Unit of measure

NIT_OF_MEASURE S_B.PRIMARY_UOM
_CODE
DATAAREA.ITEM.IT MTL_SYSTEM_ITEM Value of the item

EM_VALUE S_B.LIST_PRICE_PER
_UNIT
DATAAREA.ITEM.C Currency
URRENCY
DATAAREA.ITEM.C HR_LOCATIONS_A Country of the

OUNTRY LL.Country(Select organization to which
hl.country from the item is assigned in
hr_all_organization_u Oracle Application.
nits hu, hr_locations
hl where
hulocation_id =
hl.location_id and
hu.organization_id =
MTL_SYSTEM_ITEM
_B.Organization_id)
DATAAREA.ITEM.U
SERAREA
<?xml version="1.0" encoding = "UTF-8"?><ITEM_SYNC>
<CNTROLAREA>
<BSR>
<VERB>SYNC</VERB>
<NOUN>ITEM</NOUN>
</BSR>
<SENDER>
<TASK>ITEM SYNCHRONIZATION</TASK>
<REFERENCEID>142~ITEM_SYNC~61</REFERENCEID>
</SENDER>
<YEAR>2004</YEAR>
<MONTH>06</MONTH>
<DAY>05</DAY>
<HOUR>02</HOUR>
<MINUTE>53</MINUTE>
<SECOND>51</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<ITEM>
<ITEM_ID>11746</ITEM_ID>
<ITEM_CODE>WSH-Standard</ITEM_CODE>
<DESCRIPTION>WSH-Standard</DESCRIPTION>
<HAZARD_CLASS/>
<ORGANIZATION_ID>8259</ORGANIZATION_ID>
<SRC_ORGANIZATION_ID/>
<ITEM_TYPE>Finished good</ITEM_TYPE>
<UNIT_OF_MEASURE>Ea</UNIT_OF_MEASURE>
<ITEM_VALUE/>
<COUNTRY>CN</COUNTRY>
<USERAREA>
<ORACLE.ITEM_SYNC.ITEM.USERAREA>
<ORACLE.ITEM_SYNC.ITEM.LONG_DESCRIPTION/>
<ORACLE.OPERATING_UNIT/>
<ORACLE.PARAMETER INDEX="1" NAME="PPar-1"
VALUE="PVal-1"/>
<ORACLE.PARAMETERS TYPE="SERVICE">
<ORACLE.PARAMETER INDEX="1" NAME="Par1" VALUE="Val1"/>
</ORACLE.ITEM_SYNC.ITEM.USERAREA>
</USERAREA>
</ITEM>
</DATAAREA>
<DATAAREA>
<ITEM>

<HAZARD_CLASS/>
<ITEM_VALUE/>
<COUNTRY>AU</COUNTRY>
<USERAREA>
VALUE="PVal-1"/>
</USERAREA>
</ITEM>
</DATAAREA>
<DATAAREA>
<ITEM>
<HAZARD_CLASS/>
<ITEM_VALUE/>
<USERAREA>
VALUE="PVal-1"/>
</USERAREA>
</ITEM>
</DATAAREA>
<DATAAREA>
<ITEM>
<HAZARD_CLASS/>
<ITEM_VALUE/>
<USERAREA>
VALUE="PVal-1"/>
</USERAREA>
</ITEM>
</DATAAREA>
</ITEM_SYNC>
ITM Sample Order Export Compliance XML

The following table lists each of the ITM Order Export Compliance XML

Table.Column
ORDER Required Represents the Order Contains the Order

line information. Header Information.
Every Order line
would map to one
Order Tag and
multiple Order Tags
would be present in a
message for same
Order Number.
ORDER_LINE Required
ORDER_LINE.ORDE Required OE_ORDER_HEADE Order number

R_NUMBER RS_ALL.ORDER_NU
MBER

ORDER_LINE.ORDE Required OE_ORDER_HEADE Order type
R_TYPE RS_ALL.ORDER_TYP
E
ORDER_LINE.ORG_I Required OE_ORDER_HEADE Operating unit

D RS_ALL.ORG_ID
ORDER_LINE.CUST_ Optional OE_ORDER_HEADE Purchase order

PO_NUM RS_ALL.CUST_PO_N number
UM
ORDER_LINE.TRAN Optional OE_ORDER_HEADE Currency

SACTIONAL_CURR_ RS_ALL.TRANSACTI
CODE ONAL_CURR_CODE
ORDER_LINE.CONV Optional OE_ORDER_HEADE Conversion code

ERSION_TYPE_COD RS_ALL.CONVERSI
E ON_TYPE_CODE
ORDER_LINE.CONV Optional OE_ORDER_HEADE Conversion rate

ERSION_RATE RS_ALL.CONVERSI
ON_RATE
ORDER_LINE.ORDE Optional OE_ORDER_HEADE Order date

RED_DATE RS_ALL.ORDERED_
DATE
ORDER_LINE.SHIPP Optional OE_ORDER_LINES_ Shipping method

ING_METHOD_COD ALL.SHIPPING_MET
E HOD_CODE
ORDER_LINE.REQU Optional OE_ORDER_LINES_ Request date

EST_DATE ALL.REQUEST_DAT
E
ORDER_LINE.FREIG Optional OE_ORDER_LINES_ Freight terms

HT_TERMS_CODE ALL.FREIGHT_TER
MS_CODE
ORDER_LINE.PAYM Optional RA_TERMS_TL.NA Name of the payment

ENT_TERMS_NAME ME terms
ORDER_LINE.PAYM Optional OE_ORDER_HEADE Payment terms ID

ENT_TERM_ID RS_ALL.PAYMENT_
TERM_ID
ORDER_LINE.ORDE Optional OE_ORDER_LINES. Quantity ordered
RED_QUANTITY ORDERED_QUANTI
TY
ORDER_LINE.LINE_ Required OE_ORDER_LINES_ Line number

NUMBER ALL.LINE_NUMBER
ORDER_LINE.UNIT_ Optional OE_ORDER_LINES_ List price

LIST_PRICE ALL.UNIT_LIST_PRI
CE
ORDER_LINE.UNIT_ Optional OE_ORDER_LINES_ Sell price

SELLING_PRICE ALL.UNIT_SELLING
_PRICE
ORDER_LINE.ITEM_ Required ITEM_ID Item ID, which 3rd

ID Party Partner
application can
recognize as a
primary key.
ORDER_LINE.PART Required
Y
ORDER_LINE.PART Required Identification from

Y.PARTY_ID ITM adapter
ORDER_LINE.PART Optional FND_LOOKUPS.mea The party type is just

Y.TYPE ning an informatory field.
(ForFND_LOOKUPS. Type SHIP_FROM,
code = SHIP_TO, BILL_TO,
HZ_CUST_SITE_USE DELIVER To,
S.Site_Use_Code = SOLD_TO, and
fnd_lookups.lookup_ Intermediate Ship To
code) are selected.
ORDER_LINE.PART Optional HZ_PARTIES.party_ Party name

Y.NAME name
ORDER_LINE.PART Optional HZ_LOCATIONS.AD Party Address 1

Y.ADDRESS1-5 DRESS1..ADDRESS5 through 5
ORDER_LINE.PART Optional HZ_LOCATIONS.CI City

Y.CITY TY

ORDER_LINE.PART Optional HZ_LOCATIONS.ST State or province
Y.STATE_OR_PROVI ATE
NCE
ORDER_LINE.PART Optional HZ_LOCATIONS.CO Country code

Y.COUNTRY UNTRY
CODE="US"
NAME="US"
ORDER_LINE.PART Optional HZ_LOCATIONS.PO Postal code

Y.POSTAL_CODE STAL_CODE
ORDER_LINE.PART Optional HZ_PARTIES.Party_ Contact name

Y.CONTACT_NAME name (Having a
record in
HZ_PARTY_RELATI
ONSHIPS with
relationship_type =
'CONTACT_OF')
ORDER_LINE.PART Optional HZ_CONTACT_POI Contact email adress

Y.EMAIL NTS.EMAIL
ORDER_LINE.PART Optional HZ_CONTACT_POI Contact phone

Y.PHONE NTS.PHONE_NUMB number
ER
ORDER_LINE.PART Optional HZ_CONTACT_POI Contact fax number

Y.FAX NTS.PHONE_NUMB
ER
ORDER_LINE.PART Optional Contact web site URL

Y.WEB
ORDER_LINE.PART Optional From Attributes to include

Y.ADDL_INFO WSH_ITM_PARTIES additional attributes
table, from Name, Value
ATTRIBUTE1_NAME pairs or via pre
to process custom APIs.
ATTRIBUTE20_NAM
E and
ATTRIBUTE1_VALU
E to
ATTRIBUTE20_VAL
UE.
<?xml version="1.0" encoding = "UTF-8"?><request>
<message_id>7832~OM_EXPORT_COMPLIANCE~61</message_id>
<admin>
<subscriber_id>vsathiya</subscriber_id>
<password>xxxxx</password>
<request_generator>OM</request_generator>
<revision>1.0</revision>
</admin>
<parameters>
<parameter name="Para1" value="Para1"/>
<parameter name="Para5" value="para5"/>
<parameter name="Para3" value="Para3"/>
</parameters>
<transaction_date>4/28/2004 6:35:21</transaction_date>
<addl_info/>
<order_line>
<transaction_key>7832~50027-Standard_ECE-1</transaction_key>
<order_number>50027</order_number>
<order_type>Standard_ECE</order_type>
<org_id>204</org_id>
<cust_po_num/>
<transactional_curr_code>USD</transactional_curr_code>
<conversion_type_code/>
<conversion_rate/>
<ordered_date>4/28/2004 6:25:57</ordered_date>
<shipping_method_code>000001_United
Par_A_3DS</shipping_method_code>
<request_date>4/28/2004 6:25:57</request_date>
<freight_terms_code>Due</freight_terms_code>
<payment_terms_name/>
<payment_term_id>4</payment_term_id>
<ordered_quantity>5</ordered_quantity>
<line_number>1</line_number>
<unit_list_price>50</unit_list_price>
<unit_selling_price>50</unit_selling_price>
<item_id>29585</item_id>
<party>
<party_id>7832-498</party_id>
<type>SHIP_FROM</type>
<name>Vision Operations</name>
<address1>90 Fifth Avenue,,</address1>
<address2/>
<address3/>
<address4/>
<address5/>
<city>New York</city>
<state_or_province/>
<country code="US" name="US"/>
<postal_code>10022-3422</postal_code>
<contact_name/>
<email/>
<phone/>
<fax/>
<web/>
<addl_info/>
</party>
<party>
<type>SHIP_TO</type>
<name>Computer Service and Rentals</name>
<address1>301 Summit Hill Drive 1,,,</address1>

<address2/>
<address3/>
<address4/>
<address5/>
<city>Chattanooga</city>
<postal_code>37401</postal_code>
<contact_name/>
<email/>
<phone/>
<fax/>
<web/>
<addl_info/>
</party>
<party>
<type>DELIVER_TO</type>
<address1>234 Lester B. Pearson Road,,,</address1>
<address2/>
<address3/>
<address4/>
<address5/>
<city>Iqualuit</city>
<country code="CA" name="CA"/>
<postal_code>I2W 3E4</postal_code>
<contact_name/>
<email/>
<phone/>
<fax/>
<web/>
<addl_info/>
</party>
<party>
<type>BILL_TO</type>
<address2/>
<address3/>
<address4/>
<address5/>
<contact_name/>
<email/>
<phone/>
<fax/>
<web/>
<addl_info/>
</party>
<party>
<type>SOLD_TO</type>
<address2/>
<address3/>
<address4/>
<address5/>
<contact_name/>
<email/>
<phone/>
<fax/>
<web/>
<addl_info/>
</party>
</order_line>
</request>
ITM Sample Delivery Export Compliance XML

The following table lists each of the ITM Delivery Export Compliance XML

Table.Column Name
SHIPMENT.DATE Required Sys date time

TTIME
(Document)
SHIPMENT.DOC Required WSH_TRANSACTIONS_H

UMENTID ISTORY.DOCUMENT_ID
(Shipment)
SHIPMENT.SHIP Required WSH_NEW_DELIVERIES.I

PERID NITIAL_PICKUP_LOCATI
ON_ID converted to code
SHIPMENT.SYNC Required XML: "A" = Add, "D" =

ID Delete "C" = Change EDI: "
N" for Add, "F" for Delete
SHIPMENT.AMO Optional
UNT
(DECLAREVAL)
UNT
(DOCUMENT) (T)

Table.Column Name
UNT
(ESTFREIGHT)
SHIPMENT.AMO Optional WSH_FREIGHT_COSTS.T

UNT (FREIGHT) OTAL_AMOUNT
(T)
UNT (ITEM) (T)
SHIPMENT.CARR Optional WSH_NEW_DELIVERIES.

IER CARRIER_ID, converted to
external value
SHIPMENT.CARR Optional WSH_NEW_DELIVERIES.S

IERSRVLVL ERVICE_LEVEL, converted
to external value
SHIPMENT.COU Optional For wsh_new_deliveries.

NTRYDST Ultimate_dropoff_location_
id, Get the country from
hz_locations
SHIPMENT.COU Optional
NTRYORG
SHIPMENT.DATE Optional WSH_NEW_DELIVERIES.

TIME CREATION_DATE
(CREATION)
SHIPMENT.DATE Optional WSH_TRIP_STOPS.ACTU

TIME AL_ARRIVAL_DATE
(DELIVACT)

TIME .ULTIMATE_DROPOFF_D
(DELIVSCHED) ATE
SHIPMENT.DATE Optional
TIME
(EARLSTSHIP)
Table.Column Name
TIME (LOADING)

TIME .ULTIMATE_DROPOFF_D
(NEEDDELV) ATE
TIME
(PROMDELV)
TIME
(PROMSHIP)
SHIPMENT.DATE Optional WSH_TRIP_STOPS.ACTU

TIME (SHIP) AL_DEPARTURE_DATE
SHIPMENT.DATE Optional WSH_NEW_DELIVERIES.I

TIME NITIAL_PICKUP_DATE
(SHIPSCHED)
SHIPMENT.DESC Optional WSH_NEW_DELIVERIES.

RIPTN DESCRIPTION
SHIPMENT.DIST Optional
CENTER
SHIPMENT.DOC Optional
KID
SHIPMENT.DOCT Optional "SHIPMENT REQUEST"

YPE for 940 "SHIPMENT
ADVICE" for 945
SHIPMENT.DOC Optional "001" for ADD, "002" for

UMENTRV DELETE, "003" for
CHANGE
SHIPMENT.DROP Optional
SHIP

Table.Column Name
SHIPMENT.EXPO Optional
RTLIC
SHIPMENT.FRGH Optional
TCLS
SHIPMENT.FRGH Optional WSH_NEW_DELIVERIES.

TTERMS FREIGHT_TERMS_CODE
SHIPMENT.HAZ Optional
RDMATL
SHIPMENT.HDRS Optional
TATUS
SHIPMENT.IMPO Optional
RTLIC
SHIPMENT.LOA Optional
DPOINT
SHIPMENT.NOTE Optional
S1 – NOTES9
SHIPMENT.OPER Optional
AMT (FREIGHT)
(T)
SHIPMENT.PART Optional
IALSHP
SHIPMENT.PRIO Optional
RITY
SHIPMENT.QUA Optional WSH_NEW_DELIVERIES.

NTITY GROSS_WEIGHT,
(ESTWEIGHT) WSH_NEW_DELIVERIES.
WEIGHT_UOM
Table.Column Name
SHIPMENT.QUA Optional Calculate using

NTITY WSH_NEW_DELIVERIES.
(LOADINGWT) GROSS WEIGHT –
WSH_NEW_DELIVERIES.
NET WEIGHT

NTITY NET_WEIGHT
(NETWEIGHT) WSH_NEW_DELIVERIES.
WEIGHT_UOM

NTITY NUMBER_OF_LPN
(SHIPUNIT)

NTITY GROSS_WEIGHT,
(TOTWEIGHT) WSH_NEW_DELIVERIES.
WEIGHT_UOM

NTITY (VOLUME) VOLUME
WSH_NEW_DELIVERIES.
VOLUME_UOM
SHIPMENT.ROUT Optional
EID
SHIPMENT.RELE Optional
ASENUM
SHIPMENT.RELE Optional
ASENUMTOT
SHIPMENT.ROUT Optional Type of routing.

ETYPE
SHIPMENT.SHIP Optional WSH_NEW_DELIVERIES.S

NOTES HIPPING_MARKS

Table.Column Name
SHIPMENT.SHIP Optional WSH_NEW_DELIVERIES.

POINT ULTIATE_DROPOFF_LOC
ATION_ID converted to
code
SHIPMENT.SHIP Optional
PRIOR
SHIPMENT.SHIPS Optional WSH_NEW_DELIVERIES.S

RVLVL ERVICE_LEVEL
SHIPMENT.SPECI Optional
ALHND
SHIPMENT.STAG Optional
EPOINT
SHIPMENT.TEMP Optional
RATURE
(ACTUAL)
RATURE
(DELIVERY)
RATURE
(LOADING)
SHIPMENT.TRA Optional WSH_NEW_DELIVERIES.

NSMETHD MODE_OF_TRANSPORT
SHIPMENT.TRA Optional WSH_NEW_DELIVERIES.

NSTERMS FOB_CODE
SHIPMENT.WAR Optional WSH_NEW_DELIVERIES.

EHOUSE ORGANIZATION_ID
converted to code
Table.Column Name
SHIPMENT.USER Optional WSH_NEW_DELIVERIES.

AREA DELIVERY_NAME,
WSH_NEW_DELIVERIES.
LOADING_SEQUENCE,
WSH_NEW_DELIVERY
descriptive flex fields,
WSH_TRIPS.VEHICLE_N
UM_PREFIX,
WSH_TRIPS.VEHICLE_N
UMBER,
WSH_TRIPS.ROUTE_ID,
WSH_TRIPS.ROUTING_IN
STRUCTIONS,
WSH_TRIP_STOPS.DEPAR
TURE_SEAL_CODE,
WSH_NEW_DELIVERIES.S
HIP_METHOD_CODE,
NVL(WSH_TRIPS.SHIP_M
ETHOD_CODE,
WSH_NEW_DELIVERIES.S
HIP_METHOD_CODE),
WSH_NEW_DELIVERIES.
WAYBILL,
WSH_ITM_REQUEST_CO
NTROL.ATTRIBUTEn_NA
ME/ATTRIBUTEn_VALUE
Where n=1 to 20,
WSH_ITM_REQUEST_CO
NTROL.TRIGGERING_POI
NT
PARTNER. Optional

Table.Column Name
PARTNER.NAME Required If this partner segment is

1 the Ship To segment, get
the HZ_PARTIES.NAME
for the
WSH_NEW_DELIVERIES.
ULTIMATE_DROPOFF_L
OCATION_ID, If this
partner segment is the Ship
HZ_PARTIES.NAME for
the
WSH_NEW_DELIVERIES.
ORGANIZATION_ID If
this partner segment is the
Customer segment, get the
HZ_PARTIES.NAME for
the
WSH_NEW_DELIVERIES.
CUSTOMER_ID If this
partner segment is the
Supplier segment, get the
HZ_PARTIES.NAME for
the
WSH_NEW_DELIVERIES.
ORGANIZATION_ID
PARTNER.ONETI Required
ME
PARTNER.PART Required WSH_NEW_DELIVERIES.

NRID ULTIMATE_DROPOFF_L
OCATION_ID converted to
external value, or
WSH_NEW_DELIVERIES.
ORGANIZATION_ID
converted to external value.
Table.Column Name
PARTNER.PART Required PARTNRTYPE indicates

NRTYPE the type of partner entity.
Valid values are: "ShipTo" -
The delivery location of the
customer. "BillTo" - The
customer location the bill
goes to. "SoldTo" - The
customer who is
responsible for ordering the
goods or services. Could be
at multiple organizational
levels. "Supplier" - The
partner who is responsible
for providing the goods or
services. Supplier can be at
multiple organizational
levels. "Carrier" - The
partner responsible for
delivering the goods or
services. "ShipFrom" - The
shipping location of the
partner who is responsible
for providing the goods or
services. Ship from can be
at multiple organizational
levels. "Intmd_ShipTo" –
Intermeidate Ship for the
delivery "FOB"- FOB for the
delivery
PARTNER.ACTIV Optional
E
PARTNER.CURR Optional WSH_NEW_DELIVERIES.

ENCY CURRENCY_CODE for the
supplier and ship from
partner segments
PARTNER.DESCR Optional
IPTN
PARTNER.DUNS Optional HZ_PARTIES.DUNS_NUM

NUMBER BER for all partner types

Table.Column Name
PARTNER.GLEN Optional
TITYS
PARTNER.NAME Optional
2-NAME9
PARTNER.PARE Optional
NTID
PARTNER.PART Optional Could use

NIDX HZ_PARTIES.DUNS_NUM
BER for the
HZ_PARITES.PARTY_ID
From, Ship To, Customer
and Supplier segments
PARTNER.PART Optional
NRRATG
PARTNER.PART Optional
NRROLE
PARTNER.PAYM Optional
ETHOD
PARTNER.TAXEX Optional
EMPT
PARTNER.TAXID Optional
PARTNER.TERMI Optional
D
Table.Column Name
PARTNER.USERA Optional WSH_NEW_DELIVERIES.I

REA NTMED_SHIP_TO_LOCA
TION_ID WSH_
NEW_DELIVERIES.POOL
ED_SHIP_TO_LOCATION
_ID
HZ_CUST_SITE_USES_AL
L.SITE_USE_ID
HZ_CUST_SITE_USES_AL
L.LOCATION
PARTNER – Optional
ADDRESS.
PARTNER – Optional Extracted from the

ADDRESS.ADDR HZ_LOCATIONS using the
LINE1-ADDRLIN party id that matches the
E9 Ship From, Ship TO,
Customer and Supplier
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the
HZ_PARTY_SITES table.
ADDRESS.ADDR
TYPE

ADDRESS.CITY HZ_LOCATIONS using the
party id that matches the
Ship From, Ship TO,
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the

Table.Column Name

ADDRESS.COUN HZ_LOCATIONS using the
TRY party id that matches the
Ship From, Ship TO,
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the

ADDRESS.COUN HZ_LOCATIONS using the
TY party id that matches the
Ship From, Ship TO,
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the
ADDRESS.DESCR
IPTN
PARTNER – Optional HZ_CONTACT_POINTS.R

ADDRESS.FAX1-F AW_PHONE_NUMBER
AX9 for the PARTY_ID, and
CONTACT_POINT_TYPE
= "FAX"
Table.Column Name

ADDRESS.POSTA HZ_LOCATIONS using the
LCODE party id that matches the
Ship From, Ship TO,
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the

ADDRESS.REGIO HZ_LOCATIONS using the
N party id that matches the
Ship From, Ship TO,
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the

ADDRESS.STATE HZ_LOCATIONS using the
PROVN party id that matches the
Ship From, Ship TO,
from the
WSH_NEW_DELIVERIES
or
WSH_DELIVERY_DETAIL
S table, via the
ADDRESS.TAXJR
SDCTN

Table.Column Name
PARTNER – Optional HZ_CONTACT_POINTS.R

ADDRESS.TELEP AW_PHONE_NUMBER
HONE1-TELEPH for the PARTY_ID, and
ONE9 CONTACT_POINT_TYPE
= "GEN"
PARTNER – Optional HZ_CONTACT_POINTS.U

ADDRESS.URL RL for the PARTY_ID and
CONTACT_POINT_TYPE
= "GEN"
ADDRESS.USERA
REA
CONTACT.
PARTNER – Required
CONTACT.NAM
E1
CONTACT.CONT
CTTYPE
CONTACT.DESC
RIPTN
CONTACT.EMAI
L
CONTACT.FAX1 -
FAX9

CONTACT.NAM HR_LOCATIONS_ALL
E2 - NAME9 using the WSH ID
Table.Column Name
CONTACT.TELEP
HONE1
-TELEPHONE9
CONTACT.USER
AREA
DOCUMNTREF. Optional We need to send this

segment twice – once to
represent the ship from
delivery name, and for each
ship to purchase order
number
DOCUMNTREF.D Required "SHIPMENT REQUEST"

OCTYPE
DOCUMNTREF.D Required WSH_TRANSACTIONS_H

OCUMENTID ISTORY.Orig_Document_I
D
DOCUMNTREF.P Required WSH_NEW_DELIVERIES.

ARTNRID ORGANIZATION_ID
converted to code
DOCUMNTREF.P Required "ShipFrom" - The shipping

ARTNRTYPE location of the partner who
is responsible for providing
the goods or services. Ship
from can be at multiple
organizational levels
DOCUMNTREF.D Optional
ESCRIPTN
OCUMENTRV
DOCUMNTREF.L Optional
INENUM

Table.Column Name
DOCUMNTREF.N Optional
OTES1 – NOTES9
DOCUMNTREF.S Optional
CHLINENUM
UBLINENUM
DOCUMNTREF.U Optional
SERAREA
SHIPITEM. Optional
SHIPITEM.ITEM Required WSH_DELIVERY_DETAIL

S.INVENTORY_ITEM_ID
(foreign key to
MTL_SYSTEM_ITEMS)
Derive Item_Number from
MTL_SYSTEM_ITEMS
SHIPITEM.QUAN Required WSH_DELIVERY_DETAIL

TITY (ITEM) S.REQUESTED_QUANTIT
Y
SHIPITEM.AMOU Optional
NT (EXTENDED)
(T)
SHIPITEM.AMOU Optional
NT (ITEM) (T)
SHIPITEM.COUN Optional WSH_DELIVERY_DETAIL

TRYORG S.COUNTRY_OF_ORIGIN
SHIPITEM.DISPO Optional
SITN
SHIPITEM.EXPOR Optional
TLIC
Table.Column Name
SHIPITEM.FRGH Optional WSH_DELIVERY_DETAIL

TCLS S.FREIGHT_CLASS_CAT_I
D converted to external
value
SHIPITEM.FRGH Optional
TITEM
SHIPITEM.HAZR Optional WSH_DELIVERY_DETAIL

DMATL S.HAZARD_CLASS_ID
converted to external value.
Pass it, but may not be used
in the inbound side. Extract
the data from tables. This
value will be passed in the
outbound transaction.
SHIPITEM.IMPOR Optional
TLIC
SHIPITEM.ITEMD Optional WSH_DELIVERY_DETAIL

ESC S.ITEM_DESCRIPTION
SHIPITEM.ITEMR Optional WSH_DELIVERY_DETAIL

V S.REVISION
SHIPITEM.ITEM_I Optional MTL_SYSTEM_ITEMS_B.I

D NVENTORY_ITEM_ID
SHIPITEM.ITEMR Optional
VX
SHIPITEM.ITEMX Optional WSH_DELIVERY_DETAIL

S.CUSTOMER_ITEM_ID
Converted to Item_number
by joining to
mtl_customer_items
SHIPITEM.LINEN Optional
UM

Table.Column Name
SHIPITEM.LOTLE Optional Moved the mapping to

VEL1 – INVDETAIL section.
LOTLEVEL2
SHIPITEM.NOTES Optional Notes 1

1 – NOTES9 WSH_DELIVERY_DETAIL
S.PACKING_INSTRUCTIO
NS
SHIPITEM.OWNR Optional WSH_DELIVERY_DETAIL

SHPCDE S.FOB_CODE
SHIPITEM.PACKI Optional
NG
SHIPITEM.PACKI Optional
NGDESC
SHIPITEM.PARTI Optional "0" – means partial

ALSHIP shipment not allowed (i.e
when ship_set_id is not
null) "1" – means partial
shipment is allowed(i.e
when ship_set_id is null)
SHIPITEM.QUAN Optional Calculate

TITY WSH_DELIVERY_DETAIL
(BACKORDERD) S.REQUESTED_QUANTIT
Y-
WSH_DELIVERY_DETAIL
S.SHIPPED_QUANTITY
for 945 inbound only.
SHIPITEM.QUAN Optional
TITY (OPEN)
SHIPITEM.QUAN Optional WSH_DELIVERY_DETAIL

TITY (ORDERED) S.SRC_REQUESTED_QUA
NTITY

TITY (SHIPPED) S.SHIPPED_QUANTITY
Table.Column Name

TITY (VOLUME) S.VOLUME

TITY (WEIGHT) S.NET_WEIGHT
SHIPITEM.SHIPM Optional
ATLID
SHIPITEM.SHIPN Optional WSH_DELIVERY_DETAIL

OTES S.SHIPPING_INSTRUCTIO
NS
SHIPITEM.SHIPP Optional
RIOR
SHIPITEM.SHIPM Optional
TLDESC
SHIPITEM.UPC Optional

Table.Column Name
SHIPITEM.USERA Optional Use this to store:

REA WSH_DELIVERY_DETAIL
S.DELIVERY_DETAIL_ID,
WSH_DELIVERY_ASSIGN
MENTS.PARENT_DELIVE
RY_DETAIL_ID,
WSH_DELIVERY_DETAIL
S.SHIP_TOLERANCE_AB
OVE,
WSH_DELIVERY_DETAIL
S.SHIP_TOLERANCE_BEL
OW,
WSH_DELIVERY_DETAIL
S.LOAD_SEQUENCE_NU
MBER,
WSH_DELIVERY_DETAIL
S descriptive flexfields,
WSH_DELIVERY_DETAIL
S.SHIP_SET_ID,
WSH_DELIVERY_DETAIL
S.SUBINVENTORY,
WSH_DELIVERY_DETAIL
S.TOP_MODEL_LINE_ID,
WSH_DELIVERY_DETAIL
S.SHIP_MODEL_COMPLE
TE_FLAG,
WSH_DELIVERY_DETAIL
S.COMMODITY_CODE_C
AT_ID converted to code,
WSH_DELIVERY_DETAIL
S.SHIPMENT_PRIORITY_
CODE converted to "01", "
02", or "03" for XML,
WSH_DELIVERY_DETAIL
S.DELIVER_TO_LOCATIO
N_ID,
WSH_DELIVERY_DETAIL
S.SOURCE_LINE_NUMBE
R,
WSH_DELIVERY_DETAIL
S.SOURCE_LINE_ID
Table.Column Name
DOCUMNTREF. Optional We need to send this

segment for each customer
purchase order number for
all the delivery details on
this delivery.
DOCUMNTREF.D Required "PURCHASEORDER"We

OCTYPE need to send this segment
for each customer purchase
order number for all the
delivery details on this
delivery.
DOCUMNTREF.D Required
OCUMENTID
DOCUMNTREF.D Required WSH_DELIVERY_DETAIL

OCTYPE S.CUST_PO_NUMBER "
PURCHASEORDER"

ARTNRID ULTIMATE_DROPOFF_L
external value for for
Custome
DOCUMNTREF.D Required POWSH_DELIVERY_DET

OCUMENTID AILS.CUST_PO_NUMBER
DOCUMNTREF.P Required "ShipTo" - The delivery

ARTNRTYPE location of the customer

ARTNRID ULTIMATE_DROPOFF_L
external value for for
Customer PO
DOCUMNTREF.D Required "ShipTo" - The delivery

ESCRIPTNDOCU location of the customer
MNTREF.PARTN
RTYPE

Table.Column Name
OCUMENTRVDO
CUMNTREF.DES
CRIPTN
DOCUMNTREF.L Optional
INENUMDOCUM
NTREF.DOCUME
NTRV
DOCUMNTREF.N Optional
OTES1 –
NOTES9DOCUM
NTREF.LINENU
M
CHLINENUMDO
CUMNTREF.NOT
ES1 – NOTES9
UBLINENUMDO
CUMNTREF.SCH
LINENUM
SERAREADOCU
MNTREF.SUBLIN
ENUM
SERAREA
CHARGE. Optional
CHARGE.CHARG Required WSH_FREIGHT_COSTS.FR

EID EIGHT_COST_TYPE_ID
converted to external value
Table.Column Name
CHARGE.OPERA Required WSH_FREIGHT_COSTS.T

MT (EXTENDED) OTAL_AMOUNT
(T)
CHARGE.CHARG Required WSH_FREIGHT_COSTS.C

EID URRENCY_CODEWSH_F
REIGHT_COSTS.FREIGHT
_COST_TYPE_ID
CHARGE.AMOU Required WSH_FREIGHT_COSTS.T

NT (EXTENDED) OTAL_AMOUNT
(T)
CHARGE.OPERA Required WSH_FREIGHT_COSTS.C

MT (EXTENDED) URRENCY_CODE
(T)
CHARGE.CHARG Optional WSH_FREIGHT_COSTS.FR

ETYPECHARGE. EIGHT_COST_TYPE_ID
AMOUNT converted to
(EXTENDED) (T) FREIGHT_COST_TYPE
CHARGE.CHGLI Optional WSH_FREIGHT_COSTS.FR

NENUMCHARGE EIGHT_COST_TYPE_ID
.CHARGETYPE converted to
FREIGHT_COST_TYPE
CHARGE.DESCRI Optional
PTNCHARGE.CH
GLINENUM
CHARGE.USERA Optional WSH_FREIGHT_COSTS

REA descriptive flexfields
CHARGE.DESCRI
PTN
INVDETAIL. Optional


Table.Column Name
INVDETAIL.DES Optional WSH_DELIVERY_DETAIL

CRIPTNINVDETA S.ITEM_DESCRIPTION
IL.
INVDETAIL.DISP Optional WSH_DELIVERY_DETAIL

OSITNINVDETAI S.ITEM_DESCRIPTION
L.DESCRIPTN
INVDETAIL.LOT Optional WSH_DELIVERY_DETAIL

LEVEL1 – S.LOT_NUMBER
LOTLEVEL2
INVDETAIL.DISP Optional WSH_DELIVERY_DETAIL

OSITN S.SUBLOT_NUMBER
INVDETAIL.NOT Optional WSH_DELIVERY_DETAIL

ES1 - NOTES9 S.LOT_NUMBER
INVDETAIL.LOT Optional WSH_DELIVERY_DETAIL

LEVEL1 – S.SUBLOT_NUMBER
LOTLEVEL2
INVDETAIL.QUA Optional WSH_DELIVERY_DETAIL

NTITY S.REQUESTED
(ITEM)INVDETAI QUANTITY/WSH_DELIVE
L.NOTES1 - RY_DETAILS.REQUESTED
NOTES9 _QUANTITY_UOM
INVDETAIL.SERI Optional WSH_DELIVERY_DETAIL

ALNUMINVDET S.SERIAL_NUMBERWSH_
AIL.QUANTITY DELIVERY_DETAILS.REQ
(ITEM) UESTED
QUANTITY/WSH_DELIVE
RY_DETAILS.REQUESTED
_QUANTITY_UOM
INVDETAIL.USE Optional
RAREA
Table.Column Name
INVDETAIL.SERI Optional WSH_DELIVERY_DETAIL

ALNUM S.PREFERRED_GRADE,
WSH_DELIVERY_DETAIL
S.TO_SERIAL_NUMBER,
WSH_DELIVERY_DETAIL
S.SERIAL_NUMBER
INVDETAIL.USE Optional WSH_DELIVERY_DETAIL

RAREA S.TO_SERIAL_NUMBER,
WSH_DELIVERY_DETAIL
S.PREFERRED_GRADE
CHARGE. Optional


(T)

_COST_TYPE_ID

(T)

(T)

AMOUNT converted to

Table.Column Name

FREIGHT_COST_TYPE
PTNCHARGE.CH
GLINENUM

CHARGE.DESCRI
PTN

DISTRIBUTION. Optional
DISTRIBUTION.B Optional
USNAREADISTRI
BUTION.
DISTRIBUTION.C Optional
OSTCENTERDIST
RIBUTION.BUSN
AREA
DISTRIBUTION.D Optional
EPARTMENTDIS
TRIBUTION.COS
TCENTER
DISTRIBUTION.D Optional
IVISIONDISTRIB
UTION.DEPART
MENT
Table.Column Name
DISTRIBUTION.E Optional
LEMENT1 -
ELEMENT
999DISTRIBUTIO
N.DIVISION
DISTRIBUTION.F Optional
UNDDISTRIBUTI
ON.ELEMENT1 -
ELEMENT 999
DISTRIBUTION.G Optional
EOGRAPHYDIST
RIBUTION.FUND
LENTITYSDISTRI
BUTION.GEOGR
APHY
LNOMACCTDIST
RIBUTION.GLEN
TITYS
DISTRIBUTION.O Optional
PERAMT
(EXTENDED)
(T)DISTRIBUTIO
N.GLNOMACCT
DISTRIBUTION.P Optional
ROFITCTRDISTRI
BUTION.OPERA
MT (EXTENDED)
(T)
DISTRIBUTION.P Optional
ROJECTDISTRIBU
TION.PROFITCTR

Table.Column Name
DISTRIBUTION.U Optional
NITDISTRIBUTIO
N.PROJECT
DISTRIBUTION. Optional
WAREHOUSEDIS
TRIBUTION.UNIT
SERAREADISTRI
BUTION.WAREH
OUSE
SERAREA
SHIPUNIT. Optional
SHIPUNIT.CARRI Required WSH_DELIVERY_DETAIL

ER S.CARRIER_ID converted
to external value
SHIPUNIT.SHIPP Required WSH_DELIVERY_DETAIL

ERID S.SHIP_FROM_LOCATIO
N_ID converted to external
value.
SHIPUNIT.CARRI Required WSH_DELIVERY_DETAIL

ER S.CARRIER_ID converted
to external value
SHIPUNIT.TRAC Required WSH_DELIVERY_DETAIL

KINGID S.TRACKING_NUMBER
SHIPUNIT.SHIPP Required WSH_DELIVERY_DETAIL

ERID S.SHIP_FROM_LOCATIO
N_ID converted to external
value.
Table.Column Name
SHIPUNIT.AMOU Required WSH_DELIVERY_DETAIL

NT S.TRACKING_NUMBER
(DECLAREVAL)S
HIPUNIT.TRACKI
NGID
SHIPUNIT.AMOU Optional
NT (FREIGHT(
(T)SHIPUNIT.AM
OUNT
(DECLAREVAL)
NT (ITEM)
(T)SHIPUNIT.AM
OUNT (FREIGHT(
(T)
NT (TOTAL)
(T)SHIPUNIT.AM
OUNT (ITEM) (T)
SHIPUNIT.CARR Optional
SRVLVLSHIPUNI
T.AMOUNT
(TOTAL) (T)
SHIPUNIT.CONT Optional WSH_DELIVERY_DETAIL

AINRIDSHIPUNI S.DELIVERY_DETAIL_ID
T.CARRSRVLVL

NRGRPIDSHIPU S.MASTER_CONTAINER_
NIT.CONTAINRI ITEM_ID converted to
D external
valueWSH_DELIVERY_DE
TAILS.DELIVERY_DETAIL
_ID

Table.Column Name

NRSEALSHIPUNI S.SEAL_CODEWSH_DELI
T.CONTNRGRPI VERY_DETAILS.MASTER_
D CONTAINER_ITEM_ID

RTYPESHIPUNIT. S.CONTAINER_TYPE_CO
CONTNRSEAL DE
WSH_DELIVERY_DETAIL
S.SEAL_CODE
SHIPUNIT.COUN Optional WSH_DELIVERY_DETAIL

TRYDSTSHIPUNI S.CONTAINER_TYPE_CO
T.CONTRTYPE DE
SHIPUNIT.COUN Optional WSH_DELIVERY_DETAIL

TRYORGSHIPUNI S.COUNTRY_OF_ORIGIN
T.COUNTRYDST
SHIPUNIT.DATE Optional WSH_TRIP_STOPS.ACTU

TIME AL_ARRIVAL_DATEWSH
(DELIVACT)SHIP _DELIVERY_DETAILS.CO
UNIT.COUNTRY UNTRY_OF_ORIGIN
ORG
SHIPUNIT.DATE Optional WSH_DELIVERY_DETAIL

TIME S.DATE_SCHEDULEDWS
(DELIVSCHED)S H_TRIP_STOPS.ACTUAL_
HIPUNIT.DATETI ARRIVAL_DATE
ME (DELIVACT)
SHIPUNIT.DATE Optional WSH_DELIVERY_DETAIL

TIME S.DATE_SCHEDULED
(LOADING)SHIP
UNIT.DATETIME
(DELIVSCHED)
SHIPUNIT.DATE Optional WSH_TRIP_STOPS.ACTU

TIME AL_DEPARTURE_DATE
(SHIP)SHIPUNIT.
DATETIME
(LOADING)
Table.Column Name
SHIPUNIT.DESCR Optional WSH_TRIP_STOPS.ACTU

IPTNSHIPUNIT.D AL_DEPARTURE_DATE
ATETIME (SHIP)
SHIPUNIT.EXPO Optional
RTLICSHIPUNIT.
DESCRIPTN
SHIPUNIT.FRGH Optional WSH_DELIVERY_DETAIL

TCLSSHIPUNIT.E S.FREIGHT_CLASS_CAT_I
XPORTLIC D converted to external
value
SHIPUNIT.FRCH Optional WSH_DELIVERY_DETAIL

TITEMSHIPUNIT. S.FREIGHT_CLASS_CAT_I
FRGHTCLS D converted to external
value
SHIPUNIT.FRGT Optional WSH_DELIVERY_DETAIL

HTERMSSHIPUN S.FREIGHT_TERMS_COD
IT.FRCHTITEM E converted to external
value
SHIPUNIT.HAZR Optional WSH_DELIVERY_DETAIL

DMATLSHIPUNI S.HAZARD_CLASS_ID
T.FRGTHTERMS converted to external
valueWSH_DELIVERY_DE
TAILS.FREIGHT_TERMS_
CODE converted to
external value
SHIPUNIT.IMPO Optional WSH_DELIVERY_DETAIL

RTLICSHIPUNIT. S.HAZARD_CLASS_ID
HAZRDMATL converted to external value
SHIPUNIT.LOAD Optional
POINTSHIPUNIT.
IMPORTLIC
SHIPUNIT.NOTE Optional WSH_DELIVERY_DETAIL

S1 - S.PACKING_INSTRUCTIO
NOTES9SHIPUNI NS
T.LOADPOINT

Table.Column Name
SHIPUNIT.OPER Optional WSH_DELIVERY_DETAIL

AMT (FREIGHT) S.PACKING_INSTRUCTIO
(T)SHIPUNIT.NO NS
TES1 - NOTES9
SHIPUNIT.PACKI Optional
NGSHIPUNIT.OP
ERAMT
(FREIGHT) (T)
SHIPUNIT.PACKI Optional
NGDESCSHIPUN
IT.PACKING
SHIPUNIT.QUAN Optional
TITY
(ESTWEIGHT)SHI
PUNIT.PACKING
DESC
SHIPUNIT.QUAN Optional Populate from

TITY MTL_SYSTEM_ITEMS
(HEIGHT)SHIPU
NIT.QUANTITY
(ESTWEIGHT)
SHIPUNIT.QUAN Optional Populate from

TITY MTL_SYSTEM_ITEMSPop
(LENGTH)SHIPU ulate from
NIT.QUANTITY MTL_SYSTEM_ITEMS
(HEIGHT)
SHIPUNIT.QUAN Optional Calculate

ITTY WSH_DELIVERY_DETAIL
(LOADINGWT)S S.GROSS WEIGHT -
HIPUNIT.QUANT WSH_DELIVERY_DETAIL
ITY (LENGTH) S.NET WEIGHTPopulate
from
MTL_SYSTEM_ITEMS
Table.Column Name
SHIPUNIT.QUAN Optional WSH_DELIVERY_DETAIL

TITY S.NET_WEIGHT +
(NETWEIGHT)SH WSH_DELIVERY_DETAIL
IPUNIT.QUANIT S.WEIGHT_UOM_CODE
TY for delivery lines =
(LOADINGWT) container item, Calculate
WSH_DELIVERY_DETAIL
S.GROSS WEIGHT -
WSH_DELIVERY_DETAIL
S.NET WEIGHT

TITY S.GROSS_WEIGHT +
(TOTWEIGHT)SH WSH_DELIVERY_DETAIL
IPUNIT.QUANTI S.WEIGHT_UOM_CODEW
TY (NETWEIGHT) SH_DELIVERY_DETAILS.
NET_WEIGHT +
WSH_DELIVERY_DETAIL
S.WEIGHT_UOM_CODE
for delivery lines =
container item

TITY S.VOLUME +
(VOLUME)SHIPU WSH_DELIVERY_DETAIL
NIT.QUANTITY S.VOLUME_UOM_CODE
(TOTWEIGHT) for delivery lines =
container
itemWSH_DELIVERY_DET
AILS.GROSS_WEIGHT +
WSH_DELIVERY_DETAIL
S.WEIGHT_UOM_CODE

TITY (WIDTH) S.VOLUME +
WSH_DELIVERY_DETAIL
S.VOLUME_UOM_CODE
for delivery lines =
container item

TITY (VOLUME) S.GROSS_WEIGHT +
WSH_DELIVERY_DETAIL
S.WEIGHT_UOM_CODE

Table.Column Name
SHIPUNIT.SHIPM Optional WSH_DELIVERY_DETAIL

ATLIDSHIPUNIT. S.INVENTORY_ITEM_ID
QUANTITY converted to Item Number
(WIDTH) by joining to
mtl_system_items ( this
delivery detail id is the
delivery detail id of the
container record)
SHIPUNIT.SHIPN Optional WSH_DELIVERY_DETAIL

OTESSHIPUNIT.S S.SHIPPING_INSTRUCTIO
HIPMATLID NSWSH_DELIVERY_DET
AILS.INVENTORY_ITEM_
ID converted to Item
Number by joining to
mtl_system_items ( this
delivery detail id is the
delivery detail id of the
container record)
SHIPUNIT.SHIPP Optional WSH_DELIVERY_DETAIL

OINTSHIPUNIT.S S.DELIVER_TO_LOCATIO
HIPNOTES N_IDWSH_DELIVERY_DE
TAILS.SHIPPING_INSTRU
CTIONS
SHIPUNIT.SHIPS Optional WSH_DELIVERY_DETAIL

RVLVLSHIPUNIT S.SHIP_METHOD_CODE
.SHIPPOINT WSH_DELIVERY_DETAIL
S.DELIVER_TO_LOCATIO
N_ID
SHIPUNIT.SHPM Optional WSH_DELIVERY_DETALS

TLDESCSHIPUNI .ITEM_DESCRIPTIONWS
T.SHIPSRVLVL H_DELIVERY_DETAILS.S
HIP_METHOD_CODE
SHIPUNIT.SHPU Optional WSH_DELIVERY_DETALS

NITSEQSHIPUNI .ITEM_DESCRIPTION
T.SHPMTLDESC
Table.Column Name
SHIPUNIT.SHPU Optional
NITSTSSHIPUNIT
.SHPUNITSEQ
SHIPUNIT.SHPU Optional
NITTOTSHIPUNI
T.SHPUNITSTS
SHIPUNIT.SPECI Optional
ALHNDSHIPUNI
T.SHPUNITTOT
SHIPUNIT.STAGE Optional
POINTSHIPUNIT.
SPECIALHND
SHIPUNIT.TEMP Optional
RATURE
(ACTUAL)SHIPU
NIT.STAGEPOIN
T
RATURE
(DELIVERY)SHIP
UNIT.TEMPRATU
RE (ACTUAL)
RATURE
(LOADING)SHIP
UNIT.TEMPRATU
RE (DELIVERY)
SHIPUNIT.TRAC Optional
KINGIDTYPESHI
PUNIT.TEMPRAT
URE (LOADING)
SHIPUNIT.TRAN Optional WSH_DELIVERY_DETAIL

SMETHDSHIPUN S.SHIP_METHOD_CODE
IT.TRACKINGIDT Write Procedure to
YPE Populate this column.

Table.Column Name
SHIPUNIT.TRAN Optional WSH_NEW_DELIVERIES.

STERMSSHIPUNI FOB_CODEWSH_DELIVE
T.TRANSMETHD RY_DETAILS.SHIP_METH
OD_CODE
SHIPUNIT.USER Optional WSH_DELIVERY_DETAIL

AREASHIPUNIT. S.DELIVERY_DETAIL_ID
TRANSTERMS (To be called as
DELIVERY_DETAIL_NUM
BER)
WSH_DELIVERY_DETAIL
NS
WSH_DELIVERY_DETAIL
S.DESCRIPTIVE_FLEXFIEL
DS
WSH_DELIVERY_DETAIL
S.LOT_NUMBER
WSH_DELIVERY_DETAIL
S.SUBLOT_NUMBER
WSH_DELIVERY_DETAIL
S.REVISION
WSH_DELIVERY_DETAIL
S.SERIAL NUMBER
WSH_DELIVERY_DETAIL
S.TO_SERIAL NUMBER
WSH_NEW_DELIVERIES.
FOB_CODE
Table.Column Name
SHIPUNIT.USER Optional WSH_DELIVERY_DETAIL

AREA S.DELIVERY_DETAIL_ID
(To be called as
DELIVERY_DETAIL_NUM
BER)
WSH_DELIVERY_DETAIL
NS
WSH_DELIVERY_DETAIL
S.DESCRIPTIVE_FLEXFIEL
DS
WSH_DELIVERY_DETAIL
S.LOT_NUMBER
WSH_DELIVERY_DETAIL
S.SUBLOT_NUMBER
WSH_DELIVERY_DETAIL
S.REVISION
WSH_DELIVERY_DETAIL
S.SERIAL NUMBER
WSH_DELIVERY_DETAIL
S.TO_SERIAL NUMBER
INVITEM. Optional If the Ship Unit is a

container, these are the
details about the item(s) in
the container.
INVITEM.ITEM Required If the Ship Unit is a

INVITEM. container, these are the
details about the item(s) in
the container.
INVITEM.QUAN Required
TITY (ITEM)
(REQUIRED)
INVITEM.ITEM Required
INVITEM.AMOU Required
NT (EXTENDED)
(T)INVITEM.QUA
NTITY (ITEM)

Table.Column Name
INVITEM.AMOU Optional
NT (ITEM)
(T)INVITEM.AM
OUNT
(EXTENDED) (T)
INVITEM.COUNT Optional
RY
ORGINVITEM.A
MOUNT (ITEM)
(T)
INVITEM.FRGHT Optional
CLSINVITEM.CO
UNTRY ORG
INVITEM.FRGHTI Optional
TEMINVITEM.FR
GHTCLS
INVITEM.HAZRD Optional
MATLINVITEM.F
RGHTITEM
INVITEM.ITEMD Optional
ESCINVITEM.HA
ZRDMATL
INVITEM.ITEMR Optional
VINVITEM.ITEM
DESC
VXINVITEM.ITE
MRV
INVITEM.LOTLE Optional
VEL1 -
LOTLEVEL2INVI
TEM.ITEMRVX
Table.Column Name
INVITEM.NOTES Optional
1 - NOTES
9INVITEM.LOTLE
VEL1 -
LOTLEVEL2
INVITEM.OWNR Optional
SHPCDEINVITE
M.NOTES 1 -
NOTES 9
INVITEM.QUAN Optional
TITY
(VOLUME)INVIT
EM.OWNRSHPC
DE
TITY
(WEIGHT)INVITE
M.QUANTITY
(VOLUME)
INVITEM.SHIPN Optional
OTESINVITEM.Q
UANTITY
(WEIGHT)
INVITEM.UPCIN Optional
VITEM.SHIPNOT
ES
INVITEM.USERA Optional
REAINVITEM.UP
C
REA

Table.Column Name
CONTAINER. Optional This is used to send

intermediate packaging
info. We do not have the
ability to send intermediate
packaging within the
shipping unit, so we will
not use this segment.
CONTAINER.CO Optional WSH_DELIVERY_DETAIL

NTAINRIDCONT S.CONTAINER_NAMEThi
AINER. s is used to send
intermediate packaging
info. We do not have the
ability to send intermediate
packaging within the
shipping unit, so we will
not use this segment.

NTNRSEALCONT S.SEAL_CODEWSH_DELI
AINER.CONTAIN VERY_DETAILS.CONTAI
RID NER_NAME

NTNRTYPECONT S.CONTAINER_TYPE_CO
AINER.CONTNR DE
SEAL WSH_DELIVERY_DETAIL
S.SEAL_CODE
CONTAINER.DES Optional WSH_DELIVERY_DETAIL

CRIPTNCONTAI S.CONTAINER_TYPE_CO
NER.CONTNRTY DE
PE
CONTAINER.NO Optional
TES 1 - NOTES
9CONTAINER.DE
SCRIPTN
CONTAINER.PA Optional
CKINGCONTAIN
ER.NOTES 1 -
NOTES 9
Table.Column Name
CKINGDESCCON
TAINER.PACKIN
G
RCNTNRIDCONT
AINER.PACKING
DESC
CONTAINER.SHI Optional WSH_DELIVERY_DETAIL

PMATLIDCONTA S.INVENTORY_ITEM_ID
INER.PARCNTNR converted to ITEM
ID NUMBER by joining to
mtl_system_items
CONTAINER.SHP Optional WSH_DELIVERY_DETAIL

MTLDESCCONT S.ITEM_DESCRIPTION
AINER.SHIPMAT WSH_DELIVERY_DETAIL
LID S.INVENTORY_ITEM_ID
converted to ITEM
NUMBER by joining to
mtl_system_items

Table.Column Name
CONTAINER.USE Optional WSH_DELIVERY_ASSIGN

RAREACONTAIN MENTS.DELIVERY_DETA
ER.SHPMTLDESC IL_ID (To be called as
DELIVERY_DETAIL_NUM
BER)
WSH_DELIVERY_ASSIGN
MENTS.PARENT_DELIVE
RY_DETAIL_ID (To be
called as
PARENT_DELIVERY_DET
AIL_NUMBER) HEIGHT –
From mtl_system_items
LENGTH - From
mtl_system_items
WEIGHT-
WSH_DELIVERY_DETAIL
S. GROSS_WEIGHT
WSH_DELIVERY_DETAIL
S. NET_WEIGHT
VOLUME –
WSH_DELIVERY_DETAIL
S. VOLUME WIDTH- From
mtl_system_items LOT-
WSH_DELIVERY_DETAIL
S. LOT_NUMBER
SUBLOT-
WSH_DELIVERY_DETAIL
S. SUBLOT_NUMBER
WSH_DELIVERY_DETAIL
S. REVISION
WSH_DELIVERY_DETAIL
S. SERIAL NUMBER
WSH_DELIVERY_DETAIL
S. TO_SERIAL NUMBER
WSH_DELIVERY_DETAIL
S.
SHIP_FROM_LOCATION_
ID converted to code (To be
called as
SHIP_FROM_LOCATION
LOCATION)
WSH_DELIVERY_DETAIL
S.
DELIVER_TO_LOCATION
_ID converted to code (To
Table.Column Name
be called as
DELIVER_TO_LOCATION
)
WSH_DELIVERY_DETAIL
S. TRACKING_NUMBER
WSH_DELIVERY_DETAIL
S. COUNTRY_OF_ORIGIN
WSH_TRIP_STOPS.ACTU
AL_ ARRIVAL_DATE
WSH_DELIVERY_DETAIL
S. DATE_SCHEDULED
WSH_TRIP_STOPS.ACTU
AL_ DEPARTURE_DATE
WSH_DELIVERY_DETAIL
S. SHIP_METHOD_CODE
WSH_DELIVE

Table.Column Name
CONTAINER.USE WSH_DELIVERY_ASSIGN
RAREA MENTS.DELIVERY_DETA
IL_ID
(To be called as
DELIVERY_DETAIL_NUM
BER)
WSH_DELIVERY_ASSIGN
MENTS.PARENT_DELIVE
RY_DETAIL_ID
(To be called as
PARENT_DELIVERY_DET
AIL_NUMBER)
HEIGHT – From
mtl_system_items
LENGTH - From
mtl_system_items
WEIGHT-
WSH_DELIVERY_DETAIL
S. GROSS_WEIGHT
WSH_DELIVERY_DETAIL
S. NET_WEIGHT
VOLUME –
WSH_DELIVERY_DETAIL
S. VOLUME
WIDTH- From
mtl_system_items
LOT-
WSH_DELIVERY_DETAIL
S. LOT_NUMBER
SUBLOT-
WSH_DELIVERY_DETAIL
S. SUBLOT_NUMBER
WSH_DELIVERY_DETAIL
S. REVISION
WSH_DELIVERY_DETAIL
S. SERIAL NUMBER
WSH_DELIVERY_DETAIL
Table.Column Name
S. TO_SERIAL NUMBER
WSH_DELIVERY_DETAIL
S.
SHIP_FROM_LOCATION_
ID converted to code (To be
called as
SHIP_FROM_LOCATION
LOCATION)
WSH_DELIVERY_DETAIL
S.
DELIVER_TO_LOCATION
_ID converted to code
(To be called as
DELIVER_TO_LOCATION
)
WSH_DELIVERY_DETAIL
S. TRACKING_NUMBER
WSH_DELIVERY_DETAIL
S. COUNTRY_OF_ORIGIN
WSH_TRIP_STOPS.ACTU
AL_ ARRIVAL_DATE
WSH_DELIVERY_DETAIL
S. DATE_SCHEDULED
WSH_TRIP_STOPS.ACTU
AL_ DEPARTURE_DATE
WSH_DELIVERY_DETAIL
S. SHIP_METHOD_CODE
WSH_DELIVERY_DETAIL
S.
FREIGHT_CLASS_CAT_ID
(To be called as
FREIGHT_CLASS_CATEG
ORY)
WSH_DELIVERY_DETAIL
S.
FREIGHT_TERMS_CODE

Table.Column Name
WSH_DELIVERY_DETAIL
S. HAZARD_CLASS_ID
(To be called as
HAZARD_CLASS or as
HAZARD_CLASS_CODE)
WSH_DELIVERY_DETAIL
S. FOB_CODE
WSH_DELIVERY_DETAIL
S.
SHIPPING_INSTRUCTION
S
WSH_DELIVERY_DETAIL
S.
PACKING_INSTRUCTION
S
WSH_DELIVERY_DETAIL
S. Descriptive Flexfields
CHARGE. Required This CHARGE section is for

a CONTAINER.

valueThis CHARGE section
is for a CONTAINER.

(T)

_COST_TYPE_ID

(T)
Table.Column Name

(T)

AMOUNT converted to

FREIGHT_COST_TYPE
PTNCHARGE.CH
GLINENUM

CHARGE.DESCRI
PTN

INVITEM. Optional
INVITEM.
TITY (ITEM)
INVITEM.AMOU Required
NT (EXTENDED)
(T)
TITY (ITEM)

Table.Column Name
NT (ITEM) (T)
NT (EXTENDED)
(T)
RY ORG
NT (ITEM) (T)
CLS
RY ORG
TEM
CLS
MATL
TEM
ESC
MATL
V
Table.Column Name
ESC
VX
V
VEL1 -
LOTLEVEL2
VX
1 - NOTES 9
VEL1 -
LOTLEVEL2
SHPCDE
1 - NOTES 9
TITY (VOLUME)
SHPCDE
TITY (WEIGHT)
TITY (VOLUME)

Table.Column Name
OTES
TITY (WEIGHT)
INVITEM.UPC Optional
OTES
REA
INVITEM.UPC Optional
REA
CHARGE. Optional This CHARGE section is for

SHIPUNIT.

valueThis CHARGE section
is for SHIPUNIT.

(T)

_COST_TYPE_ID

(T)
Table.Column Name

(T)

ETYPE EIGHT_COST_TYPE_ID
CHARGE.AMOU Optional converted to

NT (EXTENDED) FREIGHT_COST_TYPE
(T)

NENUM EIGHT_COST_TYPE_ID
CHARGE.CHARG Optional converted to

ETYPE FREIGHT_COST_TYPE
PTN
CHARGE.CHGLI Optional
NENUM
PTN



<?xml version="1.0" encoding = "UTF-8"?><SHOW_SHIPMENT_005>
<CNTROLAREA>
<BSR>
<VERB>SHOW</VERB>
<NOUN>SHIPMENT</NOUN>
</BSR>
<SENDER>
<TASK>SSNO</TASK>
<REFERENCEID>13784~WSH_EXPORT_COMPLIANCE~61</REFERENCEID>
</SENDER>
<YEAR>2004</YEAR>
<MONTH>06</MONTH>
<DAY>18</DAY>
<HOUR>08</HOUR>
<MINUTE>31</MINUTE>
<SECOND>40</SECOND>
</DATETIME>
</CNTROLAREA>
<DATAAREA>
<SHOW_SHIPMENT>
<SHIPMENT>
<YEAR>2004</YEAR>
<MONTH>06</MONTH>
<DAY>18</DAY>
<HOUR>08</HOUR>
<MINUTE>31</MINUTE>
<SECOND>35</SECOND>
</DATETIME>
<YEAR>2004</YEAR>
<MONTH>06</MONTH>
<DAY>18</DAY>
<HOUR>08</HOUR>
<MINUTE>27</MINUTE>
<SECOND>01</SECOND>
</DATETIME>
<DATETIME qualifier="ACTUAL_ARRIVAL">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
</DATETIME>
<DATETIME qualifier="ULTIMATE_DROPOFF">
<YEAR>2004</YEAR>
<MONTH>06</MONTH>
<DAY>18</DAY>
<HOUR>11</HOUR>
<MINUTE>59</MINUTE>
<SECOND>00</SECOND>
</DATETIME>
<DATETIME qualifier="ACTUAL_DEPARTURE">
<YEAR/>
<MONTH/>
<DAY/>
<HOUR/>
<MINUTE/>
<SECOND/>
</DATETIME>
<DATETIME qualifier="INITIAL_PICKUP">
<YEAR>2004</YEAR>
<MONTH>06</MONTH>
<DAY>18</DAY>
<HOUR>08</HOUR>
<MINUTE>25</MINUTE>
<SECOND>16</SECOND>
</DATETIME>
<QUANTITY qualifier="ESTIMATED_WEIGHT">
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Lbs</UOM>
</QUANTITY>
<QUANTITY qualifier="LOADING_WEIGHT">
<VALUE>0</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Lbs</UOM>
</QUANTITY>
<QUANTITY qualifier="NET_WEIGHT">
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Lbs</UOM>
</QUANTITY>
<QUANTITY qualifier="SHIP_UNIT">
<VALUE/>
<NUMOFDEC/>
<SIGN/>
<UOM/>
</QUANTITY>
<QUANTITY qualifier="TOTAL_WEIGHT">
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Lbs</UOM>
</QUANTITY>

<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>FT3</UOM>
</QUANTITY>
<AMOUNT qualifier="FREIGHT">
<VALUE/>
<NUMOFDESC/>
<SIGN/>
<CURRENCY/>
<DRCR/>
</AMOUNT>
<SHIPPERID>Beijing</SHIPPERID>
<SYNCID>A</SYNCID>
<CARRIER/>
<CARRSRVLVL/>
<COUNTRYDST>CN</COUNTRYDST>
<DESCRIPTN/>
<DOCTYPE>SS</DOCTYPE>
<DOCUMENTRV>001</DOCUMENTRV>
<SHIPPOINT>Atlanta (OPS)</SHIPPOINT>
<SHIPSRVLVL/>
<TRANSMETHD/>
<TRANSTERMS/>
<WAREHOUSE>IM1</WAREHOUSE>
<USERAREA>
<ORACLE.SHOW_SHIPMENT_005.SHIPMENT.USERAREA>
<ORACLE.DELIVERY_NAME>63771</ORACLE.DELIVERY_NAME>
<ORACLE.LOADING_SEQUENCE/>
<ORACLE.VEHICLE_NUM_PREFIX/>
<ORACLE.VEHICLE_NUMBER/>
<ORACLE.ROUTE_ID/>
<ORACLE.ROUTING_INSTRUCTIONS/>
<ORACLE.DEPARTURE_SEAL_CODE/>
<ORACLE.ORIG_DOCID/>
<ORACLE.CUSTOMER_NAME>Computer Service and
Rentals</ORACLE.CUSTOMER_NAME>
<ORACLE.CUSTOMER_NUMBER>1006</ORACLE.CUSTOMER_NUMBER>
<ORACLE.WAYBILL/>
<ORACLE.DESCRIPTIVE_FLEXFIELD>
<ORACLE.ATTRIBUTE_CATEGORY/>
<ORACLE.ATTRIBUTE1/>
</ORACLE.DESCRIPTIVE_FLEXFIELD>
</ORACLE.SHOW_SHIPMENT_005.SHIPMENT.USERAREA>
</USERAREA>
<PARTNER>
<NAME>ITMTESTORG1</NAME>
<PARTNRTYPE>SHIP_FROM</PARTNRTYPE>
<PARTNERID>IM1</PARTNERID>
<CURRENCY/>
<DUNS_NUMBER>0</DUNS_NUMBER>
<PARTNIDX>0</PARTNIDX>
<USERAREA>
<ORACLE.SHOW_SHIPMENT_005.SHIPMENT.PARTNER.USERAREA>
<ORACLE.INTMED_SHIP_TO_LOCATION/>
<ORACLE.POOLED_SHIP_TO_LOCATION/>
</ORACLE.SHOW_SHIPMENT_005.SHIPMENT.PARTNER.USERAREA>
</USERAREA>
<ADDRESS>
<ADDRLINE index="1">Jia 1</ADDRLINE>
<ADDRLINE index="2">Yuentanbeiju Dongkou</ADDRLINE>
<ADDRTYPE/>
<CITY>Xicheng</CITY>
<COUNTRY>CN</COUNTRY>
<COUNTY/>
<REGION/>
<STATEPROVN/>
</ADDRESS>
<CONTACT>
<FAX>(01) 8512393</FAX>
<TELEPHONE>(01) 8512211</TELEPHONE>
<URL/>
</CONTACT>
<DOCUMNTREF>
<DOCTYPE>SHIPMENTREQUEST</DOCTYPE>
<DOCUMENTID/>
<PARTNRID>IM1</PARTNRID>
</DOCUMNTREF>
</PARTNER>
<PARTNER>
<NAME>Computer Service and Rentals</NAME>
<PARTNERID>Atlanta (OPS)</PARTNERID>
<CURRENCY/>
<DUNS_NUMBER/>
<PARTNIDX/>
<USERAREA>
<ORACLE.SHOW_SHIPMENT_005.SHIPMENT.PARTNER.USERAREA>
<ORACLE.INTMED_SHIP_TO_LOCATION/>
<ORACLE.POOLED_SHIP_TO_LOCATION/>
</ORACLE.SHOW_SHIPMENT_005.SHIPMENT.PARTNER.USERAREA>
</USERAREA>
<ADDRESS>
<ADDRLINE index="1">1156 River Street</ADDRLINE>
<ADDRTYPE/>
<COUNTY>Fulton</COUNTY>
<REGION/>

</ADDRESS>
<CONTACT>
<FAX>404-876-8526</FAX>
<TELEPHONE>404-876-0987</TELEPHONE>
<URL/>
</CONTACT>
<DOCUMNTREF>
<DOCTYPE>SHIPMENTREQUEST</DOCTYPE>
<DOCUMENTID/>
<PARTNRID>Atlanta (OPS)</PARTNRID>
</DOCUMNTREF>
</PARTNER>
<SHIPITEM>
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Ea</UOM>
</QUANTITY>
<QUANTITY qualifier="BACKORDERED">
<VALUE>0</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Ea</UOM>
</QUANTITY>
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>FT3</UOM>
</QUANTITY>
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Lbs</UOM>
</QUANTITY>
<ITEM>WSH-Standard</ITEM>
<COUNTRYORG/>
<FRGHTCLS/>
<HAZRDMATL/>
<ITEMDESC>WSH-Standard</ITEMDESC>
<ITEMRV/>
<ITEMX/>
<NOTES/>
<SHIPNOTES/>
<USERAREA>
<ORACLE.SHOW_SHIPMENT_005.SHIPMENT.SHIPITEM.USERAREA>
<ORACLE.DELIVERY_DETAIL_NUMBER>225272</ORACLE.DELIVERY_DETAIL_NUMBER>
<ORACLE.PARENT_DELIVERY_DETAIL_NUMBER/>
<ORACLE.SHIP_TOLERANCE_ABOVE>50</ORACLE.SHIP_TOLERANCE_ABOVE>
<ORACLE.SHIP_TOLERANCE_BELOW>50</ORACLE.SHIP_TOLERANCE_BELOW>
<ORACLE.LOAD_SEQUENCE_NUMBER/>
<ORACLE.SHIP_SET_NUMBER/>
<ORACLE.SUBINVENTORY>Stores</ORACLE.SUBINVENTORY>
<ORACLE.TOP_MODEL_LINE_NUMBER/>
<ORACLE.SHIP_MODEL_COMPLETE_FLAG/>
<ORACLE.COMMODITY_CODE_CATEGORY/>
<ORACLE.SHIPMENT_PRIORITY_CODE/>
<ORACLE.DELIVERY_TO_LOCATION>1093</ORACLE.DELIVERY_TO_LOCATION>
<ORACLE.CUSTOMER_NAME>Computer Service and
Rentals</ORACLE.CUSTOMER_NAME>
<ORACLE.CUSTOMER_NUMBER>1006</ORACLE.CUSTOMER_NUMBER>
<ORACLE.DESCRIPTIVE_FLEXFIELD>
<ORACLE.ATTRIBUTE_CATEGORY/>
</ORACLE.DESCRIPTIVE_FLEXFIELD>
</ORACLE.SHOW_SHIPMENT_005.SHIPMENT.SHIPITEM.USERAREA>
</USERAREA>
<DOCUMNTREF>
<DOCUMENTID/>
</DOCUMNTREF>
<INVDETAIL>
<VALUE>3</VALUE>
<NUMOFDEC/>
<SIGN/>
<UOM>Ea</UOM>
</QUANTITY>
<DESCRIPTN>WSH-Standard</DESCRIPTN>
<SERIALNUM/>
<USERAREA>
<ORACLE.SHOW_SHIPMENT_005.SHIPMENT.SHIPITEM.INVDETAIL.USERAREA>
<ORACLE.TO_SERIAL_NUMBER/>

<ORACLE.PREFERRED_GRADE/>
</ORACLE.SHOW_SHIPMENT_005.SHIPMENT.SHIPITEM.INVDETAIL.USERAREA>
</USERAREA>
</INVDETAIL>
</SHIPITEM>
</SHIPMENT>
</SHOW_SHIPMENT>
</DATAAREA>
14
Oracle Shipping Execution EDI Transactions

• DSNO
DSNO
Departure Ship Notice Outbound 856

DSNO is a notice used by the supplier to provide advance notification of a shipment to
the buyer or trading partner that the material has been shipped. It is extremely flexible,
and permits the seller to transmit shipment information in varying levels of detail. It is
also referred to as ASC X12 856 transaction EDI.
Interface Trip Stop (ITS): DSNO is generated as a part of Interface Trip Stop process.
DSNO can also be generated after Ship Confirm using the concurrent program
Departure Ship Notice Outbound.
The Outbound Execution engine is responsible for extracting data related to a
transaction from Oracle Applications. A transaction is referred to as a Business
Document or a message i.e. purchase order, invoices, shipment notices, etc. The
Extracted data can be staged in a staging table, fed directly to the EDI Flat File process
to create an Outbound EDI File, or sent to the XML Engine for producing XML
Documents.
A given transaction can have multiple representation for the outside world i.e. a
purchase order document can be an XML document for one customer and EDI Flat File
for another customer. The data related to different maps for the same transaction is
stored in the EDI repository. The triggering process will identify which map to process
and then pass on the value to the engine.
The input to the Execution Engine is the Map Identifier for the message and the
transaction type. The map identifier stores the mapping information between the Oracle
Applications tables and the Flat File or XML or Staging table.
The Execution engine extracts the data from EC messaging views, defined on top of
Oracle Shipping Execution EDI Transactions 14-1

business views for each transaction. In addition to the data obtained from the view, the
engine executes stored procedures, functions, and custom code to pull out the
remaining business data. RFID information can also be provided as part of the DSNO
for Oracle Warehouse Management enabled organizations. For more information, see
the Oracle E-Commerce Gateway User and Implementation Guide.
A
Oracle Order Management Error and
Information Messages
This appendix covers the following topics:

• Process_PO and Acknowledge_PO
• Show_SalesOrder
• Cancel_PO
• Change SO
• Inbound Change PO Request
Process_PO and Acknowledge_PO

1. The error out message if it is not determined whether document delivery is
required for that TP.
OE_OI_TP_NOT_FOUND - Missing Primary SOLD_TO site usage for the customer
id &CUST_ID
2. The error out message if the outbound acknowledgment data is not generated
correctly.
OE_OI_ACK_DATA_NOT_FOUND - Error in getting data from &TABLE for
sending the acknowledgment
3. The error out message if a particular type of EDI location is not found.
OE_OI_EDI_LOC_NOT_FOUND - &EDI_LOCATION not found for the site usage
of &SITE_USAGE
4. The error out message if the org cannot be determined from the address.
OE_OI_ORG_NOT_FOUND - &SITE_USAGE site usage is not found for address id
&ADDRESS_ID
Oracle Order Management Error and Information Messages A-1

5. The error out message if the customer site cannot be determined when generating
acknowledgment data.
Process_PO and Acknowledge Purchase Order
OE_OI_CUST_SITE_NOT_FOUND - Could not determine account/party site id for
customer id &CUST_ID
6. The error out message if the customer cannot be identified before raising the
acknowledgment event.
OE_OI_CUST_NOT_FOUND - No Customer Found & OPT_TABLE for document
id &DOC_ID
Show_SalesOrder
No seeded messaged for this transaction exist.
Cancel_PO
1. Error message if invalid quantity is sent on the inbound Cancel_PO XML.
OE_OI_INVALID_QTY_3A9 - Attempt to cancel Invalid Quantity
2. Error message if we cannot determine whether document delivery is required for

that trading partner.
OE_OI_TP_NOT_FOUND - Missing Primary SOLD_TO site usage for the customer
id &CUST_ID
3. Error message if we cannot generate the outbound acknowledgment data correctly.

OE_OI_ACK_DATA_NOT_FOUND - Error in getting data from &TABLE for
sending the acknowledgment
4. Error message if a particular type of EDI location is not found.

OE_OI_EDI_LOC_NOT_FOUND - &EDI_LOCATION not found for the site usage
of &SITE_USAGE
5. Error message if the org cannot be determined from the address.

OE_OI_ORG_NOT_FOUND - & SITE_USAGE site usage is not found for address id
&ADDRESS_ID
6. Error message if the customer site cannot be determined when generating

acknowledgment data.
OE_OI_CUST_SITE_NOT_FOUND - Could not determine account/party site id for
customer id &CUST_ID
A-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
7. Error message if the customer cannot be identified before raising the
acknowledgment event.
OE_OI_CUST_NOT_FOUND - No Customer Found &OPT_TABLE for document
id &DOC_ID
Note: Integration with the Collaboration History Module (CLN)
Order Management provides integration with Collaboration History Module (CLN).

The Collaboration History module records the transaction history when the trading
partners exchange messages. To enable this Order Management has incorporated the
API calls during the processing of the XML messages.
Refer to the Collaboration History Module documentation for more details.
Change SO
Following message will be raised when status of 3A8 response is 'ACCEPT' but 3A8
does not match with the changes proposed on the original 3A7.
1. Message_Name: ONT_3A8_RESPONSE_COL_MISMATCH
3A8 Request Purchase Order Change response does not match with changes
proposed on the original 3A7.
Message Type: Error

1. One or more rejected lines was received on a Change PO Response
Change PO - Buyer response contained one or more rejected lines which were not
processed by Order Management
Change PO Response was rejected at header level.
Change PO - Buyer response contained a rejected header and was not processed
by Order Management.
2. OM is ready to send Change SO

OM is ready to send Change SO message.
3. Setup validation done (Successful)

Change SO - Setup validation successful.
4. Setup validation done (Failed)

Change SO - Setup validation failed.
5. Change Sales Order message sent
Oracle Order Management Error and Information Messages A-3

Change SO message has been sent.
Inbound Change PO Request

1. When the Change PO message is processed and Order Import tables are populated
with the data the message recorded using Collaboration History Module API is:
On success – Change PO - Data successfully entered into Open Interface tables
2. Order Import is going to be run immediately:

Change PO - Order Import will be run in Synchronous mode
3. Order Import will be run in Asynchronous mode.

Change PO - Order Import will be run in Asynchronous mode
4. Order Import has completed.

Change PO-Order import has completed (Sucessfully)
5. Order Import has completed.

Change PO-Order import has completed (Failure)
A-4 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide

Om API

Uploaded by

Document Informationclick to expand document information

Copyright:

Available Formats

Om API

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Om API

Uploaded by

Copyright:

Available Formats

Oracle® Order Management

Open Interfaces, API, & Electronic Messaging Guide

Part No. B31585-01

Copyright © 1996, 2007, Oracle. All rights reserved.

Primary Author: John Brazier, Pratima Mahtani, John Salvini

U.S. GOVERNMENT RIGHTS

Send Us Your Comments

1 Integrating Your Systems

2 Oracle Advanced Pricing Open Interfaces and APIs

3 Oracle Advanced Pricing XML Transactions

4 Oracle Order Management XML Transactions: Implementation Considerations

5 Oracle Order Management XML Transactions

6 Oracle Order Management EDI Transactions

7 Oracle Order Management Open Interfaces and APIs

8 Oracle Order Management: Integration with Other Products

10 Oracle Release Management EDI Transactions

11 Oracle Release Management Open Interfaces and APIs

12 Oracle Shipping Execution Open Interfaces and APIs

13 Oracle Shipping Execution XML Transactions

14 Oracle Shipping Execution EDI Transactions

A Oracle Order Management Error and Information Messages

TTY Access to Oracle Support Services

Accessibility of Code Examples in Documentation

Accessibility of Links to External Web Sites in Documentation

Related Information Sources

Do Not Use Database Tools to Modify Oracle Applications Data

This chapter covers the following topics:

Overview of Oracle Order Management APIs and Open Interfaces

Basic Business Needs

• Connect to other systems such as finite scheduling packages, computer-aided

Integrating Your Systems 1-1

• Control processing of inbound data imported from outside Oracle applications.

• Validate imported data to maintain data integrity within the application.

• Review, update, and resubmit imported data that failed validation.

• Export data from Oracle Order Management products to external systems.

Oracle Order Management Interfaces

Open Interface Architectures

• Interface Views (Business Views)

• Function Calls or Programmatic Interfaces (Processes)

Function Calls or Programmatic Interfaces (Processes)

Summary: Beyond Published Interfaces

Some Key Terms and Tables

Data Flow Direction Inbound means into Oracle Order

Iface Man The interface is documented in detail in the

e-TRM The tables, views, or modules are described in

Integrating Your Systems 1-3

ONT ONT ONT ONT ONT ONT

Order Import Inbound Table Yes Yes OE_HEADER

Process Inbound Process No Yes OE_ORDER_

Agreement Inbound/Out Procedure Yes Yes OE_PRICING

Attribute Inbound/Out Procedure Yes Yes QP_ATTR_M

Business Inbound/Out Procedure Yes Yes QP_MODIFI

Integrating Your Systems 1-5

Business Inbound/Out Procedure Yes Yes QP_PRICE_F

Business Procedure Yes Yes QP_LIMITS_

Create Inbound/Out Procedure Yes Yes QP_PRICE_B

Custom Inbound/Out Procedure Yes Yes QP_RUNTIM

Get Currency Inbound/Out Procedure Yes Yes QP_CURREN

Get_Attribute Inbound/Out Procedure Yes Yes QP_UTIL_PU