7/31/2019 115eccim
1/425
Oracle e-Commerce Gateway Implementation Manual
Oracle e-Commerce Gateway Implementation Manual, Volume 1
Release 11i
March 31, 2000
Part No. A75164-01
7/31/2019 115eccim
2/425
Oracle e-Comm erce Gateway Implem entation Man ual, Release 11i
Part No. A75164-01
Copyr ight 2000, Oracle Corp oration. All rights reserved .
Primary Author: Bonnie Shebat Williams, Fred Graham, Debbie Quezadaz, Janet Lee
Contribu ting Auth ors: Steve Moriarty, Dan McCoy, Geoffrey Scott-Baker, Steve Nelson, DavidWrightson
Contributors: David Reitan
The Programs (which includ e both the software and documentation) contain proprietary information o fOracle Corp oration; they are provided un der a license agreemen t containing restrictions on use an ddisclosure and are also protected by copyrigh t, paten t, and o ther intellectual and ind ustrial proper tylaws. Reverse engineering, disassembly, or decompilation of the Programs is prohibited.
The inform ation contained in this docu ment is subject to chan ge withou t notice. If you find a ny p roblemsin the docum entation, please report them to us in writing. Oracle Corporation d oes not warrant that thisdocum ent is error free. Except as may be expressly permitted in you r license agreement for th esePrograms, no part of these Programs may be reproduced or transmitted in any form or by any means,electronic or mechanical, for any p urp ose, w ithout the express wr itten perm ission of Oracle Corp oration.
If the Program s are delivered to the U.S. Governmen t or anyon e licensing or using th e program s onbehalf of the U.S. Governm ent, the following notice is app licable:
Restricted Rights N otice Program s delivered su bject to the DOD FAR Sup plemen t are "commercialcomputer software" and use, duplication, and disclosure of the Programs, including documentation,shall be sub ject to the licensing restrictions set forth in the ap plicable Oracle license agreem ent.Otherw ise, Program s delivered sub ject to the Federal Acquisition Regulations are "restricted comp utersoftware" and u se, dup lication, and d isclosure of the Progr ams sh all be subject to the restrictions in FAR52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500Oracle Parkway, Redwood City, CA 94065.
The Program s are not intend ed for u se in any nu clear, aviation, mass transit, medical, or other inh erentlydan gerou s app lications. It shall be the licensee's responsibility to take all app ropr iate fail-safe, backup ,redu nd ancy, and oth er measur es to ensure the safe u se of such app lications if the Program s are used forsuch pu rp oses, and O racle Corp oration disclaims liability for any d amag es caused b y such use of thePrograms.
Oracle is a registered tradem ark, and is trad emark or registered trad emark of Oracle Corporation. Allother comp any or p rodu ct names mentioned are used for identification purp oses only and may betrademarks of their respective owners.
7/31/2019 115eccim
3/425
iii
Contents
Send Us Your Comments ................................................................................................................... ix
Preface............................................................................................................................................................ xi
1 Introduction
Purpose of the Implementation Guide ........................................................................................... 1-2
Documentation.................................................................................................................................... 1-3
Oracle e-Commerce Gateway Overview ....................................................................................... 1-4
Processing Traditiona l EDI Transactions ................................................................................ 1-12
EDI Translators ........................................................................................................................... 1-17
2 Implementation Positioning
Implementation Positioning............................................................................................................. 2-2
Other Application Implementations.......................................................................................... 2-5
Determ ine Com munications Meth ods For The Transactions ................................................ 2-9
Implem entation Plann ing .......................................................................................................... 2-11
3 Oracle e-Commerce Gateway Implementation Checklist
Implementation Steps ........................................................................................................................ 3-2
Implem entation Checklist for Software Upgrade ........................................................................ 3-3
Implem entation Checklist for Fresh Install .................................................................................. 3-7
Implem entation Checklist for Maintenance Patch ...................................................................... 3-8
4 Implementation Details
Report Scripts ...................................................................................................................................... 4-2
Define Responsibilities ..................................................................................................................... 4-4
Define UTL_FILE_DIR Parameter in INIT.ORA File .................................................................. 4-5
Review Release 11i Upgrade Guideline ......................................................................................... 4-7
Set Up Profil es ................................................................................................................................... 4-10
7/31/2019 115eccim
4/425
iv
System Profile Win dow ............................................................................................................. 4-11
Transaction Specific Op tions .................................................................................................... 4-15Ou tbound Pu rchase Order Transaction Profile ..................................................................... 4-16
Determine Process and Column Rules and Actions .................................................................. 4-18
Enable Additional Transaction Data ............................................................................................. 4-25
Modify Transaction Interface File ................................................................................................. 4-29
Synchronize New Transaction Layout D efini tions with Translator....................................... 4-35
Common Transaction Interface File D efinition Errors.............................................................. 4-36
Set Up Trading Partners ................................................................................................................... 4-37
Common Set Up Errors.............................................................................................................. 4-40
Set Up Code Conversion ................................................................................................................. 4-41
Interface with Translators ............................................................................................................... 4-45
.................................................................................................... Transaction Data File Report 4-46
Communications......................................................................................................................... 4-48
Archive/Backup ................................................................................................................................. 4-49
5 Transaction Interface File Architecture
File Structure Overview ..................................................................................................................... 5-2
Interface Data File Structure............................................................................................................. 5-5
Specia l Record s ............................................................................................................................. 5-7
Optional Outbound Trading Partner Flexfield Records (0020-0070) ...................................... 5-12
Common Record Key (1-100).................................................................................................... 5-13Common Records (Based on Record Layout Code).............................................................. 5-17
Code Conversion Internal and External Codes on the File ...................................................... 5-25
6 Application Transaction Detail
Oracle Inventory ................................................................................................................................. 6-2
Oracle Order Management ............................................................................................................... 6-5Oracle Payables ................................................................................................................................... 6-6
Inbou nd Invoice (INI/ 810/ INVOIC) ........................................................................................ 6-8
Inbound Ship ment and Billing Notice (SBNI/ 857/ No EDIFACT) ..................................... 6-15
Ou tbound Application Ad vice (ADVO/ 824/ APERAK)...................................................... 6-16
Out bound Payment Order/ Remittance Adv ice (PYO/ 820/ PAYORD-PAYEXT-REMADV)...
6-18
Oracle Process Manufacturing ....................................................................................................... 6-24
7/31/2019 115eccim
5/425
v
Oracle Purchasing ............................................................................................................................. 6-25
Inbound Price/ Sales Catalog (CATI/ 832/ PRICAT) Inbound Respon se to Request forQuotation (RRQI/ 843/ QUOTES 6-27
Inbound Ship N otice/ Manifest (ASNI/ 856/ DESADV) Inbound Shipment and Billing
Not ice (SBNI/ 857/ No EDIFACT) 6-36
Ou tbound Application Ad vice (ADVO/ 824/ APERAK)...................................................... 6-48
Ou tbound Pu rchase Order (POO/ 850/ ORDERS)................................................................. 6-49
Outbou nd Purchase Ord er Chan ge (POCO/ 860/ ORDCH G) ............................................. 6-52
Oracle Receivables ............................................................................................................................ 6-55Ou tbound Invoice (INO/ 810/ INVOIC) ................................................................................. 6-56
Out bound Credit Memo/ Debit Memo (CDMO/ 812/ CREADV-DEBADV)..................... 6-59
Oracle Release Management .......................................................................................................... 6-62
Oracle Shipping Execution ............................................................................................................. 6-63
Oracle Supplier Scheduling ........................................................................................................... 6-64
Ou tbound Planning Schedule (SPSO/ 830/ DELFOR) .......................................................... 6-65
Ou tbound Shipp ing Schedule (SSSO/ 862/ DELJIT) ............................................................. 6-69
7 Test Transactions
Testing Inbound Transactions .......................................................................................................... 7-2
Testing Outbound Transactions ....................................................................................................... 7-6
Printing and Extract of Documents ................................................................................................. 7-8
8 Troubleshooting
Troubleshooting ............................................................................................................................... ... 8-2
Error Messages .................................................................................................................................... 8-4
Inbound Transactions ...................................................................................................................... 8-11
Transaction Exception Sum mar ies ........................................................................................... 8-13
Reports ................................................................................................................................................ 8-16
9 Trading Partner
Trading Partner.................................................................................................................................... 9-2
Trading Partner Group ....................................................................................................................... 9-3
EDI Location Codes ............................................................................................................................ 9-4
Translator Codes............................................................................................................................... ... 9-6
7/31/2019 115eccim
6/425
vi
Translator Code and EDI Location Code Across Applications .................................................. 9-9
Linking Trading Partner Data to the Oracle Application Source........................................ 9-11EDI Location Codes in the Transaction Interface Files ............................................................. 9-13
Multi Organizations ......................................................................................................................... 9-20
Organ izat ions in Oracle Ap plication Op en In terface Tables ............................................... 9-24
Trading Partner Window s......................................................................................................... 9-25
10 Code Conversion
Code Conversion ............................................................................................................................... 10-2
Concaten ated Search Key for Inbound Tran sactions .......................................................... 10-32
Concatenated Search Key for Outbound Transactions ............................................................ 10-38
11 Extensible Architecture
Customizing EDI Transactions....................................................................................................... 11-2
Descriptive Flexfields ...................................................................................................................... 11-4
Steps for Extensible Architecture .................................................................................................. 11-8
A Transaction Summary Layouts
Oracle Inventory Transaction Summaries...................................................................................... A-2
Cu rrent Inform ation ..................................................................................................................... A-2
Oracle Order Management Transaction Summaries .................................................................... A-7Cu rrent Inform ation ..................................................................................................................... A-7
Oracle Payables Transaction Summaries ....................................................................................... A-8
Cu rrent Inform ation ..................................................................................................................... A-8
Inbound Invoice.......................................................................................................................... A-11
Oracle Process Manufacturing Transaction Summaries ........................................................... A-28
Cu rrent Inform ation ................................................................................................................... A-28
Oracle Purchasing Transaction Sum maries ................................................................................. A-29
Cu rrent Inform ation ................................................................................................................... A-29
Oracle Receivables Transaction Summaries ................................................................................ A-72
Cu rrent Inform ation ................................................................................................................... A-72
Oracle Release Management Transaction Summaries ............................................................... A-90
Oracle Shipping Execution Transaction Summaries ................................................................. A-91
Cu rrent Inform ation ................................................................................................................... A-91
7/31/2019 115eccim
7/425
vii
Oracle Supplier Scheduling Transaction Summaries ................................................................ A-92
Cu rrent Inform ation ................................................................................................................... A-92
7/31/2019 115eccim
8/425
viii
7/31/2019 115eccim
9/425
ix
Send Us Your Comments
Oracle e-Commerce Gateway Implementation Manual, Release 11i
Part No. A75164-01
Oracle Corporation w elcomes your comm ents and su ggestions on the quality and u sefulness of this
pu blication. Your inp ut is an important part of the information u sed for revision.
s Did you find any errors?
s Is the information clearly presented ?
s Do you need more information? If so, wh ere?
s Are the examples correct? Do you need more examples?
s What features did you like most about th is manual?
If you find an y errors or have any other suggestions for imp rovement, please indicate the chapter,
section, and page n um ber (if available). You can send commen ts to us in th e following w ays:
s E-mail - ed isup @us.oracle.com
s FAX - 650.506.7812 Attn: Oracle e-Com merce Gateway
s Posta l service: 3op9
Oracle Corporation
Oracle Oracle e-Comm erce Gateway Documentation
500 Oracle Parkw ay, 3op6
Redw ood Shores, CA 94065
USA
If you w ould like a reply, please give your nam e, add ress, and telephone nu mber below.
If you have p roblems w ith the software, please contact you r local Oracle Supp ort Services.
7/31/2019 115eccim
10/425
x
7/31/2019 115eccim
11/425
xi
Preface
The Oracle e-Comm erce Gateway Implementation Manu al is used to imp lement
app lication integrations for electronic commerce.
Intended AudienceThis man ual is intend ed for anyone wh o is interested in implemen ting Oracle
e-Comm erce Gateway.
StructureThis m anual contains eleven chapters and one app endix:
Chap
Chap ter 1 Introdu ces Oracle e-Comm erce Gateway implem entation.
Chapter 2 Explains Oracle e-Commerce Gateway implementation addit ional
requirements.
Chapter 3 Contains the Oracle e-Commerce Gateway implementation
checklist.
Chap ter 4 Provides Oracle e-Comm erce Gateway imp lementation details.
Chapter 5 Contains the details of the Transaction Interface File Architecture.
Chapter 6 Explains the transaction details by Oracle application.
Chapter 7 Explains how to test an inbound or outbound transaction .
Chapter 8 Contains information regarding troubleshooting Oracle
e-Comm erce Gateway errors.
7/31/2019 115eccim
12/425
xii
Related DocumentsFor more information, see the following man uals in the Release 11i Oracle
App lications Open Interface Guides:
s Oracle e-Commerce Gateway Users Guide
s Oracle Purchasing Users Guide
s Oracle Supplier Scheduling Users Guide
s Oracle Payables Users Guide
s Oracle Receivables Users Guide
s Oracle Order Management Users Guide
s Oracle Shipping Execution Users Guide
s Oracle Release Management Users Guide
s Oracle Manufacturing, Distribution, Sales and Service Open Interface Manual
s Oracle Payables Users Guide, Payables Open Interface
s Oracle e-Commerce Gateway Technical Reference Manual
s Oracle Purchasing Technical Reference Manual
s
Oracle Supplier Scheduling Technical Reference M anu als Oracle Payables Technical Reference Manual
s Oracle Receivables Technical Reference Manual
s Oracle Order M anagement Technical Reference Manual
s Oracle Shipping Execut ion Technical Reference Manual
s Oracle Release M anagement Technical Reference Manual
Chapter 9 Explains in detail about Oracle e-Commerce Gateway Trading
Partners.Chapter 10 Explains how to define and use Code Conversions used by Oracle
e-Comm erce Gateway.
Chapter 11 Describes Extensible Architecture and how it relates to outbound
transactions.
Appendix A Includes the transaction summary layouts by product.
7/31/2019 115eccim
13/425
xiii
ConventionsIn examples, an implied carriage return occurs a t the end of each line, unless
otherw ise noted. You m ust p ress the Return key at the end of a line of input.
The following conventions are also used in this m anu al:
Convention Meaning
< > Angle brackets enclose user-sup plied nam es.
> What follows is the actual SQL statemen t.
7/31/2019 115eccim
14/425
xiv
7/31/2019 115eccim
15/425
Introduction 1-1
1Introduction
This chap ter contains the following in formation about Oracle e-Commerce Gateway
implementation:
Purp ose of the Implementation Gu ide on page 1-2
Documentation on page 1-3
Oracle e-Comm erce Gateway Overv iew on page 1-4
7/31/2019 115eccim
16/425
Purpose of the Implementation Guide
1-2 Oracle e-Commerce Gateway Implementation Manual
Purpose of the Implementation GuideThe Oracle e-Comm erce Gateway Implementation Guid e provides details to
facilitate imp lementation of the product, and h ighlights add itional actions to ensure
a successful implementa tion.
While Oracle e-Comm erce Gateway is in itself, a comprehensive prod uct tha t will
suit most customer s e-business integration requ irements, most of the effort
expended during an implementation cycle concerns defining, mapping, and
balancing custom er requirements against trad ing partn er expectations. This guid e
includ es imp lementation details, and contains an overview of the main points thatshould be taken into considera tion du ring the course of an Oracle e-Comm erce
Gateway project.
The Oracle e-Comm erce Gateway Implemen tation Guide provides the following:
s Required kn owled ge profile for an implementer
s Implemen tation checklist
s Profiles and validation ru les setup details
s Trading Partner setup details and recommend ations
s Code conversion setup details and recommend ations
s Oracle Application setups for the transactions
s Transaction interface file architecture
s
Transaction interface file modification guideliness Testing recommend ations
s Details about th e sup ported transactions
s Trouble Shooting tools and recomm endations
s Recomm endations on how to extend th e supp orted transactions
Note: Details for add ing transactions not sup ported by Oracle e-Comm erce
Gateway are not included in this document.
7/31/2019 115eccim
17/425
Documentation
Introduction 1-3
DocumentationThe following d ocumen tation for Oracle e-Comm erce Gatew ay is available:
s Oracle e-Comm erce Gateway User s Guide
s Oracle e-Commerce Gatew ay Technical Reference Manual (TRM)
Someone in your organization may need this man ual if any custom izations
such as extension tables are imp lemented .
s
Oracle Manufactu ring, Distribution, Sales and Service Open Interface Manuals Oracle Payables Users Guid e
Note: Get the latest Oracle e-Commerce Gateway sup plemen tal documents
from Oracle Supp ort Services Metalink web site. See the p reface for more
details about th is web site.
7/31/2019 115eccim
18/425
Oracle e-Commerce Gateway Overview
1-4 Oracle e-Commerce Gateway Implementation Manual
Oracle e-Commerce Gateway Overview
e-Business Integration
Oracle e-Comm erce Gateway is a stand ards-based integra tion prod uct for Oracle
App lications. This integration p rodu ct allows you to in tegrate Oracle Applications
with ap plications residing inside or outside of your enterprise, communicating via
the Intran et, Extranet, or the Internet.
Oracle e-Comm erce Gateway evolved from th e Oracle EDI Gateway p rodu ct,
focusing on Electronic Data Interchange (EDI) into a prod uct focused on e-businessintegration. All the features and fun ctions of Oracle EDI Gateway are retained and
enhanced to create the Oracle e-Comm erce Gateway p rodu ct.
Oracle e-Comm erce Gateway su pp orts seamless integration, streamlined
imp lementation, and ru le-based transaction processing to au tomate your business
operations. The major features includ e:
s Open and Extensible Architecture
7/31/2019 115eccim
19/425
Oracle e-Commerce Gateway Overview
Introduction 1-5
s Streamlined Transaction Imp lementation
s Configurable Integration Environmen t
s Rule-Based Process Managem ent
s Reports
Oracle e-Comm erce Gateway is designed with an open an d extensible architecture
for easy integration with any third p arty app lication.
The product is architected with self-contained yet integrated mod ules focused on
ease of imp lementation; you simp ly define the bu siness rules and configurationparameters, then you can implemen t any of the pre-built transactions.
Extensibility hooks are provided to integrate custom transactions and extend the
Oracle e-Comm erce Gateway supp orted tran sactions by incorporating da ta from
non-Oracle App lications d ata sou rces.
Configurable Integration Environment
Oracle e-Comm erce Gateway su pp orts configurations at the system, transaction,
trad ing pa rtner, and process levels giving you utm ost control of your da ta, interface
files, and business processes.
You can configure how data elements are validated and map ped , the structure and
layout of an interface file, w hen a bu siness process is initiated, and how it should
proceed. Furthermore, you can control the behavior of a process if an exception is
detected.
All rules are stored in a repository to supp ort dyn amic run-time message creation,
autom ated p rocess monitoring, and exception analysis. Using a single wind ow, you
can change a rule by changing th e informat ion stored in the Oracle e-Comm erce
Gateway repository. The upd ated ru le takes effect at run-time withou t any code
modifications.
System level configurations apply to all transactions, and includ e the following :
s
Define inbound / outbound file directorys Enable/ disable transactions
s Define text wrapping ru les
Transaction level configurations app ly to a specific transaction, and includ e the
following:
s Valida tion Rules
7/31/2019 115eccim
20/425
Oracle e-Commerce Gateway Overview
1-6 Oracle e-Commerce Gateway Implementation Manual
s Code Conversions
s Transaction Layout
By defining the validation rules, you indicate how a transaction is to be validated, what
constitutes an exception, and what action to take if an exception is detected. This ensures
that only valid transactions are passed to Oracle e-Commerce Gateway for processing.
Oracle e-Commerce Gateway supports the following validation and exception processing
rules:
The transaction exception rules includ e invalid trad ing par tner, invalid Ad dress, nd
Test/ Production mode discrepancy.The data validation rules includ e:
Each ru le is associated w ith an action taken w hen an exception is detected. Theexception p rocessing options are skip current d ocument, log the violation and
continue processing, or abort the entire run.
Another form of transaction configuration is performed on th e transaction data,
based on u ser-defined code conversion rules. The Oracle e-Comm erce Gateway
Code Conversion m odu le supp orts the following:
s One Or acle code to one external code
Data Rule Description
Data Type Checking Compare the data types of the data in the file to the datatype defined in Gateway transaction table.
Defau lt if Nu ll Move a defau lt value to the st ag ing t able column, if the field
is NULL (blank) in the interface file.
Null Dependency Checks if the incoming data for a given column has a nulldependency.
Predefined List Checks if the incoming da ta for a given column is equa l toor not equ al to a value in a predefined list in the Oraclee-Commerce Gatew ay.
Simple Lookup Checks if the incoming data for a given column is a valid
value equal to the one foun d in the u ser-defined table andcolum n th at w ill be used in a SQL Select Statement.
Valueset Lookup Checks if the incoming data for a g iven column is a va lidvalue in a standard Oracle Valueset.
Value is Required Checks if the incoming data for a given column has anon-nu ll value, i.e. it cannot be blank.
7/31/2019 115eccim
21/425
Oracle e-Commerce Gateway Overview
Introduction 1-7
s One Oracle code to m any external codes
s Criteria-based code conversion
s Intelligent search for Oracle or external code(s)
An example of a one-to-one relationship is the conversion of a single Oracle code for unit of
measure to a unit of measure code based on the ISO 9000 code list, the ASC X12 code list,
or your private code list. An example of a one to many relationship is the conversion of a
single Oracle code for payment terms to its ASC X12 components for discount percent,
discount days, and net days.
You can d efine a code conversion ru le that ap plies to all transactions for all trad ing
part ners or one that is specific to a trading partner and tran saction combination.
For maximum flexibility, you can define up to five specific criteria per ru le.
Intelligent search is used to iden tify the O racle interna l or external codes by
performing the search using the maximum nu mber of user-defined criteria then
redu cing the nu mber of criteria by one un til a match is foun d. If a match is not
found , a default is used.
The final tran saction configu ration is related to the tran saction layou t. Oracle
e-Comm erce Gateway d elivers seeded t ransaction layout definitions representing
relevant bu siness data from or to Oracle App lications. The transaction layout
definitions may be used as is, or customized to match the d ata you transmit to your
trad ing partn er. The transaction layout configuration options includ e change file
structu re, change record layou t, change record attr ibutes, and d elete records.
In add ition to the system and transaction level configurations, you m ay configure
the trading p artner attributes.
The trading p artner is the entity you are doing bu siness with and is the key link
between Oracle e-Commerce Gateway an d O racles suite of e-business produ cts and
between Oracle e-Comm erce Gateway or any third party application. The third
party app lication may be an EDI translator for EDI transactions or any oth er
app lication internal or external to your enterp rise. In add ition to establishing these
links, you can configure the trading par tner attributes to indicate that a transaction
is enabled or disabled for processing, and indicate the transaction status to be test orprod uction for processing.
Once all the necessary system, transaction and trad ing part ner level configurations
are defined, and you are ready to initiate a transaction, Oracle e-Comm erce
Gateway supports three processing options:
Event-dr iven p rocessing for time critical business transactions such as electronic
payments or ship notices.
7/31/2019 115eccim
22/425
Oracle e-Commerce Gateway Overview
1-8 Oracle e-Commerce Gateway Implementation Manual
Schedule-based p rocessing for less critical but routinely u sed bu siness transactions
such as pu rchase orders.
User-defined processing.
The processing option you select dep ends on the natu re of your bu siness and
tran saction criticality.
Once the tran saction p rocess is initiated, the ru n-time execution engine takes over
and proceeds according to the system, transaction, and trad ing partn er
configurations you defined.
If necessary, a user-activated run-time execution log is available to assist with
trouble shooting. This diagnostic tool sup ports m ultiple levels of trace details for
both technical and non-technical analysts.
View Transaction Exceptions
The status of a transaction process and any reported exceptions may be viewed
using a single workbench style window known as the View Staged Documents
window. Sum mary or detailed inquires are supported u sing tree style navigation.Dynamic window s and drill-dow ns are provided to h elp analyze the cause of an
exception.
Once the cause of the exception is identified and resolved, you have the option to submit the
transaction for reprocessing or treat the exception as a warning by ignoring or deleting the
exception.
The status inqu iry, trouble-shooting and re-processing of tran sactions are all done in
one single window, the View Staged Docum ents window.
Several reports facilitate the imp lementation p rocess. Use the reports to view
trading p artner and code conversion d ata or review the seeded transaction layout
definitions, and the contents of a d ata file.
Transaction List
Oracle e-Comm erce Gateway is indep endent of all EDI standard s and can be
integrated w ith any up stream or down stream p rocess via an ASCII file. It is this
indep end ence that enables you to select any EDI translator or third p arty
app lication that best suits your business requirements.
Includ ed in the Oracle e-Comm erce Gateway product are many pre-built business
critical transactions, and integration configura tion tools designed to streamline you r
imp lementation to easily transform you r business to e-business.
7/31/2019 115eccim
23/425
Oracle e-Commerce Gateway Overview
Introduction 1-9
X12
Tran.
EDIFACT
Message Direction Description
850 ORDERS in bou nd Pu rch ase Or der in to Oracle Process Man ufactu rin g
855 ORDRSP outbound Purchase Order Acknowledgment from Oracle ProcessManufacturing
856 DESADV ou tbou nd Sh ip N otice/ Man ifest from O racle ProcessManufacturing
X12
Tran.
EDIFACT
Message Direction Description Base Oracle Application
850 ORDERS outbound Purchase Orders from Oracle Purchasing
860 ORDCH G ou tbound Purchase Ord er ChangeRequest
from Oracle Purchasing
832 PRICAT inbound Price/ Sales Catalog into Oracle Purchasing
843 QUOTES inbound Response to Request forQuotation
into Oracle Purchasing
856 DESADV in bou nd Sh ip N otice/ Man ifest in to O racle Pu rch asin g
857 no
equivalent
inbound Shipment and Billing Notice into Oracle Purchasing andPayables
824 APERAK outbound Application A dvice,diagnostic
message used in response toth e
inbound ship notice,shipment/ billing notice,an d
invoice transactions
from
Oracle Purchasing andPayables
830 DELFOR outbound Planning Schedule from Oracle SupplierScheduling
862 DELJIT outbound Shipping Schedule from Oracle SupplierScheduling
O l C G t O i
7/31/2019 115eccim
24/425
Oracle e-Commerce Gateway Overview
1-10 Oracle e-Commerce Gateway Implementation Manual
The following transactions are available with Oracle Process Manufactur ing. The
Inbound Purchase Order and Outboun d Ship Notice/ Manifest transactions are
based on th e Oracle Process Manufacturing d ata mod el and sh ould be treated as
different transactions even thou gh they share the same nam e as their respective
transactions in Oracle Order Management.
810 INVOIC inbound Invoice, includes d ata for the
ASC X12 110, 210, 410, 880transactions
into Oracle Payables
820 PAYORD/
REMADV
outbound Payment Orders / Remittance Advice
from Oracle Payables
850 ORDERS inbound Purchase Orders into Oracle OrderManagement
855 ORDRSP outbound Purchase Order
Acknowledgments
from Oracle Order
Management
860 ORDCHG inbound Purchase Order Changes from Oracle OrderManagement
865 ORDRSP ou tbound Purchase Ord er Change
Acknowledgments
from Oracle OrderManagement
856 DESADV outbound Ship Notice/ Manifest from Oracle ShippingExecution
830 DELFOR inbound Planning Schedule into Oracle ReleaseManagement
862 DELJIT inbound Shipping Schedule into Oracle ReleaseManagement
866 no
equivalent
inbound Production Sequence into Oracle ReleaseManagement
810 INVOIC outbound Invoice, includes data for the
ASC X12 110, 210, 410, 880transactions
from Oracle Receivables
812 CREADV/ DEBADV
outbound Credit Memo, Debit Memo from Oracle Receivables
N/ A CUSDEC outbound Movement Statist ics(INTRASTAT)
from Oracle Inven tory
Oracle e Commerce Gateway Overview
7/31/2019 115eccim
25/425
Oracle e-Commerce Gateway Overview
Introduction 1-11
X12
Tran.
EDIFACT
Message Direction Description Base Oracle Application
850 ORDERS inbound Purchase Order into Oracle ProcessManufacturing
855 ORDRSP outbound Purchase OrderAcknowledgment
from Oracle ProcessManufacturing
856 DESADV outbound Ship Notice/ Manifest from Oracle ProcessManufacturing
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
26/425
Oracle e-Commerce Gateway Overview
1-12 Oracle e-Commerce Gateway Implementation Manual
Processing Traditional EDI Transactions
Although Oracle e-Comm erce Gateway has evolved into an e-business integrator, itcontinues to be the hu b for processing high volume traditional EDI transactions.
The following section d escribes how trad itional EDI transactions are p rocessed
through Oracle e-Comm erce Gateway.
Interface Files between Oracle e-Commerce Gateway and Any Translator
ASCII files are passed between Oracle e-Comm erce Gateway an d any Translator for
trad itional EDI transaction p rocessing.
For inbound transactions, the Translator copies the d ata from its position in the
stand ard EDI transaction to its required position in the Oracle transaction interface
file.
The reverse data m app ing is done for outbou nd transactions. Oracle e-Comm erce
Gateway creates a transaction interface file of the d ata from th e base Oracle
App lication. The Translator copies the data to its position in the chosen stand ard .
The following graphic is an example Oracle e-Comm erce Gateway ou tboun d
pu rchase order (POO) interface file on th e left, and the ASC X12 purchase ord er
(850) transaction on the right.
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
27/425
Oracle e Commerce Gateway Overview
Introduction 1-13
Oracle e-Comm erce Gateway extracts outboun d tr ansaction data from application
tables and loads inboun d tran sactions into the base Oracle App lication Open
Interface tables.
0010 => ISA, GS
1000 => BEG
2000 => PO1
3000 => SCH
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
28/425
y
1-14 Oracle e-Commerce Gateway Implementation Manual
The comp onents and tran saction flows are shown below.
Outboun d Flow of a Transaction with Or acle e-Comm erce Gateway
Inboun d Flow of a Transaction with O racle e-Commerce Gateway
Oracle e-Comm erce Gateway resides between Oracle App lications and a tr anslator
and processes data using ASCII interface files.
The EDI Translator accomm odates the EDI stand ards such as ASC X12 and
EDIFACT, and m onitors transm itting standard formatted data between Trad ing
Partners. The format and content of this file can be ad justed using the Interface File
Definition wind ow w ithin Oracle e-Comm erce Gateway, thou gh any changes mustbe imp lemented w ithin the EDI Translator s data map and set-up .
An EDI Translator data map m ay be defined to p rodu ce a transaction according to
the recommend ations of any ind ustry guid eline such as UCS, EIDX, or AIAG. A
data m ap m ay accomm odate the data requirements of a single trading partner or
many trading partners.
Oracle
e-Commerce
Gateway
Outbound
Message
TranslatorInterface
File
Oracle
Application
850BT12357889SG41825520
ISA~
BEG~00N1~ST~
ISA~
BEG~00N1~ST~
850BT1235789SG41825520
Inbound
Message
TranslatorInterface
File
Oracle
Application
Open Interface
Oracle
Application
Oracle
e-Commerce
Gateway
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
29/425
Introduction 1-15
Oracle e-Comm erce Gatew ay p rocesses data via th e transaction interface file that is
received from or sent to the Translator. Oracle e-Comm erce Gatewa y is
independ ent of all standard formats since only the bu siness data is found in the
Oracle e-Comm erce Gatew ay t ransaction interface files.
Oracle e-Comm erce Gateway d oes not have commun ication software to transmit
the standard formatted d ata between trading partners. Oracle e-Commerce
Gateway relies on the Translator being connected to third p arty comm un ication
service providers to transmit d ata to, or receive data from, trading partners after the
data is mapp ed to the desired standard format.
Outbound Process Flow
Oracle e-Comm erce Gateway ou tboun d transaction process creates interface data
files to supp ort any EDI Stand ard that is ava ilable from th e Translator. Oracle
e-Comm erce Gateway collects all of the business d ata needed to map to a standard
EDI transaction w hich the receiving Trad ing Partn er can interpret p roperly into
their receiving ap plication u sing their equ ivalent of Oracle e-Comm erce
Gateway/ Translator set up.Oracle e-Comm erce Gateway extracts the data from the base ap plication tables, and
optionally extracts data from other files/ tables via extension tables. The use of
extension tables requires the custom ization of stand ard code p ackages provided
with Oracle e-Comm erce Gatew ay.
Oracle e-Comm erce Gateway does the following :
s Reviews the System and Transaction p rofiles.
s Gets Trad ing Partn er p rocessing param eters, e.g. location codes,
allowable/ enabled EDI transactions, etc.
s Extracts data from Oracle base app lications tables relevant to the transaction
being processed.
s Opt ionally, retrieves data from custom er defined extension tab les (requires
some customization).
s App lies code conversions (when set up and activated).
s Popu lates Oracle e-Comm erce Gateway tables with all the data gath ered.
Sets the d ata extract flags in the base Oracle App lication table to p revent
subsequ ent re-extraction.
Produces an interface data file for use by the EDI Translator.
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
30/425
1-16 Oracle e-Commerce Gateway Implementation Manual
Inbound Process Flow
The inbou nd transaction flow is similar to the ou tboun d tr ansaction flow.Oracle e-Comm erce Gateway p erforms the following functions du ring an inbou nd
tran saction p rocess after it receives an interface file from the EDI Translator or oth er
process:
s Reviews the System and Transaction p rofiles.
s Gets Trad ing Partner validation p rocessing param eters.
s
Validates data based on u ser-defined p rocess rules for the transaction.s App lies code conversions (if set up and activated ).
s Validates data based on u ser-defined column rules for the data elements.
s Captu res transaction data exceptions. These exceptions can be reviewed on-line
from the staging t ables to examine th e exception cond ition. The correction
action is p erformed in a trad ing partner set u p or other app lication set u p, then
the transaction can be revalidated . Optionally transactions may be d eleted from
the view staging tables.
s Loads valid transactions into the app ropriate Oracle Application Open Interface
tables for the transaction.
All the valid transactions are loaded into the Ap plication Op en Interface tables
wh ere it is valida ted by Oracle Open Interfaces Ap plication Program Interfaces
(APIs). Valid da ta is loaded into Oracle App lication base tables.
Exception data is detected both in Oracle e-Comm erce Gateway and OracleApp lications dep ending on the type of exception encoun tered. For example, Oracle
e-Commerce Gateway w ould d etect that the trading partner w as not set up for a
given transaction, whereas the base Oracle App lication API wou ld d etect a
du plicate invoice.
The app lications stand ard error hand ling fun ctions are u sed to identify, report, and
resolve errors. Errors d etected by the Translator are resolved by the error h and ling
in that p rocess. Reoccurr ing da ta errors that originate from the send er should be
discussed with the trading partner for perman ent corrections.
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
31/425
Introduction 1-17
EDI Translators
The following section describes fun ction p erformed by an EDI Translator in theprocessing of trad itional EDI transactions.
The various stand ards for message formatting are both precise and potentially
changing, in add ition, there are many issues regarding the various add ressing
methods and communication protocols that m ay be used for the actual exchange of
transactions. A formatting and commu nications interface is therefore required
between Oracle e-Comm erce Gateway and the external comm un ications service.
This interface software is called the EDI Translator. There are a num ber of specialistcompan ies who operate in this area offering packages to address these
requirements.
EDI Translators generally provide tools to map any interface data file format to an y
format including standard EDI transactions and messages, so data m app ing to a
stand ard like SPEC2000 should not be an issue with most Translator p roviders.
They m ay not p rovide p redefined d ata map s for all standards, but their software
should provide a m eans to handle any-to-any data m apping.
Another key feature provid ed by the Translator is comm un ication error and forma t
checking to ensure that invalid messages are rejected and retu rned .
Translator software normally provides bu ilt in supp ort for one or more of the EDI
standards and communication methods. It may also offer support for pre-packaged
extension produ cts that include proprietary file forma ts.
EDI Translators p erform the following ma in functions:
1. Integrated Aud it Trail.
Provides an au dit trail of transaction activity and profile up dates.
2. Trad ing Pa rtner Identification.
Trad ing par tner iden tifications are maintained to define wh ich transactions are
enabled for test or p roduction, w hich EDI standard and its version/ release to
map the data, define data for the electronic envelope, define the
comm unications m ethod to be u sed, etc.
3. Stand ards Translation.
Maintains ASC X12 and EDIFACT transaction tables for all versions/ releases,
XML, and other stand ards as needed .
4. Data Mapping.
Provide data mapp ing facilities between p roprietary formats and the standard s.
Oracle e-Commerce Gateway Overview
7/31/2019 115eccim
32/425
1-18 Oracle e-Commerce Gateway Implementation Manual
5. Communications.
Provides scripts to access popu lar VANs and VASPs, They also have thecapability to send d ata over the Internet.
6. Short-term Transaction Archival.
Requeu es transactions to transm it again as needed .
7. Autom atic Transaction Status Feedback to the Ap plication
Feedback is provided to Oracle App lications that transactions have confirmed
receipts from tr ading p artners or some other tran smission status, e.g. buyersmay wish to see a confirmation th at a su pp lier received (or not) a specific order.
8. Aud it Transaction Archival.
Maintains historical archival of data for aud it pu rposes.
7/31/2019 115eccim
33/425
Implementation Positioning 2-1
2Implementation Positioning
This chap ter contains the following in formation about Oracle e-Commerce Gateway
implementation:
Implementation Positioning on page 2-2
Implementation Positioning
7/31/2019 115eccim
34/425
2-2 Oracle e-Commerce Gateway Implementation Manual
Implementation Positioning
To successfully imp lement the Oracle e-Comm erce Gateway and enable specifictransactions within the p roduct, the implementers needs to h ave certain knowledge
and experience beyond the Oracle e-Comm erce Gateway. This section d escribes
those additional requirements.
Understand Standards
If trad itional EDI transactions are being imp lemented , the following m ust be
understood:
Understand Standard Components
Implementers mu st be familiar w ith all EDI standards comp onents, i.e., segments,
elements, and code values that make u p EDI transactions for which the
E-Comm erce Gateway interface is being imp lemented . Implementors mu st know
wh ich elements in an EDI transaction correspond with fields in an Oracle
E-Comm erce Gatew ay interface file to be able to assist w ith Translator softw are
map ping. Implementors mu st be familiar with codes (qualifiers) that are used toidentify data elements in an EDI transaction.
Understand Characteristics of the EDI Transaction
Implemen tors mu st be familiar w ith the characteristics of an EDI transaction.
For example, the ASC X12 stand ard Purchase Order 850 transaction has a three level
structure: Head er, Item, and Shipm ents. The Oracle Order Managemen t
OrderImport op en interface has a two level structure: head er and th e combined
Item/ Shipm ents. Each combination of the Item and Shipmen t in the transaction
mu st be combined to create an item record in the tran saction interface file.
Understand the Data Mapping Requirements
Implemen tors should review the clients data m app ing requirements to identify
elements for wh ich there is no correspond ing field in the Oracle E-Comm erce
Gateway tr ansaction interface file. For examp le, the Trad ing Partner may send d ataat the detail line level in a p urchase order tr ansaction that identifies their warehouse
bin/ bulk location. The Trad ing Partner requires the supp lier to prin t this data on a
label and app ly the label to each carton associated with the detail line item. This
carton label facilitates the Trading Partners receiving process.
If necessary, it is recommend ed that th e EDI imp lementation team includ e an
app lication specialist in the relevant transaction area.
Implementation Positioning
7/31/2019 115eccim
35/425
Implementation Positioning 2-3
Understanding the Oracle e-Commerce Gateway Functions
Attend an Oracle E-Commerce Gateway Course
Implementors should attend an Oracle E-Commerce Gateway course. They mu st
understand all the features including p rofile set up s, process rules, column rules,
trad ing partn er definitions, and code conversion for setting up th e produ ct.
Understand Trading Partner Set Ups It is essential that the relationship betw eenTranslator and EDI Location Codes be completely un derstood . Also a policy shou ld
be pu t in place with the customer so an adm inistrator can easily m aintain thetrad ing par tner set up screens given only basic data about the Trad ing Partner,
Location, and perm issible transactions.
Understand General Code Conversion Set Ups
The Code Conversion capabilities of the Oracle e-Comm erce Gateway can p rovide a
comprehensive set of criteria to convert intern al Oracle codes, site codes, paym ent
codes etc. to/ from the terms u sed by the Trad ing Partners. These conversions can beun dertaken globally or based up on sp ecific criteria using u p to five keys - see the
Oracle e-Comm erce User Manual for more details. Conversion requirements
should be carefully planned and kep t as simp le as possible to avoid over comp lex
situations requiring burdensome maintenance.
Understand Extension tables (for Outbound Transactions)
Implementors should und erstand or have access to a developer wh o und erstands
PL/ SQL and h ow data is stored in the da tabase. They can determ ine feasibility ofchanges, how to make those changes withou t disturbing th e existing routines, and
how to make them in such a w ay that the changes can be easily adapted w hen
patches are installed. This also applies to inbound transactions wh en additional
routines are needed to make the d ata pu t into the interface tables by the Oracle
e-Commerce Gateway compatible with th e import p rocess and/ or the customers
needs.
A basic knowledge of the table structure of the relevant Oracle App lications andOracle e-Comm erce Gateway is a big advantage if any custom work is
contemplated.
Implementation Positioning
7/31/2019 115eccim
36/425
2-4 Oracle e-Commerce Gateway Implementation Manual
Understand Oracle Applications and Application Open Interfaces
Know the Transient Data in the Oracle Application
The Oracle App lications prod uce data as needed by the app lication. They may not
retain d ata in the tables that is calculated because the n um bers used to produ ce the
calculation (number of units and discount p ercentage in the example below) may
change each time the app lication is run. The d ata is printed on a p ermanent p aper
docum ent. Because EDI is a substitu te for the pap er docum ent, this data must be
compu ted and stored in the ou tgoing file. The imp lementer must allow for this by
defining a field in the EDI extension table and the code to popu late it.
Know the Functionality of the Oracle Application
Verify tha t the O racle Application p erforms the fun ction expected by the
transaction.
Know the Required Fields and Default Data
Know th e required fields in the transaction interface file and the ap plication openinterface and know the defaults d efined in the Oracle e-Comm erce Gateway for the
transaction
The open interface tables require certain fields to be pop ulated to prop erly process
the incoming d ata. Because it is not known w hether the d ata is available on the
source system, a default value can be used so that p rocessing can continu e.
Required fields and default values are dependent on how the app lication is
configured to hand le keyboard entry in setup . It is also very imp ortant that thebase app lication is set up w ith the data that it is expecting.
Implementation Positioning
7/31/2019 115eccim
37/425
Implementation Positioning 2-5
Other Application Implementations
For stand ard tran sactions, an e-Comm erce environment m ust be installed.Generally the following m ust be done in the Translator sp ecifically and the
e-Comm erce env ironment generally.
This documen t does not d iscuss th e detail of installing Translators or the operation
of Tran slators.
Translators
Each comp any m ust install a Translator to p rocesses traditional standardtransactions su ch as ASC X12 transactions an d EDIFACT messages. They m ust
review its system requ irements, and its integration requirements w ith the Oracle
e-Comm erce Gateway.
The ability to configu re the Tran slator to su it different form ats is also a
consideration to facilitate any changes that m ay be required from up da tes to the
Oracle e-Comm erce Gateway. These changes may be in th e form of new or
add itional transactions, changes in the custom er s business requirements, andchanges occasioned by new or existing trad ing p artners. If the Translator is d ifficult
to up date or configure, this may imp act the successful, timely outcome of an EDI
implementation.
Another consideration is whether or not the Translator is runn ing on the same
server as the Oracle e-Comm erce Gateway. In some cases, the Translator has been
installed on a separate machine, for example a mainframe. When th is is the case, it
is necessary to allow for file transfer requirements and sched uling to/ from the
Translator. In some instances a file transfer to/ from a mainframe may require thatthe file be of fixed length . In this case. the var iable nature of the files used by the
Oracle e-Comm erce Gateway may pose problems of pad ding (for outboun d
transactions) and interface file d efinition (for inbou nd transactions).
Trading Partner Definitions
Translators have criteria for d efining trad ing partners, that is different from the
trad ing par tner definitions used in the Oracle e-Comm erce Gateway.The Translator set u p requires identifying the following:
s Sender an d receiver ident ification codes for the electronic envelopes.
s The EDI stand ard and its version/ release or data d ictionary for trad itional EDI
transactions.
Implementation Positioning
7/31/2019 115eccim
38/425
2-6 Oracle e-Commerce Gateway Implementation Manual
s The transactions data map used to map data between the source data file and
the standard transaction.
s Which code conversion sets are to be used for the transaction for the trad ing
partner.
s Commu nication method .
s Comm un ication service provider.
The Oracle e-Comm erce Gateway requires the Translator s identification code for its
trad ing p artner d efinition in the tr ansaction interface file on the Control Record
0010. It is defined at the Translator Code in the trad ing pa rtner set u p in th eTrad ing Partner Detain tab in the Trad ing Partner set up .
Code Conversion
Like the Oracle e-Commerce Gateway, Translators provide for code conversion
between the value defined in the base Oracle Application and the values required
by the EDI stand ard or the trading partner. Code conversion is performed on
specific da ta elements. You can u se the Oracle e-Commerce Gateway for some d ataelements and the Translator on other d ata elements. You shou ld decide w here it is
most efficient for your imp lementations, bearing in mind how easy it will be in the
future to ad d, edit, or delete conversions in the Oracle e-Comm erce Gateway or the
Translator.
Data Mapping
Review the Oracle e-Commerce Gateway transaction interface files and the EDI
stand ard tran saction to determine w here the data is positioned in the EDI stand ard
transaction. If transaction data m aps already exist, they provides a good starting
point since the stand ard tran saction portion of the data m ap can be copied from the
existing data map. You will need to substitute its mapp ed position defined in the
Oracle e-Comm erce Gatew ay t ransaction interface file.
Some Translators p rovide a base data map for the Oracle e-Comm erce Gateway
transaction interface file. These base d ata m aps are currently based on the initial
release 11. They are not likely to be plug and play data m aps. Note that th eTranslator p roviders m ay charge ad ditional license or service fees for these
pre-configured data map s.
The base data m aps m ost likely need customization for the following reasons:
s Whether the internal or external code(s) are available in the interface file (if you
used code conversion)
Implementation Positioning
7/31/2019 115eccim
39/425
Implementation Positioning 2-7
s System or business requirements
s Trading partners requirementsThe base data m aps m ay also need changes if software p atches add or change data
element p ositions in the transaction interface file and you accept new records a fter
the seed data reconciliation review.
The following reports may facilitate your d ata map reviews. Run the reports as
needed:
s Transaction Record Layout report to see th e tran saction interface file
s Transaction Data File report to see data from a file against its t ransaction
interface file layout
The following process should be followed after a patch is app lied. This process
attemp ts to restore the record layou t to the layout as d efined before the latest
patches w ere applied. Review the log from th is process to see the imp act of the
patch and the reconstructed transaction record layout:
s Seed Data Reconciliation process
For outboun d t ransactions, if data cannot be found in the transaction interface file
as defined by the Oracle e-Comm erce Gateway, sup plemen tal data m ay be foun d in
user d efined flexfields or the user d efined t ransaction extension tables. Data may
also be map ped to transaction flexfields for inbound tran sactions. Custom code is
required to p opu late the transaction extension tables if that op tion is used for
outbound transactions.
If there are still gaps in the data, determine the best way to add ress data orfunctional gaps. Two alternatives may be followed for inbound transactions:
s Custom mod ifications ma y be necessary in the base application
s This applies to outbou nd transactions: there may be the case where the
transaction passed all the validat ion in the Oracle e-Comm erce Gateway, but the
app lication open interface may still require add itional data. Write custom code
to add da ta to the transactions in the ap plication open interface tables. This
custom code is executed after the Oracle e-Comm erce Gateway wrote thetransactions to the ap plication op en interface table but before the app lication
open interface executes.
s For inbound transactions, modifications shou ld be mad e similarly to those
mad e to popu late the extension tables.
Implementation Positioning
7/31/2019 115eccim
40/425
2-8 Oracle e-Commerce Gateway Implementation Manual
Transaction Processing
The Oracle e-Comm erce Gatewa y creates transactions by th e following m ethods:s A transaction is initiated by an event in the base Oracle App lication.
s The base app lication initiates a request within Concur rent manager w ith key
data from the tran saction to w rite the transaction to a t ransaction interface file.
s Created by a scheduled requ est within Concurrent Manager.
Usually the requ est extracts all eligible transactions that are read y to be extracted.
You can limit the tran sactions selected by entering selection parameters in therequest.
Set up ap propr iate transaction interface file detection in the file directory. The file
directory is defined in the initial app lication set u p for all transactions in the System
Profile Options in the Oracle e-Comm erce Gateway. The Translator n eeds to be able
to access the inter face file.
Follow you r file backup and archive procedures and practices that m ay also need to
consider local fiscal requirements.
Determine th e frequency that the Oracle e-Comm erce Gateway files are processed
through the Translator. Ideally, you shou ld put comp leted transaction files either in
another d irectory or und er other file names so that the Translator cannot access the
file unt il the Oracle e-Comm erce Gateway is finished w ith it.
Implementation Positioning
7/31/2019 115eccim
41/425
Implementation Positioning 2-9
Determine Communications Methods For The Transactions
Ensure that th e order in w hich the processes are performed - e.g. for outbou ndtransactions, Oracle e-Commerce Gateway processing, file transfer, archive, or
Translator - fits in w ith the local environm ent and other p rocesses being performed
around the Oracle e-Comm erce Gateway.
Transaction Testing
Create test acceptan ce criteria to test th e transactions.
Bear in mind th at each trad ing partner m ay have its own requirements andtherefore one size may not fit all. Customization may extend to a lower level than
jus t the transaction type. This m ay increase the time requ ired for both development
and testing. Trad ing partner and customer are not synonym ous! For example, if a
chain of ten retail stores allows each store to require some sort of different data on a
transaction, then there are ten trad ing partner d ata map s, not one data map .
Another examp le is a trad ing partner in California where the state may require
add itional hazardous m aterial data for shipping.
First test internally to va lidate initial mapp ing, conversions, settings an d interaction
between the Oracle e-Comm erce Gatew ay and Translator, e.g.
s Interface file testing into/ out of the Oracle e-Comm erce Gateway
s Interaction testing to/ from the Translator
s Interaction testing along the p ath betw een the ap plications and the Translator
output/ input
s Verify and comp are the data passed to/ from the app lications w ith the EDI
transaction file into/ out of the Translator.
Nom inate test Trading Partners for the initial transaction outboun d/ inbound and
obtain their agreemen t to be test sites.
Where the nu mber of trading p artners is large, it may be necessary to take a phase
testing app roach, that is:
s An initial small set of test trad ing partners to validate correct map ping, andidentify an y initial issues caused by new map ping specifications and/ or
software.
s A second, larger set of trading partners to verify the fixes imp lemented as a
result of the initial trading p artner testing.
Implementation Positioning
7/31/2019 115eccim
42/425
2-10 Oracle e-Commerce Gateway Implementation Manual
s Final testing with the total trading par tner comm unity, or move directly to
produ ction status.
It is imp ortant that acceptance of correct operation a t each stage be documented
before proceeding to the next stage of testing.
Implementation Positioning
7/31/2019 115eccim
43/425
Implementation Positioning 2-11
Implementation Planning
The process of sending and receiving an e-commerce transaction is relativelysimp le. As with all simple concepts h owever, there is usu ally a lot of work to d o in
map ping custom er, trading partner, and Translator requiremen ts to ensure that each
stage has the requ ired data in the correct fields. Most of the imp lementation time is
taken in these tasks.
The checklist for the issues involved in a stand ard Oracle e-Comm erce Gateway
implementation can be sum marized as:
s Data mapp ing requirements
s Trad ing Partner set ups
s General Code Conversion set ups
s Extension tables (for outbou nd transactions)
s Stand ards to be used for transactions
s Relevant fun ctionality in the Oracle App lication
s Required fields and d efaults on transaction interface file and Ap plication
Open Interface
s Customer's setup an d procedu res for u sing th e App lications
s Changes in procedu res or business rules within the Application relating to
e-Commerce
s
Specific imp lementation ru les negotiated with the Trad ing Partnerss Capabilities of the Translator in creating an d using the tran saction interface
file
s Method for file transfer between the Translator and Oracle e-Comm erce
Gateway
The planning process includ es the following:
s
Develop p roject planss Investigate and un derstan d the bu siness imp act of each transaction
s Identify customization requiremen ts
s Co-ordinate the Translator interface
s Collate all set-up da ta
Implementation Positioning
7/31/2019 115eccim
44/425
2-12 Oracle e-Commerce Gateway Implementation Manual
s Write tran saction or message specifications
s Produ ce Test Plans
s Develop transaction archiving p olicies
s Co-ordina te testing w ith Trad ing Partners
The scope of a project dep ends on the know ledge of the imp lementers, num ber of
Trad ing par tner sites to define, nu mber of Transactions imp lemented , and th e
number of data maps need ed in the Translator.
A simple project is one that involves one supp orted transaction, few trad ingpartners, and minimal code conversion.
Set-up includes the ha rdw are set-up and software installation of the pre-built
prod ucts. It does not add ress the changes that may be needed for code conversion
and customization which are part of the Modification phase. Also, Modification
may either come before Testing (since the need for changes are iden tified in the
Definition ph ase), or there may be another Testing ph ase after Modification. A
good m inimu m guideline for this second phase w ould be one day of testing for
each day of mod ification.
An ou tline timeline proposal for a simp le project could show elapsed tim e to be as
follows if both a custom er EDI imp lementer and a person w ho is experienced w ith
the Oracle e-Comm erce Gateway and the base Oracle application:
PhaseTime(Days)
Customer
EDIImplementer
Experienced Oraclee-Commerce
GatewayImplementer
Training 2 X X
Project Definition 10 X X
Set-ups 2 X X
Testing 10 X X
Modification TBD X X
Moving to Production Status 5 X
Production Status/ OngoingSupport
15 X X
7/31/2019 115eccim
45/425
Oracle e-Commerce Gateway Implementation Checklist 3-1
3Oracle e-Commerce Gateway
Implementation Checklist
This chap ter contains the following in formation about Oracle e-Commerce Gateway
implementation:
Implementation Steps on page 3-2
Implementation Checklist for Software Upgrade on page 3-3
Implemen tation Checklist for Fresh Install on page 3-7
Implementation Checklist for Maintenan ce Patch on page 3-8
Implementation Steps
7/31/2019 115eccim
46/425
3-2 Oracle e-Commerce Gateway Implementation Manual
Implementation Steps
The following is a list of the implementation steps to imp lement a tr ansaction inRelease 11i. Since the total solution requires other Oracle App lication mod ules as
well as a Translator, references to these p rodu cts are includ ed.
There are three possible starting points w hen implemen ting a transaction, they are
as follows:
s Upgrading from Release 10.7/ Release 11 to Release 11i
s Fresh in stall of Release 11i
s App lying a maintenance patch for Release 11i
The purp ose of the imp lementation checklist is to guid e you throug h the
imp lementation p rocess. The details for each step are described in the
imp lementation section referenced or the correspond ing Oracle reference manu al.
Implementation Checklist for Software Upgrade
7/31/2019 115eccim
47/425
Oracle e-Commerce Gateway Implementation Checklist 3-3
Implementation Checklist for Software Upgrade
Step
Required/
Optional Description
Reference
(IG: Implementation Guide)
1 Required Run the fo llowing server side scr ip ts for eachtransaction im plemented in Release 10.7/ Release 11.These scripts w ill report the transaction layou tdefinitions and code conversion assignments priorto the upgr ade:
Release 10.7:
ECEUGR.sql - for layout definitions
ECEUGR2.sql - for code conversion assignments
Release 11:
ECELAYDR.sql - for layou t d efinitions
ECEXREFR.sql - for code conversion assignments
Upgrad e Docum entation
IG: Report Scripts
IG: Review Release 11i Upgrade
2 Required Install Release 11i Oracle e-Commerce Gateway. Oracle AutoInstall Manual
3 Requ ired Run the follow ing rep orts for each transactionimp lemented in Release 10.7/ Release 11 to view theRelease 11i transaction layout definitions and codeconversion assignments after th e up grade.
Transaction Layout Definition Report
Code Con version Values Report
User s Guide: Reports
4 As N eed ed Com pare the before an d after u pgrad e rep orts ford ifferences in transaction layou t definitions andcode conversion assignments. Make the necessarychanges:
Adjust transaction layout definitions
Reassign code categories
Since this is an upgra de, there will not be anyvalidation rule differences to reconcile.
Users Guide:
Chang ing the Interface DataFile Record Layout
Assigning Categories
IG: Modify TransactionInterface File
IG: Set Up Code Con version
5 Requ ired Set u p system profiles, p ay sp ecial attention to theprofiles for inbound and ou tbound directory path:
Inbound file directory
Outbou nd file directory
Users Guide: Setting ProfileOptions
IG: Set Up Profiles
Implementation Checklist for Software Upgrade
7/31/2019 115eccim
48/425
3-4 Oracle e-Commerce Gateway Implementation Manual
6 Requ ired Ensure that inbou nd and outbound d irectory pathsdefined in the system profile match UTL_FILE_DIR
settings in INIT.ORA file. Restart the database ifyou mad e changes to the INIT.ORA file.
IG: Define UTL_FILE_DIRparameter in INIT.ORA file
7 As Needed Set up general transaction profiles
Enable/ disable transaction (for all transactions)
Add ress precedence (for inbound transactions)
User s Gu ide: Setting ProfileOptions
IG: Set Up Profiles
8 As N eed ed Set u p transaction sp ecific p rofiles for ou tbou ndtransactions, such as the Purchase Order or
Purchase Order Ch ange transactions
Users Guide: Setting ProfileOptions
IG: Set Up Profiles
9 Required, forinboundtransaction
Review seeded Process Rule Actions and updaterule action if defau lt behavior is not desired
IG: Determine Process andColum n Rules and Actions
10 Required, forinboundtransaction
Review seeded Column Rule Actions for requiredfields and up date rule action if default behavior isnot desired
IG:
Determine Process and ColumnRules and Actions
App lication Set Up
11 Required, forinboundtransaction
Review seeded Column Rule Actions for date andnum eric fields and up date ru le action if defaultbehavior is not desired
IG: Determine Process andColum n Rules and Actions
12 Optional, forinboundtransactions
Determine if other colum ns in the transactionrequire Column Rules
IG: Determine Process andColum n Rules and Actions
13 As N eed ed En able ad d ition al d ata field s as n ecessary u sin greference fields, descriptive flexfields or the
Oracle e-Comm erce Gateway ExtensibleArchitecture
IG: Enable Add itionalTransaction Data
14 Op tion al Review in terface file d efin ition s (record layou ts) forthe transaction an d make any necessaryadjustments
Users Guide: Changing theInterface Data File RecordLayout
IG: Modify Tran saction
Interface File
15 Requ ired Ru n Tran saction Layou t Definition Rep ort to get thecurrent definitions.
Users Guide: Repor ts
16 Requ ired Synchronize the d ata m ap s in the Translator withthe tr ansaction interface file definitions
IG: Interface with Translators
Implementation Checklist for Software Upgrade
7/31/2019 115eccim
49/425
Oracle e-Commerce Gateway Implementation Checklist 3-5
In sum mary, the following h as been installed or set up :
s The upgrad e version is installed
s All custom developmen t re-integrated after upgrade is comp leted (when
appropriate)
17 Requ ired Ensu re that Location Cod e is d efin ed for the trad in gpar tner entity (customer site, sup plier site, bank
branch, internal location) defined in OracleApplications
IG: Application Set Up
18 Required Define trading partner:
Assign trading partn er to add ress site in OracleApp lications using Define Trad ing Partn er,Assignment tab.
Define translator code u sing Define Trad ing Partn er,Details tab. This is the link to the Translatordefinition for the trading partner
Enable transaction(s) for trading p artner (s)
IG:
Set Up Trad ing Partn er
Trad ing Partner Details
19 As Needed Set up code conversions
Review/ define Code Conversion Categories
Enable Code Conversion
Define Code Conversion Values
IG:
Set Up Cod e Conversion
Code Conversion Details
20 Requ ired Review Oracle Ap plications set u ps for eachtransaction and up date as necessary
IG: Application Set Up
21 Requ ired Prepare data to test transaction
Add data in Or acle App lications to test outboundtransaction
Create inbound file to test inbound transaction
IG: Test Transactions
22 Requ ired Test th e transaction bein g im plem en ted at several
levels until results match expectations
Internally (Oracle e-Commerce Gateway and OracleApplications)
With Translator
With Trad ing Partn er
IG: Test Transactions
23 Requ ired Release fu lly tested transaction to prod uction
24 As N eeded Archive transaction interface files as needed IG: Archive/ Backup
Implementation Checklist for Software Upgrade
S d T i P fil d
7/31/2019 115eccim
50/425
3-6 Oracle e-Commerce Gateway Implementation Manual
s System and Transaction Profile set ups a re entered
s Process rules and Colum n ru les are set up
s Code Conversion is set up
s Trad ing Partners are set up
s Base Oracle App lication set ups a re complete
s Transaction interface file d efinitions m odifications are completed (when
appropriated)
It is suggested that a simp le outbound and/ or inbound transaction be passedthrough the Oracle e-Comm erce Gateway to validate the installation before any
site-specific configuration is und ertaken.
Implementation Checklist for Fresh Install
I l t ti Ch kli t f F h I t ll
7/31/2019 115eccim
51/425
Oracle e-Commerce Gateway Implementation Checklist 3-7
Implementation Checklist for Fresh Install
To help ensure a su ccessful imp lementation, do the following:s Read the Introdu ction, and become familiar with the pre-requisites
s Implement related Oracle App lications mod ules before imp lementing Oracle
e-Comm erce Gateway
s Become familiar w ith the Oracle e-Comm erce Gateway set ups
If you are imp lementing O racle e-Comm erce Gatew ay for the first time, steps 1, 3,
and 4 described in th e Implemen tation Checklist for Software Upgrad e section arenot required since there is no existing seed d ata to comp are and reconcile. Insert
steps 2.1 and 2.2 below. All other implementation steps are still required in ad dition
to defining an O racle e-Commerce Gateway responsibility to start the
implementation process.
s In summ ary, the following has been set up in add ition to the su mm ary items in
the software up grade:
s System options for the inbound and outbound directory paths are d efined in
the system profile and match th e UTL_FILE_DIR settings in INIT.ORA file
s System an d Transaction profile set ups are entered (as needed )
s Transaction specific options h ave been implemen ted (as needed)
Step
Required/
Optional Description
Reference
(IG: Implementation Guide)1 Omit Run Scripts.
2.1 Required Define Access Responsibilities. IG: Define Responsibilities
2.2 Required Define the u t l_file_dir parameters. Done by DBA. IG: Define UTL_FILE_DIRParameter in INIT.ORA File
3 Omit Run reports for each transaction
4 Omit Compare reports
Implementation Checklist for Maintenance Patch
Implementation Checklist for Maintenance Patch
7/31/2019 115eccim
52/425
3-8 Oracle e-Commerce Gateway Implementation Manual
Implementation Checklist for Maintenance Patch
If you are installing a main tenance patch to a Release 11i environment, add itionalimp lementation steps are necessary to retain any customizations mad e to the
original seed data.
There are four typ es of seed d ata that m ay be impacted by applying a m aintenance
patch, they are as follows:
s Transaction layout definitions
s Code conversion assignments
s Process rules and corresponding actions
s Colum n rules and correspond ing actions
Use the Seed Data Reconciliation process in Oracle e-Commerce Gateway to
compare the seed data values before and after the install. Depend ing on your
response to th e program param eters, the program either p reserves or overwrites
your seed d ata customizations. In add ition, the program reports anything that it
could not au tomatically reconcile. These exceptions must be reviewed andre-imp lemented as necessary.
The following implemen tation steps are necessary to re-imp lement any seed d ata
customizations to the original seed data values and to synchronize the transaction
layout d efinitions with th e Translator. Your ability to quickly install and imp lement
a maintenan ce patch is essential to minim izing any business disrup tions.
Implementation Checklist for Maintenance Patch
7/31/2019 115eccim
53/425
Oracle e-Commerce Gateway Implementation Checklist 3-9
In sum mary, the following h as been installed or set up :
Step
Required/
Optional Description
Reference
(IG: Implementation Guide)
1 Requ ired Rev iew README text d elivered w ith th emaintenance patch to identify transactions containinglayout definition changes.
Run seed d ata repor ts for each transaction identified
to get the before values.
Transaction Layou t Definition Report
Code Conversion Values Report
Users Guide: Repor ts
2 Required Apply maintenance patch Oracle AutoInstall Manual
3 As N eed ed Ru n Seed Data Reconciliation process for eachtransaction in the list of values to resolve the seeddata differences. The list of values will be adjusted toreflect the transactions processed. A report of seeddata differences that could n ot be autom aticallyreconciled will be provid ed.
Users Guide: Seed Da taReconciliation
4 As N eed ed Man ually resolve seed data d ifferen ces that cou ld notbe au tomatically reconciled:
Adjust transaction layout definitions
Reassign code categories
Redefine p rocess rule actions
Redefine column rules and actions
Repeat this step for each transaction impacted.
Users Guide:
Interface File Definition
Assign Code ConversionCategories
Assign Process Rules
Assign Column Rules
5 As N eed ed For n ew d ata elem en ts ad ded as a resu lt of in stalling amaintenance patch, assign record attributes to thedata element to activate them. Refer to the READMEtext delivered with the maintenance patch for adescription of the change(s).
Users Guide: Interface FileDefinition
6 As N eed ed For n ew d ata elem en ts ad ded as a resu lt of in stalling ama intenance patch, define column rules as necessary.
Users Guide: AssigningColum n Rules
IG: Determine Process andColum n Rules and Actions
7 As N eed ed Synchronize the d ata map s in the Translator with thetransaction interface file definitions.
IG: Interface withTranslators
Implementation Checklist for Maintenance Patch
s Most current p atches app lied (when app ropriate)
7/31/2019 115eccim
54/425
3-10 Oracle e-Commerce Gateway Implementation Manual
p pp ( pp p )
s All custom development re-integrated after patches applied (wh en ap propriate)
s The Seed Data Reconciliation process preserved or overlaid the seed d ata
s Transaction interface file d efinitions m odifications are completed (when
appropriated)
It is suggested that a simp le outbound and/ or inbound transaction be passed
through the Oracle e-Comm erce Gateway to validate the installation before any
site-specific configuration is und ertaken.
7/31/2019 115eccim
55/425
Implementation Details 4-1
4Implementation Details
This chap ter contains the following in formation about Oracle e-Commerce Gateway
implementation:
Report Scripts on page 4-2
Define Responsibilities on page 4-4
Define UTL_FILE_DIR Parameter in INIT.ORA File on