Tutorial #004: Building Metadata For Oracle B2B 11g Using Self-Service XML
Tutorial #004: Building Metadata For Oracle B2B 11g Using Self-Service XML
Tutorial #004: Building Metadata For Oracle B2B 11g Using Self-Service XML
Tutorial #004:
Building Metadata for Oracle
B2B 11g using Self-Service XML
Page 1 of 24
Contents
Introduction......................................................................................................................... 3
Creating basic Self-Service XML ....................................................................................... 4
Get Self-Service XSD ..................................................................................................... 4
Create blank Self-Service XML from Schema ............................................................ 4
Update Document protocol values in XML ................................................................. 7
Update ParameterValue for Document protocol.......................................................... 8
Update trading partner details in XML ...................................................................... 9
Update Host details in TradingPartner Element .......................................................... 9
Add Remote TP details in TradingPartner Element .................................................. 11
Update agreement details in XML ............................................................................. 13
Update Inbound Agreement to receive 850 Document.............................................. 13
Add Outbound Agreement to send 997 Document .................................................... 14
Export ECS/XSD files from Oracle B2B Document Editor ...................................... 16
Complete Self-Service XML........................................................................................ 17
Create Oracle B2B Metadata using Self-Service Utility.................................................. 19
Additional features, Tips and Tricks ................................................................................ 20
Creating MLLP channel ............................................................................................. 20
Using Folder based input approach............................................................................ 20
Typical Self-Service Errors ............................................................................................... 21
FAQ ................................................................................................................................... 22
Reference Information ...................................................................................................... 23
Page 2 of 24
Introduction
Self-Service XML is a simplified metadata of Oracle B2B 11g metadata. This helps user to
create bulk amount of document protocol, trading partner, and agreements in a single
command.
Purpose
The main purpose of this tech-note is to show Self-Service usage through creating XML
based on the Selfservice.xsd, and running the tool using command-line script.
After reading this tech-note, users should be able to independently model Self-Service XML
based on the use cases.
Audience
B2B users who want to create/upload bulk configuration using Oracle B2B as an Integration
Gateway product and would like to understand various use cases and implementation.
Prerequisite
Basic knowledge of XML and Oracle B2B 11g metadata is must.
Assumptions
This document is based on Oracle Fusion Middleware B2B 11g R1 PS2.
Page 3 of 24
Deploying agreements and modifying the existing configuration are similar for all the document
protocols, which will not be explained in this document.
Value
/scratch/<env.USER>/fmwhome/AS11gR1SOA
$ORACLE_HOME/../modules/org.apache.ant_1.7.0
$ORACLE_HOME/../jdk160_11
Now, a file with name selfservice.xsd will get created in the ORACLE_HOME/bin location.
Page 4 of 24
Page 5 of 24
Click Finish.
An XML is created with all possible elements and empty string as value in attributes.
Empty string in this blank XML has to be get filled with right value based on the Appendix in
Oracle B2B documentation. In this XML, DocumentPrototocol, TradingPartner, and Agreement
elements are created once by IDE. User needs to create these elements based on their business
requirement.
Page 6 of 24
Page 7 of 24
Page 8 of 24
Add Identification Elements, to capture three identifier details- EDI Interchange ID, EDI Group
ID, and EDI Interchange ID Qualifier. List of identifications supported in Self-Service XML is
captured in the Appendix of Oracle B2B documentation.
<Identification name="InterchangeID" value="Acme" />
<Identification name="GroupID" value="Acme" />
<Identification name="InterchangeIDQualifier" value="ZZ" />
Note:
Page 9 of 24
Page 10 of 24
Add Identification Elements, to capture three identifier details- EDI Interchange ID, EDI Group
ID, and EDI Interchange ID Qualifier.
<Identification name="InterchangeID" value=" GlobalChips" />
<Identification name="GroupID" value=" GlobalChips" />
<Identification name="InterchangeIDQualifier" value="ZZ" />
Note:
Page 11 of 24
Update TransportProtocolRef element, with the name of transport, and update with possible
ParameterValues
<TransportProtocolRef name="File">
<ParameterValue name="folder"
value="/tmp/GlobalChips_File_Outbound/" />
</TransportProtocolRef>
In this use case, one ParameterValue has created to capture folder value. Processed 997
documents will be placed in this folder by Host.
Complete DeliveryChannel element
<DeliveryChannel ackMode="None" compressed="false"
internal="false" listening="false"
name="GlobalChips_File_Endpoint" responseMode="None">
<ExchangeProtocolRef name="Generic-File" />
<TransportProtocolRef name="File">
<ParameterValue name="folder"
value="/tmp/GlobalChips_File_Outbound" />
</TransportProtocolRef>
</DeliveryChannel>
Page 12 of 24
Note: Listening channels receives the messages from trading partner. Listening channels
works agnostic to agreement and trading partner and are not required to refer from agreement.
Update RespondingParticipant.
<RespondingParticipant name="Acme">
<Identifications>
<IdentificationRef name="GroupID" value="Acme" />
<IdentificationRef name="InterchangeID" value="Acme" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</RespondingParticipant>
Page 13 of 24
<Agreement agreementId="GlobalChips_Acme_X12_4010_850_File"
name="GlobalChips_Acme_X12_4010_850_File">
<SupportedDocumentType docDefName="850def"
docProtocolName="EDI_X12" docProtocolVersion="4010"
docTypeName="850">
<InitiatingParticipant name="GlobalChips">
<Identifications>
<IdentificationRef name="GroupID" value="GlobalChips" />
<IdentificationRef name="InterchangeID" value="GlobalChips" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</InitiatingParticipant>
<RespondingParticipant name="Acme">
<Identifications>
<IdentificationRef name="GroupID" value="Acme" />
<IdentificationRef name="InterchangeID" value="Acme" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</RespondingParticipant>
<AgrDocTypeParameterValues>
<ParameterValue name="validate" value="true" />
<ParameterValue name="translate" value="true" />
<ParameterValue name="fa" value="true" />
</AgrDocTypeParameterValues>
</SupportedDocumentType>
</Agreement>
Note: If no internal delivery channel found in Host participant, then any messages received
using this agreement will send to Fabric/JMS/AQ based on the System Configuration set in
Oracle B2B UI.
Page 14 of 24
Note: Listening channels receives the messages from trading partner. Listening channels
works agnostic to agreement and trading partner and are not required to refer from agreement.
Update RespondingParticipant.
<RespondingParticipant name="GlobalChips">
<Identifications>
<IdentificationRef name="GroupID" value="GlobalChips" />
<IdentificationRef name="InterchangeID" value="GlobalChips" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
<DeliveryChannels>
<DeliveryChannelRef name="GlobalChips_File_Endpoint" />
</DeliveryChannels>
</RespondingParticipant>
Page 15 of 24
<Agreement agreementId="Acme_GlobalChips_X12_4010_997_File"
name=" Acme_GlobalChips_X12_4010_997_File">
<SupportedDocumentType docDefName="997def"
docProtocolName="EDI_X12" docProtocolVersion="4010"
docTypeName="997">
<InitiatingParticipant name="Acme">
<Identifications>
<IdentificationRef name="GroupID" value="Acme" />
<IdentificationRef name="InterchangeID" value="Acme" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</InitiatingParticipant>
<RespondingParticipant name="GlobalChips">
<Identifications>
<IdentificationRef name="GroupID" value="GlobalChips" />
<IdentificationRef name="InterchangeID" value="GlobalChips" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
<DeliveryChannels>
<DeliveryChannelRef name="GlobalChips_File_Endpoint" />
</DeliveryChannels>
</RespondingParticipant>
<AgrDocTypeParameterValues>
<ParameterValue name="validate" value="true" />
<ParameterValue name="translate" value="true" />
<ParameterValue name="fa" value="false" />
</AgrDocTypeParameterValues>
</SupportedDocumentType>
</Agreement>
Note: Relative path used to locate schemas folder in this use case. This schemas folder has
to be created in which folder Self-Service XML exist.
Page 16 of 24
<Agreements>
<Agreement agreementId="GlobalChips_Acme_X12_4010_850_File"
name="GlobalChips_Acme_X12_4010_850_File">
<SupportedDocumentType docDefName="850def"
docProtocolName="EDI_X12" docProtocolVersion="4010"
docTypeName="850">
<InitiatingParticipant name="GlobalChips">
<Identifications>
<IdentificationRef name="GroupID" value="GlobalChips" />
<IdentificationRef name="InterchangeID" value="GlobalChips" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</InitiatingParticipant>
<RespondingParticipant name="Acme">
<Identifications>
<IdentificationRef name="GroupID" value="Acme" />
<IdentificationRef name="InterchangeID" value="Acme" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</RespondingParticipant>
<AgrDocTypeParameterValues>
<ParameterValue name="validate" value="true" />
<ParameterValue name="translate" value="true" />
<ParameterValue name="fa" value="true" />
</AgrDocTypeParameterValues>
</SupportedDocumentType>
</Agreement>
<Agreement agreementId="Acme_GlobalChips_X12_4010_997_File"
name="Acme_GlobalChips_X12_4010_997_File">
<SupportedDocumentType docDefName="997def"
docProtocolName="EDI_X12" docProtocolVersion="4010"
docTypeName="997">
<InitiatingParticipant name="Acme">
<Identifications>
<IdentificationRef name="GroupID" value="Acme" />
<IdentificationRef name="InterchangeID" value="Acme" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
</InitiatingParticipant>
<RespondingParticipant name="GlobalChips">
<Identifications>
<IdentificationRef name="GroupID" value="GlobalChips" />
<IdentificationRef name="InterchangeID" value="GlobalChips" />
<IdentificationRef name="InterchangeIDQualifier" value="ZZ" />
</Identifications>
<DeliveryChannels>
<DeliveryChannelRef
name="GlobalChips_File_Endpoint" />
</DeliveryChannels>
</RespondingParticipant>
<AgrDocTypeParameterValues>
<ParameterValue name="validate" value="true" />
<ParameterValue name="translate" value="true" />
<ParameterValue name="fa" value="false" />
</AgrDocTypeParameterValues>
</SupportedDocumentType>
</Agreement>
</Agreements>
</SelfService>
Page 18 of 24
Value
/scratch/<env.USER>/fmwhome/AS11gR1SOA
$ORACLE_HOME/../modules/org.apache.ant_1.7.0
$ORACLE_HOME/../jdk160_11
A file with name soa.zip will get created in the ORACLE_HOME/bin location.
Oralce metadata is in importable format for Oracle B2B and can be imported either using
Oracle B2B UI or Command-line approach.
Page 19 of 24
Note: All these files have to have SelfService element as root element.
Page 20 of 24
Page 21 of 24
FAQ
1. What are the formats can be used to give value for name attribute in Identification
element?
Three, For instance, consider EDI Interchange ID, following are the formats used to
create identification.
1. <Identification name="InterchangeID" value="Acme" />
2. <Identification name="itype-InterchangeID" value="Acme" />
3. <Identification name="EDI Interchange ID" value="Acme" />
Page 22 of 24
Reference Information
Links
Oracle B2B
http://www.oracle.com/technology/products/integration/b2b/index.html
Oracle B2B Forum
Forum: http://forums.oracle.com/forums/forum.jspa?forumID=242
Fusion Middleware
http://www.oracle.com/technology/products/middleware/index.html
Service-Oriented Architecture
http://www.oracle.com/technologies/soa/index.html
Oracle B2B 11g Self-Service Appendix
http://download.oracle.com/docs/cd/E14571_01/integration.1111/e10229/app_sel
fservice.htm
Page 23 of 24
Chief Editor:
Krishnamoorthy Dharmalingam
Contributors:
Sundararaman Shenbagam
Ramesh Anantharamaiah
Sankar Mani
Jeffrey Hutchins
Ted Hong
Lasted Updated: May 24, 2011
Oracle Corporation
World Headquarters
500 Oracle Parkway
Redwood Shores, CA 94065
U.S.A.
Worldwide Inquiries:
Phone: +1.650.506.7000
Fax: +1.650.506.7200
www.oracle.com
Oracle Corporation provides the software
that powers the Internet.
Oracle is a registered trademark of Oracle Corporation. Various
product and service names referenced herein may be trademarks
of Oracle Corporation. All other product and service names
mentioned may be trademarks of their respective owners.
Copyright 2008 Oracle Corporation
All rights reserved.
Page 24 of 24