Oracle 10g Release 2 (10.1.2) Application Server Integration B2B User’s Guide
PDF
Dokumen
Iklan
Iklan
Oracle® Application Server Integration B2B User’s Guide 10g Release 2 (10.1.2) B19370-03 March 2006 Oracle Application Server Integration B2B User’s Guide, 10g Release 2 (10.1.2) B19370-03 Copyright © 2004, 2006, Oracle. All rights reserved. Primary Author: Deanna Bradshaw and Mark Kennedy Contributors: Oracle Application Server Integration B2B development, product management, and quality assurance teams The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software—Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065 The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party. Contents Preface .............................................................................................................................................................. xvii Audience.................................................................................................................................................... xvii Documentation Accessibility .................................................................................................................. xvii Related Documentation .......................................................................................................................... xviii Conventions ............................................................................................................................................. xviii What’s New in Oracle Application Server Integration B2B? ............................................ xix Part I 1 Introduction and Concepts Introduction to Oracle Application Server Integration B2B What Does OracleAS Integration B2B Provide? ................................................................................ Supported Protocols................................................................................................................................. Design-Time Workflow........................................................................................................................... Business Protocols.............................................................................................................................. Trading Partner Management—Creating Trading Partner Profiles ........................................... Trading Partner Management—Creating Trading Partner Agreements................................... Configuration and Deployment....................................................................................................... OracleAS Integration B2B Administration, Monitoring, and Security ......................................... Summary .................................................................................................................................................... 2 1-1 1-3 1-4 1-5 1-5 1-7 1-8 1-8 1-9 Getting Started with the User Interface Accessing the User Interface .................................................................................................................. 2-1 User Interface Page Components ......................................................................................................... 2-3 Main List Pages................................................................................................................................... 2-4 Details Pages ....................................................................................................................................... 2-5 Creating Incomplete Partner Data ................................................................................................... 2-7 Creating, Adding, Deleting, and Removing Data ......................................................................... 2-8 Naming Conventions......................................................................................................................... 2-8 Using the Browser Back and Forward Buttons.............................................................................. 2-8 Using the Return to List Link ........................................................................................................... 2-8 Searching for Data on the Main List Page ...................................................................................... 2-8 Exporting Partner Data to an XML File .......................................................................................... 2-9 Viewing the State of Partner Data on the Details Pages............................................................ 2-11 Draft State for Partner Data .................................................................................................... 2-12 iii Approved State for Partner Data ........................................................................................... Deployed State for Partner Data............................................................................................ Partners Main Tab ................................................................................................................................. Trading Partners List Page............................................................................................................. Trading Partner Agreements List Page........................................................................................ Protocols List Page .......................................................................................................................... Callouts List Page............................................................................................................................ Deployment Main Tab.......................................................................................................................... Reports Main Tab .................................................................................................................................. Administration Main Tab .................................................................................................................... Design List Page .............................................................................................................................. Management List Page ................................................................................................................... Summary ................................................................................................................................................. 3 2-12 2-12 2-13 2-13 2-16 2-16 2-17 2-18 2-18 2-19 2-20 2-21 2-22 Supported Protocols Overview of Supported Protocols......................................................................................................... 3-1 Document Protocols................................................................................................................................. 3-2 RosettaNet ........................................................................................................................................... 3-4 RosettaNet Dictionaries ............................................................................................................. 3-5 RosettaNet Validation ................................................................................................................ 3-5 EDI X12 ............................................................................................................................................... 3-6 EDI EDIFACT ..................................................................................................................................... 3-6 Custom Documents ........................................................................................................................... 3-7 HL7 ....................................................................................................................................................... 3-8 Exchange Protocols................................................................................................................................... 3-8 RNIF ..................................................................................................................................................... 3-9 AS2 .................................................................................................................................................... 3-10 Generic .............................................................................................................................................. 3-10 MLLP................................................................................................................................................. 3-10 ebMS.................................................................................................................................................. 3-10 Process Protocols ................................................................................................................................... 3-11 PIPs.................................................................................................................................................... 3-11 Business Protocols................................................................................................................................. 3-12 Mix and Match Protocols ............................................................................................................... 3-13 Summary ................................................................................................................................................. 3-13 4 Communicating with Host Trading Partner Applications Internal Delivery Channels in OracleAS Integration B2B............................................................... Integrations with OracleAS Integration InterConnect ..................................................................... Integrations with Oracle E-Business Suite.......................................................................................... Integrations with Oracle BPEL Process Manager .............................................................................. Messages.............................................................................................................................................. Headers......................................................................................................................................... The Payload ................................................................................................................................. Internal Delivery Channels........................................................................................................ Configuring OracleAS Integration B2B........................................................................................... The B2B WSIL Browser .................................................................................................................... iv 4-1 4-2 4-4 4-5 4-6 4-6 4-6 4-7 4-7 4-7 Configuring Oracle BPEL Process Manager .................................................................................. 4-8 Oracle BPEL Process Manager Adapters................................................................................. 4-9 Message Correlation ....................................................................................................................... 4-10 Moving a BPEL Project (with B2B Integration) from Test to Production Environments ..... 4-11 Integrations with Host Applications ................................................................................................. 4-11 Overview of Callouts............................................................................................................................ 4-12 Summary ................................................................................................................................................. 4-12 Part II 5 Tutorials Purchase Order Tutorials About the OracleAS Integration B2B Tutorials .................................................................................. 5-1 Business Scenario ............................................................................................................................... 5-1 Business Scenario Workflow in the Tutorials ................................................................................ 5-2 Before You Begin the Tutorials .............................................................................................................. 5-3 Installing OracleAS Integration B2B................................................................................................ 5-3 Setting Up the CLASSPATH Environment .................................................................................... 5-3 Logging In to OracleAS Integration B2B ........................................................................................ 5-3 Changing the Host Trading Partner Name .................................................................................... 5-4 Location of Run-Time and Configuration Files Used in the Tutorials....................................... 5-4 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction ................................................. 5-5 Acme Server, Task 1: Creating the Collaboration ......................................................................... 5-6 Creating the 3A4 Collaboration ................................................................................................ 5-6 Acme Server, Task 2: Setting Up the Trading Partners ................................................................ 5-8 Setting Up the Remote Trading Partner (GlobalChips) ........................................................ 5-9 Setting Up the Host Trading Partner (Acme) ...................................................................... 5-10 Acme Server, Task 3: Creating the Trading Partner Agreement.............................................. 5-12 Acme Server, Task 4: Creating and Deploying the Configuration .......................................... 5-12 Task 5: Verifying the Purchase Order Transaction .................................................................... 5-13 GlobalChips Server, Task 1: Creating the Collaboration........................................................... 5-13 GlobalChips Server, Task 2: Setting Up the Trading Partners ................................................. 5-13 Setting Up the Remote Trading Partner (Acme) ................................................................. 5-13 Setting Up the Host Trading Partner (GlobalChips) .......................................................... 5-15 GlobalChips Server, Task 3: Creating the Trading Partner Agreement.................................. 5-16 GlobalChips Server, Task 4: Creating and Deploying the Configuration .............................. 5-17 Both Servers, Task 5: Verifying the Purchase Order Transaction ............................................ 5-17 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction................................ 5-18 Acme Server, Task 1: Creating the Business Actions................................................................. 5-19 Creating the Process_ORDERS Business Action—Acme Sends a Purchase Order ....... 5-19 Creating the Process_CONTRL Business Action—Functional Acknowledgments....... 5-21 Creating the Process_ORDRSP Business Action—GlobalChips Sends a Purchase Order Confirmation 5-22 Acme Server, Task 2: Setting Up the Trading Partners ............................................................. 5-23 Setting Up the Remote Trading Partner (GlobalChips) ..................................................... 5-24 Setting Up the Host Trading Partner (Acme) ...................................................................... 5-27 Acme Server, Task 3: Creating the Trading Partner Agreement.............................................. 5-28 Acme Server, Task 4: Creating and Deploying the Configuration .......................................... 5-30 v Task 5: Verifying the Purchase Order Transaction .................................................................... GlobalChips Server, Task 1: Creating the Business Actions ..................................................... GlobalChips Server, Task 2: Setting Up the Trading Partners ................................................. Changing the Host Trading Partner Name to GlobalChips .............................................. Setting Up the Remote Trading Partner (Acme) ................................................................. Setting Up the Host Trading Partner (GlobalChips) .......................................................... GlobalChips Server, Task 3: Creating the Trading Partner Agreement.................................. GlobalChips Server, Task 4: Creating and Deploying the Configuration .............................. Both Servers, Task 5: Verifying the Purchase Order Transaction ............................................ Using the EMail Transport Protocol............................................................................................. Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction ............................................ Acme Server, Task 1: Creating the Business Actions................................................................. Creating the Process_850 Business Action—Acme Sends a Purchase Order ................. Creating the Process_997 Business Action—Acknowledgments...................................... Creating the Process_855 Business Action—GlobalChips Sends a Purchase Order Confirmation ............................................................................................................................. Acme Server, Task 2: Setting Up the Trading Partners ............................................................. Setting Up the Remote Trading Partner (GlobalChips) ..................................................... Setting Up the Host Trading Partner (Acme) ...................................................................... Acme Server, Task 3: Creating the Trading Partner Agreement.............................................. Acme Server, Task 4: Creating and Deploying the Configuration .......................................... Task 5: Verifying the Purchase Order Transaction .................................................................... GlobalChips Server, Task 1: Creating the Business Actions .................................................... GlobalChips Server, Task 2: Setting Up the Trading Partners ................................................. Setting Up the Remote Trading Partner (Acme) ................................................................. Setting Up the Host Trading Partner (GlobalChips) .......................................................... GlobalChips Server, Task 3: Creating the Trading Partner Agreement.................................. GlobalChips Server, Task 4: Creating and Deploying the Configuration .............................. Both Servers, Task 5: Verifying the Purchase Order Transaction ............................................ Using the EMail Transport Protocol .................................................................................................. Doing More Than One Tutorial.......................................................................................................... Starting and Stopping the B2B Server with OPMN ................................................................... Importing Configuration Data ...................................................................................................... Summary ................................................................................................................................................. 6 5-30 5-30 5-31 5-31 5-31 5-35 5-36 5-37 5-37 5-38 5-40 5-41 5-41 5-42 5-44 5-45 5-45 5-48 5-50 5-51 5-52 5-52 5-52 5-52 5-56 5-57 5-58 5-58 5-59 5-61 5-61 5-61 5-64 Health Care Tutorial About the Health Care Tutorial ............................................................................................................. 6-1 Before You Begin the Tutorial ................................................................................................................ 6-2 Tutorial: Setting Up an HL7 over MLLP Transaction ........................................................................ 6-2 Acme Server, Task 1: Creating the Business Actions.................................................................... 6-3 Creating the Process_A01 Business Action—Acme Sends an ADT_A01 Message........... 6-3 Creating the Process_ACK Business Action—Acknowledgment ....................................... 6-4 Acme Server, Task 2: Setting Up the Trading Partners ................................................................ 6-5 Setting Up the Remote Trading Partner (GlobalChips) ........................................................ 6-6 Setting Up the Host Trading Partner (Acme) ......................................................................... 6-8 Acme Server, Task 3: Creating the Trading Partner Agreement.............................................. 6-10 Acme Server, Task 4: Creating and Deploying the Configuration .......................................... 6-10 vi Task 5: Verifying the Purchase Order Transaction .................................................................... GlobalChips Server, Task 1: Creating the Business Actions ..................................................... GlobalChips Server, Task 2: Setting Up the Trading Partners ................................................. Setting Up the Remote Trading Partner (Acme) ................................................................. Setting Up the Host Trading Partner (GlobalChips) .......................................................... GlobalChips Server, Task 3: Creating the Trading Partner Agreement.................................. GlobalChips Server, Task 4: Creating and Deploying the Configuration .............................. Both Servers, Task 5: Verifying the ADT_A01 Transaction ...................................................... Summary ................................................................................................................................................. 7 6-11 6-11 6-11 6-12 6-14 6-15 6-16 6-16 6-17 Custom XML Document Tutorial About the Custom XML Document Tutorial....................................................................................... 7-1 Before You Begin the Tutorial ................................................................................................................ 7-1 Tutorial: Setting Up a Custom Document over ebMS Transaction................................................. 7-2 Acme Server, Task 1: Creating the Business Action ..................................................................... 7-2 Creating the Process_ebMSRequest Business Action—Acme Sends an ebMS Document 7-2 Acme Server, Task 2: Setting Up the Trading Partners ................................................................ 7-4 Setting Up the Remote Trading Partner (GlobalChips) ........................................................ 7-4 Setting Up the Host Trading Partner (Acme) ......................................................................... 7-6 Acme Server, Task 3: Creating the Trading Partner Agreement................................................. 7-7 Acme Server, Task 4: Creating and Deploying the Configuration ............................................. 7-8 Task 5: Verifying the Purchase Order Transaction ....................................................................... 7-8 GlobalChips Server, Task 1: Creating the Business Action.......................................................... 7-8 Creating the Process_ebMSRequest Business Action—GlobalChips Sends an ebMS Document ..................................................................................................................................... 7-8 GlobalChips Server, Task 2: Setting Up the Trading Partners .................................................... 7-9 Setting Up the Remote Trading Partner (Acme) ................................................................. 7-10 Setting Up the Host Trading Partner (GlobalChips) .......................................................... 7-11 GlobalChips Server, Task 3: Creating the Trading Partner Agreement.................................. 7-13 GlobalChips Server, Task 4: Creating and Deploying the Configuration .............................. 7-13 Both Servers, Task 5: Verifying the Transaction......................................................................... 7-14 Summary ................................................................................................................................................. 7-14 Part III 8 Using the User Interface for Design-Time and Deployment Tasks Managing Business Protocols Business Protocol Management Overview.......................................................................................... 8-1 Collaborations and Business Actions Overview ........................................................................... 8-2 OracleAS Integration B2B - Document Editor Overview............................................................. 8-4 Viewing Business Protocols ................................................................................................................... 8-4 Managing Document Protocols ............................................................................................................. 8-5 Creating a Document Protocol Revision......................................................................................... 8-8 Viewing a Document Protocol Revision ......................................................................................... 8-9 Updating a Document Protocol Revision ....................................................................................... 8-9 Deleting a Document Protocol Revision...................................................................................... 8-10 Creating a Document Type............................................................................................................ 8-10 vii Viewing a Document Type ............................................................................................................ Updating a Document Type .......................................................................................................... Deleting a Document Type ............................................................................................................ Viewing a Document Definition of a Document Type .............................................................. Updating a Document Definition of a Document Type ............................................................ Configuring the XPath Expression for a Custom XML Document.......................................... Example: Creating a UCCNet Custom Document.............................................................. Viewing Exchange Protocols ............................................................................................................... Managing Process Protocols................................................................................................................ Creating a Business Action ............................................................................................................ Page 1: General Page ............................................................................................................... Page 2: Document Protocol Revision .................................................................................... Page 3: Document Type .......................................................................................................... Page 4: Review.......................................................................................................................... Viewing a Business Action ............................................................................................................ Updating a Business Action .......................................................................................................... Deleting a Business Action ............................................................................................................ Creating a Collaboration ................................................................................................................ Page 1: General Page ............................................................................................................... Page 2: Business Transaction Page ........................................................................................ Page 3: Requesting Business Action...................................................................................... Page 4: Responding Business Action (Optional) ................................................................. Page 5: Review.......................................................................................................................... Viewing a Collaboration ................................................................................................................ Updating a Collaboration .............................................................................................................. Deleting a Collaboration ................................................................................................................ Common User Errors ............................................................................................................................ Summary ................................................................................................................................................. 9 8-12 8-12 8-13 8-13 8-14 8-15 8-17 8-18 8-19 8-20 8-22 8-23 8-24 8-25 8-26 8-26 8-27 8-27 8-29 8-31 8-31 8-33 8-35 8-35 8-36 8-36 8-37 8-37 Creating Trading Partners Trading Partner Creation Overview...................................................................................................... 9-1 What Is a Trading Partner? ............................................................................................................... 9-1 How Do You Create a Trading Partner?......................................................................................... 9-2 Create Trading Partner Wizard Overview ..................................................................................... 9-3 Create Trading Partner Wizard and Protocol Standards ............................................................. 9-6 Prerequisites to Using the Create Trading Partner Wizard ........................................................ 9-7 Accessing the Create Trading Partner Wizard .............................................................................. 9-7 Creating and Assigning All Capabilities During a Single Wizard Session ................................. 9-9 Page 1: General Page.......................................................................................................................... 9-9 Page 2: Identification Page................................................................................................................ 9-9 Page 3: Operational Capability Page............................................................................................ 9-11 Page 4: Delivery Channel Page ..................................................................................................... 9-15 Page 5: Document Exchange Page ................................................................................................ 9-17 Page 6: Transport Page ................................................................................................................... 9-21 Page 7: Review Page ....................................................................................................................... 9-23 Creating and Defining All Capabilities During Separate Wizard Sessions.............................. 9-23 Creating a Remote Trading Partner ............................................................................................. 9-24 viii Assigning the Business Protocol to the Remote Trading Partner ............................................ 9-25 Creating Business Protocol Operational Capabilities for the Remote Trading Partner ....... 9-26 Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners ............................................................................................................................................. 9-27 Common User Errors ............................................................................................................................ 9-28 Summary ................................................................................................................................................. 9-28 10 Managing Trading Partners Trading Partner Management Overview .......................................................................................... Trading Partner Details Page ........................................................................................................ Capabilities Page ............................................................................................................................. Business Protocol Details Page...................................................................................................... Managing Trading Partners................................................................................................................. Viewing a Host or Remote Trading Partner................................................................................ Updating a Host or Remote Trading Partner.............................................................................. Deleting a Remote Trading Partner.............................................................................................. Managing Trading Partner Identification......................................................................................... Creating Trading Partner Identification ...................................................................................... Viewing a Trading Partner Identification.................................................................................... Updating a Trading Partner Identification................................................................................ Deleting a Trading Partner Identification ................................................................................. Managing Trading Partner Agreements.......................................................................................... Managing Remote Trading Partner Certificates............................................................................ Creating a Remote Trading Partner Certificate ........................................................................ Viewing a Remote Trading Partner Certificate......................................................................... Updating a Remote Trading Partner Certificate....................................................................... Deleting a Remote Trading Partner Certificate ........................................................................ Managing the Host Trading Partner Wallet Password ................................................................. Creating a Host Trading Partner Wallet Password.................................................................. Updating a Host Trading Partner Wallet Password ................................................................ Managing Trading Partner Contact Information for Persons and Organizations .................. Creating Contact Information for a Trading Partner Person or Organization..................... Viewing Contact Information for a Trading Partner Person or Organization ..................... Updating Contact Information for a Trading Partner Person or Organization ................... Deleting Contact Information for a Trading Partner Person or Organization..................... Managing Trading Partner Persons ................................................................................................. Creating a Trading Partner Person ............................................................................................. Viewing a Trading Partner Person and Updating the Person Password ............................. Updating a Trading Partner Person ........................................................................................... Deleting a Trading Partner Person ............................................................................................. Assigning a User Role to a Host Trading Partner Person ....................................................... Removing a User Role from a Host Trading Partner Person.................................................. Viewing User Roles and Use Case Group Details.................................................................... Managing Trading Partner Business Protocols.............................................................................. Assigning a Business Protocol..................................................................................................... Viewing a Business Protocol........................................................................................................ Viewing an Exchange Protocol ................................................................................................... 10-1 10-2 10-3 10-4 10-5 10-6 10-7 10-7 10-7 10-8 10-9 10-10 10-10 10-10 10-11 10-13 10-13 10-14 10-14 10-14 10-15 10-16 10-17 10-18 10-18 10-19 10-20 10-20 10-22 10-22 10-23 10-23 10-24 10-24 10-25 10-25 10-27 10-28 10-28 ix Viewing a Document Protocol .................................................................................................... Viewing a Process Protocol.......................................................................................................... Removing a Business Protocol from a Remote Trading Partner............................................ Managing Internal Delivery Channels ........................................................................................... Creating an Internal Delivery Channel...................................................................................... Page 1: General Page ............................................................................................................. Page 2: Transport Page.......................................................................................................... Page 3: Review Page .............................................................................................................. Example: Creating an Internal Delivery Channel Using the JMS Transport Protocol........ Troubleshooting the JMS Internal Delivery Channel ....................................................... Example: Creating File/FTP Internal Delivery Channels ....................................................... File Name Restrictions .......................................................................................................... Deleting an Internal Delivery Channel ...................................................................................... Managing Business Protocol Collaborations................................................................................. Viewing a Business Protocol Collaboration .............................................................................. Updating a Business Protocol Collaboration ............................................................................ Deleting a Business Protocol Collaboration .............................................................................. Managing Business Protocol Business Actions............................................................................. Viewing a Business Protocol Business Action .......................................................................... Updating a Business Protocol Business Action ........................................................................ Deleting a Business Protocol Business Action .......................................................................... Managing Business Protocol Delivery Channels.......................................................................... Viewing a Business Protocol Delivery Channel ....................................................................... Updating a Business Protocol Delivery Channel ..................................................................... Deleting a Business Protocol Delivery Channel ....................................................................... Managing Business Protocol Document Exchanges..................................................................... Viewing a Business Protocol Document Exchange.................................................................. Updating a Business Protocol Document Exchange ................................................................ Deleting a Business Protocol Document Exchange.................................................................. Managing Business Protocol Transports......................................................................................... Viewing a Business Protocol Transport ..................................................................................... Updating a Business Protocol Transport ................................................................................... Deleting a Business Protocol Transport..................................................................................... Managing Business Protocol Transport Servers............................................................................ Viewing a Business Protocol Transport Server......................................................................... Updating a Business Protocol Transport Server....................................................................... Deleting a Business Protocol Transport Server......................................................................... Managing Business Protocol Endpoints ......................................................................................... Viewing a Business Protocol Endpoint ...................................................................................... Updating a Business Protocol Endpoint .................................................................................... Deleting a Business Protocol Endpoint...................................................................................... Viewing a Protocol Endpoint of a Business Protocol Endpoint ............................................. Updating a Protocol Endpoint of a Business Protocol Endpoint ........................................... Deleting a Protocol Endpoint of a Business Protocol Endpoint ............................................. Common User Errors .......................................................................................................................... Summary ............................................................................................................................................... x 10-29 10-29 10-30 10-30 10-33 10-33 10-34 10-37 10-37 10-39 10-39 10-42 10-42 10-43 10-44 10-45 10-46 10-46 10-48 10-48 10-49 10-49 10-51 10-51 10-52 10-52 10-54 10-54 10-55 10-55 10-57 10-57 10-58 10-58 10-60 10-60 10-61 10-61 10-63 10-64 10-64 10-64 10-65 10-65 10-66 10-66 11 Managing Callouts Callouts Overview................................................................................................................................. Managing Callouts................................................................................................................................ Creating a Callout ........................................................................................................................... Implementing a Callout: Code Example .............................................................................. Viewing a Callout............................................................................................................................ Updating a Callout.......................................................................................................................... Deleting a Callout ........................................................................................................................... Managing Callout Properties .............................................................................................................. Creating Callout Properties ........................................................................................................... Viewing Callout Properties ........................................................................................................... Updating Callout Properties ....................................................................................................... Deleting Callout Properties ......................................................................................................... Managing Callout Usages.................................................................................................................. Creating a Callout Usage ............................................................................................................. Viewing a Callout Usage.............................................................................................................. Updating a Callout Usage............................................................................................................ Deleting a Callout Usage.............................................................................................................. Creating a Callout Metadata Parameter Value for a Callout Usage...................................... Viewing a Callout Metadata Parameter Value for a Callout Usage ...................................... Updating a Callout Metadata Parameter Value for a Callout Usage .................................... Deleting a Callout Metadata Parameter Value for a Callout Usage ...................................... Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction ................ Acme Server, Task 1: Performing the RosettaNet over RNIF Tutorial ................................. Acme Server, Task 2: Setting Up Callout Usages ..................................................................... Create an OAG Custom Document Type........................................................................... Modify XML Gateway Settings............................................................................................ Modify the XSLTCallout Settings ........................................................................................ Create a Trading Partner Agreement.................................................................................. Create and Deploy a Configuration .................................................................................... GlobalChips Server, Task 1: Performing the RosettaNet over RNIF Tutorial...................... GlobalChips Server, Task 2: Setting Up Callout Usages ......................................................... Create an OAG Custom Document Type........................................................................... Modify XML Gateway Settings............................................................................................ Modify the XSLTCallout Settings ........................................................................................ Create a Trading Partner Agreement.................................................................................. Create and Deploy a Configuration .................................................................................... Common User Errors .......................................................................................................................... Summary ............................................................................................................................................... 12 11-1 11-3 11-4 11-5 11-6 11-7 11-7 11-7 11-8 11-9 11-10 11-10 11-10 11-12 11-13 11-13 11-13 11-14 11-15 11-16 11-16 11-16 11-17 11-17 11-17 11-19 11-20 11-20 11-21 11-21 11-21 11-21 11-21 11-21 11-22 11-22 11-22 11-22 Creating and Managing Trading Partner Agreements Trading Partner Agreement Overview .............................................................................................. What is A Trading Partner Agreement? ...................................................................................... How Do You Create a Trading Partner Agreement?................................................................. Prerequisites to Creating a Trading Partner Agreement........................................................... Managing Trading Partner Agreements............................................................................................ 12-1 12-1 12-2 12-3 12-4 xi Creating a Trading Partner Agreement ....................................................................................... 12-5 Viewing a Trading Partner Agreement........................................................................................ 12-8 Updating a Trading Partner Agreement...................................................................................... 12-8 Deleting a Trading Partner Agreement ....................................................................................... 12-9 Managing Trading Partner Agreement Participants....................................................................... 12-9 Adding Identifications and Operational and Communication Capabilities to Trading Partner Agreement Participants ................................................................................................................ 12-10 Viewing a Trading Partner Agreement Participant ................................................................. 12-11 Updating a Trading Partner Agreement Participant ............................................................... 12-12 Removing a Trading Partner Agreement Participant.............................................................. 12-13 Managing Delivery Channels of Trading Partner Agreement Participants............................. 12-13 Adding a Delivery Channel to a Trading Partner Agreement Participant........................... 12-14 Viewing a Delivery Channel of a Trading Partner Agreement Participant ........................ 12-14 Updating a Delivery Channel of a Trading Partner Agreement Participant ....................... 12-15 Removing a Delivery Channel from a Trading Partner Agreement Participant ................. 12-16 Common User Errors .......................................................................................................................... 12-16 Summary ............................................................................................................................................... 12-16 13 Creating and Deploying a Configuration Configuration Overview ...................................................................................................................... What Is a Configuration? ............................................................................................................... Configuration Creation Overview................................................................................................ Creating a Configuration ..................................................................................................................... Successful Configuration Creation and Validation.................................................................... Unsuccessful Configuration Creation and Validation............................................................... Deploying a Configuration ................................................................................................................. Configuration Deployment Overview ......................................................................................... Deploying a Validated Configuration.......................................................................................... Redeploying a Configuration ........................................................................................................ Viewing a Configuration ..................................................................................................................... Quiescing a Configuration .................................................................................................................. Discarding a Configuration................................................................................................................. Exporting a Configuration................................................................................................................. Common User Errors .......................................................................................................................... Summary ............................................................................................................................................... Part IV 14 13-1 13-2 13-2 13-3 13-5 13-6 13-6 13-6 13-7 13-8 13-8 13-9 13-9 13-10 13-10 13-11 Using Scripts and Utilities Batching and Debatching EDI Transaction Sets EDI Batching .......................................................................................................................................... 14-1 EDI Batching Examples........................................................................................................................ 14-2 15 API for Creating Trading Partners and Agreements The Trading Partner Descriptor XML................................................................................................ 15-1 The Agreement Descriptor XML ........................................................................................................ 15-4 Using the Self-service API................................................................................................................... 15-5 xii Example Files ......................................................................................................................................... 15-6 16 Utilities for Enqueuing and Dequeuing Java Enqueue and Dequeue ................................................................................................................ IPEnqueue ........................................................................................................................................ IPDequeue ........................................................................................................................................ PL/SQL Enqueue and Dequeue.......................................................................................................... msgid_b2b.sql .................................................................................................................................. enq_b2b.sql....................................................................................................................................... deq_b2b.sql....................................................................................................................................... Part V 17 Administration, Monitoring, and Security Tasks Administering OracleAS Integration B2B Administering OracleAS Integration B2B ................................................................................... Managing Contact Types ..................................................................................................................... Viewing a Contact Type ................................................................................................................. Managing Trading Partner Identification Types............................................................................. Creating a Trading Partner Identification Type ......................................................................... Viewing a Trading Partner Identification Type.......................................................................... Exporting and Importing the Design-Time Repository................................................................. Exporting the Design-Time Repository Contents ...................................................................... Importing the Design-Time Repository Contents ...................................................................... Importing an Exported Configuration ......................................................................................... Importing Support for Collaborations, Transaction Sets, and UCCnet Standards ............... The Run-Time Repository ................................................................................................................... Purging the Entire Repository ............................................................................................................ Purging Business Messages and Wire Messages Using the Purge Utility ............................... Common User Errors .......................................................................................................................... Summary ............................................................................................................................................... 18 16-1 16-1 16-2 16-2 16-2 16-3 16-3 17-1 17-3 17-3 17-3 17-4 17-4 17-5 17-7 17-7 17-8 17-8 17-9 17-9 17-10 17-11 17-11 System Management with Oracle Enterprise Manager 10g Oracle Enterprise Manager 10g Monitoring and Administration Overview............................. OracleAS Integration B2B Management Concepts and Components ..................................... OracleAS Metadata Repository.............................................................................................. OracleAS Integration B2B Instance ....................................................................................... The B2B Server of OracleAS Integration B2B....................................................................... The OC4J Instance of OracleAS Integration B2B................................................................. Oracle Enterprise Manager 10g Application Server Control Console Tasks.......................... Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console ................................................................................................. OracleAS Integration B2B Monitoring and Administration Tasks .......................................... OracleAS Integration B2B Log Files ...................................................................................... OracleAS Integration B2B Middle-Tier Instance Performance ......................................... OracleAS Integration B2B Middle-Tier Instance Server Properties.................................. OracleAS Integration B2B Port Management ............................................................................. 18-1 18-2 18-3 18-3 18-3 18-3 18-3 18-4 18-6 18-7 18-7 18-8 18-9 xiii Starting and Stopping OracleAS Integration B2B Components with OPMN ......................... Additional Oracle Application Server and OracleAS Integration B2B Management Tasks Changing Port Numbers .................................................................................................................... Port Changing Error Message ..................................................................................................... Modifying Ports............................................................................................................................. Summary ............................................................................................................................................... 19 Creating Reports Reports Overview.................................................................................................................................. Reports User Role............................................................................................................................ Creating Business Message Status Reports...................................................................................... Creating Wire Message Status Reports ............................................................................................. Creating Collaboration Status Reports ............................................................................................. Creating Error Status Reports ............................................................................................................. Saving Reports ....................................................................................................................................... Saving Report Definitions................................................................................................................... Importing Reports ................................................................................................................................. Summary ................................................................................................................................................. 20 19-1 19-1 19-2 19-4 19-6 19-7 19-8 19-8 19-8 19-9 OracleAS Integration B2B Security The OracleAS Integration B2B Security Model .............................................................................. Classes of Users and Their Privileges .......................................................................................... Resources Protected ........................................................................................................................ Authorization and Access Enforcement ...................................................................................... Use of Oracle Application Server Security Services................................................................... Use of Oracle Identity Management Infrastructure ................................................................... Configuring Oracle Application Server Security Framework for OracleAS Integration B2B OracleAS Integration B2B Security Framework Configuration Issues ................................... Identity Management Configuration Issues Specific to OracleAS Integration B2B .............. Configuring OracleAS Integration B2B Security............................................................................ OracleAS Integration B2B Installation ......................................................................................... Required Information for Installing OracleAS Integration B2B........................................ OracleAS Integration B2B Security Configuration..................................................................... Digital Envelopes and Certificates for Host and Remote Trading Partners ................... Digital Signatures for Host and Remote Trading Partners................................................ Secure HTTP and Client Authentication .............................................................................. Encrypted Wallet Passwords for Host Trading Partners................................................... Host Trading Partner Password Encryption in High Availability Environments ................ Configuration Issues and Options for Oracle Application Server Security ........................... Oracle HTTP Server Transport Servlet and OracleAS Integration B2B ................................ Summary ............................................................................................................................................... A 18-9 18-10 18-11 18-11 18-11 18-13 20-1 20-1 20-2 20-2 20-3 20-3 20-3 20-3 20-3 20-3 20-4 20-4 20-4 20-4 20-5 20-6 20-8 20-9 20-9 20-10 20-11 Troubleshooting and Workarounds Retrieving the B2B Database Password .............................................................................................. A-1 OracleAS Integration B2B Processing Is Very Slow ......................................................................... A-1 User Interface Pages Time Out Too Fast ............................................................................................. A-2 xiv B2B User Login Must Have a Role ....................................................................................................... Run-Time Error When Enqueuing a Message to IP_OUT_ENQUEUE ........................................ Checking the IP_IN_QUEUE and IP_OUT_QUEUE Queues......................................................... Running Reports ..................................................................................................................................... Checking Log Files.................................................................................................................................. Setting Log Levels ............................................................................................................................. Correcting Out-of-Memory Errors ....................................................................................................... Resolving Connection Errors ................................................................................................................ Connection Errors While Posting Messages to the Trading Partner URL................................ Generic Exchange Protocol Workarounds .......................................................................................... Transport Protocol Parameter Settings for the FTP or File Transport Protocol....................... Timestamp Formats ................................................................................................................... FTP Server on Windows Operating Systems ................................................................................ Generic Exchange Protocols and Functional Acknowledgments .............................................. Generic Exchange Protocols and Oracle Application Server Web Cache................................. Configuration Changes and Redeployment After a Request Is Sent But Before a Response Is Received .................................................................................................................................................... Non-English OracleAS Integration B2B Pages in Oracle Enterprise Manager........................... Oracle Application Server Clustering and Integration B2B ........................................................... Configuring OracleAS Integration B2B in Enterprise Environments .......................................... B A-9 A-9 A-9 A-9 Exception Handling Inbound Messages .................................................................................................................................. Request or Response Messages ....................................................................................................... Acknowledgment Messages ............................................................................................................ Exception Messages .......................................................................................................................... Outbound Messages ............................................................................................................................... Inbound Exception Handling Scenarios............................................................................................. Exception Payload Definition ............................................................................................................... C A-2 A-2 A-2 A-2 A-3 A-3 A-4 A-5 A-6 A-6 A-7 A-7 A-8 A-8 A-8 B-1 B-1 B-2 B-2 B-2 B-3 B-4 Identifying a Trading Partner Using ISA/GS Glossary Index xv xvi Preface This guide describes how to use Oracle Application Server Integration B2B. This preface contains the following topics: ■ Audience ■ Documentation Accessibility ■ Related Documentation ■ Conventions Audience Oracle Application Server Integration B2B User’s Guide is intended for customers who want to perform the following tasks for integrations between enterprises. ■ Design ■ Deploy ■ Monitor ■ Manage Documentation Accessibility Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/ Accessibility of Code Examples in Documentation Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace. xvii Accessibility of Links to External Web Sites in Documentation This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites. TTY Access to Oracle Support Services Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398. Related Documentation For more information, see these Oracle resources: ■ Oracle Application Server 10g Documentation Library ■ Oracle Application Server Integration B2B Installation Guide Printed documentation is available for sale in the Oracle Store at http://oraclestore.oracle.com/ To download free release notes, installation documentation, white papers, or other collateral, please visit the Oracle Technology Network (OTN). You must register online before using OTN; registration is free and can be done at http://www.oracle.com/technology/membership/ If you already have a username and password for OTN, then you can go directly to the documentation section of the OTN Web site at http://www.oracle.com/technology/documentation/ Conventions The following text conventions are used in this document: xviii Convention Meaning boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary. italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. What’s New in Oracle Application Server Integration B2B? OracleAS Integration B2B supports the following new and enhanced features in 10g Release 2 (10.1.2): ■ Additional business protocols: – Custom Document over MLLP Exchange – Custom Document over ebMS – HL7 over Generic Exchange – HL7 over MLLP Exchange See Chapter 3, "Supported Protocols" and Chapter 6, "Health Care Tutorial" and Chapter 7, "Custom XML Document Tutorial" for more information. ■ EDI transaction set batching and debatching See Chapter 3, "Supported Protocols" for more information. ■ Integration of OracleAS Integration B2B and Oracle BPEL Process Manager See Chapter 4, "Communicating with Host Trading Partner Applications" for more information. ■ Utilities for creating many trading partners and trading partner agreements at once See Chapter 15, "API for Creating Trading Partners and Agreements" for more information. ■ Java and PL/QL enqueuing and dequeuing to internal delivery channels See Chapter 16, "Utilities for Enqueuing and Dequeuing" for more information. ■ Utility for purging business messages and wire messages See Chapter 17, "Administering OracleAS Integration B2B" for more information. ■ Exception handling for inbound and outbound messages See Appendix B, "Exception Handling" for more information. ■ Ability to identify a trading partner using ISA/GS See Appendix C, "Identifying a Trading Partner Using ISA/GS" for more information. ■ Access to instance run-time data through an API, which is an alternative to using the Reports tab xix See OracleAS Integration B2B Instance Data Access Java API Reference for more information. xx Part I Introduction and Concepts This part introduces Oracle Application Server Integration B2B (OracleAS Integration B2B) and provides conceptual details. This part contains the following chapters: ■ Chapter 1, "Introduction to Oracle Application Server Integration B2B" ■ Chapter 2, "Getting Started with the User Interface" ■ Chapter 3, "Supported Protocols" ■ Chapter 4, "Communicating with Host Trading Partner Applications" 1 Introduction to Oracle Application Server Integration B2B Oracle Application Server Integration B2B (OracleAS Integration B2B) is an e-business integration product for the business-to-business (B2B) exchange of services, information, and products. If you know who you want to trade with (for example, a specific supplier), what you want to do (for example, send a purchase order), and how you want to do it (for example, send the purchase order over the Internet), then you have defined a basic B2B transaction. This chapter contains the following topics: ■ What Does OracleAS Integration B2B Provide? ■ Supported Protocols ■ Design-Time Workflow ■ OracleAS Integration B2B Administration, Monitoring, and Security ■ Summary What Does OracleAS Integration B2B Provide? OracleAS Integration B2B provides the features you need to design, deploy, monitor, and manage a B2B integration. Table 1–1 lists the features and benefits of OracleAS Integration B2B. Introduction to Oracle Application Server Integration B2B 1-1 What Does OracleAS Integration B2B Provide? Table 1–1 Features and Benefits of OracleAS Integration B2B Feature Benefit Standard B2B protocols and custom protocols You can work with trading partners who use a variety Chapter 3, "Supported of protocols; choose from RosettaNet, EDI EDIFACT, Protocols" EDI X12, Applicability Statement 2 (AS2), UCCnet, HL7, MLLP, ebXML Messaging Service, or create a custom protocol. Integration with OracleAS Integration products and custom applications Using the secure B2B connectivity of OracleAS Integration B2B, you can send a purchase order (or other business document) from your Oracle E-Business Suite iProcurement application, for example, to a trading partner. ■ ■ ■ ■ Oracle E-Business Suite OracleAS Integration InterConnect Oracle BPEL Process Manager Trading partner applications See . . . Chapter 4, "Communicating with Host Trading Partner Applications" Chapter 10, "Managing Trading Partners" If your trading partner requires a business document format that differs from your format, use the transformation capabilities of OracleAS Integration InterConnect. Oracle BPEL Process Manager and OracleAS Integration B2B interoperate to address an enterprise’s end-to-end integration needs and exploit service-oriented architecture (SOA). Using internal delivery channels, you can communicate with the back-end applications of the host trading partner Integrated user experience The user interface and wizards guide all aspects of designing your B2B transaction, no matter which protocols you choose. Chapter 2, "Getting Started with the User Interface" Comprehensive trading partner management In OracleAS Integration B2B, you can associate standard or custom protocols and communication details with trading partners, thus enabling multiple protocols and multiple versions for each of the trading partners. Chapter 8, "Managing Business Protocols" Chapter 9, "Creating Trading Partners" Chapter 10, "Managing The host trading partner is automatically assigned a Trading Partners" business protocol and operational capabilities that are compatible with the remote trading partner. When you create a trading partner agreement, the host trading partner is also automatically assigned a collaboration or business action that is compatible with the one assigned to the remote trading partner. Reports With the integrated reports feature, you can create business message, wire message, collaboration, and error status reports. You can also save a report definition for reuse or to view in Microsoft Excel. Security The security features of OracleAS Integration B2B Chapter 20, "OracleAS include, for example, the ability to configure digital Integration B2B Security" envelopes, remote trading partner certificates, digital signatures, secure socket layer (SSL), and host trading partner wallet passwords. OracleAS Integration B2B also leverages Oracle Application Server security features. Chapter 19, "Creating Reports" Figure 1–1 shows another view of OracleAS Integration B2B features. Who you want to trade with is defined in the trading partner management component. What you do is defined in the business protocol (shown within the dotted lines). How you do the B2B transaction is defined in the transport and packaging components. OracleAS Integration B2B interfaces with Oracle Application Server Integration InterConnect (OracleAS Integration InterConnect) and Oracle BPEL Process Manager using the IP queue, with Oracle E-Business Suite using the XML Gateway, and with trading 1-2 Oracle Application Server Integration B2B User’s Guide Supported Protocols partner applications using queues. The figure also shows that the B2B server supports a number of standard protocols, which are listed in Table 1–2. Figure 1–1 OracleAS Integration B2B Architecture Oracle Application Server Integration InterConnect Oracle Application Server Integration B2B Business Protocol What IP queue Trading Partner Management Process Protocol · B2B Who Oracle E-Business Suite Oracle BPEL Process Manager Document Protocols · RosettaNet · EDI x12 · EDI EDIFACT · Custom · HL7 XML Gateway B2B Server IP queue Trading Partner Internet Exchange Protocols How · RosettaNet Implementation Framework · AS2 · Generic · MLLP · ebMS Transport Protocols · HTTP · HTTPS · Email · File · FTP · FTPS · TCP / IP Packaging Protocols · MIME · S / MIME · SOAP · XMLDSig · XMLEncrypt Trading Partner Metadata Repository Supported Protocols Table 1–2 describes the protocols—the agreed-upon formats for transmitting data— and the protocol revisions that OracleAS Integration B2B supports, categorized by protocol type. As shown in the table, OracleAS Integration B2B implements the nonproprietary, XML-based RosettaNet standards to exchange documents over the Internet. OracleAS Integration B2B also implements electronic data interchange (EDI), a standard format for exchanging business data over the Internet (using AS2) or over value-added networks (VANs), by supporting EDI X12 and EDI EDIFACT. For clinical and administrative health care data, OracleAS Integration B2B supports HL7. For proprietary transaction mechanisms, OracleAS Integration B2B provides the Custom Document protocol to create document definitions for XML and non-XML Introduction to Oracle Application Server Integration B2B 1-3 Design-Time Workflow messages. The table also lists the exchange, transport, and packaging protocols that OracleAS Integration B2B supports. Table 1–2 B2B Protocols Supported in OracleAS Integration B2B Protocol Type Protocol and Revision The document protocol defines the document type of the message payload, which is based on which standard (RosettaNet, EDI, and so on) you are using as part of the business logic. The exchange protocol defines the message exchange mechanism—how to exchange the documents defined by the document protocol. It defines the headers, acknowledgments, and packaging that puts the headers and payload together. It also defines the transport protocol and packaging protocol for the exchange. ■ ■ transport protocol—defines the underlying transport and its properties packaging protocol—defines a packaging mechanism. Message security such as signing and encryption are often based on a specific packaging mechanism The process protocol defines how you exchange messages, using the document protocol-based business document, and exchanging it based on the exchange protocol. It is the mechanism by which business actions and collaborations are associated with specific document types. ■ RosettaNet (1.1 and 2.0) ■ EDI X12 (all revisions) ■ EDI EDIFACT (all revisions) ■ Custom Document—customer-defined protocols ■ Health Level 7 (HL7) ■ RosettaNet Implementation Framework (RNIF 01.10, RNIF V02.00) ■ Applicability Statement 2 (AS2) ■ Generic (Generic 1.0) ■ Minimum Lower Layer Protocol (MLLP) ■ ebXML Messaging Service (ebMS) ■ HTTP (HTTP 1.0, HTTP 1.1) ■ HTTPS (HTTPS 1.0, HTTPS 1.1) ■ Email (SMTP 1.0, IMAP 1.0) ■ File (File 1.0) ■ FTP (FTP 1.0) ■ FTPS ■ TCP/IP ■ MIME (MIME 1.0) ■ S/MIME (S/MIME 2.0, S/MIME 3.0) ■ SOAP ■ XML digital signature (XMLDSig) ■ XML encryption (XMLEncrypt) ■ B2B See Chapter 3, "Supported Protocols" for more information. Design-Time Workflow The design-time workflow of OracleAS Integration B2B follows naturally from how businesses exchange services, information, and products: 1. Identify the business protocol. Identifying the business protocol—a combination of a document protocol, exchange protocol, and process protocol (see Table 1–2)—consists of selecting a predefined business protocol, or modifying one so that it is configured to your needs. 1-4 Oracle Application Server Integration B2B User’s Guide Design-Time Workflow Manage trading partners—trading partner profiles and trading partner agreements. 2. As part of trading partner management, you create the remote trading partner and associate it with the business protocol. Then you create a trading partner agreement and associate it with the remote trading partner and business protocol. Configure and deploy. 3. A configuration is the collection of trading partner data that you have created. Creating a configuration enforces the validation rules so that only valid, complete, and consistent data is available in the run-time repository. Then deployment activates a configuration from the design-time repository to the runtime repository. Figure 1–2 shows the design-time workflow. Figure 1–2 Design-Time Workflow Manage Trading Partners 1 3 2 Identify the Business Protocol · Process Protocol · Document Protocol · Exchange Protocol Trading Partner Profile Configure Deploy Capabilities Trading Partner Agreement See Chapter 2, "Getting Started with the User Interface" for how the design-time workflow is reflected in the OracleAS Integration B2B wizards and user interface. Business Protocols OracleAS Integration B2B provides business protocols, which bundle common message exchange options. The business protocols capture combinations needed to integrate typical B2B scenarios. Figure 1–1 on page 1-3 shows a dashed line around the process, document, and exchange protocols that make up the business protocol. See the following for more information: ■ ■ "Business Protocols" on page 3-12 for a list of the business protocols defined in OracleAS Integration B2B Chapter 8, "Managing Business Protocols" Trading Partner Management—Creating Trading Partner Profiles A trading partner is an organization that engages in e-business transactions between enterprises with another organization (trading partner). In OracleAS Integration B2B, trading partner management starts with creating a trading partner profile, which defines the following. ■ Who are the trading partners? ■ How are they uniquely identified? Introduction to Oracle Application Server Integration B2B 1-5 Design-Time Workflow ■ What standards do they support? ■ How do they send documents? ■ How do they exchange documents? ■ How do they communicate? A trading partner may have host (back-end) applications, databases, or customers to involve in the transaction. Using the OracleAS Integration B2B user interface defines you as the host trading partner. The workflow for creating a trading partner is shown in Figure 1–3. The workflow in the figure corresponds to pages in the Create Trading Partner wizard. Figure 1–3 Trading Partner Management Workflow General Identification Operational Capability Delivery Channel Document Exchange Transport Review On the General page, you name the trading partners. On the Identification page, you provide standard identifiers (such as a DUNS number). For the remote trading partner, you set up the first three steps only. The host trading partner is automatically assigned support for a business protocol and operational capabilities that are compatible with those of the remote trading partner. In the operational capability step, you define the collaborations (for RosettaNet) or business actions (for EDI X12, EDIFACT, or Custom Document) for a trading partner’s business protocol. For example, if you select the RosettaNet over RNIF business protocol, the wizard prompts you to select a collaboration (such as PIP 3A4) and its associated role (buyer or seller), to indicate a time in which to process the collaboration, and to select whether OracleAS Integration B2B handles the acknowledgments. If you select an EDI or Custom Document business protocol, the wizard prompts you to select the business action (such as 850 or ORDERS), to indicate the initiator, and to select whether OracleAS Integration B2B handles the acknowledgment. The delivery channel, document exchange, and transport steps shown in Figure 1–3 comprise the communication capabilities of the trading partner’s business protocol. The delivery channel defines the secure exchange of messages between trading partners. Selections you make when specifying the delivery channel determine the document exchange and transport options. Delivery channel details that you provide include: ■ Delivery channel name ■ Acknowledgment mode ■ Global usage code ■ If nonrepudiation of receipt and nonrepudiation of origin are required ■ If encryption, transport security, and compression (for AS2 exchange protocol) are enabled ■ Time to acknowledgment value ■ Retry count value The document exchange defines the characteristics for exchanging messages between trading partners. Document exchange details that you provide include: 1-6 Oracle Application Server Integration B2B User’s Guide Design-Time Workflow ■ Document exchange name ■ Exchange protocol revision and any override parameter values ■ Digital signature and signing credential ■ Digital envelope and encryption credential The document exchange layer receives a business document, encrypts it (if specified), adds a digital signature for nonrepudiation (if specified), and sends it to the transport for transmission to the other trading partner. The document exchange elements essentially describe a trading partner’s message-receiving characteristics. The document protocols supported in OracleAS Integration B2B are listed in Table 1–2 on page 1-4. The transport defines characteristics for message delivery. The transport details that you provide include: ■ Transport name and protocol ■ Transport server name, hostname, address, and login credentials ■ Endpoint URI of the trading partner For outgoing messages sent to a trading partner, OracleAS Integration B2B calls the transport with the message to send and provides the necessary transport protocol-specific bindings. For incoming messages received from a trading partner, the transport receives the messages and calls OracleAS Integration B2B with the received message and transport binding data for processing. The transport binding data specifies the protocol-specific status data and a list of protocol headers with their values. The transport protocols supported in OracleAS Integration B2B are listed in Table 1–2 on page 1-4. OracleAS Integration B2B is designed so that you can do all the trading partner management tasks in a comprehensive series of steps within the user interface. The Partners tab gives you access to all these tasks. See the following for more information: ■ Chapter 2, "Getting Started with the User Interface" ■ Chapter 9, "Creating Trading Partners" ■ Chapter 10, "Managing Trading Partners" Trading Partner Management—Creating Trading Partner Agreements Trading partner agreements define the terms and agreements that enable business documents to be exchanged between trading partners. Based on each trading partner profile, the trading partner agreement defines the following: ■ Who are the participants? ■ What is each participant’s unique identification? ■ Which business protocol should be used? ■ How does each participant send documents? ■ How does each participant exchange documents? ■ How does each participant communicate? ■ What are the agreement terms? Introduction to Oracle Application Server Integration B2B 1-7 OracleAS Integration B2B Administration, Monitoring, and Security Figure 1–4 shows an example of the information that is defined during trading partner management and that becomes part of a trading partner agreement. The figure shows the PIP 3A4 collaboration. The remote trading partner (buyer) sends a purchase order request to the host trading partner (seller), who responds with a purchase order acceptance. Figure 1–4 Information Defined for the PIP 3A4 Collaboration Trading Partner Agreement: Acme_3A4 Remote Trading Partner Host Trading Partner Acme Participant GlobalChips ** RosettaNet over RNIF Business Protocol RosettaNet over RNIF** Buyer-3A4-V02.00 Collaboration* (Operational Capabilities) Seller-3A4-V02.00** 123456789 Trading Partner Identification 372463489 Acme_DC Delivery Channel (Communication Capabilities) GlobalChips_DC * If the RosettaNet over RNIF business protocol is used, collaborations are part of the trading partner agreement. If any EDI or Custom Document business protocol is used, Business Actions are part of the trading partner agreement. ** Automatically included in the trading partner agreement. Trading partner agreements do not expose the internal processes of one trading partner to another. See Chapter 12, "Creating and Managing Trading Partner Agreements" for more information. Configuration and Deployment In the configuration and deployment stage, you create a configuration—essentially a container for everything you have previously specified about trading partners and trading partner agreements. Then you deploy the configuration to the run-time environment. In the run-time environment, OracleAS Integration B2B sends messages to and receives messages from remote trading partners. See Chapter 13, "Creating and Deploying a Configuration" for more information. OracleAS Integration B2B Administration, Monitoring, and Security Table 1–3 shows the features that are available to administer, monitor, and provide security in OracleAS Integration B2B. 1-8 Oracle Application Server Integration B2B User’s Guide Summary Table 1–3 OracleAS Integration B2B Features for Administration, Monitoring, and Security To Do... Use... See... Administer design-time and run-time data OracleAS Integration B2B user interface Chapter 17, "Administering OracleAS Integration B2B" OracleAS Integration B2B Administration tab Manage an OracleAS Integration B2B Oracle Enterprise Manager 10g middle tier, start and stop OracleAS Integration B2B components, or change server property values Chapter 18, "System Management with Oracle Enterprise Manager 10g" Create reports that describe the run-time behavior status of a deployed configuration OracleAS Integration B2B Reports tab Chapter 19, "Creating Reports" Control user access to content and protect your site against break-ins OracleAS Integration B2B security features Chapter 20, "OracleAS Integration B2B Security" Summary This chapter describes the features, benefits, supported protocols, and design-time workflow of OracleAS Integration B2B. Introduction to Oracle Application Server Integration B2B 1-9 Summary 1-10 Oracle Application Server Integration B2B User’s Guide 2 Getting Started with the User Interface This chapter describes how to get started with OracleAS Integration B2B. The features and tasks available from each tab in the user interface are described. This chapter contains the following topics: ■ Accessing the User Interface ■ User Interface Page Components ■ Partners Main Tab ■ Deployment Main Tab ■ Reports Main Tab ■ Administration Main Tab ■ Summary Accessing the User Interface These instructions assume that you have installed OracleAS Integration B2B. See OracleAS Integration B2B Installation Guide at http://www.oracle.com/technology/documentation/appserver101202.html To access the user interface: 1. Open a Web browser. For a list of supported browsers, see OracleAS Integration B2B Installation Guide. 2. Go to the following URL: http://hostname:port/b2b where: ■ ■ hostname is the name of the host on which OracleAS Integration B2B is installed port is the port number that OracleAS Integration B2B uses. The following sources identify the port number used. – The ipsetupinfo.txt file in the install subdirectory of your Oracle home directory – The End of Installation page that displays at the end of OracleAS Integration B2B installation A page for logging in to the OracleAS Integration B2B user interface appears. Getting Started with the User Interface 2-1 Accessing the User Interface 3. Enter the following information: For This Field... Enter This... Username admin where admin is the default OracleAS Integration B2B user interface username. You can create additional users. These users can also use all features of the user interface if you assign them the Administrator role. Note: You cannot update the password for the predefined admin user. Instead, create a new user and assign it the Administrator role. You can update the password for this new user. See "Creating a Trading Partner Person" on page 10-22 for instructions on creating a user and assigning a password and "Assigning a User Role to a Host Trading Partner Person" on page 10-24 for instructions on assigning the Administrator user role. Password ias_admin_password where ias_admin_password is the Oracle Application Server administrator password you entered during J2EE and Web Cache installation. You also entered this password when prompted during OracleAS Integration B2B installation. See "Viewing a Trading Partner Person and Updating the Person Password" on page 10-22 for instructions on changing the password. The admin username enables you to create, update, and delete partner data in the OracleAS Integration B2B user interface. 4. Click Login. The OracleAS Integration B2B home page appears with the following main tabs: Partners, Deployment, Reports, and Administration. From these tabs, you can do the following: 2-2 Oracle Application Server Integration B2B User’s Guide User Interface Page Components This Tab... Enables You To... Perform the following partner data tasks: Partners ■ Create or import RosettaNet collaborations, EDI X12 or EDI EDIFACT transaction sets, and UCCnet standards, for example. A transaction set maps to a document type of a business action in the OracleAS Integration B2B user interface. Collaborations, business actions, and standards describe business documents and their movement between trading partners. ■ Create a remote trading partner ■ Assign support for a business protocol to a remote trading partner ■ ■ Create operational capability (created or imported support for collaborations for the RosettaNet over RNIF business protocol or business actions or standards for any EDI or Custom Document business protocol) and communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) for the business protocol of the remote trading partner Create communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) for the business protocol of the host trading partner Note: The host trading partner automatically includes support for all business protocols and operational capabilities. You assign a business protocol and create operational capabilities for the remote trading partner only. ■ Create a trading partner agreement between host and remote trading partners Create, validate, and deploy a configuration that consists of a complete and consistent set of partner data created under the Partners tab. Creating a configuration means you intend to deploy the trading partner agreement that has been created. Deployment of a configuration results in OracleAS Integration B2B being ready to perform actual business as designed. Deployment Note: Do not leave a configuration in a validated state. Either deploy or discard the configuration immediately. Reports Monitor the status of the deployed configuration by creating and viewing reports Administration Administer various portions of the configuration, including exporting, importing, and purging data. A link is provided to Oracle Enterprise Manager 10g for performing system management tasks. 5. See "User Interface Page Components" on page 2-3 for a description of the general layout of OracleAS Integration B2B user interface pages. See the following for more information: ■ "Partners Main Tab" on page 2-13 ■ "Deployment Main Tab" on page 2-18 ■ "Reports Main Tab" on page 2-18 ■ "Administration Main Tab" on page 2-19 User Interface Page Components The OracleAS Integration B2B user interface presents partner data tasks in a series of HTML pages. This section contains the following topics: ■ Main List Pages ■ Details Pages ■ Creating Incomplete Partner Data ■ Creating, Adding, Deleting, and Removing Data ■ Naming Conventions ■ Using the Browser Back and Forward Buttons ■ Using the Return to List Link Getting Started with the User Interface 2-3 User Interface Page Components ■ Searching for Data on the Main List Page ■ Exporting Partner Data to an XML File ■ Viewing the State of Partner Data on the Details Pages Main List Pages When you click the subtab (for example, Trading Partners) of a main tab (for example, Partners), a main list page displays information you created, as shown in Figure 2–1. Main list pages have general names such as Trading Partners or Trading Partner Agreements, and are not named after specific partner data that you create. Figure 2–1 Main List Page Table 2–1 describes the contents of Figure 2–1 and the tasks you can perform. 2-4 Oracle Application Server Integration B2B User’s Guide User Interface Page Components Table 2–1 Main List Page Contents Page Element Search list Location in Page top left of Figure 2–1 Description Enables you to search for a specific element, such as a trading partner name, by selecting a criteria from the Search list. This list only displays if the quantity for this element exceeds ten (for example, more than ten trading partners). See "Searching for Data on the Main List Page" on page 2-8 for details about using the search feature. Subtab (Trading top left of Partners) Figure 2–1 Identifies the subtab of the main tab in which you are located (in this example, the Trading Partners subtab of the Partners main tab). The subtabs that appear are based on the main tab you selected. Some subtabs have additional sections (for example, the Trading Partner Details page under the Trading Partners subtab includes General, Organization, Users, and Capabilities sections). Main tab (Partners) top right of Figure 2–1 Identifies the main tab in which you are located (in this example, the Partners tab). There are four main tabs (Partners, Deployment, Reports, and Administration). Home link top right of Figure 2–1 Returns you to the OracleAS Integration B2B user interface home page. (See Step 4 on page 2-2.) Help link top right of Figure 2–1 Enables you to access online help for the page. Logout link top right of Figure 2–1 Logs you out of the OracleAS Integration B2B user interface and returns you to the login page. (See Step 3 on page 2-2.) Logged in as message top right of Figure 2–1 Displays the user currently logged into the OracleAS Integration B2B user interface, along with the host trading partner name (in this example, mark@Acme). Shortcut section top right of Figure 2–1 Provides shortcuts for performing related tasks specific to this partner data (in this example, a shortcut for creating a trading partner agreement is provided, since a trading partner must be assigned to a trading partner agreement to be part of a deployed configuration). Create button middle of Figure 2–1 Enables you to create partner data (for this example, a trading partner). Name column middle of Figure 2–1 Enables you to access specific details about the selected partner data (known as the details page). For example, if you select a trading partner (such as Acme), you can see the trading partner agreements with which it is associated. Update column middle of Figure 2–1 Enables you to update the selected partner data (for this example, a trading partner). Delete column middle of Figure 2–1 Enables you to delete the selected partner data (for this example, a trading partner). Previous and Next lists middle and bottom right of Figure 2–1 Enables you to access additional main list pages of partner data. This list displays only if the quantity for this element exceeds ten (for example, more than ten trading partners). Links at bottom of page bottom of Figure 2–1 Enable you to: ■ Access the four main tabs (Partners, Deployment, Reports, and Administration) ■ Return to the OracleAS Integration B2B user interface home page (Home) ■ Access online help for the page (Help) ■ Log out of the OracleAS Integration B2B user interface (Logout) Details Pages Partner data that you create has its own details page typically accessed through the Name column shown in Figure 2–1 on page 2-4. Details pages are named after specific Getting Started with the User Interface 2-5 User Interface Page Components elements that you create. For example, Figure 2–2 shows the details page for a trading partner named RN-TradingPartner1. Figure 2–2 Details Page Table 2–2 describes the contents of Figure 2–2 and the tasks you can perform. Table 2–2 Details Page Contents Page Elements Details section Location in Page Description top left of Figure 2–2 Enables you to view specific details, including a description and the current state of this partner data (in this example, Draft). See "Viewing the State of Partner Data on the Details Pages" on page 2-11 for details about states such as Draft. Section (General) top left of Figure 2–2 Identifies the section of the subtab in which you are located (in this example, the General section of the Trading Partners subtab of the Partners main tab). The sections that appear are based on the subtab you selected. Subtab (Trading Partners) top left of Figure 2–2 Identifies the subtab of the main tab in which you are located (in this example, the Trading Partners subtab of the Partners main tab). The subtabs that appear are based on the main tab you selected. Main tab (Partners) top right of Figure 2–2 Identifies the main tab in which you are located (in this example, the Partners tab). There are four main tabs (Partners, Deployment, Reports, and Administration). 2-6 Oracle Application Server Integration B2B User’s Guide User Interface Page Components Table 2–2 (Cont.) Details Page Contents Location in Page Description Home link top right of Figure 2–2 Returns you to the OracleAS Integration B2B user interface home page. (See Step 4 on page 2-2.) Help link top right of Figure 2–2 Enables you to access online help for the page. Logout link top right of Figure 2–2 Logs you out of the OracleAS Integration B2B user interface and returns you to the login page. (See Step 3 on page 2-2.) Logged in as message top right of Figure 2–2 Displays the user currently logged into the OracleAS Integration B2B user interface, along with the host trading partner name (in this example, mark@Acme). Validate button top right of Figure 2–2 Enables you to validate this partner data to ensure its correctness and completeness. Page Elements See "Viewing the State of Partner Data on the Details Pages" on page 2-11 for details about the Validate button. Export button top right of Figure 2–2 Enables you to export the contents of this partner data to an XML file to send to other persons or organizations (trading partners) for review. See "Exporting Partner Data to an XML File" on page 2-9 for details about exporting partner data to persons or organizations (trading partners) for review. Delete button top right of Figure 2–2 Enables you to delete the selected partner data (for this example, the RN-TradingPartner1 trading partner). Update button top right of Figure 2–2 Enables you to update the selected partner data (for this example, the RN-TradingPartner1 trading partner). Create buttons, Delete columns, Update columns, Details column middle of Figure 2–2 Enable you to manage (create, delete, update, and view) elements associated with the main partner data (for this example, you can manage trading partner identifications, associated trading partner agreements, and remote trading partner certificates from this Trading Partner Details page). Links at bottom of page bottom of Figure 2–2 Enable you to: Return To List link bottom left of Figure 2–2 ■ Access the four main tabs (Partners, Deployments, Reports, and Administration) ■ Return to the OracleAS Integration B2B user interface home page (Home) ■ Access online help for the page (Help) ■ Log out of the OracleAS Integration B2B user interface (Logout) Enables you to move one level up to the main list page. For example, clicking Return To List on this page takes you one level up to the Trading Partners page shown in Figure 2–1 on page 2-4. Creating Incomplete Partner Data You can complete all partner tasks and store the partner details for later use. Or, you can complete a portion of your partner tasks and complete the remaining tasks later (for example, you can follow this approach with the Create Trading Partner wizard). When you initially create a specific element, only fields clearly marked with an asterisk must be completed. You can ignore fields that are not mandatory, or modify these details at a later time. Getting Started with the User Interface 2-7 User Interface Page Components Creating, Adding, Deleting, and Removing Data The OracleAS Integration B2B user interface pages provide Create, Add, Delete, and Remove buttons. ■ ■ Use the Create and Delete buttons to create and delete partner data. Use the Add and Remove buttons to add or remove an association between elements. For example, if you delete a trading partner agreement, it is deleted from OracleAS Integration B2B and must be re-created if you want to use it again. However, if you remove a delivery channel from an agreement, it is still available in OracleAS Integration B2B for reuse at a later time. Naming Conventions You are frequently prompted to provide names when creating data. Oracle recommends that you adhere to the following naming conventions: ■ Provide data with unique and meaningful names to make it easy to identify its content. For example, if you are creating a trading partner agreement using RosettaNet Partner Interface Process (PIP) 3A4 with a remote trading partner named Acme, use that name in the agreement (for example, Acme_PIP3A4_Agreement). ■ Do not include beginning or trailing blank spaces in the names of data you create Using the Browser Back and Forward Buttons Do not use the Back or Forward buttons of your Web browser when creating partner data. For example, if you are creating partner data with the Create Trading Partner wizard, use the Back and Next buttons specifically provided in the user interface. Using the Return to List Link Details pages include a Return to List link at the bottom left that enables you to move up one level. For example, clicking Return to List on a specific Trading Partner Details page takes you up to the main Trading Partners list page. Use the Return to List link instead of the Back or Forward buttons of your Web browser. Searching for Data on the Main List Page The search feature is available from a list page if the number of elements on a page exceeds ten. Figure 2–3 provides an example of the search feature that appears on the Trading Partners page that you access by clicking Partners, then Trading Partners. Instead of browsing from page to page, select a specific search criteria in the Search list to find the appropriate trading partner. The Search list contains attributes of the element. For example, if a text attribute is selected (such as name) on the Trading Partners main list page, a text field appears and enables you to enter a specific name for which to search. You can use the % sign as a wildcard instead of specifying the entire name. 2-8 Oracle Application Server Integration B2B User’s Guide User Interface Page Components Figure 2–3 Search Feature Exporting Partner Data to an XML File The details pages for some high-level partner data elements include an Export button to export partner data to an XML file. You can then submit this file for review and approval to applicable persons to ensure that it is correct. Figure 2–4 shows the location of the Export button in the upper-right part of a details page for a remote trading partner named RN-TradingPartner1. Only the details pages of certain partner data elements include the export feature. High-level partner data elements include lower-level partner data elements on their details pages that can also be defined. For example, the Trading Partner Details page in Figure 2–4 enables you to manage such lower-level partner data elements as trading partner identifications, associated trading partner agreements, and remote trading partner certificates. When you click Export on the Trading Partner Details page, the partner data that you defined for the trading partner is all included in the XML file (including data for trading partner identifications, associated trading partner agreements, and certificates). Getting Started with the User Interface 2-9 User Interface Page Components Figure 2–4 Partner Data Export Button Table 2–3 identifies the high-level partner data elements that have an Export button, and the partner data that is included in the XML file when you click Export. References are provided for more specific details about managing this data. 2-10 Oracle Application Server Integration B2B User’s Guide User Interface Page Components Table 2–3 Partner Data Export Details Pages with an Export Button ■ Partner Data Exported to an XML File Trading Partner Details page Trading partner identifications, associated trading partner agreements, remote trading partner certificates, and host trading partner wallet manager passwords (under the General section) ■ ■ ■ ■ Chapter 9, "Creating Trading Partners" Chapter 10, "Managing Trading Partners" Chapter 11, "Managing Callouts" Organization contact information (for contacting an organization) (under the Organization section) ■ Users and contact information (for creating a user and contacting a person) (under the Users section) ■ Business protocols and their associated operational capabilities (support for collaborations for the RosettaNet over RNIF business protocol or support for business actions for any EDI or Custom Document business protocols) and communication capabilities (delivery channels, document exchanges, transports, transport servers, and endpoints) (under the Capabilities section) ■ Agreement Details page See Also... The details of the trading partner, including this lower-level partner data: The details of the trading partner agreement, including host and remote trading partner participants Chapter 12, "Creating and Managing Trading Partner Agreements" Note: Do not manually edit exported files. If you do so, OracleAS Integration B2B cannot guarantee their integrity. See "Partners Main Tab" on page 2-13 for additional details about the partner data described in this section. Viewing the State of Partner Data on the Details Pages Partner data created under the Partners tab goes through several lifecycle states from the time of creation through its role in a validated and deployed configuration. The current state of trading partners and trading partner agreements is displayed in the Details sections on their details pages. For example, see Figure 2–4 on page 2-10, where the State is Draft for RN-TradingPartner1. Table 2–4 shows the states available for trading partners and trading partner agreements. Table 2–4 Partner Data Element States Lifecycle State Description Draft Partner data is created, but not yet validated Approved Partner data has been approved and validated for individual correctness Deployed Partner data is deployed in a validated configuration The following sections describe the lifecycle states in OracleAS Integration B2B: ■ Draft State for Partner Data ■ Approved State for Partner Data ■ Deployed State for Partner Data Getting Started with the User Interface 2-11 User Interface Page Components Draft State for Partner Data When you create partner data, its initial state is Draft, which is displayed in the Details section of the details page. Figure 2–5 shows the Draft state (in this example, for a trading partner). During this state, you can optionally export your partner data to XML files to submit to specific persons for their review. You (as the host trading partner) can later update the status of the trading partner after receiving reviewer inputs. Figure 2–5 Draft State See "Exporting Partner Data to an XML File" on page 2-9 for more information. Approved State for Partner Data You can validate your partner data for individual correctness after creation by clicking the Validate button. This individual validation is separate from the complete, end-to-end validation that is performed on all partner data when you create a configuration. If no validation errors occur, the details page refreshes and the state changes from Draft to Approved, as shown in Figure 2–6. The Validate button is gone. Figure 2–6 Approved State Any validation errors appear on the page. You must correct the errors and click Validate again. Deployed State for Partner Data After you create, validate, and deploy a configuration, the State field changes to Deployed on the details pages of all trading partners and trading partner agreements included in the configuration. See "Creating a Configuration" on page 13-3 for instructions on creating, validating, and deploying a configuration. 2-12 Oracle Application Server Integration B2B User’s Guide Partners Main Tab Partners Main Tab When you select the Partners tab to manage partner data, the page shown in Figure 2–7 appears. Figure 2–7 Partners Tab From this page, you can do the following tasks: ■ View definitions of key partner concepts ■ Access list pages for the following Partners subtabs to perform management tasks: ■ – Trading Partners List Page – Trading Partner Agreements List Page – Protocols List Page – Callouts List Page Access shortcuts in the Shortcuts section for creating a trading partner with the Create Trading Partner wizard and creating a trading partner agreement Trading Partners List Page When you select the Trading Partners tab, the list page shown in Figure 2–8 appears. Getting Started with the User Interface 2-13 Partners Main Tab Figure 2–8 Trading Partners Tab The Trading Partners page displays the host trading partner (in this example, named Acme and automatically identified by the word Host in parentheses) and all remote trading partners you created. The host trading partner name is automatically named MyCompany after installation. You can update it after installation to a name that uniquely reflects your organization (for example, Acme). The host trading partner is the organization in which OracleAS Integration B2B is installed. There can be only one host trading partner. It cannot be deleted. The remote trading partners are the organizations outside your enterprise with whom you conduct business, as defined in a trading partner agreement. The host trading partner uses the OracleAS Integration B2B user interface to define the capabilities for all trading partners (both host and remote). The host trading partner consults with the remote trading partner to obtain the necessary details. From the Trading Partners page, you can do the following tasks: ■ ■ ■ Access a shortcut in the Shortcuts section to create a trading partner agreement Manage the host trading partner (update and view) and remote trading partners (create, delete, update, and view) Click a specific trading partner in the Name column to access the page shown in Figure 2–9 with links for managing (create, view, update, add, and delete) the following: ■ ■ ■ 2-14 Trading partner identification types, associated agreements, remote trading partner certificates, and the host trading partner wallet password (under the General section at the top left of the page) Trading partner organizations and persons and their contact details (under the Organization and Users sections at the top left of the page) Business protocols (under the Capabilities section at the top left of the page). After you add support for a business protocol to a remote trading partner (for Oracle Application Server Integration B2B User’s Guide Partners Main Tab example, RosettaNet over RNIF for RosettaNet or EDI EDIFACT over Generic Exchange for EDI EDIFACT), you can perform the following management tasks by clicking on the business protocol in the Name column of the Capabilities page shown in Figure 2–10: * Operational capabilities tasks for the business protocol of the remote trading partner, such as adding or removing support for a collaboration (if using the RosettaNet over RNIF business protocol) or a business action (if using any EDI or Custom Document business protocol). See Figure 10–3 on page 10-4 for an example. * Communication capabilities tasks for the business protocol of the host and remote trading partner, such as managing delivery channels, document exchanges, transports, transport servers, and endpoints. See Figure 10–3 on page 10-4 for an example. The host trading partner is automatically assigned business protocols and operational capabilities. You assign a business protocol and create operational capabilities for the remote trading partner only. Figure 2–9 Trading Partner Details Page Figure 2–10 Business Protocol Details Page Getting Started with the User Interface 2-15 Partners Main Tab See the following for more information: ■ Chapter 9, "Creating Trading Partners" ■ Chapter 10, "Managing Trading Partners" Trading Partner Agreements List Page When you select the Agreements tab, the Trading Partner Agreements list page shown in Figure 2–11 appears. Figure 2–11 Trading Partner Agreements Tab From this page, you can do the following tasks: ■ ■ ■ Manage (create, update, delete, and view) trading partner agreements between trading partners Click a specific trading partner agreement in the Name section to access a page to update details about the trading partners participating in the trading partner agreement (both remote and host trading partners) Access shortcuts listed in the Shortcut section for performing agreement-related tasks (for example, creating a remote trading partner) See Chapter 12, "Creating and Managing Trading Partner Agreements" for more information. Protocols List Page When you select the Protocols tab, the Business Protocols list page shown in Figure 2–12 appears. 2-16 Oracle Application Server Integration B2B User’s Guide Partners Main Tab Figure 2–12 Protocols Tab From this page, you can do the following tasks: ■ ■ View all business protocols available with OracleAS Integration B2B Click a specific business protocol in the Name section to access a page to manage (create, delete, update, and view) the process protocol, document protocol, and exchange protocol of a business protocol. From this page, you can access the Process Protocol Revision Details page to manage (create, delete, update, and view) support for collaborations (for RosettaNet over RNIF) and business actions (for EDI or Custom Document, such as UCCnet standards) of business protocols. Collaborations, business actions, and standards describe business documents and their movement between trading partners. See Chapter 8, "Managing Business Protocols" for more information. Callouts List Page XSLTCallout, which is provided with OracleAS Integration B2B, transforms XML documents from one form to another (for example, Oracle E-Business Suite XML to RosettaNet XML and vice versa). When you select the Callouts tab, the list page shown in Figure 2–13 appears. Figure 2–13 Callouts Tab Getting Started with the User Interface 2-17 Deployment Main Tab From this page, you can do the following tasks: ■ ■ Manage callouts (create, delete, update, and view) used to manipulate documents outside of OracleAS Integration B2B. Click a callout in the Name section to access a page to view callout details (such as classification, language type, implementation name, and library name), and manage (create, delete, update, and view) callout properties and usages. See Chapter 11, "Managing Callouts" for more information. Deployment Main Tab When you select the Deployment tab with no deployed configurations, the list page shown in Figure 2–14 appears. Figure 2–14 Deployment Tab From this page, you can do the following tasks: ■ Create a configuration that consists of the following: ■ ■ Partner data consisting of host and remote trading partners, their business protocols and operational and communication capabilities, and trading partner agreements between these trading partners created under the Partners tab Deploy, discard, quiesce, or export the configuration Note: Do not leave a configuration in a validated state. Either deploy or discard the configuration. Oracle recommends that you delete retired configurations. However, purging a retired configuration removes the associated run-time data. Oracle recommends that you do a database archive of run-time data before purging. See Chapter 13, "Creating and Deploying a Configuration" for more information. Reports Main Tab When you select the Reports tab, the Reports list page shown in Figure 2–15 appears. 2-18 Oracle Application Server Integration B2B User’s Guide Administration Main Tab Figure 2–15 Reports Tab From this page, you can do the following tasks: ■ Access the following Reports sections to create and view reports about deployed configurations: ■ Business message status reports Provide details about the status of business messages sent between trading partners, including the business action, business message ID and status, and document and exchange protocols. Support for querying both XML or EDI payload content is provided. ■ Wire message status reports Provide details about trading partner wire message instances, including transport protocol type and wire message payload contents. These reports enable you to go from a business message to its corresponding wire message and from a wire message to its corresponding business messages. ■ Collaboration status reports Provide details about the collaboration name, protocol message identification, and exchange protocol (RosettaNet) ■ Error status reports Provide details about message processing errors ■ Save generated reports in comma-delimited value format for viewing in Microsoft Excel format ■ Import a previously saved report ■ Save report definitions to a file See Chapter 19, "Creating Reports" for more information. Administration Main Tab When you select the Administration tab, the list page shown in Figure 2–16 appears. Getting Started with the User Interface 2-19 Administration Main Tab Figure 2–16 Administration Tab From this page, you can do the following tasks: ■ ■ ■ View definitions of administration features that you access from this page Access the Oracle Enterprise Manager 10g Application Server Control Console to start and stop OracleAS Integration B2B; view run-time performance; configure server properties for logging levels, B2B settings, and security levels; and view log files. Access the list pages for the following Administration subtabs for performing management tasks: ■ Design List Page ■ Management List Page See the following for more information: ■ Chapter 17, "Administering OracleAS Integration B2B" ■ Chapter 18, "System Management with Oracle Enterprise Manager 10g" Design List Page When you select the Design tab, the list page shown in Figure 2–17 appears. 2-20 Oracle Application Server Integration B2B User’s Guide Administration Main Tab Figure 2–17 Design Tab From this page, you can do the following tasks: ■ ■ View the methods available for contacting organizations and persons (contact types). Manage trading partner identification types. If you create a trading partner identification type on this page, it displays when you create a trading partner identification by clicking Partners, then Trading Partners, then trading_partner_ name_in_Name_column, then Trading Partner Identifications, and then Create. See the following for more information: ■ "Managing Contact Types" on page 17-3 ■ "Managing Trading Partner Identification Types" on page 17-3 Management List Page When you select the Management tab, the list page shown in Figure 2–18 appears. Getting Started with the User Interface 2-21 Summary Figure 2–18 Management Tab From this page, you can do the following tasks: ■ ■ ■ ■ Import the OracleAS Integration B2B design-time repository data that was previously exported. During import, the host trading partner, as identified in the user interface, and the host trading partner identified in the export file must be the same. Export and import the entire contents of the OracleAS Integration B2B design-time repository to and from an XML file. This enables you to export the contents from one repository and import it into another repository. Export and import a configuration created under the Deployment tab to and from an XML file Purge the entire repository. See "Purging the Entire Repository" on page 17-9 for more information. See the following for more information: ■ "Exporting and Importing the Design-Time Repository" on page 17-5 ■ "Purging the Entire Repository" on page 17-9 Summary This chapter shows the higher-level pages of the OracleAS Integration B2B user interface, starting with the OracleAS Integration B2B home page. References are provided to chapters that describe these pages in more specific detail. This chapter describes in detail the layout, links, and tabs on main list pages and details pages. The main tabs (Partners, Deployment, Reports, and Administration) are described so that you understand the tasks you can perform on each page. Subtab pages are also described (for example, Trading Partners and Agreements of the Partners tab). 2-22 Oracle Application Server Integration B2B User’s Guide 3 Supported Protocols This chapter describes the standard B2B protocols supported by OracleAS Integration B2B. This chapter contains the following topics: ■ Overview of Supported Protocols ■ Document Protocols ■ Exchange Protocols ■ Process Protocols ■ Business Protocols ■ Summary Overview of Supported Protocols Table 3–1 lists the protocols—the agreed-upon formats for transmitting data—and the protocol revisions that OracleAS Integration B2B supports, categorized by protocol type. The protocols are described in more detail in subsequent sections. Supported Protocols 3-1 Document Protocols Table 3–1 B2B Protocols Supported in OracleAS Integration B2B Protocol Type Protocol and Revision The document protocol defines the document type of the message payload, which is based on which standard (RosettaNet, EDI, and so on) you are using as part of the business logic. The exchange protocol defines the message exchange mechanism—how to exchange the documents defined by the document protocol. It defines the headers, acknowledgments, and packaging that puts the headers and payload together. It also defines the transport protocol and packaging protocol for the exchange. ■ ■ transport protocol—defines the underlying transport and its properties packaging protocol—defines a packaging mechanism. Message security such as signing and encryption are often based on a specific packaging mechanism The process protocol defines how you exchange messages, using the document protocol-based business document, and exchanging it based on the exchange protocol. It is the mechanism by which business actions and collaborations are associated with specific document types. ■ RosettaNet (1.1 and 2.0) ■ EDI X12 (all revisions) ■ EDI EDIFACT (all revisions) ■ Custom Document—customer-defined protocols ■ Health Level 7 (HL7) ■ RosettaNet Implementation Framework (RNIF 01.10, RNIF V02.00) ■ Applicability Statement 2 (AS2) ■ Generic (Generic 1.0) ■ Minimum Lower Layer Protocol (MLLP) ■ ebXML Messaging Service (ebMS) ■ HTTP (HTTP 1.0, HTTP 1.1) ■ HTTPS (HTTPS 1.0, HTTPS 1.1) ■ Email (SMTP 1.0, IMAP 1.0) ■ File (File 1.0) ■ FTP (FTP 1.0) ■ FTPS ■ TCP/IP ■ MIME (MIME 1.0) ■ S/MIME (S/MIME 2.0, S/MIME 3.0) ■ SOAP ■ XML digital signature (XMLDSig) ■ XML encryption (XMLEncrypt) ■ B2B Document Protocols The document protocol defines the document type of the message payload. Business protocols can have multiple document protocols. Document protocols follow the hierarchy shown in Figure 3–1. 3-2 Oracle Application Server Integration B2B User’s Guide Document Protocols Figure 3–1 Document Protocol Hierarchy Document Protocol (EDI X12) Document Protocol Revision (EDI X12 4010) Document Type (850) Document Definition (.xsd file and associated information) A document protocol can consist of multiple document protocol revisions. A document protocol revision can consist of multiple document types. A document type can consist of multiple document definitions, because you can start with one document definition and customize it for different trading partners. For document definition files, you can use the template library of the Windows-based OracleAS Integration B2B - Document Editor to create RosettaNet.xsd and .dtd files, EDI X12 and EDI EDIFACT.ecs files and HL7 files that you then import into the OracleAS Integration B2B user interface. You cannot use OracleAS Integration B2B - Document Editor to define custom documents. See "OracleAS Integration B2B - Document Editor Overview" on page 8-4 for more information. OracleAS Integration B2B supports the following document protocols. The document protocols are discussed in more detail in subsequent sections. ■ RosettaNet ■ EDI X12 ■ EDI EDIFACT ■ Custom Documents (includes support for UCCnet) ■ HL7 Using Document Protocols in OracleAS Integration B2B To use the standard document protocols for RosettaNet, EDI X12, EDI EDIFACT, and UCCnet message exchanges, you must import them into OracleAS Integration B2B. See "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 for details. Supported Protocols 3-3 Document Protocols See Also: ■ ■ ■ ■ ■ ■ "Managing Document Protocols" on page 8-5 "Page 2: Document Protocol Revision" on page 8-23 and "Page 3: Document Type" on page 8-24 for instructions on using OracleAS Integration B2B - Document Editor to import files when creating a business action "Page 3: Requesting Business Action" on page 8-31 for instructions on using OracleAS Integration B2B - Document Editor to import files when creating a collaboration The online Help included with OracleAS Integration B2B Document Editor for instructions on using the library templates to create .ecs, .dtd, and .xsd files Figure 8–4, Figure 8–5, and Figure 8–6 on page 8-7 for examples of document protocols defined for the EDI X12 over Generic Exchange business protocol Figure 8–8 on page 8-20 for an example of process protocol management tasks for the RosettaNet over RNIF business protocol RosettaNet OracleAS Integration B2B implements the nonproprietary, XML-based RosettaNet standards to exchange documents over the Internet. RosettaNet standards prescribe when information should be exchanged, acknowledged, or confirmed, and how messages in an exchange should be packaged and physically exchanged between trading partners. RosettaNet standards are specified through the use of the RosettaNet Partner Interface Process (PIP), RosettaNet Dictionaries, and RNIF, which are described in subsequent sections. OracleAS Integration B2B supports message exchanges using the RosettaNet PIPs shown in Table 3–2 when you create a collaboration. See "Process Protocols" on page 3-11 for more information about PIPs. Table 3–2 3-4 RosettaNet PIPs Supported in OracleAS Integration B2B PIP Description Version 0A1 Notification of Failure V02.00.00 2A1 Distribute New Product Information V02.00.00 2A9 Query Technical Product Information V01.01.01 2A10 Distribute Design Engineering Information V02.00.00 2A12 Distribute Product Master V01.03.00 3A1 Request Quote V02.01.00 3A4 Request Purchase Order V02.03.00 3A6 Distribute Order Status V02.02.00 3A7 Notify of Purchase Order Update V02.03.00 3A8 Request Purchase Order Change V01.03.00 3A9 Request Purchase Order Cancellation V01.01.00 3B2 Notify of Advanced Shipment V01.01.00 Oracle Application Server Integration B2B User’s Guide Document Protocols Table 3–2 (Cont.) RosettaNet PIPs Supported in OracleAS Integration B2B PIP Description Version 3B3 Distribute Shipment Status R01.00.00 3B12 Request Shipping Order V01.01.00 3B13 Notify of Shipping Order Confirmation V01.01.00 3C1 Return Product V01.00.00 3C3 Notify of Invoice V01.01.00 3C4 Notify of Invoice Reject V01.00.00 4A1 Notify of Strategic Forecast V02.00.00 4A3 Notify of Threshold Release Forecast V02.01.00 4A4 Notify of Planning Release Forecast V03.00.00 4A5 Notify of Forecast Reply V02.00.00 4B2 Notify of Shipment Receipt V01.00.00 4C1 Distribute Inventory Report V02.03.00 7B1 Distribute Work in Process V01.00.00 You can see how a collaboration is created using PIP 3A4 in "Acme Server, Task 1: Creating the Collaboration" on page 5-6 of tutorial 1. See http://www.rosettanet.org for information about the RosettaNet consortium and its history, and for details about RosettaNet standards. RosettaNet Dictionaries The RosettaNet Business Dictionary provides a common vocabulary and a common set of properties to use in XML documents. For example, trading partners using the RosettaNet Business Dictionary might agree to use the term DRAM for memory chip. The RosettaNet Technical Dictionary is not supported in OracleAS Integration B2B. RosettaNet Validation RosettaNet validation compares the elements in RosettaNet XML-format business documents to the requirements specified in the RosettaNet Message Guideline specification to determine their validity. This specification defines requirements for details such as element datatypes, element lengths, element value lists, and element cardinality. PIPs that require RosettaNet dictionary validation are also validated when a dictionary is present. The minimum validation-level requirements on the sections of a RosettaNet XML-format business document are as follows. These requirements cover the preamble, delivery header, service header, and service content sections of a document. Documents not following one or more of these requirements are identified as invalid. 1. The XML-format business document requires compliance with its DTD. 2. Elements with datatypes, lengths, or both that are specified in the RosettaNet Message Guideline specification require validation against this specification. 3. An element’s list of values specified in the entity instance list in the corresponding RosettaNet Message Guideline specification requires validation against this specification. Supported Protocols 3-5 Document Protocols 4. If the Message Guideline specification defines the cardinality specification of an element differently from the corresponding DTD specification, the Message Guideline specification takes precedence. 5. If a PIP requires dictionary validation, and a dictionary is included, the service content requires validation against the dictionary as a part of action performance. 6. Cross-tag validation is based on message guidelines. EDI X12 OracleAS Integration B2B supports message exchanges using American National Standards Institute (ANSI) X12. These standards prescribe the formats, character sets, and data elements used in the exchange of documents such as purchase orders and invoices. You can use the X12 transaction sets shown in Table 3–3 when you create a business action. Table 3–3 EDI X12 Transaction Sets Supported in OracleAS Integration B2B Set Description Version 850 Purchase Order 4010 855 Purchase Order Acknowledgment 4010 997 Functional Acknowledgment 4010 You can see how a business action is created using the 850, 855, and 997 transactions in "Acme Server, Task 1: Creating the Business Actions" on page 5-41 of tutorial 3. See http://www.ansi.org for information about the organization that created and maintains the ANSI X12 standards. EDI EDIFACT OracleAS Integration B2B supports message exchanges using UN/EDIFACT, the United Nations Electronic Data Interchange for Administration, Commerce and Transport. These standards prescribe the formats, character sets, and data elements used in the exchange of documents such as purchase orders and invoices. You can use the EDI EDIFACT transaction sets shown in Table 3–4 when you create a business action. Table 3–4 EDI EDIFACT Transaction Sets Supported in OracleAS Integration B2B Set Description Version ORDERS Purchase Order Message D98A ORDRSP Purchase Order Response Message D98A CONTRL Syntax and Service Report Message D3 You can see how a business action is created using the ORDERS, ORDRSP, and CONTRL transactions in "Acme Server, Task 1: Creating the Business Actions" on page 5-19 of tutorial 2. See Chapter 14, "Batching and Debatching EDI Transaction Sets" for information about EDI batching support. See http://www.unece.org for information about the organization that created and maintains the UN/EDIFACT standards. 3-6 Oracle Application Server Integration B2B User’s Guide Document Protocols Custom Documents You can use the Custom Document protocol to create documents needed for proprietary transaction mechanisms. With the Custom Document option, you can create document definitions for XML and non-XML messages. With XML messages, you have the advantage of schema enforcement (.xsd). With non-XML messages, you can create trading partner agreements for specific message types. To configure a custom document, you specify the rules to identify the incoming document. For XML documents, you specify an XPath expression and a value, which is the expected result of the expression. See "Configuring the XPath Expression for a Custom XML Document" on page 8-15 for more information. OracleAS Integration B2B provides support for UCCnet under the Custom Document option. UCCnet is a service that enables trading partners to exchange standards-compliant data in the retail and consumer goods industries. When you use Custom Document, the message contents are not translated or validated. You can use the UCCnet standards shown in Table 3–5 when you create a Custom Document protocol. As with the other protocols, Custom Document has the following features available: authentication, authorization, nonrepudiation of origin and content, nonrepudiation of receipt, time to perform, time to acknowledge, and retry counts. Table 3–5 UCCnet Standards Supported in OracleAS Integration B2B Standard Version registerCommand 2.3.1 confirmCommand 2.3.1 linkCommand 2.3.1 checkComplianceCommand 2.3.1 documentCommand 2.3.1 documentIdentificationCommand 2.3.1 notificationStateCommand 2.3.1 queryCommand 2.3.1 registerLinkCommand 2.3.1 publicationCommand 2.3.1 publishCommand 2.3.1 catalogueItemMaintenanceCommand 2.3.1 priceCommand 2.3.1 validateCommand 2.3.1 registerOwnershipCommand 2.3.1 subscriptionCommand 2.3.1 notifyCommand‘ 2.3.1 response‘ 2.3.1 See http://www.uccnet.org for further descriptions of UCCnet standards Supported Protocols 3-7 Exchange Protocols HL7 OracleAS Integration B2B implements the Health Level 7 (HL7) version 2.x standard to exchange documents containing health care information using the Generic exchange or MLLP exchange. When using HL7, the standard OracleAS Integration B2B features, such as validation, translation, automatic generation of outbound envelope headers, and acknowledgments, are available. HL7 BATCH and FILE envelopes are not supported in this release. You can see how a business action is created using the HL7 over MLLP business protocol in "Acme Server, Task 1: Creating the Business Actions" on page 6-3 of the health care tutorial. See http://www.hl7.org for more information. Exchange Protocols The exchange protocol defines the headers, acknowledgments, and packaging that puts the headers and payload together (the message exchange mechanism). The exchange protocol also defines exchange-level security—signing and encryption—and transport protocols for the exchange. OracleAS Integration B2B supports the following exchange protocols: ■ RNIF ■ AS2 ■ Generic ■ MLLP ■ ebMS Exchange protocol guidelines are described in Table 3–6. Table 3–6 3-8 Exchange Protocol Guidelines Guideline Description Transport Supports multiple transport protocols (such as secure HTTP and SMTP) for delivering business messages between trading partners Packaging Supports the multipurpose internet mail extensions (MIME) format Authorization Ensures that a message sender is authorized to send the subject message to the receiving partner Authentication Requires a message sender to digitally sign a message Encryption Ensures that messages transmitted can be seen only by the expected recipient, who is able to decrypt and extract the business data Oracle Application Server Integration B2B User’s Guide Exchange Protocols Table 3–6 (Cont.) Exchange Protocol Guidelines Guideline Description Nonrepudiation Provides absolute evidence that a specific action occurred. This ensures that an originating trading partner cannot deny having sent a message and a receiving partner cannot deny having received a message. The following nonrepudiation types are available: ■ ■ Nonrepudiation of origin requires a message sender to digitally sign a message. This protects against attempts by a sender to deny sending a message. The message recipient must store the message for an agreed-on period of time (typically three to seven years). Nonrepudiation of receipt requires a message recipient to send back a digitally-signed acknowledgment. The message recipient must store both the receipt and the original message for an agreed-on period of time (typically three to seven years). This protects against any attempt by a message recipient to deny receiving a message. The transport protocol and packaging protocol are components of the exchange protocol. The following transport and packaging protocols are supported in OracleAS Integration B2B: ■ ■ Transport protocols ■ HTTP ■ HTTPS ■ Email ■ File ■ FTP ■ FTPS ■ TCP/IP Packaging protocols ■ MIME ■ S/MIME ■ SOAP ■ XMLDSig ■ XMLEncrypt See the following for more information: ■ ■ Figure 1–1 on page 1-3 for how the protocols fit into the OracleAS Integration B2B architecture "Viewing Exchange Protocols" on page 8-18 for details about exchange protocols RNIF RNIF defines implementation guidelines for creating software applications that provide for the reliable transport of PIPs in XML-format business documents between trading partners. Guidelines are provided for transport, routing, packaging, security, signals, and trading partner agreements. Supported Protocols 3-9 Exchange Protocols RNIF specifies the envelope or container format that remains constant when exchanging business documents (the payloads), whereas the document exchange choreography and the XML schemas vary based on which PIP and document type are used. The RNIF envelope format is also independent of the specific transfer protocol you use. OracleAS Integration B2B supports RNIF revisions 1.1 and 2.0. RNIF 2.0 does not include the proprietary aspects of RNIF 1.1, and adds support for multiple transfer protocols, hub-based routing, attachments, payload encryption, and more. See http://www.rosettanet.org for the white paper (in PDF) "RosettaNet Implementation Framework (RNIF) 2.0: Benefits of RNIF 2.0 and Comparison to RNIF 1.1" for a thorough discussion of the two versions AS2 AS2 is a specification for using EDI over the Internet. AS2 provides S/MIME encryption and security over HTTP or HTTPS. AS2 works with non-EDI document types such as .xml, .txt, .doc, and .xls. AS2 is also called EDI over the Internet, or EDIINT AS2. AS2 interoperability is certified in OracleAS Integration B2B. You can see how an EDI over the Internet (AS2) transaction is created in "Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction" on page 5-40. See Chapter 9, "Creating Trading Partners" for information about digital signatures, encryption, and signing credentials Generic Using the Generic option, you can send messages with or without security, using any of the transport protocols listed in Table 3–1 on page 3-2. The Generic exchange protocol supports MIME and S/MIME, including S/MIME 3.0-based signing and encryption. There is no receipt acknowledgment support with the Generic exchange protocol (acknowledgment mode must be set to None on the Delivery Channel page of the Create Trading Partner wizard). MLLP Minimum Lower Layer Protocol (MLLP) is used with HL7 or Custom documents. When using this protocol, you can identify the remote trading partner at the MLLP exchange level by creating a new MLLP Trading Partner Identification Type, or you can identify the remote trading partner at the document level. See "Setting Up the Remote Trading Partner (GlobalChips)" on page 6-6 for an example of creating an MLLP ID. ebMS Electronic business Extensible Markup Language (ebXML) Messaging Service (ebMS) is used to exchange XML documents. ebMS is built on a SOAP Web services message format. OracleAS Integration B2B implements ebMS 1.0 and 2.0 and uses the HTTP, HTTPS, and Email transport protocols and the SOAP packaging protocol. The ebMS protocol supports correlation between documents. OracleAS Integration B2B also supports XMLDSig, XML Encrypt, and gZip-based compression for large documents. ebMS interoperability is certified. 3-10 Oracle Application Server Integration B2B User’s Guide Process Protocols Process Protocols The process protocol defines how documents are exchanged. OracleAS Integration B2B supports complex processes such the RosettaNet PIP or simple processes, such as exchanging a single EDI business action. OracleAS Integration B2B provides the B2B process protocol, which is included with all business protocols supported in OracleAS Integration B2B. The B2B process protocol defines the business actions (for EDI or Custom Document business protocols) and the collaborations (for the RosettaNet over RNIF business protocol) that are associated with specific document types. See the following for more information: ■ ■ Figure 8–7, "Process Protocol Management Tasks for any EDI, HL7, or Custom Document Business Protocol" on page 8-19 for an example of business actions defined for the B2B process protocol Figure 8–8, "Process Protocol Management Tasks for the RosettaNet over RNIF Business Protocol" on page 8-20 for an example of collaborations defined for the B2B process protocol PIPs A PIP is an XML-based dialog that defines the business processes between trading partners. It defines the structure, sequence of steps, roles (buyer and seller) activities, data elements, values, and value types for each business document message exchanged between trading partners. PIPs bundle the steps of the business process together. You can see this in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction" on page 5-5, in which only a few steps are needed to associate the buyer and seller (trading partners) with the 3A4 collaboration. Using PIP 3A4 as an example, you can see how a PIP defines a dialog between trading partners, as shown in Figure 3–2. The figure shows how the PIP 3A4 messages are exchanged between buyer and seller. Figure 3–2 PIP 3A4 Message Exchange Buyer Seller Purchase Order Request Receipt Acknowledgment Purchase Order Confirmation Receipt Acknowledgment A PIP sequence combines a cluster, segment, and type. The PIP sequence 3A4, for example, encodes the information shown in Table 3–7. Supported Protocols 3-11 Business Protocols Table 3–7 PIP 3A4 Breakdown Element Description 3 Order manage cluster, which lets trading partners: ■ Order catalog products ■ Create custom orders ■ Manage product distribution and delivery ■ Support product returns and financial transactions 3A Quote and order entry segment 3A4 Specific PIP type, which supports: ■ Submittal of a purchase order by a buyer ■ Submittal of an acceptance purchase order by a seller ■ Ability of a buyer to cancel or change a purchase order based on the acknowledgment response See the following for more information: ■ Table 3–2 on page 3-4 for a list of PIPs supported in OracleAS Integration B2B ■ http://www.rosettanet.org for a complete list of PIP clusters and segments Business Protocols OracleAS Integration B2B provides business protocols, which bundle common message exchange options. The business protocols capture combinations needed to integrate typical B2B scenarios. Each business protocol combines a document protocol, an exchange protocol, and the B2B process protocol. OracleAS Integration B2B provides the following business protocols: ■ Custom Document over Generic Exchange ■ Custom Document over Internet ■ Custom Document over MLLP Exchange ■ Custom Document over ebMS ■ EDI EDIFACT over Generic Exchange ■ EDI EDIFACT over Internet ■ EDI X12 over Generic Exchange ■ EDI X12 over Internet ■ HL7 over Generic Exchange ■ HL7 over MLLP Exchange ■ RosettaNet over RNIF You can see this list by clicking Partners, then Protocols. The business protocols are flexible. After you select a business protocol, you have choices as you define the operational capability and communication capabilities of the business protocol of the remote trading partner and the communication capabilities of the host trading partner. See "Business Protocol Management Overview" on page 8-1 3-12 Oracle Application Server Integration B2B User’s Guide Summary Mix and Match Protocols OracleAS Integration B2B is flexible in how you mix and match protocols (described in Table 3–1 on page 3-2) and in allowing you to create your own custom documents. For example, you can create the following: ■ ■ ■ A custom XML document sent over HTTP or SMTP, with encryption and compression options An EDI transaction set sent using FTP, with encryption An EDI X12 transaction set sent over AS2, with signing, compression, and encryption options ■ A RosettaNet document sent over RNIF 1.1 or RNIF 2.0, with signing ■ A UCCnet document sent over AS2 See Chapter 8, "Managing Business Protocols" for the options that are available as you create business actions and collaborations for a business protocol. Summary This chapter describes the support OracleAS Integration B2B offers for standard B2B protocols such as RosettaNet, EDI X12, EDI EDIFACT, HL7, AS2, and UCCnet. The document, exchange, and process protocols are described, as well as the business protocol, which is a combination of the protocols. It also describes options for using Custom Documents to mix and match protocols. Supported Protocols 3-13 Summary 3-14 Oracle Application Server Integration B2B User’s Guide 4 Communicating with Host Trading Partner Applications OracleAS Integration B2B communicates with the back-end applications of the host trading partner—host applications—by using internal delivery channels. This chapter provides an overview of the predefined internal delivery channels available with OracleAS Integration B2B. This chapter contains the following topics: ■ Internal Delivery Channels in OracleAS Integration B2B ■ Integrations with OracleAS Integration InterConnect ■ Integrations with Oracle E-Business Suite ■ Integrations with Oracle BPEL Process Manager ■ Integrations with Host Applications ■ Summary See "Managing Internal Delivery Channels" on page 10-30 for details on creating an internal delivery channel. Internal Delivery Channels in OracleAS Integration B2B OracleAS Integration B2B provides the following predefined internal delivery channels to communicate with a host application. ■ ■ B2B Outbound and B2B Inbound—internal delivery channels for OracleAS Integration InterConnect and Oracle BPEL Process Manager XML Gateway Outbound and XML Gateway Inbound—internal delivery channels for Oracle E-Business Suite You use these predefined internal delivery channels in integration configurations in which OracleAS Integration InterConnect, Oracle E-Business Suite, or Oracle BPEL Process Manager is used. You use user-defined internal delivery channels to communicate with other host applications. The user-defined internal delivery channels use Oracle AQ, JMS, File or FTP queues. When using either predefined or user-defined internal delivery channels, you select the channel to use with your host application when you create a trading partner agreement. ■ "Managing Internal Delivery Channels" on page 10-30 Communicating with Host Trading Partner Applications 4-1 Integrations with OracleAS Integration InterConnect ■ "Creating a Trading Partner Agreement" on page 12-5 for information on selecting an internal delivery channel Integrations with OracleAS Integration InterConnect OracleAS Integration B2B provides the following internal delivery channels to communicate with OracleAS Integration InterConnect: ■ ■ B2B Inbound—this channel enables communication between the host application and OracleAS Integration B2B upon receipt of inbound messages from the remote trading partner. B2B Outbound—this channel enables communication between the host application and OracleAS Integration B2B to send outbound messages to the remote trading partner. By default, the B2B Inbound internal delivery channel connects to the IP_IN_QUEUE queue and the B2B Outbound internal delivery channel connects to the IP_OUT_ QUEUE queue. These queues are defined as follows: ■ ■ IP_IN_QUEUE—queue on which OracleAS Integration B2B (target) receives messages and publishes to OracleAS Integration InterConnect. IP_OUT_QUEUE—queue on which OracleAS Integration B2B (source) publishes messages that are received from OracleAS Integration InterConnect. OracleAS Integration InterConnect transforms message formats when the host and remote trading partner applications use different business document formats. The Oracle Advanced Queuing (AQ) adapter of OracleAS Integration InterConnect uses IP queues to send messages to and receive messages from OracleAS Integration B2B. You should set up the OracleAS Integration InterConnect AQ adapter to listen on IP_IN_ QUEUE, with the consumer name of the AQ adapter set to b2buser, as in aq_ bridge_consumer_name=b2buser. When AQ is listening on IP_OUT_QUEUE for a message sent by OracleAS Integration B2B, AQ must be set to publish. This publishes the message to the hub queue of OracleAS Integration InterConnect. OracleAS Integration B2B processes all exchange protocol specific headers and enqueues the payload, along with a few attributes, to the IP queue. OracleAS Integration InterConnect picks up the message from the queue and transforms it, first to the common view, and then to the final format, and sends it to the host application. For OracleAS Integration InterConnect to recognize an incoming AQ message from OracleAS Integration B2B, the incoming AQ message structure must mirror the IP_ IN_QUEUE structure. For OracleAS Integration B2B to recognize an outgoing AQ message from OracleAS Integration InterConnect, the outgoing AQ message structure must mirror the IP_OUT_QUEUE structure. In the case of IP_OUT_QUEUE, the message is coming from OracleAS Integration InterConnect to OracleAS Integration B2B, but it is an outbound message—going out from the application to the trading partner. These two queues, IP_IN_QUEUE and IP_OUT_QUEUE, contain the IP_MESSAGE_ TYPE object, which is described in Table 4–1 and provided as reference information. 4-2 Oracle Application Server Integration B2B User’s Guide Integrations with OracleAS Integration InterConnect Table 4–1 IP_MESSAGE_TYPE Parameters Name Description Type MSG_ID A unique identification for the message. VARCHAR2(128) ■ ■ INREPLYTO_MSG_ID For inbound messages, assigned by the trading partner For outbound messages, assigned as part of the middleware process The ID of the message that replies to MSG_ID. ■ Assigned to null if the middleware initiated the message ■ Assigned to MSG_ID when in response to a previous message The trading partner that sends the message. FROM_PARTY ■ ■ ■ ■ VARCHAR2(512) If the middleware initiates the message, assigned to the host trading partner If the messages is a response, assigned to TO_PARTY The trading partner that receives the message. TO_PARTY VARCHAR2(128) VARCHAR2(512) If the middleware initiates the message, assigned to the remote trading partner If the message is a response, assigned to FROM_PARTY ACTION_NAME The business action that defines the document. Can be null. VARCHAR2(512) DOCTYPE_NAME The document type as defined in OracleAS Integration B2B; for example, 850. VARCHAR2(512) DOCTYPE_REVISION The document revision as defined in OracleAS Integration B2B; for example, 4010. VARCHAR2(512) MSG_TYPE The type of message, for example, a response or a request message. Required. Supported values are: NUMBER(38) 0 INVALID 1 REQUEST 2 RESPONSE 3 ACKNOWLEDGMENT 4 IN_BAND_EXCEPTION 5 OUT_OF_BAND_EXCEPTION 6 STATUS_REQUEST 7 STATUS_RESPONSE 8 PULL 9 FUNCTIONAL_ACK 99 OTHER PAYLOAD Message payload. CLOB ATTACHMENT Attachment (optional). BLOB OracleAS Integration B2B provides the following options to enqueue and dequeue messages to and from internal delivery channels: ■ ■ Java commands to enable enqueuing to IP_OUT_QUEUE and dequeuing from IP_ IN_QUEUE PL/SQL scripts to enable enqueuing and dequeuing to and from B2B queues See Chapter 16, "Utilities for Enqueuing and Dequeuing" for details. Communicating with Host Trading Partner Applications 4-3 Integrations with Oracle E-Business Suite Integrations with Oracle E-Business Suite OracleAS Integration B2B provides the following internal delivery channels to communicate with Oracle E-Business Suite: ■ ■ XML Gateway Inbound—this channel enables communication between the host application and OracleAS Integration B2B upon receipt of inbound messages from the remote trading partner. XML Gateway Outbound—this channel enables communication between the host application and OracleAS Integration B2B to send outbound messages to the remote trading partner. For example, the host trading partner running the Oracle E-Business Suite iProcurement application can send its purchase order request to a remote trading partner using the secure and reliable B2B connectivity of OracleAS Integration B2B. Figure 4–1 shows how OracleAS Integration B2B, using one of the exchange protocols, conducts B2B transactions between a trading partner and Oracle E-Business Suite. Figure 4–1 Using OracleAS Integration B2B with Oracle E-Business Suite Oracle E-Business Suite Internet Order Procurement Management Supply Chain Trading Connector ... XML Gateway RN or UCCnet RN or UCCnet OracleAS Integration B2B · RosettaNet · AS2 · Generic (HTTP, SMTP/IMAP, FTP/File) Internet Trading Partners By default, the XML Gateway Inbound internal delivery channel connects to the ECX_ INQUEUE queue and the XML Gateway Outbound internal delivery channel connects to the ECX_OUTQUEUE queue. These two queues, ECX_INQUEUE and ECX_OUTQUEUE, contain the SYSTEM.ECXMSG message type, which is described in Table 4–2 and provided as reference information. 4-4 Oracle Application Server Integration B2B User’s Guide Integrations with Oracle BPEL Process Manager Table 4–2 SYSTEM.ECXMSG Parameters Name Type MESSAGE_TYPE VARCHAR2(2000) MESSAGE_STANDARD VARCHAR2(2000) TRANSACTION_TYPE VARCHAR2(2000) TRANSACTION_SUBTYPE VARCHAR2(2000) DOCUMENT_NUMBER VARCHAR2(2000) PARTYID VARCHAR2(2000) PARTY_SITE_ID VARCHAR2(2000) PARTY_TYPE VARCHAR2(2000) PROTOCOL_TYPE VARCHAR2(2000) PROTOCOL_ADDRESS VARCHAR2(2000) USERNAME VARCHAR2(2000) PASSWORD VARCHAR2(2000) PAYLOAD CLOB ATTRIBUTE1 VARCHAR2(2000) ATTRIBUTE2 VARCHAR2(2000) ATTRIBUTE3 VARCHAR2(2000) ATTRIBUTE4 VARCHAR2(2000) ATTRIBUTE5 VARCHAR2(2000) See Oracle Applications Concepts, available at http://download-west.oracle.com/docs/cd/B12190_ 11/current/html/docset.html, for information about the E-Business Suite Home page, new in Release 11i. Integrations with Oracle BPEL Process Manager OracleAS Integration B2B provides the following internal delivery channels to communicate with Oracle BPEL Process Manager: ■ ■ B2B Inbound—this channel enables communication between the host application and OracleAS Integration B2B upon receipt of inbound messages from the remote trading partner. B2B Outbound—this channel enables communication between the host application and OracleAS Integration B2B to send outbound messages to the remote trading partner. The B2B Inbound internal delivery channel connects to the IP_IN_QUEUE queue and the B2B Outbound internal delivery channel connects to the IP_OUT_QUEUE queue. These queues are defined as follows: ■ ■ IP_IN_QUEUE—queue on which OracleAS Integration B2B (target) receives messages and publishes to Oracle BPEL Process Manager. IP_OUT_QUEUE—queue on which OracleAS Integration B2B (source) publishes messages that are received from Oracle BPEL Process Manager. Communicating with Host Trading Partner Applications 4-5 Integrations with Oracle BPEL Process Manager When you configure OracleAS Integration B2B to communicate with Oracle BPEL Process Manager, you follow the typical process flow in the user interface: ■ Create the business action ■ Set up the host and remote trading partner ■ Create the trading partner agreement ■ Validate and deploy the trading partner agreement OracleAS Integration B2B collaborations and business actions represent the document revision, document type, and document definition that are exchanged with the trading partner and Oracle BPEL Process Manager. Note: As part of your Oracle BPEL Process Manager postinstallation procedures, ensure that you have entered 127.0.0.1 in the Exceptions field in your Web browser preferences. See Oracle BPEL Process Manager Quick Start Guide for instructions on setting the hostname in your Web browser preferences. Messages All inbound and outbound messages include the AQ header, IP_MESSAGE_TYPE, and the document payload. This provides the information needed for routing. For outbound messages, IP_MESSAGE_TYPE must be populated to route the document to the trading partner. See Table 4–1 on page 4-3 for all the parameters of IP_MESSAGE_TYPE. Headers The following AQ header parameters provide routing information: ■ PRIORITY ■ CORRELATION ■ ATTEMPTS ■ ENQUEUETIME ■ ORIGMESSAGEID The following IP_MESSAGE_TYPE parameters provide information for OracleAS Integration B2B to route the document to the appropriate trading partner. ■ MSG_ID ■ INREPLYTO_MSG_ID ■ FROM_PARTY ■ TO_PARTY ■ ACTION_NAME ■ DOCTYPE_NAME ■ DOCTYPE_REVISION The Payload The OracleAS Integration B2B document type defines the payload, which is defined in the PAYLOAD parameter of IP_MESSAGE_TYPE. 4-6 Oracle Application Server Integration B2B User’s Guide Integrations with Oracle BPEL Process Manager Internal Delivery Channels OracleAS Integration B2B supports the following user-defined internal delivery channels: ■ Oracle AQ ■ JMS queues ■ File ■ FTP See "Managing Internal Delivery Channels" on page 10-30 for details on defining an internal delivery channel. Configuring OracleAS Integration B2B Before you configure and deploy a trading partner agreement, ensure that oracle.tip.adapter.b2b.DocumentRouting is set to true. This parameter is found in the following OracleAS Integration B2B installation directory: Oracle_Home\ip\config\tip.properties A UUID is automatically generated for Document Routing ID in the Document Protocol Parameter. This UUID is used as a recipient/consumer for AQ so that the BPEL AQ adapter is able to pick up the corresponding message. The B2B WSIL Browser The B2B WSIL Browser enables B2B-BPEL interoperability. It is in B2B-BPEL.zip in the following OracleAS Integration B2B installation directory: Oracle_Home\ip\install See README.txt, located in B2B-BPEL.zip, for instructions on installing the B2B WSIL Browser. The B2B WSIL Browser automates the configuration of the B2B connection and is invoked using the WSIF browser, which enables the B2B repository to be checked for deployed documents. The B2B WSIL Browser does the following: ■ Creates a WSDL for retrieving a deployed document (for example, 850) ■ Uses the default Oracle queues ■ Uses an AQ consumer for the document type selected ■ ■ Uses an XML schema corresponding to the deployed document (for example, 850.xsd) Uses IP_MESSAGE_TYPE as the AQ header (In JDeveloper BPEL Designer, variables are assigned to the AQ header message type header_msg and to the payload message type document_msg.) Note: ■ ■ The B2B WSIL Browser does not support nested XSDs. Use the AQ adapter for document types with nested XSDs. The B2B WSIL Browser can be configured for one OracleAS Integration B2B instance only. Communicating with Host Trading Partner Applications 4-7 Integrations with Oracle BPEL Process Manager Configuring Oracle BPEL Process Manager To configure Oracle BPEL Process Manager to communicate with OracleAS Integration B2B, you do the following: ■ Create a partner link ■ Use the B2B WSIL Browser to browse the B2B document types To invoke the B2B WSIL Browser, click the WSIL Browser icon (second from the left), as shown in Figure 4–2. Figure 4–2 Create Partner Link Window To access B2B document types and generate a WSDL file for each document type that is deployed on the B2B server, navigate in the WSDL Chooser window as follows: Click Adapters, then B2B, and then navigate through the document protocol, document protocol revision, document type, and document definition, as shown in Figure 4–3. 4-8 Oracle Application Server Integration B2B User’s Guide Integrations with Oracle BPEL Process Manager Figure 4–3 Oracle BPEL Process Manager WSDL Chooser The WSDL Chooser displays only documents that have been deployed on the B2B Server. Selecting a document type generates a WSDL URL. In the example shown in the figure, selecting Acme_CONTROL generates the following WSDL URL: http://127.0.0.1:9700/BPELConsole/wsil/adapters/B2B/EDI_EDIFACT/EDIFACT_ D3-D3/CONTRL/Acme_CONTROL?wsdl After the document is selected, you are returned to the Create Partner Link window. The WSDL file and Partner Link Type sections are populated. To send an outbound document from the BPEL Engine to the B2B Server, you must populate partnerRole with the B2BSend_% role. For the preceding example shown Figure 4–3, partnerRole will be B2BSend_CONTROL_EDIFACT_D3-D3. To receive an inbound document from the B2B Server to the BPEL Engine, you must populate myRole with the B2BReceive_% role. For the preceding example shown in Figure 4–3, myRole will be B2BReceive_CONTROL_EDIFACT_D3-D3. You must populate either partnerRole or myRole. Do not populate both or leave both unpopulated. Note: You must modify the oc4j-ra.xml file to set the database server location (JNDI) to eis/b2b. Changes to oc4j-ra.xml require restarting the application server. Oracle BPEL Process Manager Adapters Oracle BPEL Process Manager provides the following adapters for interoperability with OracleAS Integration B2B: ■ Oracle AQ adapter Communicating with Host Trading Partner Applications 4-9 Integrations with Oracle BPEL Process Manager ■ – The B2B WSIL uses these default queues and is the recommended method. – You can configure the adapter manually to enqueue and dequeue documents from OracleAS Integration B2B – Trading partner information is defined in IP_MESSAGE_TYPE JMS adapter The JMS header and properties define the trading partner information ■ File/FTP adapter Trading partner information is defined in the file names. See Oracle Adapters for Files, FTP, Databases, and Enterprise Messaging User’s Guide for more information about specific adapters. Message Correlation In OracleAS Integration B2B, a transaction typically contains only one message. Messages are automatically correlated by virtue of the business protocol being used. For example, RosettaNet supports correlation between documents through the PIPs. See the following for more information about message correlation: ■ "RosettaNet" on page 3-4 ■ "EDI X12" on page 3-6 ■ "ebMS" on page 3-10 In Oracle BPEL Process Manager, messages are correlated based on correlation sets. Oracle BPEL Process Manager uses the MSG_ID and INREPLYTO_MSG_ID parameters of IP_MESSAGE_TYPE to correlate messages. For example, assume that Acme and GlobalChips exchange purchase order information using the EDI X12 over Internet (AS2) business protocol, as shown in Figure 4–4. GlobalChips initiates the transaction by sending the inbound purchase order. Acme receives the purchase order and responds with an outbound purchase order acknowledgment. In OracleAS Integration B2B, you define the EDI X12 4010, 850, and 855 documents, the AS2 exchange, the remote trading partner, and the trading partner agreement. In Oracle BPEL Process Manager, you define a correlation set between the purchase order and the purchase order acknowledgment using the purchase order number. MSG_ID of the inbound purchase order is assigned to INREPLYTO_MSG_ID of the outbound purchase order acknowledgment. See Oracle BPEL Process Manager Developer’s Guide for more information. 4-10 Oracle Application Server Integration B2B User’s Guide Integrations with Host Applications Figure 4–4 Message Correlation in OracleAS Integration B2B and Oracle BPEL Process Manager Application Oracle BPEL Process Manager OracleAS Integration B2B Purchase Order Request Purchase Order Request Application Trading Partner Receipt Acknowledgment Internet Purchase Order Confirmation Purchase Order Confirmation Receipt Acknowledgment Moving a BPEL Project (with B2B Integration) from Test to Production Environments If you installed Oracle BPEL Process Manager for Developers for design and test purposes (test environment), and plan to port your BPEL project to a Oracle BPEL Process Manager for OracleAS Middle Tier installation (production environment), then do the following: ■ ■ Install Oracle BPEL Process Manager for OracleAS Middle Tier and OracleAS Integration B2B on the same production server so that you do not have to change the URL to access B2B documents. (You can deploy the BPEL process in the test environment using the URL to the production server to access B2B documents.) Install the B2B WSIL Browser in the production environment of Oracle BPEL Process Manager. See the following for more information: ■ ■ "The B2B WSIL Browser" on page 4-7 The README.txt file in B2B-BPEL.zip, located in the OracleAS Integration B2B installation directory When you build a BPEL project during design time, you configure the B2B document using the B2B WSIL Browser in the OracleAS middle-tier environment. When you deploy the BPEL project for run-time testing, you deploy it to the test environment. When you are ready for production, deploy the same BPEL project to the OracleAS middle-tier environment (production environment). No changes are required in the BPEL project file with respect to the B2B partner link because you have already configured for the B2B document using the B2B WSIL Browser in the OracleAS middle-tier environment. Integrations with Host Applications You can define JMS, AQ, File, and FTP queues to communicate with host trading partner applications by defining your own internal delivery channels. You use user-defined internal delivery channels in integration configurations in which OracleAS Integration InterConnect or another transformation tool is not used. You also create a callout and callout usages. See "Creating an Internal Delivery Channel" on page 10-33 and "Example: Creating an Internal Delivery Channel Using the JMS Transport Protocol" on page 10-37 for more information. Communicating with Host Trading Partner Applications 4-11 Overview of Callouts Overview of Callouts Consider the example of a remote trading partner who sends a RosettaNet XML-formatted purchase order request to the host trading partner. The host trading partner application is an Oracle E-Business Suite application that does not understand RosettaNet XML-formatted messages. To enable communication between these two different formats, you create a callout that consists of callout usages. In this example, one callout usage transforms the RosettaNet XML-formatted purchase order request into an Oracle E-Business Suite XML format understood by the Oracle E-Business Suite application. Oracle E-Business Suite application, in turn, responds to the request message with a purchase order acceptance message in Oracle E-Business Suite XML format. This message is transformed by another callout usage back into a RosettaNet XML-formatted message for the remote trading partner. You create two separate internal delivery channels for these messages: ■ One for the initiating purchase order request ■ One for the responding purchase order acceptance When you create a trading partner agreement between the host and remote trading partners, you associate the initiating internal delivery channel with the initiating callout usage that transforms the purchase order request from RosettaNet XML to Oracle E-Business Suite XML. You also associate the responding internal delivery channel with the responding callout usage that transforms the purchase order acceptance from Oracle E-Business Suite XML to RosettaNet XML. By default, the initiating internal delivery channel and callout usage are available for selection when you create a trading partner agreement. If you also want a responding internal delivery channel and responding callout usage to be available for selection, you must select Yes from the Is acknowledgement handled By Integration B2B? list on the Create Trading Partner - Operational Capability page or Create Supported Collaboration Role page when you create a trading partner. See Chapter 11, "Managing Callouts" for more information. Summary This chapter describes how OracleAS Integration B2B communicates with host applications through the following internal delivery channels: B2B Inbound, B2B Outbound, XML Gateway Inbound, and XML Gateway Outbound. 4-12 Oracle Application Server Integration B2B User’s Guide Part II Tutorials This part provides tutorials that guide you through the steps to design, deploy, and verify B2B scenarios. This part contains the following chapters: ■ Chapter 5, "Purchase Order Tutorials" ■ Chapter 6, "Health Care Tutorial" ■ Chapter 7, "Custom XML Document Tutorial" 5 Purchase Order Tutorials The OracleAS Integration B2B tutorials guide you through the steps to design, deploy, and verify B2B scenarios. After using these tutorials, you should be able to create and deploy your own RosettaNet, EDI EDIFACT,or EDI X12. This chapter contains the following topics: ■ About the OracleAS Integration B2B Tutorials ■ Before You Begin the Tutorials ■ Tutorial 1: Setting Up a RosettaNet over the Internet Transaction ■ Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction ■ Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction ■ Using the EMail Transport Protocol ■ Doing More Than One Tutorial ■ Summary About the OracleAS Integration B2B Tutorials The tutorials use one business scenario to demonstrate three different industry-standard protocols: ■ Tutorial 1: RosettaNet over the Internet ■ Tutorial 2: EDI EDIFACT over Generic (VAN) ■ Tutorial 3: EDI X12 over Internet (Applicability Statement 2) Business Scenario The tutorials depict B2B transactions between two U.S.-based organizations, GlobalChips and Acme. GlobalChips supplies components to the buyer, Acme. In the past, GlobalChips and Acme used EDI X12 over a value-added network (VAN) for their electronic ordering process. However, under pressure from competition and strategic buyers like Acme, whose European and Asian distributors use RosettaNet and EDI EDIFACT, GlobalChips needs an enterprise B2B solution that supports an array of e-business standards. GlobalChips selected OracleAS Integration B2B as its enterprise B2B solution based on the following criteria: ■ Quick installation and setup ■ Multiprotocol support—RosettaNet, EDI EDIFACT, and EDI X12 Purchase Order Tutorials 5-1 About the OracleAS Integration B2B Tutorials ■ Multiplatform support—Windows, Solaris, Linux, and HP-UX ■ Multilanguage support ■ Comprehensive global trading partner management ■ Real-time trading partner exchange monitoring ■ Scalability and high availability to support 24x7 business operations ■ Ability to continue using EDI over VAN where needed ■ Secure implementation of a B2B gateway, with flexibility to comply with evolving corporate policies GlobalChips is prepared for global business using OracleAS Integration B2B, as shown in Figure 5–1. Figure 5–1 GlobalChips Uses OracleAS Integration B2B Oracle Application Server Integration B2B at GlobalChips (Seller) Acme - Asia (Buyer) Acme - Europe (Buyer) EDIFACT ORDERS (PO) PIP 3A4 (PO) EDI EDIFACT over Generic (VAN) RosettaNet over RNIF EDIFACT ORDRSP (POA) PIP 3A4 (POA) EDI X12 over Internet (AS2) X12 850 (PO) X12 855 (POA) Acme - U.S. (Buyer) Note: For this tutorial, you set up OracleAS Integration B2B on servers at both Acme and GlobalChips "sites;" that is, on: ■ ■ The Acme server, where Acme is the host trading partner and GlobalChips is the remote trading partner. The GlobalChips server, where GlobalChips is the host trading partner and Acme is the remote trading partner. With this setup, you can verify that the purchase orders, acknowledgments, and purchase order confirmations are actually sent and received. On both servers, Acme is the buyer and GlobalChips is the seller. Business Scenario Workflow in the Tutorials The tutorials assume the following purchase order workflow from the business scenario: 5-2 1. Acme sends a purchase order request to GlobalChips. 2. GlobalChips sends an acknowledgment of the purchase order to Acme. Oracle Application Server Integration B2B User’s Guide Before You Begin the Tutorials 3. GlobalChips sends a purchase order confirmation to Acme. 4. Acme sends an acknowledgment of the purchase order confirmation to GlobalChips. Before You Begin the Tutorials It is strongly recommended that you complete at least one tutorial. The tutorials are independent of each other, so you can do tutorial 3 without doing tutorial 1. If you work with a partner, one person can set up the seller side and the other the buyer side. With this setup, you can verify that the messages are actually sent and received. If you want to do more than one tutorial, see "Doing More Than One Tutorial" on page 5-61 for more information. Before you begin a tutorial, see the following sections: ■ "Installing OracleAS Integration B2B" on page 5-3 ■ "Setting Up the CLASSPATH Environment" on page 5-3 ■ "Logging In to OracleAS Integration B2B" on page 5-3 ■ "Changing the Host Trading Partner Name" on page 5-4 Also note the location of configuration and run-time files that are used in the tutorials, as described in: ■ "Location of Run-Time and Configuration Files Used in the Tutorials" on page 5-4 Installing OracleAS Integration B2B The tutorials assume that you have installed OracleAS Integration B2B. See OracleAS Integration B2B Installation Guide at http://www.oracle.com/technology/documentation/appserver101202.html Setting Up the CLASSPATH Environment You must set up the CLASSPATH environment before running these tutorials. Based on your operating system, complete the steps in the following table. On UNIX platforms, you must grant execute permission using chmod +x to run the scripts. If Using... Follow These Steps... Solaris or Linux 1. Open a Bourne shell, Korn shell, or C shell. (If you use a different shell, first edit the script described in Step 2 to execute properly in your shell environment.) 2. Run one of the following scripts: In a Bourne or Korn shell—Oracle_Home/ip/install/setenv.sh Windows 3. Ensure that you remain in this shell. The setenv script sets up the required CLASSPATH environment for running enqueue and dequeue scripts later in these tutorials. Switching to a different shell causes these scripts to fail. 1. Run the following script: Oracle_Home\ip\install\setenv.bat Logging In to OracleAS Integration B2B In a browser (Microsoft Internet Explorer 6 or Mozilla Firefox 1.0.4), do the following: Purchase Order Tutorials 5-3 Before You Begin the Tutorials 1. Connect to OracleAS Integration B2B at http://hostname:port/b2b. This connection information is also provided in ipsetupinfo.txt in your Oracle_Home installation directory. 2. For username, enter admin. 3. For password, enter the password that you used with the ias_admin username during J2EE and Web Cache and OracleAS Integration B2B installations. 4. Click Login. Changing the Host Trading Partner Name Change the host trading partner name (created at installation) to the name used in the tutorials. 1. Click Partners, then Trading Partners. 2. For MyCompany (Host), click Update. 3. If you are on the Acme server, enter Acme in place of MyCompany. If you are on the GlobalChips server, enter GlobalChips in place of MyCompany. 4. Click Apply. Location of Run-Time and Configuration Files Used in the Tutorials Table 5–1 lists the files in Oracle_Home/ip/tutorial/protocolname. You use these files to verify the purchase order transaction in task 5 of each tutorial. Note: The path name delimiter used in this documentation, /, is for UNIX. If you are using Windows, assume that the path name delimiter is \. 5-4 Oracle Application Server Integration B2B User’s Guide Tutorial 1: Setting Up a RosettaNet over the Internet Transaction Table 5–1 Run-Time and Configuration Files Used in the Tutorials Tutorial Run-Time Files Configuration Files 1 RosettaNet over Internet 3a4_req.xml 3A4_MS_V02_02_ PurchaseOrderRequest.dtd 3a4_rsp.xml deq.sh deq.csh deq.bat 3A4_MS_V02_02_ PurchaseOrderConfirmation.dtd RN_buyer_export.xml RN_seller_export.xml enq_3a4_req.sh enq_3a4_req.bat enq_3a4_req.properties enq_3a4_rsp.sh enq_3a4_rsp.csh enq_3a4_rsp.bat enq_3a4_rsp.properties ipdequeue.properties 2 EDI EDIFACT over Generic (VAN) Acme_orders.xml contrl.ecs GlobalChips_ordrsp.xml contrl.xsd deq.sh orders.ecs deq.bat orders.xsd enq_orders.sh ordrsp.ecs enq_orders.bat ordrsp.xsd enq_orders.properties EDIFACT_buyer_export.xml enq_ordrsp.sh EDIFACT_seller_export.xml enq_ordrsp.bat enq_ordrsp.properties ipdequeue.properties 3 EDI X12 over Internet (AS2) Acme_850.xml 850.ecs GlobalChips_855.xml 850.xsd deq.sh 855.ecs deq.bat 855.xsd enq_850.sh 997.ecs enq_850.bat 997.xsd enq_850.properties X12_buyer_export.xml enq_855.properties X12_seller_export.xml enq_855.sh enq_855.bat ipdequeue.properties Tutorial 1: Setting Up a RosettaNet over the Internet Transaction In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server. One person does the following tasks: Purchase Order Tutorials 5-5 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction ■ Acme Server, Task 1: Creating the Collaboration ■ Acme Server, Task 2: Setting Up the Trading Partners ■ Acme Server, Task 3: Creating the Trading Partner Agreement ■ Acme Server, Task 4: Creating and Deploying the Configuration In parallel, another person does the following tasks: ■ GlobalChips Server, Task 1: Creating the Collaboration ■ GlobalChips Server, Task 2: Setting Up the Trading Partners ■ GlobalChips Server, Task 3: Creating the Trading Partner Agreement ■ GlobalChips Server, Task 4: Creating and Deploying the Configuration After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5: ■ Both Servers, Task 5: Verifying the Purchase Order Transaction Note: Fields and checkboxes for which you should accept default values, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly. The RosettaNet transaction between Acme and GlobalChips is depicted in Figure 5–2. Figure 5–2 Tutorial 1 RosettaNet Transaction: Acme Is the Buyer and GlobalChips Is the Seller Oracle Application Server Integration B2B at GlobalChips (Seller) Oracle Application Server Integration B2B at Acme - Asia (Buyer) PIP 3A4 (PO) RosettaNet over RNIF PIP 3A4 (POA) Acme Server, Task 1: Creating the Collaboration In the following set of tasks, Acme is the host trading partner. You create one collaboration, PIP 3A4, which has the following business actions: ■ The purchase order request—from Acme to GlobalChips ■ The purchase order confirmation—from GlobalChips to Acme Because the acknowledgments are a part of PIP 3A4, you do not have to create them. See "Creating a Collaboration" on page 8-27 for more information. Creating the 3A4 Collaboration 5-6 1. Click Partners, then Protocols. 2. Click RosettaNet over RNIF. 3. From Shortcut, click Create Collaboration. Oracle Application Server Integration B2B User’s Guide Tutorial 1: Setting Up a RosettaNet over the Internet Transaction The following workflow for creating a collaboration is shown at the top of the page: General 4. Business Transaction Requesting Business Action Responding Business Action (Optional) On the Create Collaboration: General page, provide the following information and click Next. Field Value Name 3A4 Revision V02.00 Initiating Role Name Buyer Accepting Role Name Seller 5. Review On the Create Collaboration: Business Transaction page, provide the following information and click Next. Field Value Name Request Purchase Order Revision V02.00 6. On the Create Collaboration: Requesting Business Action page, provide the following information and click Next. Field Value Protocol Action Name Purchase Order Request Action Response Mode Async Requesting Business Action Field Value Create Mode Create New Name Purchase Order Request Action Revision V02.00 Acknowledgement Mode Async Document Type Field Value Name Pip3A4PurchaseOrderRequest Revision V02.00 Document Definition Field Value Name Request Purchase Order Definition Purchase Order Tutorials 5-7 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction Document Definition Field Value Definition 3A4_MS_V02_02_PurchaseOrderRequest.dtd 7. On the Create Collaboration: Responding Business Action page, provide the following information and click Next. Field Value Protocol Action Name Purchase Order Confirmation Action Responding Business Action Field Value Create Mode Create New Name Purchase Order Confirmation Action Revision V02.00 Document Type Field Value Name Pip3A4PurchaseOrderConfirmation Revision V02.00 Document Definition Field Value Name Purchase Order Confirmation Definition Definition 3A4_MS_V02_02_ PurchaseOrderConfirmation.dtd 8. Review the data and click Finish, or make changes using Back. You should see Collaboration 3A4: V02.00 successfully created at the top of the page. Acme Server, Task 2: Setting Up the Trading Partners On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (GlobalChips) ■ Setting Up the Host Trading Partner (Acme) See the following for more information: ■ ■ "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 If you have not already done so, change the default host trading partner name from MyCompany to: ■ 5-8 Acme, if you are working on the Acme server Oracle Application Server Integration B2B User’s Guide Tutorial 1: Setting Up a RosettaNet over the Internet Transaction ■ GlobalChips, if you are working on the GlobalChips server See "Changing the Host Trading Partner Name" on page 5-4 for instructions. Setting Up the Remote Trading Partner (GlobalChips) In the following steps, you set up the remote trading partner’s business protocol, operational capabilities, and communication capabilities. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. The following workflow for creating a trading partner is shown at the top of the page. General Identification Operational Capability Delivery Channel Document Exchange Transport Review 3. On the Create Trading Partner: General page, enter the remote trading partner name, GlobalChips, and click Next. 4. On the Create Trading Partner: Identification page, enter 111111111 for the DUNS value and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol RosettaNet over RNIF Collaboration 3A4 - V02.00 Collaboration Role Seller Is acknowledgement handled by Integration B2B? Yes 6. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips RN DC Acknowledgement Mode Async 7. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name GlobalChips RN DocEx Exchange Protocol Revision RosettaNet - V02.00 8. On the Create Trading Partner: Transport page, provide the following information. Purchase Order Tutorials 5-9 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction General Field Value Name GlobalChips RN Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Port port_number a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI b2b/transportServlet 9. Review the data and click Finish, or make changes using Back. You should see Trading Partner GlobalChips successfully created at the top of the page. Setting Up the Host Trading Partner (Acme) In the following steps, you set up the host trading partner’s DUNS number and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click Acme (Host). 3. Under Trading Partner Identifications, click Create. 4. For Trading Partner Identification Type, select DUNS. 5. For Value, enter 222222222. 6. Click Apply. 7. Click Capabilities. 8. Click RosettaNet over RNIF. 9. Click Create Communication Capability. The following workflow for creating the communication capabilities is shown at the top of the page. Delivery Channel 5-10 Document Exchange Transport Oracle Application Server Integration B2B User’s Guide Review Tutorial 1: Setting Up a RosettaNet over the Internet Transaction 10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme RN DC Acknowledgement Mode Async 11. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name Acme RN DocEx Exchange Protocol Revision RosettaNet-V02.00 12. On the Create Trading Partner: Transport page, provide the following information and click Next. a. Select Create New and provide the following information: General Field Value Name Acme RN Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 b. Select Create New and provide the following information: Transport Server Field Value Name Acme Transport Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Port port_number c. Select Use Existing and provide the following information: Endpoint Field Value Endpoint b2b/transportServlet 13. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. Purchase Order Tutorials 5-11 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction Acme Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the trading partner in the agreement. Acme is also automatically assigned a collaboration that is compatible with the one assigned to GlobalChips. You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select GlobalChips. 4. From Supported Business Protocol, select RosettaNet over RNIF. 5. From Supported Collaboration, select Seller - 3A4 - V02.00. 6. For Trading Partner Identification, select DUNS - 111111111 for GlobalChips and DUNS - 222222222 for Acme. 7. For Trading Partner Delivery Channel, select GlobalChips RN DC and Acme RN DC. 8. For Internal Delivery Channel, select B2B Outbound. 9. For Responding Internal Delivery Channel, select B2B Inbound. 10. In the Name field, enter Tutorial 1 Agreement. 11. In the Agreement ID field, enter 1100. 12. Click Apply. You should see Agreement Tutorial 1 Agreement successfully created at the top of the page. Note that both participants are shown on the page. 13. Click Validate. You should see Agreement Tutorial 1 Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. Acme Server, Task 4: Creating and Deploying the Configuration After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment. 1. Click Deployment. 2. Click Create. 3. For Configuration Name, enter Tutorial 1 Configuration. 4. Select Tutorial 1 Agreement. 5. Click Apply. You should see Creation and validation of configuration Tutorial 1 Configuration successful. 6. 5-12 For Tutorial 1 Configuration, click Deploy. Oracle Application Server Integration B2B User’s Guide Tutorial 1: Setting Up a RosettaNet over the Internet Transaction 7. Review the list of configurations and click Deploy. You should see Deployment finished successfully for configuration Tutorial 1 Configuration. See Chapter 13, "Creating and Deploying a Configuration" for more information. Task 5: Verifying the Purchase Order Transaction See "Both Servers, Task 5: Verifying the Purchase Order Transaction" on page 5-17 for more information. GlobalChips Server, Task 1: Creating the Collaboration Acme and GlobalChips use the same collaboration. So, on the GlobalChips server, create the same collaboration that was created on the Acme server. See "Acme Server, Task 1: Creating the Collaboration" on page 5-6 for instructions. GlobalChips Server, Task 2: Setting Up the Trading Partners On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (Acme) ■ Setting Up the Host Trading Partner (GlobalChips) See the following for more information: ■ ■ "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See "Changing the Host Trading Partner Name" on page 5-4 for instructions. Setting Up the Remote Trading Partner (Acme) In the following steps, you set up the remote trading partner’s business protocol, operational capabilities, and communication capabilities. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. The following workflow for creating a trading partner is shown at the top of the page. General Identification 3. Operational Capability Delivery Channel Document Exchange Transport Review On the Create Trading Partner: General page, provide the remote trading partner name, Acme, and click Next. Purchase Order Tutorials 5-13 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction 4. On the Create Trading Partner: Identification page, enter 222222222 for the DUNS value and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol RosettaNet over RNIF Collaboration 3A4 - V02.00 Collaboration Role Buyer Is acknowledgement handled by Integration B2B? Yes 6. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme RN DC Acknowledgement Mode Async 7. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name Acme RN DocEx Exchange Protocol Revision RosettaNet - V02.00 8. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name Acme RN Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 Transport Server Field Value Name Acme Transport Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Port port_number a. 5-14 Click Create New, provide the following information, and click Next. Oracle Application Server Integration B2B User’s Guide Tutorial 1: Setting Up a RosettaNet over the Internet Transaction Endpoint Field Value URI b2b/transportServlet 9. Review the data and click Finish, or make changes using Back. You should see Trading Partner Acme successfully created at the top of the page. Setting Up the Host Trading Partner (GlobalChips) In the following steps, you set up the host trading partner’s DUNS number and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click GlobalChips (Host). 3. Under Trading Partner Identifications, click Create. 4. For Trading Partner Identification Type, select DUNS. 5. For Value, enter 111111111. 6. Click Apply. 7. Click Capabilities. 8. Click RosettaNet over RNIF. 9. Click Create Communication Capability. The following workflow for creating the communication capabilities is shown at the top of the page. Delivery Channel Document Exchange Transport Review 10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips RN DC Acknowledgement Mode Async 11. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name GlobalChips RN DocEx Exchange Protocol Revision RosettaNet-V02.00 12. On the Create Trading Partner: Transport page, provide the following information and click Next. a. Select Create New and provide the following information: Purchase Order Tutorials 5-15 Tutorial 1: Setting Up a RosettaNet over the Internet Transaction General Field Value Name GlobalChips RN Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 b. Select Create New and provide the following information: Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Port port_number c. Select Use Existing and provide the following information: Endpoint Field Value Endpoint b2b/transportServlet 13. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. GlobalChips Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the trading partner in the agreement. GlobalChips is also automatically assigned a collaboration that is compatible with the one assigned to Acme. Note: You cannot create a trading partner agreement between more than two trading partners. 5-16 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select Acme. 4. From Supported Business Protocol, select RosettaNet over RNIF. 5. From Supported Collaboration, select Buyer - 3A4 - V02.00. 6. For Trading Partner Identification, select DUNS - 222222222 for Acme and DUNS - 111111111 for GlobalChips. 7. For Trading Partner Delivery Channel, select Acme RN DC and GlobalChips RN DC. 8. For Internal Delivery Channel, select B2B Inbound. Oracle Application Server Integration B2B User’s Guide Tutorial 1: Setting Up a RosettaNet over the Internet Transaction 9. For Responding Internal Delivery Channel, select B2B Outbound. 10. In the Name field, enter Tutorial 1 Agreement. 11. In the Agreement ID field, enter 1100. 12. Click Apply. You should see Agreement Tutorial 1 Agreement successfully created at the top of the page. Note that both participants are shown on the page. 13. Click Validate. You should see Agreement Tutorial 1 Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. GlobalChips Server, Task 4: Creating and Deploying the Configuration This step is the same on both servers. See "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-12 for instructions. Both Servers, Task 5: Verifying the Purchase Order Transaction Use the run-time files in Oracle_Home/ip/tutorial/RosettaNet/runtime (see Table 5–1 on page 5-5) to verify the transmission and receipt of the purchase order and purchase order confirmation. On UNIX platforms, you must grant execute permission using chmod +x to run the scripts. Note: You must run the setenv script to set up the CLASSPATH environment before running the following enqueue and dequeue scripts. See "Setting Up the CLASSPATH Environment" on page 5-3 if you have not already done so. 1. On both the Acme and GlobalChips servers, run one of the following files: ■ In a Bourne or Korn shell—deq.sh ■ In a C shell—deq.csh ■ In Windows—deq.bat This dequeues the purchase order on the GlobalChips server and the purchase order confirmation on the Acme server. The dequeue script generates a trace file, t1.trc, which shows the message that the application receives from OracleAS Integration B2B. 2. On the Acme server, run one of the following files: ■ In a Bourne or Korn shell—enq_3a4_req.sh ■ In a C shell—enq_3a4_req.csh ■ In Windows—enq_3a4_req.bat This enqueues the Acme purchase order and translates it to RosettaNet PIP 3A4 data to send to GlobalChips. Wait a minute or two before proceeding to the next step. Purchase Order Tutorials 5-17 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction On the GlobalChips server, the purchase order is dequeued, which you can see in the trace file, t1.trc. 3. Open t1.trc, and select and copy the value for MsgID. 4. Open enq_3a4_rsp.properties and paste the MsgID value into the value for replyToMsgID. 5. Save enq_3a4_rsp.properties. 6. On the GlobalChips server, run one of the following files: ■ In a Bourne or Korn shell—enq_3a4_rsp.sh ■ In a C shell—enq_3a4_rsp.csh ■ In Windows—enq_3a4_rsp.bat This enqueues the purchase order confirmation from GlobalChips to Acme. Wait a minute before proceeding to the next step. 7. On the Acme server, the purchase order confirmation is dequeued, which you can see in the trace file, t1.trc. Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server. In the following scenario, Acme and GlobalChips use the File - 1.0 transport protocol. See "Using the EMail Transport Protocol" on page 5-38 for the steps to use the EMail transport protocol instead. Note: Because the two servers can be on different hosts, the Acme and GlobalChips folders must be shared; that is, the GlobalChips trading partner must be able to put messages in the Acme folder (which may be on a different host). Similarly, the Acme trading partner must be able to access the GlobalChips folder (which may be on a different host). If for some reason the folders are not shared, then FTP must be used instead of the File protocol. If you use FTP, then you must specify the username and password when you create the transport server. One person does the following tasks: ■ Acme Server, Task 1: Creating the Business Actions ■ Acme Server, Task 2: Setting Up the Trading Partners ■ Acme Server, Task 3: Creating the Trading Partner Agreement ■ Acme Server, Task 4: Creating and Deploying the Configuration In parallel, the other person does the following tasks: 5-18 ■ GlobalChips Server, Task 1: Creating the Business Actions ■ GlobalChips Server, Task 2: Setting Up the Trading Partners ■ GlobalChips Server, Task 3: Creating the Trading Partner Agreement ■ GlobalChips Server, Task 4: Creating and Deploying the Configuration Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5: ■ Both Servers, Task 5: Verifying the Purchase Order Transaction Note: Fields and checkboxes that you should accept default values for, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly. The EDI EDIFACT transaction between Acme and GlobalChips is depicted in Figure 5–3. Figure 5–3 Tutorial 2 EDIFACT Transaction: Acme Is the Buyer and GlobalChips Is the Seller Oracle Application Server Integration B2B at Acme - Europe (Buyer) Oracle Application Server Integration B2B at GlobalChips (Seller) EDIFACT ORDERS (PO) EDI EDIFACT over Generic (VAN) EDIFACT ORDRSP (POA) Acme Server, Task 1: Creating the Business Actions In the following set of tasks, Acme is the host trading partner. You create the following business actions for this transaction. ■ ■ ■ Process_ORDERS—Acme uses the Process_ORDERS business action to send a purchase order to GlobalChips. Process_CONTRL—GlobalChips and Acme use the Process_CONTRL business action to send functional acknowledgments. GlobalChips acknowledges that they have received Acme’s purchase order. Acme acknowledges that they have received GlobalChips’ purchase order confirmation. Process_ORDRSP—GlobalChips uses the Process_ORDRSP business action to send a purchase order confirmation indicating that they can fulfill Acme’s purchase order request. Note: You must use all uppercase for document protocol parameters, as shown in this tutorial. This is an EDIFACT standard. See "Creating a Business Action" on page 8-20 for more information. Creating the Process_ORDERS Business Action—Acme Sends a Purchase Order 1. Click Partners, then Protocols. 2. Click EDI EDIFACT over Generic Exchange. 3. From Shortcut, click Create Business Action. The following workflow for creating a business action is shown at the top of the page: Purchase Order Tutorials 5-19 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction General 4. Review Document Type On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_ORDERS Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Create New Name EDIFACT_D98A Revision D98A Document Protocol Parameters Field Override Value1 [Interchange Sender Identification] ACME [Interchange Recipient Identification] ACME [Application Sender’s Identification] ACME [Application Recipient’s Identification] ACME 1 6. 5-20 Document Protocol Revision If you are working on the GlobalChips server, use GLOBALCHIPS instead of ACME for the override value. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name ORDERS Revision D98A Document Definition Field Value Name ORDERS Definition Definition orders.xsd Document Type Parameters Field Override Value Functional Group Identification ORDERS Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Document Type Parameters Field Override Value Transaction Set ecs File orders.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_ORDERS: 1.0 successfully created at the top of the page. Creating the Process_CONTRL Business Action—Functional Acknowledgments You create the Process_CONTRL business action for two purposes: ■ ■ For the buyer, Acme, to send a functional acknowledgment to GlobalChips. Acme acknowledges that they received GlobalChips’ purchase order confirmation. For the seller, GlobalChips, to send a functional acknowledgment to Acme. GlobalChips acknowledges that they received Acme’s purchase order request. 1. Click Partners, then Protocols. 2. Click EDI EDIFACT over Generic Exchange. 3. From Shortcut, click Create Business Action. The following workflow for creating a business action is shown at the top of the page: General 4. Document Protocol Revision Review Document Type On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_CONTRL Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Create New Name EDIFACT_D3 Revision D3 Document Protocol Parameters Field Override Value1 [Interchange Sender Identification] ACME Purchase Order Tutorials 5-21 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Document Protocol Parameters Field Override Value1 [Interchange Recipient Identification] ACME [Application Sender’s Identification] ACME [Application Recipient’s Identification] ACME 1 6. If you are working on the GlobalChips server, use GLOBALCHIPS instead of ACME for the override value. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Override Value Name CONTRL Revision D3 Document Definition Field Value Name Acme_CONTRL Definition contrl.xsd Document Type Parameters Field Override Value Functional Group Identifier Code CONTRL Transaction Set ecs File contrl.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_CONTRL: 1.0 successfully created at the top of the page. Creating the Process_ORDRSP Business Action—GlobalChips Sends a Purchase Order Confirmation 1. Click Partners, then Protocols. 2. Click EDI EDIFACT over Generic Exchange. 3. From Shortcut, click Create Business Action. The following workflow for creating a business action is shown at the top of the page: General 4. 5-22 Document Protocol Revision Review Document Type On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_ORDRSP Revision 1.0 Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Field Value Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Use Existing Document Protocol Revision EDIFACT_D98A-D98A 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name ORDRSP Revision D98A Document Definition Field Value Name ORDRSP Definition ordrsp.xsd Document Type Parameters Field Override Value Functional Group Identifier Code ORDRSP Transaction Set ecs File ordrsp.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_ORDRSP: 1.0 successfully created at the top of the page. Acme Server, Task 2: Setting Up the Trading Partners On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (GlobalChips) ■ Setting Up the Host Trading Partner (Acme) See the following for more information: ■ ■ "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Purchase Order Tutorials 5-23 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See "Changing the Host Trading Partner Name" on page 5-4 for instructions. Setting Up the Remote Trading Partner (GlobalChips) As you set up GlobalChips, you associate it with the business actions as follows: ■ ■ ■ ■ Process_ORDERS-Responder. GlobalChips responds to the Process_ORDERS business action (see Step 5 on page 5-24, Is Initiator = False), because it receives the purchase order. Process_CONTRL-Initiator. GlobalChips initiates the Process_CONTRL business action (see Step 14 on page 5-26, Is Initiator=True) when it sends a functional acknowledgment to Acme. Process_CONTRL-Responder. GlobalChips responds to the Process_CONTRL business action (see Step 16 on page 5-26, Is Initiator=False), because it receives a functional acknowledgment from Acme. Process_ORDRSP-Initiator. GlobalChips initiates the Process_ORDRSP business action (see Step 18 on page 5-27, Is Initiator=True) when it sends the purchase order confirmation to Acme. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. The following workflow for creating a trading partner is shown at the top of the page. General 5-24 Identification Operational Capability Delivery Channel Document Exchange Transport Review 3. On the Create Trading Partner: General page, provide the remote trading partner name, GlobalChips, and click Next. 4. Skip the Create Trading Partner: Identification page and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol EDI EDIFACT over Generic Exchange Business Action Process_ORDERS Is Initiator False Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ORDERS Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Document Information Field Value Use Existing Document Protocol Parameter Values Uncheck the box. Use Default Document Definition Check the box. 6. Continuing on the Create Trading Partner: Operational Capability page, provide the following override values and click Next. Document Protocol Parameters Field Override Value [Interchange Sender Identification] GLOBALCHIPS [Interchange Recipient Identification] GLOBALCHIPS [Application Sender’s Identification] GLOBALCHIPS [Application Recipient’s Identification] GLOBALCHIPS 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips DC Acknowledgement Mode None 8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name GlobalChips DocEx Exchange Protocol Revision Generic - 1.0 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name GlobalChips Transport Transport Protocol Field Value Transport Protocol File - 1.0 Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Purchase Order Tutorials 5-25 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI GlobalChips_endpoint Outgoing file directory for the remote trading partner. 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner GlobalChips successfully created at the top of the page. 11. Click Capabilities. 12. Click EDI EDIFACT over Generic Exchange. 13. Click Create Operational Capability. 14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_CONTRL Is Initiator True Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type CONTRL Document Protocol Parameter Field Override Value Interchange Sender Identification GLOBALCHIPS Interchange Recipient Identification GLOBALCHIPS Application Sender’s Identification GLOBALCHIPS Application Recipient’s Identification GLOBALCHIPS You should see Supported business action created successfully at the top of the page, for Process_CONTRL-Initiator. 15. Repeat Steps 11 through 13. 16. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. 5-26 General Field Value Business Action Process_CONTRL Is Initiator False Functional acknowledgement required? No Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction General Field Value Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type CONTRL You should see Supported business action created successfully at the top of the page, for Process_CONTRL-Responder. 17. Repeat Steps 11 through 13. 18. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_ORDRSP Is Initiator True Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ORDRSP You should see Supported business action created successfully at the top of the page, for Process_ORDRSP-Initiator. Setting Up the Host Trading Partner (Acme) In the following steps, you set up the host trading partner’s communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click Acme (Host). 3. Click Capabilities. 4. Click EDI EDIFACT over Generic Exchange. 5. Click Create Communication Capability. The following workflow for creating the communication capabilities is shown at the top of the page. Delivery Channel 6. Document Exchange Transport Review On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Purchase Order Tutorials 5-27 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Field Value Name Acme DC Acknowledgement Mode None 7. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name Acme DocEx Exchange Protocol Revision Generic - 1.0 8. On the Create Trading Partner: Transport page, provide the following information and click Next. a. Select Create New and provide the following information: General Field Value Name Acme Transport Transport Protocol Field Value Transport Protocol File - 1.0 b. Select Create New and provide the following information: Transport Server Field Value Name Acme Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. c. Select Create New and provide the following information: Endpoint Field Value URI Acme_endpoint Incoming file directory for the host trading partner. 9. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. Acme Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the remote trading partner 5-28 Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction in the agreement. Acme is also automatically assigned a business action that is compatible with the one assigned to GlobalChips. Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select GlobalChips. 4. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 5. From Supported Business Action, select Process_ORDERS-Responder. 6. For Trading Partner Identification, select Name - GlobalChips and Name Acme. 7. For Trading Partner Delivery Channel, select GlobalChips DC and Acme DC. 8. For Internal Delivery Channel, select B2B Outbound. 9. For Responding Internal Delivery Channel, select B2B Inbound. 10. In the Name field, enter Tutorial 2 Agreement. 11. In the Agreement ID field, enter 1200. 12. Click Apply. You should see Agreement Tutorial 2 Agreement successfully created at the top of the page. 13. For Trading Partner Participants, click Add. 14. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 15. From Supported Business Action, select Process_CONTRL-Initiator. 16. Repeat Steps 6 and 7. 17. For Internal Delivery Channel, select B2B Inbound. 18. For Responding Internal Delivery Channel, select B2B Outbound. 19. Click Apply. You should see Trading partner participant successfully added. 20. For Trading Partner Participants, click Add. 21. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 22. From Supported Business Action, select Process_CONTRL-Responder. 23. Repeat Steps 6 through 9. 24. Click Apply. You should see Trading partner participant successfully added. 25. For Trading Partner Participants, click Add. 26. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 27. From Supported Business Action, select Process_ORDRSP - Initiator. 28. Repeat Steps 6 and 7. Purchase Order Tutorials 5-29 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction 29. For Internal Delivery Channel, select B2B Inbound. 30. For Responding Internal Delivery Channel, select B2B Outbound. 31. Click Apply. You should see Trading partner participant successfully added. 32. Click Validate. You should see Agreement Tutorial 2 Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. Acme Server, Task 4: Creating and Deploying the Configuration After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment. 1. Click Deployment. 2. Click Create. 3. For Configuration Name, enter Tutorial 2 Configuration. 4. Select Tutorial 2 Agreement. 5. Click Apply. You should see Creation and validation of configuration Tutorial 2 Configuration successful. 6. For Tutorial 2 Configuration, click Deploy. 7. Review the list of configurations and click Deploy. You should see Deployment finished successfully for configuration Tutorial 2 Configuration. See Chapter 13, "Creating and Deploying a Configuration" for more information. Task 5: Verifying the Purchase Order Transaction See "Both Servers, Task 5: Verifying the Purchase Order Transaction" on page 5-37 for more information. GlobalChips Server, Task 1: Creating the Business Actions Acme and GlobalChips use the same set of business actions. So, on the GlobalChips server, create the same business actions that were created on the Acme server. You can use the same instructions, "Acme Server, Task 1: Creating the Business Actions" on page 5-19 for: ■ Creating the Process_ORDERS Business Action—Acme Sends a Purchase Order ■ Creating the Process_CONTRL Business Action—Functional Acknowledgments ■ 5-30 Creating the Process_ORDRSP Business Action—GlobalChips Sends a Purchase Order Confirmation Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction GlobalChips Server, Task 2: Setting Up the Trading Partners On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner. This section contains these topics: ■ Changing the Host Trading Partner Name to GlobalChips ■ Setting Up the Remote Trading Partner (Acme) ■ Setting Up the Host Trading Partner (GlobalChips) See the following for more information: ■ ■ "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See "Changing the Host Trading Partner Name" on page 5-4 for instructions. Changing the Host Trading Partner Name to GlobalChips For this tutorial, change the host trading partner name (created at installation) to GlobalChips. 1. Click Partners, then Trading Partners. 2. For MyCompany (Host), click Update. 3. Enter GlobalChips in place of MyCompany. 4. Click Apply. Setting Up the Remote Trading Partner (Acme) As you set up Acme, you associate it with the following business actions: ■ ■ ■ ■ Process_ORDERS-Initiator. Acme is the initiator of the Process_ORDERS business action (see Step 5 on page 5-32, Is Initiator = True), when it sends the purchase order to GlobalChips. Process_CONTRL-Initiator. Acme is the initiator of the Process_CONTRL business action (see Step 14 on page 5-33, Is Initiator=True) when it sends a functional acknowledgment to GlobalChips. Process_CONTRL-Responder. Acme is not the initiator of the Process_CONTRL business action (see Step 16 on page 5-34, Is Initiator=False) when it receives a functional acknowledgment from GlobalChips. Process_ORDRSP-Responder. Acme is not the initiator of the Process_ORDRSP business action (see Step 18 on page 5-34, Is Initiator=False) when it receives the purchase order confirmation from GlobalChips. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. Purchase Order Tutorials 5-31 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction The following workflow for creating a trading partner is shown at the top of the page. General Identification Delivery Channel Document Exchange Transport Review 3. On the Create Trading Partner: General page, provide the remote trading partner name, Acme, and click Next. 4. Skip the Create Trading Partner: Identification page and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol EDI EDIFACT over Generic Exchange Business Action Process_ORDERS Is Initiator True Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ORDERS Use Existing Document Protocol Parameter Values Uncheck the box. Use Default Document Definition Check the box. 6. Continuing on the Create Trading Partner: Operational Capability page, provide the following override values and click Next. Document Protocol Parameters Field Override Value [Interchange Sender Identification] ACME [Interchange Recipient Identification] ACME [Application Sender’s Identification] ACME [Application Recipient’s Identification] ACME 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme DC Acknowledgement Mode None 8. 5-32 Operational Capability On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Field Value Name Acme DocEx Exchange Protocol Revision Generic - 1.0 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name Acme Transport Transport Protocol Field Value Transport Protocol File - 1.0 Transport Server Field Value Name Acme Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI Acme_endpoint Outgoing file directory for the remote trading partner. 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner Acme created successfully at the top of the page. 11. Click Capabilities. 12. Click EDI EDIFACT over Generic Exchange. 13. Click Create Operational Capability. 14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_CONTRL Is Initiator True Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Purchase Order Tutorials 5-33 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Document Information Field Value Document Type CONTRL Document Protocol Parameter Field Override Value Interchange Sender Identification ACME Interchange Recipient Identification ACME Application Sender’s Identification ACME Application Recipient’s Identification ACME You should see Supported business action created successfully at the top of the page, for Process_CONTRL-Initiator. 15. Repeat Steps 11 through 13. 16. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_CONTRL Is Initiator False Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type CONTRL You should see Supported business action created successfully at the top of the page, for Process_CONTRL-Responder. 17. Repeat Steps 11 through 13. 18. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. 5-34 General Field Value Business Action Process_ORDRSP Is Initiator False Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ORDRSP Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction You should see Supported business action created successfully at the top of the page, for Process_ORDRSP-Responder. Setting Up the Host Trading Partner (GlobalChips) In the following steps, you set up the host trading partner’s communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click GlobalChips (Host). 3. Click Capabilities. 4. Click EDI EDIFACT over Generic Exchange. 5. Click Create Communication Capability. The following workflow for creating the communication capabilities is shown at the top of the page. Document Exchange Delivery Channel 6. Transport Review On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips DC Acknowledgement Mode None 7. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name GlobalChips DocEx Exchange Protocol Revision Generic - 1.0 8. On the Create Trading Partner: Transport page, provide the following information and click Next. a. Select Create New and provide the following information: General Field Value Name GlobalChips Transport Transport Protocol Field Value Transport Protocol File - 1.0 b. Select Create New and provide the following information: Purchase Order Tutorials 5-35 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction Transport Server Field Value Name GlobalChips Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. c. Select Create New and provide the following information: Endpoint Field Value URI GlobalChips_endpoint Incoming file directory for the host trading partner. 9. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. GlobalChips Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the remote trading partner in the agreement. GlobalChips is also automatically assigned a business action that is compatible with the one assigned to Acme. Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select Acme. 4. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 5. From Supported Business Action, select Process_ORDERS-Initiator. 6. For Trading Partner Identification, select Name - Acme and Name GlobalChips. 7. For Trading Partner Delivery Channel, select Acme DC and GlobalChips DC. 8. For Internal Delivery Channel, select B2B Inbound. 9. For Responding Internal Delivery Channel, select B2B Outbound. 10. In the Name field, enter Tutorial 2 Agreement. 11. In the Agreement ID field, enter 1200. 12. Click Apply. You should see Agreement Tutorial 2 Agreement successfully created at the top of the page. 13. For Trading Partner Participants, click Add. 5-36 Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction 14. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 15. From Supported Business Action, select Process_CONTRL-Initiator. 16. Repeat Steps 6 through 9. 17. Click Apply. You should see Trading partner participant successfully added. 18. For Trading Partner Participants, click Add. 19. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 20. From Supported Business Action, select Process_CONTRL-Responder. 21. Repeat Steps 6 and 7. 22. For Internal Delivery Channel, select B2B Outbound. 23. For Responding Internal Delivery Channel, select B2B Inbound. 24. Click Apply. You should see Trading partner participant successfully added. 25. For Trading Partner Participants, click Add. 26. From Supported Business Protocol, select EDI EDIFACT over Generic Exchange. 27. From Supported Business Action, select Process_ORDRSP-Responder. 28. Repeat Steps 6 and 7. 29. For Internal Delivery Channel, select B2B Outbound. 30. For Responding Internal Delivery Channel, select B2B Inbound. 31. Click Apply. You should see Trading partner participant successfully added. 32. Click Validate. You should see Agreement Tutorial 2 Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. GlobalChips Server, Task 4: Creating and Deploying the Configuration This step is the same on both servers. See "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-30 for instructions. Both Servers, Task 5: Verifying the Purchase Order Transaction Use the run-time files in Oracle_Home/ip/tutorial/Edifact/runtime (see Table 5–1 on page 5-5) to verify the transmission and receipt of the purchase order and purchase order confirmation. On UNIX platforms, you must grant execute permission using chmod +x to run the scripts. Note: You must run the setenv script to set up the CLASSPATH environment before running the following enqueue and dequeue scripts. See "Setting Up the CLASSPATH Environment" on page 5-3 if you have not already done so. Purchase Order Tutorials 5-37 Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction 1. On both the Acme and GlobalChips servers, run one of the following files: ■ In a Bourne or Korn shell—deq.sh ■ In Windows—deq.bat This dequeues the purchase order on the GlobalChips server and the purchase order confirmation on the Acme server. The dequeue script generates a trace file, t1.trc, which shows the message that the application receives from OracleAS Integration B2B. 2. On the Acme server, run one of the following files: ■ In a Bourne or Korn shell—enq_orders.sh ■ In Windows—enq_orders.bat This enqueues the Acme purchase order and translates it to EDIFACT ORDER data to send to GlobalChips. Wait a minute or two before proceeding to the next step. On the GlobalChips server, the purchase order is dequeued, which you can see in the trace file, t1.trc. The trace file name can be configured in enq_ orders.properties. 3. On the GlobalChips server, run one of the following files: ■ In a Bourne or Korn shell—enq_ordrsp.sh ■ In Windows—enq_ordrsp.bat This enqueues the purchase order confirmation from GlobalChips to Acme. Wait a minute before proceeding to the next step. 4. On the Acme server, the purchase order confirmation is dequeued, which you can see in the trace file, t1.trc. The trace file name can be configured in enq_ordrsp.properties. Using the EMail Transport Protocol In "Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction" on page 5-18, Acme and GlobalChips use the File - 1.0 transport protocol. This section describes how you can modify tutorial 2 (or other protocols that use the generic exchange) so that Acme sends a custom document to Globalchips using the EMail transport protocol. These instructions assume the following: ■ ■ ■ ■ ■ 5-38 Acme, the host trading partner and initiator, sends a custom document using the EMail transport protocol. GlobalChips is the remote trading partner and responder. For Trading Partner Identification Type, both Acme and GlobalChips are assigned the Generic Identifier type, whose value is the e-mail user name provided for each company on the Transport page. The EMail transport protocol for the remote trading partner is used to send only the payload to the host trading partner The procedure for configuring the EMail transport protocol is similar for the host and remote trading partners; the only differences are the values used for Host Name, Username, and Password. Oracle Application Server Integration B2B User’s Guide Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction To set up the EMail transport server for the host trading partner, see "Setting Up the Host Trading Partner (Acme)" on page 5-27 and replace Steps 6 through 8 with the following: 6. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme Email Acknowledgement Mode None 7. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name Acme DocExchange Exchange Protocol Revision Generic - 1.0 8. On the Create Trading Partner: Transport page, provide the following information and click Next. ■ Select Create New and provide the following information: General Field Value Name Acme Transport Transport Protocol Field Value Transport Protocol Email - 1.0 ■ Select Create New and provide the following information: Transport Server Field Value Name Acme EMail Transport Server Host Name Acme_email_server_name The e-mail server at the Acme site. For example, acm1.acme.com. Username email_username Password email_password Parameters - ■ content-type application/b2b ■ send message as attachment true ■ Select Create New and provide the following information: Endpoint Field Value URI Username@hostname Purchase Order Tutorials 5-39 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Note the following: ■ ■ ■ E-mail attachments are base64 encoded. If you set the content-type parameter to text/plain, then ^M characters are introduced in the base64-encoded message, which creates problems during decoding. Setting the content-type parameter to application/b2b avoids this problem. Some e-mail servers truncate a payload that is more than 80 or 120 characters long when it is in the message body. Setting the send message as attachment parameter to true avoids this problem by sending the payload as an attachment instead of in the message body. The endpoint of the host trading partner is polled for e-mail messages at regular intervals. The default value is 60 seconds. Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server. One person does the following tasks: ■ Acme Server, Task 1: Creating the Business Actions ■ Acme Server, Task 2: Setting Up the Trading Partners ■ Acme Server, Task 3: Creating the Trading Partner Agreement ■ Acme Server, Task 4: Creating and Deploying the Configuration In parallel, another person does the following tasks: ■ GlobalChips Server, Task 1: Creating the Business Actions ■ GlobalChips Server, Task 2: Setting Up the Trading Partners ■ GlobalChips Server, Task 3: Creating the Trading Partner Agreement ■ GlobalChips Server, Task 4: Creating and Deploying the Configuration After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5: ■ Both Servers, Task 5: Verifying the Purchase Order Transaction Note: Fields and checkboxes that you should accept default values for, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly. The EDI X12 transaction between Acme and GlobalChips is depicted in Figure 5–4. 5-40 Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Figure 5–4 Tutorial 3 EDI X12 Transaction: Acme Is the Buyer and GlobalChips Is the Seller Oracle Application Server Integration B2B at GlobalChips (Seller) Oracle Application Server Integration B2B at Acme - U.S. (Buyer) X12 850 (PO) EDI X12 over Internet (AS2) X12 855 (POA) Acme Server, Task 1: Creating the Business Actions In the following set of tasks, Acme is the host trading partner. You create the following business actions for this transaction. ■ ■ ■ Process_850—Acme uses the Process_850 business action to send a purchase order to GlobalChips. Process_997—GlobalChips and Acme use the Process_997 business action to send acknowledgments. GlobalChips acknowledges that they have received Acme’s purchase order. Acme acknowledges that they have received GlobalChips’ purchase order confirmation. Process_855—GlobalChips uses the Process_855 business action to send a purchase order confirmation indicating that they can fulfill Acme’s purchase order request. See "Creating a Business Action" on page 8-20 for more information. Creating the Process_850 Business Action—Acme Sends a Purchase Order 1. Click Partners, then Protocols. 2. Click EDI X12 over Internet. 3. From Shortcut, click Create Business Action. The following workflow for creating a business action is shown at the top of the page: General 4. Document Protocol Revision Review Document Type On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_850 Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async Purchase Order Tutorials 5-41 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Create New Name X12_4010 Revision 4010 Document Protocol Parameters Field Override Value1 [Interchange Sender ID] Acme [Interchange Receiver ID] Acme Interchange Control Version Number 00200 [Application Sender’s Code] Acme [Application Receiver’s Code] Acme 1 6. If you are working on the GlobalChips server, use GlobalChips instead of Acme for the override value. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name 850 Revision 4010 Document Definition Field Value Name 850 Definition Definition 850.xsd Document Type Parameters Field Override Value Functional Group Identifier Code PO Transaction Set ecs File 850.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_850: 1.0 successfully created at the top of the page. Creating the Process_997 Business Action—Acknowledgments You create the Process_997 business action for two purposes: ■ ■ 1. 5-42 For the buyer, Acme, to send an acknowledgment to GlobalChips. Acme acknowledges that they received GlobalChips’ purchase order confirmation. For the seller, GlobalChips, to send an acknowledgment to Acme. GlobalChips acknowledges that they received Acme’s purchase order request. Click Partners, then Protocols. Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 2. Click EDI X12 over Internet. 3. From Shortcut, click Create Business Action. The following workflow for creating a business action is shown at the top of the page: General 4. Document Protocol Revision Review Document Type On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_997 Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Use Existing Document Protocol Revision X12_4010 - 4010 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Override Value Name 997 Revision 4010 Document Definition Field Value Name 997 Definition Definition 997.xsd Document Type Parameters Field Override Value Functional Group Identifier Code FA Transaction Set ecs File 997.ecs 7. Review the data and click Finish, or make changes using Back. Purchase Order Tutorials 5-43 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction You should see Business Action Process_997: 1.0 successfully created at the top of the page. Creating the Process_855 Business Action—GlobalChips Sends a Purchase Order Confirmation 1. Click Partners, then Protocols. 2. Click EDI X12 over Internet. 3. From Shortcut, click Create Business Action. The following workflow for creating a business action is shown at the top of the page: General 4. Review Document Type On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_855 Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Use Existing Document Protocol Revision X12_4010 - 4010 6. 5-44 Document Protocol Revision On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name 855 Revision 4010 Document Definition Field Value Name 855 Definition Definition 855.xsd Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Document Type Parameters Field Override Value Functional Group Identifier Code PR Transaction Set ecs File 855.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_855: 1.0 successfully created at the top of the page. Acme Server, Task 2: Setting Up the Trading Partners On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (GlobalChips) ■ Setting Up the Host Trading Partner (Acme) See the following for more information: ■ ■ "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See "Changing the Host Trading Partner Name" on page 5-4 for instructions. Setting Up the Remote Trading Partner (GlobalChips) As you set up GlobalChips, you associate it with the business actions as follows: ■ ■ ■ ■ Process_850-Responder. GlobalChips responds to the Process_850 business action (see Step 5 on page 5-46, Is Initiator = False) when it receives the purchase order. Process_997-Initiator. GlobalChips initiates the Process_997 business action (see Step 14 on page 5-47, Is Initiator=True) when it sends an acknowledgment to Acme. Process_855-Initiator. GlobalChips initiates the Process_855 business action (see Step 16 on page 5-48, Is Initiator=True) when it sends the purchase order confirmation to Acme. Process_997-Responder. GlobalChips responds to the Process_997 business action (see Step 18 on page 5-48, Is Initiator=False) when it receives an acknowledgment from Acme. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. The following workflow for creating a trading partner is shown at the top of the page. Purchase Order Tutorials 5-45 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction General Identification Delivery Channel Document Exchange Transport Review 3. On the Create Trading Partner: General page, provide the remote trading partner name, GlobalChips, and click Next. 4. On the Create Trading Partner: Identification page, enter GlobalChips for the AS2 Identifier value and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol EDI X12 over Internet Business Action Process_850 Is Initiator False Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 850 Use Existing Document Protocol Parameter Values Uncheck the box. Use Default Document Definition Check the box. 6. Continuing on the Create Trading Partner: Operational Capability page, provide the following override values and click Next. Document Protocol Parameters Field Override Value [Interchange Sender ID] GlobalChips [Interchange Receiver ID] GlobalChips [Application Sender’s Code] GlobalChips [Application Receiver’s Code] GlobalChips 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips X12 DC Acknowledgement Mode Async 8. 5-46 Operational Capability On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Field Value Name GlobalChips X12 DocEx Exchange Protocol Revision AS2 - 1.1 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name GlobalChips X12 Transport Transport Protocol Field Value Transport Protocol HTTP - 1.0 Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Port port_number a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI b2b/transportServlet 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner GlobalChips successfully created at the top of the page. 11. Click Capabilities. 12. Click EDI X12 over Internet. 13. Click Create Operational Capability. 14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. Field Value Business Action Process_997 Is Initiator True Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Purchase Order Tutorials 5-47 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Document Information Field Value Document Type 997 You should see Supported business action created successfully at the top of the page, for Process_997-Initiator. 15. Repeat Steps 11 through 13. 16. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. Field Value Business Action Process_855 Is Initiator True Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 855 You should see Supported business action created successfully at the top of the page, for Process_855-Initiator. 17. Repeat Steps 11 through 13. 18. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. Field Value Business Action Process_997 Is Initiator False Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 997 You should see Supported business action created successfully at the top of the page, for Process_997-Responder. Setting Up the Host Trading Partner (Acme) In the following steps, you set up the host trading partner’s AS2 identifier and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. 5-48 Click Partners, then Trading Partners. Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 2. Click Acme (Host). 3. Click General. 4. Under Trading Partner Identifications, click Create. 5. For Trading Partner Identification Type, select AS2 Identifier. 6. For Value, enter Acme. 7. Click Apply. 8. Click Capabilities. 9. Click EDI X12 over Internet. 10. Click Create Communication Capability. The following workflow for creating the communication capabilities is shown at the top of the page. Document Exchange Delivery Channel Transport Review 11. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme X12 DC Acknowledgement Mode Async 12. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name Acme X12 DocEx Exchange Protocol Revision AS2 - 1.1 13. On the Create Trading Partner: Transport page, provide the following information and click Next. a. Select Create New and provide the following information: General Field Value Name Acme X12 Transport Transport Protocol Field Value Transport Protocol HTTP - 1.0 b. Select Create New and provide the following information: Transport Server Field Value Name Acme Transport Server Purchase Order Tutorials 5-49 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Transport Server Field Value Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Port port_number c. Select Use Existing and provide the following information: Endpoint Field Value Endpoint b2b/transportServlet 14. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. Acme Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the trading partner in the agreement. Acme is also automatically assigned a business action that is compatible with the one assigned to GlobalChips. Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select GlobalChips. 4. From Supported Business Protocol, select EDI X12 over Internet. 5. From Supported Business Action, select Process_850-Responder. 6. For Trading Partner Identification, select AS2 Identifier - GlobalChips and AS2 Identifier - Acme. 7. For Trading Partner Delivery Channel, select GlobalChips X12 DC and Acme X12 DC. 8. For Internal Delivery Channel, select B2B Outbound. 9. For Responding Internal Delivery Channel, select B2B Inbound. 10. In the Name field, enter Tutorial 3 Agreement. 11. In the Agreement ID field, enter 1300. 12. Click Apply. You should see Agreement Tutorial 3 Agreement successfully created at the top of the page. 13. For Trading Partner Participant, click Add. 14. From Supported Business Protocol, select EDI X12 over Internet. 5-50 Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 15. From Supported Business Action, select Process_997-Initiator. 16. Repeat Steps 6 through 7. 17. For Internal Delivery Channel, select B2B Inbound. 18. For Responding Internal Delivery Channel, select B2B Outbound. 19. Click Apply. You should see Trading partner participant successfully added at the top of the page. 20. For Trading Partner Participant, click Add. 21. From Supported Business Protocol, select EDI X12 over Internet. 22. From Supported Business Action, select Process_855-Initiator. 23. Repeat Steps 6 and 7. 24. For Internal Delivery Channel, select B2B Inbound. 25. For Responding Internal Delivery Channel, select B2B Outbound. 26. Click Apply. You should see Trading partner participant successfully added at the top of the page. 27. For Trading Partner Participant, click Add. 28. From Supported Business Protocol, select EDI X12 over Internet. 29. From Supported Business Action, select Process_997-Responder. 30. Repeat Steps 6 through 9. 31. Click Apply. You should see Trading partner participant successfully added at the top of the page. 32. Click Validate. You should see Agreement Tutorial 3 Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. Acme Server, Task 4: Creating and Deploying the Configuration After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment. 1. Click Deployment. 2. Click Create. 3. For Configuration Name, enter Tutorial 3 Configuration. 4. Select Tutorial 3 Agreement. 5. Click Apply. 6. For Tutorial 3 Configuration, click Deploy. Purchase Order Tutorials 5-51 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 7. Review the list of configurations and click Deploy. You should see Deployment finished successfully for configuration Tutorial 3 Configuration. See Chapter 13, "Creating and Deploying a Configuration" for more information. Task 5: Verifying the Purchase Order Transaction See "Both Servers, Task 5: Verifying the Purchase Order Transaction" on page 5-58 for more information. GlobalChips Server, Task 1: Creating the Business Actions Acme and GlobalChips use the same set of business actions. So, on the GlobalChips server, create the same business actions that were created on the Acme server. You can use the same instructions, "Acme Server, Task 1: Creating the Business Actions" on page 5-41 for: ■ Creating the Process_850 Business Action—Acme Sends a Purchase Order ■ Creating the Process_997 Business Action—Acknowledgments ■ Creating the Process_855 Business Action—GlobalChips Sends a Purchase Order Confirmation GlobalChips Server, Task 2: Setting Up the Trading Partners On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (Acme) ■ Setting Up the Host Trading Partner (GlobalChips) See the following for more information: ■ ■ "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See "Changing the Host Trading Partner Name" on page 5-4 for instructions. Setting Up the Remote Trading Partner (Acme) As you set up Acme, you associate it with the following business actions: ■ ■ 5-52 Process_850-Initiator. Acme initiates the Process_850 business action (see Step 5 on page 5-53, Is Initiator = True) when it sends the purchase order to GlobalChips. Process_997-Responder. Acme responds to the Process_997 business action (see Step 14 on page 5-54, Is Initiator=False), when it receives a functional acknowledgment from GlobalChips. Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction ■ ■ Process_855-Responder. Acme responds to the Process_855 business action (see Step 16 on page 5-55, Is Initiator=False), when it receives the purchase order confirmation from GlobalChips. Process_997-Initiator. Acme initiates the Process_997 business action (see Step 18 on page 5-55, Is Initiator=True) when it sends an acknowledgment to GlobalChips. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. The following workflow for creating a trading partner is shown at the top of the page. General Identification Operational Capability Delivery Channel Document Exchange Transport Review 3. On the Create Trading Partner: General page, provide the remote trading partner name, Acme, and click Next. 4. On the Create Trading Partner: Identification page, enter Acme for the AS2 Identifier value and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol EDI X12 over Internet Business Action Process_850 Is Initiator True Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 850 Use Existing Document Protocol Parameter Values Uncheck the box. Use Default Document Definition Check the box. 6. Continuing on the Create Trading Partner: Operational Capability page, provide the following override values and click Next. Document Protocol Parameters Field Override Value [Interchange Sender ID] Acme [Interchange Receiver ID] Acme [Application Sender’s Code] Acme [Application Receiver’s Code] Acme Purchase Order Tutorials 5-53 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme X12 DC Acknowledgement Mode Async 8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name Acme X12 DocEx Exchange Protocol Revision AS2 - 1.1 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name Acme X12 Transport Transport Protocol Field Value Transport Protocol HTTP - 1.0 Transport Server Field Value Name Acme Transport Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Port port_number a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI b2b/transportServlet 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner Acme successfully created at the top of the page, for Process_850-Initiator. 11. Click Capabilities. 12. Click EDI EX12 over Internet. 13. Click Create Operational Capability. 14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. 5-54 Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction General Field Value Business Action Process_997 Is Initiator False Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 997 You should see Supported business action successfully created at the top of the page, for Process_997-Responder. 15. Repeat Steps 11 through 13. 16. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_855 Is Initiator False Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 855 You should see Supported business action created successfully at the top of the page, for Process_855-Responder. 17. Repeat Steps 11 through 13. 18. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_997 Is Initiator True Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type 997 Purchase Order Tutorials 5-55 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction You should see Supported business action created successfully at the top of the page, for Process_997-Initiator. Setting Up the Host Trading Partner (GlobalChips) In the following steps, you set up the host trading partner’s AS2 identifier and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click GlobalChips (Host). 3. Click General. 4. Under Trading Partner Identifications, click Create. 5. For Trading Partner Identification Type, select AS2 Identifier. 6. For Value, enter GlobalChips. 7. Click Apply. 8. Click Capabilities. 9. Click EDI X12 over Internet. 10. Click Create Communication Capability. The following workflow for creating the communication capabilities is shown at the top of the page. Document Exchange Delivery Channel Transport Review 11. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips X12 DC Acknowledgement Mode Async 12. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name GlobalChips X12 DocEx Exchange Protocol Revision AS2 - 1.1 13. On the Create Trading Partner: Transport page, provide the following information and click Next. a. 5-56 Select Create New and provide the following information: General Field Value Name GlobalChips X12 Transport Oracle Application Server Integration B2B User’s Guide Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction Transport Protocol Field Value Transport Protocol HTTP - 1.0 b. Select Create New and provide the following information: Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Port port_number c. Select Use Existing and provide the following information: Endpoint Field Value Endpoint b2b/transportServlet 14. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. GlobalChips Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the trading partner in the agreement. GlobalChips is also automatically assigned a business action that is compatible with the one assigned to Acme. Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select Acme. 4. From Supported Business Protocol, select EDI X12 over Internet. 5. From Supported Business Action, select Process_850-Initiator. 6. For Trading Partner Identification, select AS2 Identifier - Acme and AS2 Identifier - GlobalChips. 7. For Trading Partner Delivery Channel, select Acme X12 DC and GlobalChips X12 DC. 8. For Internal Delivery Channel, select B2B Inbound. 9. For Responding Internal Delivery Channel, select B2B Outbound. 10. In the Name field, enter Tutorial 3 Agreement. 11. In the Agreement ID field, enter 1300. Purchase Order Tutorials 5-57 Tutorial 3: Setting Up an EDI X12 over Internet (AS2) Transaction 12. Click Apply. You should see Agreement Tutorial 3 Agreement successfully created at the top of the page. 13. For Trading Partner Participant, click Add. 14. From Supported Business Protocol, select EDI X12 over Internet. 15. From Supported Business Action, select Process_997-Responder. 16. Repeat Steps 6 and 7. 17. For Internal Delivery Channel, select B2B Outbound. 18. For Responding Internal Delivery Channel, select B2B Inbound. 19. Click Apply. You should see Trading partner participant successfully added at the top of the page. 20. For Trading Partner Participant, click Add. 21. From Supported Business Protocol, select EDI X12 over Internet. 22. From Supported Business Action, select Process_855-Responder. 23. Repeat Steps 6 and 7. 24. For Internal Delivery Channel, select B2B Outbound. 25. For Responding Internal Delivery Channel, select B2B Inbound. 26. Click Apply. You should see Trading partner participant successfully added at the top of the page. 27. For Trading Partner Participant, click Add. 28. From Supported Business Protocol, select EDI X12 over Internet. 29. From Supported Business Action, select Process_997-Initiator. 30. Repeat Steps 6 through 9. 31. Click Apply. You should see Trading partner participant successfully added at the top of the page. 32. Click Validate. You should see Agreement Tutorial 3 Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. GlobalChips Server, Task 4: Creating and Deploying the Configuration This task is the same on both servers. See "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-51 for instructions. Both Servers, Task 5: Verifying the Purchase Order Transaction Use the run-time files in Oracle_Home/ip/tutorial/X12/runtime (see Table 5–1 on page 5-5) to verify the transmission and receipt of the purchase order and purchase 5-58 Oracle Application Server Integration B2B User’s Guide Using the EMail Transport Protocol order confirmation. On UNIX platforms, you must grant execute permission using chmod +x to run the scripts. Note: You must run the setenv script to set up the CLASSPATH environment before running the following enqueue and dequeue scripts. See "Setting Up the CLASSPATH Environment" on page 5-3 if you have not already done so. 1. On both the Acme and GlobalChips servers, run one of the following files: ■ In a Bourne or Korn shell—deq.sh ■ In Windows—deq.bat This dequeues the purchase order on the GlobalChips server and the purchase order confirmation on the Acme server. The dequeue script generates a trace file, t1.trc, which shows the message that the application receives from OracleAS Integration B2B. 2. On the Acme server, run one of the following files: ■ In a Bourne or Korn shell— enq_850.sh ■ In Windows— enq_850.bat This enqueues the Acme purchase order and translates it to X12 850 data to send to GlobalChips. Wait a minute or two before proceeding to the next step. On the GlobalChips server, the purchase order is dequeued, which you can see in the trace file, t1.trc. The trace file name can be configured in ipdequeue.properties. 3. On the GlobalChips server, run one of the following files: ■ In a Bourne or Korn shell—enq_855.sh ■ In Windows—enq_855.bat This enqueues the purchase order confirmation from GlobalChips to Acme. Wait a minute before proceeding to the next step. 4. On the Acme server, the purchase order confirmation is dequeued, which you can see in the trace file, t1.trc. The trace file name can be configured in ipdequeue.properties. Using the EMail Transport Protocol In "Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction" on page 5-18, Acme and GlobalChips used the File - 1.0 transport protocol. This section describes how you can modify tutorial 2 (or other protocols that use the generic exchange) so that Acme sends a custom document to Globalchips using the EMail transport protocol. These instructions assume the following: ■ ■ ■ Acme, the host trading partner and initiator, sends a custom document using the EMail transport protocol. GlobalChips is the remote trading partner and responder. For Trading Partner Identification Type, both Acme and GlobalChips are assigned the Generic Identifier type, whose value is the e-mail user name provided for each company on the Transport page. Purchase Order Tutorials 5-59 Using the EMail Transport Protocol ■ ■ The EMail transport protocol for the remote trading partner is used to send only the payload to the host trading partner The procedure for configuring the EMail transport protocol is similar for the host and remote trading partners; the only differences are the values used for Host Name, Username, and Password. To set up the EMail transport server for the host trading partner, see "Setting Up the Host Trading Partner (Acme)" on page 5-27 and replace Steps 6 through 8 with the following: 6. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme Email Acknowledgement Mode None 7. On the Create Trading Partner: Document Exchange page, click Create New. Provide the following information and click Next. Field Value Name Acme DocExchange Exchange Protocol Revision Generic - 1.0 8. On the Create Trading Partner: Transport page, provide the following information and click Next. ■ Select Create New and provide the following information: General Field Value Name Acme Transport Transport Protocol Field Value Transport Protocol Email - 1.0 ■ Select Create New and provide the following information: Transport Server Field Value Name Acme EMail Transport Server Host Name Acme_email_server_name The e-mail server at the Acme site. For example, acm1.acme.com. 5-60 Username email_username Password email_password Parameters - ■ content-type application/b2b ■ send message as attachment true Oracle Application Server Integration B2B User’s Guide Doing More Than One Tutorial ■ Select Create New and provide the following information: Endpoint Field Value URI <Username@hostname> Note the following: ■ ■ ■ E-mail attachments are base64 encoded. If you set the content-type parameter to text/plain, then ^M characters are introduced in the base64-encoded message, which creates problems during decoding. Setting the content-type parameter to application/b2b avoids this problem. Some e-mail servers truncate a payload that is more than 80 or 120 characters long when it is in the message body. Setting the send message as attachment parameter to true avoids this problem by sending the payload as an attachment instead of in the message body. The endpoint of the host trading partner is polled for e-mail messages at regular intervals. The default value is 60 seconds. Doing More Than One Tutorial If you do more than one tutorial, note the following: ■ ■ You should restart the B2B server so that OracleAS Integration B2B can check for new objects in the metadata repository. See "Starting and Stopping the B2B Server with OPMN" on page 5-61 for more information. After completing a tutorial, you may want to see how another B2B scenario works without completing all the setup. You can skip some setup steps by importing XML files with configuration data. See "Importing Configuration Data" on page 5-61 for more information. Starting and Stopping the B2B Server with OPMN At the operating system command prompt, use Oracle Process Manager and Notification Server (OPMN) to restart the B2B server as follows. You must be in the Oracle_Home/opmn/bin directory to run the commands. prompt> opmnctl stopproc process-type=B2BServer prompt> opmnctl startproc process-type=B2BServer See Oracle Process Manager and Notification Server Administrator’s Guide for more information. Importing Configuration Data If you have completed one or more of the tutorials and want to take a shortcut when doing another tutorial, you can import XML files with configuration data. Then you can skip most of the steps in tasks 1, 2, and 3; however, you must update the endpoint, host name, and port for whichever trading partner you are setting up, as described in the following steps. The steps assume that: ■ ■ You are logged in to OracleAS Integration B2B. Your host trading partner name is set to Acme or GlobalChips. See "Changing the Host Trading Partner Name" on page 5-4 for more information. Purchase Order Tutorials 5-61 Doing More Than One Tutorial 1. Purge the metadata repository if you have already completed a tutorial. See "Starting and Stopping the B2B Server with OPMN" on page 5-61 for instructions. 2. Decide which trading partner you are setting up—Acme or GlobalChips. You need this information for Step 4. 3. Click Administration, then Management. 4. Click Browse and find one of the following export files in Oracle_ Home/ip/tutorial/protocolname/config/. For tutorial 1: ■ RN_buyer_export.xml—if you are setting up the Acme server ■ RN_seller_export.xml—if you are setting up the GlobalChips server For tutorial 2: ■ ■ EDIFACT_buyer_export.xml—if you are setting up the Acme server EDIFACT_seller_export.xml—if you are setting up the GlobalChips server For tutorial 3: ■ X12_buyer_export.xml—if you are setting up the Acme server ■ X12_seller_export.xml—if you are setting up the GlobalChips server 5. Click Import. 6. Click Partners. 7. Click Trading Partners. 8. Click the name of the trading partner you are setting up. 9. Click Capabilities. 10. Click the business protocol associated with the tutorial you are doing, as follows: ■ RosettaNet over Internet for tutorial 1 ■ EDI EDIFECT over Generic Exchange for tutorial 2 ■ EDI X12 over Internet for tutorial 3 11. For any of the updatable Endpoints, click Update. 12. For URI, enter one of the following and click Apply. ■ b2b/transportServlet for tutorials 1 and 3, when setting up either Acme or GlobalChips ■ Acme_endpoint for tutorial 2, when setting up Acme ■ GlobalChips_endpoint for tutorial 2, when setting up GlobalChips 13. Repeat Steps 9 and 10 on page 5-62. 14. For Transports, find the name you want to update and click Update. 15. For Endpoint, select the name you entered in Step 12 and click Update. 16. Repeat Steps 9 and 10 on page 5-62. You should see the name you entered in Step 12 in the URI column for Transports. 17. For Transport Servers, find the name you want to update and click Update. 5-62 Oracle Application Server Integration B2B User’s Guide Doing More Than One Tutorial 18. For Host Name, enter one of the following: ■ Acme_hostname if you are setting up Acme This is the name of the transport server host exchanging messages at the Acme site. ■ GlobalChips_hostname if you are setting up GlobalChips This is the name of the transport server host exchanging messages at the GlobalChips site. 19. For Port, enter your port_number and click Update. 20. Repeat Steps 9 and 10 on page 5-62. You should see the name you entered in Step 18 in the Host Name column for Transport Servers. Verify that the Transport Protocol, Transport Server, and Endpoint values are correct. 21. Click Partners, then Agreements. 22. Click one of the following, depending on which tutorial you are doing: ■ Tutorial 1 Agreement ■ Tutorial 2 Agreement ■ Tutorial 3 Agreement 23. Click Validate. 24. Start at task 4, "Creating and Deploying the Configuration," for whichever tutorial you imported an XML file for in steps 4 and 5: ■ ■ ■ For tutorial 1, see "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-12 for instructions for either server. For tutorial 2, see "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-30 for instructions for either server. For tutorial 3, see "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-51 for instructions for either server. Purchase Order Tutorials 5-63 Summary See Also: For more information about steps 12 through 19 on page 5-62, see the following: ■ ■ ■ ■ ■ ■ For tutorial 1, "Setting Up the Remote Trading Partner (GlobalChips)" on page 5-9 and "Setting Up the Host Trading Partner (Acme)" on page 5-10 if you are setting up Acme For tutorial 1, "Setting Up the Remote Trading Partner (Acme)" on page 5-13 and "Setting Up the Host Trading Partner (GlobalChips)" on page 5-15 if you are setting up GlobalChips For tutorial 2, "Setting Up the Remote Trading Partner (GlobalChips)" on page 5-24 and "Setting Up the Host Trading Partner (Acme)" on page 5-27 if you are setting up Acme For tutorial 2, "Setting Up the Remote Trading Partner (Acme)" on page 5-31 and "Setting Up the Host Trading Partner (GlobalChips)" on page 5-35 if you are setting up GlobalChips For tutorial 3, "Setting Up the Remote Trading Partner (GlobalChips)" on page 5-45 and "Setting Up the Host Trading Partner (Acme)" on page 5-48 if you are setting up Acme For tutorial 3,"Setting Up the Remote Trading Partner (Acme)" on page 5-52 and "Setting Up the Host Trading Partner (GlobalChips)" on page 5-56 if you are setting up GlobalChips Summary This chapter provides tutorials for creating RosettaNet, EDI EDIFACT, and EDI X12 configurations. Each tutorial guides you through the steps to design, deploy, and verify a configuration. 5-64 Oracle Application Server Integration B2B User’s Guide 6 Health Care Tutorial The OracleAS Integration B2B tutorials guide you through the steps to design, deploy, and verify B2B scenarios. After using this tutorial, you should be able to create and deploy your own HL7 over MLLP transaction. This chapter contains the following topics: ■ About the Health Care Tutorial ■ Before You Begin the Tutorial ■ Tutorial: Setting Up an HL7 over MLLP Transaction ■ Summary About the Health Care Tutorial This tutorial depicts a scenario in which the admitting unit of a hospital, Acme, sends a notification message of a patient admission to the hospital’s central data repository, GlobalChips. GlobalChips then sends an acknowledgment of the admission notification to Acme. Note: For this tutorial, you set up OracleAS Integration B2B on servers at both Acme and GlobalChips "sites;" that is, on: ■ ■ The Acme server, where Acme is the host trading partner and GlobalChips is the remote trading partner. The GlobalChips server, where GlobalChips is the host trading partner and Acme is the remote trading partner. With this setup, you can verify that the admission notification and acknowledgment are actually sent and received. On both servers, Acme is the buyer and GlobalChips is the seller. Note for MLLP Transactions: For every client and server socket, a listener polls the socket for new messages. If no message is present, the listener sleeps for the interval set in the variable in tip.properties: oracle.tip.adapter.b2b.mllp.pollInterval The default value is 1000 milliseconds. Health Care Tutorial 6-1 Before You Begin the Tutorial Before You Begin the Tutorial Before you begin the tutorial, see the following sections: ■ "Installing OracleAS Integration B2B" on page 5-3 ■ "Setting Up the CLASSPATH Environment" on page 5-3 ■ "Logging In to OracleAS Integration B2B" on page 5-3 ■ "Changing the Host Trading Partner Name" on page 5-4 Table 6–1 lists the configuration and run-time files that are used in this tutorial. You use these files to verify the transaction in task 5 of this tutorial. See "Both Servers, Task 5: Verifying the ADT_A01 Transaction" on page 6-16 for instructions. Table 6–1 Run-Time and Configuration Files Used in the Tutorial Run-Time Files Configuration Files a01.xml ACK_A01.ecs deq.sh ACK_A01.xsd deq.bat ADT_A01.ecs enq_a01.sh ADT_A01.xsd enq_a01.bat hl7_buyer.xml enq_a01.properties hl7_seller.xml ipdequeue.properties The files are found at Oracle_Home/ip/tutorial/protocolname Note: The path name delimiter used in this documentation, /, is for UNIX. If you are using Windows, assume that the path name delimiter is \. Tutorial: Setting Up an HL7 over MLLP Transaction In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server. One person does the following tasks: ■ Acme Server, Task 1: Creating the Business Actions ■ Acme Server, Task 2: Setting Up the Trading Partners ■ Acme Server, Task 3: Creating the Trading Partner Agreement ■ Acme Server, Task 4: Creating and Deploying the Configuration In parallel, the other person does the following tasks: 6-2 ■ GlobalChips Server, Task 1: Creating the Business Actions ■ GlobalChips Server, Task 2: Setting Up the Trading Partners ■ GlobalChips Server, Task 3: Creating the Trading Partner Agreement ■ GlobalChips Server, Task 4: Creating and Deploying the Configuration Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5: ■ Both Servers, Task 5: Verifying the ADT_A01 Transaction Note: Fields and checkboxes that you should accept default values for, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly. Acme Server, Task 1: Creating the Business Actions In the following set of tasks, Acme is the host trading partner. You create the following business actions for this transaction. ■ ■ Process_A01—Acme uses the Process_A01 business action to send an admission notification to GlobalChips. Process_ACK—GlobalChips uses the Process_ACK business action to send an acknowledgment of the admission notification to Acme. See "Creating a Business Action" on page 8-20 for more information. Creating the Process_A01 Business Action—Acme Sends an ADT_A01 Message 1. Click Partners, then Protocols. 2. Click HL7 over MLLP Exchange. 3. From Shortcut, click Create Business Action. 4. On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_A01 Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode None 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Name HL7 Revision 2.3.1 Translation Enabled Yes Validation Enabled Yes Document Protocol Parameters Field Override Value1 [Sending App ID] ACME APP Health Care Tutorial 6-3 Tutorial: Setting Up an HL7 over MLLP Transaction Document Protocol Parameters Field Override Value1 [Sending Facility] ACME FAC [Receiving App ID] ACME APP [Receiving Facility] ACME FAC Processing ID P Accept Acknowledgement Type AL Application Acknowledgement Type AL Country Code US Character Set ASCII 1 If you are working on the GlobalChips server, use GC instead of ACME in the override value. Note: The values in the Document Protocol Parameter fields replace the macros in the MSH segment of the payload. 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name ADT_A01 Revision 2.3.1 Document Definition Field Value Name A01 Definition Definition ADT_A01.xsd Document Type Parameters Field Override Value Message Set ecs File ADT_A01.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_A01 : 1.0 successfully created at the top of the page. Creating the Process_ACK Business Action—Acknowledgment You create the Process_ACK business action for the seller, GlobalChips, to send an acknowledgment to Acme. 6-4 1. Click Partners, then Protocols. 2. Click HL7 over MLLP Exchange. 3. From Shortcut, click Create Business Action. 4. On the Create Business Action: General page, provide the following information and click Next. Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction Field Value Name Process_ACK Revision 1.0 Acknowledgement Mode None 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Create Mode Use Existing Document Protocol Revision HL7 - 2.3.1 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Override Value Name ACK_A01 Revision 2.3.1 Document Definition Field Value Name ACK Definition Definition ACK_A01.xsd Document Type Parameters Field Override Value Message Set ecs File ACK_A01.ecs 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_ACK : 1.0 successfully created at the top of the page. Acme Server, Task 2: Setting Up the Trading Partners On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (GlobalChips) ■ Setting Up the Host Trading Partner (Acme) If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See the following for more information: Health Care Tutorial 6-5 Tutorial: Setting Up an HL7 over MLLP Transaction ■ ■ ■ "Changing the Host Trading Partner Name" on page 5-4 "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Setting Up the Remote Trading Partner (GlobalChips) As you set up GlobalChips, you associate it with the following business actions: ■ ■ Process_ACK-Initiator. GlobalChips initiates the Process_ACK business action when it sends an acknowledgment to Acme. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. 3. On the Create Trading Partner: General page, provide the remote trading partner name, GlobalChips, and click Next. 4. On the Create Trading Partner: Identification page, for the MLLP ID value, enter the fully qualified domain name of the GlobalChips host machine and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol HL7 over MLLP Exchange Business Action Process_A01 Is Initiator False Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ADT_A01 Use Existing Document Protocol Parameter Values Uncheck the box. Use Default Document Definition Check the box. 6. 6-6 Process_A01-Responder. GlobalChips responds to the Process_A01 business action after it receives the admission notification. Continuing on the next Create Trading Partner: Operational Capability page, provide the following override values and click Next. Document Protocol Parameters Field Override Value [Sending App ID] GC APP [Sending Facility] GC FAC [Receiving App ID] GC APP [Receiving Facility] GC FAC Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction Document Protocol Parameters Field Override Value Processing ID P Accept Acknowledgement Type AL Application Acknowledgement Type AL Country Code US Character Set ASCII 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips Permanent MLLP Acknowledgement Mode None 8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name GlobalChips Permanent DocEx Exchange Protocol Revision MLLP - 1.0 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name GlobalChips MLLP Perm Transport Transport Protocol Field Value Transport Protocol TCP - 1.0 Transport Server Field Value Name GlobalChips MLLP Perm Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Parameters Field Current Value Port MLLP_server_portnumber Permanent Connection Type True a. Click Create New, provide the following information, and click Next. Health Care Tutorial 6-7 Tutorial: Setting Up an HL7 over MLLP Transaction Endpoint Field Value URI any_string11 1 Provide any string because this is a required field. 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner GlobalChips successfully created at the top of the page. 11. Click Capabilities. 12. Click HL7 over MLLP Exchange. 13. Click Create Operational Capability. 14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_ACK Is Initiator True Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ACK_A01 You should see Supported business action created successfully at the top of the page, for Process_ACK - Initiator. Setting Up the Host Trading Partner (Acme) In the following steps, you set up the host trading partner’s MLLP ID and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 6-8 1. Click Partners, then Trading Partners. 2. Click Acme (Host). 3. Under Trading Partner Identifications, click Create. 4. For Trading Partner Identification Type, select MLLP ID. 5. For Value, enter the fully qualified domain name of the Acme host machine (for example, myhost.example.com.). 6. Click Apply. 7. Click Capabilities. 8. Click HL7 over MLLP Exchange. 9. Click Create Communication Capability. Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction 10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme Permanent MLLP Acknowledgement Mode None 11. On the Create Trading Partner: Document Exchange page, click Create New. a. Provide the following information and click Next. Field Value Name Acme Permanent DocEx Exchange Protocol Revision MLLP - 1.0 12. On the Create Trading Partner: Transport page, do the following and click Next. a. Select Create New and provide the following information: General Field Value Name Acme MLLP Perm Transport Transport Protocol Field Value Transport Protocol TCP - 1.0 b. Select Create New and provide the following information: Transport Server Field Value Name Acme MLLP Perm Transport Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Parameters Field Value Port MLLP_server_portnumber Permanent Connection Type True c. Select Create New and provide the following information: Endpoint Field Value URI any_string21 1 Provide any string because this is a required field. Do not use the same string you entered previously. 13. Review the data and click Finish, or make changes using Back. Health Care Tutorial 6-9 Tutorial: Setting Up an HL7 over MLLP Transaction You should see Communication Capability created successfully at the top of the page. Acme Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the remote trading partner in the agreement. Acme is also automatically assigned a business action that is compatible with the one assigned to GlobalChips. Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select GlobalChips. 4. From Supported Business Protocol, select HL7 over MLLP Exchange. 5. From Supported Business Action, select Process_A01 - Responder. 6. For Trading Partner Identification, select MLLP ID - hostname for both GlobalChips and Acme. 7. For Trading Partner Delivery Channel, select GlobalChips Permanent MLLP and Acme Permanent MLLP. 8. In the Name field, enter HL7 MLLP Permanent Agreement. 9. In the Agreement ID field, enter 1800. 10. Click Apply. You should see Agreement HL7 MLLP Permanent Agreement successfully created at the top of the page. 11. Under Trading Partner Participants, click Add. 12. From Supported Business Protocol, select HL7 over MLLP Exchange. 13. From Supported Business Action, select Process_ACK - Initiator. 14. Repeat Steps 6 and 7. 15. Click Apply. You should see Trading partner participant successfully added. 16. Click Validate. You should see Agreement HL7 MLLP Permanent Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. Acme Server, Task 4: Creating and Deploying the Configuration After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment. 6-10 Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction 1. Click Deployment. 2. Click Create. 3. For Configuration Name, enter HL7 MLLP Permanent Configuration. 4. Select HL7 MLLP Permanent Agreement. 5. Click Apply. You should see Creation and validation of configuration HL7 MLLP Permanent Configuration successful. 6. For HL7 MLLP Permanent Configuration, click Deploy. 7. Review the list of configurations and click Deploy. You should see Deployment finished successfully for configuration HL7 MLLP Permanent Configuration. See Chapter 13, "Creating and Deploying a Configuration" for more information. Task 5: Verifying the Purchase Order Transaction See "Both Servers, Task 5: Verifying the ADT_A01 Transaction" on page 6-16 for instructions. GlobalChips Server, Task 1: Creating the Business Actions Acme and GlobalChips use the same set of business actions. So, on the GlobalChips server, create the same business actions that were created on the Acme server. See "Acme Server, Task 1: Creating the Business Actions" on page 6-3 for instructions. As you follow the instructions, substitute GlobalChips for Acme in the override values for the document protocol parameters (as footnoted). GlobalChips Server, Task 2: Setting Up the Trading Partners On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (Acme) ■ Setting Up the Host Trading Partner (GlobalChips) If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See the following for more information: ■ ■ ■ "Changing the Host Trading Partner Name" on page 5-4 "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Health Care Tutorial 6-11 Tutorial: Setting Up an HL7 over MLLP Transaction Setting Up the Remote Trading Partner (Acme) As you set up Acme, you associate it with the following business actions: ■ ■ Process_ACK-Responder. Acme receives an acknowledgment from GlobalChips. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. 3. On the Create Trading Partner: General page, provide the remote trading partner name, Acme, and click Next. 4. On the Create Trading Partner: Identification page, for the MLLP ID value, enter the fully qualified domain name of the Acme host machine and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol HL7 over MLLP Exchange Business Action Process_A01 Is Initiator True Functional acknowledgement required? Yes Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ADT_A01 Use Existing Document Protocol Parameter Values Uncheck the box. Use Default Document Definition Check the box. 6. 6-12 Process_A01-Initiator. Acme is the initiator of the Process_A01 business action when it sends the admission notification to GlobalChips. Continuing on the next Create Trading Partner: Operational Capability page, provide the following override values and click Next. Document Protocol Parameters Field Override Value [Sending App ID] ACME APP [Sending Facility] ACME FAC [Receiving App ID] ACME APP [Receiving Facility] ACME FAC Processing ID P Accept Acknowledgement Type AL Application Acknowledgement Type AL Country Code US Character Set ASCII Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme Permanent MLLP Acknowledgement Mode None 8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name Acme Permanent DocEx Exchange Protocol Revision MLLP - 1.0 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name Acme MLLP Perm Transport Transport Protocol Field Value Transport Protocol TCP - 1.0 Transport Server Field Value Name Acme MLLP Perm Transport Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Parameters Field Value Port MLLP_server_portnumber Permanent Connection Type True a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI None 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner Acme created successfully at the top of the page. 11. Click Capabilities. 12. Click HL7 over MLLP Exchange. Health Care Tutorial 6-13 Tutorial: Setting Up an HL7 over MLLP Transaction 13. Click Create Operational Capability. 14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply. General Field Value Business Action Process_ACK Is Initiator False Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ACK_A01 You should see Supported business action created successfully at the top of the page, for Process_ACK - Responder. Setting Up the Host Trading Partner (GlobalChips) In the following steps, you set up the host trading partner’s MLLP ID and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click GlobalChips (Host). 3. Under Trading Partner Identifications, click Create. 4. For Trading Partner Identification Type, select MLLP ID. 5. For Value, enter the fully qualified domain name of the GlobalChips host machine. 6. Click Apply. 7. Click Capabilities. 8. Click HL7 over MLLP Exchange. 9. Click Create Communication Capability. 10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips Permanent MLLP Acknowledgement Mode None 11. On the Create Trading Partner: Document Exchange page, click Create New. a. 6-14 Provide the following information and click Next. Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up an HL7 over MLLP Transaction Field Value Name GlobalChips Permanent DocEx Exchange Protocol Revision MLLP - 1.0 12. On the Create Trading Partner: Transport page, do the following information and click Next. a. Select Create New and provide the following information: General Field Value Name GlobalChips MLLP Perm Transport Transport Protocol Field Value Transport Protocol TCP - 1.0 b. Select Create New and provide the following information: Transport Server Field Value Name GlobalChips MLLP Perm Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Parameters Field Value Port MLLP_server_portnumber Permanent Collection Type True c. Select Create New and provide the following information: Endpoint Field Value URI any_string1 1 Provide any string in this required field. Do not use the same string you entered previously. 13. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. GlobalChips Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the remote trading partner in the agreement. GlobalChips is also automatically assigned a business action that is compatible with the one assigned to Acme. Health Care Tutorial 6-15 Tutorial: Setting Up an HL7 over MLLP Transaction Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select Acme. 4. From Supported Business Protocol, select HL7 over MLLP Exchange. 5. From Supported Business Action, select Process_A01-Initiator. 6. For Trading Partner Identification, select MLLP ID - hostname for both Acme and Globalchips. 7. For Trading Partner Delivery Channel, select Acme Permanent MLLP and GlobalChips Permanent MLLP. 8. In the Name field, enter HL7 Permanent Agreement. 9. In the Agreement ID field, enter 1900. 10. Click Apply. You should see Agreement HL7 Permanent Agreement successfully created at the top of the page. 11. Under Trading Partner Participants, click Add. 12. From Supported Business Protocol, select HL7 over MLLP Exchange. 13. From Supported Business Action, select Process_ACK - Responder. 14. Repeat Steps 6 and 7. 15. Click Apply. You should see Trading partner participant successfully added. 16. Click Validate. You should see Agreement HL7 Permanent Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. GlobalChips Server, Task 4: Creating and Deploying the Configuration This step is the same on both servers. See "Acme Server, Task 4: Creating and Deploying the Configuration" on page 6-10 for instructions. Both Servers, Task 5: Verifying the ADT_A01 Transaction To verify the transmission and receipt of the ADT_A01 and ACK messages, use the run-time files at Oracle_Home/ip/tutorial/hl7/runtime Table 6–1 on page 6-2 lists the run-time files. On UNIX platforms, you must grant execute permission using chmod +x to run the scripts. 6-16 Oracle Application Server Integration B2B User’s Guide Summary Note: You must run the setenv script to set up the CLASSPATH environment before running the following enqueue and dequeue scripts. See "Setting Up the CLASSPATH Environment" on page 5-3 if you have not already done so. 1. On the GlobalChips server, run one of the following files: ■ In a Bourne or Korn shell—deq.sh ■ In Windows—deq.bat This dequeues the ADT_A01 message on the GlobalChips server. 2. On the Acme server, run one of the following files: ■ In a Bourne or Korn shell—enq_a01.sh ■ In Windows—enq_a01.bat This enqueues the ADT_A01 message and translates it into a native Hl7 message to send to GlobalChips. Wait a minute or two before proceeding to the next step. On the GlobalChips server, the message is dequeued, which you can see in the trace file, t1.trc. The trace file which shows the message that the application receives from OracleAS Integration B2B. 3. Click Reports in the user interface to view the acknowledgment generated by GlobalChips. Summary This chapter provides a tutorial for creating an HL7 over MLLP configuration. The tutorial guides you through the steps to design, deploy, and verify the configuration. Health Care Tutorial 6-17 Summary 6-18 Oracle Application Server Integration B2B User’s Guide 7 Custom XML Document Tutorial The OracleAS Integration B2B tutorials guide you through the steps to design, deploy, and verify B2B scenarios. After using this tutorial, you should be able to create and deploy your own custom document over ebXML messaging service (ebMS) transaction. This chapter contains the following topics: ■ About the Custom XML Document Tutorial ■ Before You Begin the Tutorial ■ Tutorial: Setting Up a Custom Document over ebMS Transaction ■ Summary About the Custom XML Document Tutorial This tutorial depicts a scenario in which Acme sends a custom XML document using the ebMS exchange protocol to GlobalChips. Note: For this tutorial, you set up OracleAS Integration B2B on servers at both Acme and GlobalChips "sites;" that is, on: ■ ■ The Acme server, where Acme is the host trading partner and GlobalChips is the remote trading partner. The GlobalChips server, where GlobalChips is the host trading partner and Acme is the remote trading partner. With this setup, you can verify that the custom XML document is sent and received. On both servers, Acme is the buyer and GlobalChips is the seller. Before You Begin the Tutorial Before you begin the tutorial, see the following sections: ■ "Installing OracleAS Integration B2B" on page 5-3 ■ "Setting Up the CLASSPATH Environment" on page 5-3 ■ "Logging In to OracleAS Integration B2B" on page 5-3 ■ "Changing the Host Trading Partner Name" on page 5-4 Custom XML Document Tutorial 7-1 Tutorial: Setting Up a Custom Document over ebMS Transaction Note: The path name delimiter used in this documentation, /, is for UNIX. If you are using Windows, assume that the path name delimiter is \. Tutorial: Setting Up a Custom Document over ebMS Transaction In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server. One person does the following tasks: ■ Acme Server, Task 1: Creating the Business Action ■ Acme Server, Task 2: Setting Up the Trading Partners ■ Acme Server, Task 3: Creating the Trading Partner Agreement ■ Acme Server, Task 4: Creating and Deploying the Configuration In parallel, the other person does the following tasks: ■ GlobalChips Server, Task 1: Creating the Business Action ■ GlobalChips Server, Task 2: Setting Up the Trading Partners ■ GlobalChips Server, Task 3: Creating the Trading Partner Agreement ■ GlobalChips Server, Task 4: Creating and Deploying the Configuration After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5: ■ Both Servers, Task 5: Verifying the Transaction Note: Fields and checkboxes that you should accept default values for, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly. Note about ebMS: OracleAS Integration B2B maps INREPLYTO_ MSG_ID (see Table 4–1, " IP_MESSAGE_TYPE Parameters" on page 4-3) to the ebMS conversation_id parameter. Acme Server, Task 1: Creating the Business Action In the following set of tasks, Acme is the host trading partner. You create the following business actions for this transaction. ■ Process_ebMSRequest—Acme uses the Process_ebMSRequest business action to send an XML document to GlobalChips. See "Creating a Business Action" on page 8-20 for more information. Creating the Process_ebMSRequest Business Action—Acme Sends an ebMS Document 1. 7-2 Click Partners, then Protocols. Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up a Custom Document over ebMS Transaction 2. Click Custom Document over ebMS. 3. From Shortcut, click Create Business Action. 4. On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_ebMSRequest Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Name ebMS Document Protocol Revision Revision 1.0 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name ebMS doc type Revision 1.0 Document Definition Field Value Name ebMS doc def Definition ebMSOrder.xsd Document Type Parameters Field Override Value Service Acme Service Service Type Acme Service Type From Role Acme From Role To Role Acme To Role 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_ebMSRequest : 1.0 successfully created at the top of the page. Custom XML Document Tutorial 7-3 Tutorial: Setting Up a Custom Document over ebMS Transaction Acme Server, Task 2: Setting Up the Trading Partners On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner. This section contains these topics: ■ Setting Up the Remote Trading Partner (GlobalChips) ■ Setting Up the Host Trading Partner (Acme) If you have not already done so, change the default host trading partner name from MyCompany to: ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See the following for more information: ■ ■ ■ "Changing the Host Trading Partner Name" on page 5-4 "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Setting Up the Remote Trading Partner (GlobalChips) As you set up GlobalChips, you associate it with the Process_A01-Responder business actions. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. 3. On the Create Trading Partner: General page, provide the remote trading partner name, GlobalChips, and click Next. 4. On the Create Trading Partner: Identification page, for the ebMS Identifier value, enter GlobalChips and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol Custom Document over ebMS Business Action Process_ebMSRequest Is Initiator False Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes 6. 7-4 Continuing on the Create Trading Partner: Operational Capability page, provide the following information and click Next. Document Information Field Value Document Type ebMS doc type Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up a Custom Document over ebMS Transaction Document Information Field Value Use Existing Document Protocol Parameter Values Check the box. Use Default Document Definition Check the box. 7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips ebMS DC Acknowledgement Mode Async 8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name GlobalChips ebMS DocEx Exchange Protocol Revision ebMS - 2.0 9. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name GlobalChips ebMS Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Port port_number a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI b2b/transportServlet 10. Review the data and click Finish, or make changes using Back. You should see Trading Partner GlobalChips successfully created at the top of the page. Custom XML Document Tutorial 7-5 Tutorial: Setting Up a Custom Document over ebMS Transaction Setting Up the Host Trading Partner (Acme) In the following steps, you set up the host trading partner’s ebMS identifier and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click Acme (Host). 3. Under Trading Partner Identifications, click Create. 4. For Trading Partner Identification Type, select ebMS Identifier. 5. For Value, enter Acme. 6. Click Apply. 7. Click Capabilities. 8. Click Custom Document over ebMS. 9. Click Create Communication Capability. 10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme ebMS DC Acknowledgement Mode Async 11. On the Create Trading Partner: Document Exchange page, click Create New. a. Provide the following information and click Next. Field Value Name Acme ebMS DocEx Exchange Protocol Revision ebMS - 2.0 12. On the Create Trading Partner: Transport page, do the following and click Next. a. General Field Value Name Acme ebMS Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 b. 7-6 Select Create New and provide the following information: Select Create New and provide the following information: Transport Server Field Value Name Acme Transport Server Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up a Custom Document over ebMS Transaction Transport Server Field Value Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Port port_number c. Select Use Existing and provide the following information: Endpoint Field Value URI b2b/transportServer 13. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. Acme Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the remote trading partner in the agreement. Acme is also automatically assigned a business action that is compatible with the one assigned to GlobalChips. Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select GlobalChips. 4. From Supported Business Protocol, select Custom Document over ebMS. 5. From Supported Business Action, select Process_ebMSRequest - Responder. 6. For Trading Partner Identification, select ebMS Identifier - hostname for both GlobalChips and Acme. 7. For Trading Partner Delivery Channel, select GlobalChips ebMS DC and Acme ebMS DC. 8. In the Name field, enter ebMS Agreement. 9. In the Agreement ID field, enter agr1. The same value for Agreement ID must be used for both trading partners. 10. Click Apply. You should see Agreement ebMS Agreement successfully created at the top of the page. 11. Click Validate. You should see Agreement ebMS Agreement is valid. The agreement is approved as part of the validation. Custom XML Document Tutorial 7-7 Tutorial: Setting Up a Custom Document over ebMS Transaction See "Creating a Trading Partner Agreement" on page 12-5 for more information. Acme Server, Task 4: Creating and Deploying the Configuration After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment. 1. Click Deployment. 2. Click Create. 3. For Configuration Name, enter ebMS Configuration. 4. Select ebMS Agreement. 5. Click Apply. 6. For ebMS Configuration, click Deploy. 7. Review the list of configurations and click Deploy. You should see Deployment finished successfully for configuration ebMS Configuration. See Chapter 13, "Creating and Deploying a Configuration" for more information. Task 5: Verifying the Purchase Order Transaction See "Both Servers, Task 5: Verifying the Transaction" on page 7-14 for instructions. GlobalChips Server, Task 1: Creating the Business Action In the following set of tasks, GlobalChips is the host trading partner. You create the following business action for this transaction. ■ Process_ebMSRequest—GlobalChips uses the Process_ebMSRequest business action to send an XML document to Acme. See "Creating a Business Action" on page 8-20 for more information. Creating the Process_ebMSRequest Business Action—GlobalChips Sends an ebMS Document 7-8 1. Click Partners, then Protocols. 2. Click Custom Document over ebMS. 3. From Shortcut, click Create Business Action. 4. On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process_ebMSRequest Revision 1.0 Is Nonrepudiation of Receipt Required No Is Nonrepudiation of Origin Required No Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up a Custom Document over ebMS Transaction Field Value Acknowledgement Mode Async 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Name ebMS Document Protocol Revision Revision 1.0 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name ebMS doc type Revision 1.0 Document Definition Field Value Name ebMS doc def Definition ebMSOrder.xsd Document Type Parameters Field Override Value Identification Value POReq Identification Expression (XPath) for XML Document /Query/DocType/text() Service GlobalChips Service Service Type GlobalChips Service Type From Role GlobalChips From Role To Role GlobalChips To Role 7. Review the data and click Finish, or make changes using Back. You should see Business Action Process_ebMSRequest : 1.0 successfully created at the top of the page. GlobalChips Server, Task 2: Setting Up the Trading Partners On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner. This section contains these topics: ■ Setting Up the Host Trading Partner (Acme) ■ Setting Up the Host Trading Partner (GlobalChips) If you have not already done so, change the default host trading partner name from MyCompany to: Custom XML Document Tutorial 7-9 Tutorial: Setting Up a Custom Document over ebMS Transaction ■ Acme, if you are working on the Acme server ■ GlobalChips, if you are working on the GlobalChips server See the following for more information: ■ ■ ■ "Changing the Host Trading Partner Name" on page 5-4 "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Setting Up the Remote Trading Partner (Acme) As you set up Acme, you associate it with the following business actions: ■ ■ Process_ACK-Responder. Acme receives an acknowledgment from GlobalChips. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner. 3. On the Create Trading Partner: General page, provide the remote trading partner name, Acme, and click Next. 4. On the Create Trading Partner: Identification page, for the ebMS Identifier value, enter Acme and click Next. 5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next. General Field Value Business Protocol Custom Document over ebMS Business Action Process_ebMSRequest Is Initiator False Functional acknowledgement required? No Is acknowledgement handled by Integration B2B? Yes Document Information Field Value Document Type ebMS doc type Use Existing Document Protocol Parameter Values Check the box. Use Default Document Definition Check the box. 6. 7-10 Process_A01-Initiator. Acme is the initiator of the Process_A01 business action when it sends the admission notification to GlobalChips. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name Acme ebMS DC Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up a Custom Document over ebMS Transaction Field Value Acknowledgement Mode Async 7. On the Create Trading Partner: Document Exchange page, provide the following information and click Next. Field Value Name Acme ebMS DocEx Exchange Protocol Revision ebMS - 2.0 8. On the Create Trading Partner: Transport page, provide the following information. General Field Value Name Acme ebMS Transport Transport Protocol Field Value Transport Protocol HTTP - 1.1 Transport Server Field Value Name Acme Transport Server Host Name Acme_hostname The transport server host exchanging messages at the Acme site. Port port_number a. Click Create New, provide the following information, and click Next. Endpoint Field Value URI b2b/transportServlet 9. Review the data and click Finish, or make changes using Back. You should see Trading Partner Acme created successfully at the top of the page. Setting Up the Host Trading Partner (GlobalChips) In the following steps, you set up the host trading partner’s ebMS Identifier and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner. 1. Click Partners, then Trading Partners. 2. Click GlobalChips (Host). 3. Under Trading Partner Identifications, click Create. 4. For Trading Partner Identification Type, select ebMS Identifier. Custom XML Document Tutorial 7-11 Tutorial: Setting Up a Custom Document over ebMS Transaction 5. For Value, enter GlobalChips. 6. Click Apply. 7. Click Capabilities. 8. Click Custom Document over ebMS. 9. Click Create Communication Capability. 10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next. Field Value Name GlobalChips ebMS DC Acknowledgement Mode Async 11. On the Create Trading Partner: Document Exchange page, click Create New. a. Provide the following information and click Next. Field Value Name GlobalChips ebMS DocEx Exchange Protocol Revision ebMS - 2.0 12. On the Create Trading Partner: Transport page, do the following information and click Next. a. Select Create New and provide the following information: General Field Value Name GlobalChips ebMS Transport Transport Protocol Field Value Transport Protocol HTTP- 1.1 b. Select Create New and provide the following information: Transport Server Field Value Name GlobalChips Transport Server Host Name GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site. Port port_number c. 7-12 Select Use Existing and provide the following information: Endpoint Field Value URI b2b/transportServlet Oracle Application Server Integration B2B User’s Guide Tutorial: Setting Up a Custom Document over ebMS Transaction 13. Review the data and click Finish, or make changes using Back. You should see Communication Capability created successfully at the top of the page. GlobalChips Server, Task 3: Creating the Trading Partner Agreement As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the remote trading partner in the agreement. GlobalChips is also automatically assigned a business action that is compatible with the one assigned to Acme. 1. Click Partners. 2. From Shortcuts, click Create Trading Partner Agreement. 3. From Trading Partner, select Acme. 4. From Supported Business Protocol, select Custom Document over ebMS. 5. From Supported Business Action, select Process_ebMSRequest-Responder. 6. For Trading Partner Identification, select ebMS - trading_partner_name for both Acme and Globalchips. 7. For Trading Partner Delivery Channel, select Acme ebMS DC and GlobalChips ebMS DC. 8. In the Name field, enter ebMS Agreement. 9. In the Agreement ID field, enter agr1. The Agreement ID value here must match the ID used in the sender’s agreement. 10. Click Apply. You should see Agreement ebMS Agreement successfully created at the top of the page. 11. Click Validate. You should see Agreement ebMS Agreement is valid. The agreement is approved as part of the validation. See "Creating a Trading Partner Agreement" on page 12-5 for more information. GlobalChips Server, Task 4: Creating and Deploying the Configuration After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment. 1. Click Deployment. 2. Click Create. 3. For Configuration Name, enter ebMS Configuration. 4. Select ebMS Agreement. 5. Click Apply. 6. For ebMS Configuration, click Deploy. 7. Review the list of configurations and click Deploy. Custom XML Document Tutorial 7-13 Summary You should see Deployment finished successfully for configuration ebMS Configuration. See Chapter 13, "Creating and Deploying a Configuration" for more information. Both Servers, Task 5: Verifying the Transaction Table 7–1 lists the files that you use to verify the transaction. Table 7–1 Files Used in the Tutorial File Name Description ebMSOrder.xml The payload that the buyer sends to the seller ebMSOrder.xsd Describes the payload enq_ebMSOrder.properties Parameter file with information needed to enqueue the payload to IP_OUT_QUEUE on the B2B server enq_order.bat Calls IPEnqueue and passes it the enq_ ebMSOrder.properties file. enq_order.sh See Chapter 16, "Utilities for Enqueuing and Dequeuing" for more information about IPEnqueue. The files are found at Oracle_Home/ip/tutorial/protocolname 1. On the Acme server, go the directory that contains the tutorial files and run enq_ order.bat or enq_order.sh. 2. Using the OracleAS Integration B2B user interface on the Acme server, run a Business Message Status Report to see if the message was sent. a. Click Reports. b. Click Business Message. c. Click Run Report. If the message was sent, you see two lines in the report, one for the order and one for the acknowledgment. The state field should say complete. You can run the same report from the GlobalChips server. Summary This chapter provides a tutorial for creating a Custom Document over ebMS configuration. The tutorial guides you through the steps to design, deploy, and verify the configuration. 7-14 Oracle Application Server Integration B2B User’s Guide Part III Using the User Interface for Design-Time and Deployment Tasks This part describes how to design and deploy a configuration consisting of a trading partner agreement between trading partners using the Oracle Application Server Integration B2B user interface. This part contains the following chapters: ■ Chapter 8, "Managing Business Protocols" ■ Chapter 9, "Creating Trading Partners" ■ Chapter 10, "Managing Trading Partners" ■ Chapter 11, "Managing Callouts" ■ Chapter 12, "Creating and Managing Trading Partner Agreements" ■ Chapter 13, "Creating and Deploying a Configuration" 8 Managing Business Protocols This chapter describes the tasks required to manage business protocols. You assign support for business protocols to the remote trading partner. The host trading partner is automatically assigned support for all business protocols in Oracle Application Server Integration B2B. This chapter contains the following topics: ■ Business Protocol Management Overview ■ Viewing Business Protocols ■ Managing Document Protocols ■ Viewing Exchange Protocols ■ Managing Process Protocols ■ Common User Errors ■ Summary Business Protocol Management Overview Each trading partner must have support for a business protocol. The business protocol identifies the implementation guidelines to use for the reliable transport of messages between trading partners. You use the OracleAS Integration B2B user interface to create operational capability and communication capabilities for the selected business protocol of the trading partner. Trading partners define their operational capabilities by the support for a business action (for any EDI, HL7, or Custom Document business protocol) or collaboration (for the RosettaNet over RNIF business protocol). The business protocol is comprised of three protocols: document, exchange, and process (of which business actions and collaborations are a part). Figure 8–1 shows the business protocol format. Figure 8–2 shows a specific example of the type of process, document, and exchange protocol details that can display for a business protocol (in this example, RosettaNet over RNIF). This format is reflected in the layout of the OracleAS Integration B2B user interface (and shown throughout this chapter). Managing Business Protocols 8-1 Business Protocol Management Overview Figure 8–1 Business Protocol Format Business Protocol Process Protocol Collaboration (for RosettaNet over RNIF) Business Action (for EDI or Custom Document) Document Protocol Document Protocol Revision Document Type Document Definition Exchange Protocol Transport Protocol Packaging Protocol Figure 8–2 Business Protocol Format: RosettaNet Example Business Protocol: RosettaNet over RNIF Process Protocol: B2B Collaboration: Buyer - 3A4 - V02.00 Document Protocol: RosettaNet Document Protocol Revision: V02.00 Document Type: RequestPurchaseOrder Document Definition: PurchaseOrder.dtd Exchange Protocol: RNIF V02.00 Transport Protocol: HTTP Packaging Protocol: MIME Note: Figure 8–2 shows a .dtd file as the document definition file with RosettaNet over RNIF. You can also specify .xsd files as the document definition file. OracleAS Integration B2B enables you to either import standard .dtd files downloaded from the RosettaNet Web site or import .xsd or .dtd files created with the OracleAS Integration B2B - Document Editor. At run time, the payload must conform to the document definition file type you use. See "Supported Protocols" on page 1-3 for more information. Collaborations and Business Actions Overview Figure 8–1 and Figure 8–2 show that collaborations and business actions appear as part of the process protocol for a business protocol. Collaborations and business actions describe the business documents and their movement between trading partners. Trading partners define their operational capabilities by the collaborations and business actions they support. When you create a remote trading partner with the Create Trading Partner wizard, you assign it either support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI, HL7, or Custom Document business protocol). The host trading partner is automatically assigned a business action or collaboration that is compatible with the selection for the remote trading partner. 8-2 Oracle Application Server Integration B2B User’s Guide Business Protocol Management Overview Collaborations and business actions can be bidirectional. When you create support for a collaboration or business action of a trading partner, you also specify whether the trading partner initiates or responds to the collaboration. The OracleAS Integration B2B user interface provides two methods for creating support for collaborations and business actions. Table 8–1 describes these methods: Table 8–1 Methods for Creating Support for Collaborations and Business Actions Method Description Import through a file The following frequently used collaborations, transaction sets, and standards are automatically installed with OracleAS Integration B2B. You can import them into the design-time repository. This enables you to see and use them in the OracleAS Integration B2B user interface. ■ ■ ■ ■ ■ Approximately 25 RosettaNet collaborations. See Table 3–2, " RosettaNet PIPs Supported in OracleAS Integration B2B" on page 3-4 for a list. EDI X12, document protocol revision 4010 with transaction sets 850 purchase order, 855 purchase order acknowledgment, and 997 functional acknowledgment EDI EDIFACT, document protocol revision D98A with transaction sets ORDERS purchase order message and ORDRSP purchase order response message, and document protocol revision D3 with transaction set CONTRL syntax and service report message HL7, document protocol revision 2.3.1 with document type A01 UCCnet, document protocol revision 2.3.1 (available under Custom Document support) An EDI transaction set maps to a document type of a business action in the OracleAS Integration B2B user interface. After importing these files by clicking Administration, then Management, and then Import, the business actions and collaborations display in the Process Protocol Revision Details page. (See Figure 8–7 on page 8-19 and Figure 8–8 on page 8-20, respectively.) You can then assign support for collaborations and business actions to a remote trading partner with the Create Trading Partner wizard. Create through wizards You can create your own support for collaborations and business actions with the Create Collaboration wizard and Create Business Action wizard, respectively. Use of both wizards is described in this chapter. For example, if you want to use a RosettaNet collaboration that is not included in the import file described previously, you can use the Create Collaboration wizard. Once complete, you can assign support for collaborations and business actions to a remote trading partner. See the following for more information: ■ ■ Chapter 3, "Supported Protocols" for a list of supported RosettaNet collaborations (Table 3–2 on page 3-4), EDI X12 transaction sets (Table 3–3 on page 3-6), EDI EDIFACT transaction sets (Table 3–4 on page 3-6), and UCCnet standards (Table 3–5 on page 3-7) Chapter 9, "Creating Trading Partners" for instructions on assigning support for a business action or collaboration to a remote trading partner Managing Business Protocols 8-3 Viewing Business Protocols ■ "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 for instructions on importing collaborations, transaction sets, and UCCnet standards OracleAS Integration B2B - Document Editor Overview When you use the Create Business Action and Create Collaboration wizards, you are prompted to import document definition files. You can use OracleAS Integration B2B Document Editor to create these files for EDI X12, EDI EDIFACT, HL7 and RosettaNet documents. OracleAS Integration B2B - Document Editor is an integrated guideline creation and implementation application for creating business-to-business (B2B) electronic commerce. You can use OracleAS Integration B2B - Document Editor library of templates to create EDI X12 and EDI EDIFACT .ecs files and RosettaNet and HL7 .xsd and .dtd files that you then import into the OracleAS Integration B2B user interface tool with the Create Business Action wizard and Create Collaboration wizard. This enables you to create configurations with OracleAS Integration B2B trading partners that use EDI X12, EDI EDIFACT, HL7, and RosettaNet. The OracleAS Integration B2B - Document Editor is also compatible with older files. Older .ecs files are upgraded (if you confirm to upgrade when prompted) before they are read. If you want to read an older version of a .xsd file, the output is Import, then Importing the file, then Convert from XML Schema (XSD). Note: OracleAS Integration B2B - Document Editor requires .NET 1.1 to be installed. You can install OracleAS Integration B2B - Document Editor from the root of the OracleAS Integration B2B CD-ROM. See the following for more information: ■ ■ Oracle Application Server Integration B2B Installation Guide for instructions on installing OracleAS Integration B2B - Document Editor The online Help included with the OracleAS Integration B2B - Document Editor for instructions on using the library templates to create .ecs, .xsd, and .dtd files Viewing Business Protocols The OracleAS Integration B2B user interface enables you to view the business protocols. The remote trading partner must add support for a business protocol before doing anything else. 1. Click Partners, then Protocols. The Business Protocols page displays the business protocols available with OracleAS Integration B2B. The Description column describes the contents of the business protocol. 8-4 Oracle Application Server Integration B2B User’s Guide Managing Document Protocols 2. Click a specific business protocol to access the Business Protocol Details page. This page shows details about the document, exchange, and process protocols of the business protocol. The management tasks you can perform are described in detail in the remaining sections of this chapter. See the following for more information: ■ ■ "Business Protocols" on page 3-12 for details about business protocols Chapter 9, "Creating Trading Partners" for instructions on adding support for a business protocol to a remote trading partner Managing Document Protocols The OracleAS Integration B2B user interface enables you to perform the document protocol management tasks shown in Figure 8–4 through Figure 8–6. These tasks are described in detail in this section. The document protocol defines the document type of the message payload. Business protocols can have multiple document protocols. Document protocols follow the hierarchy shown in Figure 8–3. A document protocol can consist of multiple document protocol revisions. A document protocol revision can consist of multiple document types. A document type can consist of multiple document definitions, because you can start with one document definition and customize it for different trading partners. In this example, the document definition file is a .xsd file. Managing Business Protocols 8-5 Managing Document Protocols Figure 8–3 Document Protocol Hierarchy Document Protocol (EDI X12) Document Protocol Revision (EDI X12 4010) Document Type (850) Document Definition (.xsd file and associated information) Figure 8–4 Document Protocol Management Tasks (Part 1 of 3) Clicking Details in the Document Protocol Revisions section of Figure 8–4 causes the Document Protocol Revision Details page shown in Figure 8–5 to appear. 8-6 Oracle Application Server Integration B2B User’s Guide Managing Document Protocols Figure 8–5 Document Protocol Management Tasks (Part 2 of 3) Clicking a specific document type (850 for this example) in the Name column of the Document Types section of Figure 8–5 causes the Document Type Details page shown in Figure 8–6 to appear. A document type consists of multiple document definitions, because you can start with one document definition and customize it for different trading partners. Figure 8–6 Document Protocol Management Tasks (Part 3 of 3) Table 8–2 identifies the document protocol management tasks shown in Figure 8–4 through Figure 8–6 and provides references to procedures for performing these tasks. Table 8–2 Document Protocol Management Tasks Page Elements Management Task See Section... Create button in Document Protocol Revisions section of Figure 8–4 Create a document protocol revision "Creating a Document Protocol Revision" on page 8-8 Details column in Document Protocol Revisions section of Figure 8–4 View details about a document protocol revision "Viewing a Document Protocol Revision" on page 8-9 Update column in Document Protocol Revisions section of Figure 8–4 Update a document protocol "Updating a Document revision Protocol Revision" on page 8-9 Managing Business Protocols 8-7 Managing Document Protocols Table 8–2 (Cont.) Document Protocol Management Tasks Page Elements Management Task See Section... Delete column in Document Protocol Revisions section of Figure 8–4 Delete a document protocol revision "Deleting a Document Protocol Revision" on page 8-10 Create button in Document Types Create a document type section of Figure 8–5 "Creating a Document Type" on page 8-10 Name column in Document Types section of Figure 8–5 View details about a document type "Viewing a Document Type" on page 8-12 Update column in Document Types section of Figure 8–5 Update a document type "Updating a Document Type" on page 8-12 Delete column in Document Types section of Figure 8–5 Delete a document type "Deleting a Document Type" on page 8-13 Name column in Document Definitions section of Figure 8–6 View details about a document definition "Viewing a Document Definition of a Document Type" on page 8-13 Update column in Document Definitions section of Figure 8–6 Update a document definition "Updating a Document Definition of a Document Type" on page 8-14 Note: RosettaNet document protocol support is provided for only version 2.0. Regardless of the collaboration (PIP) version you create or import, the supported document protocol revision version is 2.0. See "Document Protocols" on page 3-2 for more information. Creating a Document Protocol Revision The Create Business Action and Create Collaboration wizards enable you to create a document protocol revision as part of a single wizard session. You can also individually create a document protocol revision without using the wizards. Follow these instructions to individually create a document protocol revision. Once created, you can use the wizards to select this document protocol revision to be part of support for a business action or collaboration. 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Click Create in the Document Protocol Revisions section. The Create Document Protocol Revision page appears. 4. 8-8 Enter the following details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the document protocol revision. Description Enter a description of the document protocol revision. Revision * Enter a revision number for the document protocol revision. Oracle Application Server Integration B2B User’s Guide Managing Document Protocols Field Value Translation Enabled Select No or Yes. Validation Enabled Select No or Yes. If you enable validation outside of the OracleAS Integration B2B user interface (for example, in EDI X12 or EDI EDIFACT), performance is impacted. Document Protocol Parameters Note: This field only displays for EDI or Custom Document business protocols. 5. Enter specific values in the Override Value fields. You can also import interchange or group .ecs files that can optionally be created with the OracleAS Integration B2B - Document Editor. Click Apply. The document protocol revision is created and the new Document Protocol Revision Details page appears. Viewing a Document Protocol Revision Follow these instructions to view details about a specific document protocol revision: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision to view in the Details column of the Document Protocol Revisions section. The Document Protocol Revision Details page for the selected document protocol revision appears. 4. View specific details about the document protocol revision: ■ ■ ■ ■ The business protocol and document protocol for this document protocol revision The document protocol revision description, revision number, and status of translation and validation (in the Details section) The document types and revisions of this document protocol revision The document protocol parameters and their default and override values for this document protocol revision See Figure 8–5 on page 8-7 for an example of the Document Protocol Revision Details page. This page, as with the Business Protocol Details page shown in Figure 8–4 on page 8-6, enables you to delete or update the document protocol revision (except for RosettaNet). Updating a Document Protocol Revision You can update all document protocol revisions with the exception of RosettaNet. Follow these instructions to update a document protocol revision: 1. Click Partners, then Protocols. Managing Business Protocols 8-9 Managing Document Protocols 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision to update in the Update column of the Document Protocol Revisions section. The Update Document Protocol Revision page appears. 4. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Update with a unique and recognizable name for the document protocol revision. Description Update the description of the document protocol revision. Revision * Update the revision number for the document protocol revision. Translation Enabled Select No or Yes. Validation Enabled Select No or Yes. If you enable validation outside of the OracleAS Integration B2B user interface (for example, in EDI X12 or EDI EDIFACT), performance is impacted. Document Protocol Parameters 5. Make appropriate updates to specific values in the Override Value fields. You can import .ecs files. Click Apply. The document protocol revision is updated and the Document Protocol Revision Details page appears. Deleting a Document Protocol Revision You can delete all document protocol revisions with the exception of RosettaNet. Follow these instructions to delete a document protocol revision: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision to delete in the Delete column of the Document Protocol Revisions section. 4. Click Yes when prompted to delete a document protocol revision. The document protocol revision is deleted and the Business Protocol Details page appears. Creating a Document Type The Create Business Action and Create Collaboration wizards enable you to create a document type as part of a single wizard session. You can also individually create a document type without using the wizards. Follow these instructions to individually create a document type. Once created, you can use the wizards to select the document type of a specific document protocol revision. This provides support for a business action or collaboration. 8-10 Oracle Application Server Integration B2B User’s Guide Managing Document Protocols 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific revision in the Details column of the Document Protocol Revisions section. 4. Click Create in the Document Types section. The Create Document Type page appears. 5. Enter the following details. An asterisk (*) indicates a required field. Field Value Details ■ Name * Enter a unique and recognizable name for the document type. ■ Description Enter a description of the document type. ■ Revision * Enter a revision number for the document type. Document Definition ■ Name * Enter a unique and recognizable name for the document definition. ■ Description Enter a description of the document definition. ■ Translation Enabled Select No or Yes. ■ Validation Enabled Select No or Yes. Note: If you are using globalization support with OracleAS Integration B2B, do not select Yes. ■ Definition Click Browse to select a document definition file. ■ Starting XSD File Path Click Browse to select the root XSD file name if the document definition file is a ZIP file. Document Type Parameters Enter values in the Override Value fields or click Browse to select a .ecs transaction set file that can optionally be created with the OracleAS Integration B2B - Document Editor. ■ Note: This section only appears for an EDI or Custom Document business protocol. 6. Click Apply. The document type is created and the new Document Type Details page appears. You can now select this document type in the Create Business Action wizard. To do this, you must perform the following steps: a. Select the specific document protocol revision of which this document type is a part on the Create Business Action: Document Protocol Revision page (page two of four). b. Select Use Existing from the Create Mode list on the Create Business Action: Document Type page (page three of four). The page refreshes to display a Document Type list from which you can select this document type. While the document protocol revision can include multiple document types, only a single type can be selected. The EDI and Custom Document business protocols Managing Business Protocols 8-11 Managing Document Protocols enable you to select only a single document type for a document protocol revision. You can now include this document type in a collaboration in the Create Collaboration wizard. To do this, you must perform the following steps: a. Select the specific document protocol revision of which this document type is a part on the Create Collaboration: General page (page one of five). This document protocol revision can include multiple document types. RosettaNet enables you to have multiple document types included with a single document protocol revision. See the following for more information: ■ "Creating a Business Action" on page 8-20 ■ "Creating a Collaboration" on page 8-27 Viewing a Document Type 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision in the Details column of the Document Protocol Revisions section. The Document Protocol Revision Details page for the selected document protocol revision appears. 4. Select a specific document type to view in the Name column of the Document Types section. The Document Type Details page for the selected document type appears. 5. View specific details about the document type: ■ ■ The business protocol and its associated document protocol and document protocol revision for this document type The document definitions and values of this document type. You can also manage the document definitions for this document type. See Figure 8–6 on page 8-7 for an example of the Document Type Details page. This page, as with the Document Protocol Revision Details page shown in Figure 8–5 on page 8-7, enables you to delete or update the document type. Updating a Document Type Follow these instructions to update a document type: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision in the Details column of the Document Protocol Revisions section. The Document Protocol Revision Details page appears. 8-12 Oracle Application Server Integration B2B User’s Guide Managing Document Protocols 4. Select a specific document type to update in the Update column of the Document Types section. The Update Document Type page appears. 5. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Update with a unique and recognizable name for the document type. Description Update the description of the document type. Revision * Update the revision number for the document type. Note: If this document type is for the RosettaNet over RNIF business protocol, this number must match the document type revision number. If they do not match, you receive an error after deployment. If you imported the predefined RosettaNet collaborations, both revision numbers automatically match. See "Updating a Collaboration" on page 8-36 for more information. Document Definition * 6. Select a document definition from the list. Click Apply. The document type is updated and the Document Type Details page appears. Deleting a Document Type Follow these instructions to delete a document type: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision in the Details column of the Document Protocol Revisions section. The Document Protocol Revision Details page appears. 4. Select a specific document type to delete in the Delete column of the Document Types section. 5. Click Yes when prompted to delete a document type. The document type is deleted and the Document Protocol Revision Details page appears. Viewing a Document Definition of a Document Type Follow these instructions to view details about a specific document definition: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific document protocol revision in the Details column of the Document Protocol Revisions section. Managing Business Protocols 8-13 Managing Document Protocols The Document Protocol Revision Details page appears. 4. Select a specific document type in the Name column of the Document Types section. The Document Type Details page appears. 5. Select a specific document definition to view in the Name column of the Document Definitions section. The Document Definition Details page for the selected document definition appears. 6. View specific details about the document definition: ■ ■ ■ The business protocol and its document protocol and document protocol revision for the document definition The document definition description and the statuses of document definition translation and validation (in the Details section) The document parameters and values of this document definition This page, as with the Document Type Details page shown in Figure 8–6 on page 8-7, enables you to update the document definition. Updating a Document Definition of a Document Type Follow these instructions to update a document definition: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific revision in the Details column of the Document Protocol Revisions section. The Document Protocol Revision Details page appears. 4. Select a specific document type in the Name column of the Document Types section. The Document Type Details page appears. 5. Select a specific document definition to update in the Update column of the Document Definitions section. The Update Document Definition page appears. 6. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Update with a unique and recognizable name for the document definition. Description Update the description of the document definition. Translation Enabled Select No or Yes. Validation Enabled Select No or Yes. Note: If you are using globalization support with OracleAS Integration B2B, do not select Yes. 8-14 Oracle Application Server Integration B2B User’s Guide Managing Document Protocols Field Value Definition Click Browse to select a document definition file (typically a .xsd file). Parameters Make appropriate updates to specific values in the Override Value fields. You can also import specific files for EDI or Custom Document business protocols as needed. 7. Click Apply. The document definition is updated and the Document Definition Details page appears. Configuring the XPath Expression for a Custom XML Document The XPath expression identifies a custom XML document. You configure the XPath expression when you specify the document type parameters. See Chapter 7, "Custom XML Document Tutorial" for an example. You have the following options when configuring an XPath expression: ■ Option 1: Specify the XPath and matching value Assuming that the transaction ID is 12345, set the parameters as follows: Field Value Identification Value 12345 Identification Expression //*[local-name() = ’TransactionID’]/text() OracleAS Integration B2B compares the value of Identification Expression in the payload to the value specified in Identification Value. If the values match, then the document is identified successfully. ■ Option 2: Check for the existence of a node Assume that you are checking for the existence of a node called registerCommand. Set the parameters as follows: Field Value Identification Value Leave blank. Identification Expression /*[local-name()=’envelope’]/body/transaction/command/*[loc al-name()=’registerCommand’] When the Identification Value field is left blank, OracleAS Integration B2B checks for the node identified in Identification Expression. If a node in the payload matches, then the document is identified successfully. ■ Option 3: Check the value of an attribute Assume that the value of the country attribute is US. Set the parameters as follows: Field Value Identification Value US Identification Expression //*/@country Managing Business Protocols 8-15 Managing Document Protocols OracleAS Integration B2B compares the value of the country attribute to the Identification Value. If the values match, then the document is identified successfully. The following code examples show the XML payloads (truncated for brevity) for the preceding options. Option 1: Specify the XPath and matching value <?xml version="1.0" encoding="UTF-8" ?> -<Message xmlns:ns1="http://www.example1.org" xmlns:ns2="http://www.example2.org" xmlns="http://www.example3.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns="http://www.example4.org"> -<MessageHeader> <Source>201944019</Source> <Destination>205704856</Destination> <TransactionID>123456</TransactionID> <Version>1-0-0</Version> </MessageHeader> -<Body> -<ns:Case xsi:schemaLocation="http://www.example4.org" ns1:caseCategoryID="1"> <ns1:OfficialProvisionNumber>String</ns1:OfficialProvisionNumber> </ns:Case> </Body> </Message> Option 2: Check for the existence of a node -<uccnet:envelope xmins:eanucc="http://www.ean-ucc.org/schemas/1.3/eanucc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:uccnet="http://www.uccnet.org/schemas/2.2/uccnet" communicationVersion="2.2" xsi:schemaLocation="http://www.uccnet.org/schemas/2.2/uccnet http://www.testregistry.net/xmlschema/uccnet/2.2/Envelope.xsd"> -<messageHeader> -<messageIdentifier> <value>791:1_EB3CDC749A1F2BABE03014906CC4605A</value> </messageIdentifier> <userId>oraclesupXSD</userId> -<representingParty> <gin>0060974050142</gin> </representingParty> </messageHeader> -<body> -<transaction> -<entityIdentification> <uniqueCreatorIdentification>856</uniqueCreatorIdentification> -<globalLocationNumber> <gin>0060974050142</gin> </globalLocationNumber> </entityIdentification> -<command> -<uccnet:registerCommand> <registerCommandHeader type="ADD" /> </uccnet:registerCommand> </command> </transaction> </body> </uccnet:envelope> Option 3: Check the value of an attribute <?xml version="1.0" encoding="windows-1252" ?> 8-16 Oracle Application Server Integration B2B User’s Guide Managing Document Protocols -<MyAddress country="US" xmlns="http://www.example.org" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="PO.xsd"> <name>B2B Buyer</name> <street>100 Oracle Parkway</street> <city>Redwood City</city> <state>CA</state> <zip>94065</zip> <MyAddress> Example: Creating a UCCNet Custom Document 1. Click Partners, then Protocols. 2. Click Custom Document over ebMS. 3. From Shortcut, click Create Business Action. 4. On the Create Business Action: General page, provide the following information and click Next. Field Value Name Process registerCommand Revision 1.0 5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next. Field Value Name UCCnet Revision 2.4 6. On the Create Business Action: Document Type page, provide the following information and click Next. General Field Value Name registerCommand DocType Revision 1.0 Document Definition Field Value Name registerCommand DocumentDefinition Definition Upload the ZIP file containing the UCCnet schemas. Starting XSD File Path Enter the path in the ZIP file to Envelope.xsd. 7. After entering the preceding parameters, specify the Identification Value and Identification Expression() for the XML document. Managing Business Protocols 8-17 Viewing Exchange Protocols Viewing Exchange Protocols The OracleAS Integration B2B user interface enables you to view exchange protocol details. The exchange protocol defines the headers, acknowledgments, and packaging that puts the headers and payload together (the message exchange mechanism). The exchange protocol also defines exchange-level security—signing and encryption—and transport protocols for the exchange. Follow these instructions to view exchange protocol revision details: 1. Click Partners, then Protocols. 2. Select a specific business protocol in the Name column of the Business Protocols section. The Business Protocol Details page appears. 3. Select a specific exchange protocol revision to view in the Details column of the Exchange Protocol Revisions section. (See Figure 8–4 on page 8-6.) The Exchange Protocol Revision Details page for the selected exchange protocol revision appears. 4. View specific details about the following: ■ The Details section, which shows revision, description, status or nonrepudiation of origin and receipt, number of retries allowed, time to acknowledge, status of request retry messages, implementation class, packaging protocol, and packaging identification From the Exchange Protocol Revision Details page, you can click the Packaging Id value to see the Packaging Id Details page, which describes the packaging for the protocol you selected. From the Exchange Protocol Revision Details page, you can also click the Packaging Protocol value to see the Packaging Protocol Details page, which lists the packaging IDs for the packaging protocol you are using. ■ ■ ■ ■ ■ 5. 8-18 The Business Signals section, which shows the exception messages and the acknowledgment signals to exchange to confirm receipt of messages The Protocol Elements section, which shows message header details such as preamble header, delivery header, and service header, whether these details can be encrypted, and their datatypes. The Supported Transport Protocols section, which shows the supported transports for this version The Supported Security Specifications section, which shows the supported signing and encryption features The Parameters section, which shows the supported parameters for this version Click Return to List to return to the Business Protocol Details page. Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Note: ■ ■ The Exchange Protocol Revision Details page can also be accessed by clicking Partners, then Trading Partners, then trading_ partner_name_in_Name_column, then Capabilities, then business_protocol_name_in_Name_column, and then exchange_ protocol_revision_name_in_Exchange_Protocol_Revision_ column (in Document Exchanges section). Support is not provided for remote trading partner-to-remote trading partner message routing. Messages are always exchanged with the host trading partner. If you must route messages from one remote trading partner to another remote trading partner, you must do so outside of the OracleAS Integration B2B user interface tool. See "Exchange Protocols" on page 3-8 for more information. Managing Process Protocols The OracleAS Integration B2B user interface enables you to perform the process protocol management tasks shown in Figure 8–7 and Figure 8–8. These tasks are described in detail in this section. OracleAS Integration B2B provides a single process protocol named B2B Process. This process protocol is included with all business protocols supported by OracleAS Integration B2B. The process protocol defines the business actions (for any EDI, HL7, or Custom Document (such as UCCnet) business protocols) and the collaborations (for the RosettaNet over RNIF business protocol) that are associated with specific document types. Figure 8–7 Process Protocol Management Tasks for any EDI, HL7, or Custom Document Business Protocol Managing Business Protocols 8-19 Managing Process Protocols Figure 8–8 Process Protocol Management Tasks for the RosettaNet over RNIF Business Protocol Table 8–3 identifies the process protocol management tasks shown in Figure 8–7 and Figure 8–8 and provides references to procedures for performing these tasks. Table 8–3 Process Protocol Management Tasks Page Elements Management Task See Section... Create button in Business Actions Create a business action section of Figure 8–7 "Creating a Business Action" on page 8-20 Details column in Business Actions section of Figure 8–7 View details about a business action "Viewing a Business Action" on page 8-26 Update column in Business Actions section of Figure 8–7 Update a business action "Updating a Business Action" on page 8-26 Delete column in Business Actions section of Figure 8–7 Delete a business action "Deleting a Business Action" on page 8-27 Create button in Collaborations section of Figure 8–8 Create a collaboration "Creating a Collaboration" on page 8-27 Details column in Collaborations View details about a section of Figure 8–8 collaboration "Viewing a Collaboration" on page 8-35 Update column in Collaborations Update a collaboration section of Figure 8–8 "Updating a Collaboration" on page 8-36 Delete column in Collaborations section of Figure 8–8 "Deleting a Collaboration" on page 8-36 Delete a collaboration Note: The revision for each business action and collaboration displays in the Revision column of the Business Actions and Collaborations sections. (See Figure 8–7 and Figure 8–8.) See "Process Protocols" on page 3-11 for more information. Creating a Business Action You can import some of the most frequently used EDI EDIFACT and EDI X12 transaction sets and UCCnet standards into the OracleAS Integration B2B user interface by clicking Administration, then Management, and then Import. 8-20 Oracle Application Server Integration B2B User’s Guide Managing Process Protocols For transaction sets not included in the import file, OracleAS Integration B2B provides a Create Business Action wizard that enables you to create additional business actions for any EDI, HL7, or Custom Document business protocol. Use of this wizard is described in this section. You can use the OracleAS Integration B2B - Document Editor to create the .ecs files that you are prompted to import when creating a business action with this wizard. Regardless of whether you use the import or create business action method, you can then assign support for a business action to a remote trading partner in either of two ways. Trading partners define their operational capabilities by the business actions they support. ■ ■ With the Create Trading Partner Wizard (on the Create Trading Partner: Operational Capability page when you initially create the remote trading partner) Through the Create Operational Capability button of the Business Protocol Details page for the business protocol assigned to the remote trading partner you previously created The Create Business Action wizard provides a series of pages that guide you through business action creation. Table 8–4 provides an overview of the wizard pages that appear and the types of questions for which you are prompted to provide details. Before using this wizard, review the information shown in Table 8–4. Table 8–4 Create Business Action Wizard Pages Page Description Page 1: General Page Prompts you to define the following general business action details: ■ Business action name, description, and revision number ■ Retry count and time to acknowledge values ■ ■ Page 2: Document Protocol Revision If nonrepudiation of receipt and nonrepudiation of origin are required Acknowledgment mode Prompts you to define the following document protocol revision details: ■ ■ ■ Document protocol revision name, description, and revision number If document protocol revision translation and validation are to be performed by OracleAS Integration B2B Document protocol parameter values You can also import interchange or group .ecs files created with the OracleAS Integration B2B - Document Editor. Page 3: Document Type Prompts you to define the following document type details: ■ Document type name, description, and revision number ■ Document definition name and description ■ If document type translation and validation are to be performed by OracleAS Integration B2B ■ Document definition file to import ■ Document protocol parameter values You can also import the document definition file. Managing Business Protocols 8-21 Managing Process Protocols Table 8–4 (Cont.) Create Business Action Wizard Pages Page Description Page 4: Review Prompts you to review details about the following selections you made on the previous pages: ■ Business action name and revision ■ Document protocol revision name and revision ■ Document type and definition Follow these tasks to create a business action with the Create Business Action wizard: ■ Page 1: General Page ■ Page 2: Document Protocol Revision ■ Page 3: Document Type ■ Page 4: Review See Chapter 9, "Creating Trading Partners" for instructions on assigning support for a business action to a remote trading partner. Page 1: General Page Follow these instructions to create and define the details of a business action: 1. Click Partners, then Protocols. 2. Click a specific EDI or Custom Document business protocol in the Name column of the Business Protocols section. The Business Protocol Details page for the selected business protocol appears. 3. Start the Create Business Action wizard in either of two ways: a. Click Create Business Action in the Shortcut section. or a. Click Details in the Process Protocol Revisions section. b. Click Create in the Business Actions section. The Create Business Action: General page appears and displays the selected business protocol and its process protocol and process protocol revision in the top left part of the page. These details appear on each remaining page of the wizard. 4. 8-22 Enter the following details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the business action. Description Enter a description of the business action. Revision * Enter a revision number for the business action. Retry Count Enter a value. This value specifies the amount of time to wait before retrying. Time To Acknowledge Enter a value in minutes. This value specifies the time in which an acknowledgment message must be received. If an acknowledgment is not received, an error message is returned. Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Field Value Is Non-Repudiation of Receipt Required Select No or Yes. You can override this selection when you create the delivery channel (the communication capabilities) for the trading partner. Is Non-Repudiation of Origin Required Select No or Yes. Acknowledgement Mode Select Async, None, or Sync. 5. You can override this selection when you create the delivery channel (the communication capabilities) for the trading partner. Click Next. The Create Business Action: Document Protocol Revision page appears. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel (the communication capabilities). Page 2: Document Protocol Revision Follow these instructions to create a document protocol revision. An example of a document protocol revision is revision 4010 if you are using an EDI X12 business protocol or revision D98A or D3 if you are using an EDI EDIFACT business protocol. 1. If this business protocol already includes a document protocol revision, the Create Mode list appears. Select Use Existing or Create New. Otherwise, go to Step 3. 2. Go to the following step based on your mode selection: If You Selected... Go To... Create New Step 3 Use Existing Step 4 3. If you selected Create New or the Create Mode list did not appear, perform Steps 3a through 3b. a. Enter the following details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the document protocol revision. Description Enter a description of the document protocol revision. Revision * Enter a revision number for the document protocol. Translation Enabled Select No or Yes. This enables OracleAS Integration B2B to perform translation. Validation Enabled Select No or Yes. This enables OracleAS Integration B2B to perform validation. If you enable validation outside of the OracleAS Integration B2B user interface (for example, in EDI X12 or EDI EDIFACT), performance is impacted. Note: If you are using globalization support with OracleAS Integration B2B, do not select Yes. See Oracle Application Server Integration B2B Installation Guide for additional globalization issues. Managing Business Protocols 8-23 Managing Process Protocols Field Value Document Protocol Parameters Enter specific values for parameters in the Override Value fields or import appropriate interchange or group .ecs parameter files that can optionally be created with the OracleAS Integration B2B Document Editor. Note: You can override the values you specify or the files you import when you create a trading partner in "Page 3: Operational Capability Page" on page 9-11. b. 4. 5. Go to Step 5. If you selected Use Existing, perform Steps 4a through 4b. a. Select a document protocol revision from the Document Protocol Revision list. b. Go to Step 5. Click Next. The Create Business Action: Document Type page appears. Page 3: Document Type Follow these instructions to create a document type under a document protocol revision that defines the business document. A document type maps to a transaction set in an EDI EDIFACT or X12 transaction set (for example, document type 850 or 855 for EDI X12 document protocol revision 4010). This page also enables you to import definition and .ecs files that define document type parameters. 1. If the document protocol revision you selected in "Page 2: Document Protocol Revision" on page 8-23 already includes a document type, the Create Mode list appears. Select Use Existing or Create New. Otherwise, go to Step 3. 2. Go to the following step based on your mode selection: If You Selected... Go To... Create New Step 3 Use Existing Step 4 3. If you selected Create New or the Create Mode list did not appear, perform Steps 3a through 3b. a. Enter the following details. An asterisk (*) indicates a required field. Field Value General ■ Name * Enter a unique and recognizable name for the document type. This must be a correct document type name, such as 850 or 997 for EDI X12 or ORDERS or ORDRSP for EDI EDIFACT. ■ Description Enter a description of the document type. ■ Revision * Select a revision number for the document type. Document Definition ■ 8-24 Name * Enter a unique and recognizable name for the document definition. Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Field Value ■ Description Enter a description of the document definition. ■ Translation Enabled Select Yes or No. ■ Validation Enabled Select Yes or No. Note: If you are using globalization support with OracleAS Integration B2B, do not select Yes. ■ ■ Definition Click Browse to select a document definition file created with the OracleAS Integration B2B - Document Editor. (typically a .xsd file). Starting XSD File Path Click Browse to select the root XSD file name if the document definition file is a ZIP file. Document Type Parameters Make appropriate updates to specific values in the Override Value fields or import appropriate transaction set .ecs parameter files created with the OracleAS Integration B2B - Document Editor. If the parameter is a string, you can enter a value of up to 100 characters. Note: You can override the values you specify or the files you import when you create a trading partner in "Page 3: Operational Capability Page" on page 9-11. b. 4. 5. Go to Step 5. If you selected Use Existing, perform Steps 4a through 4b. a. Select a document type from the Document Type list. b. Go to Step 5. Click Next. The Create Business Action: Review page appears and displays your selections from the previous pages. Page 4: Review 1. Review the business action details. ■ ■ To modify these details, click the Back button of the Create Business Action wizard to return to the previous pages. When you complete modifications, click Next until you access the review page; then click Finish. Do not use the Back and Forward buttons of your Web browser. If you are satisfied with these details, click Finish. The business action is created and the new Business Action Details page appears. You can now assign support for this business action to a remote trading partner as follows: ■ ■ On the Operational Capability page of the Create Trading Partner wizard (page three of seven) On the Operational Capability page, which is accessible from the Create Operational Capability button of the Business Protocol Details page for any EDI, HL7, or Custom Document business protocol assigned to the trading partner. (Click Partners, then Trading Partners, then trading_partner_name_ in_Name_column, then Capabilities, and then business_protocol_name_in_ Name_column.) Managing Business Protocols 8-25 Managing Process Protocols 2. Click Return to List to return to the Process Protocol Revision Details page. 3. Click Return to List to return to the Business Protocol Details page. See Chapter 9, "Creating Trading Partners" for instructions on assigning support for a business action to a remote trading partner. Viewing a Business Action Follow these instructions to view a business action: 1. Click Partners, then Protocols. 2. Click a specific EDI or Custom Document business protocol in the Name column of the Business Protocols section. 3. Click Details in the Process Protocol Revisions section. The Process Protocol Revision Details page appears. 4. Select the specific business action to view in the Details column of the Business Actions section. The Business Action Details page for the selected business action appears. 5. View specific details, including the following: ■ ■ ■ The business protocol and its process protocol and process protocol revision The description, revision, retry count, time to acknowledge, nonrepudiation of origin and receipt statuses, and acknowledgment mode (in the Details section) The document type, which you can manage (remove and view) from this page This page, as with the Process Protocol Revision Details page shown in Figure 8–7 on page 8-20, enables you to delete or update the business action. 6. Click Return to List to return to the Process Protocol Revision Details page. Updating a Business Action Follow these instructions to update a business action: 1. Click Partners, then Protocols. 2. Click a specific EDI or Custom Document business protocol in the Name column of the Business Protocols section. 3. Click Details in the Process Protocol Revisions section. The Process Protocol Revision Details page appears. 4. Select a specific business action to update in the Update column of the Business Actions section. The Update Business Action page appears. 5. 8-26 Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Update with a unique and recognizable name for the business action. Description Update the description of the business action. Revision * Update the revision number for the business action. Retry Count Update the retry count value for the business action. Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Field Value Time To Acknowledge Update the time limit for performing this business action. Is Non-Repudiation of Receipt Required Select No or Yes. Is Non-Repudiation of Origin Required Select No or Yes. Acknowledgement Mode Select Async, None, or Sync. 6. Click Apply. The business action is updated and the Business Action Details page appears. Deleting a Business Action Follow these instructions to delete a business action: 1. Click Partners, then Protocols. 2. Click a specific EDI or Custom Document business protocol in the Name column of the Business Protocols section. 3. Click Details in the Process Protocol Revisions section. The Process Protocol Revision Details page appears. 4. Select a specific business action to delete in the Delete column of the Business Actions section. 5. Click Yes when prompted to delete a business action. The business action is deleted and the Process Protocol Revision Details page appears. Creating a Collaboration You can import approximately 25 of the most frequently used RosettaNet collaborations (for example, RosettaNet Partner Interface Process (PIP) 3A4) into the OracleAS Integration B2B user interface by clicking Administration, then Management, and then Import. For collaborations not included in the import file, OracleAS Integration B2B provides a Create Collaboration wizard that enables you to create additional collaborations for the RosettaNet over RNIF business protocol. Use of this wizard is described in this section. You must first perform the following tasks before you can use the Create Collaboration wizard. The tasks to perform are based on the method by which you are creating the RosettaNet collaboration: ■ Download from the RosettaNet Web site: 1. Go to www.rosettanet.org. 2. Download a zip file of the appropriate PIP. This zip file includes the document definition file (.dtd file) that you import when using the Create Collaboration wizard. This file also includes the specification that describes the details to enter into the Create Collaboration wizard fields (for example, the collaboration name, revision, code, initiating role name, accepting role name, and so on). Managing Business Protocols 8-27 Managing Process Protocols ■ Use the OracleAS Integration B2B - Document Editor: 1. Install the OracleAS Integration B2B - Document Editor, as described in the Oracle Application Server Integration B2B Installation Guide 2. See the online Help included with the OracleAS Integration B2B - Document Editor for instructions on exporting RosettaNet guidelines to .xsd or .dtd files. Regardless of whether you use the import or create collaboration method, you can then assign support for a collaboration to a remote trading partner in either of two ways: ■ ■ With the Create Trading Partner Wizard (on the Create Trading Partner: Operational Capability page when you initially create the remote trading partner) Through the Create Operational Capability button of the Business Protocol Details page for the business protocol assigned to the remote trading partner you previously created The Create Collaboration wizard provides a series of pages that guide you through collaboration creation. Table 8–5 provides an overview of the wizard pages that appear and the types of questions for which you are prompted to provide details. Before using this wizard, review the information shown in Table 8–5. Table 8–5 Create Collaboration Wizard Pages Page Description Page 1: General Page Prompts you to define the following general collaboration details: Page 2: Business Transaction Page Page 3: Requesting Business Action ■ Collaboration name, description, and revision number ■ Collaboration code ■ The time in which to perform the collaboration ■ Initiating role name and description ■ Accepting role name and description Prompts you to define the following business transaction details: ■ Business transaction name, description, and revision number ■ The time in which to perform the transaction Prompts you to define the following requesting business action details: ■ Protocol action name ■ Response Mode (asynchronous or synchronous) ■ 8-28 Requesting business action name, description, and revision number ■ Amount of time to wait before retrying ■ Time in which an acknowledgment message must be received ■ Acknowledgment mode ■ Document type name, description, and revision number ■ Document definition name and description ■ If RosettaNet Business Dictionary validation is enabled ■ The document definition file to import Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Table 8–5 (Cont.) Create Collaboration Wizard Pages Page Description Page 4: Responding Business Action (Optional) Prompts you to define the following responding business action details: Note: This page appears if you selected Sync or Async from the Response Mode list in Page 3: Requesting Business Action. Page 5: Review ■ ■ Protocol action name Responding business action name, description, and revision number ■ Document protocol revision name and revision ■ Document type and definition ■ Amount of time to wait before retrying ■ Time in which an acknowledgment message must be received ■ Document type name, description, and revision number ■ Document definition name and description ■ If RosettaNet Business Dictionary validation is enabled ■ The document definition file to import Prompts you to review details about the following selections you made on the previous pages: ■ ■ ■ ■ Collaboration name, revision, and initiating and accepting role names Business transaction name Requesting business action details (protocol action name, response mode, business action, revision, acknowledge mode, document type, and document definition) Responding business action details (protocol action name, business action, revision, document type, and document definition) Follow these tasks to create a collaboration with the Create Collaboration wizard: ■ Page 1: General Page ■ Page 2: Business Transaction Page ■ Page 3: Requesting Business Action ■ Page 4: Responding Business Action (Optional) ■ Page 5: Review Note: Ensure that you carefully enter collaboration details into the Create Collaboration wizard. The naming and case conventions described in the downloaded RosettaNet PIP specification must be explicitly followed. Chapter 9, "Creating Trading Partners" for instructions on assigning support for a collaboration to a remote trading partner. Page 1: General Page Follow these instructions to create the collaboration (for this example, PIP 7B1) and its initiating and accepting roles (for example, buyer and seller) for the RosettaNet over RNIF business protocol: Managing Business Protocols 8-29 Managing Process Protocols 1. Click Partners, then Protocols. 2. Click the RosettaNet over RNIF business protocol in the Name column of the Business Protocols section. The Business Protocol Details page for the RosettaNet over RNIF business protocol appears. 3. Start the Create Collaboration wizard in either of two ways: a. Click Create Collaboration in the Shortcut section. or a. Click Details in the Process Protocol Revisions section. b. Click Create in the Collaborations section. The Create Collaboration: General page appears and displays the selected business protocol and its process protocol and process protocol revision in the top left part of the page. These details appear on each remaining page of the wizard. 4. Enter the following details. An asterisk (*) indicates a required field. An example of the details to enter for PIP 7B1 is provided for the first three pages of this wizard. Field Value Example Document Protocol Revision Select the document protocol revision to use. This list only displays if more than one document protocol revision exists. Not applicable for this example ■ Name * Enter a unique and recognizable name for the collaboration (the RosettaNet PIP). 7B1 ■ Description Enter a description of the collaboration. Distributes status information about the manufacture or assembly of a product ■ Revision * Enter a revision number for the collaboration. V01.00 (for RosettaNet Implementation Framework (RNIF) version 1.0) General ■ Note: This number must match the document type revision number you enter on the Create Collaboration: Requesting Business Action and Responding Business Action pages. ■ ■ Code Enter a code for the collaboration. Work in Process Notification Time To Perform Enter the time limit in minutes for performing this collaboration. You can override this value when you create your trading partner. 120 Enter a unique and recognizable name for the initiating role in this business transaction. Solution Provider Initiating Role ■ 8-30 Name * Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Field ■ Value Description Example Enter a description for the initiating Party that architects, configures, role. engineers, sells, and determines the fulfillment of the configured solution to partners Accepting Role ■ Name * Enter a unique and recognizable name for the accepting role in this business transaction. Solution Requester ■ Description Enter a description for the accepting role. Party that creates a demand for a product or service, or has contracted with a solution provider for the manufacture or fulfillment of a product 5. Click Next. The Create Collaboration: Business Transaction page appears. Page 2: Business Transaction Page Follow these instructions to create the business transaction for the RosettaNet over RNIF business protocol. When complete, the business transaction includes the requesting and responding actions. 1. Enter the following details. An asterisk (*) indicates a required field. Field Value Example Name * Enter a unique and recognizable name for the business transaction. Work in Process Notification Description Enter a description of the business transaction. Work in Process Notification Revision * Enter a revision number for the business transaction. V01.00 Time To Perform Enter the time limit in minutes for performing this transaction. 120 2. Click Next. The Create Collaboration: Requesting Business Action page appears. Page 3: Requesting Business Action Follow these instructions to create the requesting business action. The requesting business action is initiated by the initiating role you created in the Create Collaboration: General page (page 1) of this wizard. 1. Enter the unique and recognizable name in the Protocol Action Name field (for this example, Work in Process Notification Request Action). Note: The name you specify must exactly match that shown in the Business Action in FSV column of the Business Action - Business Document Mapping table of the RosettaNet specification for the PIP you are using. Managing Business Protocols 8-31 Managing Process Protocols 2. Select Async, None, or Sync from the Response Mode list (for this example, select None for PIP 7B1). Your selection determines the wizard page that appears after you complete the remaining details on this wizard page and click Next. ■ ■ If you select Async or Sync, the Responding Business Action page ("Page 4: Responding Business Action (Optional)" on page 8-33) appears next. If you select None, the Review page ("Page 5: Review" on page 8-35) appears next. 3. Select Use Existing or Create New from the Create Mode list (for this example, select Create New). 4. Go to the following step based on your mode selection in Step 3: If You Selected... Go To... Create New Step 5 Use Existing Step 6 5. If you selected Create New, perform Steps 5a through 5b. a. Enter the following details. An asterisk (*) indicates a required field. Field Value Example Name * Enter a unique and recognizable name for the requesting business action. Work in Process Notification Action Description Enter a description of the requesting business action. Work in Process Notification Action Revision * Enter a revision number for the requesting business action. V01.00 Retry Count Enter a value. This value specifies the amount of time to wait before retrying. 3 Time To Acknowledge Enter a value in minutes. This 120 value specifies the time in which an acknowledgment message must be received. If an acknowledgment is not received, an error message is returned. Acknowledge Mode Select Async, None, or Sync Document Type 8-32 ■ Name * Enter a unique and recognizable name for the document type. A document type maps to a RosettaNet business document. Work in Process Notification ■ Description Enter a description of the document type. Work in Process Notification ■ Revision * Enter a revision number for the document type. V01.00 Oracle Application Server Integration B2B User’s Guide Note: This number must match the collaboration revision number you enter on the Create Collaboration: General page. Managing Process Protocols Field Value Example Document Definition ■ Name * Enter a unique and recognizable name for the document definition. Work in Process Notification ■ Description Enter a description of the document definition. Work in Process Notification Validation Enabled Select No or Yes. Selecting Yes No enables RosettaNet Business Dictionary validation. If you enable validation outside of the OracleAS Integration B2B user interface, performance is impacted. Definition * Click Browse to select a document definition file (typically a .dtd file). ■ ■ 7B1_MS_V01_00_ WorkinProcessNotification.dtd Note: You can either import standard .dtd files downloaded from the RosettaNet Web site (as shown in this example) or import .xsd or .dtd files created with the OracleAS Integration B2B Document Editor. ■ Starting XSD File Path b. 6. 7. Click Browse to select the root XSD file name if the document definition file is a ZIP file. - Go to Step 7. If you selected Use Existing, perform Steps 6a through Step 6b. a. Select an existing business action from the Business Action list. b. Go to Step 7. Click Next. The Create Collaboration: Responding Business Action page appears. Page 4: Responding Business Action (Optional) This wizard page appears if you selected Async or Sync from the Response Mode list in Step 2 of "Page 3: Requesting Business Action" on page 8-31. Follow these instructions to create the responding (accepting) business action. The responding business action is initiated by the accepting role you created in the Create Collaboration: General page (page 1) of this wizard. 1. Enter a name in the Protocol Action Name field. Note: The name you specify must exactly match that shown in the Business Action in FSV column of the Business Action - Business Document Mapping table of the RosettaNet specification for the PIP you are using. 2. Select Create New or Use Existing from the Create Mode list. 3. Go to the following step based on your mode selection in Step 2: Managing Business Protocols 8-33 Managing Process Protocols If You Selected... Go To... Create New Step 4 Use Existing Step 5 4. If you selected Create New, perform Step 4a through Step 4b. a. Enter the following details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the responding business action. Description Enter a description of the responding business action. Revision * Enter a revision number for the responding business action. Retry Count Enter a value. This value specifies the amount of time to wait before retrying. Time To Acknowledge Enter a value in minutes. This value specifies the time in which an acknowledgment message must be received. If an acknowledgment is not received, an error message is returned. Document Type ■ Name * Enter a unique and recognizable name for the document type. ■ Description Enter a description of the document type. ■ Revision * Enter a revision number for the document type. Note: This number must match the collaboration revision number you enter on the Create Collaboration: General page. Document Definition ■ Name * Enter a unique and recognizable name for the document definition. ■ Description Enter a description of the document definition. ■ Validation Enabled Select Yes or No. ■ Definition * Click Browse to select a definition file (typically a .dtd file). Note: You can either import standard .dtd files downloaded from the RosettaNet Web site (as shown in this example) or import .xsd or .dtd files created with the OracleAS Integration B2B Document Editor. ■ Starting XSD File Path Click Browse to select the root XSD file name if the document definition file is a ZIP file. b. 5. 6. Go to Step 6. If you selected Use Existing, perform Step 5a through Step 5b. a. Select an existing business action from the Business Action list. b. Go to Step 6. Click Next. The Create Collaboration: Review page appears and displays your selections from the previous pages. 8-34 Oracle Application Server Integration B2B User’s Guide Managing Process Protocols Page 5: Review 1. Review the collaboration details. ■ ■ To modify these details, click the Back button of the Create Collaboration wizard to return to the previous pages. When you complete modifications, click Next until you access the review page; then click Finish. Do not use the Back and Forward buttons of your Web browser. If you are satisfied with these details, click Finish. The collaboration is created and the new Collaboration Details page appears. You can now assign support for this collaboration to a remote trading partner as follows: ■ ■ On the Operational Capability page of the Create Trading Partner wizard (page three of seven) On the Create Supported Collaboration Role page, which is accessible from the Create Operational Capability button of the Business Protocol Details page for the RosettaNet over RNIF business protocol assigned to the trading partner. (Click Partners, then Trading Partners, then trading_partner_name_ in_Name_column, then Capabilities, and then RosettaNet over RNIF.) 2. Click Return to List to return to the Process Protocol Revision Details page. 3. Click Return to List to return to the Business Protocol Details page. See Chapter 9, "Creating Trading Partners" for instructions on assigning support for a collaboration to a remote trading partner. Viewing a Collaboration Follow these instructions to view a collaboration: 1. Click Partners, then Protocols. 2. Click the RosettaNet over RNIF business protocol in the Name column of the Business Protocols section. 3. Click Details in the Process Protocol Revisions section. The Process Protocol Revision Details page appears. 4. Select the specific collaboration to view in the Details column of the Collaborations section. The Collaboration Details page for the selected collaboration appears. 5. View specific details, including the following: ■ ■ The business protocol and its process protocol and process protocol revision The description, revision, code, time to perform, initiating role, accepting role, and business transaction (in the Details section). Depending upon the collaboration selected, you can also access pages for updating the initiating role, accepting role, business transaction, requesting action, and responding action. This page, as with the Process Protocol Revision Details page shown in Figure 8–8 on page 8-20, enables you to delete or update the collaboration. 6. Click Return to List to return to the Process Protocol Revision Details page. Managing Business Protocols 8-35 Managing Process Protocols Updating a Collaboration Follow these instructions to update a collaboration: 1. Click Partners, then Protocols. 2. Click the RosettaNet over RNIF business protocol in the Name column of the Business Protocols section. 3. Click Details in the Process Protocol Revisions section. The Process Protocol Revision Details page appears. 4. Select a specific collaboration to update in the Update column of the Collaborations section. The Update Collaboration page appears. 5. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Update with a unique and recognizable name for the collaboration. Description Update the description of the collaboration. Revision * Update the revision number for the collaboration. Note: This number must match the document type revision number. If they do not match, you receive an error after deployment. If you imported the predefined RosettaNet collaborations, both revision numbers automatically match. See "Updating a Document Type" on page 8-12 for more information. Code Update the code for the collaboration. Time To Perform Update the time limit in minutes for performing this collaboration. 6. Click Apply. The collaboration is updated and the Collaboration Details page appears. Deleting a Collaboration Follow these instructions to delete a collaboration: 1. Click Partners, then Protocols. 2. Click the RosettaNet over RNIF business protocol in the Name column of the Business Protocols section. 3. Click Details in the Process Protocol Revisions section. The Process Protocol Revision Details page appears. 4. Select a specific collaboration to delete in the Delete column of the Collaborations section. 5. Click Yes when prompted to delete a collaboration. The collaboration is deleted and the Process Protocol Revision Details page appears. 8-36 Oracle Application Server Integration B2B User’s Guide Summary Common User Errors ■ ■ ■ ■ ■ Do not include beginning or trailing blank spaces in the names of business protocol partner data that you create. If you create a document type for the RosettaNet over RNIF business protocol, the collaboration revision number must match the document type revision number. If you are using EDI X12, ensure that the Interchange Control Version Number is valid. If this parameter is null, you will encounter an invalid guideline error while processing the incoming EDI document. You enter the Interchange Control Version Number on the Create Business Action: Protocol Revision Page. If you are using globalization support with OracleAS Integration B2B, do not enable validation in the OracleAS Integration B2B user interface. If you create a collaboration with the Create Collaboration wizard, ensure that you follow the naming and case conventions described in the downloaded RosettaNet PIP specification. If you use OracleAS Integration B2B in conjunction with the B2B WSIL Browser in Oracle BPEL Process Manager, note the following: ■ ■ Do not use spaces or special characters in your naming conventions. Otherwise, the WSDL generated by the B2B WSIL Browser may include invalid characters. For Custom Documents that employ an XSD file as the document definition, use the root element name in the XSD as the Document Type name. See "The B2B WSIL Browser" on page 4-7 for more information. Summary This chapter describes the tasks required to manage the three protocols that comprise the business protocol: document, exchange, and process. The process protocol consists of business actions and collaborations. This chapter also describes how to create a business action with the Create Business Action wizard and a collaboration with the Create Collaboration wizard. Managing Business Protocols 8-37 Summary 8-38 Oracle Application Server Integration B2B User’s Guide 9 Creating Trading Partners This chapter describes how to use the Create Trading Partner wizard to create a remote trading partner, assign it support for a business protocol with operational and communication capabilities, and assign communication capabilities to the business protocol of the host trading partner. The host trading partner is automatically assigned business protocols and operational capabilities that are compatible with those of the remote trading partner. You assign only communication capabilities to the business protocol of the host trading partner. This chapter contains the following topics: ■ Trading Partner Creation Overview ■ Creating and Assigning All Capabilities During a Single Wizard Session ■ Creating and Defining All Capabilities During Separate Wizard Sessions ■ Common User Errors ■ Summary See Chapter 15, "API for Creating Trading Partners and Agreements" for how to create trading partners programmatically or through a command line utility. Trading Partner Creation Overview The following sections provide an overview of the Create Trading Partner wizard: ■ What Is a Trading Partner? ■ How Do You Create a Trading Partner? ■ Create Trading Partner Wizard Overview ■ Create Trading Partner Wizard and Protocol Standards ■ Prerequisites to Using the Create Trading Partner Wizard ■ Accessing the Create Trading Partner Wizard What Is a Trading Partner? A trading partner is a party that engages in a business transaction with another trading partner. There are two types of trading partners in OracleAS Integration B2B: ■ Host trading partner The host trading partner is the organization in which OracleAS Integration B2B is installed. You do not need to create the host trading partner with the Create Creating Trading Partners 9-1 Trading Partner Creation Overview Trading Partner wizard; it is automatically included with OracleAS Integration B2B. ■ Remote trading partner The remote trading partner is the organization outside your enterprise with whom the host trading partner conducts a business transaction. You must create the remote trading partner with the Create Trading Partner wizard. How Do You Create a Trading Partner? Figure 9–1 describes the main types of tasks to perform with the Create Trading Partner wizard. Figure 9–1 Create Trading Partner Wizard Tasks Task 1: Create a Remote Trading Partner (Host Trading Partner is automatically created) Remote Trading Partner (Acme) Host Trading Partner (GlobalChips) Task 2: Define a Business Protocol for the Remote Trading Partner (Business Protocol for the Host Trading Partner is automatically defined) Remote Trading Partner (Acme) Host Trading Partner (GlobalChips) Business Protocol (EDI X12) Business Protocol (EDI X12) Task 3: Define Operational and Communication Capabilities for the Business Protocol of the Remote Trading Partner Task 4: Define Communication Capabilities for the Business Protocol of the Host Trading Partner (Operational Capabilities are automatically defined) Remote Trading Partner (Acme) Host Trading Partner (GlobalChips) Business Protocol (EDI X12) Business Protocol (EDI X12) Operational Capabilities (EDI Business Action) Operational Capabilities (EDI Business Action) Communication Capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) Communication Capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) You assign support for the business protocol to the remote trading partner. The business protocol identifies the implementation guidelines to use for the reliable transport of messages between trading partners. You then assign operational capabilities and communication capabilities to the business protocol of the remote trading partner. The host trading partner is automatically assigned a business protocol and operational capabilities that are compatible with those of the remote trading partner. You assign only communication capabilities to the business protocol of the host trading partner. 9-2 Oracle Application Server Integration B2B User’s Guide Trading Partner Creation Overview Operational capabilities describe the support for a business action (for any EDI or Custom Document business protocol) or collaboration (for the RosettaNet over RNIF business protocol) to use in a business transaction. Communication capabilities describe the following details: ■ ■ ■ Delivery channel details, such as use of nonrepudiation, encryption, and transport security Document exchange details, such as use of a digital envelope, encryption credential, digital signature, and signing credential Transport details, such as transport mode, protocol, server name, and endpoint address details The host trading partner consults with the remote trading partner to obtain the necessary business protocol, operational capability, and communication capability details and uses the OracleAS Integration B2B user interface to define this information for both trading partners. The remote trading partner has no access to the OracleAS Integration B2B user interface. Create Trading Partner Wizard Overview The Create Trading Partner wizard provides a series of pages that guide you through the remote trading partner creation tasks shown in Figure 9–1 on page 9-2. Table 9–1 provides an overview of the wizard pages that appear and the types of questions for which you are prompted to provide details. Before using this wizard, review the information shown in Table 9–1. Table 9–1 Create Trading Partner Wizard Pages Page Description Page 1: General Page Prompts you to enter a remote trading partner name and an optional description Creating Trading Partners 9-3 Trading Partner Creation Overview Table 9–1 (Cont.) Create Trading Partner Wizard Pages Page Description Page 2: Identification Page Prompts you to enter a value and description for a remote trading partner identification type. For example, a value for the following: ■ AS2 Identifier ■ DUNS number ■ EDI Group ID ■ EDI Interchange ID ■ EDI location code ■ Generic Identifier Note: Enter an Internet Protocol (IP) address to identify trading partners if you are using a generic exchange protocol with the HTTP or HTTPS transport protocol. Do not enter a hostname. ■ MLLP ID ■ ebMS Identifier ■ Any additional identification types you created by clicking Administration, then Design, then Trading Partner Identification Types, and then Create Note: You can click Finish on this page to create the remote trading partner name. You can also click Next to continue assigning the remote trading partner support for a business protocol and creating its operational capabilities (support for collaborations or business actions) and communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint) during this wizard session. If you click Finish, you can define these details at a later time. Page 3: Operational Capability Page Prompts you to select a business protocol. Each business protocol has an associated document protocol, exchange protocol, and process protocol. Based on your business protocol selection, the page refreshes to prompt you for additional details to define for this remote trading partner. For example: ■ ■ If you select the RosettaNet over RNIF business protocol, you are prompted to select support for a collaboration (for example, RosettaNet Partner Interface Process (PIP) 3A4) and its associated role (for example, buyer or seller), enter a time in which to process the collaboration, and select whether OracleAS Integration B2B handles acknowledgments. If you select any EDI, Custom Document, or HL7 business protocol, you are prompted to select support for a business action, if the business action is the initiator, if a functional acknowledgment is required, whether OracleAS Integration B2B handles acknowledgments, and the document type. You also have the option to use or override default settings created with the Create Business Action wizard for document protocol parameter values and document definitions and to select different document definition files. 9-4 Oracle Application Server Integration B2B User’s Guide Trading Partner Creation Overview Table 9–1 (Cont.) Create Trading Partner Wizard Pages Page Description Page 4: Delivery Channel Page Prompts you to define the following delivery channel details for the secure exchange of messages between trading partners: ■ Delivery channel name ■ Acknowledgment mode ■ Global usage code ■ If nonrepudiation of receipt and nonrepudiation of origin are required ■ If encryption, transport security, and compression are enabled ■ Time to acknowledgment value ■ Retry count value Note: The selections you make on this page for nonrepudiation of receipt, nonrepudiation of origin, encryption, and transport security determine the fields that display and the transport protocols that are selectable on subsequent pages of this wizard. Page 5: Document Exchange Page Prompts you to define the following document exchange characteristics for exchanging messages between trading partners: ■ ■ ■ ■ ■ Page 6: Transport Page Document exchange name Exchange protocol revision (for example, RosettaNet V02.00 or 01.10) and parameter values that can be overridden, if necessary Document exchange protocol parameters Digital signature, signing credential, and certificate file if you selected Yes for nonrepudiation of receipt and nonrepudiation of origin on the Delivery Channel page Digital envelope, encryption credential, and certificate file if you selected Yes to enable encryption on the Delivery Channel page Prompts you to define the following transport characteristics for message delivery using a selected transport communication protocol: ■ ■ Transport name and protocol. If you selected Yes to enable transport security on the Delivery Channel page, you are prompted to select a secure transport protocol. Transport server name, hostname, address, and login credentials ■ Transport parameters ■ Endpoint URI of the trading partner Creating Trading Partners 9-5 Trading Partner Creation Overview Table 9–1 (Cont.) Create Trading Partner Wizard Pages Page Description Page 7: Review Page Prompts you to review details about the following selections you made on the previous wizard pages: ■ ■ ■ If using RosettaNet, then the business protocol, support for a collaboration, collaboration role, and whether a default document definition is used (displayed under the Operational Capability header) If using EDI, Custom Document, or HL7, then the business protocol, support for a business action, whether default document protocol parameters are used, and whether a default document definition is used (displayed under the Operational Capability header) Delivery channel, document exchange, exchange protocol revision, transport, transport protocol, and transport server (displayed under the Communication Capability header) Note: After the trading partner is created, the Trading Partner Details page includes General, Organization, Users, and Capabilities links at the top of the page. The Capabilities link points to the details described on the Review page. Create Trading Partner Wizard and Protocol Standards The Create Trading Partner wizard can prompt you for information that is not applicable to the business protocol you select. Nothing prevents you from providing responses to these prompts. However, you only receive the benefits provided by these features if your business protocol selection actually supports these capabilities. You must understand the capabilities of your business protocol before using the Create Trading Partner wizard. For example: ■ ■ ■ ■ ■ 9-6 The Compression Enabled field on the Create Trading Partner: Delivery Channel page only applies to the business protocols using the AS2 exchange protocol: Custom Document over Internet, EDI X12 over Internet, and EDI EDIFACT over Internet. The Is acknowledgement handled by Integration B2B? field on the Create Trading Partner: Operational Capability page that appears for all business protocols applies to the following exchange protocols only: ebMS, AS2, RNIF. The Functional acknowledgement required? field on the Create Trading Partner: Operational Capability page that appears for all business protocols applies to business protocols that include the EDI X12 or EDI EDIFACT document protocol only. It does not apply to business protocols using the Custom Document protocol. If you are using a business protocol with a generic exchange, you must select None from the Acknowledgement Mode list on the Create Trading Partner: Delivery Channel page. If you select Sync or Async, validation fails when creating a configuration. The Is Non-Repudiation of Origin Required, Is Non-Repudiation of Receipt Required, and Encryption Enabled fields on the Create Trading Partner: Delivery Channel page are not supported for business protocols using a generic exchange protocol with the File or FTP transport protocols. Oracle Application Server Integration B2B User’s Guide Trading Partner Creation Overview Prerequisites to Using the Create Trading Partner Wizard Ensure that you review and complete any necessary prerequisites described in Table 9–2 before using the Create Trading Partner wizard: Table 9–2 Prerequisites to Using the Create Trading Partner Wizard Prerequisite If you are using the generic exchange protocol parameter, ensure that you first review all product workarounds. If you want to create a remote trading partner and assign it an EDI, HL7, or Custom Document (such as a UCCnet standard) business protocol during a single wizard session, you must first create support for a business action or import a transaction set (maps to a document type of a business action in the OracleAS Integration B2B user interface) or standard. If you want to create a remote trading partner and assign it the RosettaNet over RNIF business protocol during a single wizard session, you must first create or import support for a collaboration. See Section... ■ ■ ■ ■ ■ "Generic Exchange Protocol Workarounds" on page A-6 "Creating a Business Action" on page 8-20 "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 "Creating a Collaboration" on page 8-27 "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 Accessing the Create Trading Partner Wizard The Create Trading Partner wizard provides you with a flexible approach to performing the tasks in Figure 9–1. For example, you can: ■ ■ ■ Create a remote trading partner, assign support for the business protocol, and create the business protocol operational capabilities and communication capabilities during a single wizard session. Create a remote trading partner now, assign support for the business protocol, and create the business protocol operational capabilities (support for a collaboration or business action) and communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint) during separate wizard sessions. Create the communication capabilities of the host trading partner during a separate wizard session. The host trading partner is automatically assigned a business protocol and operational capabilities that are compatible with those of the remote trading partner. The method by which to access the different pages of the Create Trading Partner wizard is based on the task you want to perform. Table 9–3 describes these tasks and their access methods. Creating Trading Partners 9-7 Trading Partner Creation Overview Table 9–3 Create Trading Partner Wizard Tasks and Access Methods Task Access Method See Section... For Remote Trading Partners: - - ■ ■ ■ Create the trading partner, 1. assign support for the business protocol, and create the business protocol 2. operational and communication capabilities during a single wizard session Click Partners, then Trading Partners, then Create or Partners, then Create Trading Partner in the Shortcuts section. Create only the trading partner name during a single wizard session 1. Click Partners, then Trading Partners, then Create or Partners, and then Create Trading Partner in the Shortcuts section. 2. Complete only the first two pages of the Create Trading Partner wizard. 3. Click Finish. 1. Click Partners, then Trading Partners. 2. Select the previously created trading partner in the Name column. 3. Click Capabilities, then Add in the Business Protocols section. 4. Select a business protocol from the Business Protocol list. 1. Click Partners, then Trading Partners. 2. Select the previously created trading partner in the Name column. 3. Click Capabilities. Assign support for the business protocol during a separate session Note: You can assign support for multiple business protocols to a remote trading partner. The host trading partner is automatically assigned all business protocols. ■ Assign support for the business protocol and create its operational capabilities during a separate session Note: The host trading partner is automatically assigned support for 4. all operational capabilities. 5. For Both the Host and Remote Trading Partners: ■ Create the business protocol communication capabilities "Assigning the Business Protocol to the Remote Trading Partner" on page 9-25 "Creating Business Protocol Operational Capabilities for the Remote Trading Partner" on page 9-26 Click Create Operational Capability. This action starts the Operational Capability page of the wizard and enables you to create business action or collaboration details. - 1. Click Partners, then Trading Partners. 2. Select the previously created trading partner in the Name column. 5. "Creating a Remote Trading Partner" on page 9-24 Select the business protocol to which to add operational capabilities in the Name column of the Business Protocols section. - Note: Use this method for the host trading partner and if you need to 3. create the remote trading partner communication capabilities during 4. a separate wizard session. 9-8 Complete all Create Trading Partner wizard pages (seven pages in total). "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 Click Capabilities. Select the business protocol to which to add communication capabilities in the Name column of the Business Protocols section. Click Create Communication Capability. This action starts the Delivery Channel page of the wizard, and guides you through all remaining pages (Document Exchange, Transport, and Review) of the wizard. Oracle Application Server Integration B2B User’s Guide "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Creating and Assigning All Capabilities During a Single Wizard Session Creating and Assigning All Capabilities During a Single Wizard Session You can create and assign all capabilities to a remote trading partner during a single wizard session if you have all the required information. The single wizard session enables you to do the following: ■ ■ ■ Assign support for a business protocol Create the business protocol operational capabilities (support for a collaboration or business action) Create the business protocol communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) Follow these tasks to create a remote trading partner, assign it support for a business protocol, and create business protocol operational and communication capabilities during a single wizard session. ■ Page 1: General Page ■ Page 2: Identification Page ■ Page 3: Operational Capability Page ■ Page 4: Delivery Channel Page ■ Page 5: Document Exchange Page ■ Page 6: Transport Page ■ Page 7: Review Page Note: You do not need to create a host trading partner; the host trading partner is automatically created during installation. There can be only one host trading partner. Page 1: General Page 1. Click Partners. 2. Under Shortcuts, click Create Trading Partner. The Create Trading Partner: General page appears. 3. Enter the following details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the remote trading partner. Description Enter an optional description for the remote trading partner. 4. Click Next. The Create Trading Partner: Identification page appears. Page 2: Identification Page 1. Enter a value for an identification type for the remote trading partner. The following types are automatically included with OracleAS Integration B2B. Additional identification types are displayed if you created them by clicking Creating Trading Partners 9-9 Creating and Assigning All Capabilities During a Single Wizard Session Administration, then Design, then Trading Partner Identification Types, and then Create. Field Value AS2 Identifier Enter the AS2 identifier. This type is an alias for the service address (specified by the AS2-from field) inside an AS2 transaction. DUNS Enter a DUNS (data universal numbering system) value. This type, known formally as a D-U-N-S Number, is a unique, sequentially-generated, nine-digit number that you obtain from Dun and Bradstreet. EDI Group ID Enter an EDI group identifier. This type identifies the trading partner based on the EDI group ID in the group envelope of an EDI message. EDI Interchange ID Enter the EDI interchange identifier. This type identifies the trading partner based on the EDI interchange ID in the interchange envelope of an EDI message. EDI Location Code Enter an EDI location code. This type provides a unique identification of all locations relevant to the EDI transaction. Generic Identifier Enter the IP address to use for identifying trading partners if you are using the generic exchange protocol (EDI X12 over Generic Exchange, EDI EDIFACT over Generic Exchange, or Custom Document over Generic Exchange) with the HTTP or HTTPS transport protocol. Do not enter the hostname. MLLP ID Enter the MLLP identifier.This type, TCP/IP Minimum Lower Layer Protocol (MLLP), is the standard for HL7. ebMS Identifier Enter the ebMS identifier.This type, OASIS ebXML Messaging Services (ebXML), specifies a secure and reliable way to exchange messages using HTTP, HTTPS, SOAP, XMLDsig, and XMLEncrypt. See "Creating a Trading Partner Identification Type" on page 17-4 for instructions on creating additional identification types. 2. Enter an optional description of the trading partner identification type. 3. Click one of the following based on what you want to do next. Click... If You Want To... Next Continue assigning the remote trading partner support for a business protocol and creating its operational capabilities (support for a collaboration or business action) and communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) during this single wizard session. If you click Next, you can complete all remaining pages of this wizard. The remaining procedures in this section describe the pages that appear when you click Next. Finish Exit the wizard and create the remaining details at a later time. 4. Click Next. The Create Trading Partner: Operational Capability page appears. 9-10 Oracle Application Server Integration B2B User’s Guide Creating and Assigning All Capabilities During a Single Wizard Session Page 3: Operational Capability Page Notes: ■ ■ 1. In addition to accessing the Operational Capability page through the Create Trading Partner wizard, you can also access this page by clicking Create Operational Capability on the Business Protocol Details page of a remote trading partner. Instructions for using that method are provided in "Creating Business Protocol Operational Capabilities for the Remote Trading Partner" on page 9-26. The host trading partner is automatically assigned all operational capabilities. Select a business protocol for a remote trading partner from the Business Protocol list. The business protocol identifies the implementation guidelines for the reliable transport of business document messages between trading partners. Each business protocol consists of the following three protocols: ■ Document protocol Defines the document types of the message payload ■ Exchange protocol Defines the message exchange mechanism—how to exchange the documents defined by the document protocol. It defines the headers, the acknowledgments, and the packaging that puts the headers and payload together. It also defines the transport protocol and packaging protocol for the exchange. ■ Process protocol Defines how you exchange messages, using the document protocol-based business document, and exchanging it based on the exchange protocol. The following business protocols (and their associated process, document, and exchange protocols) are displayed: Includes This Process This Business Protocol... Protocol Includes This Document Protocol Includes This Exchange Protocol Custom Document over Generic Exchange B2B Custom Generic Custom Document over Internet B2B Custom AS2 Custom Document over MLLP Exchange B2B Custom MLLP Custom Document over ebMS B2B Custom ebMS EDI EDIFACT over Generic Exchange B2B EDI EDIFACT Generic EDI EDIFACT over Internet B2B EDI EDIFACT AS2 EDI X12 over Generic Exchange B2B EDI X12 Generic Creating Trading Partners 9-11 Creating and Assigning All Capabilities During a Single Wizard Session Includes This Process This Business Protocol... Protocol Includes This Document Protocol Includes This Exchange Protocol EDI X12 over Internet B2B EDI X12 AS2 HL7 over Generic Exchange B2B HL7 Generic HL7 over MLLP Exchange B2B HL7 MLLP RosettaNet over RNIF B2B RosettaNet RNIF The screen refreshes based on your selection in Step 1. 2. Go to the following step based on your business protocol selection: If You Selected... Go To... RosettaNet over RNIF Step 3 on page 9-12 Any EDI, HL7, or Custom Document business protocol Step 4 on page 9-14 3. If you selected RosettaNet over RNIF, perform Steps 3a through 3f. The following partial list is an example of the PIPs that can appear if you performed the following tasks: ■ ■ a. Imported RosettaNet support for collaborations by clicking Administration, then Management, and then Import Created the RosettaNet collaboration by clicking Partners, then Protocols, then RosettaNet over RNIF, and then Create Collaboration (in the Shortcut section) Select a PIP value from the Collaboration list. A collaboration consists of a set of roles (for example, buyer and seller) that interact and exchange business document messages through a set of agreed-upon steps. The following table provides an example of the collaborations that can appear if you imported the RosettaNet collaborations file. SeeTable 3–2 on page 3-4 for a list of the PIPs supported in OracleAS Integration B2B. Collaboration Type This Collaboration Supports the... 0A1 Notification of failure Detection by either involved party of the failure of a business activity to complete successfully 3A4 Request purchase order Following sequence of events: ■ ■ ■ ■ 9-12 Submittal of a purchase order request by a buyer Submittal of a receipt acknowledgment confirmation by a seller Submittal of a purchase order confirmation by a seller Submittal of receipt of a purchase order confirmation by a buyer 3A6 Distribute order status Sellers to send the status of open orders to buyers 3A7 Notify of purchase order update Oracle Application Server Integration B2B User’s Guide Process for requesting a work in process response containing information on the production status of the product being manufactured from trading partners Creating and Assigning All Capabilities During a Single Wizard Session Collaboration Type This Collaboration Supports the... 3A8 Request purchase order change Buyer to change purchase order line items and obtain a quick response from the provider that acknowledges, at the line level, if the changes are accepted, rejected, or pending 3B2 Notify of advance shipment Shippers to send advance shipment and shipper’s manifest notifications The page refreshes. b. Select a value from the Collaboration Role list. This is the role performed by a trading partner in a collaboration. The role you select defines who the initiator or responder is in this collaboration between trading partners (for example, the buyer is the initiator for PIP 3A4). The available selections are based on the support for a collaboration you selected from the list of example PIPs in Step 3a. This table provides an example of the roles that can appear if you imported the RosettaNet collaborations file. If You Selected... The List Displays These Selections... 0A1 ■ PIP Failure Notifier ■ Failure Report Administrator ■ Buyer ■ Seller ■ Seller ■ Buyer ■ Seller ■ Buyer ■ Buyer ■ Seller ■ Shipper ■ Receiver 3A4 3A6 3A7 3A8 3B2 c. Enter the time in minutes in which to process the support for a collaboration in the Time To Perform field. This value overrides the value defined by the collaboration. d. Select Yes or No from the Is acknowledgement handled by Integration B2B? list. Yes—OracleAS Integration B2B automatically generates and consumes the exchange-level acknowledgment. No—OracleAS Integration B2B passes the acknowledgment through. The middleware generates and consumes the acknowledgment. e. Click Next. The host trading partner is automatically assigned a collaboration that is compatible with your selection for the remote trading partner. f. Go to "Page 4: Delivery Channel Page" on page 9-15. Creating Trading Partners 9-13 Creating and Assigning All Capabilities During a Single Wizard Session 4. If you selected any EDI, Custom Document, or HL7 business protocol, then perform Steps 4a through 4f. Business actions are displayed if you performed the following tasks: ■ ■ a. Imported the EDI X12 and EDI EDIFACT transaction sets or UCCnet standards by clicking Administration, then Management, and then Import Created an EDI X12, EDI EDIFACT, or HL7 business action by clicking Partners, then Protocols, then business_protocol_name, and then Create Business Action (in the Shortcut section) Enter the following details. An asterisk (*) indicates a required field. Field Value Business Action * Select a business action. The page refreshes to display the Document Type list and the following two check boxes: ■ Use Existing Document Protocol Parameter Values ■ Use Default Document Definition Both check boxes are automatically selected. You specified values for both when you created the business action manually in "Creating a Business Action" on page 8-20 or imported it in "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8. If you deselect either or both check boxes, you have the opportunity to override the default settings after clicking Next. Is Initiator * Select False or True. Functional acknowledgement required? * Select No or Yes. Applies to EDI functional acknowledgments only. Is acknowledgement handled by Integration B2B? * Select No or Yes. If you select Yes, then OracleAS Integration B2B automatically generates and consumes the exchange-level acknowledgment. If you select No, then OracleAS Integration B2B passes the acknowledgment through. The middleware generates and consumes the acknowledgment. b. Select a document type from the Document Type list. A document type is displayed only if you have already created or imported one. c. If you want to change any document protocol parameter values, deselect the Use Existing Document Protocol Parameter Values check box. d. If you want to change the document definition file and enable translation and validation, deselect the Use Default Document Definition check box. e. Click Next. The steps to perform next are based on whether you deselected the check boxes: 9-14 If You... The... Then Go to... Did not deselect either check box The Delivery Channel page appears "Page 4: Delivery Channel Page" on page 9-15. Deselected either or both check boxes The Operational Capabilities page refreshes. Step 4f. Oracle Application Server Integration B2B User’s Guide Creating and Assigning All Capabilities During a Single Wizard Session f. Perform the following steps based on the check boxes you deselected. If you decide not to change anything, reselect either or both check boxes. This causes the page to refresh to hide the steps described in this table. If You Deselected... Then... Use Existing Document Protocol Parameter Values 1. Override appropriate document protocol parameter settings created or imported with the Create Business Action wizard by specifying an override value in the Override Value field. 2. Select the group or interchange .ecs files to import. 3. Click Next when finished. 4. Go to "Page 4: Delivery Channel Page" on page 9-15. Use Default Document Definition 1. Enter a unique and recognizable name for the document definition. 2. Enter an optional description. 3. Specify whether to enable document definition translation and validation. 4. Specify a different document definition file that contains the parameter value contents. 5. If the document is a zip file, specify the root XSD file name. 6. Override appropriate document definition parameter settings by specifying an override value in the Override Value field. If the parameter is a string, you can enter a value of up to 100 characters. 7. Select .ecs files to import. 8. Click Next when finished. 9. Go to "Page 4: Delivery Channel Page" on page 9-15. See the following for more information: ■ "Creating a Business Action" on page 8-20 ■ "Creating a Collaboration" on page 8-27 ■ "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 Page 4: Delivery Channel Page Note: In addition to accessing the Delivery Channel page through the Create Trading Partner wizard, you can also access this and all remaining wizard pages by clicking Create Communication Capability on the Business Protocol Details pages of the remote and host trading partners. Instructions for using that method are provided in "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27. Creating Trading Partners 9-15 Creating and Assigning All Capabilities During a Single Wizard Session 1. Enter the following delivery channel details to create the secure exchange of messages between trading partners. An asterisk (*) indicates a required field. The selections you make on this page from the Is Non-Repudiation of Receipt Required, Is Non-Repudiation of Origin Required, Encryption Enabled, and Transport Security Enabled lists determine the types of questions you are asked or selections you can make on later pages of this wizard. Field Value Name * Enter a unique and recognizable name for the delivery channel. Acknowledgement Mode Select Async, None, or Sync for the mode in which the trading partner receives messages. If you are using a business protocol that includes a generic exchange, you must select None. If you do not select None, validation fails when creating a trading partner agreement. Global Usage Code Select Production or Test. This specifies the usage of the delivery channel. If it is set to Test, then the delivery channel is used only for testing purposes. If it is set to Production, then it is used only for production purposes. Is Non-Repudiation of Receipt Required1 Select No or Yes. If you select Yes, a digital signature and signing credential are necessary. You are prompted for these details later on the Document Exchange page of this wizard. The value you select must match with that selected for Is Non-Repudiation of Origin Required. Is Non-Repudiation of Origin Select No or Yes. Required1 If you select Yes, a digital signature and signing credential are necessary. You are prompted for these details later on the Document Exchange page of this wizard. Do not select Yes if RosettaNet 01.10 is the exchange protocol to use. The value you select must match with that selected for Is Non-Repudiation of Receipt Required. Encryption Enabled1 Select No or Yes. If you select Yes, a digital envelop and encryption credential are necessary. You are prompted for these details later on the Document Exchange page of this wizard. Do not select Yes if RosettaNet 01.10 is the exchange protocol to use. 9-16 Oracle Application Server Integration B2B User’s Guide Creating and Assigning All Capabilities During a Single Wizard Session Field Value Transport Security Enabled Select No or Yes. The selection you make determines the type of transport protocol (HTTP or HTTPS) you can select later on the Transport page of this wizard. Compression Enabled Select No or Yes to compress the message. Compression is only supported for the Applicability Statement 2 (AS2) exchange protocol. Time To Acknowledgement Enter a value in minutes. This value specifies the time in which an acknowledgment must be received. If an acknowledgment is not received, then retries occur. Retry Count 1 2. Enter a value. This defines the number of times to retry. You must select either Yes or No if you want to include these delivery channel details in a trading partner agreement of a deployed configuration. Click Next. The Create Trading Partner: Document Exchange page appears. The document exchange describes the supported exchange revision protocol (such as RosettaNet 01.10), digital signature and signing details, and digital envelope and encryption credential details. The document exchange uses these capabilities to exchange messages with a trading partner. Page 5: Document Exchange Page 1. Enter the following document exchange details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the document exchange. Exchange Protocol Revision * Select the exchange protocol revision to use. The revisions that appear are based on the exchange protocol you are using: ■ If using RNIF, select RosettaNet - 01.10 or RosettaNet V02.00. ■ If using Generic Exchange, select Generic 1.0. ■ If using AS2, select AS2 - 1.1 ■ If using MLLP, select MLLP - 1.0 ■ If using ebMS, select ebMS - 1.0 or ebMS - 2.0 The page refreshes based on your selection in the Exchange Protocol Revision list and your previous selections from the Is Non-Repudiation of Receipt Required, Is Non-Repudiation of Origin Required, and Encryption Enabled lists on the Delivery Channel page of this wizard. Creating Trading Partners 9-17 Creating and Assigning All Capabilities During a Single Wizard Session 9-18 2. Accept or override (update) appropriate exchange protocol parameter default values in the Override Value field of the Exchange Protocol Parameters section. If you are using the AS2 exchange protocol, the parameter Signed and Compressed equals true means that OracleAS Integration B2B by default signs the message before compressing it. 3. If you selected Yes from the Encryption Enabled list on the Delivery Channel page, you are prompted to enter the following digital envelope and encryption credential details. An asterisk (*) indicates a required field. Oracle Application Server Integration B2B User’s Guide Creating and Assigning All Capabilities During a Single Wizard Session Field Value Digital Envelope * Select a digital envelope to use. The digital envelopes that appear are based on the exchange protocol revision you are using: ■ If using RosettaNet - V02.00, select one of the following digital envelopes: SMIME 3.0 with DES SMIME 3.0 with 3DES SMIME 3.0 with RC2-40 SMIME 3.0 with RC2-64 SMIME 3.0 with RC2-128 SMIME 2.0 with DES SMIME 2.0 with 3DES SMIME 2.0 with RC2-40 SMIME 2.0 with RC2-64 SMIME 2.0 with RC2-128 ■ If using AS2 - 1.1 or Generic 1.0, select one of the following digital envelopes: SMIME 3.0 with DES SMIME 3.0 with 3DES SMIME 3.0 with RC2-40 SMIME 3.0 with RC2-64 SMIME 3.0 with RC2-128 Digital envelopes are not supported for the other exchange protocols (those not explicitly identified here). Encryption Credential ■ Name * Select either of the following: ■ ■ ■ 4. Certificate File * Create New and enter a new encryption credential name in the Name field. Use Existing to access a list to select an existing encryption credential. Click Browse to select a certificate file. This certificate must be in base64-encoded format. If you selected Yes from the Is Non-Repudiation of Receipt Required and Is Non-Repudiation of Origin Required lists on the Delivery Channel page, you are prompted to enter the following digital signature and signing credential details. An asterisk (*) indicates a required field. Creating Trading Partners 9-19 Creating and Assigning All Capabilities During a Single Wizard Session Field Value Digital Signature * Select a digital signature to use. The digital signatures that appear are based on the exchange protocol revision you are using: ■ If using RosettaNet - V02.00, select one of the following digital signatures: SMIME 3.0 with SHA-RSA SMIME 3.0 with MD5-RSA SMIME 2.0 with SHA-RSA SMIME 2.0 with MD5-RSA ■ If using AS2 - 1.1 or Generic 1.0, select one of the following digital signatures: SMIME 3.0 with SHA-RSA SMIME 3.0 with MD5-RSA Note: Oracle recommends that you select a digital signature that uses SHA-RSA. Digital signatures are not supported for the other exchange protocols (those not explicitly identified here). Signing Credential ■ Name * Select either of the following: ■ ■ ■ Certificate File 5. Click Next. Create New and enter a new signing credential name in the Name field. Use Existing to access a list to select an existing signing credential. Click Browse to select a certificate file. This certificate must be in base64-encoded format. The Create Trading Partner: Transport page appears and enables you to create transport details for message delivery. The transport protocols available for selection are based on selecting Yes or No from the Transport Security Enabled list on the Delivery Channel page of this wizard. 9-20 Oracle Application Server Integration B2B User’s Guide Creating and Assigning All Capabilities During a Single Wizard Session Page 6: Transport Page 1. Enter a unique and recognizable name for the transport. 2. Select the transport protocol from the Transport Protocol list. The transport protocol selections that display are based on whether you selected No or Yes for Transport Security Enabled on the Delivery Channel page. If You Selected... Then... No Select HTTP - 1.0 or HTTP - 1.1 from the Transport Protocol list. Yes Select HTTP - 1.0 (Secure) or HTTP - 1.1 (Secure) from the Transport Protocol list. Each selection uses secure socket layer (SSL) 3.0. 3. If you are using the EDI X12 over Generic Exchange, EDI EDIFACT over Generic Exchange, Custom Document over Generic Exchange, or HL7 over Generic business protocol, then the following transport protocols are available: ■ HTTP - 1.0 ■ HTTP - 1.1 ■ Email - 1.0 ■ FTP - 1.0 ■ File - 1.0 Creating Trading Partners 9-21 Creating and Assigning All Capabilities During a Single Wizard Session Note: If you select Email - 1.0, be aware of the following issues: ■ ■ ■ There can be problems if the document being exchanged has large records Ensure that the incoming transport From and To headers use angle brackets (<,>) in the e-mail ID (for example, To=Joe<[email protected]>) See "Using the EMail Transport Protocol" on page 5-59 for more information. If you are using Custom Document over MLLP Exchange or HL7 over MLLP, then the TCP - 1.0 transport protocol is available. If you are using Custom Document over ebMS, then the following transport protocols are available: ■ HTTP - 1.0 ■ HTTP - 1.1 The page refreshes based on your selection in Step 2 or 3. 4. Enter the following transport server details. An asterisk (*) indicates a required field. Field Value Transport Server ■ Name * Select either of the following: ■ ■ Create New and enter a new transport server in the Name field. Use Existing to access a list to select an existing transport server. ■ Description Enter a description for the transport server. ■ Host Name * Enter the hostname of the transport server. Note: If using one of the generic exchange protocols with the HTTP or HTTPS transport protocol, enter the IP address to use for identifying trading partners. Do not enter the hostname. 9-22 ■ IP Address Enter the IP address of the transport server. ■ Username Enter the username for logging into the transport server. ■ Password Enter the password of the username. 5. Accept or override (update) appropriate transport parameter default values in the Override Value field of the Parameters section. For example, if you selected HTTP or secure HTTP, you can specify values for port and additional transport headers. 6. Enter the following endpoint details. An asterisk (*) indicates a required field. Field Value Endpoint - Oracle Application Server Integration B2B User’s Guide Creating and Defining All Capabilities During Separate Wizard Sessions Field ■ Value URI * Select either of the following: ■ ■ Create New and enter a new endpoint in the URI field. Use Existing to access the Endpoint list to select an existing URI. Note: Do not select any of the following predefined internal endpoints that display in the Endpoints list: apps.ECX_INBOUND, apps.ECX_OUTBOUND, b2b.IP_ IN_QUEUE, and b2b.IP_OUT_QUEUE. These endpoints are used only with internal delivery channels for communication between the host application and OracleAS Integration B2B, and cannot be updated or deleted. They cannot be used for communication between the host trading partner and the remote trading partner. 7. Click Next. The Create Trading Partner: Review page appears and displays details about the type of trading partner to create. See "Viewing a Business Protocol Endpoint" on page 10-63 for the internal endpoints that apply to each internal delivery channel. Page 7: Review Page 1. Review the trading partner details. ■ ■ To modify these details, click the Back button of the Create Trading Partner wizard to return to the previous pages. When you complete modifications, click Next until you access the review page; then click Finish. Do not use the Back and Forward buttons of your Web browser. If you are satisfied with these details, click Finish. The remote trading partner is created and the Trading Partner Details page for the new trading partner appears. Links to the General, Organization, Users, and Capabilities sections display at the top of the page. The host trading partner is automatically assigned a business protocol and operational capabilities that are compatible with those of the remote trading partner. You see these details when you create a trading partner agreement between the two trading partners. 2. Click the Capabilities section at the top of the page to access the Capabilities page for the business protocol you selected in Step 1 on page 9-11. 3. Click the business protocol in the Name column to access the Business Protocol Details page. This page includes details about the operational (support for a collaboration or business action) and communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint) you created with the Create Trading Partner wizard. Creating and Defining All Capabilities During Separate Wizard Sessions This method enables you to create a remote trading partner, assign support for a business protocol to the remote trading partner, create business protocol operational capabilities for the remote trading partner, and create business protocol communication capabilities for the host and remote trading partner during separate sessions. Creating Trading Partners 9-23 Creating and Defining All Capabilities During Separate Wizard Sessions This method is useful for environments in which you do not currently know all required details or do not plan to use some communication capabilities. You can create the trading partner now, and complete remaining details as the information becomes known. Follow these tasks to create the trading partner, assign support for the business protocol, and create the business protocol operational capabilities during separate wizard sessions. After completing these tasks, you can create the communication capabilities during an additional wizard session. ■ Creating a Remote Trading Partner ■ Assigning the Business Protocol to the Remote Trading Partner ■ ■ Creating Business Protocol Operational Capabilities for the Remote Trading Partner Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners Creating a Remote Trading Partner 1. Click Partners, then Trading Partners, then Create or Partners, and then Create Trading Partner in the Shortcuts section. The Create Trading Partner: General page appears. 2. Enter the following details. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the remote trading partner. Description Enter an optional description for the remote trading partner. 3. Click Next. The Create Trading Partner: Identification page appears. 4. 9-24 Enter a value for an identification type for the remote trading partner. A identification type is required to create a trading partner agreement. The following types are automatically included with OracleAS Integration B2B. Additional identification types can display here if you created them by clicking Administration, then Design, then Trading Partner Identification Types, and then Create. Field Value AS2 Identifier Enter the AS2 identifier. This type is an alias for the service address (specified by the AS2-from field) inside an AS2 transaction. DUNS Enter a DUNS (data universal numbering system) value. This type, known formally as a D-U-N-S Number, is a unique, sequentially-generated, nine-digit number that you obtain from Dun and Bradstreet. EDI Group ID Enter an EDI group identifier. This type identifies the trading partner based on the EDI group ID in the group envelope of an EDI message. EDI Interchange ID Enter the EDI interchange identifier. This type identifies the trading partner based on the EDI interchange ID in the interchange envelope of an EDI message. Oracle Application Server Integration B2B User’s Guide Creating and Defining All Capabilities During Separate Wizard Sessions Field Value EDI Location Code Enter an EDI location code. This type provides a unique identification of all locations relevant to the EDI transaction. Generic Identifier Enter the IP address to use for identifying trading partners if you are using the generic exchange protocol (EDI X12 over Generic Exchange, EDI EDIFACT over Generic Exchange, or Custom Document over Generic Exchange) with the HTTP or HTTPS transport protocol. Do not enter the hostname. MLLP ID Enter the MLLP identifier.This type, TCP/IP Minimum Lower Layer Protocol (MLLP), is the standard for HL7 ebMS Identifier Enter the ebMS identifier.This type, OASIS ebXML Messaging Services (ebXML), specifies a secure and reliable way to exchange messages using HTTP, HTTPS, SOAP, XMLDsig, and XM Encrypt. See "Creating a Trading Partner Identification Type" on page 17-4 for instructions on creating additional trading partner identification types. 5. Enter an optional description for trading partner identification. 6. Click Finish. You can assign the remote trading partner support for a business protocol as needed at a later time. Assigning the Business Protocol to the Remote Trading Partner Follow these instructions to assign the business protocol to the remote trading partner. 1. Click Partners, then Trading Partners. 2. Select the specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Click Add in the Business Protocols section. The Add Business Protocol page appears. 5. Select a business protocol to add from the Business Protocol list. See Step 1 of "Page 3: Operational Capability Page" on page 9-11 for a list of selections. 6. Click Apply. The business protocol is assigned and the Capabilities page appears. 7. Select the new business protocol in the Name column. The Business Protocol Details page for the selected business protocol appears. 8. View specific details. Note that the page is divided into two main sections (Operational Capabilities and Communication Capabilities) that each consist of additional subsections. You can create the operational and communication capabilities as needed at a later time. Section Subsections Operational Capabilities ■ Supported Collaborations (appears if you selected the RosettaNet over RNIF business protocol) Creating Trading Partners 9-25 Creating and Defining All Capabilities During Separate Wizard Sessions Section Subsections ■ Communication Capabilities Supported Business Actions (appears if you selected any EDI or Custom Document business protocol) ■ Delivery Channels ■ Document Exchanges ■ Transports ■ Transport Servers ■ Endpoints Creating Business Protocol Operational Capabilities for the Remote Trading Partner Follow these instructions to assign support for a collaboration or business action (the operational capabilities) to the business protocol added in "Assigning the Business Protocol to the Remote Trading Partner" on page 9-25. Collaborations and business actions describe the business documents and their movement between trading partners. Trading partners define their operational capabilities by the collaborations and business actions they support. This method uses the Operational Capability page of the Create Trading Partner wizard. 1. Click Partners, then Trading Partners. 2. Select the specific remote trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select the business protocol to which to add operational capabilities in the Name column of the Business Protocols section. 5. Click Create Operational Capability in the Operational Capabilities section. The page that displays next is based on the type of business protocol you selected in Step 4. 6. Perform the following steps based on the business protocol type you selected. If You Selected... Go to... RosettaNet over RNIF Step 7 Any EDI or Custom Document business protocol Steps 4a through 4f on page 9-14. After you complete those steps, the Supported Business Action Details page appears and displays your selections. 7. If you selected RosettaNet over RNIF as the business protocol, perform Steps 7a through 7d. a. 9-26 Make a selection from the Collaboration Role list. Each selection combines a role (for example, Buyer), a collaboration (for example, 3A4), and a version (for example, V02.00). The selections that appear are based on the types of support for collaborations you imported or created. – Buyer - 3A4 - V02.00 – Buyer - 3A6 - V02.00 Oracle Application Server Integration B2B User’s Guide Creating and Defining All Capabilities During Separate Wizard Sessions – Buyer - 3A7 - V02.00 – Buyer - 3A8 - V02.00 – Failure Report Administrator - 0A1 - V02.00 – PIP Report Administrator - 0A1 - V02.00 – Receiver - 3B2 - V01.00 – Seller - 3A4 - V02.00 – Seller - 3A6 - V02.00 – Seller - 3A7 - V02.00 – Seller - 3A8 - V02.00 – Shipper - 3B2 - V01.00 b. Select Yes or No from the Is acknowledgement handled by Integration B2B? list. c. Enter the time in minutes in which to process the support for a collaboration in the Time To Perform field. This value overrides the value defined by the collaboration. d. Click Apply. Support for a collaboration is created. Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners Follow these instructions to create communication capabilities (delivery channel, document exchange, transport, transport server, and endpoint details) for the host trading partner and the remote trading partner business protocol added in "Assigning the Business Protocol to the Remote Trading Partner" on page 9-25. This method uses the Delivery Channel, Document Exchange, and Transport pages of the Create Trading Partner wizard. A delivery channel is required to create a trading partner agreement. 1. Review the following sections before using the Create Trading Partner wizard. ■ ■ "Create Trading Partner Wizard and Protocol Standards" on page 9-6 for details about how the communication capabilities available to you are based on the business protocol you select "Prerequisites to Using the Create Trading Partner Wizard" on page 9-7 for communication capability prerequisites for using the Create Trading Partner wizard 2. Click Partners, then Trading Partners. 3. Select the specific trading partner in the Name column. 4. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 5. Select the business protocol to which to add communication capabilities in the Name column of the Business Protocols section. See Step 1 on page 9-11 for a list of selections. 6. Click Create Communication Capability in the Communication Capabilities section. Creating Trading Partners 9-27 Common User Errors The Delivery Channel page of the Create Trading Partner wizard appears. This wizard guides you through the remaining pages of the wizard (Delivery Channel, Document Exchange, Transport, and Review) to create the communication capabilities of the remote trading partner. 7. Go to "Page 4: Delivery Channel Page" on page 9-15 and follow the remaining pages of the Create Trading Partner wizard. Common User Errors ■ ■ ■ ■ ■ Do not include beginning or trailing blank spaces in the names of trading partner data that you create. The values you select for Is Non-Repudiation of Origin Required and Is Non-Repudiation of Receipt Required must match. You must select Yes or No for Is Non-Repudiation of Origin Required, Is Non-Repudiation of Receipt Required, and Encryption Enabled if you want to include these delivery channel details in a trading partner agreement of a deployed configuration. If you are using a business protocol with a generic exchange, you must select None from the Acknowledgement Mode list on the Create Trading Partner: Delivery Channel page. To avoid additional generic exchange errors, ensure that you review all details described in "Generic Exchange Protocol Workarounds" on page A-6. If you are using encryption and signing credentials, then you must input the digital certificate in base64-encoded format. Summary This chapter describes how you use the Create Trading Partner wizard to perform the following tasks: ■ Create a remote trading partner ■ Assign support for a business protocol to a remote trading partner ■ Create operational and communication capabilities for a remote trading partner ■ Create communication capabilities for the host trading partner You can perform these tasks as part of single wizard session or separate wizard sessions. The host trading partner is automatically assigned a business protocol and operational capabilities that are compatible with those of the remote trading partner. You assign only communication capabilities to the business protocol of the host trading partner. 9-28 Oracle Application Server Integration B2B User’s Guide 10 Managing Trading Partners This chapter describes the tasks required to manage trading partners, support for their business protocols, and their business protocol operational and communication capabilities. This chapter contains the following topics: ■ Trading Partner Management Overview ■ Managing Trading Partners ■ Managing Trading Partner Identification ■ Managing Trading Partner Agreements ■ Managing Remote Trading Partner Certificates ■ Managing the Host Trading Partner Wallet Password ■ Managing Trading Partner Contact Information for Persons and Organizations ■ Managing Trading Partner Persons ■ Managing Trading Partner Business Protocols ■ Managing Internal Delivery Channels ■ Managing Business Protocol Collaborations ■ Managing Business Protocol Business Actions ■ Managing Business Protocol Delivery Channels ■ Managing Business Protocol Document Exchanges ■ Managing Business Protocol Transports ■ Managing Business Protocol Transport Servers ■ Managing Business Protocol Endpoints ■ Common User Errors ■ Summary See Chapter 9, "Creating Trading Partners" for instructions on creating trading partners, assigning support for business protocols, and creating business protocol operational and communication capabilities. Trading Partner Management Overview In Chapter 9, "Creating Trading Partners" you created the remote trading partner, assigned support for the business protocol to the remote trading partner, created Managing Trading Partners 10-1 Trading Partner Management Overview business protocol operational capability for the remote trading partner, and created business protocol communication capabilities for the host and remote trading partners. You can now perform additional trading partner management tasks (for example, viewing, updating, deleting, adding, and removing details). The following sections provide a brief overview of the pages from which you perform these tasks: ■ Trading Partner Details Page ■ Capabilities Page ■ Business Protocol Details Page Trading Partner Details Page Both trading partners have a Trading Partner Details page similar to that shown in Figure 10–1. A remote trading partner is shown for this example; the page for the host trading partner differs only in that you cannot manage a certificate; instead a method for managing a wallet password is provided. You access the Trading Partner Details page by clicking Partners, then Trading Partners, and then trading_partner_name_in_the_Name_column. Four sections display at the top of the Trading Partner Details page: General, Organization, Users, and Capabilities. Figure 10–1 Trading Partner Details Page These four sections enable you to access pages from which to perform management tasks. Table 10–1 describes the tasks you can access from these sections and provides references for more details. 10-2 Oracle Application Server Integration B2B User’s Guide Trading Partner Management Overview Table 10–1 Trading Partner Details Page Management Tasks Section Management Task Description General This is the default page that displays when you first access the Trading Partner Details page shown in Figure 10–1. This page enables you to manage the following details: ■ See Section... Trading Partner Identifications "Managing Trading Partner Identification" on page 10-7 Enables you to manage the method for uniquely identifying a trading partner (for example, a Data Universal Numbering System (DUNS) number) ■ Associated Agreements Enables you to manage the trading partner agreement of which the trading partner is a part ■ Certificates (for remote trading partners only) "Managing Remote Trading Partner Certificates" on page 10-11 Enables you to securely bind an identity such as a remote trading partner to a public key ■ "Managing Trading Partner Agreements" on page 10-10 Wallet passwords (for the host trading partner only) "Managing the Host Trading Partner Wallet Password" on page 10-14 Enables you to store and manage a wallet password Note: Wallet password management tasks do not display in Figure 10–1, which is an example of a Trading Partner Details page for a remote trading partner. Instead, see Figure 10–8 on page 10-15. Organization Clicking this section displays a page for managing the contact information for persons (for example, an e-mail address). (See Figure 10–9 on page 10-17 for an example of this page.) "Managing Trading Partner Contact Information for Persons and Organizations" on page 10-17 Users Clicking this section displays a page for managing OracleAS Integration B2B persons. Persons consist of OracleAS Integration B2B user interface users and persons who can optionally review trading partner details (for example, the business protocol and operational and communication capabilities assigned to a trading partner). (See Figure 10–10 on page 10-20 for an example of this page.) "Managing Trading Partner Persons" on page 10-20 Capabilities Clicking this section displays a page for managing the business protocol of a trading partner. You can also access a page to manage the operational and communication capabilities of the business protocol. (See Figure 10–2 on page 10-4.) For the host trading partner, internal delivery channels can also be managed from this page. "Managing Trading Partner Business Protocols" on page 10-25 Capabilities Page Clicking Capabilities on the Trading Partner Details page displays the Capabilities page shown in Figure 10–2. This page enables you to manage the business protocol associated with the trading partner and access a page for managing the operational and communication capabilities of the business protocol. The Capabilities page that displays in this example is for a remote trading partner; only business protocols that you have explicitly assigned to the remote trading partner appear. The Capabilities page for a host trading partner displays all business protocols available with OracleAS Integration B2B. This is because the host trading partner is automatically assigned support for all business protocols and operational capabilities. This simplifies the user experience. (See Figure 10–12 on page 10-26 for the Capabilities page of the host trading partner.) Managing Trading Partners 10-3 Trading Partner Management Overview Figure 10–2 Capabilities Page See "Managing Trading Partner Business Protocols" on page 10-25 for additional details about the Capabilities pages for both host and remote trading partners. Business Protocol Details Page Clicking the business protocol name in the Name column in Figure 10–2 (for this example, RosettaNet over RNIF) enables the Business Protocol Details page shown in Figure 10–3 to appear. Figure 10–3 Business Protocol Details Page Management tasks on the Business Protocol Details page are divided into two sections: Operational Capabilities and Communication Capabilities. Table 10–2 describes the tasks you can access from these sections and provides references for more details. 10-4 Oracle Application Server Integration B2B User’s Guide Managing Trading Partners Table 10–2 Business Protocol Details Page Management Tasks Section Management Task Description Operational Capabilities This section enables you to manage the following operational capabilities: ■ See Section... Support for collaborations (these display if you are using the RosettaNet over RNIF business protocol) Enables you to manage the collaborations used between trading partners ■ Support for business actions (these display if you are using any EDI or Custom Document business protocol) Enables you to manage the business actions used between trading partners "Managing Business Protocol Collaborations" on page 10-43 "Managing Business Protocol Business Actions" on page 10-46 Communication This section enables you to manage the following communication Capabilities capabilities: ■ Delivery Channels Enables you to manage security characteristics such as nonrepudiation of origin and receipt, acknowledgment mode, time to acknowledge, retry count, transport security, encryption, and file compression ■ Document Exchanges "Managing Business Protocol Document Exchanges" on page 10-52 Enables you to manage the capabilities for exchanging messages with a trading partner ■ Transports Enables you to manage transport protocols, modes, servers, and endpoints ■ Transport Servers Enables you to manage the endpoint server of the trading partner ■ "Managing Business Protocol Delivery Channels" on page 10-49 "Managing Business Protocol Transports" on page 10-55 "Managing Business Protocol Transport Servers" on page 10-58 Endpoints "Managing Business Protocol Endpoints" on Enables you to manage the endpoint address (typically a URI) page 10-61 of a trading partner The remaining sections of this chapter provide specific details on managing trading partners, support for their business protocols, and the operational and communication capabilities of the business protocols. Managing Trading Partners The OracleAS Integration B2B user interface enables you to perform the remote and host trading partner management tasks shown in Figure 10–4. These tasks are described in detail in this section. The remote trading partner is the party outside of the enterprise of the host trading partner (and its installation of OracleAS Integration B2B). The host trading partner is identified by the word (Host) that displays in the Trading Partners page shown in Figure 10–4. Managing Trading Partners 10-5 Managing Trading Partners Figure 10–4 Trading Partner Management Tasks Table 10–3 identifies the trading partner management tasks shown in Figure 10–4 and provides references to procedures for performing these tasks. Table 10–3 Trading Partner Management Tasks Page Elements Management Task Shortcut section in Take a shortcut to create a Trading Partners page trading partner agreement of Figure 10–4 See Section... "Managing Trading Partner Agreements" on page 12-4 Create button of Create a remote trading partner "Trading Partner Creation Trading Partners page (the host trading partner is Overview" on page 9-1 of Figure 10–4 automatically created) Name column of View details about a host or Trading Partners page remote trading partner of Figure 10–4 "Viewing a Host or Remote Trading Partner" on page 10-6 Update column of Update a host or remote Trading Partners page trading partner of Figure 10–4 "Updating a Host or Remote Trading Partner" on page 10-7 Delete column of Delete a remote trading partner "Deleting a Remote Trading Partner" Trading Partners page (you cannot delete the host on page 10-7 of Figure 10–4 trading partner) Viewing a Host or Remote Trading Partner Follow these instructions to view details about a host or remote trading partner: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner to view in the Name column. The Trading Partner Details page for the selected trading partner appears. 3. View specific details, including the following: ■ ■ ■ Trading partner identification type and value (for example, a DUNS number, EDI location code, or AS2 Identifier) of the trading partner Trading partner agreements and their current state (for example, Draft) with which this trading partner is associated Remote trading partner certificate name and location (The host trading partner uses a wallet password instead of a certificate.) See Figure 10–5 on page 10-8 for an example of the Trading Partner Details page. The Trading Partner Details page, as with the Trading Partners page shown in Figure 10–4 on page 10-6, enables you to delete or update a remote trading partner and update the host trading partner. Links to the General, Organization, Users, and Capabilities sections also display at the top of the page. 10-6 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Identification 4. Click Return to List to return to the Trading Partners page. See the following for more information: ■ ■ "Exporting Partner Data to an XML File" on page 2-9 for details on the Export button that displays on Trading Partner Details pages "Viewing the State of Partner Data on the Details Pages" on page 2-11 for details on the Draft, Approved, and Deployed states that display on Trading Partner Details pages Updating a Host or Remote Trading Partner The remote trading partner name is the name you entered when creating a remote trading partner in Chapter 9, "Creating Trading Partners". The host trading partner is automatically named MyCompany after installation. You can change the host name to one that more accurately reflects your organization or company (for example, ipdev, which appears in Figure 10–4 on page 10-6). Follow these instructions to update the name (or description) of a host or remote trading partner. 1. Click Partners, then Trading Partners. 2. Select a specific trading partner name to update in the Update column. The Update Trading Partner page appears. 3. Make appropriate changes to the name (or description) of the trading partner. 4. Click Apply. The trading partner is updated and the Trading Partners Details page appears. Deleting a Remote Trading Partner Follow these instructions to delete a remote trading partner: Note: You cannot delete the host trading partner. Only remote trading partners can be deleted. 1. Click Partners, then Trading Partners. 2. Select a specific remote trading partner to delete in the Delete column. 3. Click Yes when prompted to delete a remote trading partner. The remote trading partner is deleted and the Trading Partners page appears. Managing Trading Partner Identification The OracleAS Integration B2B user interface enables you to perform the trading partner identification management tasks shown in Figure 10–5. These tasks are described in detail in this section. The trading partner identification value is separate from the trading partner name and provides an additional method to uniquely identify a trading partner. Trading partner identification consists of a type and a value and is required to create a trading partner agreement. A trading partner identification type called Name with a value of MyCompany is automatically created for the host trading partner. When you create a remote trading partner, a trading partner identification type called Name with a value of the remote trading partner’s name is also automatically created. Managing Trading Partners 10-7 Managing Trading Partner Identification Figure 10–5 Trading Partner Identification Management Tasks Table 10–4 identifies the trading partner identification management tasks shown in Figure 10–5 and provides references to procedures for performing these tasks. Table 10–4 Trading Partner Identification Management Tasks Page Elements Management Task See Section... Create button in Trading Partner Identifications section of Figure 10–5 Create trading partner identification "Creating Trading Partner Identification" on page 10-8 Details column in Trading Partner Identifications section of Figure 10–5 View details about trading partner identification "Viewing a Trading Partner Identification" on page 10-9 Update column in Trading Partner Identifications section of Figure 10–5 Update trading partner identification "Updating a Trading Partner Identification" on page 10-10 Delete column in Trading Partner Identifications section of Figure 10–5 Delete trading partner identification "Deleting a Trading Partner Identification" on page 10-10 Note: The trading partner identification type and value also display in the Trading Partner Identification Type and Value columns, respectively, of the Trading Partner Identifications section. (See Figure 10–5.) Creating Trading Partner Identification Follow these instructions to create trading partner identification for the host or remote trading partner. The Create Trading Partner wizard also enables you to create an identification for the remote trading partner. Trading partner identification is required to create a trading partner agreement. A default trading partner identification type called Name is automatically provided for host and remote trading partners. 1. 10-8 Click Partners, then Trading Partners. Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Identification 2. Select a specific trading partner in the Name column. 3. Click Create in the Trading Partner Identifications section. The Create Trading Partner Identification page displays the fields for creating trading partner identification. 4. Enter the following details to create trading partner identification. An asterisk (*) indicates a required field. Additional identification types can display here if you created them by clicking Administration, then Design, then Trading Partner Identification Types, and then Create. Field Value Trading Partner Identification Type* Select a type from the available values. ■ DUNS DUNS (data universal numbering system) known formally as a D-U-N-S Number, is a unique, sequentially-generated, nine-digit number that you obtain from Dun and Bradstreet. ■ EDI Location Code Provides a unique identification of all locations relevant to the EDI transaction. ■ AS2 Identifier An alias for the service address (specified by the AS2-from field) inside an AS2 transaction. ■ Generic Identifier The Internet Protocol (IP) address to use for identifying trading partners if you are using the generic exchange protocol (EDI X12 over Generic Exchange, EDI EDIFACT over Generic Exchange, or Custom Document over Generic Exchange) with the HTTP or HTTPS transport protocol. Do not enter the hostname. Value * Enter a value for the selected type. For example, if DUNS is your type, enter the DUNS number. Description Provide an optional description. 5. Click Apply. Trading partner identification is created and the new Trading Partner Identification Details page appears. See "Page 2: Identification Page" on page 9-9 for an alternative method of creating trading partner identification for a remote trading partner with the Create Trading Partner wizard. Viewing a Trading Partner Identification Follow these instructions to view details about a specific trading partner identification: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Select a specific trading partner identification to view in the Details column of the Trading Partner Identifications section. The Trading Partner Identification Details page for the selected trading partner identification appears. Managing Trading Partners 10-9 Managing Trading Partner Agreements 4. View specific details about the trading partner identification type and value (for example, a DUNS number, EDI location code, or AS2 identifier value). This page, as with the Trading Partner Details page shown in Figure 10–5 on page 10-8, enables you to delete or update a trading partner identification that you created. You cannot delete the default type of Name. Updating a Trading Partner Identification Follow these instructions to update trading partner identification that you created. A trading partner identification type called Name that is automatically provided for the host and remote trading partners cannot be updated. 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Select a specific trading partner identification to update in the Update column of the Trading Partner Identifications section. The Update Trading Partner Identification page appears. 4. Make appropriate changes. (See Step 4 on page 10-9 for a list of fields you can update.) 5. Click Apply. The trading partner identification is updated and the Trading Partner Identification Details page appears. Deleting a Trading Partner Identification Follow these instructions to delete trading partner identification that you created. A trading partner identification called Name that is automatically provided for the host and remote trading partners cannot be deleted. 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Select a specific trading partner identification to delete in the Delete column of the Trading Partner Identifications section. 4. Click Yes when prompted to delete trading partner identification. The trading partner identification is deleted and the Trading Partner Details page appears. Managing Trading Partner Agreements The OracleAS Integration B2B user interface enables you to perform the trading partner associated agreement management tasks shown in Figure 10–6. The associated agreement is the trading partner agreement of which the trading partner is a part. This agreement defines the behavior that trading partners agree to follow when engaging in a business transaction. 10-10 Oracle Application Server Integration B2B User’s Guide Managing Remote Trading Partner Certificates Figure 10–6 Trading Partner Associated Agreement Management Tasks Table 10–5 identifies the trading partner associated agreement management tasks shown in Figure 10–6 and provides references to procedures for performing these tasks. Table 10–5 Trading Partner Associated Agreement Management Tasks Page Elements Management Task See Section... Name column in Associated Agreements section of Figure 10–6 View the trading partner agreement with which a trading partner is associated "Viewing a Trading Partner Agreement" on page 12-8 Update column in Associated Agreements section of Figure 10–6 Update the trading partner agreement with which a trading partner is associated "Updating a Trading Partner Agreement" on page 12-8 Delete column in Associated Agreements section of Figure 10–6 Delete the trading partner agreement with which a trading partner is associated "Deleting a Trading Partner Agreement" on page 12-9 Note: The State column of the Associated Agreements section shown in Figure 10–6 displays the current state of the trading partner agreement. Managing Remote Trading Partner Certificates The OracleAS Integration B2B user interface enables you to perform the remote trading partner certificate management tasks shown in Figure 10–7. These tasks are described in detail in this section. A certificate securely binds an identity such as a trading partner to a public key. A certificate is created when a trading partner’s public key is signed by a trusted identity known as a certificate authority (CA). This certificate ensures that the trading partner's partner data is correct and that the public key actually belongs to that trading partner during business transactions. See Oracle Application Server Certificate Authority Administrator’s Guide for more information about CAs. Managing Trading Partners 10-11 Managing Remote Trading Partner Certificates The host trading partner does not use a certificate. Instead, the host trading partner uses a wallet password for security. Figure 10–7 Remote Trading Partner Certificate Management Tasks Note: The Create button in the Certificates section displays only for remote trading partners. Host trading partners create a wallet password and specify a directory location on the Trading Partner Details page of the host trading partner. Table 10–6 identifies the remote trading partner certificate management tasks shown in Figure 10–7 and provides references to procedures for performing these tasks. Table 10–6 Remote Trading Partner Certificate Management Tasks Page Elements Management Task See Section... Create button in Certificates section of Figure 10–7 Create a remote trading partner certificate "Creating a Remote Trading Partner Certificate" on page 10-13 Name column in Certificates section of Figure 10–7 View details about a remote trading partner certificate "Viewing a Remote Trading Partner Certificate" on page 10-13 Update column in Certificates section of Figure 10–7 Update a remote trading partner certificate "Updating a Remote Trading Partner Certificate" on page 10-14 Delete column in Certificates section of Figure 10–7 Delete a remote trading partner "Deleting a Remote Trading certificate Partner Certificate" on page 10-14 Note: The certificate file name displays in the Certificate Location column of the Certificates section. (See Figure 10–7.) 10-12 Oracle Application Server Integration B2B User’s Guide Managing Remote Trading Partner Certificates See "Managing the Host Trading Partner Wallet Password" on page 10-14 for instructions on managing the wallet password for the host trading partner. Creating a Remote Trading Partner Certificate Follow these instructions to create a remote trading partner certificate. You can then assign nonrepudiation and enable encryption to this certificate by clicking Partners, then Trading Partners, then trading_partner_name_in_the_Name_column, then Capabilities, then business_protocol_name_in_Name_column, and then Create Communication Capabilities. On the Delivery Channel page that appears, enable nonrepudiation of origin, nonrepudiation of receipt, or encryption. On the Document Exchange page that follows, select Use Existing in the Signing Credential section. The remote trading partner certificate created in this section appears in the Certificate list. The Create Trading Partner wizard also enables you to create and assign a certificate to a remote trading partner during a single wizard session. 1. Click Partners, then Trading Partners. 2. Select a specific remote trading partner in the Name column. 3. Click Create in the Certificates section. The Create Certificate page appears. 4. Enter the following details to create a remote trading partner certificate. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the remote trading partner certificate. Certificate File * Click Browse to select the remote trading partner certificate file. 5. Click Apply. The remote trading partner certificate is created and the new Certificate Details page appears. See "Page 4: Delivery Channel Page" on page 9-15 and "Page 5: Document Exchange Page" on page 9-17 for an alternative method of creating a remote trading partner certificate with the Create Trading Partner wizard. Viewing a Remote Trading Partner Certificate Follow these instructions to view details about a specific remote trading partner certificate: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Select a specific certificate to view in the Name column of the Certificates section. The Certificate Details page for the selected certificate appears. 4. View the certificate file name. This page, as with the Trading Partner Details page shown in Figure 10–7 on page 10-12, enables you to delete or update the selected certificate. 5. Click Return to List to return to the Trading Partner Details page. Managing Trading Partners 10-13 Managing the Host Trading Partner Wallet Password Updating a Remote Trading Partner Certificate Follow these instructions to update a remote trading partner certificate: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Select a specific certificate to update in the Update column of the Certificates section. The Update Certificate page appears. 4. Make appropriate changes. (See Step 4 on page 10-13 for a list of fields you can update.) Note that the Certificate File field is empty. You must upload the file again. 5. Click Apply. The remote trading partner certificate is updated and the Certificate Details page appears. Deleting a Remote Trading Partner Certificate Follow these instructions to delete a remote trading partner certificate. You cannot delete a remote trading partner certificate that you created in "Creating a Remote Trading Partner Certificate" on page 10-13 and assigned to a remote trading partner under Create Communication Capability. You must first delete the delivery channel associated with that document exchange. Then you can delete it. 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Select a specific remote trading partner certificate to delete in the Delete column of the Certificates section. 4. Click Yes when prompted to delete a remote trading partner certificate. The remote trading partner certificate is deleted and the Trading Partner Details page appears. Managing the Host Trading Partner Wallet Password The OracleAS Integration B2B user interface enables you to perform the host trading partner wallet password management tasks shown in Figure 10–8. These tasks are described in detail in this section. A wallet is a container in which certificates and trusted certificates are stored and managed. These data structures securely store a user private key, a user certificate, and a set of trusted certificates. A wallet password opens the user's wallet. When you create or update the wallet password on a previously validated Trading Partner Details page (that is, the State section displays as Approved), the state reverts to Draft and the Validate button reappears. You must revalidate the host trading partner by clicking Validate. A remote trading partner does not use a wallet password. Instead, the remote trading partner uses a remote certificate for security. 10-14 Oracle Application Server Integration B2B User’s Guide Managing the Host Trading Partner Wallet Password Figure 10–8 Host Trading Partner Wallet Password Management Tasks Table 10–7 identifies the host trading partner wallet password management tasks shown in Figure 10–8 and provides references to procedures for performing these tasks. Table 10–7 Host Trading Partner Wallet Password Management Tasks Page Elements Management Task See Section... Create button to the right of Wallet Password in the Details section of Figure 10–8 Create a wallet password "Creating a Host Trading Partner Wallet Password" on page 10-15 Update button of Figure 10–8 Update a wallet password "Updating a Host Trading Partner Wallet Password" on page 10-16 Note: This button displays to the right of Wallet Password in the Details section only after the wallet password has been created. See "Managing Remote Trading Partner Certificates" on page 10-11 for instructions on managing the certificate for the remote trading partner. Creating a Host Trading Partner Wallet Password An Oracle Wallet is automatically created during installation in Oracle_ Home/Apache/Apache/conf/ssl.wlt/default/ewallet.p12 on your Oracle Application Server middle tier. The initial password is welcome. Perform the following tasks in Oracle Wallet Manager: ■ Change the initial password ■ Export the Oracle Wallet ■ Name the file ora_wallet.txt After that, you can create a host trading partner wallet password on the Trading Partner Details page of the host trading partner. This password must match the Oracle Managing Trading Partners 10-15 Managing the Host Trading Partner Wallet Password Wallet password. Follow these instructions to create a host trading partner wallet password: 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. The host trading partner is identified by the word (Host). 3. Click Create to the right of Wallet Password in the Details section. The Create Host Wallet Password page appears. 4. Enter the following details to create a wallet password. An asterisk (*) indicates a required field. Field Value New Wallet Password Enter the same wallet password that you created in Oracle Wallet Manager. Confirm New Password Enter the same wallet password a second time. 5. Click Apply. The password is stored in encrypted format. The Create button to the right of Wallet Password in the Details section now always displays as the Update button. 6. Go to Oracle Enterprise Manager 10g Application Server Control Console and specify the directory for the wallet location with the OracleAS Integration B2B Wallet Location configuration parameter (for example, Oracle_ Home/Apache/Apache/conf/ssl.wlt/default/ora_wallet.txt). See the following for more information: ■ ■ "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 for instructions on changing configuration parameters such as Wallet Location Oracle Application Server Security Guide for instructions on using Oracle Wallet Manager Updating a Host Trading Partner Wallet Password If you later update the wallet password in Oracle Wallet Manager, you must also update the password with the same value in the OracleAS Integration B2B user interface. Follow these instructions to update a host trading partner wallet password: Note: You cannot update the wallet password in the OracleAS Integration B2B user interface without first updating it in Oracle Wallet Manager. 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. 3. Click Update to the right of Wallet Password in the Details section. The Update Host Wallet Password page appears. 4. Make appropriate changes. (See Step 4 of "Creating a Host Trading Partner Wallet Password" on page 10-16 for a list of fields that you can update.) Ensure that the password matches the one you first specified in Oracle Wallet Manager. 10-16 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Contact Information for Persons and Organizations 5. Click Apply. The host trading partner wallet password is updated and the Trading Partner Details page appears. Managing Trading Partner Contact Information for Persons and Organizations The OracleAS Integration B2B user interface enables you to perform the person and organization contact information management tasks shown in Figure 10–9. These tasks are described in detail in this section. Contact information is the method by which to contact a user or organization (such as an e-mail address or phone number). Figure 10–9 Person and Organization Contact Information Management Tasks Table 10–8 identifies the person and organization contact information management tasks shown in Figure 10–9 and provides references to procedures for performing these tasks. Table 10–8 Person and Organization Contact Information Management Tasks Page Elements Management Task See Section... Create button of Contact Information section of Figure 10–9 Create contact information for a person or organization "Creating Contact Information for a Trading Partner Person or Organization" on page 10-18 Contact Type column of Contact Information section of Figure 10–9 View details about contact information for a person or organization "Viewing Contact Information for a Trading Partner Person or Organization" on page 10-18 Contact Type column of Contact Information section of Figure 10–9 (to access the page to update contact information for a person or organization) Update contact information for "Updating Contact a person or organization Information for a Trading Partner Person or Organization" on page 10-19 Contact Type column of Contact Information section of Figure 10–9 (to access the page to delete contact information for a person or organization) Delete contact information for a person or organization "Deleting Contact Information for a Trading Partner Person or Organization" on page 10-20 Note: The contact information value (for example, an e-mail address) displays in the Value column of the Contact Information section. (See Figure 10–9.) Managing Trading Partners 10-17 Managing Trading Partner Contact Information for Persons and Organizations Creating Contact Information for a Trading Partner Person or Organization Follow these instructions to create contact information for a specific trading partner person or organization: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Perform the following steps based on the type of contact information to create: To Create Contact Information For... Perform These Steps... A person 1. Click Users at the top of the Trading Partner Details page. 2. Select a specific person in the Name column of the People section. 3. Click Create in the Contact Information section. 1. Click Organization at the top of the Trading Partner Details page. 2. Click Create in the Contact Information section. An organization The Create Contact Information page appears. 4. Enter the following details to create person or organization contact details. An asterisk (*) indicates a required field. Field Value Contact Type * Select one of the automatically available contact types (Contact Name, Email, Fax, or Phone) Value Enter a value for the selected contact type. For example, if you select Phone as the contact type, enter a phone number in this field. Note: Contact type creation does not cause a person to be automatically contacted when a specific condition occurs, such as the need to review a trading partner agreement. You must manually contact a person through the selected contact type method. 5. Click Apply. The Contact Information Details page appears. Viewing Contact Information for a Trading Partner Person or Organization Follow these instructions to view details about contact information for a specific trading partner person or organization: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Perform the following steps based on the type of contact information to view: 10-18 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Contact Information for Persons and Organizations To View Contact Information For... Perform These Steps... A person 1. Click Users at the top of the Trading Partner Details page. 2. Select a specific person for which to view contact information in the Name column of the People section. 3. Click a specific contact type in the Contact Type column of the Contact Information section. 1. Click Organization at the top of the Trading Partner Details page. 2. Click a specific contact type in the Contact Type column of the Contact Information section. An organization The Contact Information Details page appears. 4. View specific details about the contact type and method for contacting the person. 5. Click Return to List. Updating Contact Information for a Trading Partner Person or Organization Follow these instructions to update contact information for a specific trading partner person or organization: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Perform the following steps based on the type of contact information to update: To Update Contact Information For... Perform These Steps... A person 1. Click Users at the top of the Trading Partner Details page. 2. Select a specific person for which to update contact information in the Name column of the People section. 3. Select the contact information to update in the Contact Type column of the Contact Information section. 4. Click Update on the Contact Information Details page. 1. Click Organization at the top of the Trading Partner Details page. 2. Select the contact information to update in the Contact Type column of the Contact Information section. 3. Click Update on the Contact Information Details page. An organization The Update Contact Information page appears. 4. Make appropriate changes to the contact type (for example, Contact Name, E-mail, Fax, or Phone) or value. Managing Trading Partners 10-19 Managing Trading Partner Persons 5. Click Apply. The contact information is updated and the Contact Information Details page appears. Deleting Contact Information for a Trading Partner Person or Organization Follow these instructions to delete contact information for a specific trading partner person or organization: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Perform the following steps based on the type of contact information to update: To Delete Contact Information For... Perform These Steps... A person 1. Click Users at the top of the Trading Partner Details page. 2. Select a specific person for which to delete contact information in the Name column of the People section. 3. Select the contact information to delete in the Contact Type column of the Contact Information section. 4. Click Delete on the Contact Information Details page. 1. Click Organization at the top of the Trading Partner Details page. 2. Select the contact information to delete in the Contact Type column of the Contact Information section. 3. Click Delete on the Contact Information Details page. An organization 4. Click Yes when prompted to delete the contact information. 5. Click Apply. The contact information is deleted. Managing Trading Partner Persons The OracleAS Integration B2B user interface enables you to perform the person management tasks shown in Figure 10–10. These tasks are described in detail in this section. A person can be an OracleAS Integration B2B user interface user or a reviewer of trading partner and trading partner agreement details. Figure 10–10 Person Management Tasks You can create two person types in the People section: 10-20 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Persons ■ Host trading partner person (if you select the host trading partner) ■ Remote trading partner person (if you select a remote trading partner) These two person types have different capabilities, as shown in Table 10–9. Table 10–9 Person Capabilities Capability Host Trading Remote Trading Partner Person Partner Person Use the OracleAS Integration B2B user interface to: Yes No Can add user roles and use cases (privileges) to the person Yes type No ■ Manage (create, view, update, and delete) partner data ■ Deploy and administer a configuration ■ Create reports Note: The Administrator role must be assigned to a host trading partner person before they can use the OracleAS Integration B2B user interface. This role provides the user with access to the functionality of the entire user interface. The Reports role can be assigned to users who require access to only the functionality of the Reports tab of the user interface. A person created for a remote trading partner cannot use the OracleAS Integration B2B user interface. Table 10–10 identifies the person management tasks shown in Figure 10–10 and provides references to procedures for performing these tasks. Table 10–10 Person Management Tasks Page Elements Management Task See Section... Create button in People section Create a person for a trading of Figure 10–10 partner "Creating a Trading Partner Person" on page 10-22 Name column in People section View details about a person of of Figure 10–10 a trading partner and update the person password "Viewing a Trading Partner Person and Updating the Person Password" on page 10-22 Update column in People section of Figure 10–10 Update a person of a trading partner "Updating a Trading Partner Person" on page 10-23 Delete column in People section of Figure 10–10 Delete a person of a trading partner "Deleting a Trading Partner Person" on page 10-23 Name column in People section Assign a user role to a host of Figure 10–10 (to access the trading partner person page to assign a user role) "Assigning a User Role to a Host Trading Partner Person" on page 10-24 Name column in People section Remove a user role from a host "Removing a User Role of Figure 10–10 (to access the trading partner person from a Host Trading page to remove a user role) Partner Person" on page 10-24 Name column in People section View user roles and use case of Figure 10–10 (to access the groups page to view user roles and use case groups) "Viewing User Roles and Use Case Group Details" on page 10-25 Managing Trading Partners 10-21 Managing Trading Partner Persons Creating a Trading Partner Person Follow these instructions to create a trading partner person. This person can be a reviewer of trading partner agreement details. If this person is created for the host trading partner, they can also use the OracleAS Integration B2B user interface. 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the selected trading partner appears. 4. Click Create in the People section. 5. Enter the following details to create a trading partner person. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable person name. Password * Enter a password. Note: If you are creating a remote trading partner person, then you can ignore this field. If you are creating a host trading partner person, enter a password if you want to later add the following user roles: ■ ■ Description 6. The Administrator role for persons requiring access to the functionality of the entire OracleAS Integration B2B user interface The Reports role for persons (such as business analysts) requiring access to the functionality of only the Reports tab of the user interface Provide an optional description. Click Apply. The trading partner person is created and the Person Details page appears. At this point, this person cannot use the OracleAS Integration B2B user interface. They must now be assigned a user role. 7. Click Return to List to return to the Users page. See the following for more information: ■ Table 10–9 on page 10-21 for the capabilities of this person ■ "Assigning a User Role to a Host Trading Partner Person" on page 10-24 Viewing a Trading Partner Person and Updating the Person Password Follow these instructions to view details about a specific trading partner person and update the person password of a host trading partner: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the selected trading partner appears. 4. Select a specific trading partner person to view in the Name column of the People section. The Person Details page for the selected trading partner person appears. 10-22 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Persons 5. View specific details, including the method for contacting the person (for example, an e-mail address). 6. If you want to update the trading partner person password, click Update in the Details section. The Update Person Password page appears. 7. Enter the following details to update a person password. Field Value New Password Enter a new password. Confirm New Password Enter the new password a second time. 8. Click Apply. The Person Details page appears. 9. Click Return to List to return to the Users page. Updating a Trading Partner Person Follow these instructions to update a trading partner person: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the selected trading partner appears. 4. Select a specific trading partner person to update in the Update column of the People section. The Update Person page appears. 5. Make appropriate changes to the name or description. 6. Click Apply. The trading partner person is updated and the Person Details page appears. Deleting a Trading Partner Person Follow these instructions to delete a trading partner person: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the selected trading partner appears. 4. Select a specific trading partner person to delete in the Delete column of the People section. 5. Click Yes when prompted to delete a trading partner person. The trading partner person is deleted and the Trading Partner Details page appears. Managing Trading Partners 10-23 Managing Trading Partner Persons Assigning a User Role to a Host Trading Partner Person You can add a user role to a host trading partner person, but not to a remote trading partner person. A user role is the group of related use cases (privileges) that permit a person to connect to and perform tasks with the OracleAS Integration B2B user interface. Follow these instructions to add a user role to a person: 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the host trading partner appears. 4. Select a specific person in the Name column. The Person Details page appears. 5. Click Add in the User Roles section to add a user role to the host trading partner person. The Create User Role Enrollment page appears. 6. Select one of the following roles from the User Role list: ■ ■ 7. The Administrator role for persons requiring access to the functionality of the entire OracleAS Integration B2B user interface (that is, the Partners, Deployment, Reports, and Administration tabs) The Reports role for persons (such as business analysts) requiring access to only the functionality of the Reports tab of the OracleAS Integration B2B user interface Click Apply. The user role is added and the Person Details page appears. If the person does not have a password, you receive an error and the user role is not added. 8. Click Apply. The Person Details page appears. See "Viewing a Trading Partner Person and Updating the Person Password" on page 10-22 if you need to add a password to the host trading partner person. Removing a User Role from a Host Trading Partner Person You can remove a user role from a host trading partner person that you created, but not from a remote trading partner person (they have none). You cannot remove the Administrator role from the default host trading partner user of admin. Follow these instructions to remove a user role from a person: Caution: If you remove a user role from a host trading partner person that you created, that person no longer has privileges to use the OracleAS Integration B2B user interface. 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the host trading partner appears. 10-24 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Business Protocols 4. Select a specific person in the Name column. The Person Details page appears. 5. Select a user role to remove in the Remove column of the User Roles section. 6. Click Yes when prompted to remove the user role. The user role is removed and the Person Details page appears. Viewing User Roles and Use Case Group Details User roles consist of use case groups that include the use cases (privileges) that permit a person to perform tasks with the OracleAS Integration B2B user interface. Note: You cannot create, delete, or update user roles or use case groups. Follow these instructions to view the user role and its associated use case group details: 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. 3. Click Users at the top of the Trading Partner Details page. The Users page for the host trading partner appears. 4. Select a specific person in the Name column. The Person Details page appears. 5. Select the Administrator or Reports role in the Name column of the User Roles section. The User Role Details page appears. 6. View specific details, including a description of the user role, the state of the role, and the use case group of the role. 7. Click the use case group in the Name column of the Use Case Groups section. 8. View the specific use cases assigned to the use case group of the role. 9. Click Return to List to return to the User Role Details page. 10. Click Return to List to return to the Person Details page. Managing Trading Partner Business Protocols The OracleAS Integration B2B user interface enables you to perform the business protocol management tasks shown in Figure 10–11 and Figure 10–12. These tasks are described in detail in this section. The business protocol identifies the implementation guidelines for the reliable transport of business document messages between trading partners. Each trading partner must have support for a business protocol with operational and communication capabilities. A business protocol consists of the following three protocols: ■ Document protocol Managing Trading Partners 10-25 Managing Trading Partner Business Protocols Defines the document types of the message payload. Document protocols are defined as part of the operational capabilities of the business protocol in the OracleAS Integration B2B user interface ■ Exchange protocol Defines the message exchange mechanism—how to exchange the documents defined by the document protocol. It defines the headers, the acknowledgments, and the packaging that puts the headers and payload together. ■ Process protocol Defines how documents are exchanged. Process protocols are defined as part of the operational capabilities of the business protocol in the OracleAS Integration B2B user interface. OracleAS Integration B2B includes a single process protocol called the B2B process. The process protocol consists of support for collaborations (for the RosettaNet over RNIF business protocol) or business actions (for any EDI or Custom Document business protocol). Figure 10–11 shows a business protocol for a remote trading partner (RosettaNet over RNIF in this example). You must use the OracleAS Integration B2B user interface to assign support for a business protocol to a remote trading partner. Figure 10–11 Business Protocol Management Tasks (Remote Trading Partner) Figure 10–12 shows the business protocols for the host trading partner. Support for all business protocols in the OracleAS Integration B2B user interface is automatically assigned to the host trading partner. These business protocols cannot be removed. Figure 10–12 Business Protocol Management Tasks (Host Trading Partner) 10-26 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Business Protocols Table 10–11 identifies the business protocol management tasks shown in Figure 10–11 and Figure 10–12 and provides references to procedures for performing these tasks. Table 10–11 Business Protocol Management Tasks Page Elements Management Task See Section... Add button in Figure 10–11 (for Add a business protocol to a remote trading partners) remote trading partner "Assigning a Business Protocol" on page 10-27 Note: The host trading partner is automatically assigned support for all business protocols. (See Figure 10–12.) Name column of Figure 10–11 or Figure 10–12 View details about a business protocol "Viewing a Business Protocol" on page 10-28 Exchange Protocol column of Figure 10–11 or Figure 10–12 View details about the exchange protocol of a business protocol "Viewing an Exchange Protocol" on page 10-28 Document Protocol column of Figure 10–11 or Figure 10–12 View details about the document protocol of a business protocol "Viewing a Document Protocol" on page 10-29 Remove column of Figure 10–11 Remove support for a business protocol from a remote trading partner "Removing a Business Protocol from a Remote Trading Partner" on page 10-30 View details about the process protocol of a business protocol "Viewing a Process Protocol" on page 10-29 Note: The business protocol supported by the host trading partner cannot be removed. (See Figure 10–12.) Name column of Figure 10–11 or Figure 10–12 (for accessing a page to select the B2B process protocol) Assigning a Business Protocol The procedural tasks to follow to assign a business protocol are different for a remote or host trading partner. The remote trading partner assigns support for a business protocol either during or separate from a session of the Create Trading Partner wizard. The host trading partner is automatically assigned support for all business protocols. Table 10–12 identifies each task and provides references to procedures for performing these tasks. Table 10–12 Adding a Business Protocol to Remote and Host Trading Partners Task See Section... For Remote Trading Partners: ■ ■ Create the trading partner and assign support for the business protocol and all its operational and communication capabilities during a single Create Trading Partner wizard session "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 Add the business protocol during a separate Create Trading Partner wizard session "Creating and Defining All Capabilities During Separate Wizard Sessions" on page 9-23 Note: You can assign multiple business protocols to a remote trading partner. For the Host Trading Partner: The host trading partner is automatically assigned support for all business protocols, as shown in Figure 10–12. Chapter 9, "Creating Trading Partners" Managing Trading Partners 10-27 Managing Trading Partner Business Protocols Viewing a Business Protocol Follow these instructions to view details about a specific business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol to view in the Name column. The Business Protocol Details page for the selected business protocol appears. 5. View specific details, including the associated document, exchange, and process protocols listed in the Details section near the top. In addition, the following sections display on this page. (See Figure 10–15 on page 10-43 for an example.) Section Operational Capabilities Subsection ■ ■ Communication Capabilities 6. Supported Collaborations (for the RosettaNet over RNIF business protocol) Supported Business Actions (for any EDI or Custom Document business protocols) See Section... ■ ■ ■ Delivery Channels ■ ■ Document Exchanges ■ ■ Transports ■ ■ Transport Servers ■ ■ Endpoints ■ "Managing Business Protocol Collaborations" on page 10-43 "Managing Business Protocol Business Actions" on page 10-46 "Managing Business Protocol Delivery Channels" on page 10-49 "Managing Business Protocol Document Exchanges" on page 10-52 "Managing Business Protocol Transports" on page 10-55 "Managing Business Protocol Transport Servers" on page 10-58 "Managing Business Protocol Endpoints" on page 10-61 Click Return to List to return to the Capabilities page. Viewing an Exchange Protocol Follow these instructions to view details about a specific exchange protocol of a business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific exchange protocol to view in the Exchange Protocol column. The Exchange Protocol Details page for the selected exchange protocol appears. 10-28 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Business Protocols 5. View specific details about the following: ■ ■ ■ ■ 6. The Business Signals section shows the exception messages and the acknowledgment signals to exchange to confirm receipt of messages. The Supported Transport Protocols section shows the supported transports for this version. The Supported Security Specifications section shows the supported signing and encryption features. The Parameters section shows the supported parameters for this version. Click Return to List to go to the Business Protocol Details page. See "Viewing Exchange Protocols" on page 8-18 for more information. Viewing a Document Protocol Follow these instructions to view details about a specific document protocol of a business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific document protocol to view in the Document Protocol column. The Document Protocol Details page for the selected document protocol appears. 5. View specific details about a document protocol revision. You can manage (view, update, and delete) the revision from this page (unless it is RosettaNet, which can only be viewed). 6. Click Return to List to return to the Business Protocol Details page. See "Viewing a Document Protocol Revision" on page 8-9 for more information. Viewing a Process Protocol OracleAS Integration B2B includes a single process protocol called the B2B process. Follow these instructions to view details about the B2B process: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Click B2B to the right of Process Protocol in the Details section. The Process Protocol Details page for the selected process protocol appears. 6. View specific details about process protocol revisions and supported document protocols. 7. Click the process protocol revision in the Details column. The Process Protocol Revision Details page appears. Managing Trading Partners 10-29 Managing Internal Delivery Channels 8. View specific details about support for collaborations (if the RosettaNet over RNIF business protocol is selected) or business actions (if any EDI or Custom Document business protocol is selected) associated with this process protocol. 9. Click Return to List to return to the Business Protocol Details page. See "Managing Process Protocols" on page 8-19 for more information. Removing a Business Protocol from a Remote Trading Partner Follow these instructions to remove a business protocol from a remote trading partner: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol to remove in the Remove column. 5. Click Yes when prompted to remove a business protocol. The business protocol is removed and the Business Protocol Details page appears. Managing Internal Delivery Channels The host application of the trading partner is the ultimate source and destination for sending and receiving messages. The OracleAS Integration B2B user interface enables you to create an internal delivery channel for the host application of the host trading partner. This internal delivery channel provides the communication interface between the host application and OracleAS Integration B2B (See Figure 10–13). You select an internal delivery channel for the host trading partner when you create a trading partner agreement. The internal delivery channel operates only within the enterprise of the host trading partner, and differs from the "external" delivery channel that enables host and remote trading partners in different enterprises to communicate. The OracleAS Integration B2B user interface enables you to perform the internal delivery channel management tasks shown in Figure 10–14. These tasks are described in detail in this section. OracleAS Integration B2B provides four predefined internal delivery channels for use with Oracle Application Server Integration InterConnect and Oracle E-Business Suite: ■ B2B Inbound For integrations with host applications using the IP_MESSAGE_TYPE message structure. This channel enables communication between the host application using this message structure and OracleAS Integration B2B upon receipt of inbound messages from a remote trading partner. This channel is automatically associated with the b2b.IP_IN_QUEUE internal endpoint. ■ B2B Outbound For integrations with host applications using the IP_MESSAGE_TYPE message structure. This channel enables communication between the host application using this message structure and OracleAS Integration B2B to send outbound messages to a remote trading partner. This channel is automatically associated with the b2b.IP_OUT_QUEUE internal endpoint. ■ XML Gateway Inbound 10-30 Oracle Application Server Integration B2B User’s Guide Managing Internal Delivery Channels For integrations with Oracle E-Business Suite applications. This channel enables communication between the host application and OracleAS Integration B2B upon receipt of inbound messages from a remote trading partner. This channel is automatically associated with the apps.ECX_INBOUND internal endpoint. ■ XML Gateway Outbound For integrations with Oracle E-Business Suite applications. This channel enables communication between the host application and OracleAS Integration B2B to send outbound messages to a remote trading partner. This channel is automatically associated with the apps.ECX_OUTBOUND internal endpoint. You can also create your own internal delivery channels to use with the host trading partner host application, including separate internal delivery channels for sending and responding (acknowledgment) messages. An example of this is an environment in which your business transaction with a remote trading partner requires an acknowledgment (for example, RosettaNet Partner Interface Process (PIP) 3A4), and you want to use two separate internal delivery channels for these messages (one for inbound and the other for outbound). When you create a trading partner, select Yes from the Is acknowledgement handled By Integration B2B? list on the Create Trading Partner - Operational Capability page or Create Supported Collaboration Role page. When you create a trading partner agreement for the business protocol of this trading partner, you can select both internal delivery channels. Figure 10–13 provides an example of a host application that includes two internal delivery channels: ■ ■ The outbound internal delivery channel sends a purchase order request to a remote trading partner The inbound internal delivery channel receives a purchase order acknowledgment from a remote trading partner Figure 10–13 Internal Delivery Channel Internal Delivery Channel (purchase order request in outbound direction) Host Application Host Trading Partner Internet Remote Trading Partner Responding Internal Delivery Channel (purchase order acknowledgement in inbound direction) Managing Trading Partners 10-31 Managing Internal Delivery Channels Figure 10–14 Internal Delivery Channel Management Tasks Note: Do not update any parameters available under the Transport Parameter column in Figure 10–14. If you must update the XML Gateway Inbound or Outbound internal delivery channel endpoint names, click Partners, then Trading Partners, then host_trading_ partner_name_in_the_Name_column, then Capabilities, and then business_protocol_name_in_Name_column. Then, click Update in the Endpoints section for the internal delivery channel endpoint to update. Table 10–13 identifies the internal delivery channel management tasks shown in Figure 10–14 and provides references to procedures for performing these tasks. Table 10–13 Internal Delivery Channel Management Tasks Page Elements Management Task See Section... Create button in Internal Delivery Channels section of Figure 10–14 Create an internal delivery channel "Creating an Internal Delivery Channel" on page 10-33 Transport Parameter column in Internal Delivery Channels section of Figure 10–14 View details about a transport used with an internal delivery channel. Do not update any transport parameters on this page or any pages available under it. These pages are for viewing only. "Viewing a Business Protocol Transport" on page 10-57 Transport Server column in Internal Delivery Channels section of Figure 10–14 View details about a transport server used with an internal delivery channel. "Viewing a Business Protocol Transport Server" on page 10-60 "Example: Creating an Internal Delivery Channel Using the JMS Transport Protocol" on page 10-37 10-32 Oracle Application Server Integration B2B User’s Guide Managing Internal Delivery Channels Table 10–13 (Cont.) Internal Delivery Channel Management Tasks Page Elements Management Task See Section... Delete column in Internal Delivery Channels section of Figure 10–14 Delete an internal delivery channel that you created. "Deleting an Internal Delivery Channel" on page 10-42 Note: The Is Inbound column describes the direction in which the internal delivery channel communicates. The direction is always from the perspective of the host trading partner. If the host initiates a business transaction with a remote trading partner, the direction is outbound. If the host is the recipient of a business transaction initiated by a remote trading partner, the direction is inbound. See the following for more information: ■ ■ ■ Table 4–1, " IP_MESSAGE_TYPE Parameters" on page 4-3 for information about the IP_MESSAGE_TYPE message structure Chapter 9, "Creating Trading Partners" for instructions on selecting Yes from the Is acknowledgement handled By Integration B2B? list on the Create Trading Partner - Operational Capability page or Create Supported Collaboration Role page "Creating a Trading Partner Agreement" on page 12-5 for instructions on assigning an internal delivery channel to the host trading partner in a trading partner agreement Creating an Internal Delivery Channel Follow these instructions to create an internal delivery channel: ■ Page 1: General Page ■ Page 2: Transport Page ■ Page 3: Review Page Note: You cannot update an internal delivery channel. Page 1: General Page 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the host trading partner appears. 4. Click Create in the Internal Delivery Channels section. The Create Internal Delivery Channel - General page appears. 5. Enter the following details. An asterisk (*) indicates a required field. Managing Trading Partners 10-33 Managing Internal Delivery Channels Field Value Name * Enter a unique and recognizable name for the internal delivery channel. Is Inbound * Select Yes if the internal delivery channel is used for receiving an inbound message sent to OracleAS Integration B2B from a remote trading partner. Otherwise, select No for outbound messages sent from OracleAS Integration B2B to a remote trading partner. 6. Click Next. The Create Internal Delivery Channel - Transport page appears. Page 2: Transport Page 1. Select Create New or Use Existing. 2. Go to the following section based on your selection: If You Selected... Go To... Create New "Creating a New Transport" on page 10-34 Use Existing "Using an Existing Transport" on page 10-36 Creating a New Transport Follow these instructions to create a new transport for the internal delivery channel. 1. Enter a unique and recognizable name for the transport in the Name field. 2. Select the transport protocol to use from the Transport Protocol list. Selection Description AQ Enables applications to communicate asynchronously with OracleAS Integration B2B over a reliable, scalable, and secure communication channel. Oracle advanced queuing (AQ) provides an extremely flexible mechanism for bidirectional, asynchronous communication. Application location is transparent, using any number of Oracle's connectivity options, including OCI, JDBC, or PL/SQL. Both XML and non-XML message payloads are supported. JMS Enables applications to send and receive messages to and from the queues and topics administered by any Java Message Service (JMS) provider; the Oracle JMS (OJMS) and MQSeries JMS (IBM) providers can be used with OracleAS Integration B2B. File Enables files to be copied between applications. FTP Enables files to be passed with FTP between applications. The page refreshes based on your selection. 3. Select Use Existing or Create New in the Transport Server section. 4. Go to the following step based on your selection: If You Selected... Go To... Create New Step 5 on page 10-35 Use Existing Step 6 on page 10-36 10-34 Oracle Application Server Integration B2B User’s Guide Managing Internal Delivery Channels 5. If you selected Create New in Step 4, perform Steps 5a through 5c. a. Enter the following transport server details for the internal delivery channel. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the transport server. Description Enter a description for the transport server. Host Name * Enter the hostname of the transport server. Note: If using a generic exchange protocol (EDI X12 over Generic Exchange, EDI EDIFACT over Generic Exchange, or Custom Document over Generic Exchange) with the HTTP or HTTPS transport protocol, enter the IP address to use for identifying trading partners. Do not enter the hostname. IP Address Enter the IP address of the transport server. Username Enter the username for logging into the transport server. Password Enter the password of the username. b. Enter appropriate transport parameter values in the Current Value column of the Parameters section. If you select File or FTP, other parameters appear. Transport Protocol Field Value AQ Hostname Enter the name of the host on which the application database is installed. Port Enter the application database port number. SID Enter the application database system identifier (SID). Consumer Enter the consumer queue name. The name can be from 1 to 30 characters in length. The application that writes to the queue uses a consumer name to indicate that OracleAS Integration B2B must pick up a message. Leave this field blank if the queues AQ connects to on the application database side are single consumer queues. If any of the queues are multiconsumer queues, specify a consumer name. Recipient Enter the recipient queue name. The name can be from 1 to 30 characters in length. The application that writes to the queue uses a recipient name to indicate that OracleAS Integration B2B sent a message. Leave this field blank if the queues AQ connects to on the application database side are single recipient queues. If any of the queues are multirecipient queues, specify a recipient name. Polling Interval JMS Enter the time interval in milliseconds during which OracleAS Integration B2B polls the server for inbound messages. Connection Factory Enter the JNDI location or Java class name for the Location connection factory. Factory Provider Properties Enter the JMS vendor-specific properties to pass to the connection factory. Managing Trading Partners 10-35 Managing Internal Delivery Channels Transport Protocol Field Value Destination Enter the JMS vendor-specific properties to pass to Provider Properties the destination. c. 6. 7. isTopic Enter False or True to indicate if JMS is communicating with a topic. The JMS can communicate with either a topic or a queue. Subscriber ID Enter the subscriber ID. This is required if JMS is communicating with a topic. Polling Interval Enter the time interval in milliseconds during which OracleAS Integration B2B polls the server for inbound messages. Go to Step 7. If you selected Use Existing in Step 4, perform Steps 6a through 6b. a. Select a transport server from the Transport Server list. Note that all delivery channels appear in this list. Do not select any delivery channels used for communication between host and remote trading partners. Only delivery channels that enable communication between the host application and the host trading partner can be selected. Of the predefined internal delivery channels that appear, only XML Gateway Inbound and XML Gateway Outbound can be customized. B2B Inbound and B2B Outbound cannot be customized. b. Go to Step 7. Enter the following endpoint details. An asterisk (*) indicates a required field. Field Value URI * (default name) Select either of the following: ■ ■ 8. Create New to enter a new endpoint in the URI field. Use Existing to refresh the page and display the Endpoint list for selecting an existing URI. Click Next. The Create Internal Delivery Channel: Review page appears and displays details about the type of internal delivery channel to create. 9. Go to "Page 3: Review Page" on page 10-37. Using an Existing Transport Follow these instructions to use an existing transport. 1. 2. Make a selection from the Transport Parameter list. See "Managing Internal Delivery Channels" on page 10-30 for definitions of the predefined channels. ■ B2B Inbound ■ B2B Outbound ■ XML Gateway Inbound ■ XML Gateway Outbound ■ Internal delivery channels you previously created Click Next. 10-36 Oracle Application Server Integration B2B User’s Guide Managing Internal Delivery Channels The Create Internal Delivery Channel: Review page appears and displays details about the type of internal delivery channel to create. 3. Go to "Page 3: Review Page" on page 10-37. Page 3: Review Page 1. Review the internal delivery channel details. ■ ■ To modify these details, click the Back button of the Create Internal Delivery Channel wizard to return to the previous pages. When you complete modifications, click Next until you access the review page; then click Finish. Do not use the Back and Forward buttons of your Web browser. If you are satisfied with these details, click Finish. The internal delivery channel is created and the Capabilities page of the host trading partner appears. The internal delivery channel can now be selected when you create a trading partner agreement. Example: Creating an Internal Delivery Channel Using the JMS Transport Protocol This section provides an example of creating an internal delivery channel using the transport protocol. Note: Sample scripts to create JMS queues and send and receive sample JMS messages are located in Oracle_ Home/tip/adapter/b2b/transport/test/jms. 1. Open the Oracle_Home/home/config/application.xmlfile. 2. Define the resource provider by adding the following lines immediately before the </orion-application tag. For example: <resource-provider class="oracle.jms.OjmsContext" name="JMS_b2b"> <description>OJMS Context using thin JDBC</description> <property name="url" value="jdbc:oracle:thin:sunbox2005:1521:b2bdev" /> <property name="username" value="b2b" /> <property name="password" value="b2b" /> </resource-provider> Where... Is... Hostname sunbox2005 Note: This is the host on which the database with OJMS is installed. Port 1521 SID b2bdev Username b2b Password b2b 3. Enter values appropriate to your environment. 4. If Oracle Application Server Java Authentication and Authorization Service (JAAS) Provider (JAZN) security is activated in the application.xml file, disable the following line with comment markers: Managing Trading Partners 10-37 Managing Internal Delivery Channels <!-- jazn.provider="XML" location="./jazn-data.xml"/ --> 5. Open the Oracle_Home/home/config/principals.xml file. 6. Activate the admin user by removing deactiviated="true" from the end of the following line. <user username="admin" password="welcome"> 7. Disable the following line with comment markers: <!-- server host="myhost" port="1089" username="admin" password="welcome" /--> 8. Identify the remote method invocation (RMI) port value in the Oracle_ Home/home/config/rmi.xml file. This value is required for the java.naming.provider.url value in the Destination Provider Properties field of Step 10c. 9. Place the application-client.xml file in the classes/META-INF/ directory. The application-client.xml file must be empty between the start and end tags: <application-client> </application-client> 10. Create an internal delivery channel in the OracleAS Integration B2B user interface. Note: Specific examples are provided for some of the fields of the Create Internal Delivery Channel wizard. You must also provide appropriate values for other fields. a. Select JMS from the Transport Protocol list. b. Enter the following endpoint details in the Transport Server section: Field Value Example Username This value maps to the jms.sender.destination_username property b2b Password This value maps to the jms.sender.destination_password property b2b c. Enter appropriate transport parameter values in the Current Value column of the Parameters section. Field Value Example Connection Factory Location This value maps to jms.sender.jndi_connection_ factory_location java:comp/resource/JMS_ b2b/QueueConnectionFactories/qcf Factory Provider Properties This value maps to jms.sender.factory_provider_ properties java.naming.factory.initial= com.evermind.server.rmi.RMIInitial ContextFactory;java.naming.securit y.credentials=welcome; java.naming.security.principal= admin;java.naming.provider.url= opmn:ormi://144.25.141.184:6004 10-38 Oracle Application Server Integration B2B User’s Guide Managing Internal Delivery Channels Field Value Example Destination Provider Properties This value maps to jms.sender.destination_ provider_properties java.naming.factory.initial= com.evermind.server.rmi.RMIInitial ContextFactory;java.naming.securit y.credentials=welcome; java.naming.security.principal= admin;java.naming.provider.url= opmn:ormi://144.25.141.184:6004 In the case of the Factory Provider Properties field, specify the java.naming.provider.url value based on the OC4J status: If OC4J Is a... Then... Standalone installation The value takes the form: Middle-tier installation The value takes the form: d. ormi://myhost:1089, where 1089 is the RMI port in the rmi.xml file. opmn:ormi://myhost:6004, where 6004 is the request port defined in Oracle_Home/opmn/conf/opmn.xml. Enter the name of the destination location in the URI field of the Endpoints section. This maps to the jms.sender.jndi_destination_location property. For example: java:comp/resource/JMS_b2b/Queues/B2B_JMS_INQUEUE where JMS_b2b is the resource provider defined in application.xml and B2B_JMS_INQUEUE is the name of the JMS queue. Note: Do not prefix this value with jms://; this is automatically added. Troubleshooting the JMS Internal Delivery Channel ■ ■ Ensure that Oracle_Home/dms/diagnostics/lib/ojdl.jar is in the CLASSPATH. Check if OC4J is a standalone or middle-tier installation. The JNDI naming URL value is different in both cases. ■ Ensure that OC4J is running. ■ Ensure that the admin user is not deactivated. Check the principals.xml file. ■ Ensure that the RMI port is correct. Check the rmi.xml file. ■ ■ Ensure that the jazn-xml line is commented out in the application.xml file (or user admin is activated in the jazn-data.xml file). Restart OC4J after making any changes to the application.xml and principals.xml files. Example: Creating File/FTP Internal Delivery Channels To create a File internal delivery channel using the OracleAS Integration B2B user interface: Managing Trading Partners 10-39 Managing Internal Delivery Channels Note: Fields and checkboxes for which you should accept default values, or leave blank, are omitted in the following steps. 1. Click Partners, then Trading Partners. 2. Click the name of the host trading partner. 3. Click Capabilities. 4. Under Internal Delivery Channels, click Create. 5. On the Create Internal Delivery Channel - General page, provide the following information and click Next. Field Value Name File Outbound Is Inbound No 6. On the Create Internal Delivery Channel - Transport page, provide the following information and click Next. a. Select Create New and provide the following information: General Field Value Name File Outbound Transport Transport Protocol Field Value Transport Protocol File b. Select Create New and provide the following information: Transport Server Field Value Name File Outbound Server Host Name local_hostname The transport server exchanging messages at the host trading partner site. c. Select Create New and provide the following information: Endpoint Field Value URI /private/GlobalChips For inbound messages, the endpoint is the directory where you want the file to be placed. 7. Review the data and click Finish, or make changes using Back. You should see Internal Delivery Channel created successfully at the top of the page. 10-40 Oracle Application Server Integration B2B User’s Guide Managing Internal Delivery Channels To create an FTP internal delivery channel using the OracleAS Integration B2B user interface: 1. Click Partners, then Trading Partners. 2. Click the name of the host trading partner. 3. Click Capabilities. 4. Under Internal Delivery Channels, click Create. 5. On the Create Internal Delivery Channel - General page, provide the following information and click Next. Field Value Name FTP Outbound Is Inbound No 6. On the Create Internal Delivery Channel - Transport page, provide the following information and click Next. a. Select Create New and provide the following information: General Field Value Name FTP Outbound Transport Transport Protocol Field Value Transport Protocol FTP b. Select Create New and provide the following information: Transport Server Field Value Name FTP Transport Server Host Name local_hostname The transport server exchanging messages at the host trading partner site. c. Select Create New and provide the following information: Endpoint Field Value URI /private/Acme For outbound messages, the endpoint is the directory on the host server that is polled. 7. Review the data and click Finish, or make changes using Back. You should see Internal Delivery Channel created successfully at the top of the page. Managing Trading Partners 10-41 Managing Internal Delivery Channels File Name Restrictions The outbound message file name must provide the following information to OracleAS Integration B2B: Field Value (Using EDI X12 as an Example) To Trading Partner Name Acme Doc Type X12 - 850 Purchase Order DocType Revision X12 - 4010 MessageType 1 - Request 2 - Response 3 - Acknowledgment 4 - Error MessageId A unique number ReplyToMsgId Optional extension Any string Outbound file name format required from source: <ToTP> <DocType> <DocTypeRevision> <MessageType> <MessageId> <ReplyToMsgId> <extension> Example: GlobalChips_850_4010_1_12345.xml Inbound file name format generated by OracleAS Integration B2B: <FromTP> <DocType> <DocTypeRevision> <MessageType> <MessageId> <ReplyToMsgId> <extension> Example: Acme_855_4010_1_54321.xml Deleting an Internal Delivery Channel You can only delete internal delivery channels that you created. Follow these instructions to delete an internal delivery channel: 1. Click Partners, then Trading Partners. 2. Select the host trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the host trading partner appears. 10-42 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Collaborations 4. Select a specific internal delivery channel to delete in the Delete column of the Internal Delivery Channels section. 5. Click Yes when prompted to delete an internal delivery channel. The internal delivery channel is deleted and the Capabilities page for the host trading partner appears. Managing Business Protocol Collaborations The OracleAS Integration B2B user interface enables you to perform the collaboration management tasks for the RosettaNet over RNIF business protocol shown in Figure 10–15. These tasks are described in detail in this section. Collaborations consist of a set of partner interface processes (PIPs) that define the capabilities of a trading partner in a business transaction (such as buyer and seller). Collaborations apply only to the RosettaNet over RNIF business protocol, and not to any EDI or Custom Document business protocols. In the OracleAS Integration B2B user interface, trading partners define their operational capabilities by the collaborations they support. Figure 10–15 Business Protocol Collaboration Management Tasks Table 10–14 identifies the business protocol collaboration management tasks shown in Figure 10–15 and provides references to procedures for performing these tasks. Managing Trading Partners 10-43 Managing Business Protocol Collaborations Table 10–14 Business Protocol Collaboration Management Tasks Page Elements Management Task See Section... Select support for a Chapter 9, "Creating collaboration (which includes a Trading Partners" PIP) and a collaboration role Note: The host trading partner (for example, buyer or seller) is automatically assigned a for the RosettaNet over RNIF collaboration that is compatible business protocol (trading with the selection for the partners define their remote trading partner. operational capabilities by the collaborations they support) Create Operational Capability button of Figure 10–15 Details column in Supported Collaborations section of Figure 10–15 View details about support for a collaboration "Viewing a Business Protocol Collaboration" on page 10-44 Update column in Supported Collaborations section of Figure 10–15 Update support for a collaboration "Updating a Business Protocol Collaboration" on page 10-45 Delete column in Supported Collaborations section of Figure 10–15 Delete support for a collaboration "Deleting a Business Protocol Collaboration" on page 10-46 Note: You must have already created or imported support for a collaboration for it to display in the Business Protocol Details page. Viewing a Business Protocol Collaboration Follow these instructions to view details about a specific collaboration for the RosettaNet over RNIF business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select the RosettaNet over RNIF business protocol in the Name column. 5. Select a specific collaboration to view in the Details column of the Supported Collaborations section. The Supported Collaboration Role Details page for the selected collaboration appears. 6. View specific details, including the following: ■ Collaboration role (for example, buyer or seller) ■ Collaboration (for example, PIP 3A4) ■ Version (for example, V02.00) ■ If acknowledgment is handled by OracleAS Integration B2B ■ The time to perform the collaboration ■ If any validation rules are associated with the business protocol collaboration This page, as with the Business Protocol Details page shown in Figure 10–15 on page 10-43, enables you to delete or update the selected collaboration. 10-44 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Collaborations 7. Click Return to List to return to the Capabilities page. Updating a Business Protocol Collaboration Follow these instructions to update a collaboration for the RosettaNet over RNIF business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select the RosettaNet over RNIF business protocol in the Name column. 5. Select a specific collaboration to update in the Update column of the Supported Collaborations section. The Update Supported Collaboration Role page appears. 6. Make appropriate updates: Field Value Collaboration Role Select an appropriate update from the list. The following list is an example of what can appear. The collaboration roles that display are based upon those that you imported or created. Each selection combines a role (for example, Buyer), a collaboration (for example, PIP 3A4), and a version (for example, V02.00). ■ Buyer - 3A4 - V02.00 ■ Buyer - 3A6 - V02.00 ■ Buyer - 3A7 - V02.00 ■ Buyer - 3A8 - V02.00 ■ Failure Report Administrator - 0A1 - V02.00 ■ PIP Report Administrator - 0A1 - V02.00 ■ Receiver - 3B2 - V01.00 ■ Seller - 3A4 - V02.00 ■ Seller - 3A6 - V02.00 ■ Seller - 3A7 - V02.00 ■ Seller - 3A8 - V02.00 ■ Shipper - 3B2 - V01.00 Is acknowledgement handled Select No or Yes. by Integration B2B? If Yes is selected, OracleAS Integration B2B handles acknowledgment. If No is selected, the application handles acknowledgment. Time To Perform 7. Update the time in minutes in which to process the support for a collaboration. This value overrides the value defined by the collaboration. Click Apply. The business protocol collaboration is updated and the Collaboration Role Details page appears. Managing Trading Partners 10-45 Managing Business Protocol Business Actions Deleting a Business Protocol Collaboration Follow these instructions to delete support for a collaboration for the RosettaNet over RNIF business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select the RosettaNet over RNIF business protocol in the Name column. 5. Select a specific collaboration to delete in the Delete column of the Supported Collaborations section. 6. Click Yes when prompted to delete a collaboration. The collaboration is deleted and the Business Protocol Details page appears. Managing Business Protocol Business Actions The OracleAS Integration B2B user interface enables you to perform the business action management tasks shown in Figure 10–16. These tasks are described in detail in this section. Business actions define the roles played in a configuration between trading partners in a business transaction (such as initiator and responder). Business actions apply to any EDI or Custom Document business protocols, and not to the RosettaNet over RNIF business protocol. In the OracleAS Integration B2B user interface, trading partners define their operational capabilities by the business actions they support. 10-46 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Business Actions Figure 10–16 Business Protocol Business Action Management Tasks Table 10–15 identifies the business protocol business action management tasks shown in Figure 10–16 and provides references to procedures for performing these tasks. Table 10–15 Business Protocol Business Action Management Tasks Page Elements Management Task See Section... Create Operational Capability button of Figure 10–16 Select support for a business action for an EDI or Custom Document business protocol (trading partners define their operational capabilities by the business actions they support) Chapter 9, "Creating Trading Partners" Name column in Supported Business Actions section of Figure 10–16 View details about support for a business action "Viewing a Business Protocol Business Action" on page 10-48 Update column in Supported Business Actions section of Figure 10–16 Update support for a business action "Updating a Business Protocol Business Action" on page 10-48 Delete column in Supported Business Actions section of Figure 10–16 Delete support for a business action "Deleting a Business Protocol Business Action" on page 10-49 Note: The host trading partner is automatically assigned a business action that is compatible with the selection for the remote trading partner. Note: You must have already created or imported support for a business action for it to display in the Business Protocol Details page. Managing Trading Partners 10-47 Managing Business Protocol Business Actions Viewing a Business Protocol Business Action Follow these instructions to view details about a specific business action of an EDI or Custom Document business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific EDI or Custom Document business protocol in the Name column. 5. Select a specific business action to view in the Name column of the Supported Business Actions section. The Supported Business Action Details page for the selected business action appears. 6. View specific details, including support for the business action, initiator status, functional acknowledgment, and if acknowledgment is handled by OracleAS Integration B2B. You can also view document information, such as the document protocol, document protocol revision, document type, document definition, and document protocol parameter settings. This page, as with the Business Protocol Details page shown in Figure 10–16 on page 10-47, enables you to delete or update the selected business action. 7. Click Return to List to return to the Business Protocol Details page. Updating a Business Protocol Business Action Follow these instructions to update support for a business action of an EDI or Custom Document business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific EDI or Custom Document business protocol in the Name column. 5. Select a specific business action to update in the Update column of the Supported Business Actions section. The Update Supported Business Action page appears. 6. Make appropriate updates. Field Value Is Initiator * Select False or True. Functional acknowledgement required? * Select No or Yes. Is acknowledgement handled by Integration B2B? * Select No or Yes. If Yes is selected, OracleAS Integration B2B handles acknowledgment. If No is selected, the application handles acknowledgment. 10-48 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Delivery Channels Field Value Use Existing Document Definition Deselect to change the default settings. Use Default Document Definition Select to change the default settings. Document Protocol Parameters Override values in the New Value column. You can also import interchange or group .ecs files. Note: .ecs files are only applicable to the EDI business protocol. 7. Click Apply. The business action is updated and the Supported Business Action Details page appears. Deleting a Business Protocol Business Action Follow these instructions to delete support for a business action of an EDI or Custom Document business protocol: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific EDI or Custom Document business protocol in the Name column. 5. Select a specific business action to delete in the Delete column of the Supported Business Actions section. 6. Click Yes when prompted to delete a business action. The business action is deleted and the Business Protocol Details page appears. Managing Business Protocol Delivery Channels The OracleAS Integration B2B user interface enables you to perform the delivery channel management tasks shown in Figure 10–17. These tasks are described in detail in this section. The delivery channel describes whether security characteristics such as nonrepudiation of origin and receipt, acknowledgment mode, time to acknowledge, retry count, transport security, encryption, and file compression are required. The delivery channel also includes the following: ■ ■ Associated transport (with its transport protocol, mode, server, and endpoint address) Associated document exchange (with its exchange protocol parameters, exchange protocol override elements, exchange protocol revision, and, if defined, its support for a digital envelope, encryption credential, digital signature, signing credential, and validation) A business protocol can have multiple delivery channels. To create a trading partner agreement, you must create a delivery channel. When you create a trading partner agreement, you can assign only one delivery channel to the agreement. In the OracleAS Integration B2B user interface, delivery channels are part of the communication capabilities of the supported business protocol. Managing Trading Partners 10-49 Managing Business Protocol Delivery Channels Figure 10–17 Delivery Channel Management Tasks Table 10–16 identifies the delivery channel management tasks shown in Figure 10–17 and provides references to procedures for performing these tasks. Table 10–16 Delivery Channel Management Tasks Page Elements Management Task See Section... Create Communication Capability button of Figure 10–17 Starts the Create Trading Partner wizard to guide you through creation of a delivery channel, document exchange, transport, transport server, and endpoint (pages 4 through 7 of the wizard) "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Name column in Delivery Channels section of Figure 10–17 View details about a delivery channel (including the associated document exchange and transport) "Viewing a Business Protocol Delivery Channel" on page 10-51 Update column in Delivery Channels section of Figure 10–17 Update a delivery channel "Updating a Business Protocol Delivery Channel" on page 10-51 Delete column in Delivery Channels section of Figure 10–17 Delete a delivery channel "Deleting a Business Protocol Delivery Channel" on page 10-52 10-50 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Delivery Channels Note: The transport and document exchange associated with the delivery channel display in the Document Exchange and Transport columns of the Delivery Channels section. (See Figure 10–17.) Viewing a Business Protocol Delivery Channel Follow these instructions to view details about a specific delivery channel: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific delivery channel in the Name column of the Delivery Channels section. The Delivery Channel Details page for the selected delivery channel appears. 6. View specific details, including the delivery channel name, document exchange (with a link to that details page), transport (with a link to that details page), acknowledgment mode, global usage code, nonrepudiation of receipt or origin support, encryption support, transport security support, time to acknowledgment value, and retry count value. This page, as with the Business Protocol Details page shown in Figure 10–17 on page 10-50, enables you to delete or update the selected delivery channel. 7. Click Return to List to return to the Business Protocol Details page. Updating a Business Protocol Delivery Channel Follow these instructions to update a delivery channel: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific delivery channel to update in the Update column of the Delivery Channels section. The Update Delivery Channel page appears. 6. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the delivery channel. Document Exchange Select a document exchange to use with this delivery channel. Transport Select a transport to use with this delivery channel. Acknowledgement Mode Select Async, None, or Sync for the mode in which the trading partner receives messages. Managing Trading Partners 10-51 Managing Business Protocol Document Exchanges Field Value Global Usage Code Select Production or Test. This specifies the usage of the delivery channel. If set to Test, the delivery channel is used only for testing purposes. If set to Production, it is used only for production purposes. This parameter is used mainly with RNIF. Is Non-Repudiation of Receipt Required Cannot be updated on this page. You must create a new delivery channel to update this value. Is Non-Repudiation of Origin Cannot be updated on this page. You must create a new Required delivery channel to update this value. Encryption Enabled Cannot be updated on this page. You must create a new delivery channel to update this value. Transport Security Enabled Select No or Yes. If you select Yes, a secure transport protocol, security specification, and remote trading partner certificate are necessary. You must update these details on the Update Transport page. Compression Enabled Select No or Yes. This field applies only to the AS2 exchange protocol. By default, OracleAS Integration B2B signs the message before encrypting it. Time To Acknowledgement Enter a value in minutes. This value specifies the time in which an acknowledgment message must be received. If an acknowledgment is not received, an error message is returned. Retry Count Enter a value. This value specifies the number of times to retry. 7. Click Apply. The delivery channel is updated and the Delivery Channel Details page appears. Deleting a Business Protocol Delivery Channel Follow these instructions to delete a delivery channel: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific delivery channel to delete in the Delete column of the Delivery Channels section. 6. Click Yes when prompted to delete a delivery channel. The delivery channel is deleted and the Business Protocol Details page appears. Managing Business Protocol Document Exchanges The OracleAS Integration B2B user interface enables you to perform the document exchange management tasks shown in Figure 10–18. These tasks are described in detail in this section. The document exchange describes the supported exchange protocol revision (such as RosettaNet 01.10) and, if being used, credential encryptions, 10-52 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Document Exchanges signing credentials, digital envelopes, digital signatures, and validation support. The document exchange uses these capabilities to exchange messages with a trading partner. In the OracleAS Integration B2B user interface, document exchanges are part of the communication capabilities of the business protocol. A document exchange is associated with a delivery channel that you assign to a trading partner agreement. Figure 10–18 Document Exchange Management Tasks Table 10–17 identifies the document exchange management tasks shown in Figure 10–18 and provides references to procedures for performing these tasks. Table 10–17 Document Exchange Management Tasks Page Elements Management Task See Section... Create Communication Capability button of Figure 10–18 Starts the Create Trading Partner wizard to guide you through creation of a delivery channel, document exchange, transport, transport server, and endpoint (pages 4 through 7 of the wizard) "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Name column in Document Exchanges section of Figure 10–18 View details about a document "Viewing a Business exchange Protocol Document Exchange" on page 10-54 Managing Trading Partners 10-53 Managing Business Protocol Document Exchanges Table 10–17 (Cont.) Document Exchange Management Tasks Page Elements Management Task Exchange Protocol Revision column in Document Exchanges section of Figure 10–18 View details about an exchange "Viewing Exchange protocol revision Protocols" on page 8-18 Update column in Document Exchanges section of Figure 10–18 Update a document exchange Name column in Document Delete a document exchange Exchanges section of Figure 10–18 (to access a page to delete a document exchange) See Section... "Updating a Business Protocol Document Exchange" on page 10-54 "Deleting a Business Protocol Document Exchange" on page 10-55 Note: The exchange protocol revision of this document exchange displays in the Exchange Protocol Revision column of the Document Exchanges section. (See Figure 10–18.) Viewing a Business Protocol Document Exchange Follow these instructions to view details about a specific document exchange: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific document exchange to view in the Name column of the Document Exchanges section. The Document Exchange Details page for the selected document exchange appears. 6. View specific details, including exchange protocol parameters, exchange protocols, digital envelopes, encryption credentials, digital signatures, signing credentials, and validation support in the Details section at the top of the page. This page, as with the Business Protocol Details page shown in Figure 10–18 on page 10-53, enables you to update the selected document exchange. You can also delete the document exchange from this page. 7. Click Return to List to return to the Business Protocol Details page. Updating a Business Protocol Document Exchange Follow these instructions to update a document exchange: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 10-54 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Transports 5. Select a specific document exchange to update in the Update column of the Document Exchanges section. The Update Document Exchange page appears. 6. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Exchange Protocol Revision * Select the exchange protocol revision to use. The revisions that appear are based on the exchange protocol you are using: Exchange Protocol Parameters 7. ■ If using RNIF, select RosettaNet - 01.10 or RosettaNet - V02.00. ■ If using Generic Exchange, select Generic 1.0. ■ If using AS, select AS2 - 1.1 Change appropriate exchange protocol parameters values. If you are using the AS2 exchange protocol, the parameter Signed and Compressed equals true means that OracleAS Integration B2B by default signs the message before compressing it. Click Apply. The document exchange is updated and the Document Exchange Details page appears. Deleting a Business Protocol Document Exchange Follow these instructions to delete a document exchange: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific document exchange to delete in the Name column of the Document Exchanges section. The Document Exchange Details page appears. 6. Click Delete to delete the document exchange. 7. Click Yes when prompted to delete the document exchange. The document exchange is deleted and the Business Protocol Details page appears. Managing Business Protocol Transports The OracleAS Integration B2B user interface enables you to perform the transport management tasks shown in Figure 10–19. These tasks are described in detail in this section. The transport defines the properties specific to a given usage of a protocol endpoint. The transport is responsible for message delivery using the selected transport protocol (such as HTTP 1.1), mode (synchronous or asynchronous), server, and protocol endpoint address (trading partner address, such as a URI). In the OracleAS Integration B2B user interface, transports are part of the communication capabilities of the business protocol. A transport is associated with a delivery channel that you assign to a trading partner agreement. Managing Trading Partners 10-55 Managing Business Protocol Transports Figure 10–19 Transport Management Tasks Table 10–18 identifies the transport management tasks shown in Figure 10–19 and provides references to procedures for performing these tasks. Table 10–18 Transport Management Tasks Page Elements Management Task See Section... Create Communication Capability button of Figure 10–19 Starts the Create Trading Partner wizard to guide you through creation of a delivery channel, document exchange, transport, transport server, and endpoint (pages 4 through 7 of the wizard) "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Name column in Transports section of Figure 10–19 View details about a transport "Viewing a Business Protocol Transport" on page 10-57 Update column in Transports section of Figure 10–19 Update a transport "Updating a Business Protocol Transport" on page 10-57 Name column in Transports section of Figure 10–19 (to access a page to delete a transport) Delete a transport "Deleting a Business Protocol Transport" on page 10-58 10-56 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Transports Note: The transport server and URI for this transport also display in the Transport Server and URI columns, respectively, of the Transports section. (See Figure 10–19.) Viewing a Business Protocol Transport Follow these instructions to view details about a specific transport: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific transport to view in the Name column of the Transports section. The Transport Details page for the selected transport appears. 6. View specific details about the transport protocol (for example, HTTP), transport server name, URI (trading partner endpoint address), and transport parameters (such as the port number and additional transport headers). If you selected a transport server for a predefined internal delivery channel, the URI is the specific internal endpoint to which it applies. This page, as with the Business Protocol Details page shown in Figure 10–19 on page 10-56, enables you to update the selected transport. You can also delete the transport from this page. 7. Click Return to List to return to the Business Protocol Details page. See "Viewing a Business Protocol Endpoint" on page 10-63 for the internal endpoints that apply to each internal delivery channel. Updating a Business Protocol Transport Follow these instructions to update a transport: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific transport to update in the Update column of the Transports section. The Update Transport Parameter page appears. 6. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Transport Protocol Select a transport protocol (for example, HTTP). Transport Server Select a transport server. Managing Trading Partners 10-57 Managing Business Protocol Transport Servers Field Value Endpoint Select an endpoint. All endpoints in the OracleAS Integration B2B user interface display for selection. 7. Click Apply. The transport is updated and the Transport Details page appears. Deleting a Business Protocol Transport Follow these instructions to delete a transport: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific transport to delete in the Name column of the Transports section. The Transport Details page appears. 6. Click Delete to delete the transport. 7. Click Yes when prompted to delete the transport. The transport is deleted and the Business Protocol Details page appears. Managing Business Protocol Transport Servers The OracleAS Integration B2B user interface enables you to perform the transport server management tasks shown in Figure 10–20. These tasks are described in detail in this section. The transport server is the endpoint server name for the trading partner. In the OracleAS Integration B2B user interface, transport servers are part of the communication capabilities of the business protocol. A transport server is associated with a delivery channel that you assign to a trading partner agreement. 10-58 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Transport Servers Figure 10–20 Transport Server Management Tasks Table 10–19 identifies the transport server management tasks shown in Figure 10–20 and provides references to procedures for performing these tasks. Table 10–19 Transport Server Management Tasks Page Elements Management Task See Section... Create Communication Capability button of Figure 10–20 Starts the Create Trading Partner wizard to guide you through creation of a delivery channel, document exchange, and transport (pages 4 through 7 of the wizard) "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 Name column in Transport Servers section of Figure 10–20 View details about a transport server "Viewing a Business Protocol Transport Server" on page 10-60 Update column in Transport Servers section of Figure 10–20 Update a transport server "Updating a Business Protocol Transport Server" on page 10-60 Name column in Transport Servers section of Figure 10–20 (to access a page to delete a transport server) Delete a transport server "Deleting a Business Protocol Transport Server" on page 10-61 Managing Trading Partners 10-59 Managing Business Protocol Transport Servers Note: The transport protocol and the server host name for this transport server also display in the Transport Protocol and Host Name columns, respectively, of the Transport Servers section. (See Figure 10–20.) Viewing a Business Protocol Transport Server Follow these instructions to view a transport server: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific transport server to view in the Name column of the Transport Servers section. The Transport Server Details page for the selected transport server appears. 6. View specific details about the trading partner name, server name, server protocol used (for example, HTTP), IP address, server username, server password, and transport protocol parameter values (such as the port number of the server and additional transport headers). This page, as with the Business Protocol Details page shown in Figure 10–20 on page 10-59, enables you to update the selected transport server. You can also delete the transport server from this page. 7. Click Return to List to return to the Business Protocol Details page. Updating a Business Protocol Transport Server Follow these instructions to update a transport server: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific transport server to update in the Update column of the Transport Servers section. The Update Transport Server page appears. 6. Make appropriate updates. An asterisk (*) indicates a required field. Note: Any updates that you make on this page must always include updating the password. If you update any other field, but do not update the password, you receive an error at run time. The password you enter can be the same one you previously specified. 10-60 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Endpoints Field Value Description Update a description for the transport server. Host Name * Update the hostname of the transport server. IP Address Update the IP address of the transport server. Username Update the username for logging into the transport server. Password Update the password of the username. Transport Parameter Values Update appropriate parameters. The parameters that appear are based on the transport protocol you are using: HTTP 1.0, HTTP 1.1, Email 1.0, FTP 1.0, or File 1.0. For example, if you are using HTTP 1.0 or 1.1, you can update the following parameters: ■ ■ HTTP port number of the server The additional transport headers, which store name and value pairs. A valid setting for this parameter takes the format name1=value1;name2=value2;...name_ n=value_n, where name1 through name_n equals the header name, and value1 through value_n equals the header value of the HTTP protocol. 7. Update appropriate parameter values in the Transport Parameter Values section. 8. Click Apply. The transport is updated and the Transport Server Details page appears. Deleting a Business Protocol Transport Server Follow these instructions to delete a transport server: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific transport server to delete in the Name column of the Transport Server section. The Transport Server Details page appears. 6. Click Delete to delete the transport server. 7. Click Yes when prompted to delete the transport server. The transport server is deleted and the Business Protocol Details page appears. Managing Business Protocol Endpoints The OracleAS Integration B2B user interface enables you to perform the endpoint management tasks shown in Figure 10–21. These tasks are described in detail in this section. Endpoints are trading partner addresses (typically a URI). An endpoint includes a protocol endpoint, which is a combination of a specific endpoint address (such as http://server.partner.com:5555/submit/rnmsg) and transport protocol (such as HTTP 1.1). Endpoints are global to all trading partners. Managing Trading Partners 10-61 Managing Business Protocol Endpoints In the OracleAS Integration B2B user interface, endpoints are part of the communication capabilities of the business protocol. An endpoint is associated with a delivery channel that you assign to a trading partner agreement. Figure 10–21 Endpoint Management Tasks Table 10–20 identifies the endpoint management tasks shown in Figure 10–21 and provides references to procedures for performing these tasks. Table 10–20 Endpoint Management Tasks Page Elements Management Task See Section... Create Communication Capability button of Figure 10–21 Starts the Create Trading Partner wizard to guide you through creation of a delivery channel, document exchange, transport, transport server, and endpoint (pages 4 through 7 of the wizard) "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners" on page 9-27 URI column in Endpoints section of Figure 10–21 View details about an endpoint "Viewing a Business Protocol Endpoint" on page 10-63 Update column in Endpoints section of Figure 10–21 Update an endpoint "Updating a Business Protocol Endpoint" on page 10-64 Delete column in Endpoints section of Figure 10–21 Delete an endpoint "Deleting a Business Protocol Endpoint" on page 10-64 10-62 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Endpoints Table 10–20 (Cont.) Endpoint Management Tasks Page Elements Management Task See Section... URI column in Endpoints section of Figure 10–21 View details about a protocol endpoint of a business protocol endpoint "Viewing a Protocol Endpoint of a Business Protocol Endpoint" on page 10-64 URI column in Endpoints section of Figure 10–21 (to access a page for updating a protocol endpoint) Update a protocol endpoint of a business protocol endpoint "Updating a Protocol Endpoint of a Business Protocol Endpoint" on page 10-65 URI column in Endpoints section of Figure 10–21 (to access a page for deleting a protocol endpoint) Delete a protocol endpoint of a business protocol endpoint "Deleting a Protocol Endpoint of a Business Protocol Endpoint" on page 10-65 Viewing a Business Protocol Endpoint Follow these instructions to view details about a specific endpoint: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific endpoint to view in the URI column of the Endpoints section. OracleAS Integration B2B includes four predefined, internal endpoints that cannot be deleted. Each endpoint is associated with a specific internal delivery channel to enable communication between the host application and the host trading partner’s installation of OracleAS Integration B2B. ■ apps.ECX_INBOUND Associated with the XML Gateway Inbound internal delivery channel. You can update the URI of this internal delivery channel. ■ apps.ECX_OUTBOUND Associated with the XML Gateway Outbound internal delivery channel. You can update the URI of this internal delivery channel. ■ b2b.IP_IN_QUEUE Associated with the B2B Inbound internal delivery channel ■ b2b.IP_OUT_QUEUE Associated with the B2B Outbound internal delivery channel The Endpoint Details page for the selected endpoint appears. 6. View specific details about the URI endpoint address and the transport protocol used. You can also manage the protocol endpoint of the business protocol endpoint from this page. This page, as with the Business Protocol Details page shown in Figure 10–21 on page 10-62, enables you to delete or update the selected endpoint. Managing Trading Partners 10-63 Managing Business Protocol Endpoints 7. Click Return to List to return to the Business Protocol Details page. See the following for more information: ■ "Viewing a Protocol Endpoint of a Business Protocol Endpoint" on page 10-64 ■ "Updating a Protocol Endpoint of a Business Protocol Endpoint" on page 10-65 ■ "Deleting a Protocol Endpoint of a Business Protocol Endpoint" on page 10-65 Updating a Business Protocol Endpoint Follow these instructions to update an endpoint: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific endpoint to update in the Update column of the Endpoints section. The Update Endpoints page appears. 6. Make appropriate changes to the URI (endpoint address) and description. 7. Click Apply. The endpoint is updated and the Endpoint Details page appears. Deleting a Business Protocol Endpoint Follow these instructions to delete an endpoint: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific endpoint to delete in the Delete column of the Endpoints section. 6. Click Yes when prompted to delete an endpoint. The endpoint is deleted and the Business Protocol Details page appears. Viewing a Protocol Endpoint of a Business Protocol Endpoint Follow these instructions to view details about a specific protocol endpoint of a business protocol endpoint: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 10-64 Oracle Application Server Integration B2B User’s Guide Managing Business Protocol Endpoints 5. Select a specific endpoint to view in the URI column of the Endpoints section. The Endpoint Details page for the selected endpoint appears. 6. Select a specific protocol endpoint to view in the Details column of the Protocol Endpoints section. The Protocol Endpoint Details page for the selected endpoint appears. 7. View specific details about the endpoint and transport protocol that comprise this protocol endpoint. This page, as with the Endpoint Details page, enables you to delete or update the selected protocol endpoint. 8. Click Return to List to return to the Endpoint Details page. 9. Click Return to List to return to the Business Protocol Details page. Updating a Protocol Endpoint of a Business Protocol Endpoint Follow these instructions to update a protocol endpoint of a business protocol endpoint: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. 4. Select a specific business protocol in the Name column. 5. Select a specific endpoint in the URI column of the Endpoints section. The Endpoint Details page for the selected endpoint appears. 6. Select a specific protocol endpoint to update in the Update column of the Protocol Endpoints section. The Update Protocol Endpoint page appears. 7. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Endpoint * Update the endpoint used with this endpoint. Transport Protocol Update the transport endpoint used with this endpoint. 8. Click Apply. The protocol endpoint is updated and the Protocol Endpoint Details page appears. Deleting a Protocol Endpoint of a Business Protocol Endpoint Follow these instructions to delete a protocol endpoint of a business protocol endpoint: 1. Click Partners, then Trading Partners. 2. Select a specific trading partner in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. The Capabilities page for the selected trading partner appears. Managing Trading Partners 10-65 Common User Errors 4. Select a specific business protocol in the Name column. 5. Select a specific endpoint in the URI column of the Endpoints section. The Endpoint Details page for the selected endpoint appears. 6. Select a specific protocol endpoint to delete in the Delete column of the Protocol Endpoints section. 7. Click Yes when prompted to delete a protocol endpoint. The protocol endpoint is deleted and the Endpoint Details page appears. Common User Errors ■ ■ ■ Ensure that the endpoint address you specify exists and is accessible. Do not include beginning or trailing blank spaces in the names of trading partner data that you create. Any updates that you make on the Update Transport Server page must always include updating the password. If you update any other field, but do not update the password, you receive an error at run time. The password you enter can be the same one you previously specified. Summary This chapter first describes how to manage trading partners and their business protocol operational and communication capabilities that you previously created. This chapter begins with a brief overview of the main management pages in the OracleAS Integration B2B user interface (Trading Partner Details page, Capabilities page, and Business Protocol Details page). The remaining sections describe the specific tasks you can perform from these pages. 10-66 Oracle Application Server Integration B2B User’s Guide 11 Managing Callouts This chapter describes how to manage callouts, which enable you to transform the formats of messages exchanged between remote and host trading partners. This chapter contains the following topics: ■ Callouts Overview ■ Managing Callouts ■ Managing Callout Properties ■ Managing Callout Usages ■ Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction ■ Common User Errors ■ Summary Callouts Overview The host application of a trading partner is the ultimate source and destination for sending and receiving messages. You create or use predefined internal delivery channels in the OracleAS Integration B2B user interface that enable communication between the host application and the host trading partner. You can have an environment in which the host application does not understand the format of a message sent from a remote trading partner. For example, a remote trading partner sends a RosettaNet XML-formatted purchase order request to a host trading partner. The host application of the host trading partner is an Oracle E-Business Suite application that does not understand RosettaNet XML-formatted messages. Figure 11–1 provides an example of this environment. To enable communication between these two different formats, you create a callout that consists of callout usages. In this example, one callout usage transforms the RosettaNet XML-formatted purchase order request into an Oracle E-Business Suite XML format understood by the Oracle E-Business Suite application. The Oracle E-Business Suite application, in turn, responds to the request message with a purchase order acceptance message in Oracle E-Business Suite XML format. This message is transformed by another callout usage back into a RosettaNet XML-formatted message for the remote trading partner. You create two separate internal delivery channels for these messages: ■ One for the initiating purchase order request ■ One for the responding purchase order acceptance Managing Callouts 11-1 Callouts Overview When you create a trading partner agreement between the host and remote trading partners, you associate the initiating internal delivery channel with the initiating callout usage that transforms the purchase order request from RosettaNet XML to Oracle E-Business Suite XML. You also associate the responding internal delivery channel with the responding callout usage that transforms the purchase order acceptance from Oracle E-Business Suite XML to RosettaNet XML. Figure 11–1 Callouts Purchase Order Request (Oracle E-Business Suite XML format) Callout Usage (Transforms RosettaNet XML to Oracle E-Business Suite XML) Host Application (Oracle E-Business Suite XML) Internal Delivery Channel Responding Internal Delivery Channel A Host Trading Partner (seller) B Purchase Order Request (RosettaNet XML format) Purchase Order Acceptance (RosettaNet XML format) Remote Trading Partner (buyer) (RosettaNet XML) Responding Callout Usage (Transforms Oracle E-Business Suite XML to RosettaNet XML) Purchase Order Acceptance (Oracle E-Business Suite XML format) A Source Document Definition: PurchaseOrderRequest Target Document Definition: PurchaseOrderAcceptance B Source Document Definition: PurchaseOrderAcceptance Target Document Definition: PurchaseOrderRequest By default, the initiating internal delivery channel and callout usage are available for selection when you create a trading partner agreement. If you also want a responding internal delivery channel and responding callout usage to be available for selection, you must select Yes from the Is acknowledgment handled By Integration B2B? list on the Create Trading Partner - Operational Capability page or Create Supported Collaboration Role page when you create a trading partner. When you then create the trading partner agreement, you can select both internal delivery channels and both callout usages. Figure 11–2 provides an example of the upper part of the Create Agreement page that enables you to make these selections. 11-2 Oracle Application Server Integration B2B User’s Guide Managing Callouts Figure 11–2 Selecting Callouts when Creating a Trading Partner Agreement You perform the following tasks to use callouts with OracleAS Integration B2B: ■ ■ ■ Create a callout .jar file library name outside of OracleAS Integration B2B that follows the standards described in the Oracle Application Server Integration B2B Callouts Java API Reference to transform messages from one format to another, and vice versa. Create (register) a callout in the OracleAS Integration B2B user interface that includes the callout .jar file library name, the callout usages (that define the source and target document definitions such as a purchase order request and purchase order acceptance), and any input and output callout properties. Associate the callout usages with internal delivery channels when creating a trading partner agreement. During deployment of the trading partner agreement as part of a configuration, the callout usages are invoked and the transformation is performed. See the following for more information: ■ ■ "Page 3: Operational Capability Page" on page 9-11 for instructions on selecting Yes from the Is acknowledgment handled By Integration B2B? list on the Create Trading Partner - Operational Capability page "Creating Business Protocol Operational Capabilities for the Remote Trading Partner" on page 9-26 for instructions on selecting Yes from the Is acknowledgment handled By Integration B2B? list on the Create Supported Collaboration Role page ■ "Managing Internal Delivery Channels" on page 10-30 ■ "Managing Trading Partner Agreements" on page 12-4 ■ Oracle Application Server Integration B2B Callouts Java API Reference in the Oracle Application Server Documentation Library for guidelines on creating a callout Managing Callouts The OracleAS Integration B2B user interface enables you to perform the callout management tasks shown in Figure 11–3. Callouts enable you to transform the formats Managing Callouts 11-3 Managing Callouts of messages exchanged between remote and host trading partners. These tasks are described in detail in this section. Figure 11–3 Callout Management Tasks Table 11–1 identifies the callout management tasks shown in Figure 11–3 and provides references to procedures for performing these tasks. Table 11–1 Callout Management Tasks Page Elements Management Task See Section... Create button in Callouts section of Figure 11–3 Create a callout "Creating a Callout" on page 11-4 Name column in Callouts section of Figure 11–3 View details about a callout "Viewing a Callout" on page 11-6 Update column in Callouts section of Figure 11–3 Update a callout "Updating a Callout" on page 11-7 Delete column in Callouts section of Figure 11–3 Delete a callout "Deleting a Callout" on page 11-7 Creating a Callout A predefined callout named XSLTCallout is provided for XML-to-XML transformations. You cannot update or delete this callout or create callout properties or callout usages for it. You can also create your own Java callouts. A callout includes attributes, such as a name, description, implementation class name, and callout .jar file library name. These callout details load the callout class, map the input and output parameters, and invoke the class. You can create multiple callouts with the same name. However, you must assign them different implementation names. Follow these instructions to create a callout: 1. Click Partners, then Callouts. 2. Click Create in the Callouts section. The Create Callout page appears. 3. 11-4 Enter the following details to create a callout. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the callout. Description Enter a description. Implementation Name * Enter the class file name. Note: OracleAS Integration B2B includes a predefined class file named XSLTCalloutImpl that you can use for XML-to-XML transformations. Oracle Application Server Integration B2B User’s Guide Managing Callouts Field Value Library Name * Enter the callout .jar file library name that defines how to perform the transformation. The class file is included in the .jar file. Note: If you specify your own callout .jar file, the directory location for this file must be specified with the Callout Directory parameter of the Server Properties page in Oracle Enterprise Manager 10g Application Server Control Console. Note that the directory location for the default b2b.jar file included with OracleAS Integration B2B does not need to be specified. Timeout (seconds) 4. Enter the time limit in which to process the callout. Click Apply. The callout is created and the new Callout Details page appears. Note: Do not modify the b2b.jar file included with OracleAS Integration B2B. Modifying this file can cause corruption. See "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 for instructions on accessing the Callout Directory server property in Oracle Enterprise Manager 10g Application Server Control Console to set the callout .jar file location. Implementing a Callout: Code Example The following code example shows how an incoming XML document is transformed to another XML document. import import import import import import import import java.io.*; java.net.*; java.util.*; oracle.xml.parser.v2.*; oracle.tip.callout.Callout; oracle.tip.callout.CalloutMessage; oracle.tip.callout.CalloutContext; oracle.tip.callout.exception.*; /** * This sample callout transforms the incoming XML document * to another XML document. It also shows how to generate * Functional Ack and Error message. */ public class MyCallout implements Callout { public void execute(CalloutContext context, List input, List output) throws CalloutDomainException, CalloutSystemException { try { // (1) Retrieve the callout properties from CalloutContext String xsltFile = context.getStringProperty("xsltFile"); // (2) Get the input callout message CalloutMessage cmIn = (CalloutMessage)input.get(0); // (3) Process the message // instantiate a stylesheet Managing Callouts 11-5 Managing Callouts URL xslURL = new URL("file://" + xsltFile); XSLProcessor processor = new XSLProcessor(); XSLStylesheet xsl = processor.newXSLStylesheet(xslURL); // parser input XML content DOMParser parser = new DOMParser(); parser.setPreserveWhitespace(true); parser.parse(new StringReader(cmIn.getBodyAsString())); XMLDocument xml = parser.getDocument(); processor.showWarnings(true); processor.setErrorStream(System.err); // Transform the document StringWriter strWriter = new StringWriter(); processor.processXSL(xsl, xml, new PrintWriter(strWriter)); // (4) Create a output callout message // create a callout output message CalloutMessage cmOut = new CalloutMessage(strWriter.getBuffer().toString()); strWriter.close(); // create Functional Ack callout message // this is an optional step CalloutMessage fa = new CalloutMessage(/*set FA payload here*/); fa.setParameter("functional_ack", "true"); //setting your own doctype and revision //set the doc type name and revision as defined in b2b ui fa.setParameter("doctype_name", "fa"); fa.setParameter("doctype_revision", "1.0"); // create Error callout message // this is an optional step CalloutMessage err = new CalloutMessage(/* set the payload that causes this error */); err.setParameter("error_message", "true"); err.setParameter("error_desc", "set the error desc"); output.add(cmOut); output.add(fa); output.add(err); //(5) Throw an exception, if any } catch (Exception e) { throw new CalloutDomainException(e); } } } Viewing a Callout Follow these instructions to view details about a specific callout: 1. Click Partners, then Callouts. 2. Select a specific callout to view in the Name column of the Callouts section. The Callout Details page for the selected callout appears. 3. 11-6 View specific details, including the following: Oracle Application Server Integration B2B User’s Guide Managing Callout Properties ■ ■ ■ The callout name, description, implementation name (class name), library name, and timeout value (in seconds) Any callout properties assigned to this callout The callout usages assigned to this callout (the source and target document definitions for the callout, such as a purchase order request and purchase order acceptance). For a callout to be selectable when you create a trading partner agreement, a callout usage must exist. This page, as with the Callouts page shown in Figure 11–3 on page 11-4, enables you to delete or update a callout that you created. 4. Click Return to List to return to the Callouts page. Updating a Callout Follow these instructions to update a callout that you created: 1. Click Partners, then Callouts. 2. Select a specific callout to update in the Update column of the Callouts section. The Update Callout page appears. 3. Make appropriate changes. (See Step 3 on page 11-4 for a list of fields you can update.) 4. Click Apply. The callout is updated and the Callout Details page appears. Deleting a Callout Follow these instructions to delete a callout that you created: Note: Ensure that you do not delete a callout included in a trading partner agreement of a configuration. 1. Click Partners, then Trading Partners, and then Callouts. 2. Select a specific callout to delete in the Delete column of the Callouts section. 3. Click Yes when prompted to delete a callout. The callout is deleted and the Callouts page appears. Managing Callout Properties The OracleAS Integration B2B user interface enables you to perform the callout property management tasks shown in Figure 11–4. These tasks are described in detail in this section. A predefined callout property named xsltFile is included with the XSLTCalloutImpl class file (the implementation name). You can also create your own callout properties. Callout properties are similar in concept to global variables to which you can assign local values that are applicable only to a specific callout usage. Or, you can create a callout property and assign it a default value that is applicable to all callout usages. For example, the xsltFile property specifies the location for a specific .xslt file. Within one callout usage, you can assign a value to the xsltFile property that is appropriate Managing Callouts 11-7 Managing Callout Properties for one specific callout usage (for example, /private/RNtoEBStransform.xslt for transformations from RosettaNet XML to Oracle E-Business Suite XML). In another callout usage, you can assign a different value (for example, private/EBStoRNtransform.xslt for transformations from Oracle E-Business Suite XML to RosettaNet XML). Figure 11–4 Callout Property Management Tasks Table 11–2 identifies the callout property management tasks shown in Figure 11–4 and provides references to procedures for performing these tasks. Table 11–2 Callout Property Management Tasks Page Elements Management Task See Section... Create button in Callout Properties section of Figure 11–4 Create a callout property "Creating Callout Properties" on page 11-8 Name column in Callout Properties section of Figure 11–4 View details about a callout property "Viewing Callout Properties" on page 11-9 Update column in Callout Properties section of Figure 11–4 Update a callout property "Updating Callout Properties" on page 11-10 Delete column in Callout Properties section of Figure 11–4 Delete a callout property "Deleting Callout Properties" on page 11-10 See "Creating a Callout Metadata Parameter Value for a Callout Usage" on page 11-14 to assign local values to a callout property that are applicable only to a specific callout usage and to create your own callout properties for a specific callout usage. Creating Callout Properties Follow these instructions to create a callout property: 1. 11-8 Click Partners, then Callouts. Oracle Application Server Integration B2B User’s Guide Managing Callout Properties 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Click Create in the Callout Properties section. The Create Callout Property page appears. 4. Enter the following details to create a callout property. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the callout property. Description Enter an optional description. Type * Select a type (Boolean, date, float, integer, or string). Mandatory Select False or True. Overridable Select False or True. If set to True, you can override the value at the callout usage level. If set to False, do not enter a value at the callout usage level. Minimum Length Enter a minimum length for the callout property. Maximum Length Enter a maximum length for the callout property. Encrypt Value Select False or True. Default Value Enter a value. If the Encrypt Value is set to True, this value is encrypted. 5. Click Apply. The callout property is created and the new Callout Property Details page appears. You can now assign local values to this callout property that are applicable only to a specific callout usage. Or, you can use this callout property in its current format to be applicable to all callout usages. Viewing Callout Properties Follow these instructions to view details about a specific callout property: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout to view in the Name column of the Callout Properties section. The Callout Properties Details page for the selected callout property appears. 4. View specific details, including the callout property name, description, type (for example, string), if the property is mandatory, if the property is overridable, the minimum and maximum lengths, if encryption is enabled, and the default value (which is visible if not encrypted). This page, as with the Callout Details page shown in Figure 11–4 on page 11-8, enables you to delete or update the selected callout property. 5. Click Return to List to return to the Callout Details page. Managing Callouts 11-9 Managing Callout Usages Updating Callout Properties Follow these instructions to update a callout property: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout to update in the Update column of the Callout Properties section. The Update Callout Property page appears. 4. Make appropriate changes. (See Step 4 on page 11-9 for a list of fields you can update.) 5. Click Apply. The callout property is updated and the Callout Property Details page appears. Deleting Callout Properties Follow these instructions to delete a callout property: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout property to delete in the Delete column of the Callout Properties section. 4. Click Yes when prompted to delete a callout property. The callout property is deleted and the Callout Details page appears. Managing Callout Usages The OracleAS Integration B2B user interface enables you to perform the callout usage management tasks shown in Figure 11–5 and Figure 11–6. These tasks are described in detail in this section. Callout usage enables you to map the source (input) document definition to a target (output) document definition for a transformation. You select the callout usage when you create a trading partner agreement. A callout can have multiple callout usages. You can also create callout metadata parameter values unique to a specific callout usage or you can assign local values that override callout properties set at the callout level. 11-10 Oracle Application Server Integration B2B User’s Guide Managing Callout Usages Figure 11–5 Callout Usage Management Tasks (Part 1 of 2) Clicking Details for a specific callout usage in the Callout Usage section causes the Callout Usage Details page to appear: Figure 11–6 Callout Usage Management Tasks (Part 2 of 2) Table 11–3 identifies the callout usage management tasks shown in Figure 11–5 and Figure 11–6 and provides references to procedures for performing these tasks. Table 11–3 Callout Usage Management Tasks Page Elements Management Task See Section... Create button in Callout Usage Create a callout usage section of Figure 11–5 "Creating a Callout Usage" on page 11-12 Details column in Callout Usage section of Figure 11–5 View details about a callout usage "Viewing a Callout Usage" on page 11-13 Update column in Callout Usage section of Figure 11–5 Update a callout usage "Updating a Callout Usage" on page 11-13 Delete column in Callout Usage section of Figure 11–5 Delete a callout usage "Deleting a Callout Usage" on page 11-13 Create button in Callout Metadata Parameter Values section of Figure 11–6 Create a callout metadata parameter value for a callout usage "Creating a Callout Metadata Parameter Value for a Callout Usage" on page 11-14 Managing Callouts 11-11 Managing Callout Usages Table 11–3 (Cont.) Callout Usage Management Tasks Page Elements Management Task See Section... Name column in Callout Metadata Parameter Values section of Figure 11–6 View details about a callout "Viewing a Callout metadata parameter value for a Metadata Parameter Value callout usage for a Callout Usage" on page 11-15 Update column in Callout Metadata Parameter Values section of Figure 11–6 Update a callout metadata parameter value for a callout usage "Updating a Callout Metadata Parameter Value for a Callout Usage" on page 11-16 Delete column in Callout Metadata Parameter Values section of Figure 11–6 Delete a callout metadata parameter value for a callout usage "Deleting a Callout Metadata Parameter Value for a Callout Usage" on page 11-16 Creating a Callout Usage If you want to select a callout when you create a trading partner agreement, you must first create a callout usage. A callout usage consists of a source (input) and target (output) document definition for transformation. The document definitions that display for selection are the ones you created through either of two methods: ■ ■ Created support for a business action or collaboration with the Create Business Action wizard or Create Collaboration wizard Imported EDI X12 and EDI EDIFACT transaction sets, UCCnet standards, and RosettaNet collaborations into the design-time repository by clicking Administration, then Management, and then Import Follow these instructions to create a callout usage: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Click Create in the Callout Usage section. The Create Callout Usage page appears. 4. Enter the following details to create a callout usage. An asterisk (*) indicates a required field. Field Value Source Document Definition * Select a source document definition. The selection you make here is the input to the callout (for example, a purchase order request initiated by a remote trading partner, as shown in Figure 11–1 on page 11-2). Target Document Definition * Select a target document definition. The selection you make here is the output to the callout (for example, a purchase order acceptance for a host application of a host trading partner, as shown in Figure 11–1 on page 11-2). 5. Click Apply. The callout usage is created and the new Callout Usage Details page appears. The callout usage can now be selected when you create a trading partner agreement. 11-12 Oracle Application Server Integration B2B User’s Guide Managing Callout Usages See the following for more information: ■ "Creating a Business Action" on page 8-20 ■ "Creating a Collaboration" on page 8-27 ■ "Creating a Trading Partner Agreement" on page 12-5 ■ "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 Viewing a Callout Usage Follow these instructions to view details about a specific callout usage: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage to view in the Details column of the Callout Usage section. The Callout Usage Details page for the selected callout usage appears. 4. View specific details, including the following. ■ ■ View the callout usage name Callout metadata parameter value. You can also manage (create, view, update, and delete) callout metadata parameter values for the callout usage from this page. This enables you to create parameters unique to a specific callout usage or assign local values that override callout properties set at the callout level. This page, as with the Callout Details page shown in Figure 11–5 on page 11-11, enables you to delete or update the selected callout usage. 5. Click Return to List to return to the Callout Details page. Updating a Callout Usage Follow these instructions to update a callout usage: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage to update in the Update column of the Callout Usage section. The Update Callout Usage page appears. 4. Make appropriate changes. (See Step 4 on page 11-12 for a list of fields you can update.) 5. Click Apply. The callout usage is updated and the Callout Usage Details page appears. Deleting a Callout Usage Follow these instructions to delete a callout usage: 1. Click Partners, then Callouts. Managing Callouts 11-13 Managing Callout Usages 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage to delete in the Delete column of the Callout Usage section. 4. Click Yes when prompted to delete a callout usage. The callout usage is deleted and the Callout Details page appears. Creating a Callout Metadata Parameter Value for a Callout Usage You can create a callout metadata parameter value for a callout usage that enables you to override properties set at the callout level (for example, with the xsltFile property). Callout metadata parameter values are similar in concept to local variables in that they are only applicable to a specific callout usage. For example, the xsltFile property specifies the location for a specific .xslt file. Within one callout usage, you can assign a value to the xsltFile property that is appropriate for that specific callout usage (for example, /private/RNtoEBStransform.xslt for transformations from RosettaNet XML to Oracle E-Business Suite XML). In another callout usage, you can assign a different value (for example, private/EBStoRNtransform.xslt for transformations from Oracle E-Business Suite XML to RosettaNet XML). You can also create callout metadata parameter values unique to a specific callout usage. 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage in the Details column of the Callout Usage section. The Callout Usage Details page for the selected callout usage appears. 4. Click Create in the Callout Metadata Parameter Values section. The Create Callout Metadata Parameter Value page appears. 5. Select whether to create or use an existing callout property value. 6. Go to the following steps based on your selection. Did You Select the Use Existing Callout Property Check Box? Go To... Yes Step 7 No Step 8 7. If you selected the Use Existing Callout Property check box, perform Steps 7a through 7b. a. Enter the following details to create a callout metadata parameter value. An asterisk (*) indicates a required field. Field Value Callout Property Select a callout property created at the callout level. 11-14 Oracle Application Server Integration B2B User’s Guide Managing Callout Usages Field Value Value * Enter a callout property value. This value overrides the value set at the callout level. b. 8. Go to Step 9. If you did not select the Use Existing Callout Property check box, perform Steps 8a through 8b. a. Enter the following details to create a callout metadata parameter value. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable name for the callout metadata parameter value. Description Enter an optional description. Type * Select a type (Boolean, date, float, integer, or string). Note: Changing a type can invalidate the callout metadata parameter value default value. Note: The date value does not currently function properly. To use the date value, create a callout property in which you select the date value from the Type list of the Create Callout Property page. Encrypt Value Select False or True. You cannot update this value at a later time. Value * Select Create New to create a new value or Use Existing to select an existing value. If Encrypt Value is set to True, this value is encrypted. b. 9. Go to Step 9. Click Apply. The callout metadata parameter value for this callout usage is created and the new Callout Usage Details page appears. Viewing a Callout Metadata Parameter Value for a Callout Usage Follow these instructions to view details about a specific callout metadata parameter value for a callout usage: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage in the Details column of the Callout Usage section. The Callout Usage Details page for the selected callout usage appears. 4. View specific details in the Callout Metadata Parameter Values section, including the callout metadata parameter value name, if the value is encrypted, type (for example, string), and value. 5. Click Return to List to return to the Callout Details page. Managing Callouts 11-15 Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction Updating a Callout Metadata Parameter Value for a Callout Usage Follow these instructions to update a callout metadata parameter value for a callout usage: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage in the Details column of the Callout Usage section. 4. Select a specific callout metadata parameter value to update in the Update column of the Callout Metadata Parameter Values section. The Update Callout Metadata Parameter Value page appears. 5. Update the callout metadata parameter value. 6. Click Apply. The callout metadata parameter value is updated and the Callout Usage Details page appears. Deleting a Callout Metadata Parameter Value for a Callout Usage Follow these instructions to delete a callout metadata parameter value for a callout usage: 1. Click Partners, then Callouts. 2. Select a specific callout in the Name column. The Callout Details page appears. 3. Select a specific callout usage in the Details column of the Callout Usage section. 4. Select a specific callout metadata parameter value to delete in the Delete column of the Callout Metadata Parameter Values section. 5. Click Yes when prompted to delete a callout metadata parameter value. The callout metadata parameter value is deleted and the Callout Usage Details page appears. Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction This section describes how to add callout usages to the RosettaNet over the Internet tutorial described in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction" on page 5-5. These callout usages use the predefined callout named XSLTCallout to perform the following tasks: ■ ■ Transform an Oracle E-Business Suite Open Application Group (OAG) purchase order document to a RosettaNet PIP 3A4 purchase order request document on the Acme server (the buyer) Transform a RosettaNet PIP 3A4 purchase order request document to an OAG purchase order document on the GlobalChips server (the seller) This section describes these tasks: ■ Acme Server, Task 1: Performing the RosettaNet over RNIF Tutorial 11-16 Oracle Application Server Integration B2B User’s Guide Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction ■ Acme Server, Task 2: Setting Up Callout Usages ■ GlobalChips Server, Task 1: Performing the RosettaNet over RNIF Tutorial ■ GlobalChips Server, Task 2: Setting Up Callout Usages See "Callouts Overview" on page 11-1 for more information. Acme Server, Task 1: Performing the RosettaNet over RNIF Tutorial This tutorial assumes you have completed the RosettaNet over the Internet tutorial described in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction" on page 5-5. As part of that tutorial, you set up the Acme server, where Acme was the host trading partner (buyer) and GlobalChips was the remote trading partner (seller). Note: The XML GW product sets the EDI Location Code in the Party Site ID field of XML GW message header. Ensure that you set the EDI Location Code ID type and corresponding value for the remote trading partner (3101 in the following example). Acme Server, Task 2: Setting Up Callout Usages Perform the following callout usage tasks on the Acme server: ■ Create an OAG Custom Document Type ■ Modify XML Gateway Settings ■ Modify the XSLTCallout Settings ■ Create a Trading Partner Agreement ■ Create and Deploy a Configuration Create an OAG Custom Document Type You now create a document type. The document definition of this document type becomes part of the callout usage you create later in this tutorial. 1. Click Partners, then Protocols, and then Custom Document over Internet. 2. Click Create in the Document Protocol Revisions section. 3. Enter the following details: Field Value Name OAG Note: This maps to a value in an enqueue script that you must create. Revision 4. 7.0 Click Apply. The Document Protocol Revision Details page appears. 5. Click Create in the Document Types section. 6. Enter the following details: Managing Callouts 11-17 Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction Details Field Value Name OAG PO Revision 7.0 Document Definition Field Value Name OAG_DocDef There are several document type parameters to use for integrating the OAG purchase order document with the XML Gateways. The first two document type parameter values enable the correct document type to be identified in the outbound direction. (A document type that has the document type parameter values specified for these two parameters is selected.) Document Type Parameters Field Value Description Outbound Process Type POPI TRANSACTION_TYPE value specified in the outbound SYSTEM.ECXMSG message structure Outbound Process SubType POPI TRANSACTION_SUBTYPE value specified in the outbound SYSTEM.ECXMSG message structure Inbound Process Type POPI For incoming messages, the value of this parameter is placed in the TRANSACTION_ TYPE field of the SYSTEM.ECXMSG message structure Inbound Process SubType POPI For incoming messages, the value of this parameter is placed in the TRANSACTION_ SUBTYPE field of the SYSTEM.ECXMSG message structure Inbound Party Code 3101 For incoming messages, the value of this parameter is placed in the PARTY_TYPE field of the SYSTEM.ECXMSG message structure Do not provide values for any of the following parameters: ■ OutboundPartyCode Not applicable for XML Gateway integration ■ IdentifyingXPath For an incoming REQUEST message, the value of this parameter is the xpath used when the DOCUMENT_NUMBER field is populated from the payload of the SYSTEM.ECXMSG message. ■ CorrelatingXPath For an incoming ACKNOWLEDGE message, the value of this parameter is the xpath used when the DOCUMENT_NUMBER field is populated from the payload of the SYSTEM.ECXMSG message. 7. Click Apply. You now associate this document type with the RosettaNet over RNIF business protocol. 11-18 Oracle Application Server Integration B2B User’s Guide Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction 8. Click Partners, then Protocols, and then RosettaNet over RNIF. 9. Click Details in the Process Protocol Revisions section. 10. Click Details for 3A4 in the Collaborations section. 11. Click Request Purchase Order in the Business Transaction section. 12. Click Purchase Order Request Action in the Requesting Action section. 13. Click Purchase Order Request Action in the Business Action section. 14. Click Add in the Document Types section. 15. Select OAG PO from the Document Type list. 16. Click Apply. The purchase order request action now includes the OAG purchase order document type. See "Integrations with Oracle E-Business Suite" on page 4-4 for details about the SYSTEM.ECXMGS message structure. Modify XML Gateway Settings Oracle E-Business Suite uses the XML Gateway Inbound and XML Gateway Outbound internal delivery channels. You now update these internal delivery channels with connection information appropriate to your environment. 1. Click Partners, then Trading Partners. 2. Click Acme (Host) in the Name column. 3. Click Capabilities at the top of the Trading Partner Details page. 4. Click XML Gateway Inbound in the Transport Server column of the Internal Delivery Channels section. 5. Click Update on the Transport Server Details page. 6. Enter details in the following fields that are appropriate to your environment: General Field Value Host Name your_host IP Address your_IP_address Username username Password password Transport Parameter Values Field Value port port_number sid database_sid 7. Click Update. 8. Click Return to List at the bottom of the page. 9. Click XML Gateway Outbound in the Transport Server column of the Internal Delivery Channels section. 10. Repeat Steps 5 through 7. Managing Callouts 11-19 Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction 11. If you changed the Username parameter in Step 6, you must also update the endpoint URIs for both XML Gateway internal delivery channels: a. Click Partners, then Trading Partners, and then Acme (Host). b. Click Capabilities at the top of the Trading Partner Details page. c. Click the RosettaNet over RNIF business protocol. d. Click Update for apps.ECX_OUTBOUND in the Endpoints section. e. Update the name to b2b.ECX_OUTBOUND. f. Click Update. g. Repeat Step 11d through Step 11f for the apps.ECX_INBOUND endpoint URI. Modify the XSLTCallout Settings 1. Click Partners, then Callouts. 2. Select XSLTCallout in the Name column. 3. Click Create in the Callout Usage section. 4. Enter the following details to create a callout usage that takes the OAG purchase order document definition and maps it to the RosettaNet PIP 3A4 purchase order request document. Field Value Source Document Definition OAG_DocDef Target Document Definition Pip3a4PurchaseOrderRequest 5. Click Apply. 6. Click Create in the Callout Metadata Parameter Values section. The Create Callout Metadata Parameter Value page appears. 7. Click the Use Existing Callout Property check box. 8. Enter the following details to create a callout metadata parameter value. Field Value Callout Property xsltFile Value Provide the complete directory path to the XSLT file that you create to transform the OAG purchase order document to a RosettaNet PIP 3A4 purchase order request (for example, named oag_po_to_3a4_req.xslt). 9. Click Apply. Create a Trading Partner Agreement 1. Follow the instructions in "Acme Server, Task 3: Creating the Trading Partner Agreement" on page 5-12 to create a trading partner agreement. Make the following selections: ■ ■ Select XML Gateway Outbound from the Internal Delivery Channel list. Select the associated OAG_DocDef -> Pip3A4PurchaseOrderRequest callout usage from the Callout Usage list. 11-20 Oracle Application Server Integration B2B User’s Guide Tutorial: Adding Callout Usages to the RosettaNet over the Internet Transaction Create and Deploy a Configuration 1. Follow the instructions in "Acme Server, Task 4: Creating and Deploying the Configuration" on page 5-12 to create and deploy a configuration. GlobalChips Server, Task 1: Performing the RosettaNet over RNIF Tutorial This tutorial assumes you have completed the RosettaNet over the Internet tutorial described in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction" on page 5-5. As part of that tutorial, you set up the GlobalChips server (seller), where GlobalChips was the host trading partner and Acme was the remote trading partner (buyer). On both servers, Acme was the buyer and GlobalChips was the seller. GlobalChips Server, Task 2: Setting Up Callout Usages Perform the following callout usage tasks on the GlobalChips server: ■ Create an OAG Custom Document Type ■ Modify XML Gateway Settings ■ Modify the XSLTCallout Settings ■ Create a Trading Partner Agreement ■ Create and Deploy a Configuration Create an OAG Custom Document Type 1. Follow the instructions in "Create an OAG Custom Document Type" on page 11-17 to create an OAG PO document type on the GlobalChips server. Modify XML Gateway Settings 1. Follow the instructions in "Modify XML Gateway Settings" on page 11-19 to modify the XML Gateway settings on the GlobalChips server. This time, select GlobalChips (Host) on the Trading Partners page. Modify the XSLTCallout Settings 1. Click Partners, then Callouts. 2. Select XSLTCallout in the Name column. 3. Click Create in the Callout Usage section. 4. Enter the following details to create a callout usage that takes the RosettaNet PIP 3A4 purchase order request document and maps it to the OAG purchase order document definition. Field Value Source Document Definition Pip3a4PurchaseOrderRequest Target Document Definition OAG_DocDef 5. Click Apply. 6. Click Create in the Callout Metadata Parameter Values section. The Create Callout Metadata Parameter Value page appears. 7. Click the Use Existing Callout Property check box. Managing Callouts 11-21 Common User Errors 8. Enter the following details to create a callout metadata parameter value. Field Value Callout Property xsltFile Value Provide the complete directory path to the XSLT file that you create to transform the RosettaNet PIP 3A4 purchase order request to an OAG purchase order document (for example, named 3a4_req_to_oag_ po.xslt). 9. Click Apply. Create a Trading Partner Agreement 1. Follow the instructions in "GlobalChips Server, Task 3: Creating the Trading Partner Agreement" on page 5-16 to create a trading partner agreement. Make the following selections: ■ ■ Select XML Gateway Inbound from the Internal Delivery Channel list. Select the associated Pip3A4PurchaseOrderRequest -> OAG_DocDef callout usage from the Callout Usage list. Create and Deploy a Configuration 1. Follow the instructions in "GlobalChips Server, Task 4: Creating and Deploying the Configuration" on page 5-17 to create and deploy a configuration. Common User Errors ■ ■ Do not include beginning or trailing blank spaces in the names of callout partner data that you create. Do not have two callouts with the same name and same implementation name. Summary This chapter describes how to use callouts to transform documents from one form to another. You can use callouts to invoke an XSLT style sheet and any Java program in general. For example, an incoming remote trading partner’s EDI document is sent to the host trading partner’s host Oracle E-Business Suite application, which uses XML. Callouts enable you to transform the EDI document into an XML format understood by the Oracle E-Business Suite application. The outgoing document can then be transformed back into its original format. Callouts are associated with internal delivery channels. This chapter also provides a tutorial that describes how to add callout usages to the RosettaNet over the Internet tutorial described in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction" on page 5-5. 11-22 Oracle Application Server Integration B2B User’s Guide 12 Creating and Managing Trading Partner Agreements This chapter describes the tasks required to create and manage a trading partner agreement between a host and remote trading partner. Both trading partners include support for a business protocol with operational and communication capabilities. This chapter contains the following topics: ■ Trading Partner Agreement Overview ■ Managing Trading Partner Agreements ■ Managing Trading Partner Agreement Participants ■ Managing Delivery Channels of Trading Partner Agreement Participants ■ Common User Errors ■ Summary See Chapter 15, "API for Creating Trading Partners and Agreements" for how to create trading partner agreements programmatically or through a command line utility. Trading Partner Agreement Overview The following sections provide an overview on creating a trading partner agreement: ■ What is A Trading Partner Agreement? ■ How Do You Create a Trading Partner Agreement? ■ Prerequisites to Creating a Trading Partner Agreement What is A Trading Partner Agreement? A trading partner agreement defines the behavior that trading partners agree to follow when engaging in a business transaction. A trading partner agreement consists of two trading partners: ■ Host trading partner ■ Remote trading partner A remote trading partner in an agreement includes support for a specific business protocol and its associated: ■ Support for a collaboration (the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocol). Trading Creating and Managing Trading Partner Agreements 12-1 Trading Partner Agreement Overview partners define their operational capabilities by the collaborations or business actions they support. ■ ■ Delivery channel, which defines details such as nonrepudiation, encryption, and transport security capabilities, as well as the document exchange and transport used (known in the OracleAS Integration B2B user interface as the communication capabilities) Trading partner identification type and value, such as a DUNS number The host trading partner also includes a delivery channel and trading partner identification type and value. However, the host trading partner does not include a specific business protocol and its associated support for a collaboration or business action. The host trading partner instead is automatically assigned support for all business protocols and associated collaborations and business actions included in OracleAS Integration B2B. You assign support for a business protocol and a collaboration or business action to a remote trading partner. The host trading partner is automatically assigned support for a business protocol and a collaboration or business action that are compatible with the selections for the remote trading partner. This action simplifies your user experience. Figure 12–1 shows the contents of a trading partner agreement. Figure 12–1 Trading Partner Agreement Trading Partner Agreement: Acme_3A4 Remote Trading Partner Host Trading Partner Acme Participant GlobalChips ** RosettaNet over RNIF Business Protocol RosettaNet over RNIF** Buyer-3A4-V02.00 Collaboration* (Operational Capabilities) Seller-3A4-V02.00** 123456789 Trading Partner Identification 372463489 Acme_DC Delivery Channel (Communication Capabilities) GlobalChips_DC * If the RosettaNet over RNIF business protocol is used, collaborations are part of the trading partner agreement. If any EDI or Custom Document business protocol is used, Business Actions are part of the trading partner agreement. ** Automatically included in the trading partner agreement. How Do You Create a Trading Partner Agreement? The OracleAS Integration B2B user interface enables you to perform the following tasks to create a trading partner agreement: ■ Select the remote trading partner ■ Select the business protocol support for the remote trading partner ■ Select support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocol) for the business protocol of the remote trading partner. Trading partners define their operational capability by the collaborations or business actions they support. You do not need to select support for the business protocol and a collaboration or business action for the host trading partner. Based on your selections for the remote trading partner, the host trading partner is automatically assigned details that are compatible with those of the remote trading partner. For example, if you 12-2 Oracle Application Server Integration B2B User’s Guide Trading Partner Agreement Overview select support for the RosettaNet over RNIF business protocol and Buyer - 3A4 V02.00 as the collaboration and role for the remote trading partner, the host trading partner is automatically assigned support for RosettaNet over RNIF as the business protocol and Seller - 3A4 - V02.00 as the collaboration and role. This simplifies your user experience. ■ ■ ■ ■ Select the trading partner identification types and delivery channels (communication capabilities) for both the remote and host trading partners Select the host trading partner internal delivery channel and (optionally) the callout usages Assign a required trading partner agreement name and identifier Assign optional details such as an agreement description, dates during which the agreement is active, invocation limit, and concurrent conversation limit Figure 12–2 shows the page for creating a trading partner agreement. Figure 12–2 Create Trading Partner Agreement Page Prerequisites to Creating a Trading Partner Agreement Ensure that you review and complete the prerequisites described in Table 12–1 before creating a trading partner agreement. Table 12–1 Prerequisites to Creating a Trading Partner Agreement Prerequisite See Section... Remote trading partner Creating and Managing Trading Partner Agreements 12-3 Managing Trading Partner Agreements Table 12–1 (Cont.) Prerequisites to Creating a Trading Partner Agreement Prerequisite ■ ■ ■ ■ See Section... Create a remote trading partner Assign support for a business protocol to the remote trading partner Chapter 9, "Creating Trading Partners" Assign support for a collaboration or business action (operational capabilities) and delivery channel (communication capabilities) to the business protocol of the remote trading partner Define a trading partner identification type for the remote trading partner or use the automatically created type of Name Chapter 9, "Creating Trading Partners" or "Creating Trading Partner Identification" on page 10-8 Host trading partner ■ ■ ■ ■ Define delivery channel (communication capabilities) for the host trading partner Chapter 9, "Creating Trading Partners" Define a trading partner identification type for the host trading partner or use the automatically created type of Name "Creating Trading Partner Identification" on page 10-8 Create internal delivery channels or use the predefined selections "Managing Internal Delivery Channels" on page 10-30 Create callout usages (optional) Chapter 11, "Managing Callouts" Managing Trading Partner Agreements The OracleAS Integration B2B user interface enables you to perform the trading partner agreement management tasks shown in Figure 12–3. The trading partner agreement defines the behavior that the host and remote trading partners agree to follow when engaging in a business transaction. These tasks are described in detail in this section. Figure 12–3 Trading Partner Agreement Management Tasks Table 12–2 identifies the trading partner agreement management tasks shown in Figure 12–3 and provides references to procedures for performing these tasks. Table 12–2 Trading Partner Agreement Management Tasks Page Elements 12-4 Management Task See Section... Shortcut section of Take a shortcut to create a remote Figure 12–3 trading partner (the host trading partner is automatically created) "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 Create button of Figure 12–3 Create a trading partner agreement "Creating a Trading Partner Agreement" on page 12-5 Name column of Figure 12–3 View details about a trading partner agreement "Viewing a Trading Partner Agreement" on page 12-8 Update column of Figure 12–3 Update a trading partner agreement "Updating a Trading Partner Agreement" on page 12-8 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Agreements Table 12–2 (Cont.) Trading Partner Agreement Management Tasks Page Elements Management Task See Section... Delete column of Figure 12–3 Delete a trading partner agreement "Deleting a Trading Partner Agreement" on page 12-9 Note: The state of the trading partner agreement displays in the State column of the Trading Partner Agreements page. (See Figure 12–3.) See "Viewing the State of Partner Data on the Details Pages" on page 2-11 for details about lifecycle states of trading partners and trading partner agreements. Creating a Trading Partner Agreement You create a trading partner agreement between the host trading partner and a remote trading partner. Follow these instructions to create a trading partner agreement: Note: You cannot create a trading partner agreement between more than two trading partners. 1. Click Partners, then Agreements, then Create or Partners, and then Create Trading Partner Agreement in the Shortcuts section. The Create Agreement screen appears. 2. Select a remote trading partner from the Trading Partner list. You must already have created a remote trading partner for one to display in this list. If you have not already done so, see "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 for instructions. The host trading partner is not available for selection; it is automatically included in the trading partner agreement and does not need to be selected. The page refreshes to display the Supported Business Protocol list. 3. Select a business protocol. You must have already assigned support for a business protocol to this remote trading partner for one to display in this list. If you have not already done so, see "Creating and Assigning All Capabilities During a Single Wizard Session" on page 9-9 for instructions. The page refreshes. The list that now displays immediately under the Supported Business Protocol list is based on the business protocol you selected. 4. Make a selection based on the business protocol type you selected. If You Selected... Then... RosettaNet over RNIF Select support for a collaboration from the Supported Collaboration list (for example, Buyer - 3A4 - V02.00). This is the collaboration you selected when you created this remote trading partner. The host trading partner is automatically assigned a collaboration that is compatible with your remote trading partner selection (for example, Seller - 3A4 - V02.00). Creating and Managing Trading Partner Agreements 12-5 Managing Trading Partner Agreements If You Selected... Then... Any EDI or Custom Document business protocol Select support for a business action from the Supported Business Actions list. This is the business action you selected when you created this remote trading partner. The host trading partner is automatically assigned a business action that is compatible with your remote trading partner selection. Note: You can select support for only one collaboration or business action at a time. To add additional collaborations or business actions to the agreement, you must first create the agreement, then click Add in the Trading Partner Participants section of the Agreement Details page. 5. Enter the following details to create a trading partner agreement. An asterisk (*) indicates a required field. Field Value Host/Trading Partner Both the host and remote trading partner appear in this section. ■ Trading Partner Identification * Select trading partner identification type values for both the host and remote trading partners. Both trading partners automatically include a default identification type called Name. You can also use one of the other predefined identification types (for example, a Data Universal Numbering System (DUNS)) or create your own identification type. See "Creating Trading Partner Identification" on page 10-8 for instructions on creating a trading partner identification type. ■ Trading Partner Delivery Channel * Select the delivery channels for both the host and remote trading partners. You must have already created delivery channels for both trading partners for selections to display in these lists. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel. Host Delivery Channel and Callout Usage ■ Internal Delivery Channel * Select the internal delivery channel to use for sending messages (for example, sending an outbound purchase order request from the host application of the host trading partner to the remote trading partner). This delivery channel communicates between the host trading partner’s host application and OracleAS Integration B2B. OracleAS Integration B2B includes four predefined internal delivery channels. You can also create your own. Note: The default internal delivery channel selection is sufficient for most environments. See "Managing Internal Delivery Channels" on page 10-30 for additional details about internal delivery channels. 12-6 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Agreements Field ■ Callout Usage Value If required, select a callout usage to use to transform the format of one message to another. This field is associated with the Internal Delivery Channel field. For example, if the internal delivery channel is used for sending an outbound purchase order request from the host application of the host trading partner to the remote trading partner, the callout usage translates the outbound purchase order request into a format understood by the remote trading partner. See "Managing Callouts" on page 11-3 for additional details about callouts and callout usages. ■ Responding Internal Delivery Channel If required, select the internal delivery channel to use for responding to (acknowledging) messages (for example, sending an inbound purchase order acceptance from the remote trading partner to the host application of the host trading partner). Note: This field appears if you selected Yes from the Is Acknowledgment Handled By Integration B2B? list when creating a remote trading partner on the Operational Capabilities page. Note: The default internal delivery channel selection is sufficient for most environments. See "Managing Internal Delivery Channels" on page 10-30 for additional details about responding internal delivery channels. ■ Responding Callout If required, select a responding callout usage to use to transform the Usage format of one message to another. This field is associated with the Responding Internal Delivery Channel field. For example, if the responding internal delivery channel is used for sending an inbound purchase order acceptance from the remote trading partner to the host application of the host trading partner, the callout usage translates the inbound purchase order acceptance into a format understood by the host application of the host trading partner. See "Managing Callouts" on page 11-3 for additional details about callouts and responding callout usages. Note: This field appears if you selected Yes from the Is Acknowledgment Handled By Integration B2B? list when creating a remote trading partner on the Operational Capabilities page. General - ■ Name * Enter a unique and recognizable name for the trading partner agreement. ■ Agreement Id * Enter a unique agreement identifier. ■ Description Enter a description for the trading partner agreement. ■ Effective From Date Select the calendar icon to enter an agreement beginning date. If no date is specified, the agreement is always effective. ■ Effective To Date Select the calendar icon to enter an agreement ending date. If no date is specified, the agreement is always effective. ■ Invocation Limit Enter a value for the maximum number of times the collaboration or business action can be invoked. If you do not enter a value, there is no limit on the number of invocations. Concurrent Conversations Enter a value for the maximum number of concurrent business actions or collaborations that can be in progress. ■ 6. Click Apply. The trading partner agreement is created and the Agreement Details page appears. The host trading partner is automatically assigned a collaboration or business action that is compatible with that assigned to the remote trading partner. For Creating and Managing Trading Partner Agreements 12-7 Managing Trading Partner Agreements example, if remote trading partner support is for collaboration Buyer - 3A4 V02.00, the host trading partner is automatically assigned collaboration Seller 3A4 - V02.00. 7. Click Validate. If successful, the message agreement_name Agreement is valid appears at the top. See the following for more information: ■ "Managing Internal Delivery Channels" on page 10-30 ■ "Managing Callouts" on page 11-3 Viewing a Trading Partner Agreement Follow these instructions to view details about a specific trading partner agreement: 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement to view in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. View specific details, including the following: ■ ■ The agreement ID, agreement description, dates during which the agreement is active, invocation limit, number of concurrent conversations, and agreement state (in the Details section) The host and remote trading partners in this agreement (known as participants in the OracleAS Integration B2B user interface) and their associated support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocols). See Figure 12–4 on page 12-10 for an example of an Agreement Details page. This page, as with the Trading Partner Agreements page shown in Figure 12–3 on page 12-4, enables you to delete or update a trading partner agreement. Depending on the current state of an agreement (which displays in the State field of the Details section), different buttons and additional sections can also display. If the state is Approved or Deployed, no button displays. The Export button also displays on the Agreement Details page. This button enables you to export your partner data to an XML file. You can then submit this file for review to applicable trading partners in a trading partner agreement to ensure that it is correct. 4. Click Return to List to return to the Trading Partner Agreements page. See the following for more information: ■ ■ "Viewing the State of Partner Data on the Details Pages" on page 2-11 for details about the states (such as Draft) that display on agreement details pages "Exporting Partner Data to an XML File" on page 2-9 for details about the Export button Updating a Trading Partner Agreement Follow these instructions to update a trading partner agreement: 1. 12-8 Click Partners, then Agreements. Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Agreement Participants 2. Select a specific trading partner agreement to update in the Update column. The Update Agreement page appears. 3. Make appropriate updates. An asterisk (*) indicates a required field. Field Value Name * Update with a unique and recognizable name for the trading partner agreement. Agreement Id * Update the agreement identifier. Description Update the description for the trading partner agreement. Effective From Date Select the calendar icon to update an agreement beginning date. If no date is specified, the agreement is always effective. Effective To Date Select the calendar icon to update an agreement ending date. If no date is specified, the agreement is always effective. Invocation Limit Update the value for the maximum number of times the collaboration or business action can be invoked. If you do not enter a value, there is no limit on the number of invocations. Concurrent Conversations Update the value for the maximum number of concurrent business actions or collaborations that can be in progress. 4. Click Apply. The agreement is updated and the Agreement Details page appears. Deleting a Trading Partner Agreement Follow these instructions to delete a trading partner agreement: 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement to delete in the Delete column. 3. Click Yes when prompted to delete a trading partner agreement. The trading partner agreement is deleted and the Trading Partner Agreements page appears. Managing Trading Partner Agreement Participants The OracleAS Integration B2B user interface enables you to perform the trading partner agreement participant management tasks shown in Figure 12–4. Participants are the host and remote trading partners that you assigned to the trading partner agreement in "Creating a Trading Partner Agreement" on page 12-5. These tasks are described in detail in this section. Creating and Managing Trading Partner Agreements 12-9 Managing Trading Partner Agreement Participants Figure 12–4 Trading Partner Agreement Participant Management Tasks Table 12–3 identifies the trading partner agreement participant management tasks shown in Figure 12–4 and provides references to procedures for performing these tasks. Table 12–3 Trading Partner Agreement Participant Management Tasks Page Elements Management Task See Section... Add button in Trading Partner Participants section of Figure 12–4 Add additional identification and operational and communication capabilities to trading partner agreement participants "Adding Identifications and Operational and Communication Capabilities to Trading Partner Agreement Participants" on page 12-10 Name column in Trading Partner Participants section of Figure 12–4 View details about a trading partner agreement participant "Viewing a Trading Partner Agreement Participant" on page 12-11 Update column in Trading Partner Participants section of Figure 12–4 Update a trading partner agreement participant "Updating a Trading Partner Agreement Participant" on page 12-12 Remove column in Trading Partner Participants section of Figure 12–4 Remove a trading partner agreement "Removing a Trading participant Partner Agreement Participant" on page 12-13 Adding Identifications and Operational and Communication Capabilities to Trading Partner Agreement Participants You can add additional trading partner identifications, support for business protocols and a collaboration or business action (operational capabilities), and delivery channels (communication capabilities) to trading partners in this agreement. 12-10 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Agreement Participants Follow these instructions to add additional identifications and operational and communication capabilities to trading partners in a trading partner agreement. 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Click Add in the Trading Partner Participants section. The Add Trading Partner Participant page appears. 4. Select a business protocol from the Supported Business Protocol list. The page refreshes to display additional fields. 5. Make an appropriate selection from the Supported Collaboration list (if your business protocol selection is RosettaNet over RNIF) or the Supported Business Action list (if your business protocol selection is any EDI or Custom Document protocol). 6. Enter the following details: Field Value Host/Trading Partner Both the host and remote trading partner appear in this section. ■ Trading Partner Identification Select trading partner identification type values for both the host and remote trading partners. The host and remote trading partners automatically include a default identification type called Name. You can also create your own identification type. See "Creating a Trading Partner Identification Type" on page 17-4 for instructions on creating a trading partner identification type. ■ Trading Partner Delivery Channel Select the delivery channels for both the host and remote trading partners. You must have already created delivery channels for both trading partners for selections to display in these lists. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel. 7. Click Apply. The trading partner agreement participant details are updated and the Trading Partner Participant Details page appears. Note: If you change the support for a collaboration or business action associated with a remote trading partner, the host trading partner automatically adjusts to support a collaboration or business action that is compatible with the remote trading partner. This simplifies your user experience. Viewing a Trading Partner Agreement Participant Follow these instructions to view details about a specific trading partner agreement participant: 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. Creating and Managing Trading Partner Agreements 12-11 Managing Trading Partner Agreement Participants 3. Select a specific trading partner participant to view in the Name column of the Trading Partner Participants section. The Trading Partner Participant Details page for the selected trading partner agreement participant appears. 4. View specific details about the identification value and support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocol). You can also view and manage (add, remove, and update) the delivery channel associated with this trading partner agreement participant. See Figure 12–5 on page 12-13 for an example of the Trading Partner Participant Details page. 5. Click Return to List to return to the Agreement Details page for the selected trading partner agreement. Updating a Trading Partner Agreement Participant Follow these instructions to update the trading partner identification, delivery channel, internal delivery channel, and callout usage of a trading partner agreement participant. 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Select a specific trading partner participant to update in the Update column of the Trading Partner Participants section. The Update Trading Partner Participant page appears. 4. Make appropriate updates. Field Value Host/Trading Partner Both the host and remote trading partner appear in this section. ■ Trading Partner Identification Update the trading partner identification type values for both the host and remote trading partners. Both trading partners include a default identification type called Name that is automatically included with OracleAS Integration B2B. You can also create your own identification type. See "Creating a Trading Partner Identification Type" on page 17-4 for instructions on creating a trading partner identification type. ■ Trading Partner Delivery Channel Update the delivery channels for both the host and remote trading partners. You must have already created delivery channels for both trading partners for selections to display in these lists. See Chapter 9, "Creating Trading Partners" for instructions on creating a delivery channel. Host Delivery Channel and Callout Usage ■ ■ Internal Delivery Channel Update the internal delivery channel of the host trading partner. Callout Usage Update the callout usage associated with the internal delivery channel of the host trading partner. See Step 5 on page 12-6 for a description of internal delivery channels. See Step 5 on page 12-6 for a description of callout usages. 12-12 Oracle Application Server Integration B2B User’s Guide Managing Delivery Channels of Trading Partner Agreement Participants Field ■ ■ Value Responding Internal Delivery Channel Update the responding internal delivery channel of the host trading partner. Responding Callout Usage Update the responding callout usage associated with the responding internal delivery channel of the host trading partner. See Step 5 on page 12-6 for a description of responding internal delivery channels. See Step 5 on page 12-6 for a description of responding callout usages. 5. Click Apply. The trading partner agreement participant is updated and the Trading Partner Participant Details page appears. Removing a Trading Partner Agreement Participant Follow these instructions to remove a remote trading partner agreement participant. You cannot remove the host trading partner participant. 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Select a specific trading partner participant to remove in the Remove column of the Trading Partner Participants section. 4. Click Yes when prompted to remove a trading partner agreement participant. The trading partner agreement participant is removed and the Agreement Details page appears. A trading partner agreement requires two trading partners (the host trading partner and a remote trading partner) as participants. If your agreement includes less than two participants, you must add the necessary number of trading partners. Managing Delivery Channels of Trading Partner Agreement Participants The OracleAS Integration B2B user interface enables you to perform the delivery channel management tasks shown in Figure 12–5. These tasks are described in detail in this section. The delivery channel describes security characteristics such as nonrepudiation of origin and receipt, acknowledgment mode, time to acknowledge, retry count, transport security, encryption, and file compression. Document exchange and transport details are also assigned to a delivery channel. Figure 12–5 Delivery Channel Management Tasks Creating and Managing Trading Partner Agreements 12-13 Managing Delivery Channels of Trading Partner Agreement Participants Table 12–4 identifies the delivery channel management tasks shown in Figure 12–5 and provides references to procedures for performing these tasks. Table 12–4 Delivery Channel Management Tasks Page Elements Management Task See Section... Add button in Delivery Channels Used section of Figure 12–5 Add a delivery channel to a trading partner agreement participant "Adding a Delivery Channel to a Trading Partner Agreement Participant" on page 12-14 Name column in Delivery Channels Used section of Figure 12–5 View details about a delivery channel of a trading partner agreement participant "Viewing a Delivery Channel of a Trading Partner Agreement Participant" on page 12-14 Update column in Delivery Channels Used section of Figure 12–5 Update a delivery channel of a trading partner agreement participant "Updating a Delivery Channel of a Trading Partner Agreement Participant" on page 12-15 Remove column in Delivery Channels Used section of Figure 12–5 Remove a delivery channel from a trading partner agreement participant "Removing a Delivery Channel from a Trading Partner Agreement Participant" on page 12-16 See Chapter 9, "Creating Trading Partners" for procedures on creating a delivery channel. Adding a Delivery Channel to a Trading Partner Agreement Participant If you previously removed a delivery channel from a trading partner participant in an agreement, you can add a new delivery channel. You can also use this page to change the delivery channel used by a trading partner participating in an agreement. Follow these instructions to perform either of these tasks. 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section. The Trading Partner Participant Details page for the selected trading partner agreement participant appears. 4. Click Add in the Delivery Channels Used section. The Add Participant Delivery Channel page appears. 5. Select a delivery channel from the Delivery Channel list. 6. Click Apply. The delivery channel is added and the Participant Delivery Channel Details page appears. Viewing a Delivery Channel of a Trading Partner Agreement Participant Follow these instructions to view details about a delivery channel of a trading partner agreement participant: 12-14 Oracle Application Server Integration B2B User’s Guide Managing Delivery Channels of Trading Partner Agreement Participants 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section. The Trading Partner Participant Details page appears. 4. Select a specific delivery channel to view in the Name column of the Delivery Channels Used section. The Participant Delivery Channel Details page for the selected delivery channel appears. 5. View specific details about the document exchange and transport associated with this delivery channel, and the status of acknowledgment mode, global usage code, nonrepudiation of receipt, nonrepudiation of origin, encryption, transport security, time to acknowledgment value, and retry count value. This page, as with the Trading Partner Participant Details page shown in Figure 12–5 on page 12-13, enables you to remove or update the delivery channel of the selected trading partner agreement participant. 6. Click Return to List to return to the Trading Partner Participant Details page. 7. Click Return to List to return to the Agreement Details page. Updating a Delivery Channel of a Trading Partner Agreement Participant Follow these instructions to update a delivery channel of a trading partner agreement participant: 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section. The Trading Partner Participant Details page for the selected trading partner agreement participant appears. 4. Select a specific delivery channel to update in the Update column of the Delivery Channels Used section. The Update Participant Delivery Channel page appears. 5. Select a delivery channel from the Delivery Channel list. 6. Click Apply. The trading partner agreement participant is updated and the Trading Partner Participant Details page appears. 7. Click Return to List to return to the Agreement Details page. Creating and Managing Trading Partner Agreements 12-15 Common User Errors Removing a Delivery Channel from a Trading Partner Agreement Participant Note: If you remove a delivery channel and add a new one to a trading partner participant, any internal delivery channel and responding internal delivery channel in the trading partner agreement are also removed. To re-add these channels, click Update in the Trading Partner Participants section of the Agreement Details page. Follow these instructions to remove a delivery channel from a trading partner agreement participant: 1. Click Partners, then Agreements. 2. Select a specific trading partner agreement in the Name column. The Agreement Details page for the selected trading partner agreement appears. 3. Select a specific trading partner participant in the Name column of the Trading Partner Participants section. The Trading Partner Participant Details page for the selected trading partner agreement participant appears. 4. Select a specific delivery channel to remove in the Remove column of the Delivery Channels Used section. 5. Click Yes when prompted to remove a trading partner delivery channel. The delivery channel is removed and you are returned to the Trading Partner Participant Details page. You can add this delivery channel again at a later time. Common User Errors 1. You cannot create a trading partner agreement if you did not perform all of the following tasks: ■ ■ ■ Created a remote trading partner Assigned support for a business protocol and a collaboration or business action (operational capabilities) to the remote trading partner Created delivery channels for both the host and remote trading partners (communication capabilities) 2. You cannot delete a remote trading partner in a trading partner agreement that is in a draft, approved, or deployed state. You must first delete the trading partner agreement. 3. If you are using a business protocol with a generic exchange, you must select None from the Acknowledgment Mode list when creating the delivery channel for the trading partner. If you select Sync or Async, validation fails when creating a configuration. 4. Do not include beginning or trailing blank spaces in the names of trading partner agreement partner data that you create. Summary This chapter describes how you create a trading partner agreement to which you assign the remote trading partner as a participant. The host trading partner is 12-16 Oracle Application Server Integration B2B User’s Guide Summary automatically assigned to the agreement. You also assign support for a business protocol and support for a collaboration (for the RosettaNet over RNIF business protocol) or business action (for any EDI or Custom Document business protocols) to the remote trading partner. The host trading partner is automatically assigned a business protocol and a collaboration or business action that are compatible with the remote trading partner. For example, if the remote trading partner is using the RosettaNet over RNIF business protocol with collaboration and role Buyer - 3A4 V02.00, the host trading partner is automatically assigned the RosettaNet over RNIF business protocol with collaboration and role Seller - 3A4 - V02.00. You also assign a trading partner identification type and a delivery channel to both trading partners. Internal delivery channels and callout usages can also be assigned. Creating and Managing Trading Partner Agreements 12-17 Summary 12-18 Oracle Application Server Integration B2B User’s Guide 13 Creating and Deploying a Configuration This chapter describes how to create and deploy a configuration consisting of at least one trading partner agreement between two trading partners. Complete the following tasks before performing the procedures described in this chapter: ■ Create or import support for RosettaNet collaborations, EDI X12 or EDI EDIFACT transaction sets (business actions), or UCCnet standards ■ Create a remote trading partner ■ Assign support for a business protocol to the remote trading partner ■ ■ ■ Create operational and communication capabilities for the business protocol of the remote trading partner Create communication capabilities for the business protocol of the host trading partner Create and validate a trading partner agreement between the host and remote trading partners See Chapter 8, "Managing Business Protocols" through Chapter 12, "Creating and Managing Trading Partner Agreements" for instructions on performing these tasks. This chapter contains the following topics: ■ Configuration Overview ■ Creating a Configuration ■ Deploying a Configuration ■ Viewing a Configuration ■ Quiescing a Configuration ■ Discarding a Configuration ■ Exporting a Configuration ■ Common User Errors ■ Summary Configuration Overview This section contains these topics: ■ What Is a Configuration? Creating and Deploying a Configuration 13-1 Configuration Overview ■ Configuration Creation Overview What Is a Configuration? A configuration consists of a complete, validated, and consistent set of one or more validated trading partner agreements in OracleAS Integration B2B. A configuration enables trading partner agreements to pass from the design phase to the deployment phase. Creating a configuration means you intend to deploy the trading partner agreements that have been created. Deployment of a configuration results in OracleAS Integration B2B being ready to honor and enforce actual business as designed in the trading partner agreement. Configuration Creation Overview You must use the OracleAS Integration B2B user interface to perform the following configuration tasks: 1. Create and validate a configuration of partner data consisting of at least one validated trading partner agreement between trading partners. Each trading partner agreement consists of the host and remote trading partners, which consist of the collaborations or business actions being exchanged. Delivery channels are used to send the collaborations or business actions between the trading partners. When you create a configuration, the integrity of the trading partner agreement and the trading partner data is validated to ensure that it is consistent and complete. If validation is successful, the configuration is created. You must deploy or discard the configuration immediately, and not leave it in a validated state. Until you deploy the configuration, you cannot update or create any additional operational capability for the trading partner in the agreement. An option is also available for exporting the partner data of the configuration to an XML file. 2. Deploy the configuration consisting of at least one trading partner agreement from the design-time repository to the runtime repository. You cannot deploy the same trading partner agreement in multiple configurations. Multiple, active configurations can run simultaneously if each has a different trading partner agreement. Any currently running configuration with the same trading partner agreement is automatically quiesced (gracefully shut down). You can also manually quiesce a deployed configuration or export the partner data of the deployed configuration to an XML file. Figure 13–1 shows the life of a configuration. 13-2 Oracle Application Server Integration B2B User’s Guide Creating a Configuration Figure 13–1 Life of a Configuration Validated Agreement Create Configuration Validated Configuration Deploy Active Configuration Redeploy Quiesce Quiesced Configuration Retire Retired Configuration Purge See "Common User Errors" for a review of common user errors to avoid before creating and deploying a configuration. Creating a Configuration Follow these instructions to create a configuration: 1. Click Deployment. The Configuration page appears. The Current Configurations section displays all current configurations and their state. The Retired and Discarded Configurations section (which must be expanded) displays all retired or discarded configurations and their associated trading partner agreements. Creating and Deploying a Configuration 13-3 Creating a Configuration 2. Expand the Retired and Discarded Configurations navigation tree. Any configurations that you previously discarded or retired appear. The Last Update column in both sections displays the time at which a specific action was performed with this configuration (for example, the time at which it was deployed or validated). The Action column in both sections provides a shortcut for performing the next most likely action with this configuration. For example, if the state is Active, your next most likely action is Quiesce. If the state is Validated, your next most likely action is Deploy. Note: Only approved trading partner agreements can be included in the deployment unit and, therefore, in the configuration. The current state of a configuration displays in the State column of the Current Configurations section: State Description Validated The partner data has been successfully validated to ensure that it is correct and complete and a configuration has been created. The configuration is ready for deployment. Only valid configurations can exist; invalid configurations cannot be created. Warning: Do not leave a configuration in a validated state. This causes errors when you create other configurations. Deploy or discard the configuration. 13-4 Active The trading partner agreement included in the configuration is available for execution of business in the OracleAS Integration B2B runtime repository. Messages are accepted based on your design in the trading partner agreement and processed accordingly. Quiesced The configuration is in the process of being quiesced (gracefully shut down). Once quiesced, the configuration can be redeployed or retired. Oracle Application Server Integration B2B User’s Guide Creating a Configuration The state of retired and discarded configurations displays in the State column of the Retired and Discarded Configurations section: State Description Discarded A configuration has been discarded and cannot be deployed. These types of configurations were validated, but never deployed. The trading partner agreement is also listed. Retired A deployed configuration has been retired and cannot be redeployed. 3. Click Create. The Create Configuration page appears. 4. Enter a unique and recognizable name for the configuration in the Configuration Name field. A configuration name can be no more than 30 characters in length. If you enter a previously used name for a configuration that is currently deployed or has been discarded, you receive an error and are prompted to enter a different name. 5. Select at least one trading partner agreement to include in this configuration from the Agreement list. If there is no approved trading partner agreement, the Apply button is disabled. 6. Click Apply. A page displays a message indicating that a configuration is being created, built, and validated to ensure correctness and completeness of the partner data. Configuration creation can take some time based on the complexity of your partner data. A second user accessing the same OracleAS Integration B2B user interface on another host can also view configuration creation progress. The second user sees a message stating that configuration creation is in progress. A View Status link appears that takes the second user to a configuration creation progress page. 7. See the following section based on whether or not configuration creation is successful: If Configuration Creation Is... See Section... Successful "Successful Configuration Creation and Validation" on page 13-5 Unsuccessful "Unsuccessful Configuration Creation and Validation" on page 13-6 Note: Do not leave a configuration in a validated state. Either deploy or discard the configuration. Successful Configuration Creation and Validation If configuration creation and validation are successful, the following message displays at the top of the page: Creation and validation of configuration name successful where name is the configuration name you entered in Step 4 of "Creating a Configuration" on page 13-5. Creating and Deploying a Configuration 13-5 Deploying a Configuration The Deployment page displays Validated in the State column for the configuration. You must deploy or discard the configuration immediately, and not leave it in a validated state. At this point, you cannot update or delete the following partner data in a successfully created and validated configuration: ■ Trading partner agreements ■ Trading partners You receive an error if you attempt to make changes. If you must make changes, first deploy or discard the configuration. Unsuccessful Configuration Creation and Validation If configuration creation and validation are unsuccessful, the Validation Results page displays an error. Perform the following steps: 1. See the user interface ui.log file in the Oracle_Home/ip/log/ui/ directory for specific details about the on-screen error. 2. If you want to create a record of the onscreen errors, use the Save As option of your Web browser or click the Deployment tab. Clicking the Deployment tab creates a View Errors link to these configuration errors from the main Deployment tab page. 3. If you do not want to create a record of the onscreen errors, click Discard Errors. You cannot return to this page. Deploying a Configuration This section contains these topics: ■ Configuration Deployment Overview ■ Deploying a Validated Configuration Configuration Deployment Overview Configuration deployment consists of deploying the designed and validated trading partner agreement and the corresponding set of trading partner data to the runtime repository. Only one active configuration with the same trading partner agreement is permitted at any given time. Deployment of a new configuration with the same trading partner agreement results in the quiescing of the old, currently running configuration. Multiple, active configurations can run simultaneously if each has a different trading partner agreement. A configuration accepts only noninitiating messages during quiescing. This lets the ongoing business complete processing in accordance with the old configuration. After all messages in a quiescing configuration are processed, the configuration is shut down. After the old configuration is shut down, the new configuration becomes active. You can redeploy or retire the old configuration. 13-6 Oracle Application Server Integration B2B User’s Guide Deploying a Configuration Note: If the partner data of a trading partner in a currently deployed configuration changes (for example, the host trading partner now uses a wallet password) and that trading partner is also part of a second configuration being deployed, the initial configuration is quiesced and automatically restarted to include the change. Deploying a Validated Configuration Only configurations that were successfully validated and created can be deployed. To deploy a configuration: 1. Click Deployment. 2. Deploy the configuration in either of two ways. Only configurations whose current status displays as Validated in the State column of the Current Configurations section can be deployed. a. Click Deploy in the Action column for the configuration you want to deploy. or a. Select a specific configuration to deploy in the Name column. The Configuration Details page for the selected configuration appears. b. Click Deploy. The Deployment page appears. 3. Click Apply. The Deploying Configuration page appears and displays deployment progress. 4. Click Deploy to continue with deployment. You can also click Cancel to cancel deployment. A second user accessing the same OracleAS Integration B2B user interface on another host can also view deployment progress. The second user sees a message stating that deployment is in progress. A View Status link appears that takes the second user to a deployment progress page. Only one configuration with the same trading partner agreement can be active at a time. Therefore, any currently running configuration is automatically quiesced and shut down. If deployment is successful, the Deployment page displays the Last Update field with the date at which the configuration was deployed. The State column status for the newly deployed configuration changes to Active and the Action column status changes to Quiesce. Creating and Deploying a Configuration 13-7 Viewing a Configuration Deployment can be unsuccessful. For example, system errors or out-of-memory errors can cause deployment to fail. You can now manage and create reports about your deployed configuration. See Chapter 19, "Creating Reports" for more information. Redeploying a Configuration If you make a design-time data change (for example, a change in the XPath expression) and redeploy the configuration, but subsequently do not see your changes reflected in the design-time data, then restart the B2B server as follows: opmnctl restartproc process-type=B2BServer Viewing a Configuration You can view details about the status of a specific configuration. Follow these instructions to view details about a configuration: 1. Click Deployment. 2. Select a specific configuration to view in the Name column of the Current Configurations section or the Retired and Discarded Configurations section. The Configuration Details page for the selected configuration appears. 3. View specific details, including the following: ■ ■ 13-8 The configuration name, description, date of last update, state, and whether it can be redeployed The trading partner agreement name and state included in this configuration. The following types of states can appear in the State column: State Description Validated The trading partner agreement is part of a configuration that has been successfully validated to ensure that it is correct and complete and a configuration has been created. The configuration is now ready for deployment. Deployed The trading partner agreement is part of a configuration that has been successfully deployed to the runtime repository. Draft The trading partner agreement has been modified after it was part of a discarded or deployed configuration. Oracle Application Server Integration B2B User’s Guide Discarding a Configuration Depending upon the current state of the configuration, different buttons can appear. For example, if the configuration is deployed, Quiesce and Export buttons appear. If the configuration is validated, Deploy, Discard, and Export buttons can appear. 4. Click Return To List to return to the Deployment page. Quiescing a Configuration You can manually quiesce (gracefully shut down) a deployed configuration. Once quiesced, the configuration can be redeployed or retired. In addition, a currently deployed configuration is automatically quiesced when you attempt to deploy a second configuration with the same trading partner agreement. Follow these instructions to quiesce a configuration. 1. Click Deployment. 2. Quiesce the configuration in either of two ways. Only configurations whose current status displays as Active in the State column of the Current Configurations section can be quiesced. a. Click Quiesce in the Action column for the configuration you want to quiesce. or a. Select a specific configuration to quiesce in the Name column of the Current Configurations section. The Configuration Details page for the selected configuration appears. b. Click Quiesce. The configuration is quiesced and now displays in the Retired and Discarded Configurations section of the Deployment page. The status of the configuration displays as Discarded in the State column. A quiesced configuration can be redeployed or retired. Discarding a Configuration Discarded configurations are validated configurations that were never deployed. You can discard a configuration that is no longer needed or because you want to change the partner data included in the configuration. Follow these instructions to discard a configuration: 1. Click Deployment. 2. Select a specific configuration to discard in the Name column of the Current Configurations section. Only configurations whose current status displays as Validated in the Status column of the Current Configurations section can be discarded. The Configuration Details page for the selected configuration appears. 3. Click Discard. The configuration is discarded and is no longer available for deployment. The configuration now displays in the Retired and Discarded Configurations section of the Deployment page. The status of the configuration displays as Discarded in the State column. Creating and Deploying a Configuration 13-9 Exporting a Configuration Exporting a Configuration Caution: Do not manually edit exported files. If you do so, OracleAS Integration B2B cannot guarantee their integrity. Note: Do not export a configuration using Microsoft Internet Explorer with an HTTPS URL. You receive an error if you attempt to perform this action. See issue 812935 at support.microsoft.com for additional details. Use Mozilla or Netscape to export a configuration with an HTTPS URL. You can export the partner data that comprises a configuration to an XML file. To access the page for exporting a configuration, a successfully validated configuration must exist. For configurations that use HTTPS or digital signature and encryption, the wallet password of the host trading partner is not included as part of the export file. This is because a wallet is specific to each computer. Therefore, you must re-create the wallet password for the host trading partner, this time for the target of your export. The wallet and the wallet password must be identical to the first wallet and wallet password. This applies only to the host trading partner. See "Creating a Host Trading Partner Wallet Password" on page 10-15 for more information. To export a configuration to an XML file: 1. Click Deployment. 2. Select a specific configuration to export in the Name column of the Current Configurations or the Retired and Discarded Configurations section. The Configuration Details page for the selected configuration appears. 3. Click Export. 4. Specify a directory in which to save this configuration (automatically named export.xml) when prompted. Export can take some time based on the size of the configuration. You can later reimport the partner data that comprises a configuration as follows: a. Click Administration, then Management. b. Click Browse to access the file to import. c. Select the file. d. Click Import. The partner data that comprises the configuration is reimported, but the configuration is not re-created. You must first validate the trading partner agreement of the configuration, and then re-create the configuration. See "Exporting and Importing the Design-Time Repository" on page 17-5 for details about importing a configuration. Common User Errors The following are common deployment user errors: 13-10 Oracle Application Server Integration B2B User’s Guide Summary ■ ■ Ensure that any trading partner agreement that you create is part of a completely created, end-to-end integration of partner data. This is because when you create a configuration, the trading partner agreement and its deployable units are included in the configuration. Do not deploy two trading partner agreements in which the same two trading partners perform the same collaborations or business actions. For example, the following trading partner details are defined in two separate agreements. This action in two separate agreements causes run-time errors to occur. – Host trading partner Acme uses the collaboration role Buyer - 3A4 - V02.00 – Remote trading partner GlobalChips uses the collaboration role Seller - 3A4 V02.00 Do not do this even if the agreements have different names, different agreement IDs, and are included in different configurations. ■ ■ ■ ■ ■ ■ ■ Ensure that all endpoints exist and are accessible before creating a configuration. Ensure that all endpoints are properly updated as you move to and from the development, test, and production phases. A configuration name can be no more than 30 characters in length. If you enter a previously used name for a configuration that is currently deployed or has been discarded, you receive an error and are prompted to enter a different name. Do not manually edit exported files. If you do so, OracleAS Integration B2B cannot guarantee their integrity. Do not include beginning or trailing blank spaces in the names of configuration partner data that you create. Do not leave a configuration in a validated state. This causes errors when you create other configurations. Deploy or discard a configuration immediately. You cannot update or delete the following partner data in a successfully created and validated configuration: ■ Trading partner agreements ■ Trading partners The following are best-practice recommendations: ■ Purge all retired configurations. However, purging a retired configuration removes the associated run-time data. Oracle recommends that you do a database archive of run-time data before purging. Summary This chapter describes how to create and deploy a configuration (the complete, validated, and consistent set of partner data). It also describes how to quiesce configurations, discard configurations, and export configurations to an XML file. Creating and Deploying a Configuration 13-11 Summary 13-12 Oracle Application Server Integration B2B User’s Guide Part IV Using Scripts and Utilities This part describes how to do various tasks using scripts and utilities that are provided in OracleAS Integration B2B. This part contains the following chapters: ■ Chapter 14, "Batching and Debatching EDI Transaction Sets" ■ Chapter 15, "API for Creating Trading Partners and Agreements" ■ Chapter 16, "Utilities for Enqueuing and Dequeuing" 14 Batching and Debatching EDI Transaction Sets Inbound messages to OracleAS Integration B2B are automatically debatched. Individual transactions are sent to the internal delivery channel one transaction at a time. For outbound messages received on the internal delivery channel, transaction sets can be batched based on criteria that you specify. This chapter contains the following topics: ■ EDI Batching ■ EDI Batching Examples EDI Batching To enable outbound batching, you must update the B2B_BATCH_EVENT table, shown in Table 14–1. Table 14–1 B2B_BATCH_EVENT Table Name Null? Type Description ID not null VARCHAR2(256) Randomly generated uuid EXPIRE_TIME - DATE Date and time when batching occurs INTERVAL - NUMBER(38) Time interval for the next batching to occur (in minutes) TOTPNAME - VARCHAR2(256) Trading partner to whom the batch file is sent DOCTYPE - VARCHAR2(256) Document type, such as ORDERS for EDIFACT or 850 for EDI X12 DOCTYPEREV - VARCHAR2(256) Document type revision, such as D98A or 4010 MSGCOUNT - NUMBER(38) Not used; defaults to 1 STATE - NUMBER(38) Not used; defaults to 1 ENABLE - NUMBER(38) 1 indicates that batching is enabled. 0 indicates that batching is disabled. CRITERIA1 - VARCHAR2(256) Used for full batching support. The following options are supported: ■ X12_ONE_TP ■ X12_ALL_TP ■ EFT_ONE_TP ■ EFT_ALL_TP Batching and Debatching EDI Transaction Sets 14-1 EDI Batching Examples Table 14–1 (Cont.) B2B_BATCH_EVENT Table Name Null? Type Description CRITERIA2 - VARCHAR2(256) Not used CRITERIA3 - VARCHAR2(256) Not used CRITERIA4 - NUMBER(38) Not used CRITERIA5 - NUMBER(38) Not used EDI Batching Examples The following examples show how to batch the document type ORDERS, revision D98A, to the trading partner named GlobalChips. The examples follow the scenario described in the EDI EDIFACT tutorial. TOTPName, DocType, and DocTypeRev in the following example are used in the tutorial. See"Tutorial 2: Setting Up an EDI EDIFACT over Generic (VAN) Transaction" on page 5-18 for more information. To batch DOCTYPE ORDERS revision D98A to GlobalChips (the trading partner) at 3 pm every day: SQL> insert into B2B_BATCH_EVENT values ((select sys_guid() from dual), to_date(’Fri 03-Dec-2004 15:00:00’, ’Dy DD-Mon-YYYY HH24:MI:SS’), 1440, ’GlobalChips’, ’ORDERS’, ’D98’, 1,1,1, null,null,null,null,null); To batch DOCTYPE ORDERS revision D98A to GlobalChips (the trading partner) every hour starting on Friday, December 3, 2004 at 15:00:00: SQL> insert into B2B_BATCH_EVENT values ((select sys_guid() from dual), to_date(’Fri 03-Dec-2004 15:00:00’, ’Dy DD-Mon-YYYY HH24:MI:SS’), 60, ’GlobalChips’, ’ORDERS’, ’D98’, 1,1,1, null,null,null,null,null); The unique constraint applies to TOTPNAME, DOCTYPE, and DOCTYPEREV for each row. Purging the entire repository in the OracleAS Integration B2B user interface does not purge data in the newly created tables for outbound batching. To purge these tables, rerun patch.sql. The objects in these tables are not currently exported when users export a configuration. Export the B2B_PENDING_MSGS and B2B_PATCH_EVENT tables using the exp tool in Oracle_Home/bin. For full outbound batching support, you must still enter one row into the B2B_ BATCH_EVENT table for each document type and revision you want to send to the trading partner. For backward compatibility, if you leave the column CRITERIA1 as null, the B2B Server batches one document type at one time. If you set CRITERIA1=X12_ONE_TP or EFT_ONE_TP, then the B2B Server batches all X12 or EDIFACT documents that have been entered into the B2B_BATCH_EVENT table for each trading partner. For example, assume that the B2B_BATCH_EVENT table has the following data: TOTPNAME, DOCTYPE, DOCTYPEREV, CRITERIA1 GlobalChips, 850, 4010, X12_ONE_TP GlobalChips, 810, 4030, X12_ONE_TP GlobalChips, 855, 4010, X12_ONE_TP Oracle, 810, 3050, X12_ONE_TP Oracle, 850, 3050, X12_ONE_TP Oracle, 855, 3050, X12_ONE_TP 14-2 Oracle Application Server Integration B2B User’s Guide EDI Batching Examples The B2B Server batches 810, 850, and 855 for GlobalChips and 810, 850 and 855 for Oracle (that is, batched into two wire messages). If you set CRITERIA1=X12_ALL_TP or EFT_ALL_TP, the B2B Server batches all X12 or EDIFACT documents entered into the B2B_BATCH_EVENT table for all the trading partners. For example, assume that the B2B_BATCH_EVENT table has the following data: TOTPNAME, DOCTYPE, DOCTYPEREV, CRITERIA1 GlobalChips, 850, 4010, X12_ALL_TP GlobalChips, 810, 4030, X12_ALL_TP GlobalChips, 855, 4010, X12_ALL_TP Oracle, 810, 3050, X12_ALL_TP Oracle, 850, 3050, X12_ALL_TP Oracle, 855, 3050, X12_ALL_TP The B2B Server batches 810, 850, and 855 for GlobalChips and Oracle into one wire message. You cannot mix and match for %_ALL_TP and %_ONE_TP. If you use X12_ALL_TP, then all CRITERIA1 values must be X12_ALL_TP. Similarly, if you use X12_ONE_TP, all CRITERIA1 values must be X12_ONE_TP. For example, the following data is not allowed: TOTPNAME, DOCTYPE, DOCTYPEREV, CRITERIA1 GlobalChips, 850, 4010, X12_ALL_TP GlobalChips, 810, 4030, X12_ALL_TP GlobalChips, 855, 4010, X12_ALL_TP Oracle, 810, 3050, X12_ONE_TP Oracle, 850, 3050, X12_ONE_TP Oracle, 855, 3050, X12_ONE_TP However, since you batch X12 and EDIFACT separately, you can have the following data: GlobalChips, 850, 4010, X12_ONE_TP GlobalChips, 810, 4030, X12_ONE_TP GlobalChips, 855, 4010, X12_ONE_TP Oracle, 810, 3050, X12_ONE_TP Oracle, 850, 3050, X12_ONE_TP Oracle, 855, 3050, X12_ONE_TP Sun, ORDERS, D98A, EFT_ALL_TP Sun, ORDRSP, D98A, EFT_ALL_TP Sun, INVOIC, D98A, EFT_ALL_TP Intel, ORDERS, D98A, EFT_ALL_TP Intel, ORDRSP, D98A, EFT_ALL_TP Intel, INVOIC, D98A, EFT_ALL_TP The EXPIRE_TIME and INTERVAL must be the same for each batch group. In the preceding example, this syntax, GlobalChips, 850, 4010, X12_ONE_TP GlobalChips, 810, 4030, X12_ONE_TP GlobalChips, 855, 4010, X12_ONE_TP is treated as one batch group and these rows must have the same EXPIRE_TIME and INTERVAL. In this example, Oracle, 810, 3050, X12_ONE_TP Oracle, 850, 3050, X12_ONE_TP Oracle, 855, 3050, X12_ONE_TP Batching and Debatching EDI Transaction Sets 14-3 EDI Batching Examples is treated as one batch group and these rows must have the same EXPIRE_TIME and INTERVAL. The EXPIRE_TIME and INTERVAL can be different from the first group, but within the rows of the second group, the value for EXPIRE_TIME and INTERVAL must be the same. In this example, Sun, ORDERS, D98A, EFT_ALL_TP Sun, ORDRSP, D98A, EFT_ALL_TP Sun, INVOIC, D98A, EFT_ALL_TP Intel, ORDERS, D98A, EFT_ALL_TP Intel, ORDRSP, D98A, EFT_ALL_TP Intel, INVOIC, D98A, EFT_ALL_TP is treated as one batch group and these rows must have the same EXPIRE_TIME and INTERVAL. In most cases, you must also set this property in the tip.properties file: oracle.tip.adapter.b2b.edi.identifyFromTP=Interchange. This is because batch messages have many Interchange Sender and Receiver IDs. As a result, you also must create a trading partner identification type called EDI Interchange ID and create a value for this type in the host or remote trading partner corresponding to the Interchange Sender and Receiver IDs in the EDI message. 14-4 Oracle Application Server Integration B2B User’s Guide 15 API for Creating Trading Partners and Agreements With the trading partner self-service API, you can create trading partners and agreements "on the fly" (programmatically) or use the command line utility, particularly to create many trading partners at once. The API uses XML-based descriptors for trading partners and agreements.This chapter details the formats of the XML trading partner and agreement descriptors, describes how to use the trading partner self-service API, and references example files. This chapter contains the following topics: ■ The Trading Partner Descriptor XML ■ The Agreement Descriptor XML ■ Using the Self-service API ■ Example Files See the following for information on how to create trading partners and trading partner agreements using the OracleAS Integration B2B user interface. ■ Chapter 9, "Creating Trading Partners" ■ Chapter 12, "Creating and Managing Trading Partner Agreements" Note: Only creating trading partners and agreements is supported, not updating or deleting. Also, RosettaNet collaborations are not supported in the API. The Trading Partner Descriptor XML The characteristics and capabilities of a trading partner are described through an XML file, whose format is defined by the XSD provided in the example file OrclTPProfilesV2-6.xsd. See "Example Files" on page 15-6 for the location of the file. Table 15–1 lists the elements and attributes of the trading partner XML file. API for Creating Trading Partners and Agreements 15-1 The Trading Partner Descriptor XML Table 15–1 Trading Partner Descriptor XML File Elements Description and Attributes TradingPartners The root element that contains one or more trading partner profiles. TradingPartnerProfile Contains all the information needed to create a trading partner, and therefore is the root for a single trading partner. The TradingPartners element can have many such elements under it. Attributes: TradingPartnerID ■ TPName—Specifies the name of the trading partner. ■ Description—Specifies an optional description for the trading partner. Specifies zero or more trading partner IDs. Attributes: ■ Type—Specifies the type of the identification. ■ Value—Specifies the value for this type of identification. ■ Description—Provides an optional description for the TP ID type. OperationalCapability Contains all the information that describes the operational capability of a trading partner. SupportedBusinessAction Describes a supported business action for the trading partner. Attributes: ■ ■ ■ DocumentType BusinessActionName—Specifies the name of the business action supported by this trading partner. isInitiator—Specifies if the trading partner is the initiator of the business action. isFunctionalAckReqd—Specifies if a functional acknowledgment is required. Specifies any document type parameters that need to be different from the protocol default, as well as the document definition. Attributes: DocumentTypeParameter ■ Name—Specifies the name of the document type. ■ Protocol—Specifies the name of the document protocol. ■ Version—Specifies the version of the document protocol. Specifies zero or more document type parameters and their values that need to be different from the defaults. Attributes: DocumentDefinition ■ Name—Specifies the name of the parameter. ■ Value—Specifies the value of the parameter. Contains information pertaining to the document definition. Attributes: ■ ■ 15-2 Description—Specifies an optional description for the document definition. ■ isTranslationEnabled—Indicates if translation must be performed. ■ isValidationEnabled—Indicates if validation must be performed. ■ CommunicationCapability Name—Specifies the name of the document definition. Definition—Specifies the full path to the file containing the definition (for example, an XSD file). Contains all information pertaining to the communication capabilities of a trading partner. Oracle Application Server Integration B2B User’s Guide The Trading Partner Descriptor XML Table 15–1 (Cont.) Trading Partner Descriptor XML File Elements Description and Attributes DeliveryChannel Contains information regarding a delivery channel for a trading partner. Attributes: ■ ■ OriginNonRepudiation—Indicates if nonrepudiation of origin is required. ■ EncryptionEnabled—Indicates if encryption is enabled. ■ CompressionEnabled—Indicates if compression is enabled. ■ ■ ■ ■ DocumentExchange ReceiptNonRepudiation—Indicates if nonrepudiation of receipt is required. TransportSecurityEnabled—Indicates if transport security is enabled. If enabled, the HTTP transport could be HTTPS, for example. RetryCount—Specifies the number of retries. TimeToAcknowledge—Specifies the time window before which an acknowledgment is required. Name—Specifies the name of the delivery channel (optional). If unspecified, a delivery channel name is synthesized. Specifies information relating to document exchange for a trading partner. Attributes: ■ ExchangeProtocolRevision Name—Specifies the name of the document exchange (optional). If unspecified, a name is synthesized. Specifies the exchange protocol. Attributes: ExchangeProtocolParameter ■ Name—Specifies the name of the exchange protocol. ■ Version—Specifies the version of the exchange protocol. Specifies the exchange protocol parameters that must be different from the defaults. Attributes: ■ Name—Specifies the name of the parameter. ■ Value—Specifies the value of the parameter. Encryption Contains information relevant to encryption, such as the certificate location. Certificate Contains certification information. Attributes: ■ Name—Specifies the name of the certificate. ■ Location—Specifies the location of the certificate. Non-Repudiation Contains information relevant to nonrepudiation. Transport Specifies the transport information for this delivery channel. Attributes: ■ ■ Name—Specifies the name of the transport (optional). If unspecified, a name is synthesized. URI—Specifies the URI/endpoint used by the transport. API for Creating Trading Partners and Agreements 15-3 The Agreement Descriptor XML Table 15–1 (Cont.) Trading Partner Descriptor XML File Elements Description and Attributes TransportServer Specifies the transport information for this delivery channel. Attributes: ■ ■ Description—Specifies an optional description for the transport server. ■ HostName—Required if a transport server must be created. ■ IPAddress—Specifies the IP address of the host (optional). ■ ■ TransportProtocol Name—Specifies the name of the transport server (optional). If unspecified, a name is synthesized. UserName—Required for a new transport server. Specifies the username to use (for a protocol such as FTP). Password—Required for a new transport server. Specifies the password to use (for example, FTP). Identifies the transport protocol (HTTP for example). Attributes: ■ Name—Specifies the name of the transport protocol. ■ Version—Specifies the version of the transport protocol. TransportProtocolParameter Specifies transport protocol parameters. Attributes: ■ Name—Specifies the name of the parameter. ■ Value—Specifies the value of the parameter. The Agreement Descriptor XML The characteristics and capabilities of an agreement are described through an XML file, whose format is defined by the XSD provided in the example file Agreements.xsd. See "Example Files" on page 15-6 for the location of the file. Table 15–2 lists the elements and attributes of the agreement XML file. Table 15–2 Agreement Descriptor XML File Elements Description and Attributes TPAgreements Contains descriptions of one or more agreements. Agreement Contains the description for an agreement. Attributes: ■ Name—Specifies the name of the agreement. ■ ID—Specifies the ID of the agreement. ■ Description—Describes the agreement. ■ ■ ■ ■ BusinessActionParticipant 15-4 EffectiveFromDate—Specifies the beginning date when the agreement is effective. EffectiveToDate—Specifies the end date when the agreement is effective InvocationLimit—Specifies the ceiling for the number of invocations. ConcurrentConversations—Specifies the maximum number of concurrent instances of this agreement. Describes the participants in this business action. Oracle Application Server Integration B2B User’s Guide Using the Self-service API Table 15–2 (Cont.) Agreement Descriptor XML File Elements Description and Attributes InitiatingTP Describes the trading partner initiating the business action. Attributes: ■ ■ DeliveryChannel TPIDType—Specifies the type of the trading partner ID used in the agreement. TPIDValue—Specifies the value of the trading partner ID used in the agreement. Describes the delivery channel used in the agreement. Attributes: ■ Name—Specifies the name of the delivery channel. Describes the responding trading partner in the business action. RespondingTP ■ ■ InternalDeliveryChannel TPIDType—Specifies the type of the trading partner ID used in the agreement. TPIDValue—Specifies the value of the trading partner ID used in the agreement. Describes the Delivery Channel used in the agreement. Attributes: ■ CalloutUsage Name—Specifies the name of the internal delivery channel used in the agreement. Describes the callout usage in the agreement. Attributes: ■ Name—Specifies the name of the callout usage. Using the Self-service API Clients can use the self-service API programmatically to create trading partners and agreements, as shown in the following example: FileInputStream fis = new FileInputStream(tpFile); InputSource is = new InputSource(fis); TradingPartnerManager tpMgr = TradingPartnerManager.newInstance(); tpMgr.init(); if (args.length == 2) { tpMgr.processTPProfiles(is, true); } else { tpMgr.processTPProfiles(is, false); } tpMgr.shutdown(); FileInputStream fis = new FileInputStream(tpFile); InputSource is = new InputSource(fis); AgreementManager agreementMgr = AgreementManager.newInstance(); agreementMgr.init(); agreementMgr.processAgreements(is); agreementMgr.shutdown(); You can also use the command line utility of the API. To create trading partner profiles from the specified XML file: java oracle.tip.adapter.b2b.selfservice.TradingPartnerManager <TPData.xml> To create agreements from the specified XML file: API for Creating Trading Partners and Agreements 15-5 Example Files java oracle.tip.adapter.b2b.selfservice.AgreementManager <AgreementData.xml> Example Files For the following files, go to Oracle_Home/ip/samples/TPSelfService 15-6 ■ Agreements.xml ■ OrclAgreements.xsd ■ OrclTPProfilesV2-6.xsd ■ TPProfileSampleInstance-7.xml ■ TPProfileSampleInstance-8.xml Oracle Application Server Integration B2B User’s Guide 16 Utilities for Enqueuing and Dequeuing OracleAS Integration B2B provides two utilities to help you test and verify your installation and configuration before connecting to the host (back-end) applications. You can use these two utilities to learn how to send and receive business messages to and from OracleAS Integration B2B through the default AQ queue interface. Other AQ internal delivery channels can be handled in the same way. The Java enqueue and dequeue utilities are also used in the tutorial. This chapter contains the following topics: ■ Java Enqueue and Dequeue ■ PL/SQL Enqueue and Dequeue Java Enqueue and Dequeue To enqueue and dequeue messages, use the following commands: ■ IPEnqueue ■ IPDequeue IPEnqueue and IPDequeue must be executed in the OracleAS Integration B2B environment. See "Setting Up the CLASSPATH Environment" on page 5-3 for more information. IPEnqueue To enqueue messages using Java, execute the following at the command line: java oracle.tip.adapter.b2b.data.IPEnqueue ipenqueue.properties Table 16–1 lists the Java enqueue utility properties. Table 16–1 IPEnqueue Properties Name Description queue The outbound AQ queue name. If unspecified, the Java enqueue utility uses the default outbound queue IP_OUT_QUEUE. replyToMsgID The message ID to which the sending message is replying from Trading partner that sends the message to Trading partner that receives the message doctypeName Document type name for the message doctypeRevision Document type revision for the message Utilities for Enqueuing and Dequeuing 16-1 PL/SQL Enqueue and Dequeue Table 16–1 (Cont.) IPEnqueue Properties Name Description payload Payload file name attachment Attachment file name Example: ipenqueue.properties queue replyToMsgID from to doctypeName doctypeRevision payload attachment = = = = = = = = "Acme" "GlobalChips" 850 4010 Acme_850.xml IPDequeue To dequeue messages using Java, execute the following at the command line: java oracle.tip.adapter.b2b.data.IPEnqueue ipdequeue.properties Table 16–2 lists the Java dequeue utility properties. Table 16–2 IPDequeue Properties Name Description queue The inbound AQ queue name. If unspecified, the Java dequeue utility uses the default inbound queue IP_IN_QUEUE. count The number of messages to dequeue. If unspecified, only one message is dequeued. output Output file name Example: ipdequeue.properties: queue count output = = 1 = t1.trc PL/SQL Enqueue and Dequeue Use the following scripts to enqueue to and dequeue from B2B queues: ■ msgid_b2b.sql ■ enq_b2b.sql ■ deq_b2b.sql You must execute msgid_b2b.sql before enq_b2b.sql. msgid_b2b.sql The msgid_b2b.sql script creates a database sequence to generate a unique message ID for enqueue. CREATE SEQUENCE message_seq INCREMENT BY 1 START WITH 1000; 16-2 Oracle Application Server Integration B2B User’s Guide PL/SQL Enqueue and Dequeue enq_b2b.sql The enq_b2b.sql script enqueues a message to a B2B queue. You can use either a VARCHAR2 or a CLOB as the message payload. DECLARE enqueue_options dbms_aq.enqueue_options_t; message_properties dbms_aq.message_properties_t; msg_handle RAW(16); ipmsg IP_MESSAGE_TYPE; /* xml_payload varchar2(30000); */ xml_clob clob; msg_id number(10); subscribers dbms_aq.aq$_recipient_list_t; BEGIN select message_seq.nextval into msg_id from dual; /* xml_payload :='<?xml version="1.0" encoding="UTF-8"?>'; */ xml_clob := '<?xml version="1.0" encoding="UTF-8"?>'; subscribers(1) := SYS.AQ$_AGENT('b2buser', null, null); message_properties.RECIPIENT_LIST := subscribers; ipmsg := IP_MESSAGE_TYPE (msg_id, null, 'Acme','GlobalChips','Process_850', '850', '4010', 1, xml_clob, null); dbms_aq.enqueue(queue_name => 'IP_IN_QUEUE', enqueue_options => enqueue_options, message_properties => message_properties, payload => ipmsg, msgid => msg_handle); commit; END; / show errors; deq_b2b.sql The deq_b2b.sql script dequeues a message from a B2B queue. DECLARE dequeue_options dbms_aq.dequeue_options_t; message_properties dbms_aq.message_properties_t; message_handle RAW(16); ipmsg IP_MESSAGE_TYPE; BEGIN dequeue_options.consumer_name := 'b2buser'; dequeue_options.dequeue_mode := DBMS_AQ.REMOVE; dequeue_options.navigation := DBMS_AQ.NEXT_MESSAGE; dequeue_options.wait := DBMS_AQ.FOREVER; DBMS_AQ.DEQUEUE( queue_name => 'IP_IN_QUEUE', dequeue_options => dequeue_options, message_properties => message_properties, payload => ipmsg, msgid => message_handle); DBMS_OUTPUT.PUT_LINE('Message ID : ' || ipmsg.msg_id); COMMIT; END; / show errors; Utilities for Enqueuing and Dequeuing 16-3 PL/SQL Enqueue and Dequeue 16-4 Oracle Application Server Integration B2B User’s Guide Part V Administration, Monitoring, and Security Tasks This part describes how to administer OracleAS Integration B2B design-time and run-time data, create reports that monitor the status of a deployed configuration, and ensure that your OracleAS Integration B2B instance is secure. This part contains the following chapters: ■ Chapter 17, "Administering OracleAS Integration B2B" ■ Chapter 18, "System Management with Oracle Enterprise Manager 10g" ■ Chapter 19, "Creating Reports" ■ Chapter 20, "OracleAS Integration B2B Security" 17 Administering OracleAS Integration B2B This chapter describes how to administer OracleAS Integration B2B partner information and instance data. This chapter contains the following topics: ■ Administering OracleAS Integration B2B ■ Managing Contact Types ■ Managing Trading Partner Identification Types ■ Exporting and Importing the Design-Time Repository ■ The Run-Time Repository ■ Purging the Entire Repository ■ Purging Business Messages and Wire Messages Using the Purge Utility ■ Common User Errors ■ Summary Administering OracleAS Integration B2B Through the user interface, you can perform the design tasks shown in Figure 17–1. Administering OracleAS Integration B2B 17-1 Administering OracleAS Integration B2B Figure 17–1 Design Tasks: Managing Contact Types and Trading Partner Identification Types You can also perform the import, export, and purge management tasks shown in Figure 17–2 using the user interface. Figure 17–2 Management Tasks: Importing, Exporting, and Purging Data Table 17–1 provides references to instructions for these administration tasks. 17-2 Oracle Application Server Integration B2B User’s Guide Managing Trading Partner Identification Types Table 17–1 Design and Management Tasks Task See Section... Managing contact types "Managing Contact Types" on page 17-3 Managing trading partner identification types "Managing Trading Partner Identification Types" on page 17-3 Importing and exporting the design-time repository "Exporting and Importing the Design-Time Repository" on page 17-5 Purging the entire repository "Purging the Entire Repository" on page 17-9 Managing Contact Types This section describes the contact type management tasks shown in Figure 17–1. The contact type is the method for contacting persons or organizations (such as a telephone number or e-mail address). The predefined contact types shown in Figure 17–1 cannot be updated or deleted. The contact type also appears as a selection on the Organization page (accessible by clicking Partners, then Trading Partners, then trading_partner_name_in_Name_ column, then Organization, and then Create). See "Creating Contact Information for a Trading Partner Person or Organization" on page 10-18 for more information. Table 17–2 identifies the contact type management tasks shown in Figure 17–1 and provides references to procedures for performing these tasks. Table 17–2 Contact Type Management Tasks Page Elements Management Tasks See Section... Shortcuts section of Figure 17–1 Take a shortcut to the Trading Partners page "Managing Trading Partners" on page 10-5 Name column of Contact View details about a contact Types section of Figure 17–1 type "Viewing a Contact Type" on page 17-3 Viewing a Contact Type To view details about a contact type: 1. Click Administration, then Design. 2. Select a specific contact type to view in the Name column of the Contact Types section. The Contact Type Details page for the selected contact type appears (for example, for e-mail). 3. View specific details, including the contact type and description. 4. Click Return to List to return to the Design tab main page. Managing Trading Partner Identification Types This section describes the trading partner identification type management tasks shown in Figure 17–1. The trading partner identification type includes a value that uniquely identifies a trading partner, such as a Data Universal Numbering System (DUNS) number or an electronic data interchange (EDI) location code. The predefined trading partner identification types shown in Figure 17–1 cannot be updated or deleted. You can also create your own custom trading partner identification types. Administering OracleAS Integration B2B 17-3 Managing Trading Partner Identification Types Table 17–3 identifies the trading partner identification type management tasks shown in Figure 17–1 and provides references to procedures for performing these tasks. Table 17–3 Trading Partner Identification Type Management Tasks Page Elements Management Tasks See Section... Shortcut section of Figure 17–1 Take a shortcut to the Trading Partners page "Managing Trading Partners" on page 10-5 Create button of Trading Create a trading partner Partner Identification identification type Types section of Figure 17–1 "Creating a Trading Partner Identification Type" on page 17-4 Name column of Trading View details about a trading Partner Identification partner identification type Types section of Figure 17–1 "Viewing a Trading Partner Identification Type" on page 17-4 Note: Trading partner identification types cannot be deleted or updated. Creating a Trading Partner Identification Type To create a trading partner identification type: 1. Click Administration, then Design. 2. Click Create in the Trading Partner Identification Types section. The Create Trading Partner Identification Type page appears. 3. Enter the following details to create a trading partner identification type. An asterisk (*) indicates a required field. Field Value Name * Enter a unique and recognizable trading partner identification type name. Description Enter a description. 4. Click Apply. The trading partner identification type is created and the Trading Partner Identification Type Details page appears. The trading partner identification type appears as a selection on the Create Trading Partner Identification page (accessible by clicking Partners, then Trading Partners, then trading_partner_name_in_ Name_column, then Trading Partner Identifications, and then Create). The trading partner identification type is also available for selection when you run the Create Trading Partner wizard. See "Creating Trading Partner Identification" on page 10-8 for instructions on selecting a trading partner identification value. Viewing a Trading Partner Identification Type To view details about a trading partner identification type: 17-4 1. Click Administration, then Design. 2. Select a specific trading partner identification type to view in the Name column of the Trading Partner Identification Types section. Oracle Application Server Integration B2B User’s Guide Exporting and Importing the Design-Time Repository The Trading Partner Identification Type Details page for the selected trading partner identification type appears. 3. View the trading partner identification type description. You can also manage (view, update, and delete) the value of the assigned types from this section. 4. Click Return to List to return to the Design tab main page. Exporting and Importing the Design-Time Repository The OracleAS Integration B2B user interface enables you to create partner data (such as trading partners and trading partner agreements) that is stored in the OracleAS Integration B2B design-time repository portion of the Oracle Application Server Metadata Repository. Partner data is design-time data before it is included in a deployed configuration (for example, trading partner and trading partner agreement data). Partner data is the data that you create under the Partners tab in the OracleAS Integration B2B user interface. The OracleAS Integration B2B user interface provides design-time repository export and import functionality that enables you to perform several tasks, including the following: ■ ■ ■ Export and import the entire contents of the design-time repository to and from an XML file. This enables you to export the contents from one repository and import it into another repository. Export and import a configuration created under the Deployment tab to and from the design-time repository Import supported, predefined RosettaNet collaborations (partner interface processes (PIPs)), EDI X12 and EDI EDIFACT transaction sets (business actions), and UCCnet standards into the design-time repository to assign to trading partners. This information can then be viewed by clicking Partners, then Protocols, then business_protocol_name_in_Name_column, then Process Protocol Revisions, and then Details. A transaction set maps to a document type of a business action in the OracleAS Integration B2B user interface. Caution: Do not manually edit exported files. If you do so, OracleAS Integration B2B cannot guarantee their integrity. There are several methods for using export and import. ■ ■ In high availability environments, you can back up specific configurations from your design-time repository. For migrating from a test environment to a production environment, you can import configurations tested in a staging environment into a production environment. OracleAS Integration B2B supports the following types of export: ■ ■ ■ The export feature accessible under the Administration tab (and described in this section) exports the latest versions of all partner data in the design-time repository to a file. The configuration export feature accessible under the Deployment tab exports only the data included in a specific configuration. The export feature accessible from the Agreement Details page and Trading Partner Details page exports the partner data associated with those pages to Administering OracleAS Integration B2B 17-5 Exporting and Importing the Design-Time Repository XML files. The XSDs for these XML files are included in the exported document. Note the following details about importing and exporting the latest versions of all partner data to a file: ■ Person passwords are not updated if you import partner data into a repository where the person and password already exist, even if the password was different when the export file was created. If a specific person existed when the export file was created, but does not exist in the design-time repository into which the partner data is being imported, the person and password are imported into the new design-time repository. However, if a specific person and password exist in both the design-time repository and the file to be imported, the password is not imported; it remains the same as before import. Person passwords are not imported; passwords for transport servers are imported. ■ ■ ■ The wallet password for the host trading partner is not exported or imported. This password must be created manually by following the instructions under Partners, then Trading Partners, and then host_trading_partner_name_in_ Name_column. All trading partner agreements are imported in the Draft state, even if they were approved before the export. You must validate the relevant trading partner agreements before creating and deploying a configuration. Do not use the OracleAS Integration B2B export and import features for backup or recovery of the design-time repository. OracleAS Integration B2B uses the b2b schema in the metadata repository. This schema has additional metadata and run-time state not included in the OracleAS Integration B2B export file. Use the Oracle database import and export utilities or the Oracle Application Server archiving tool to back up this schema. Table 17–4 identifies the management tasks you can perform from the Management tab main page and provides references for performing these tasks. Table 17–4 Management Tasks Management Task See Section... Export the entire design-time repository to a file "Exporting the Design-Time Repository Contents" on page 17-7 Import the design-time repository from a file (exported by clicking Administration, then Management, and then Export) "Importing the Design-Time Repository Contents" on page 17-7 Import a configuration (exported by clicking Deployment, then configuration_name_in_Name_ column, and then Export) "Importing an Exported Configuration" on page 17-8 Import supported, predefined RosettaNet collaborations, EDI transaction sets, and UCCnet standards "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards" on page 17-8 See the following for more information: ■ 17-6 "Exporting a Configuration" on page 13-10 for instructions on exporting a configuration Oracle Application Server Integration B2B User’s Guide Exporting and Importing the Design-Time Repository ■ ■ ■ ■ ■ "Exporting Partner Data to an XML File" on page 2-9 for instructions on exporting partner data to a file "Managing Trading Partner Persons" on page 10-20 for instructions on creating persons and assigning passwords "Managing the Host Trading Partner Wallet Password" on page 10-14 for instructions on creating a wallet password for the host trading partner Oracle Application Server Administrator’s Guide for details about Oracle Application Server backup and recovery Oracle Database Backup and Recovery Basics, available on the Oracle Technology Network Web site at http://www.oracle.com/technology Exporting the Design-Time Repository Contents Before you begin, review "Exporting and Importing the Design-Time Repository" on page 17-5 for important concepts. To export the design-time repository contents: 1. Click Administration, then Management, and then Export. The entire and latest contents of partner data in the design-time repository are copied to a file named export.xml that you are prompted to open or download to a directory location. Depending on the size of the design-time repository contents, this process can take time. Caution: The design-time repository contents exported to a file represent a copy of the current partner data. This file is no longer accessible for changes with the OracleAS Integration B2B user interface until it is imported back into OracleAS Integration B2B. If you continue to make changes to the design-time repository contents with the OracleAS Integration B2B user interface, and later import the exported file (the contents of which are now older), then the following occur: ■ ■ New data created with the OracleAS Integration B2B user interface after the file was exported is left untouched after the file is imported. Data updated or deleted after the file was exported is overwritten with the older contents of the imported file. Importing the Design-Time Repository Contents Follow these instructions to import the design-time repository contents that you exported to an XML file by clicking Administration, then Management, and then Export. Before you begin, review "Exporting and Importing the Design-Time Repository" on page 17-5 for important concepts. To import the design-time repository contents: 1. Click Administration, then Management. 2. Click Browse to select a file to import. Administering OracleAS Integration B2B 17-7 Exporting and Importing the Design-Time Repository 3. Click Import. The Import Status page appears. A clock indicates that the import is being processed and can take several minutes. The entire contents of the file are loaded into their previous locations in the design-time repository and are displayed in the OracleAS Integration B2B user interface. You cannot import parts of the file. A message appears indicating that the import completed successfully. The partner data that comprises a configuration is reimported, but the configuration is not re-created. You must first validate the trading partner agreement of the configuration and then re-create the configuration. If an import fails, then the changes are rolled back and the design-time repository remains unchanged. A message appears indicating that the import was unsuccessful. Importing an Exported Configuration Follow these instructions to import a configuration exported by clicking Deployment, then configuration_name_in_Name_column, and then Export: Before you begin, review "Exporting and Importing the Design-Time Repository" on page 17-5 for important concepts. To import and exported configuration: 1. Click Administration, then Management. 2. Click Browse to select the file containing the exported configuration to import. 3. Click Import. The Import Status page appears. A clock indicates that the import is being processed and can take several minutes. The trading partner agreement of a configuration is loaded into its previous location in the design-time repository. You must then validate the trading partner agreement and re-create the configuration that includes this trading partner. If an import fails, then the changes are rolled back and the design-time repository remains unchanged. A message appears indicating that the import was unsuccessful. Importing Support for Collaborations, Transaction Sets, and UCCnet Standards OracleAS Integration B2B includes support for importing the following collaborations, transaction sets, and UCCnet standards: ■ ■ ■ ■ 17-8 Approximately 25 frequently-used RosettaNet collaborations in the ip/demo/samples/RosettaNet/RosettaNet_sample.xml file EDI X12, document protocol revision 4010, transaction sets 850, 855, and 997 in the ip/demo/samples/X12/X12_sample.xml file EDI EDIFACT, document protocol revision D98A with transaction sets ORDERS and ORDRSP, and document protocol revision D3 with transaction set CONTRL in the ip/demo/samples/EDIFACT/EDIFACT_sample.xml file UCCnet standards (protocol revision 2.3.1) in the ip/demo/samples/UCCnet/UCCnet_sample.xml file Oracle Application Server Integration B2B User’s Guide Purging the Entire Repository To use these collaborations, transaction sets, and standards, you must import these files into the design-time repository. This action enables you to see and use them in the OracleAS Integration B2B user interface. Before you begin, review "Exporting and Importing the Design-Time Repository" on page 17-5 for important concepts. To import collaborations, transaction sets, and standards: 1. Click Administration, then Management. The Import page appears. 2. Click Browse to select the collaborations, transaction sets, or standards to import. 3. Click Import. The Import Status page appears. A clock indicates that the import is being processed. Once imported, these collaborations, transaction sets, and standards display in the Process Protocol Revision Details page accessible by clicking Partners, then Protocols, then business_protocol_name_in_Name_column, then Process Protocol Revision, and then Details. You can then assign these collaborations, transaction sets, and standards to remote trading partners. If an import fails, the design-time repository remains unchanged. A message appears indicating that the import was unsuccessful. See Chapter 3, "Supported Protocols" for a list of supported collaborations, transaction sets, and standards. The Run-Time Repository The OracleAS Integration B2B runtime repository stores instance data. Instance data is partner data included in a deployed configuration. During configuration creation, partner data of the integration is validated end-to-end a final time to ensure that only a complete and consistent configuration is deployed to the runtime repository. After a configuration is deployed, the runtime repository stores the configuration of instance data required to execute an integration. Instance data is created during run time when messages are processed. Purging the Entire Repository The entire repository—the Oracle Application Server Metadata Repository—contains contains design-time configuration (partner) data, run-time configuration data, and run-time instance data. The OracleAS Integration B2B user interface enables you to purge the entire repository, with the exception of the host trading partner name, which is not purged. Predefined data that was part of the installation (for example, business protocols such as EDI and RosettaNet and identification types such as a Data Universal Numbering System (DUNS) and an EDI Location Code) is not deleted. Purging enables you to perform the following tasks: ■ Manage disk space and improve performance ■ Delete multiple objects of larger granularity Administering OracleAS Integration B2B 17-9 Purging Business Messages and Wire Messages Using the Purge Utility Note: A second user accessing the same OracleAS Integration B2B user interface on another host can also view purging progress. The second user sees a message stating that purging is in progress. A View Status link appears that takes the second user to a purging progress page. To purge the entire repository: Caution: Purging is an irreversible operation. Ensure that you first archive any important configurations with the Oracle Application Server archiving tool before purging the repository. See Oracle Application Server Administrator’s Guide for instructions on archiving data before purging the repository. 1. Click Administration, then Management, and then Purge. 2. Click Entire Repository, then Purge. The Business Messages and Collaboration Instances options are not available. See "Purging Business Messages and Wire Messages Using the Purge Utility" on page 17-10 for more information. The message Purging will permanently remove the data and user should archive the data using Oracle DB archive features for future reference. Are you sure you want to purge entire repository? appears. 3. Click Yes. Purging Business Messages and Wire Messages Using the Purge Utility OracleAS Integration B2B provides a command-line utility to purge business messages and wire messages from the repository, based on specified criteria. You can run the command in both interactive and noninteractive modes. Noninteractive mode runs much faster than interactive mode. Note: Before using the purge utility, ensure that your classpath contains the b2b.jar file by running the setenv script in your Oracle_Home/ip/install directory. See "Setting Up the CLASSPATH Environment" on page 5-3 for more information. In interactive mode, the utility prompts you for the start and end dates (inclusive) of the messages to be purged. The number of messages to be purged is displayed. The purge begins after your confirmation. To run the purge utility in interactive mode: $ java oracle.tip.adapter.b2b.purge.Purge In noninteractive mode, you invoke this utility from a shell script or as a cron job. The utility does not prompt for your confirmation. To run the purge utility in noninteractive mode: $ java oracle.tip.repos.purge.PurgeManager -purgeRuntime -start mm/dd/yyyy -end mmm/dd/yyyy 17-10 Oracle Application Server Integration B2B User’s Guide Summary The start and end arguments are the inclusive dates of the messages to be purged. Common User Errors ■ Do not manually edit exported files. If you do so, OracleAS Integration B2B cannot guarantee their integrity. Summary This chapter describes how to use the OracleAS Integration B2B user interface for the following tasks: ■ Manage contact types and trading partner identification types ■ Export and import the design-time repository to and from XML files ■ Import configurations from XML files ■ Import collaborations, transaction sets, and standards ■ Purge the entire repository ■ Purge business messages and wire messages using the purge utility Administering OracleAS Integration B2B 17-11 Summary 17-12 Oracle Application Server Integration B2B User’s Guide 18 System Management with Oracle Enterprise Manager 10g This chapter provides an overview of OracleAS Integration B2B monitoring and administration tasks that you can perform from Oracle Enterprise Manager 10g. This chapter contains the following topics: ■ ■ ■ ■ Oracle Enterprise Manager 10g Monitoring and Administration Overview Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console Starting and Stopping OracleAS Integration B2B Components with OPMN Additional Oracle Application Server and OracleAS Integration B2B Management Tasks ■ Changing Port Numbers ■ Summary See the following for more information: ■ ■ Oracle Application Server Administrator’s Guide for details about using Oracle Enterprise Manager 10g to manage Oracle Application Server Oracle Enterprise Manager Concepts for conceptual details about Oracle Enterprise Manager 10g Oracle Enterprise Manager 10g Monitoring and Administration Overview Figure 18–1 provides a high-level overview of how OracleAS Integration B2B is managed. System Management with Oracle Enterprise Manager 10g 18-1 Oracle Enterprise Manager 10g Monitoring and Administration Overview Figure 18–1 Monitoring and Management with Oracle Enterprise Manager 10g OracleAS Middle Tier 1 Oracle Enterprise Manager 10g Application Server Control Console OracleAS Integration B2B OracleAS Middle Tier 2 Oracle Enterprise Manager 10g Application Server Control Console OracleAS Integration B2B OracleAS Middle Tier 3 OracleAS Metadata Repository Holds all Oracle Application Server Integration B2B Metadata and seed data Oracle Enterprise Manager 10g Application Server Control Console OracleAS Integration B2B In Figure 18–1, OracleAS Integration B2B is installed on three Oracle Application Server middle tiers that connect to an Oracle Application Server Metadata Repository. The Oracle Enterprise Manager 10g Application Server Control Console is designed to provide local monitoring and administration tasks on an OracleAS Integration B2B middle-tier instance basis. The Oracle Enterprise Manager 10g Application Server Control Console also provides real-time systems monitoring details such as up and down status, current CPU and memory consumption, and current performance status on the instance. Note: OracleAS Integration B2B cannot be managed from the Oracle Enterprise Manager 10g Grid Control Console for this release. Only management from the Oracle Enterprise Manager 10g Application Server Control Console is supported. See Oracle Enterprise Manager Concepts for more information: OracleAS Integration B2B Management Concepts and Components This section describes the following OracleAS Integration B2B management concepts and components: 18-2 Oracle Application Server Integration B2B User’s Guide Oracle Enterprise Manager 10g Monitoring and Administration Overview ■ OracleAS Metadata Repository ■ OracleAS Integration B2B Instance ■ The B2B Server of OracleAS Integration B2B ■ The OC4J Instance of OracleAS Integration B2B OracleAS Metadata Repository The OracleAS Metadata Repository contains all the partner data required for an integration. The Oracle Application Server Metadata Repository can be installed either through Oracle Application Server Infrastructure or with the Oracle Application Server Metadata Repository Creation Assistant. Every OracleAS Integration B2B middle-tier instance requires a connection to the OracleAS Metadata Repository to work properly. See Oracle Application Server Installation Guide for Oracle Application Server Metadata Repository installation concepts. OracleAS Integration B2B Instance An OracleAS Integration B2B middle-tier instance is a logical grouping of the B2B server and the Oracle Application Server Containers for J2EE (OC4J) instance. There is one OracleAS Integration B2B middle-tier instance for each Oracle home. The B2B Server of OracleAS Integration B2B The B2B server is the run-time component of OracleAS Integration B2B. The B2B server processes B2B transactions. The OC4J Instance of OracleAS Integration B2B The OC4J instance hosts the OracleAS Integration B2B user interface used for designing and deploying configurations, generating reports, managing trading partners, and other integration aspects. See Oracle Application Server Administrator’s Guide for details about troubleshooting OC4J instance issues. Oracle Enterprise Manager 10g Application Server Control Console Tasks You can perform the following local monitoring and administration tasks from the Oracle Enterprise Manager 10g Application Server Control Console: ■ ■ ■ ■ ■ ■ Start and stop the B2B server and OC4J instance components running in each OracleAS Integration B2B middle-tier instance. View the current running status (started or stopped) and memory and CPU usage for the B2B server and OC4J instances running in each Oracle Application Server middle-tier instance. View and edit OracleAS Integration B2B server properties. The online Help lists all server properties, including detailed descriptions, default values, and allowed ranges. View OracleAS Integration B2B performance (the number of messages received and number of messages that errored). Access the OracleAS Integration B2B user interface tool for designing and deploying integrations. View the OracleAS Integration B2B log files. System Management with Oracle Enterprise Manager 10g 18-3 Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console See "Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console" on page 18-4 for more information. Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console Follow these instructions to access OracleAS Integration B2B from the Oracle Enterprise Manager 10g Application Server Control Console. 1. Go to the following URL: http://hostname:port/ where: ■ ■ 2. hostname is the name of the host on which the OracleAS Integration B2B middle-tier instance is installed port is the number assigned during OracleAS Integration B2B installation. The following sources also identify the port number used to access the Oracle Enterprise Manager 10g Application Server Control Console: – The ipsetupinfo.txt file in the install subdirectory of your Oracle home directory – The End of Installation page that displayed during installation Enter the following login details when prompted: Field Value Username Enter ias_admin Password Enter the password you specified during J2EE and Web Cache installation and OracleAS Integration B2B installation for the ias_admin user. Note: If you have multiple Oracle Application Server middle-tier instances installed on a single host, you need to specify different Oracle Enterprise Manager 10g ports for each instance. See the portlist.ini file in the Oracle_Home/install directory for a list of which ports are currently in use. The Oracle Application Server home page appears: 18-4 Oracle Application Server Integration B2B User’s Guide Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console 3. Table 18–1 Select a management task to perform and see the referenced section for instructions. Management Tasks Page Elements Management Task See Also Name list of System Components section Select B2B for the OracleAS Integration B2B middle-tier instance to monitor and administer from the Oracle Enterprise Manager 10g Application Server Control Console. "OracleAS Integration B2B Monitoring and Administration Tasks" on page 18-6 for an overview of OracleAS Integration B2B tasks you can perform J2EE Applications link Select J2EE Applications to view the J2EE applications you have deployed using this instance. Online Help available with this page Ports link Select Ports to view ports assigned to OracleAS Integration B2B and other Oracle Application Server components. "OracleAS Integration B2B Port Management" on page 18-9 Infrastructure link Select Infrastructure to review and modify details about this Oracle Application Server instance, including identity management status. Online Help available with this page See Oracle Application Server Administrator’s Guide for instructions on changing the ias_admin username password. System Management with Oracle Enterprise Manager 10g 18-5 Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console OracleAS Integration B2B Monitoring and Administration Tasks Figure 18–2 shows the OracleAS Integration B2B middle-tier instance page that displays after selecting the B2B component from the System Components section in Step 3 on page 18-5. Figure 18–2 OracleAS Integration B2B Middle-Tier Instance Page Table 18–2 identifies the tasks that you can perform. These tasks are further described in the online Help available by clicking Help in the top right corner of each page. Table 18–2 Oracle Enterprise Manager 10g Application Server Control Console Monitoring and Administration Tasks Page Elements Management Task General section ■ B2B Server and OC4J Instance sections ■ Click Start All to start the B2B server and OC4J instance together. ■ Click Stop All to stop the B2B server and OC4J instance together. ■ Click Restart All to restart the B2B server and OC4J instance together. ■ ■ ■ ■ 18-6 View an overall status of the B2B server and OC4J instance components on this middle-tier instance. For the overall status to display as Up, both components must be running. View CPU and memory usage details and the time at which each component started. Click Start to start a specific component (either the B2B server or OC4J instance). Each component has its own Start button. Click Stop to stop a specific component (either the B2B server or OC4J instance). Each component has its own Stop button. Click Restart to restart a specific component (either the B2B server or OC4J instance). Each component has its own Restart button. Oracle Application Server Integration B2B User’s Guide Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console Table 18–2 (Cont.) Oracle Enterprise Manager 10g Application Server Control Console Monitoring and Administration Tasks Page Elements Management Task Logs link (at bottom or top right) ■ Click to access a page from which you can view OracleAS Integration B2B log files. See "OracleAS Integration B2B Log Files" on page 18-7 for more information. Performance link ■ Click to access a page from which you can view business message performance. See "OracleAS Integration B2B Middle-Tier Instance Performance" on page 18-7 for more information. Administration link ■ Click to display a page from which you can access the Server Properties link (to view and edit OracleAS Integration B2B server properties) and the OracleAS Integration B2B user interface login page See "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 for more information. See Oracle Application Server Administrator’s Guide for details about viewing log files and troubleshooting OC4J instance issues. OracleAS Integration B2B Log Files Oracle Application Server components such as OracleAS Integration B2B generate log files describing all types of events, including startup and shutdown details, errors, warning messages, access details on HTTP requests, and so on. You can view log files for OracleAS Integration B2B. 1. Ensure that you followed the instructions in "OracleAS Integration B2B Monitoring and Administration Tasks" on page 18-6 to access the page for viewing log files. The View Logs page appears. 2. Select B2B in the Available Components list. 3. Use the Move arrows to move selected components to the Selected Components list. 4. Click Search. A list of log files appears in the Results table. 5. Click a specific log to view in the Log File column. See Oracle Application Server Administrator’s Guide and the online Help for details about viewing log files. OracleAS Integration B2B Middle-Tier Instance Performance You can view details about performance in a specific OracleAS Integration B2B middle-tier instance, including: ■ The number of messages received since the B2B server was started ■ The number of messages that have errored out since the B2B server was started Figure 18–3 shows the performance page for a specific OracleAS Integration B2B middle-tier instance. System Management with Oracle Enterprise Manager 10g 18-7 Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console Figure 18–3 OracleAS Integration B2B Middle-Tier Instance Performance Page OracleAS Integration B2B Middle-Tier Instance Server Properties You can edit server property settings for logging levels, security, and trading partner (B2B) properties. These parameters are stored in a file called tip.properties. However, Oracle recommends that you edit these parameters only through the Server Properties page. Do not edit these parameters by accessing the tip.properties file from the directory path location and using an ASCII editor. Figure 18–4 shows the page for viewing and editing server properties. Figure 18–4 18-8 Server Properties Page Oracle Application Server Integration B2B User’s Guide Starting and Stopping OracleAS Integration B2B Components with OPMN Note: If using OracleAS Integration B2B on Windows operating systems, you must update server properties settings in the following order: 1. Stop the B2B server and OC4J instance of OracleAS Integration B2B. 2. Make updates to server property settings in the Server Properties page. 3. Start the B2B server and OC4J instance. If you do not follow this order, these updates are not applied correctly. See Also: The online Help for a detailed description of parameters you can edit, their range of values, and the default values OracleAS Integration B2B Port Management You can view OracleAS Integration B2B and Oracle Application Server component ports, and change some Oracle Application Server ports. However, it is strongly recommended that you not change OracleAS Integration B2B ports for this release. 1. Ensure that you selected Ports in Step 3 of "Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console" on page 18-4 to access the page for viewing and changing component ports. The page listing component ports appears. 2. Click the Component title in the Component column to alphabetically arrange the order of ports by name. The B2B server and OC4J instance components of OracleAS Integration B2B display details. 3. View details about ports, including the current port number and range of available ports. 4. Click the Configure column for a port that you want to change. Only ports with the pencil icon in the Configure column can be changed. 5. Follow the instructions on the page that displays to change the component port. Click the online Help for additional details. See "Port Changing Error Message" on page 18-11 for the type of error message you receive if you attempt to start OracleAS Integration B2B components while another component is using the assigned port. Starting and Stopping OracleAS Integration B2B Components with OPMN You can also start and stop the B2B server and OC4J instance components of OracleAS Integration B2B from the operating system command prompt of Oracle_ Home/opmn/bin using the Oracle Process Manager and Notification Server (OPMN). To stop the B2B server and OC4J instance individually: 1. Enter the following commands at your operating system command prompt to stop the B2B server and OC4J instance. prompt> opmnctl stopproc process-type=B2BServer System Management with Oracle Enterprise Manager 10g 18-9 Additional Oracle Application Server and OracleAS Integration B2B Management Tasks prompt> opmnctl stopproc process-type=OC4J_B2B To start the B2B server and OC4J instance individually: 1. Enter the following commands at your operating system command prompt to start the B2B server and OC4J instance. prompt> opmnctl startproc process-type=B2BServer prompt> opmnctl startproc process-type=OC4J_B2B To start and stop the B2B server and OC4J instance together: 1. Enter the following commands at your operating system command prompt to start and stop the B2B server and OC4J instance together. prompt> opmnctl startproc ias-component=B2B prompt> opmnctl stopproc ias-component=B2B See the following for more information: ■ Oracle Process Manager and Notification Server Administrator’s Guide ■ Oracle Application Server Administrator’s Guide Additional Oracle Application Server and OracleAS Integration B2B Management Tasks Table 18–3 describes additional Oracle Application Server administration tasks that also relate to OracleAS Integration B2B. References to documentation that describes these tasks are also provided. Table 18–3 Additional Oracle Enterprise Manager 10g Tasks Task See Also Configure an Oracle Application Server instance to use Infrastructure Services. Oracle Application Server Administrator’s Guide Installing and configuring Oracle Application Server for Oracle Application Server Installation high availability (including Oracle Application Server Guide Cold Failover Cluster) Changing Internet Protocol (IP) addresses and host names for an Oracle Application Server host Oracle Application Server Administrator’s Guide Viewing and changing ports Oracle Application Server Administrator’s Guide "OracleAS Integration B2B Port Management" on page 18-9 "Changing Port Numbers" on page 18-11 Using the dynamic host configuration protocol (DHCP) Oracle Application Server in Windows and Linux environments. Administrator’s Guide Configuring Oracle HTTP Server for secure socket layer Oracle HTTP Server Administrator’s (SSL) and secure HTTP Guide Configuring OC4J for SSL and secure HTTP 18-10 Oracle Application Server Integration B2B User’s Guide Oracle Application Server Security Guide Changing Port Numbers Table 18–3 (Cont.) Additional Oracle Enterprise Manager 10g Tasks Task See Also Configuring firewalls and load balancing Oracle Application Server High Availability Guide Changing Port Numbers Oracle Enterprise Manager 10g uses dynamic monitoring services (DMS) ports to gather performance data about Oracle Application Server components. For this release, OracleAS Integration B2B does not seamlessly support the use of dynamic ports. Instead, static port numbers assigned during installation are used for gathering performance data. Changing a port number is a complicated procedure. Oracle strongly recommends that you do not change port numbers. Instead, find the process that uses the ports, and stop that process (or whatever else is required to free that port). However, if you must change the port number, follow the instructions in this section. This section contains these topics: ■ Port Changing Error Message ■ Modifying Ports See the following for more information: ■ ■ Oracle Application Server Performance Guide for additional details about DMS "OracleAS Integration B2B Monitoring and Administration Tasks" on page 18-6 for instructions on stopping OracleAS Integration B2B processes Port Changing Error Message This error message occurs when you attempt to start OracleAS Integration B2B components, while another component is already using the assigned port: isunrak21(17:45:03):/private/sabburi/m13/opmn/bin % opmnctl startproc process-type=B2BServer opmnctl: starting opmn managed processes... ================================================================================ opmn id=isunrak21:6200 0 of 1 processes started. ias-instance id=m13.isunrak21 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ias-component/process-type/process-set: B2B/B2BServer/m13.isunrak21 Error --> Process (pid=0) failed to start a managed process after the maximum retry limit no port available from the port range no port available from the port range Log: none Modifying Ports If you must change the port number, follow these instructions: System Management with Oracle Enterprise Manager 10g 18-11 Changing Port Numbers 1. Make backup copies of the opmn.xml and targets.xml files to be modified in these procedures before you begin. 2. Stop all OPMN and Oracle Enterprise Manager 10g processes: emctl stop iasconsole opmnctl stopall 3. Open the Oracle_Home/opmn/conf/opmn.xml file. 4. Modify the range attribute of the port element for the corresponding OracleAS Integration B2B component. <process-type id="B2BServer" module-id="b2bengine" working-dir="$ORACLE_HOME/ip" status="enabled"> <module-data> <category id="start-parameters"> <data id="java-parameters" value="-server -Xms8M -Xmx512M"/> </category> </module-data> <port id="dms" range="8777"/> <process-set id="%IASNAME%" numprocs="1"/> <start timeout="3600"/> <stop timeout="3600"/> </process-type> 5. Open Oracle_Home/sysman/emd/targets.xml. 6. Change the "HTTPPort" attribute to the port you specified in opmn.xml in Step 4. <Target TYPE="oracle_integb2b_engine" NAME="as.dhcp-dci-stevens-towers-125-95-159-245.dci.acme.com_B2BServer" DISPLAY_NAME="B2BServer" VERSION="3.0"> <Property NAME="OracleHome" VALUE="D:\OraHome1\as"/> <Property NAME="EmptyOracleHome" VALUE=""/> <Property NAME="HTTPPort" VALUE="8777"/> <Property NAME="HTTPMachine" VALUE="stdevtemp"/> <Property NAME="OPMNPort" VALUE="6003"/> <Property NAME="OidRepSchemaName" VALUE="B2B"/> <AssocTargetInstance ASSOC_TARGET="ias" TYPE="acme_ias" NAME="as.dhcp-dci-stevens-towers-125-95-159-245.dci.acme.com"/> <CompositeMembership> <MemberOf TYPE="oracle_integb2b_instance" NAME="as.dhcp-dci-stevens-towers-125-95-159-245.dci.acme.com_B2B_Instance"/> </CompositeMembership> </Target> 7. Run the following command: Oracle_Home/dcm/bin/dcmctl updateConfig 8. Restart OPMN (and the Oracle Enterprise Manager 10g Application Server Control Console, if you are using it). opmnctl startall emctl start iasconsole See Oracle Application Server Administrator’s Guide for details about port ranges. 18-12 Oracle Application Server Integration B2B User’s Guide Summary Summary This chapter explains how to use Oracle Enterprise Manager 10g to manage OracleAS Integration B2B (for example, starting and stopping the B2B server or OC4J instance components, viewing log files, and editing server properties). For this initial release, OracleAS Integration B2B can only be managed from the Oracle Enterprise Manager 10g Application Server Control Console. Oracle Enterprise Manager 10g Grid Control Console management of OracleAS Integration B2B is not supported. System Management with Oracle Enterprise Manager 10g 18-13 Summary 18-14 Oracle Application Server Integration B2B User’s Guide 19 Creating Reports This chapter describes how to create OracleAS Integration B2B reports that describe the status of run-time behavior of a deployed configuration. This chapter contains the following topics: ■ Reports Overview ■ Creating Business Message Status Reports ■ Creating Wire Message Status Reports ■ Creating Collaboration Status Reports ■ Creating Error Status Reports ■ Saving Reports ■ Saving Report Definitions ■ Importing Reports ■ Summary Reports Overview Instance data exists in the runtime repository as business messages are exchanged. The OracleAS Integration B2B user interface enables you to query this information to see what is occurring and to perform business analysis. You can query this information in several different ways based on the type that you want. Specifically, you can query for information such as business message status, wire message status, collaboration status, and errors. Reports User Role A trading partner can include individuals such as business analysts who must be able to create and analyze configuration reports. For these situations, OracleAS Integration B2B provides a Reports user role that you can assign to host trading partner users. This role provides a user with access to only the functionality of the Reports tab of the OracleAS Integration B2B user interface. A user with this role cannot see or access the other parts of the user interface. Note that a host trading partner user with the Administrator role can access the functionality of the entire OracleAS Integration B2B user interface, including the Reports tab. See "Assigning a User Role to a Host Trading Partner Person" for instructions on assigning the Reports role to a host trading partner user. Creating Reports 19-1 Creating Business Message Status Reports Creating Business Message Status Reports Business message status reports identify business message instance details for an electronic data interchange (EDI) or Custom Document business protocol. These details include the sending and receiving trading partners, exchange protocol, document protocol, business action and its state, message date, and message details. Follow these instructions to create a business message status report. 1. Click Reports, and then Business Message. The Business Message Report Definition page appears. 2. 19-2 Enter the following details. An asterisk (*) indicates a required field. Field Value Name* Accept the default business message report name or enter a unique and recognizable name. Start Date Use the calendar icon to select the date at which to start collecting message details. End Date Use the calendar icon to select the date at which to complete collecting message details. Business Action Name Select the business action from the list. 3. If you want to specify advanced report parameters, click Show Advanced Report Options. 4. Enter the following details: Field Value Business Message Id Enter an identifier in the field. This is a 16-digit value that you can obtain from the Oracle_Home/ip/log/b2b/b2b.log file. You can enter a portion of this value, and all values that include the portion entered are returned. Oracle Application Server Integration B2B User’s Guide Creating Business Message Status Reports Field Value Business Message Status Select the status of the business message from the list: ■ Aborted Message processing was aborted. ■ Collab Wait A message is waiting for collaboration activity to complete. ■ Complete Message delivery and all processing has completed. ■ Continue Process Message processing is continuing. ■ Error An error occurred during message processing. ■ Invalid The message is invalid. ■ Out of Band Error An out-of-band error has occurred. ■ Process Ack An acknowledgment message is processing for this business message (not a valid state for an acknowledgment message). ■ Process Exp An exception message is processing for this business message (not a valid state for an exception message). ■ Send Ack An acknowledgment message has been sent. ■ Send Exp An exception message has been sent. ■ Transmit Failed Message transmission has failed. Depending upon the number of retries specified, this message may be sent later. If all retries fail, the status of this message changes to an error. ■ Wait Ack Waiting for an acknowledgment message. ■ Wait Transmit Waiting for a message to be transmitted. Sending Trading Partner Select the trading partner that sent the message. Receiving Trading Partner Select the trading partner that received the message. Sending Trading Partner Identification Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code). Sending Trading Partner Value Select the sending trading partner identification type value. For example, if you selected DUNS, select the Data Universal Numbering System (DUNS) number. Receiving Trading Partner Identification Select the trading partner identification type of the receiving trading partner. Receiving Trading Partner Value Select the receiving trading partner identification type value. Creating Reports 19-3 Creating Wire Message Status Reports Field Value Business Protocol Select the specific EDI, RosettaNet, or Custom Document business protocol used in this business transaction between sending and receiving trading partners. Agreement Name Select the trading partner agreement in which the sending and receiving trading partners are participants. Configuration Name Select the configuration that includes this trading partner agreement. By default, the report results come from the latest active configuration. Comments Enter comments to display under the title after report creation is complete. 5. Click Run Report. The status report appears. 6. View specific details. If you want to save the report results to a comma-delimited file, click Save Report. 7. If you want to save the report definition, click Save Definition. Creating Wire Message Status Reports Wire messages are the native format of data sent from trading partners. Wire messages can contain a number of sections, such as payloads, attachments, or trailers. Wire message status reports identify details about wire message instances, such as the transport protocol name, the transport protocol revision, and the protocol message identification and its state. Follow these instructions to create a wire message status report. 1. Click Reports, and then Wire Message. The Wire Message Report Definition page appears. 2. 19-4 Enter the following details. An asterisk (*) indicates a required field. Field Value Name* Accept the default wire message report name or enter a unique and recognizable name. Start Date Use the calendar icon to select the date at which to start collecting message details. End Date Use the calendar icon to select the date at which to complete collecting message details. Protocol Message Id Enter the protocol message identification. You can obtain this value from the Oracle_Home/ip/log/b2b/b2b.log file or from the trading partners that sent or received the message. You can enter a portion of this value, and all values that include the portion entered are returned. Oracle Application Server Integration B2B User’s Guide Creating Wire Message Status Reports Field Value Transport Protocol Select a transport protocol about which to collect data from the list: Wire Message Status ■ AQ - 1.0 ■ B2B Queues - 1.0 ■ E-Mail - 1.0 ■ FTP - 1.0 ■ File - 1.0 ■ HTTP - 1.0 ■ HTTP - 1.0 (Secure) ■ HTTP - 1.1 ■ HTTP - 1.1 (Secure) ■ JMS - 1.0 ■ XML Gateway Queues - 1.0 Select the wire message status from the list: ■ Complete Message processing has completed. ■ Consumed The message has been deleted. ■ Error An error occurred during message processing. ■ Processing The message is currently processing. 3. If you want to specify advanced report parameters, click Show Advanced Report Options. 4. Enter the following details: Field Value Sending Trading Partner Select the trading partner that sent the message. Receiving Trading Partner Select the trading partner that received the message. Sending Trading Partner Identification Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code). Sending Trading Partner Value Select the sending trading partner identification type value. For example, if you selected DUNS, select the DUNS number. Receiving Trading Partner Identification Select the trading partner identification type of the receiving trading partner. Receiving Trading Partner Value Select the receiving trading partner identification type value. Configuration Name Select the configuration that includes this trading partner agreement. By default, the report results come from the latest active configuration. Comments Enter comments to display under the title after report creation is complete. Creating Reports 19-5 Creating Collaboration Status Reports 5. Click Run Report. The status report appears. 6. View specific details. If you want to save the report results to a comma-delimited file, click Save Report. 7. If you want to save the report definition, click Save Definition. Creating Collaboration Status Reports Collaboration status reports identify collaboration instance details for the RosettaNet over RNIF business protocol. These details include the revision, protocol collaboration identification, state, and start and end times for the collaboration. Follow these instructions to create a collaboration status report. 1. Click Reports, and then Collaboration. The Collaboration Report Definition page appears. 2. Enter the following details. An asterisk (*) indicates a required field. Field Value Name* Accept the default collaboration report name or enter a unique and recognizable name. Start Date Use the calendar icon to select the date at which to start collecting message details. End Date Use the calendar icon to select the date at which to complete collecting message details. Collaboration Name Select the collaboration from the list (for example, 3A4). 3. If you want to specify advanced report parameters, click Show Advanced Report Options. 4. Enter the following details: Field Value Protocol Collaboration Id Enter an identifier in the field. You can obtain this value from the Oracle_Home/ip/log/b2b/b2b.log file or from the trading partners that sent or received the collaboration. You can enter a portion of this value, and all values that include the portion entered are returned. Collaboration Status Select the collaboration message status from the list: ■ Aborted Collaboration processing was aborted. ■ Complete Collaboration delivery has completed. ■ Error An error occurred during collaboration processing. ■ In Progress The collaboration is currently in progress. ■ Out of Band Error An out-of-band error has occurred. 19-6 Oracle Application Server Integration B2B User’s Guide Creating Error Status Reports Field Value Sending Trading Partner Select the trading partner that sent the message. Receiving Trading Partner Select the trading partner that received the message. Sending Trading Partner Identification Select the trading partner identification type of the sending trading partner (for example, DUNS or EDI Location Code). Sending Trading Partner Value Select the sending trading partner identification type value. For example, if you selected DUNS, select the DUNS number. Receiving Trading Partner Identification Select the trading partner identification type of the receiving trading partner. Receiving Trading Partner Value Select the receiving trading partner identification type value. Agreement Name Select the trading partner agreement in which the sending and receiving trading partners are participants. Configuration Name Select the configuration that includes this trading partner agreement. By default, the report results come from the latest active configuration. Comments Enter comments to display under the title after report creation is complete. 5. Click Run Report. The status report appears. 6. View specific details. If you want to save the report results to an XML file, click Save Report. 7. If you want to save the report results to a comma-delimited file, click Save Report. 8. If you want to save the report definition, click Save Definition. Creating Error Status Reports Error status reports identify error message details. These details include the error code, error text, business message identification, message date, and message details. Follow these instructions to create an error message status report. 1. Click Reports, and then Error. The Error Report Definition page appears. 2. Enter the following details. An asterisk (*) indicates a required field. Field Value Name* Accept the default error status report name or enter a unique and recognizable name. Start Date Use the calendar icon to select the date at which to start collecting message details. End Date Use the calendar icon to select the date at which to complete collecting message details. Message Type Select Business Message, select Wire Message, or leave this field unselected to collect data for both message types. Creating Reports 19-7 Saving Reports 3. If you want to specify advanced report parameters, click Show Advanced Report Options. Field Value Configuration Name Select the configuration that includes this trading partner agreement. By default, the report results come from all configurations. For this reason, no configuration is selected by default. Comments Enter comments to display under the title after report creation is complete. 4. Click Run Report. The status report appears. 5. View specific details. If you want to save the report results to a comma-delimited file, click Save Report. 6. If you want to save the report definition, click Save Definition. Saving Reports You can save the generated reports in comma-delimited format. This enables you to view reports in Microsoft Excel. Follow these instructions to save the contents of a generated report: 1. Create an appropriate report. 2. Click Run Report. The status page appears. 3. Click Save Report. The report contents are saved to comma-delimited format. Only Microsoft Excel is supported for viewing comma-delimited reports. Saving Report Definitions You can save the contents of your generated reports to XML files. You can then reimport the report contents as needed into the OracleAS Integration B2B user interface. Follow these instructions to save the contents of a generated report: 1. Create an appropriate report. 2. Click Run Report. The status page appears. 3. Click Save Definition. The report contents are copied to an XML file that you are prompted to open or download to a directory location. Importing Reports You can import a report that you saved previously to an XML file through the Save Definition option. 19-8 Oracle Application Server Integration B2B User’s Guide Summary Follow these instructions to import a saved report: 1. Click Reports, and then Import. The Import page appears. 2. Click Browse to select a report definition file to import. 3. Click Finish. The report contents are reimported and the report results appear in OracleAS Integration B2B. Summary This chapter describes how to create business message, wire message, collaboration, and error status reports. This chapter also describes how to save report results to a comma-delimited file for viewing in Microsoft Excel and how to save the report definition to an XML file that you can later reimport into OracleAS Integration B2B. Creating Reports 19-9 Summary 19-10 Oracle Application Server Integration B2B User’s Guide 20 OracleAS Integration B2B Security This chapter describes the architecture and configuration of security for OracleAS Integration B2B. This chapter contains the following topics: ■ ■ The OracleAS Integration B2B Security Model Configuring Oracle Application Server Security Framework for OracleAS Integration B2B ■ Configuring OracleAS Integration B2B Security ■ Summary See the following for more information: ■ ■ Oracle Application Server Security Guide for an overview of Oracle Application Server security and its core functionality Oracle Identity Management Concepts and Deployment Planning Guide for guidance for administrators of the Oracle security infrastructure The OracleAS Integration B2B Security Model This section describes the OracleAS Integration B2B security model. This section contains these topics: ■ Classes of Users and Their Privileges ■ Resources Protected ■ Authorization and Access Enforcement ■ Use of Oracle Application Server Security Services ■ Use of Oracle Identity Management Infrastructure Classes of Users and Their Privileges A single user named admin is automatically created during OracleAS Integration B2B installation. The password for admin is the same one you specified for the Oracle Application Server administrator named ias_admin when prompted during the J2EE and Web Cache and OracleAS Integration B2B installations. The admin user consists of a single default user role named Administrator. The Administrator role consists of the use cases (privileges) that enable the admin user to use the entire functionality of the OracleAS Integration B2B user interface to design, deploy, monitor, and manage integrations. A Reports role is also available for users OracleAS Integration B2B Security 20-1 The OracleAS Integration B2B Security Model (such as business analysts) that require access to only the Reports tab of the OracleAS Integration B2B user interface. The admin user can create additional users to which to assign the Administrator role. You can also administer portions of OracleAS Integration B2B from the Oracle Enterprise Manager 10g Application Server Control Console. Log in with the ias_ admin username. Use the same password for ias_admin that you specified when prompted during the J2EE and Web Cache and OracleAS Integration B2B installations. See the following for more information: ■ ■ ■ ■ ■ "Creating a Trading Partner Person" on page 10-22 to create additional users of the OracleAS Integration B2B user interface "Assigning a User Role to a Host Trading Partner Person" on page 10-24 to assign the Administrator or Reports role to a user "Viewing a Trading Partner Person and Updating the Person Password" on page 10-22 to update the admin user password "Updating a Host or Remote Trading Partner" on page 10-7 to update the name Chapter 18, "System Management with Oracle Enterprise Manager 10g" to administer OracleAS Integration B2B from the Oracle Enterprise Manager 10g Application Server Control Console Resources Protected The following security is provided for protecting resources: ■ ■ ■ ■ The partner data that you design with the OracleAS Integration B2B user interface is protected by both the admin username and password and by the security provided by the Oracle database used for the Oracle Application Server Metadata Repository. Network messaging can be secured and encrypted using Oracle Advanced Security. Network messaging can also be secured by using secure HTTP with the OracleAS Integration B2B user interface. Transport protocols that enable communication between applications and OracleAS Integration B2B use their own security (such as HTTP, FTP, and SMTP) to restrict access to data. The messages that trading partners send and receive during integrations between enterprises are protected by the following levels of security: ■ Digital envelopes and certificates ■ Digital signatures for host and remote trading partners ■ Secure HTTP (using secure socket layer (SSL)) ■ Encrypted wallet password for a host trading partner See "OracleAS Integration B2B Security Configuration" on page 20-4 for an overview of security configuration for integrations between enterprises. Authorization and Access Enforcement When you attempt to access the OracleAS Integration B2B user interface, you are prompted for a username and password. Without knowledge of this connection information, you cannot access the user interface to design, deploy, and manage integrations between enterprises. 20-2 Oracle Application Server Integration B2B User’s Guide Configuring OracleAS Integration B2B Security Use of Oracle Application Server Security Services Oracle Application Server provides a series of security services. OracleAS Integration B2B enables you to use SSL. You can use SSL for securing connections between host and remote trading partners. SSL uses a public key infrastructure to provide authentication and data integrity. Secure HTTP can also be used to secure the OracleAS Integration B2B user interface. See Oracle Application Server Security Guide for a description of Oracle Application Server security services. Use of Oracle Identity Management Infrastructure This release of OracleAS Integration B2B does not require use of Oracle Identity Management infrastructure features; Oracle Identity Management is optionally selectable for use during OracleAS Integration B2B installation and is only used for OracleAS Integration B2B schema password storage. Configuring Oracle Application Server Security Framework for OracleAS Integration B2B This section describes Oracle Application Server security options to configure to use OracleAS Integration B2B. This section contains these topics: ■ OracleAS Integration B2B Security Framework Configuration Issues ■ Identity Management Configuration Issues Specific to OracleAS Integration B2B OracleAS Integration B2B Security Framework Configuration Issues The OracleAS Integration B2B schema is protected by a password created during Oracle Application Server Infrastructure installation. These schemas are stored in the metadata repository of Oracle Application Server Infrastructure to which you configure access during OracleAS Integration B2B installation. In addition, the partner data you design, deploy, and manage with the OracleAS Integration B2B user interface is stored in this same metadata repository of Oracle Application Server Infrastructure. See the following for more information: ■ ■ Oracle Application Server Security Guide for Oracle Application Server Infrastructure and Oracle Application Server security details, including how to configure the Oracle HTTP Server with secure HTTP Oracle Application Server Containers for J2EE Security Guide Identity Management Configuration Issues Specific to OracleAS Integration B2B This initial release of OracleAS Integration B2B does not use the identity management infrastructure. Therefore, there are no identity management configuration issues and options. Configuring OracleAS Integration B2B Security This section provides an overview of OracleAS Integration B2B installation and configuration issues. This section contains these topics: ■ OracleAS Integration B2B Installation OracleAS Integration B2B Security 20-3 Configuring OracleAS Integration B2B Security ■ OracleAS Integration B2B Security Configuration ■ Host Trading Partner Password Encryption in High Availability Environments ■ Configuration Issues and Options for Oracle Application Server Security ■ Oracle HTTP Server Transport Servlet and OracleAS Integration B2B OracleAS Integration B2B Installation This section describes OracleAS Integration B2B security installation issues. Required Information for Installing OracleAS Integration B2B While you do not specify security parameters when installing OracleAS Integration B2B, the Oracle Application Server administrator must know the following information to install OracleAS Integration B2B: ■ ■ ■ ■ The name of the host on which the Oracle Application Server Infrastructure installation to use as the metadata repository is installed The specific Oracle Application Server Infrastructure installation on that host that includes the OracleAS Integration B2B schema The OracleAS Integration B2B schema password automatically created during Oracle Application Server Infrastructure installation The ias_admin password specified during J2EE and Web Cache installation, which is used as the initial password for the OracleAS Integration B2B admin user and for the Oracle Enterprise Manager 10g Application Server Control Console ias_admin user See Oracle Application Server Integration B2B Installation Guide for OracleAS Integration B2B installation instructions. OracleAS Integration B2B Security Configuration You configure security with the OracleAS Integration B2B user interface after installation. OracleAS Integration B2B provides the following levels of security: ■ Digital Envelopes and Certificates for Host and Remote Trading Partners ■ Digital Signatures for Host and Remote Trading Partners ■ Secure HTTP and Client Authentication ■ Encrypted Wallet Passwords for Host Trading Partners See "Creating a Trading Partner Agreement" on page 12-5 to create a trading partner agreement to which to assign a trading partner with its delivery channel characteristics. Digital Envelopes and Certificates for Host and Remote Trading Partners You can create encrypted business messages with remote trading partner certificates. Table 20–1 provides an overview of the tasks. Table 20–1 Host and Remote Trading Partner Certificate Tasks Tasks Assign a digital envelope to a remote trading partner with the Create Trading Partner wizard: 20-4 Oracle Application Server Integration B2B User’s Guide See... Configuring OracleAS Integration B2B Security Table 20–1 (Cont.) Host and Remote Trading Partner Certificate Tasks Tasks ■ ■ Select Yes from the Encryption Enabled list of the Create Trading Partner: Delivery Channel page. Select a digital envelope from the Digital Envelope list of the Create Trading Partner: Document Exchange page. See... ■ ■ "Page 4: Delivery Channel Page" on page 9-15 "Page 5: Document Exchange Page" on page 9-17 Assign remote trading partner certificates through either of two methods: With the Create Trading Partner wizard: ■ ■ Enter a remote certificate name in the Name field of the Create Trading Partner: Document Exchange page. Click Browse to select a certificate file for the Certificate File field of the Create Trading Partner: Document Exchange page. Without the Create Trading Partner wizard: ■ ■ ■ Note: Creating a remote trading partner certificate through this second method means that you must manually attach the correct digital envelope. "Page 5: Document Exchange Page" on page 9-17 "Page 5: Document Exchange Page" on page 9-17 "Creating a Remote Trading Partner Certificate" on page 10-13 Assign a wallet password to the host trading partner in the user interface: ■ ■ Create a wallet password with the user interface. Specify a wallet location on the Server Properties page of Oracle Enterprise Manager 10g Application Server Control Console. ■ ■ "Creating a Host Trading Partner Wallet Password" on page 10-15 "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 These digital envelope and remote trading partner certificate details comprise a portion of the delivery channel characteristics. You can then assign the delivery channel to a trading partner participating in a trading partner agreement. See the following for more information: ■ Chapter 9, "Creating Trading Partners" for information on the different methods for using the Create Trading Partner wizard ■ "Creating a Trading Partner Agreement" on page 12-5 ■ Oracle Application Server Certificate Authority Administrator’s Guide Digital Signatures for Host and Remote Trading Partners You can use a digital signature with host and remote trading partners. The digital signature ensures that the message is authentic. Table 20–2 provides an overview of the tasks for configuring digital signatures. OracleAS Integration B2B Security 20-5 Configuring OracleAS Integration B2B Security Table 20–2 Digital Signature Tasks Tasks See... Assign digital signatures to host and remote trading partners with the Create Trading Partner wizard: ■ Select Yes from the Is Non-Repudiation of Origin Required list and Is Non-Repudiation of Receipt Required list on the Create Trading Partner: Delivery Channel page. ■ "Page 4: Delivery Channel Page" on page 9-15 Notes: If you select Yes from the Is Non-Repudiation of Origin Required list, you must also select Yes from the Is Non-Repudiation of Receipt Required list. In a trading partner agreement, both the host and remote trading partners must have the same values for Is Non-Repudiation of Origin Required and Is Non-Repudiation of Receipt Required. ■ Select a digital signature from the Digital Signature list of the Create Trading Partner: Document Exchange page. ■ "Page 5: Document Exchange Page" on page 9-17 Note: Oracle recommends that you select a digital signature that uses SHA-RSA. Assign a signing credential to a remote trading partner with the Create Trading Partner wizard: ■ ■ Enter a signing credential name in the Name field of the Create Trading Partner: Document Exchange page. Click Browse to select a signing credential for the Certificate File field of the Create Trading Partner: Document Exchange page. ■ ■ "Page 5: Document Exchange Page" on page 9-17 "Page 5: Document Exchange Page" on page 9-17 Assign a wallet password to the host trading partner: ■ ■ Update the wallet password in the user interface. Update the wallet location on the Server Properties page of Oracle Enterprise Manager 10g Application Server Control Console. ■ ■ "Updating a Host Trading Partner Wallet Password" on page 10-16 "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 These digital signature details comprise a portion of the delivery channel characteristics. You can then assign the delivery channel to a trading partner participating in a trading partner agreement. See the following for more information: ■ ■ Chapter 9, "Creating Trading Partners" for information on the different methods for using the Create Trading Partner wizard "Creating a Trading Partner Agreement" on page 12-5 Secure HTTP and Client Authentication You can use SSL to secure connections between host and remote trading partners. Table 20–3 provides an overview of the parts to configuring SSL. 20-6 Oracle Application Server Integration B2B User’s Guide Configuring OracleAS Integration B2B Security Table 20–3 SSL Tasks Part Task 1 Assign SSL for transport security with the Create Trading Partner wizard: ■ ■ 2 See... Select Yes from the Transport Security Enabled list of the Create Trading Partner: Delivery Channel page. Select HTTP 1.0 (Secure) or HTTP 1.1 (Secure) from the Transport Protocol list of the Create Trading Partner: Transport page. ■ ■ "Page 4: Delivery Channel Page" on page 9-15 "Page 6: Transport Page" on page 9-21 Set up a certificate authority (CA): ■ Start Oracle Wallet Manager at the operating system command prompt: Oracle Application Server Administrator’s Guide owm ■ ■ ■ 3 Export the entire wallet into a text file. The file requires a .txt extension. Place this file in the same location as the original wallet file. Assign a wallet password to the host trading partner: ■ ■ 4 Import a trading partner’s CA into Oracle Wallet Manager. Update the wallet password you created previously. Update the wallet location on the Server Properties page of Oracle Enterprise Manager 10g Application Server Control Console. Configure SSL server and client authentication for Oracle Application Server. ■ ■ ■ ■ "Updating a Host Trading Partner Wallet Password" on page 10-16 "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 Oracle Application Server Administrator’s Guide Oracle Application Server Security Guide These SSL details comprise a portion of the delivery channel characteristics. You can then assign the delivery channel to a trading partner participating in a trading partner agreement. Note: Oracle Wallet Manager allows only base64 files to be imported. Use Internet Explorer or another tool to convert a nonbase64 encoded certificate to base64. See the following for more information: ■ ■ Chapter 9, "Creating Trading Partners" for information on the different methods for using the Create Trading Partner wizard "Creating a Trading Partner Agreement" on page 12-5 Troubleshooting SSL Setup Follow these instructions to troubleshoot SSL setup: OracleAS Integration B2B Security 20-7 Configuring OracleAS Integration B2B Security Use the browser to connect to the secure HTTP URL. Upon successful connection, the following details are viewable: ■ ■ If you are using Internet Explorer, then from File, select Properties. The connection information appears. A Certificates button that displays certificate information also appears. You may get a confirmation page from the remote server. Verifying SSL Client Authentication Follow these instructions to verify SSL client authentication: ■ ■ Using the Netscape browser: 1. Import an Oracle Wallet by selecting Communicator, then Tools, then Security Info, then Certificates, then Yours, and then Import a Certificate from the main menu. 2. Connect to the secure HTTP URL. Using the Internet Explorer browser: Internet Explorer does not recognize the .p12 file generated using Oracle Wallet. Perform these steps to import the Oracle Wallet: 1. Import the Oracle Wallet by selecting Communicator, then Tools, then Security Info, then Certificates, then Yours, and then Import a Certificate from the main menu. 2. Export the Oracle Wallet by selecting Communicator, then Tools, then Security Info, then Certificates, then Yours, and then Export. 3. Import this Oracle Wallet into Internet Explorer and try connecting to the secure HTTP URL. Encrypted Wallet Passwords for Host Trading Partners OracleAS Integration B2B uses an Oracle Wallet for storing private and public keys. A wallet password is required for accessing an Oracle Wallet. You create an initial wallet password and an Oracle Wallet with Oracle Wallet Manager. The wallet password is stored in encrypted format in the Oracle Application Server Metadata Repository. This wallet is used for digital envelopes, digital signatures, and SSL. Table 20–4 provides an overview of the tasks to perform in the OracleAS Integration B2B user interface after you create the wallet password and Oracle Wallet: Table 20–4 20-8 Host Trading Partner Wallet Password Task See... Create a host trading partner wallet password "Creating a Host Trading Partner Wallet Password" on page 10-15 Specify the directory location for the wallet file "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 to access the OracleAS Integration B2B server properties (under the Server Properties section) with Oracle Enterprise Manager 10g Application Server Control Console. The Wallet Location property enables you to specify the directory location for the wallet file. Note: Enter the same wallet password that you created in Oracle Wallet Manager. If you later change the wallet password in Oracle Wallet Manager, you must also update the password in the OracleAS Integration B2B user interface. Oracle Application Server Integration B2B User’s Guide Configuring OracleAS Integration B2B Security Host Trading Partner Password Encryption in High Availability Environments OracleAS Integration B2B provides a feature that automatically encrypts the host trading partner’s OracleAS Integration B2B passwords through use of an obfuscated, encryption key created during installation. If you want to change this key value, do so during OracleAS Integration B2B downtime, as all passwords within the OracleAS Integration B2B schema are re-encrypted. A new encryption key is then created. If OracleAS Integration B2B is part of a high availability or disaster recovery configuration and you want to change the encryption key, you must perform the following procedures: 1. Follow the instructions in "Managing and Monitoring a Middle-Tier Instance from Oracle Enterprise Manager 10g Application Server Control Console" on page 18-4 to log in to the Oracle Enterprise Manager 10g Application Server Control Console and access the primary OracleAS Integration B2B instance. 2. Shut down the B2B server and Oracle Application Server Containers for J2EE (OC4J) instance subcomponents on the primary system on which OracleAS Integration B2B is installed. 3. Go to the Security Key parameter on the Server Properties page. 4. Make the following changes: a. Change the encryption key in the Security Key field. b. Check the Re-encrypt Security Key for B2B Repository box. This action re-encrypts the OracleAS Integration B2B schema password. 5. Click Apply. 6. Go to the secondary (or backup) system of which OracleAS Integration B2B is a part. 7. Repeat Steps 2 and 3 on the secondary system. 8. Enter the same encryption key in the Security Key field as you did in Step 4a. However, do not check the Re-encrypt Security Key for B2B Repository box. 9. Repeat Steps 6 through 8 for additional secondary systems. 10. Restart the primary and secondary systems. Configuration Issues and Options for Oracle Application Server Security You can enable encryption between OracleAS Integration B2B and the OracleAS Metadata Repository by setting several Oracle Net configuration parameters. For example, you can encrypt JDBC with the following sqlnet.ora parameters: sqlnet.encryption_server=accepted sqlnet.encryption_client=requested sqlnet.encryption_types_server=(RC4_40) sqlnet.encryption_types_client=(RC4_40) sqlnet.crypto_seed ="-kdje83kkep39487dvmlqEPTbxxe70273" See Also: Oracle Database Advanced Security Administrator's Guide available on the Oracle Technology Network: http://www.oracle.com/technology OracleAS Integration B2B Security 20-9 Configuring OracleAS Integration B2B Security Oracle HTTP Server Transport Servlet and OracleAS Integration B2B OracleAS Integration B2B is integrated with the transport servlet of the Oracle HTTP Server to provide security for incoming messages of trading partners. Messages sent from remote trading partners must first pass through the transport servlet of the Oracle HTTP Server that is automatically deployed after installation. The transport server receives and passes messages on to a remote method invocation (RMI) port and instance name to which the B2B server component of OracleAS Integration B2B listens. RMI functionality enables the different Java processes of the Oracle HTTP Server and the B2B server to interface. RMI also provides for scalability: you can configure one RMI to communicate with multiple B2B servers. The messages are then passed on to OracleAS Integration B2B. Figure 20–1 shows Oracle HTTP Server and OracleAS Integration B2B configuration. Figure 20–1 Oracle HTTP Server and OracleAS Integration B2B Firewall Remote Trading Partner Oracle HTTP Server OracleAS Integration B2B RMI (host trading partner) Outside Corporate Network Inside Corporate Network The RMI port number and instance name to which the OracleAS Integration B2B listens are automatically configured with the same values in both the transport servlet’s web.xml file and in the OracleAS Integration B2B server properties settings (accessible from the Oracle Enterprise Manager 10g Application Server Control Console). These values must be the same. If you change these values in one location, you must also change them to the same values in the other location. This procedure is followed only for incoming messages from remote trading partners. For security reasons, Oracle recommends that you install and configure an additional Oracle HTTP Server outside your corporate network to receive messages from remote trading partners and pass them onto the Oracle HTTP Server and OracleAS Integration B2B instances inside your corporate network. This additional Oracle HTTP Server hides the actual location of the host trading partner from all outside parties. 20-10 Oracle Application Server Integration B2B User’s Guide Summary See Also: ■ ■ ■ ■ Oracle Application Server Integration B2B Installation Guide for instructions on configuring an additional Oracle HTTP Server outside your corporate network Oracle HTTP Server Administrator’s Guide for additional transport servlet details Oracle Enterprise Manager 10g Application Server Control Console online Help for instructions on setting RMI port and RMI instance name values Oracle Application Server High Availability Guide for instructions on changing the RMI hostname value for high availability environments in which you have multiple OracleAS Integration B2B instances using the same Oracle Application Server Metadata Repository Summary This chapter describes the security provisions of OracleAS Integration B2B, including how to use the OracleAS Integration B2B user interface to configure digital envelopes, remote trading partner certificates, digital signatures, SSL, and host trading partner wallet passwords. OracleAS Integration B2B Security 20-11 Summary 20-12 Oracle Application Server Integration B2B User’s Guide A Troubleshooting and Workarounds This appendix describes OracleAS Integration B2B issues and workarounds. This appendix contains the following topics: ■ Retrieving the B2B Database Password ■ OracleAS Integration B2B Processing Is Very Slow ■ User Interface Pages Time Out Too Fast ■ B2B User Login Must Have a Role ■ Run-Time Error When Enqueuing a Message to IP_OUT_ENQUEUE ■ Checking the IP_IN_QUEUE and IP_OUT_QUEUE Queues ■ Running Reports ■ Checking Log Files ■ Correcting Out-of-Memory Errors ■ Resolving Connection Errors ■ Generic Exchange Protocol Workarounds ■ Configuration Changes and Redeployment After a Request Is Sent But Before a Response Is Received ■ Non-English OracleAS Integration B2B Pages in Oracle Enterprise Manager ■ Oracle Application Server Clustering and Integration B2B ■ Configuring OracleAS Integration B2B in Enterprise Environments Retrieving the B2B Database Password Log in to Oracle Internet Directory, where OracleAS Integration B2B accesses the database password. Go to the B2B component and change the password. (Entry Management > cn=OracleContext > Products > IAS > IAS Infrastructure Database > orclReferenceName > orclResourceName=B2B) OracleAS Integration B2B Processing Is Very Slow If OracleAS Integration B2B is very slow after processing a few thousand messages, purge the old run-time data. Troubleshooting and Workarounds A-1 User Interface Pages Time Out Too Fast User Interface Pages Time Out Too Fast If the UI pages time out too fast, do the following: 1. Go to Oracle_Home\j2ee\OC4J_ B2B\applications\b2b\ip\WEB-INF\web.xml. 2. Modify web.xml to include a <session-config> node under <web-app>, as follows: <web-app> ..... <session-config> <session-timeout>60</session-timeout> </session-config> ..... </web-app> 3. Restart OPMN. B2B User Login Must Have a Role Logging in as the b2b user, without first assigning a role to the b2b user, produces a blank page. You must first log in as admin and assign a role to the b2b user. Then the b2b user can log in, with functionality based on the assigned role. Run-Time Error When Enqueuing a Message to IP_OUT_ENQUEUE When you enqueue a message to IP_OUT_ENQUEUE, ensure that MSG_TYPE is set to 1, where 1 indicates a request message. See Table 4–1, " IP_MESSAGE_TYPE Parameters" on page 4-3 for more information. Checking the IP_IN_QUEUE and IP_OUT_QUEUE Queues OracleAS Integration B2B provides two queues that enable you to confirm the validity of messages. These queues can be used to integrate with any application that supports advanced queuing (AQ). ■ IP_IN_QUEUE queue For inbound messages, you can confirm if the message remains in this queue. ■ IP_OUT_QUEUE queue For outbound messages, you can confirm if the message remains in this queue. Running Reports OracleAS Integration B2B provides several report creation wizards that enable you to track the movement of messages and identify errors: ■ Error Status Report This report identifies errors and all exceptions that occur. This includes enqueue/dequeue errors on a queue, transport errors occurring during wire message communication, plug-ins errors, core errors, XEngine errors (an EDI document processing run-time API), and file handling errors. This report also enables you to access other report details. A-2 Oracle Application Server Integration B2B User’s Guide Checking Log Files ■ Wire Message Report This report enables you to check inbound and outbound wire messages to confirm that they are valid and have been received or sent. ■ Business Message Report This report identifies the exchange trail of messages between trading partners. See Chapter 19, "Creating Reports" for instructions on creating reports. Checking Log Files OracleAS Integration B2B creates log files describing all types of occurrences, including startup and shutdown details, errors, warning messages, access details on HTTP requests, and so on. The log file names and formats are determined by the oracle.tip.LogType setting in the Oracle_ Home/ip/config/tip.properties file. For example, the run-time log file and design-time log file are named as follows: If oracle.tip.LogType is Set to... Then the File Name is... ojdl (default) log.xml (for both files) text b2b.log ui.log You can view the log files in either of two ways: ■ ■ Through a command line editor: 1. Go to the Oracle_Home/ip/log/b2b directory. 2. Open the log.xml file or b2b.log file. 3. Search for: – Error messages (begin with AIP-) – Exceptions – iAudit report for validation errors in the XEngine (the EDI document processing run-time API) 4. Go to the Oracle_Home/ip/log/ui directory. 5. Open the log.xml file or ui.log file. 6. Search for design-time issues, such as deployment errors. Through Oracle Enterprise Manager 10g Application Server Control Console See "OracleAS Integration B2B Log Files" on page 18-7 for instructions on accessing log files through Oracle Enterprise Manager 10g Application Server Control Console. Setting Log Levels After installation, the OracleAS Integration B2B logging level is automatically set to ERROR. To create more detailed logging level information, set the level to DEBUG. Perform this task on the Server Properties page of Oracle Enterprise Manager 10g Application Server Control Console. Three server properties can be set: ■ Generic Log Level Troubleshooting and Workarounds A-3 Correcting Out-of-Memory Errors ■ B2B Server Log Level ■ User Interface Log Level Generic Log Level provides general B2B server and user interface logging results. This property value is overridden if you set B2B Server Log Level or User Interface Log Level. Both these properties provide more detailed logging results than setting only Generic Log Level. See "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 for instructions on setting log levels through Oracle Enterprise Manager 10g Application Server Control Console. Correcting Out-of-Memory Errors If many large messages are enqueued, OracleAS Integration B2B can stop processing with no indication of errors in the OracleAS Integration B2B log files. If this occurs, you can be experiencing an out-of-memory error. Out-of-memory errors that occur in OracleAS Integration B2B are logged in the Oracle Process Manager and Notification Server (OPMN) log files. This type of error can be corrected by increasing the heap size. 1. Open the Oracle_Home/opmn/log/B2B~B2BServer~instance_name file on your Oracle Application Server middle tier. For example, if your host is named myhostname and your Oracle home is named midtier, the log file is named C:\midtier\opmn\log\B2B~B2BServer~midtier.myhostname.us.oracl e.com~1. 2. Look for any out-of-memory errors: java.lang.OutOfMemoryError If you find this type of error, increase the heap size to correct the problem. 3. Open the Oracle_Home/opmn/conf/opmn.xml file on the same Oracle Application Server middle tier. 4. Find the process-type section for B2BServer, which looks similar to the following: <process-type id="B2BServer" module-id="b2bengine" working-dir="$ORACLE_HOME/ip" status="enabled"> <environment> <variable id="EDIFECS_HOME" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE"/> <variable id="ECRegistryPath" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/Validator/Docs/Settings/Pr oduction/registryValid ator.xml"/> <variable id="LD_PRELOAD" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/bin/Release/libxenginereso urcelib.so"/> <variable id="LD_LIBRARY_PATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/bin/Release" append="true"/> <variable id="PATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/bin/Release" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/edifecsXData .jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/edifecsXTest A-4 Oracle Application Server Integration B2B User’s Guide Resolving Connection Errors .jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/edifecs.jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/log.jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/xalan.jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/js.jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/bsf.jar" append="true"/> <variable id="CLASSPATH" value="$ORACLE_HOME/ip/oem/edifecs/EDIFECSXE/eTools/java/javalibs/xerces.jar" append="true"/> </environment> <module-data> <category id="start-parameters"> <data id="java-parameters" value="-server -Xms8M -Xmx512M"/> </category> </module-data> <start timeout="3600"/> <stop timeout="3600"/> <port id="dms" range="8777"/> @ <process-set id="midtier.iwinrcf19.us.oracle.com" numprocs="1"/> </process-type> 5. Find the java-parameters entry (identified in bold in the preceding text) and change the value of Xmx512M to a more appropriate value. 6. Save your changes. 7. Stop and restart the B2B server instance. See "OracleAS Integration B2B Monitoring and Administration Tasks" on page 18-6 for instructions on stopping and starting the B2B server instance. Resolving Connection Errors Table A–1 identifies connection errors you can receive and actions for correcting these errors. These errors can appear when you create reports to monitor the status of your business messages. Table A–1 Connection Errors and Corrective Actions Error Action Blank page in UI If the database server is busy, the user interface may show a blank page or may take a long time to process an action. Reduce the database server load. Unable to establish a connection 1. Connect to the transport servlet at http://hostname:port/b2b/transportServlet. 2. Ensure that the transport servlet is running. Troubleshooting and Workarounds A-5 Generic Exchange Protocol Workarounds Table A–1 (Cont.) Connection Errors and Corrective Actions Error Action Unable to contact the RMI server 1. Ensure that the B2B server instance is running in Oracle Enterprise Manager 10g Application Server Control Console. 2. Ensure that RMI Port and RMI Instance parameter values match those for the transport servlet. The transport servlet values are defined in the web.xml file. The OracleAS Integration B2B RMI Port and RMI Instance values are defined in the Server Properties page of Oracle Enterprise Manager 10g Application Server Control Console. Connection error Connection errors may also occur because the port and IP address of the trading partner is blocked by your firewall. Ensure that the corresponding port and IP address of the trading partner is not blocked by the firewall. See the following for more information: ■ ■ ■ "OracleAS Integration B2B Monitoring and Administration Tasks" for instructions on monitoring the status of the B2B server "OracleAS Integration B2B Middle-Tier Instance Server Properties" on page 18-8 for instructions on editing RMI Port and RMI Instance parameter values in Oracle Enterprise Manager 10g Application Server Control Console "Oracle HTTP Server Transport Servlet and OracleAS Integration B2B" on page 20-10 for details about the transport servlet and the web.xml file Connection Errors While Posting Messages to the Trading Partner URL If you encounter connection errors while posting messages to the trading partner URL (for HTTPS protocol), open the Oracle Wallet (ewallet.p12) using Oracle Wallet Manager. The default location of the Oracle Wallet is ORACLE_HOME/Apache/Apache/conf/ssl.wlt/default Inspect the wallet to ensure that the trading partner certificate was imported into the Oracle Wallet as a trusted certificate. Save the Oracle Wallet and export the entire wallet as wallet.txt in the same directory as ewallet.p12. Verify that the oracle.tip.adapter.b2b.WalletLocation field has a valid URI pointing to wallet.txt. An example of a valid URI is as follows: file:/private/oracle/Oracle_Home/Apache/Apache/conf/ssl.wlt/default/wallet.txt Generic Exchange Protocol Workarounds This section describes workarounds for using the generic exchange protocol. ■ Transport Protocol Parameter Settings for the FTP or File Transport Protocol ■ FTP Server on Windows Operating Systems ■ Generic Exchange Protocols and Functional Acknowledgments ■ Generic Exchange Protocols and Oracle Application Server Web Cache A-6 Oracle Application Server Integration B2B User’s Guide Generic Exchange Protocol Workarounds Transport Protocol Parameter Settings for the FTP or File Transport Protocol If you are using a business protocol with a generic exchange, and select the FTP or File transport parameter, you must specify the following values for the transport protocol parameters shown in Table A–2. Otherwise, your business transaction is deleted during transit. You specify these parameters on the Create Trading Partner: Transport page of the Create Trading Partner wizard for both host and remote trading partners. Table A–2 Transport Protocol Parameters for File or FTP Transport Protocol Parameter Value receiver read only ■ True Enables files in the inbound directory to be retrieved in the ascending order of their last-modified time. ■ False Enables files in the inbound directory, which have been successfully retrieved, to be deleted. receiver read ordered ■ True Files are retrieved in the ascending order of their last-modified time. ■ False Files are retrieved in a random fashion. receiver read ordered timestamp source ■ listtime (recommended) For the FTP transport protocol, the FTP command LIST file obtains the last modified time of the file and the size. This command typically returns a text string of the format MMM dd HH:mm or MMM dd yyyy depending on the age of the file. You must specify the type of format you want the FTP server to return. For the File transport protocol, the last modified time of the file is retrieved by java.io.File.lastModified(). ■ filename The timestamp is extracted directly from the file name (for both the FTP and File transport protocols). You must specify the start and end of the substring of the file name, which contains the timestamp to use and the timestamp format. Specify one or more timestamp formats for parsing the output of FTP commands or timestamp substrings of filenames. See "Timestamp Formats" on page A-7 for an example of the syntax to specify. receiver read ordered timestamp format Timestamp Formats You can specify multiple format masks, each enclosed by square brackets. <format-mask> ::= <current-year> ] <start> <end> <start> "," <end> "," "'" <time-pattern> "'" [ "," ::= integer ::= integer <time-pattern> ::= <current-year> ::= TimestampFormats ::= <java.text.SimpleDateFormat> | "N" "CY" { "[" <format-mask> "]" }+ Troubleshooting and Workarounds A-7 Generic Exchange Protocol Workarounds Example: Timestamp Formats [41,53,'MMM dd HH:mm',CY][41,53,'MMM dd yyyy'] The CY token shown in the preceding text must be added for time patterns where a year is not present. The adapter then internally appends the format yyyy to the user-provided format mask and appends the current year to the actual timestamp string before parsing it. The <start> and <end> indexes demarcate the timestamp substring of the string, originating either from the FTP LIST command or the actual file name. For a given FTP server (brand/vendor), you may need to manually experiment with the server to determine which format masks to use. If <time-pattern> is specified as N, the substring is treated as a regular integral number. In terms of time (t), the number (N) is interpreted as follows: t = "12:00 am, January 1, 1970 UTC" + N milliseconds If multiple format masks are entered, they are applied in the order in which they appear, until one works. FTP Server on Windows Operating Systems If you are using a generic exchange with the FTP transport protocol on Windows operating systems, you must use the Serv-U version 5.2 FTP server and perform the following tasks. Not doing so means that FTP cannot successfully access trading partner endpoints to transfer files. Use of Microsoft FTP servers is not supported. 1. Download the Serv-U version 5.2 FTP server from: http://www.serv-u.com 2. Assign admin privileges to the FTP user on the Serv-U FTP server. 3. Create typical Windows directory paths: C:\private\edi_data 4. Ensure that endpoint directories are within the home directory of the FTP user. For example, if the FTP user home directory is C:\private\edi_data, then create a subdirectory for use as the endpoint: C:\private\edi_data\Acme 5. Create a zero-byte file in the incoming trading partner endpoint directory and a zero-byte file in the outgoing trading partner endpoint directory. For example: c:\private\edi_data\Acme\incoming0 (0 bytes) c:\private\edi_data\GlobalChips\outgoing0 (0 bytes) Generic Exchange Protocols and Functional Acknowledgments If you are using EDI X12 over Generic Exchange or EDI EDIFACT over Generic Exchange with HTTP or HTTPS, do not select Yes in the Functional acknowledgment required? field of the Create Trading Partner: Operational Capability page. Generic Exchange Protocols and Oracle Application Server Web Cache If you use the Custom Document over Generic Exchange, EDI X12 over Generic Exchange, or EDI EDIFACT over Generic Exchange business protocol with HTTP or A-8 Oracle Application Server Integration B2B User’s Guide Configuring OracleAS Integration B2B in Enterprise Environments HTTPS as your transport protocol, ensure that Oracle Application Server Web Cache is disabled. Contact Oracle Support Services for instructions. Configuration Changes and Redeployment After a Request Is Sent But Before a Response Is Received If the initiator updates an agreement and redeploys the configuration after a message is sent (for example, a request), then the incoming response is not detected. This is because B2B identifies incoming messages based on the active configuration. The collaboration status "In Progress" is valid only for the previous configuration. On the initiator side (where the configuration was redeployed), the B2B log will show AIP-50904: RefTo message not found. Non-English OracleAS Integration B2B Pages in Oracle Enterprise Manager If you are using OracleAS Integration B2B in a non-English language, note that parts of some OracleAS Integration B2B pages in Oracle Enterprise Manager 10g Application Server Control appear only in English. Oracle Application Server Clustering and Integration B2B OracleAS Integration B2B cannot be installed on a clustered application server middle-tier environment. Also, after you install Oracle Application Server Integration B2B on a middle tier, you cannot add it as a node on a cluster. Configuring OracleAS Integration B2B in Enterprise Environments In a typical Oracle Application Server environment, the Oracle Application Server middle tier with its installations of J2EE and Web Cache and OracleAS Integration B2B communicates with the OracleAS Infrastructure tier and its installation of the OracleAS Metadata Repository. You can also configure OracleAS Integration B2B to run in enterprise environments. Enterprise environments are slightly different than the typical Oracle Application Server environment in that they include an additional middle tier known as a web tier that is installed and configured outside your corporate network. The web tier includes the J2EE and Web Cache install type. However, there is no installation of OracleAS Integration B2B and no applications are deployed on the web tier. The web tier is used only to exchange HTTP requests (through the Oracle HTTP Server) with the Oracle Application Server middle tier (and its installations of J2EE and Web Cache and OracleAS Integration B2B). The Oracle Application Server middle tier, in turn, communicates with the OracleAS Infrastructure tier and its installation of the OracleAS Metadata Repository. To use OracleAS Integration B2B in enterprise environments with a web tier, you must perform the following configuration tasks: On the Oracle Application Server middle tier (with its installations of J2EE and Web Cache and OracleAS Integration B2B): 1. Go to the ORACLE_HOME/opmn/conf directory. 2. Use a text editor to open opmn.xml. 3. Find the entry for OC4J_B2B. Troubleshooting and Workarounds A-9 Configuring OracleAS Integration B2B in Enterprise Environments 4. Change the range of AJP Ports from 3301-3400 to 3301-3301. This enables OC4J_B2B to run on just one AJP port. 5. Save your changes. On the web tier (with its installation of only J2EE and Web Cache): 1. Go to the ORACLE_HOME/Apache/Apache/conf directory. 2. Use a text editor to open mod_oc4j.conf. 3. Add the following entries near the end of the file, but before the </IfModule> line. These entries enable AJP routing to communicate with the configured OC4J_ B2B: Oc4jMount /b2b ajp13://hostname:ajpport Oc4jMount /b2b/* ajp13://hostname:ajpport where: ■ ■ 4. hostname is the name of the host on which the Oracle Application Server middle tier is installed ajpport is the AJP port range that you configured on the Oracle Application Server middle tier Save your changes. See Also: Oracle Application Server Integration B2B Installation Guide for additional instructions on configuring a web tier (and its Oracle HTTP Server) outside your corporate network A-10 Oracle Application Server Integration B2B User’s Guide B Exception Handling OracleAS Integration B2B handles exceptions for inbound and outbound messages. This appendix describes the exception handling, error messages, and structures for OracleAS Integration B2B. This appendix contains the following topics: ■ Inbound Messages ■ Outbound Messages ■ Inbound Exception Handling Scenarios ■ Exception Payload Definition Inbound Messages This section describes the following inbound message types: ■ Request or Response Messages ■ Acknowledgment Messages ■ Exception Messages Request or Response Messages For an incoming request or response message that results in an exception, the following actions occur: ■ An exception message is sent to the application. The exception message is enqueued to B2B_IN_QUEUE and has the recipient name b2berroruser. The enqueued exception is based on ipException.xsd and contains information such as the error message (errorText has a short description and errorDescription has a longer description) and the error code. ■ An exception message is sent to the trading partner, if mandated by the exchange specification. The exception message is sent back to the trading partner only if there is enough information to identify the outgoing trading partner agreement. For this purpose, the flag B2BHeader.sendException is used. The flag is set to true when enough information is extracted from the incoming message to send the exception message to the trading partner. ■ OracleAS Integration B2B catches exceptions thrown by exchange or document layers. Exception Handling B-1 Outbound Messages If the B2Bheader.sendException flag is set to true, the outgoing trading partner agreement is processed and an exception message is sent to the trading partner. Acknowledgment Messages For an incoming acknowledgment message that results in an exception, the following actions occur: ■ An exception message is sent to the application. The exception message is enqueued to B2B_IN_QUEUE and has the recipient name b2berroruser. The enqueued exception is based on ipException.xsd and contains information such as error text and error code. ■ No exception message is sent back to the trading partner. Exception Messages For an incoming exception message, the following actions occur: ■ ■ The original message is updated so that it is in an errored state. The incoming exception is processed and delivered to the application normally. If the incoming exception message itself results in an exception, an exception message is sent to the application. The exception message is enqueued to B2B_IN_QUEUE and has the recipient name b2berroruser. The enqueued exception is based on ipException.xsd and contains information such as error text and error code. No exception message is sent back to the trading partner in this case. Outbound Messages If an exception occurs while an outbound message is being sent (for example, if the trading partner identification fails), then an exception message is sent to the application. The exception message is enqueued to B2B_IN_QUEUE and has the recipient name b2berroruser. The enqueued exception is based on ipException.xsd and contains information such as error text and error code. If an exception occurs during OracleAS Integration B2B startup, then an exception message is enqueued to B2B_IN_QUEUE and has the recipient name b2berroruser. The enqueued exception is based on ipException.xsd and contains information such as error text and error code. The correlation ID is not populated in this case. Note the following: ■ ■ ■ ■ When the exception message is sent back to the application, the document type is Exception instead of the original message document type. When the exception message is sent back to the application, inReplyToMessageId is populated with the correlation ID value. For inbound exception handling, a business message is always created and populated with the available information. It also points to the corresponding wire message. The wire message is updated so that it is in an errored state. For the outbound direction, only the business message is updated, because the wire message does not exist. The error reports are updated to show only business messages; a business message is always created in the inbound and outbound directions. B-2 Oracle Application Server Integration B2B User’s Guide Inbound Exception Handling Scenarios Inbound Exception Handling Scenarios Table B–1 describes inbound exception handling scenarios. Table B–1 Inbound Exception Handling Scenarios If an exception occurs because. . . The identification of the exchange fails or the exchange is not supported Then OracleAS Integration B2B does . . . ■ Notifies the middleware ■ Updates the wire message as in an errored state ■ Message unpacking fails ■ Sends a transport error message to the trading partner ■ Notifies the middleware ■ Updates the wire message as in an errored state ■ Incoming message decoding fails Notifies the middleware ■ Updates the wire message as in an errored state ■ ■ Updates the wire message as a duplicated message error Creates a business message as a duplicated message error for the wire message ■ Notifies the middleware ■ Updates the wire message as in an errored state ■ Creates a business message in an errored state for the wire message Sends an exception message to the trading partner, if the sendException flag is set in the exchange layer ■ Notifies the middleware ■ Updates the wire message as in an errored state ■ ■ Incoming document processing fails Sends an exception message to the trading partner, if the sendException flag is set in the exchange layer Notifies the middleware ■ Incoming trading partner agreement processing fails Creates a business message in an errored state for the wire message ■ ■ Document identification fails Creates a business message in an errored state for the wire message ■ ■ The message is duplicated Creates a business message in an errored state for the wire message Creates a business message in an errored state for the wire message Sends an exception message to the trading partner, if the sendException flag is set in the exchange layer ■ Notifies the middleware ■ Updates the wire message as in an errored state ■ ■ Creates a business message in an errored state for the wire message Sends an exception message to the trading partner, if the sendException flag is set in the exchange layer Note the following: ■ ■ An exception is sent back to the trading partner for request messages only. No exception is sent back to the trading partner for response, acknowledgment, and functional acknowledgment messages. Exception Handling B-3 Exception Payload Definition Exception Payload Definition The exception payload, ipException.xsd, is defined as follows: <?xml version="1.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://integration.oracle.com/B2B/Exception" targetNamespace="http://integration.oracle.com/B2B/Exception"> <xs:element name="Exception"> <!--xs:complexType name="Exception"--> <xs:complexType> <xs:sequence> <xs:element ref="correlationId"/> <xs:element ref="b2bMessageId"/> <xs:element ref="errorCode"/> <xs:element ref="errorText"/> <xs:element ref="errorDescription"/> <xs:element ref="errorSeverity"/> <xs:element ref="errorDetails" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="correlationId" type="xs:string"/> <xs:element name="b2bMessageId" type="xs:string"/> <xs:element name="errorCode" type="xs:string"/> <xs:element name="errorText" type="xs:string"/> <xs:element name="errorDescription" type="xs:string"/> <xs:element name="errorSeverity" type="xs:string"/> <xs:element name="errorDetails"> <xs:complexType> <xs:sequence> <xs:element ref="parameter" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="parameter"> <xs:complexType> <xs:attribute name="name" type="xs:string" use="required" /> <xs:attribute name="value" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:schema> B-4 Oracle Application Server Integration B2B User’s Guide C Identifying a Trading Partner Using ISA/GS If trading partners are using a value-added network (VAN) with EDI EDIFACT or EDI X12, then, to use the ISA/GS identifier, add the following property in tip.properties. This property specifies how the sending trading partner of incoming messages is identified. oracle.tip.adapter.b2b.edi.identifyFromTP = Interchange | Group | Exchange You have the following ways to identify the sending (from) trading partner: ■ Interchange Sender ID—UNB for EDIFACT AND ISA 06 FOR X12 ■ Application's Sender Code—UNG for EDIFACT and GS 02 for X12 ■ Exchange Protocol identification (default) For Trading Partner Identification Type, use one of the following types: ■ EDI Interchange ID ■ EDI Group ID Create a new Trading Partner Identification for the target trading partner with the corresponding EDI sender value for the Interchange or Group envelope. Specifically, you must create one EDI Interchange ID for the host trading partner and one EDI Interchange ID for the remote trading partner. For the incoming message, the host trading partner is the receiving trading partner and the remote trading partner is the sending trading partner. Identifying a Trading Partner Using ISA/GS C-1 C-2 Oracle Application Server Integration B2B User’s Guide Glossary acknowledgment mode The mode in which trading partners receive messages (asynchronous or synchronous). active configuration A configuration state during which the trading partner agreement included in the configuration is available for execution of business in the OracleAS Integration B2B runtime repository. Incoming messages are accepted based on your design in the trading partner agreement and processed accordingly. admin user The default username for accessing and using the OracleAS Integration B2B user interface. This username is created automatically during installation. Administration tab A main tab of the OracleAS Integration B2B user interface that enables you to manage and administer OracleAS Integration B2B, including exporting and importing the design-time repository; importing configurations; importing RosettaNet collaborations, EDI transaction sets, and UCCnet standards; importing and purging the design-time repository and instance data in the runtime repository; and managing contact types and trading partner identification types. Administrator role The role that enables a user to access and use the entire OracleAS Integration B2B user interface. Only a user in the host trading partner organization can be assigned this role. agreement See trading partner agreement. Applicability Statement 2 An EDI specification between businesses using the Internet's Web page protocol (HTTP). This specification was created by EDI over the Internet (EDIINT), a working group of the Internet Engineering Task Force (IETF) that develops secure and reliable business communication standards. AS2 See Applicability Statement 2. associated agreements See trading partner agreement. Glossary-1 back-end application See host application. B2B See business-to-business. B2B core The process, document, and exchange protocols and protocol revisions supported by OracleAS Integration B2B. B2B integration B2B integration enables trading partners to exchange business data across networks such as the Internet and incorporates the trading partners' host applications and business processes. B2B transaction See business transaction. business action Identifies the roles played in a configuration using an EDI or Custom Document business protocol. Business actions describe the business documents and their movement between trading partners. In the OracleAS Integration B2B user interface, trading partners define their operational capabilities by the business actions they support. business collaboration Consists of a set of roles (buyer and seller) collaborating through a set of agreed-on business transactions by exchanging business documents. Trading partners participate in a business collaboration through roles. This business collaboration must achieve a specified outcome. business document The name for messages exchanged between trading partners. Business Message Status Reports Monitor trading partner business message instances for EDI or Custom Document business protocols. business protocol Identifies the implementation guidelines to use for the reliable transport of business document messages between trading partners. The business protocol consists of three protocols: process (of which support for business actions and collaborations are a part), document, and exchange. business transaction A unit of business conducted by two or more trading partners that generates a definite state of success or failure. A business transaction is conducted between two trading partners playing opposite roles in a transaction. The roles are always an initiating role and a responding role. business-to-business A type of integration technology that enables companies to integrate trading partners with other trading partners. Glossary-2 callouts Used to transform documents from one form to another. You can use callouts to invoke an XSLT style sheet and any Java program in general. For example, an incoming remote trading partner’s EDI document is sent to the host trading partner’s host Oracle E-Business Suite application, which uses XML. Callouts enable you to transform the EDI document into an XML format understood by the Oracle E-Business Suite application. The outgoing document can then be transformed back into its original format. Callouts are associated with internal delivery channels. certificate See remote trading partner certificates. collaboration Collaborations consist of a set of RosettaNet PIPs that define the capabilities of a trading partner in a business transaction (such as buyer and seller). Collaborations describe the business documents and their movement between trading partners. In the OracleAS Integration B2B user interface, trading partners define their operational capabilities by the collaborations they support. Collaboration Status Reports Monitor trading partner business message instances for the RosettaNet over RNIF business protocol. communication capabilities Define the following details for the business protocol of a host or remote trading partner: ■ ■ ■ Delivery channel details, such as use of nonrepudiation, encryption, and transport security Document exchange details, such as use of digital envelopes, encryption credentials, digital signatures, and signing credentials Transport details, such as transport mode, protocol, server name, and endpoint address details company boundaries See enterprise. concurrent conversations Defines the maximum number of concurrent collaboration instances that can be in progress at any time. configuration A collection of partner data of trading partners that is consistent, complete, and deployable. Creating a configuration enforces the validation rules so that only valid, complete, and consistent data is available in the runtime repository. configuration states The state that a configuration is in at any given time (for example, active, validated, quiesced, retired, and discarded). contact information The method by which to contact a user or organization when you want to perform a specific action (such as reviewing a trading partner or trading partner agreement). Glossary-3 contact types The method for contacting persons and organizations (such as a phone number or e-mail address) when a specific activity within OracleAS Integration B2B is required (such as reviewing a trading partner agreement). Create Business Action wizard Enables you to create support for business actions for any EDI or Custom Document business protocol. Create Collaboration wizard Enables you to create support for PIP collaborations for the RosettaNet over RNIF business protocol. Create Trading Partner wizard Enables you to create a remote trading partner, assign support for a business protocol to a remote trading partner, assign operational capabilities (collaborations or business actions) to a remote trading partner, and assign communication capabilities (delivery channels, document exchanges, transports, and endpoint details) to a host trading partner and remote trading partner. The host trading partner is automatically assigned support for all business protocols and operational capabilities; only the communication capabilities for the host trading partner must be created. Custom Document A customer-defined protocol, such as UCCnet. Data Universal Numbering System A unique, sequentially-generated, nine-digit number that you can assign as the trading partner identification type. You obtain this number from Dun and Bradstreet. delivery channel Describes whether trading partner security characteristics such as nonrepudiation of origin and receipt, acknowledgment mode, time to acknowledge, retry count, transport security, encryption, and file compression are required. The delivery channel also includes the associated transport (with its transport protocol, mode, server, and endpoint address) and document exchange (with its exchange protocol parameters, exchange protocol override elements, and, if defined, its support for digital envelope, encryption credentials, digital signature, signing credentials, and validation). deployment The process of activating a configuration from the design-time repository to the runtime repository. Deployment tab A main tab of the OracleAS Integration B2B user interface that enables you to manage (create, validate, deploy, quiesce, discard, or export) a configuration. design-time data See partner data. design-time repository The repository in which partner data (trading partners and trading partner agreements) is stored before being included in a deployed configuration in the Glossary-4 runtime repository. The OracleAS Integration B2B design-time repository is part of the Oracle Application Server Metadata Repository. digital envelope The packaging method for a digital signature. digital signature Created when a public key algorithm signs the sender's message with the sender's private key. The digital signature ensures that the document is authentic, has not been forged by another trading partner, has not been altered, and cannot be repudiated by the sender. discarded configuration A configuration state during which a configuration has been discarded and cannot be deployed. These types of configurations were created and validated, but never deployed. document definition The fourth level in the document protocol hierarchy. In this hierarchy, a document protocol can consist of multiple document protocol revisions. A document protocol revision can consist of multiple document types. A document type can consist of multiple document definitions. A document definition can consist of an XSD or DTD file and associated information. An example of a document definition is an XSD file for EDI X12 4010 8050 or a DTD file for RosettaNet V02.00 RequestPurchaseOrder. document exchange Describes the supported exchange protocol (such as RosettaNet 02.00) and, if being used, credential encryption and signing credentials, digital envelopes and digital signatures, and validation support. The document exchange uses these capabilities to exchange messages with a trading partner. document protocol Defines the document type of the message payload. The first level in the document protocol hierarchy. In this hierarchy, a document protocol can consist of multiple document protocol revisions. A document protocol revision can consist of multiple document types. A document type can consist of multiple document definitions. An example of a document protocol is RosettaNet, EDI X12, EDI EDIFACT, or Custom Document (such as UCCnet). document protocol revision The second level in the document protocol hierarchy. In this hierarchy, a document protocol can consist of multiple document protocol revisions. A document protocol revision can consist of multiple document types. A document type can consist of multiple document definitions. An example of a document protocol revision is RosettaNet V02.00 or EDI X12 4010. document type The third level in the document protocol hierarchy. In this hierarchy, a document protocol can consist of multiple document protocol revisions. A document protocol revision can consist of multiple document types. A document type can consist of multiple document definitions. An example of a document type is a RosettaNet RequestPurchaseOrder or EDI X12 4010 850. Glossary-5 DUNS See Data Universal Numbering System. e-business The conduct of business over the Internet, such as buying and selling products, servicing customers, and collaborating with other companies, known as trading partners. ebMS See ebXML Messaging Service ebXML Messaging Service Electronic business extensible markup language is a specification for XML standards that is used to exchange XML-based messages. The ebMS exchange protocol in OracleAS Integration B2B is used in the Custom Document over ebMS business protocol. EDI See electronic data interchange. EDI EDIFACT EDI for Administration, Commerce, and Transport (EDIFACT) is the international standard for EDI. Developed by the United Nations, these standards work for international conventions for electronic data interchange. EDI X12 A numbered set of commercial EDI transactions defined by the American National Standards Institute's Accredited Standards Committee X12. These uniform rules for the interchange of business documents are defined for cross industry EDI use and are based upon the variable-length X12 standard. electronic data interchange A standard format for exchanging electronic business data. encryption credential The certificate to use for encryption of the document to exchange. endpoint The physical endpoint address of a trading partner. An endpoint includes a protocol endpoint, which is a combination of a specific endpoint address (such as http://server.partner.com:5555/submit/rnmsg) and transport protocol (such as HTTP 1.1). The trading partner uses this address to send or receive data. Endpoints are global to all trading partners. enterprise The boundaries of a company. Error Status Reports Monitor business message error instances. exchange protocol Defines the message exchange mechanism—how to exchange the documents defined by the document protocol. It defines the headers, the acknowledgments, and the Glossary-6 packaging that puts the headers and payload together. It also defines the transport protocol and packaging protocol for the exchange. export The OracleAS Integration B2B user interface provides design-time repository export functionality that enables you to perform the following tasks: ■ ■ ■ Export the entire contents of the design-time repository to an XML file Export a configuration created under the Deployment tab to and from the design-time repository Export the partner data associated with trading partners and trading partner agreements to XML files that can then be submitted to individuals for optional review and eventual approval generic exchange An exchange protocol supported by OracleAS Integration B2B. Health Level 7 This specification for the health care domain—pharmacy, medical devices, imaging, insurance claim processing, and so on—provides standards to exchange and manage health care-related information. OracleAS Integration B2B provides the HL7 over Generic Exchange and the HL7 over MLLP Exchange business protocols. HL7 See Health Level 7. host application The application installed within the host trading partner’s environment. An internal delivery channel is the communication interface between the host trading partner’s host application and their installation of OracleAS Integration B2B. host trading partner The organization in which OracleAS Integration B2B is installed. The host trading partner conducts business with the remote trading partner (the organization outside your enterprise). ias_admin user The default user account for accessing and using the Oracle Enterprise Manager 10g Application Server Control Console. This user is created automatically during installation. import The OracleAS Integration B2B user interface provides design-time repository import functionality that enables you to perform the following tasks: ■ ■ ■ ■ Import the entire contents of the previously exported design-time repository from an XML file Import a previously exported configuration created under the Deployment tab Import support for RosettaNet collaborations (partner interface processes (PIPs)), EDI X12 and EDIFACT transaction sets, and UCCnet standards into the design-time repository to assign to trading partners Import reports Glossary-7 ■ Import the design-time repository and instance data of the runtime repository instance data Partner data included in a deployed configuration. During configuration creation, partner data of the integration is validated end-to-end a final time to ensure that only a complete and consistent configuration is deployed to the run-time repository. After a configuration is deployed, the runtime repository stores the configuration of run-time data required to execute an integration. Run-time data is created during run time when messages are exchanged between trading partners. These messages are logged in an instance table in the runtime repository. integrations between enterprises See business-to-business. internal delivery channels An internal delivery channel is the communication interface between the host trading partner’s host application and their installation of OracleAS Integration B2B. Internal delivery channels operate only within the host trading partner’s enterprise. internal endpoints Predefined endpoints that are associated with a specific internal delivery channel to enable communication between the host trading partner’s host application and their installation of OracleAS Integration B2B. Internal endpoints operate only within the host trading partner’s enterprise. lifecycle management Enables you to manage the various states in the design and deployment of partner data (such as draft, approved, and deployed). lifecycle states The states that partner data is in at any given point in time. The set of lifecycle states is based on state changes that must be captured from a business (that is, integration) standpoint. message payload The data contents of a message (for example, a payload of a purchase order can identify the quantity ordered, the total cost, the product being ordered, and so on). metadata repository See Oracle Application Server Metadata Repository. middle tier The host on which you installed the J2EE and Web Cache and OracleAS Integration B2B installation types. MIME See multipurpose internet mail extensions. Minimum Lower Layer Protocol See MLLP MLLP The transport protocol used with HL7. Glossary-8 multipurpose internet mail extensions An extension of the original Internet e-mail protocol that lets users use the protocol to exchange different kinds of datafiles on the Internet: audio, video, images, application programs, and other kinds, as well as the ASCII handled in the original protocol, the simple mail transfer protocol (SMTP). nonrepudiation A standard that provides absolute evidence that a specific action occurred. OracleAS Integration B2B supports two types: ■ ■ Nonrepudiation of origin requires a message sender to digitally sign a message. This protects against any attempt by a sender to deny sending a message. Nonrepudiation of receipt requires a message recipient to send back a digitally signed acknowledgment. This protects against any attempt by a message recipient to deny receiving a message. OC4J See Oracle Application Server Containers for J2EE. operational capability Defines the support for business actions or collaborations for the business protocol of a host or remote trading partner. OPMN See Oracle Process Manager and Notification Server. OracleAS Integration B2B - Document Editor An integrated guideline creation and implementation application for creating business-to-business (B2B) electronic commerce. You can use the OracleAS Integration B2B - Document Editor library of templates to create EDI X12 and EDI EDIFACT .ecs files, RosettaNet XSD, HL7, and DTD files that you then import into the OracleAS Integration B2B user interface tool with the Create Business Action wizard and Create Collaboration wizard. This enables you to create configurations with OracleAS Integration B2B trading partners that use EDI X12, EDI EDIFACT, HL7, and RosettaNet. Oracle Application Server Containers for J2EE A complete set of J2EE containers written entirely in Java that execute on the Java Virtual Machine (JVM) of the standard Java Development Kit (JDK). Oracle Application Server Metadata Repository An Oracle database that contains schemas and business logic used by application server components (including OracleAS Integration B2B). The OracleAS Integration B2B schema is part of the OracleAS Metadata Repository. The OracleAS Integration B2B design-time repository and runtime repository are both part of the OracleAS Metadata Repository. Oracle Application Server Integration B2B (OracleAS Integration B2B) Enables you to successfully design, deploy, monitor, and maintain configurations between trading partners. OracleAS Integration B2B middle-tier instance A single installation of OracleAS Integration B2B. Glossary-9 Oracle E-Business Suite Provides a complete set of applications capable of automating daily business process functions. These applications assist in running supply chain operations; managing employees; and marketing, selling, and providing customer services. Oracle Process Manager and Notification Server Enables you to monitor Oracle Application Server Metadata Repository processes based on settings in the opmn.xml file. Oracle Wallet Manager A Java-based application that security administrators use to manage public-key security credentials on clients and servers. packaging Encapsulates all components of a message into a packaging format (for example, OracleAS Integration B2B supports the multipurpose internet mail extensions (MIME) format). packaging protocol Defines a packaging mechanism. Message security such as signing and encryption are often based on a specific packaging mechanism. participant See trading partner. partner data Design-time data before it is included in a deployed configuration (for example, trading partner and trading partner agreement data). Partner data is the data that you create under the Partners tab in the OracleAS Integration B2B user interface. Partner data is stored in the design-time repository part of the Oracle Application Server Metadata Repository. Partners tab A main tab of the OracleAS Integration B2B user interface that enables you to create a remote trading partner, assign support for a business protocol to a remote trading partner, create the operational capabilities (support for collaborations or business actions) for the business protocol of the remote trading partner, and create the communication (delivery channel, security, transport, transport server, and endpoint details) capabilities for the business protocols of the remote and host trading partners. The host trading partner is automatically assigned support for all business protocols and operational capabilities; only the communication capabilities for the host trading partner must be created. person A user that can be assigned as an OracleAS Integration B2B user interface user or as an optional reviewer of trading partner and trading partner agreement details. PIP See RosettaNet Partner Interface Process. process protocol Defines how documents are exchanged. Process protocols define the support for collaborations (for the RosettaNet over RNIF business protocol) and business actions Glossary-10 (for any EDI or Custom Document business protocols) that are associated with specific document types. protocol endpoint Consists of a transport protocol (such as HTTP 1.1) and trading partner endpoint address (such as URI www.myapp124abc.com). purging Deletes data from the design-time repository with the exception of data that was part of installation. In addition, instance data in the runtime repository can also be purged. quiesce The process of gracefully shutting down a deployed configuration. A configuration can be automatically or manually quiesced. quiesced configuration A configuration state during which the configuration is in the process of being quiesced (retired). Once quiesced, the configuration can be retired or redeployed. remote trading partner The organization outside your enterprise with whom to conduct business. The host trading partner must define the capabilities for both the host and remote trading partners with the OracleAS Integration B2B user interface. remote trading partner certificates A method by which to secure the given exchange of data. A certificate securely binds an identity such as a trading partner to a public key. A certificate is created when a trading partner’s public key is signed by a trusted identity known as a certificate authority (CA). This certificate ensures that the trading partner's data is correct and that the public key actually belongs to that trading partner. You select the location of a certificate. This is typically the location for the Oracle Wallet Resource Locator. Reports role Provides a host trading partner user with access to only the functionality of the Reports tab of the OracleAS Integration B2B user interface. A user with this role cannot see or access the other parts of the user interface. Reports tab A main tab of the OracleAS Integration B2B user interface that enables you to create reports that describe OracleAS Integration B2B run-time behavior. repository See design-time repository and runtime repository. retired configuration A configuration state during which a deployed configuration has been quiesced and retired. This configuration cannot be redeployed. This occurs when you deploy another configuration. This action causes any currently running configurations to be quiesced and retired. You can also manually quiesce a deployed configuration. RNBD See RosettaNet Business Dictionary. Glossary-11 RNIF See RosettaNet Implementation Framework. RosettaNet A nonprofit organization of leading technology companies that has created and implemented a common set of nonproprietary, XML-based, e-business standards. These standards define how trading partners conduct business through the exchange of business documents over the Internet. Guidelines are provided for transport, routing, packaging, security, signals, and trading partner agreements. RosettaNet Business Dictionary A RosettaNet dictionary that designates the properties used in basic business transactions between trading partners. The business dictionary defines the business properties and fundamental business data entities in PIP messages. RosettaNet dictionaries Define and describe a common set of properties for use in PIP messages. These properties define a common vocabulary for conducting business. This ensures that the information exchanged between trading partners is consistent, overlapping efforts of trading partners are eliminated, and confusion caused by the uniquely defined terminology of each trading partner is reduced. There are two dictionary types: business dictionary and technical dictionary. OracleAS Integration B2B supports only the business dictionary. RosettaNet Implementation Framework Defines the implementation guidelines for the reliable exchange of business data messages (in XML business documents) between trading partners over the Internet. RosettaNet Partner Interface Process XML-based dialogs that define the specific sequence of steps required to execute a business process (and thus, exchange data) between trading partners. PIPs are XML-based dialogs that define the structure, allowable data elements, values, and value types for each business document message exchanged. Trading partners agree on the set of PIPs to support to conduct business. RosettaNet validation Compares the elements in RosettaNet XML-format business documents to the requirements specified in the RosettaNet Message Guideline specification to determine their validity. This specification defines requirements for information such as element datatypes, element lengths, element value lists, and element cardinality. run-time data See instance data. runtime repository Stores the run-time data required to deploy and execute a configuration. Run-time data is created during run time when messages are processed. The OracleAS Integration B2B runtime repository is part of the Oracle Application Server Metadata Repository. Save Definition button Saves the contents of generated reports to XML files. You can reimport the report contents as needed into the OracleAS Integration B2B user interface. Glossary-12 S/MIME See secure multipurpose internet mail extensions. secure multipurpose internet mail extensions A secure method of sending e-mail. MIME indicates how to organize an electronic message. S/MIME describes how encryption data and a digital certificate can be included as part of the message body. signing credential Enables you to assign the certificate to use to sign the given document exchange. trading partner Engages in business transactions with another trading partner. You assign a trading partner to a trading partner agreement. trading partner agreement An electronic agreement that defines the way in which a host and remote trading partner agree to interact when performing an agreed-on collaboration or business action. trading partner identification type A type for which you assign a value that uniquely identifies a trading partner, such as a data universal numbering system (DUNS) number. You can define other types of trading partner identification types. trading partner management The design stage during which you define the basic B2B transaction. This includes setting up trading partners, assigning support for business protocols, creating business protocol operational and communication capabilities, and creating trading partner agreements. transaction set A collection of formatted data that contains the information required by a receiver to perform a standard business transaction. In an EDI standard, a transaction set has three sections (header, detail, and summary) and consists of a predefined group of segments in each section. An EDI transaction set maps to a document type of a business action in the OracleAS Integration B2B user interface. transport Defines the properties specific to a given usage of a protocol endpoint. The transport is responsible for message delivery using the selected transport protocol (such as HTTP 1.1), mode (synchronous or asynchronous), server, and protocol endpoint address (trading partner address, such as a URI). transport endpoint See endpoint. transport mode A means by which data is sent or received, such as asynchronous or synchronous mode. transport protocol A protocol that describes how to transport data (such as HTTP). Glossary-13 transport server The endpoint server name for the trading partner. UCCnet An industry standard utility for item registration and data synchronization between suppliers and retailers. UCCnet was created to synchronize item data between suppliers and retailers. It is not-for-profit and a subsidiary of the Uniform Code Council. use case groups The privileges of the Administrator role assigned to a user of the OracleAS Integration B2B user interface. user interface The OracleAS Integration B2B tool that enables you to design, deploy, monitor, and manage configurations. user role The group of related use case groups (privileges) that permit a user to perform tasks with the OracleAS Integration B2B user interface. validated The state in which your design-time data is determined to be correct and complete. validated configuration A configuration state during which the partner data has been successfully validated to ensure that it is correct and complete and a configuration has been created. The configuration is ready for deployment. Only valid configurations can exist; invalid configurations cannot be created. value-added networks A private network provider (sometimes called a turnkey communications line) hired by a company to facilitate electronic data interchange (EDI) or provide other network services. VAN See value-added networks. wallet password Opens a user's wallet. A wallet is a container in which certificates and trusted certificates are stored and managed. These data structures securely store a user private key, a user certificate, and a set of trusted certificates. Wire Message Status Reports Monitor trading partner wire message instances. wire messages The native format of data sent from trading partners. OracleAS Integration B2B does not know this data format. The direction of wire messages coming from trading partners is called inbound. The direction of wire messages sent to trading partners is called outbound. Wire messages can contain a number of sections, such as payloads, attachments, or trailers. Glossary-14 XML Gateway An Oracle E-Business Suite API that produces and consumes (deletes) XML messages. XSD The XML Schema Definition (XSD) specifies how to formally describe the elements in an Extensible Markup Language (XML) document. OracleAS Integration B2B provides predefined support for XSD. Glossary-15 Glossary-16 Index A acknowledgment mode generic exchange protocol requirement for value, 12-16 value set to None, 9-6 selecting with Create Trading Partner wizard, 9-16 updating, 10-51 acknowledgment time selecting with Create Trading Partner wizard, 9-17 updating, 10-52 acknowledgments handling, 9-4 Integration B2B handled by, 9-14 updating, 10-45, 10-48 active configuration state, 13-4 adapters Oracle BPEL Process Manager, 4-9 add button differences with create button, 2-8 additional transport headers parameter, 10-61 admin user Administrator role, not removing, 10-24 password, 20-1 protects partner data, 20-2 roles and privileges, 20-1 user interface default username, 2-2 username, default for user interface tool, 2-2 See also user roles, users administration tasks, 17-1 user interface, 17-1 administration tab description, 2-3 overview of tasks, 2-19 Administrator role user interface connection, required for, 10-21 description, 2-2 advanced queuing (AQ) internal delivery channel transport protocol, 10-34 agreement descriptor XML file Agreements.xsd, 15-4 description, 15-4 Agreement Details page description, 2-11 XML File, exporting to, 2-11 agreement ID creating for trading partner agreement, 12-7 updating, 12-9 agreements tab description, 2-16 tasks, 2-16 Agreements.xsd example descriptor file, 15-4 Applicability Statement 2 (AS2) exchange protocol compression, 9-6, 9-17, 10-52 description, 3-10 supported, 9-6 See also AS2 Identifier approved lifecycle state See lifecycle states approvers XML files of partner data, exporting submitting, 2-12 apps.ECX_INBOUND internal endpoint description, 10-63 selecting, 10-63 XML Gateway Inbound internal delivery channel, 10-30 See also endpoints apps.ECX_OUTBOUND internal endpoint description, 10-63 selecting, 10-63 XML Gateway Outbound internal delivery channel, 10-31 See also endpoints AS2 See Applicability Statement 2 (AS2) exchange protocol AS2 Identifier assigning as trading partner identification, 10-9 description, 10-9 Identification Page entry, 9-10 remote trading partner, 9-24 trading partner identification type, 9-10, 9-24 See also Applicability Statement 2 (AS2) exchange protocol Index-1 B B2B Inbound internal delivery channel, 4-2, 4-5 b2b.IP_IN_QUEUE internal endpoint, 10-30 description, 10-30 sufficient for most environments, 12-6, 12-7 supported, 4-1 See also delivery channels B2B integration, 1-1 B2B Outbound internal delivery channel, 4-2, 4-5 b2b.IP_OUT_QUEUE internal endpoint, 10-30 description, 4-1, 10-30 See also delivery channels B2B protocols supported, 1-2, 1-3, 3-1 B2B server description, 18-3 RMI server connection errors, A-6 starting with OPMN, 18-6, 18-9 with Oracle Enterprise Manager 10g, 18-6 stopping with OPMN, 18-9 with Oracle Enterprise Manager 10g, 18-6 B2B Server Level parameter logging level, A-3 B2B WSIL Browser, 4-7, 8-37 b2b.IP_IN_QUEUE internal endpoint B2B Inbound internal delivery channel, 10-30 description, 10-63 selecting, 10-63 See also endpoints, internal endpoints b2b.IP_OUT_QUEUE internal endpoint B2B Outbound internal delivery channel, 10-30 description, 10-63 selecting, 10-63 See also endpoints, internal endpoints b2b.jar file restriction on modifying, 11-5 b2b.log file location, A-3 troubleshooting errors, A-3 BPEL interoperability See Oracle BPEL Process Manager browsers restrictions on back and forward buttons, 2-8 user interface, accessing, 2-1 business actions assigning Create Trading Partner wizard, 9-26 host trading partner, automatic, 10-47, 12-2, 12-6 bidirectional, 8-3 creating with Create Business Action wizard, 8-3, 8-20 defining initiator in trading partners collaboration, 9-14 responder in trading partners collaboration, 9-14 deleting, 8-27, 10-49 description, 8-2 Index-2 Document Protocol Revision page of Create Business Action wizard, 8-21, 8-23 Document Type page of Create Business Action wizard, 8-21, 8-24 General page of Create Business Action wizard, 8-21, 8-22 importing, 17-8 managing, 10-46 remote trading partner support, assigning with Create Trading Partner wizard, 8-2 Review page of Create Business Action wizard, 8-22, 8-25 selecting for trading partner agreement, 12-6 single Create Trading Partner wizard session, 9-9 updating, 8-26, 10-48 viewing, 8-26, 10-48 See also business protocols business message status reports creating, 19-2 description, 2-19 business messages purging business messages, 17-10 Business Protocol Details page contents, 9-25 description, 10-4 business protocols assigning business protocol communication capabilities in separate Create Trading Partner wizard session, 9-27 business protocol in separate Create Trading Partner wizard session, 9-25 business protocol operational capabilities in separate Create Trading Partner wizard session, 9-26 host trading partner, automatic, 9-2, 9-23 multiple business protocols to remote trading partner, 9-8, 10-27 procedure, 10-27 single wizard session, 9-9 business actions, 8-2 collaborations, 8-2 communication capabilities, 9-9 components, 1-5 Create Partner Wizard, 9-7 creating in single wizard session, 9-9 custom documents Generic Exchange, 9-11 Internet, 9-11 description, 8-1 EDI EDIFACT Generic Exchange, 9-11 Internet, 9-11 EDI X12 Generic Exchange, 9-11 Internet, 9-12 errors, user, 8-37 format, 8-1 identifying, 1-4 listed, 3-12 managing, 8-1, 10-3, 10-25 operational capabilities, 9-9 removing from remote trading partner, 10-30 RosettaNet over RNIF, 9-12 support provided for, 9-11 viewing, 8-4, 10-28 See also business actions Business Protocols page, 2-16 C Callout Directory parameter defining callout .jar file library, 11-5 callout metadata parameters creating, 11-14 deleting, 11-16 description, 11-14 encrypting, 11-15 limitations on use of date type, 11-15 updating, 11-16 viewing, 11-15 See also callouts callout properties creating, 11-8 deleting, 11-10 description, 11-7 encrypting, 11-9 managing, 11-7 overriding values set at callout usage level, 11-9 updating, 11-10 viewing, 11-9 See also callouts callout usages associating with internal delivery channels, 11-1 creating, 11-12 creating, tutorial, 11-17 deleting, 11-13 description, 11-1 managing, 11-10 selecting when creating trading partner agreement, 4-12, 11-2, 11-12, 12-7 updating, 11-13 viewing, 11-13 See also callouts callouts, 4-12 adding to RosettaNet over Internet transaction, tutorial, 11-17 creating, 11-4 procedure, 11-4 with same name, 11-4 defining callout .jar file library location, 11-5 deleting, 11-7 description, 4-12 errors, common user, 11-22 for transformations, 11-1 list page overview, 2-17 managing, 11-1, 11-3 predefined XSLTCallout callout, 11-4 predefined XSLTCalloutImpl class file, 11-4 restriction on modifying b2b.jar file, 11-5 tasks overview, 11-3 updating, 11-7 viewing, 11-6 Callouts Java API Reference using to create a callout .jar file, 11-3 See also callouts Callouts List page description, 2-17 See also callouts callouts tab description, 2-17 overview of tasks, 2-17 See also callouts Capabilities page communication capabilities section, 2-15 description, 10-3 management tasks, 2-15 operational capabilities section, 2-15 certificates See remote trading partner certificates CLASSPATH environment setting up for tutorials, 5-3 clustering, A-9 collaboration status reports creating, 19-6 description, 2-19 See also collaborations collaborations assigning collaborations in separate Create Trading Partner wizard session, 9-26 host trading partner, automatic, 9-13, 10-44, 12-2, 12-5 remote trading partner support with Create Trading Partner wizard, 9-12 single Create Trading Partner wizard session, 9-9 bidirectional, 8-3 Business Transaction page of Create Collaboration wizard, 8-28, 8-31 collaboration roles, 9-12 creating with Create Collaboration wizard, 8-3, 8-27 defining initiator or responder in collaboration between trading partners, 9-13 deleting, 8-36, 10-46 description, 8-2 General page of Create Collaboration wizard, 8-28, 8-29 importing, 8-3, 17-8 managing, 10-43 remote trading partner support, assigning with Create Trading Partner wizard, 8-2 Requesting Business Action page of Create Collaboration wizard, 8-28, 8-31 Responding Business Action page of Create Collaboration wizard, 8-29, 8-33 Review page of Create Collaboration wizard, 8-29, 8-35 revision number matching document type revision Index-3 number, 8-13, 8-30, 8-32, 8-34, 8-36 roles, 9-12 selecting for trading partner agreement, 12-5 updating, 8-36, 10-45 viewing, 8-35, 10-44 communication capabilities business actions, 10-5 Business Protocol Details page description, 9-23 business protocol tasks, 2-15 collaborations, 10-5 completing creation, 9-4 creating for host and remote trading partners with Creating Trading Partner wizard, 9-15 for host trading partner, 2-3 in single session, 9-9 delivery channel, 12-2 description, 1-6, 9-3, 9-7 lower-level trading partner data details, 2-11 remote trading partner operational capabilities tasks, 2-15 starting Create Trading Partner wizard, 10-50, 10-53, 10-56, 10-59, 10-62 viewing business protocol, 10-28 in user interface tool, 2-15, 9-25, 10-4, 10-28 compression Applicability Statement 2 (AS2) exchange protocol, 9-6, 9-17, 10-52 limitations, 9-6 selecting with Create Trading Partner wizard, 9-17 updating, 10-52 concurrent conversations, values assigning to trading partner agreement, 12-7 updating in trading partner agreement, 12-9 configurations configurations, requirement to archive before purging, 17-9 creating description, 13-2 for deployment, 13-1, 13-3 deploying description, 13-6 restrictions with trading partner agreement in multiple configurations, 13-6, 13-7 deployment stage, 1-8 description, 13-1, 13-2 design-time workflow, 1-5 discarded configurations description, 13-9 discarding, 13-9 exporting, 13-10 limitations on importing exported configuration, 13-10, 17-8 maximum character length, 13-5 naming restrictions, 13-5 partner data in currently-deployed configuration, impact of changes to, 13-7 purging data in deployed configuration in Index-4 run-time repository, 17-9 quiescing automatically for second configuration in same agreement, 13-9 procedure, 13-9 restriction on leaving in validated state, 2-3 same trading partner agreement in multiple configurations, 13-2 states, 13-4 status of imported configuration, 17-8 successful creation and validation, 13-5 trading partner agreement inclusion, 13-3 trading partner agreement states, 13-8 trading partners, 13-6 unsuccessfully created configurations, 13-6 validated agreements in configuration, 13-4 validated configuration inability to modify, 13-6, 13-11 validations, 13-2 viewing, 13-8 contact information organizations creating, 10-18 deleting, 10-20 managing, 10-17 updating, 10-19 viewing, 10-18 persons creating, 10-18 deleting, 10-20 managing, 10-17 updating, 10-19 viewing, 10-18 preventing user contact, 10-18 contact types administering, 17-3 description, 2-21, 17-3 predefined contact types, preventing updates or deletes, 17-3 preventing being sent, 10-18 viewing, 17-3 correlation messages, 4-10 Create Business Action wizard accessing, 8-22 creating business actions, 8-21 business actions support, 8-3, 8-20 Document Protocol Revision page, 8-21, 8-23 Document Type page, 8-21, 8-24 EDI document validation for globalization support, disabling, 8-11, 8-14, 8-23, 8-25 General page, 8-21, 8-22 importing document definition files, 8-25 .ecs files, 8-24, 8-25 .xsd files, 8-25 Review page, 8-22, 8-25 create button differences with add button, 2-8 Create Collaboration wizard accessing, 8-30 Business Transaction page, 8-28, 8-31 collaborations creating, 8-28 creating collaboration support, 8-3 creating support, 8-27 details, ensuring care, 8-29 revision number matching document type, 8-30, 8-32, 8-34 General page, 8-28, 8-29 importing document definition files, 8-33, 8-34 .dtd files, 8-33, 8-34 .xsd files, 8-33, 8-34 Requesting Business Action page, 8-28, 8-31 Responding Business Action page, 8-29, 8-33 Review page, 8-29, 8-35 Create Trading Partner wizard accessing, 9-7 assigning business actions in separate session, 9-26 business actions in single session, 9-9 business protocol communication capabilities in separate session, 9-27 business protocol communication capabilities in single session, 9-9 business protocol in separate session, 9-25 business protocol operational capabilities in separate session, 9-26 business protocol operational capabilities in single session, 9-9 collaboration support, 9-12 collaborations in separate session, 9-26 collaborations in single session, 9-9 functional acknowledgment requirement, 9-6, 9-14 initiator, 9-13, 9-14 creating and defining all capabilities in separate sessions, 9-23 remote trading partner in separate session, 9-24 Delivery Channel page description, 9-5 using, 9-15 See also delivery channels description, 9-3 Document Exchange page description, 9-5 using, 9-17 See also document exchanges flexibility in using, 9-7 General page description, 9-3 using, 9-9 Identification page creating remote trading partner, 9-24 description, 9-4 using, 9-9 importing .ecs files, 9-15 internal endpoints selection restriction, 9-23 Operational Capability page description, 9-4 using, 9-11 See also operational capabilities prerequisites, 9-7 Review page description, 9-6 using, 9-23 tasks, main, 9-2 Transport page description, 9-5 using, 9-21 See also transports custom documents description, 3-7 ebMS, over, 9-11 Generic Exchange, over, 9-11 Internet, over, 9-11 MLLP exchange, over, 9-11 protocols importing UCCnet, 8-3 restriction on using functional acknowledgments in Create Trading Partner wizard, 9-6 UCCnet, 8-19 D data universal numbering system (DUNS) assigning as trading partner identification, 10-9 description, 9-10, 9-24, 10-9 trading partner identification type, 9-10, 9-24 delete button differences with remove button, 2-8 delivery channels, 4-1 adding for trading partner participants, 12-14 creating for host trading partners with Create Trading Partner wizard, 9-15, 10-50 for remote trading partners with Create Trading Partner wizard, 9-15, 10-50 deleting, 10-52 description, 10-49 internal delivery channels adding, impact of, 12-16 removing, impact of, 12-16 managing, 10-49 trading partner agreement, selecting, 12-6 trading partner participants managing for, 12-13 removing for, 12-16 updating for, 12-15 viewing for, 12-14 updating, 10-51 viewing, 10-51 See also Delivery Channel page under Create Trading Partner deployed lifecycle state Index-5 description, 2-11 for partner data, 2-12 deployment configurations deploying, 13-6 description, 13-1 validated state, restrictions, 13-2 creating a configuration, 13-3 description, 13-6 design-time workflow, 1-5 errors, user, 13-10 restrictions configuration in validated state, 2-3, 2-18, 13-5 trading partner agreement in multiple configurations, 13-6, 13-7 trading partner agreements same in multiple configurations, 13-2 states, 13-8 trading partners in configuration, 13-6 with configuration, 1-8 Deployment page description, 2-18 deployment tab description, 2-3, 2-18 tasks, 2-18 See also deployment deq_b2b.sql PL/SQL Dequeue script, 16-3 dequeuing See Java Dequeue, PL/SQL Dequeue Design List page description, 2-20 design tab tasks, 2-20 designs list page description, 2-20 design-time data creating incomplete partner data, 2-7 description, 17-5 flexibility of design, 2-7 design-time repository, 1-5 exporting, 17-5, 17-7 importing, 17-5, 17-7 restrictions backup and recovery, 17-6 importing, 17-7 design-time workflow, 1-4 details pages, 2-5 differences between creating and adding commands, 2-8 between deleting and removing commands, 2-8 digital envelopes configuration tasks, 20-4 selecting with Create Trading Partner wizard, 9-16, 9-19 supported in OracleAS Integration B2B, 20-2 updating, 10-52 See also security digital signatures configuration tasks, 20-5 enabled by nonrepudiation of origin and Index-6 receipt, 9-16 recommendations for using SHA-RSA, 9-20 selecting with Create Trading Partner wizard, 9-16, 9-20 supported in OracleAS Integration B2B, 20-2 updating, 10-52 See also security discarded configurations configuration state, 13-5 description, 13-5 procedure, 13-9 document definition files .dtd files, specifying, 8-2 importing with Create Business Action wizard, 8-25 with Create Collaboration wizard, 8-33, 8-34 .xsd files, specifying, 8-2 document definitions 100-character limit on string values, 9-15 updating, 8-14 using default document definitions with Create Trading Partner wizard, 9-15 viewing, 8-13 document editor, 8-4 document exchanges creating for host trading partners with Create Trading Partner wizard, 9-17 for remote trading partners with Create Trading Partner wizard, 9-17 deleting, 10-55 delivery channel assigned to trading partner agreement, 10-53, 12-13 description, 10-52 managing, 10-52 updating, 10-54 viewing, 10-54 See also Document Exchange page under Create Trading Partner document protocols as part of business protocol, 10-25 description, 3-2 managing, 8-5 parameters assigning with Create Trading Partner wizard, 9-14 overriding default document definitions with Create Trading Partner wizard, 9-15 overriding parameter values individually, 8-9 overriding parameter values with Create Trading Partner wizard, 8-24, 9-15 using existing parameter values with Create Trading Partner wizard, 9-15 revisions creating individually, 8-8 creating without wizards, 8-8 deleting, 8-10 updating, 8-9 viewing, 8-9 RosettaNet support provided only for version 2.0, 8-8 supported version, 1-4 viewing, 10-29 document standards importing, 17-8 document types creating individually, 8-10 with Create Business Action wizard, 8-21, 8-24 without using wizards, 8-10 deleting, 8-13 parameters 100-character limit on string values, 8-25 overriding parameter values with Create Business Action wizard, 8-11 overriding parameter values with Create Collaboration wizard, 8-11 overriding parameter values with Create Trading Partner wizard, 8-25 relationship to a transaction set, 8-24 revisions collaborations revision number matching document type revision number, 8-13, 8-30, 8-32, 8-34, 8-36 updating, 8-12 viewing, 8-12 draft lifecycle state description, 2-11 exporting partner data to XML files, 2-12 for partner data, 2-12 .dtd files downloading from RosettaNet Web site, 8-2 importing with Create Collaboration wizard, 8-33, 8-34 E ebMS exchange associated protocols, 9-11 protocol correlation between documents supported, 3-10 description, 3-10 limitations, 9-6 .ecs files, importing when creating document protocol revision outside wizards, 8-9, 8-10 with Create Business Action wizard, 8-24, 8-25 with Create Trading Partner wizard, 9-15 EDI batching examples, 14-2 EDI EDIFACT creating business actions, 8-3 description, 3-6 Generic Exchange business protocol, 9-11 Internet business protocol, 9-11 over Generic (VAN) tutorial, 5-18, 6-2, 7-2 trading partners using ISA/GS identifier, C-1 transaction sets importing, 8-3, 17-8 transaction sets supported in OracleAS Integration B2B, 3-6 EDI Location Code assigning as trading partner identification, 10-9 description, 10-9 entering on Identification page, 9-10 trading partner identification type, 9-10, 9-25 EDI X12 creating business actions, 8-3 description, 3-6 Generic Exchange business protocol, 9-11 Internet (AS2) tutorial, 5-40 Internet business protocol, 9-12 trading partners using ISA/GS identifier, C-1 transaction sets description, 3-6 importing, 8-3, 17-8 supported in OracleAS Integration B2B, 3-6 Email transport protocol angle brackets requirement in To and From headers, 9-22 limitations if exchanged document has large records, 9-22 emctl command stopping Oracle Enterprise Manager 10g, 18-11 encryption configuration tasks, 20-4 credentials selecting with Create Trading Partner wizard, 9-19 updating, 10-52 host trading partner passwords in high availability environments, 20-9 selecting with Create Trading Partner wizard, 9-16 update restriction in existing delivery channel, 10-52 viewing for exchange protocol, 10-28 wallet passwords for host trading partners, 20-8 endpoints creating for host trading partners with Create Trading Partner wizard, 9-22, 10-62 for remote trading partners with Create Trading Partner wizard, 9-22, 10-62 deleting, 10-64 delivery channel assigned to trading partner agreement, 10-62 description, 10-61 global to all trading partners, 10-61 managing, 10-61 restrictions on editing for internal delivery channels, 10-32 updating, 10-58, 10-64 viewing, 10-63 enq_b2b.sql PL/SQL Enqueue script, 16-3 enqueuing See Java Enqueue, PL/SQL Enqueue Index-7 enterprise environments, A-9 error message status reports creating, 19-7 description, 2-19 errors connection, A-5 out-of-memory, A-4 RMI server contact, A-5 user business protocols, 8-37 callouts, 11-22 deployment, 13-10 exported files, 17-11 trading partner and trading partner agreements, 12-16 trading partners, 9-28, 10-66 See also troubleshooting exception handling description, B-1 inbound exception handling scenarios, B-3 inbound messages, B-1 acknowledgement messages, B-2 exception messages, B-2 request or response messages, B-1 outbound messages, B-2 payload definition, B-4 exchange protocols as part of business protocol, 10-26 AS2, 9-6 descriptions, 3-8 ebMS, 9-6 description, 3-10 generic, 3-10 MLLP, 3-10 parameters defining with Create Trading Partner wizard, 9-18 meaning of Signed and Compressed parameter if using AS2, 9-18, 10-55 overriding values with Create Trading Partner wizard, 9-18 updating, 10-55 revisions selecting with Create Trading Partner wizard, 9-17 updating, 10-55 using AS, 9-17, 10-55 using Generic Exchange, 9-17, 10-55 using RNIF, 9-17, 10-55 RNIF, 9-6 support for B2B, 9-6 supported versions, 1-4, 3-2 viewing, 8-18, 10-28 export Agreement Details page, 2-11 configuration, 13-10 description, 17-5 design-time repository to file description, 17-5 Index-8 details, 17-6 errors, user, 17-11 exporting and submitting XML files of partner data for approval, 2-12 configuration created under deployment tab, 2-22 design-time repository to file, 2-22 export.xml file, 17-7 location on user interface, 2-7 partner data details pages with export button, 2-10 partner data to XML file, 2-9 restrictions backing up design-time repository, 17-6 manually editing exported files, 2-11, 13-10, 13-11, 17-5, 17-11 Trading Partner Details page, 2-11 types of export supported, 17-5 export.xml file exporting design-time repository to, 17-7 importing design-time repository from, 17-7 F File transport protocol security limitations, 9-6 transport protocol parameters to set, A-7 FTP servers Windows requirements, A-8 FTP transport protocol FTP server requirements on Windows, A-8 security limitations, 9-6 transport protocol parameters to set, A-7 functional acknowledgment assigning with Create Trading Partner wizard, 9-6, 9-14 custom document protocols, 9-6 EDI EDIFACT, incompatibility with, over Generic Exchange with HTTP or HTTPS, A-8 EDI X12, incompatibility with, over Generic Exchange with HTTP or HTTPS, A-8 updating, 10-48 G generic exchange protocol acknowledgment mode value requirement, 9-6, 9-16, 12-16 description, 3-10 FTP server requirements on Windows, A-8 HL7, over, 9-12 IP address requirement, 9-4, 9-10, 9-22, 9-25, 10-9, 10-35 Oracle Application Server Web Cache, requirement to disable if using HTTP or HTTPS, A-8 restrictions EDI EDIFACT over Generic Exchange with HTTP or HTTPS, A-8 EDI X12 over Generic Exchange with HTTP or HTTPS, A-8 security limitations on using File and FTP transport protocols, 9-6 transport protocols parameter settings for FTP or File transport protocol, A-7 selecting, 9-21 user interface tool, IP address requirement, 9-4, 9-10, 9-22, 9-25, 10-9, 10-35 Generic Identifier assigning as trading partner identification, 10-9 description, 10-9 remote as trading partner type, 9-4 trading partner identification type, 9-4, 9-10, 9-25 Generic Log Level parameter logging level, A-3 global usage code selecting with Create Trading Partner wizard, 9-16 updating, 10-52 used mainly with RNIF, 10-52 globalization support disabling EDI document validation in Create Business Action wizard, 8-11, 8-14, 8-23, 8-25 See Oracle Application Server Integration B2B Installation Guide for additional details, 8-23 graphical user interface tool See user interface tool H heap size, increasing, A-4 high availability, changing RMI hostname value, 20-11 HL7 over generic exchange, 9-12 over MLLP exchange, 9-12 host applications description, 10-30 integrations with, 4-11 use of internal delivery channels, 4-1, 10-30 host trading partner assigning business action compatible with remote trading partner, 12-6 business action compatible with remote trading partner, automatic, 10-47, 12-2 collaboration compatible with remote trading partner, automatic, 9-13, 10-44, 12-5 business protocols automatic support, 2-3 Capabilities page details, 10-3 communication capabilities, creating, 9-7 remote trading partners, 2-15 Review page details, 9-23 trading partners defined by, 8-2 within trading partner creation, 9-2 created automatically, 9-9 default name of MyCompany after installation, 2-14 deletion restrictions, 2-14, 10-7 description, 2-14, 9-1 operational capabilities automatic support, 2-3 Capabilities page details, 10-3 communication capabilities, creating, 9-7 remote trading partners, 2-15 Review page details, 9-23 trading partners defined by, 8-2 within trading partner creation, 9-2 person capabilities, 10-21 trading partner agreements, 12-1 updating MyCompany default host trading partner name after installation, 10-7 user of user interface tool to define trading partners’ capabilities, 2-14 host trading partner wallet passwords See wallet passwords HTTP/S. See secure HTTP I ias_admin user, 20-1 Oracle Enterprise Manager 10g user account, 18-4 import cautions about importing an integration, 17-8 collaborations standards, support for, 17-8 through file, 8-3 description, 17-5 design-time repository from file description, 17-5 details, 17-6 .dtd files from RosettaNet Web site, 8-2 from export.xml file, 17-7 importing configuration created under deployment tab, 2-22 design-time repository from file, 2-22 precautions to importing design-time repository, 17-7 reports, 19-8 restrictions recovery design-time repository, 17-6 status imported configuration, 17-8 imported trading partner agreements, 17-6 transaction sets standards, support for, 17-8 through file, 8-3 UCCnet standards, support for, 17-8 initiator assigning with Create Trading Partner wizard, 9-13, 9-14 creating bidirectional exchanges, 8-3 defining in business action between trading partners, 9-14 in collaboration between trading Index-9 partners, 9-13 updating, 10-48 instance data description, 17-9 internal delivery channels, 4-1, 4-7, 4-11 advanced queuing (AQ) as transport protocol, 10-34 advanced queuing (AQ) transport protocol, 10-34 B2B Inbound, 10-30 B2B Inbound and B2B Outbound, 4-2, 4-5 B2B Outbound, 10-30 callout usages, associating with, 11-1 communicating with host applications, 4-1 creating, 10-33 deleting, 10-42 delivery channel adding, impact of, 12-16 removing, impact of, 12-16 description, 10-30 direction from perspective of host trading partner, 10-33 EDI transaction sets, batching and debatching, 14-1 editing transport parameter details, restrictions, 10-32 example of internal delivery channel with JMS transport protocol, 10-37 internal endpoints, automatically associated, 10-30 IP_MESSAGE_TYPE message structure, using, 10-30 Java Message Service (JMS), using as transport protocol, 10-34 managing, 10-30 page for creating, 10-33 predefined business protocol entdpoint, 10-63 internal delivery channels, restriction on updates and deletes, 10-33 listed, 10-30 reasons for creating your own, 10-31 Review page for creating, 10-37 selecting for trading partner agreement, 12-6 Transport page for creating, 10-34 troubleshooting JMS transport protocol errors, 10-39 user-defined, 4-1, 4-11 XML Gateway, 4-4 XML Gateway Inbound, 10-30 XML Gateway Outbound, 10-31 internal endpoints apps.ECX_INBOUND internal endpoint, 10-63 apps.ECX_OUTBOUND internal endpoint, 10-63 b2b.IP_IN_QUEUE internal endpoint, 10-63 b2b.IP_OUT_QUEUE internal endpoint, 10-63 Create Trading Partner wizard selection restriction, 9-23 internal delivery channels associated automatically, 10-30 of host applications, used only with, 9-23 Index-10 invocation limits assigning to trading partner agreement, 12-7 updating in trading partner agreement, 12-9 IP queue, 1-2 IP_IN_QUEUE, 4-2, 4-5 IP_MESSAGE_TYPE, 4-6 parameters, 4-2 IP_MESSAGE_TYPE message structure, 4-2 internal delivery channels, used with, 10-30 IP_MESSAGE_TYPE object parameters, 4-2 IP_OUT_QUEUE, 4-2, 4-5 ipdequeue.properties Java Dequeue command, 16-2 ipException.xsd payload, B-4 ipsetupinfo.txt file lists ports for accessing Oracle Enterprise Manager 10g Application Server Control Console, 18-4 for accessing user interface tool, 2-1 location, 2-1 ISA/GS description, C-1 J Java Dequeue commands, 16-1 ipdequeue.properties command, 16-2 Java Enqueue commands, 16-1 IPEnqueue Java Enqueue command, 16-1 Java Message Service (JMS) internal delivery channel transport protocol, used as, 10-34 L lifecycle states approved state, 2-11 deployed state, 2-11 deployed state for partner data, 2-12 draft state description, 2-11 draft state for partner data, 2-12 trading partner agreement, 12-8 trading partners, 10-6 validated state for partner data, 2-12 viewing partner data states on details page, 2-11 See also states list pages, 2-4 callouts, 2-17 design, 2-20 management, 2-21 protocols, 2-16 trading partner agreements, 2-16 trading partners, 2-13 log files defining log file format in tip.properties file, A-3 file name formats, A-3 for out-of-memory errors, A-4 location, A-3 log.xml log file, A-3 setting log levels, A-3 troubleshooting errors, A-3 viewing in Oracle Enterprise Manager 10g, A-3 logging in for tutorial, 5-3 user interface tool, 2-1 log.xml file location, A-3 troubleshooting errors, A-3 See also log files 18-7, M main details pages description, 2-5 main list pages, 2-4 management list page overview, 2-21 Management page, 2-21 management tab tasks, 2-21 MD5-RSA digital signatures selecting with Create Trading Partner wizard, 9-20 supported versions, 9-20 memory errors, A-4 message correlation, 4-10 message routing support, 8-19 middle-tier instances description, 18-3 one OracleAS Integration B2B instance for each Oracle home, 18-3 requirements multiple instances on a single host, 18-4 Oracle Application Server Metadata Repository, 18-3 MLLP exchange protocol custom documents, 9-11 description, 3-10 HL7, over, 9-12 msgid_b2b.sql PL/SQL Enqueue script, 16-2 MyCompany default host trading partner name after installation, 2-14 N naming conventions partner data, 2-8 restrictions, 2-8 next list description, 2-5 nonrepudiation of origin and receipt configuration tasks, 20-5 enabling digital signatures and signing credentials, 9-16 host trading partners values, 20-6 remote trading partners values, 20-6 requirement for selected values to match, 9-16, 20-6 selecting with Create Trading Partner wizard, 9-16 update in existing delivery channel, 10-52 O OC4J instance description, 18-3 starting with OPMN, 18-6, 18-9 with Oracle Enterprise Manager 10g, 18-6 stopping with OPMN, 18-9 with Oracle Enterprise Manager 10g, 18-6 online help OracleAS Integration B2B, 3-4 operational capabilities as partner data task, 2-3 assigning host trading partner automatically, 8-2, 9-7 details display, 9-23 for business actions, 8-2 for collaborations, 8-2 managing business protocol, 10-3 tasks, 9-2 business actions, 10-5 Business Protocol Details page description, 9-23 collaborations, 10-5 completing creation, 9-4 creating for remote trading partner with Create Trading Partner wizard, 9-11, 9-26 defining with Create Trading Partner wizard, 9-7 description, 9-3 lower-level trading partner data details, 2-11 task in trading partner management workflow, 1-6 tasks for remote trading partner business protocol, 2-15 viewing business protocol, 10-28 in user interface tool, 2-15, 9-25, 10-4, 10-28 See also Operational Capability page under Create Trading Partner OPMN See Oracle Process Manager and Notification Server (OPMN) opmnctl command starting and stopping instances, 18-9 stopping OPMN, 18-11 opmn.xml file changing port numbers, 18-11 ora_wallet.txt file naming, 10-15 Oracle Application Server Containers for J2EE (OC4J) instance See OC4J instance Oracle Application Server Metadata Index-11 Repository, 18-3 Oracle Application Server Web Cache generic exchange protocol with HTTP or HTTPS, requirement to disable, A-8 Oracle BPEL Process Manager adapters, 4-9 configuring, 4-8 integrations with OracleAS Integration B2B, 4-5 Oracle E-Business Suite, 1-2 integrations with, 4-4 integrations with OracleAS Integration B2B, 4-4 internal delivery channels, 4-1 Oracle Enterprise Manager 10g log files, viewing, 18-7 monitoring and administration, overview, 18-1 OracleAS Integration B2B from Oracle Enterprise Manager 10g Grid Control Console, 18-2 performance, viewing, 18-7 ports changing port number, 18-11 viewing, 18-9 server property settings changing, 18-8 updating on Windows, 18-9 tasks, 18-3 Oracle Enterprise Manager 10g Application Server Control Console, A-3 Oracle Enterprise Manager 10g Grid Control Console cannot manage OracleAS Integration B2B, 18-2 Oracle HTTP Server installing additional server outside corporate network, 20-10 security, 20-10 Oracle Process Management and Notification (OPMN) B2B server and OC4J instance, stopping, 18-9 OracleAS Integration B2B, stopping, 18-9 Oracle Wallet created automatically during installation, 10-15 exporting, 10-15 Oracle Wallet Manager base64 files import restriction, 20-7 tasks to perform in, 10-15 OracleAS Integration B2B configuring for integrations with Oracle BPEL Process Manager, 4-7 one instance for each Oracle home, 18-3 online help, 3-4 protocol limitations, 9-6 remote trading partner-to-remote trading partner message routing, internal support not allowed, 8-19 starting with OPMN, 18-6, 18-9 stopping with OPMN, 18-9 with Oracle Enterprise Manager 10g, 18-6 user interface, accessing, 2-1 OracleAS Integration B2B - Document Editor creating .xsd files, 8-2 description, 8-4 Index-12 installing, 8-4 OracleAS Integration InterConnect, 1-2 integrations with, 4-2 integrations with OracleAS Integration B2B, 4-2 internal delivery channels, 4-1 IP_MESSAGE_TYPE, 4-2 OrclTPProfilesV2-6.xsd trading partner example descriptor file, 15-1, 15-4 P packaging protocols, 3-2 supported versions, 1-4 page components of user interface, 2-3 participants See trading partner agreement participants partner data agreements tab overview, 2-16 callouts tab overview, 2-17 creating incomplete data, 2-7 deployed state, 2-12 description, 2-18 details pages with export button, 2-10 draft state, 2-12 exporting to XML file, 2-9 naming conventions, 2-8 partners tab overview, 2-13 protocols tab overview, 2-16 tasks, 2-3 validated state, 2-12 See also partners tab partner interface processes (PIPs) description, 3-11 RosettaNet support, 4-10 trading partner agreements, 1-7 partners tab description, 2-3 tasks, 2-13 See also partner data passwords admin user, 20-1 ias_admin user, 18-4 not imported, 17-6 person passwords not exported, 17-6 updating admin password, 10-22 ias_admin password, 18-5 to transport server inclusion of password, 10-60 user interface, 2-2 wallet passwords managing host trading partner, 10-14 not exported, 17-6 performance Oracle Enterprise Manager 10g, viewing in, 18-7 validation set outside Oracle AS Integration B2B, impact, 8-9, 8-10, 8-23, 8-33 persons contact details, creating, 10-18 creating, 10-22 deleting, 10-23 host trading partner person capabilities, 10-21 managing, 10-20 passwords not exported, 17-6 remote trading partner person capabilities, 10-21 updating name or description, 10-23 password, 10-22 viewing, 10-22 PIPs See partner interface processes (PIPs), 1-7 PL/SQL Dequeue commands, 16-2 deq_b2b.sql script, 16-3 PL/SQL Enqueue commands, 16-2 enq_b2b.sql script, 16-3 msgid_b2b.sql script, 16-2 portlist.ini file list of ports in use, 18-4 ports changing OracleAS Integration B2B ports, 18-11 listed in ipsetupinfo.txt file, 2-1, 18-4 port changing error message, 18-11 portlist.ini file, 18-4 strongly recommended not to change OracleAS Integration B2B ports, 18-11 user interface tool, accessing, 2-1 viewing through Oracle Enterprise Manager 10g, 18-9 previous list, 2-5 process protocols, 3-2, 3-11 as part of business protocol, 10-26 description, 8-19 managing, 8-19 supported versions, 1-4 viewing, 10-29 protocol endpoints deleting, 10-65 description, 10-61 updating, 10-65 viewing, 10-64 protocol transport endpoints updating, 10-65 protocols business behavior, 1-5 description, 3-12 design-time workflow, 1-4 document description, 3-2 supported versions, 1-4 exchange description, 3-8 supported versions, 1-4, 3-2 list page overview, 2-16 mix and match, 3-13 packaging description, 3-2 supported versions, 1-4 process, 3-11 description, 3-2 supported versions, 1-4 supported, 1-2, 1-3, 3-1 transport description, 3-2 supported versions, 1-4 protocols tab tasks, 2-16 See also protocols purging business message or wire message, 17-10 configurations, requirement to archive before purging, 17-9 data in deployed configuration in run-time repository, 17-9 management task with user interface tool, 17-2 purge utility, purging wire messages, 17-10 repository, 17-9 Q queues confirming validity of messages, quiescing configuration state, 13-4 configurations, 13-2, 13-9 A-2 R remote trading partner certificates Certificate File field empty for certificate updates, 10-14 configuration tasks, 20-4 creating procedure, 10-13 without Create Trading Partner wizard, 9-15, 9-17 deleting, 10-14 description, 10-11 managing, 10-11 remote trading partners, 10-12 selecting certificate file with Create Trading Partner wizard, 9-19 updating Certificate File field empty, 10-14 procedure, 10-14 viewing, 10-13 See also remote trading partners remote trading partners assigning business protocol communication capabilities in separate Create Trading Partner wizard session, 9-27 business protocol in separate Create Trading Partner wizard session, 9-25 business protocol operational and communication capabilities in single wizard session, 9-9 business protocol operational capabilities in separate Create Trading Partner wizard Index-13 session, 9-26 business protocol operational capabilities in single wizard session, 9-9 collaborations and business actions to, 8-2 multiple business protocols, 9-8 creating and defining all capabilities in separate Create Trading Partner wizard sessions, 9-23 in separate Create Trading Partner wizard session, 9-24 with Create Trading Partner wizard, 9-9 default trading partner identification type called Name, 10-7 description, 9-1 managing, 9-1 person capabilities, 10-21 routing messages to other remote trading partners, 8-19 trading partner agreements, 12-1 See also remote trading partner certificates remove button differences with delete button, 2-8 report definitions saving, 19-8 reports description, 19-1 importing, 19-8 saving report definitions, 19-8 to comma-separated value (CSV) format, 2-19, 19-8 troubleshooting errors, A-2 Reports page, 2-18 Reports role description, 19-1 generating reports, required for, 10-21 reports tab description, 2-3 tasks, 2-18 responding callout usages appearing when creating trading partner agreement, 11-2 selecting when creating trading partner agreement, 11-2, 12-7 responding internal delivery channels appearing when creating trading partner agreement, 12-7 selecting for trading partner agreement, 12-7 restrictions configuration names, 13-5 deployment configuration in validated state, 13-2 design-time backup and recovery, 17-6 imports, 17-7 respository backup and recovery, 17-6 EDI EDIFACT over Generic Exchange with HTTP or HTTPS, A-8 EDI X12 over Generic Exchange with HTTP or HTTPS, A-8 host trading partner deletions, 2-14, 10-7 Index-14 internal delivery channel edits, 10-32 internal delivery channel transport parameter edits, 10-32 naming conventions, 2-8 search facility, 2-8 trading partner agreement in multiple configurations, 13-6 trading partners, maximum in agreement, 12-5 user role deletes, 10-25 Web browser back and forward buttons, 2-8 retired configurations configuration state, 13-5 description, 13-5 retry count selecting with Create Trading Partner wizard, 9-17 updating, 10-52 return to list link using, 2-8 RMI Instance parameter RMI instance, defining, 20-11, A-5 value matching web.xml transport servlet setting, 20-10, A-6 RMI Port parameter defining RMI port, 20-11, A-5 value matching web.xml transport servlet setting, 20-10, A-6 RMI server errors when attempting to contact, A-5 RNIF See RosettaNet Implementation Framework (RNIF), 3-8 RNIF exchange protocol, 9-6 roles Administrator, 10-21 assigning to a host trading partner, 10-24 deletes not allowed, 10-25 removing from a host trading partner, 10-24 Reports, 10-21 viewing for a host trading partner, 10-25 RosettaNet Business Directory, 3-5 creating collaborations, 8-3 description, 3-4 document protocol support provided only for version 2.0, 8-8 Implementation Guidelines, revision 2.0, 3-8 importing collaborations, 8-3, 17-8 Internet tutorial, 5-5 over RNIF business protocol, 9-12 partner interface processes, 4-10 RNIF exchange protocol, 9-6 Technical Directory, 3-5 validation, 3-5 RosettaNet Implementation Framework (RNIF) description, 3-9 See also RosettaNet routing support, 8-19 run-time repository, 1-5 run-time system deployment, 13-6 S search facility description, 2-5 in user interface, 2-8 only available for more than 10 elements, 2-8 using wildcards, 2-8 secure HTTP connecting to secure HTTP URL, 20-8 enabling transport security with Create Trading Partner wizard, 9-17 secure connections between trading partners, 20-6 selecting with Create Trading Partner wizard, 9-21 secure socket layer (SSL) selecting with Create Trading Partner wizard, 9-21 troubleshooting setup, 20-7 security authorization and access enforcement, 20-2 classes of users and their privileges, 20-1 configuration encryption, digital certificates, 20-4 encryption, enabling, 20-9 levels of security, 20-4 description, 20-1 digital envelopes, 20-4 digital signatures, 20-5 encryption digital envelopes, 20-4 encrypted wallet passwords for host trading partners, 20-8 host trading partners, 20-9 for trading partners, 20-2 host trading partner password encryption in high availability environments, 20-9 identity management configuration issues, 20-3 installation and configuring additional Oracle HTTP Server outside corporate network, 20-10 issues, 20-4 network messaging, 20-2 nonrepudiation of origin and receipt, 20-5 Oracle Application Server security services, 20-3 Oracle HTTP Server, 20-10 Oracle Identity Management Infrastructure, 20-3 remote trading partner certificates, 20-4 resources protected, 20-2 secure HTTP and client authentication, tasks, 20-6 securing OracleAS Integration B2B user interface tool, 20-3 security framework configuration issues, 20-3 Security Key parameter defining encryption key, 20-9 signing credentials, 20-5 verifying SSL client authentication, 20-8 wallet passwords, 20-5, 20-6, 20-7 See also digital envelopes, digital signatures, secure HTTP, secure socket layer (SSL) send for approval button details pages, 2-12 server properties B2B Server Level parameter, A-3 Callout Directory parameter, 11-5 changing in Oracle Enterprise Manager 10g, 18-8, A-3 defining log file format, A-3 description, 18-8 Generic Log Level parameter, A-3 range of values described in online help, 18-3, 18-9 RMI Instance parameter, 20-11, A-5 RMI Port parameter, 20-11, A-5 Security Key parameter, 20-9 setting log levels, A-3 updating property values on Windows, 18-9 User Interface Log Level parameter, A-3 Wallet Location parameter, 10-16, 20-5, 20-6, 20-7, 20-8 SHA-RSA digital signatures recommended digital signature, 20-6 selecting with Create Trading Partner wizard, 9-20 supported versions, 9-20 See also security shortcut section creating trading partner and trading partner agreement, 2-13 description, 2-5 for creating trading partner agreement, 2-5 signing credentials configuration tasks, 20-5 enabled by nonrepudiation of origin and receipt, 9-16 selecting with Create Trading Partner wizard, 9-16, 9-20 updating, 10-52 viewing for exchange protocol, 10-28 S/MIME digital envelopes selecting with Create Trading Partner wizard, 9-19 supported versions, 9-19 See also digital envelopes, security states approved, 2-11 deployed, 2-11 draft, 2-11 of a configuration, 13-4 viewing partner data lifecycle states on details page, 2-11 See also lifecycle states string values 100-character limit for document definitions, 9-15 100-character limit for document type parameter values, 8-25 SYSTEM.ECXMSG message structure, 4-4 Index-15 in callouts tutorial, 11-18 SYSTEM.ECXMSG message type parameters, 4-4 T targets.xml file changing port numbers, 18-12 These, 4-2 trading partner agreement participants adding additional identifications and operational and communication capabilities, 12-10 host trading partner, 12-13 managing, 12-9 removing a remote trading partner, 12-13 updating identifications, delivery channels, internal delivery channels, and callout usages for a remote trading partner, 12-12 viewing, 12-11 trading partner agreements adding multiple business actions to single agreement, 12-6 multiple collaborations to single agreement, 12-6 API description, 15-1 using self-service API, 15-5 API, example files location, 15-6 assigning beginning date, 12-7 concurrent conversation value, 12-7 ending date, 12-7 invocation limit, 12-7 configuration, included in, 13-3 creating agreement ID, 12-7 description, 12-2 procedure, 12-5 creation overview, 12-1 deleting, 12-9 delivery channel, selecting, 12-6 description, 12-1 design-time workflow, 1-5 enabling responding callout usages to appear, 11-2 responding internal delivery channels to appear, 11-2 errors, user, 12-16 impact of validated agreement when wallet password is updated or created, 10-14 list page overview, 2-16 managing, 12-4 maximum trading partners in agreement, 12-5 nonrepudiation of origin and receipt values, 20-6 participant information, 1-7 prerequisites, 12-3 revalidating agreement of exported configuration, 13-10, 17-8 selecting Index-16 business action, 12-6 callout usage, 11-2, 12-7 collaboration, 12-5 internal delivery channel, 11-2, 12-6 responding callout usage, 11-2, 12-7 responding internal delivery channel, 11-2, 12-7 trading partner identification type value, 12-6 selecting callout usage, 4-12 selecting internal delivery channel, 4-12 shortcut to creating, 2-5 status after importing, 17-6 of trading partner agreement in imported configuration, 17-8 tutorial on custom XML document, 7-1 updating beginning date, 12-9 concurrent conversation value, 12-9 ending date, 12-9 invocation limit, 12-9 procedure, 12-8 validated agreements in configuration, 13-4 viewing lifecycle states, 12-8 procedure, 12-8 XML custom document tutorial, 7-1 descriptors, 15-1 files for API, 15-1 See also trading partner agreement participants Trading Partner Agreements page description, 2-16 See also trading partner agreements trading partner descriptor XML file description, 15-1, 15-4 OrclTPProfilesV2-6.xsd, 15-1, 15-4 Trading Partner Details page capabilities section, 2-14 description, 2-11 exporting to an XML file, 2-11 general section, 2-14 organization section, 2-14 users section, 2-14 using, 2-14, 10-2 trading partner identification types AS2 Identifier, 9-10, 9-24 assigning an AS2 Identifier, 10-9 assigning DUNS number, 10-9 assigning EDI Location Code, 10-9 assigning Generic Identifier, 10-9 creating procedure, 17-4 with Create Trading Partner wizard, 9-24 without Create Trading Partner wizard, 10-8 creating with Create Trading Partner wizard, 9-9, 9-24 data universal numbering system (DUNS), 9-10, 9-24 deleting, 10-10 description, 2-21, 17-3 EDI Location Code, 9-10, 9-25 Generic Identifier, 9-4, 9-10, 9-25 managing, 10-7, 17-3 predefined contact types that you cannot delete or update, 17-3 selecting value for trading partner agreement, 12-6 updating, 10-10 viewing, 10-9, 17-4 trading partner management, 1-5, 1-7 Trading Partner page overview, 2-13 trading partner participant delivery channel impact on internal delivery channels of removing and adding a delivery channel, 12-16 trading partner participant delivery channels adding, 12-14 managing, 12-13 removing, 12-16 updating, 12-15 viewing, 12-14 trading partners accessing Create Trading Partner wizard, 9-7 Business Protocol Details page, 10-4 Create Trading Partner wizard prerequisites, 9-7 creating creation overview, 9-1 remote trading partner in separate Create Trading Partner wizard session, 9-24 tasks, 9-2 defining initiator in business action, 9-14 responder in business action, 9-14 deleting restrictions, 10-7 Delivery Channel page of Create Trading Partner wizard, 9-5, 9-15 description, 9-1 Document Exchange page of Create Trading Partner wizard, 9-5, 9-17 EDI EDIFACT, and ISA/GS identifier, C-1 EDI X12, and ISA/GS identifier, C-1 errors, user, 9-28, 10-66, 12-16 General page of Create Trading Partner wizard, 9-3, 9-9 host trading partner deletion restriction, 10-7 Identification page of Create Trading Partner wizard, 9-4, 9-9, 9-24 in configuration, 13-6 ISA/GS, identifying using, C-1 list page overview, 2-13 managing, 10-5 associated trading partner agreement, 10-10 description, 10-1 Operational Capability page of Create Trading Partner wizard, 9-4, 9-11 Review page of Create Trading Partner wizard, 9-6, 9-23 Trading Partner Details page, 10-2 Transport page of Create Trading Partner wizard, 9-5, 9-21 tutorial on custom XML document, 7-1 updating, 10-7 value-added network (VAN), and ISA/GS identifier, C-1 viewing lifecycle states, 10-6 procedure, 10-6 XML custom document tutorial, 7-1 transaction sets description, 2-3 importing, 8-3, 17-8 relationship to a document type of a business action, 8-24, 17-5 relationship to document type of business action, 2-3 transformations, using callouts, 11-1 transport protocols listed, 3-2 parameters defining with Create Trading Partner wizard, 9-22 parameters based on transport protocol, 9-22 parameters that appear are based on transport protocol used, 10-61 restrictions on editing for internal delivery channels, 10-32 updating values, 10-61 when using FTP or File transport protocol, A-7 revision, 3-2 selecting Email, 9-21 File, 9-21 FTP, 9-21 HTTP, 9-21 secure HTTP, 9-21 with Create Trading Partner wizard, 9-21 supported versions, 1-4 updating, 10-57 transport security selecting with Create Trading Partner wizard, 9-17 updates not allowed, 10-52 updating, 10-52 See also security transport servers creating for host and remote trading partners with Create Trading Partner wizard, 10-59 deleting, 10-61 delivery channel assigned to trading partner agreement, 10-58 description, 10-58 managing, 10-58 updates with password, 10-60 updating, 10-57, 10-60 viewing, 10-60 transport servlet accessing, A-5 Index-17 provides security for incoming messages of trading partners, 20-10 web.xml values matching RMI Port and RMI Instance parameter values, 20-10, A-6 transports creating for host and remote trading partners with Create Trading Partner wizard, 9-21, 10-56 deleting, 10-58 delivery channel assigned to trading partner agreement, 10-55, 12-13 description, 10-55 managing, 10-55 updating, 10-57 viewing, 10-57 See also Transport page under Create Trading Partner troubleshooting checking log files, A-3 checking queues, A-2 internal delivery channels using JMS transport protocol, 10-39 out-of-memory errors, A-4 resolving connection errors, A-5 running reports, A-2 setting log levels, A-3 SSL setup, 20-7 See also errors tutorials adding callout usages to RosettaNet over Internet transaction, 11-16 callout usages, 11-17 callouts, SYSTEM.ECXMSG message structure in, 11-18 CLASSPATH, setting for tutorials, 5-3 custom XML document, 7-1 description, 5-3 EDI EDIFACT over Generic (VAN) transaction, 5-18, 6-2, 7-2 EDI X12 over Internet (AS2) transaction, 5-40 logging in before using, 5-3 RosettaNet over Internet transaction, 5-5 setting up for, 5-3 XSLTCallout callout, 11-20 U UCCnet importing document standards, 8-3, 17-8 supported in OracleAS Integration B2B, 3-7 supported under Custom Document option, 3-7 using as a custom document protocol, 8-19 ui.log file location of, A-3 troubleshooting errors, A-3 updateConfig command updating configuration changes, 18-12 use case groups deletes not allowed, 10-25 use cases description, 10-24 Index-18 groups, viewing, 10-25 privileges of a user role, 10-21 user errors See errors, troubleshooting user interface accessing, 2-1 administration, 17-1 administration tab overview, 2-19 Administrator role, 2-2, 10-21 agreements tab overview, 2-16 callouts tab overview, 2-17 creating incomplete information, 2-7 creating, adding, deleting, and removing data, 2-8 deployment tab overview, 2-18 design tab, 2-20 details pages, 2-5 exporting partner data to XML file, 2-9 flexibility of design, 2-7 list link, returning to, 2-8 list pages overview, 2-4 location of export button, 2-7 main page, 2-2 management tab overview, 2-21 page components, 2-3 partner data details pages with export button, 2-10 partners tab overview, 2-13 protocols tab overview, 2-16 reports tab overview, 2-18 searching for data, 2-8 user currently logged in, 2-5, 2-7 using browser back and forward buttons, 2-8 viewing partner data states on details page, 2-11 User Interface Log Level parameter defining logging level, A-3 user roles Administrator role, 10-21 removing from default admin user, 10-24 assigning to a host trading partner, 10-24 deletes not allowed, 10-25 description, 10-24 removing from a host trading partner, 10-24 Reports, 10-21 viewing for a host trading partner, 10-25 users accessing user interface tool, 2-1 admin user name, 2-1, 20-1 creating, 10-22 currently logged into user interface, 2-5, 2-7 deleting, 10-23 ias_admin user name, 20-1 managing, 10-20 updating name or description, 10-23 password, 10-22 viewing, 10-22 V validate button location, 2-7 separate from end-to-end validation when creating configuration, 2-12 validate partner data for individual correctness, 2-12 validation configuration state, 13-4 disabling if using globalization support with EDI documents, 8-11, 8-14, 8-23, 8-25 lifecycle state for creating partner data, 2-12 of configuration, 13-2 performance outside OracleAS Integration B2B, 8-9, 8-10, 8-23, 8-33 value-added network (VAN) EDI use of, 1-3 trading partners using ISA/GS identifier, C-1 VAN See value-added network (VAN), 1-3 W Wallet Location parameter defining wallet file location, 10-16, 20-6, 20-7, 20-8 for defining wallet file location, 20-5 wallet passwords configuration tasks, 20-5, 20-6, 20-7 creating, 10-15 description, 10-14 enabling Update button, 10-15 encrypted only for host trading partners, 20-8 host trading partner only, 10-14 impact of validated trading partner agreement when wallet password is created or updated, 10-14 managing, 10-14 not exported or imported, 17-6 Oracle Wallet automatically created during installation, 10-15 password matching Oracle Wallet password, 10-16 updates in Oracle Wallet Manager requirement, 10-16 Web browsers restrictions on back and forward buttons, 2-8 user interface, accessing, 2-1 wildcards using in search facility, 2-8 wire messages description, 19-4 status reports creating, 19-4 description, 2-19 workflow design-time, 1-4 exporting configuration, 13-10 partner data, 2-9 trading partner descriptor XML file, 15-1 XML Gateway, 1-2 message structure, 4-4 XML Gateway Inbound internal delivery channel apps.ECX_INBOUND internal endpoint, 10-30 description, 4-1, 10-30 See also delivery channels XML Gateway internal delivery channels, 4-4 XML Gateway Outbound internal delivery channel apps.ECX_OUTBOUND internal endpoint, 10-31 description, 4-1, 10-31 See also delivery channels XML trading partner and agreement descriptors, 15-1 .xsd files importing with Create Business Action wizard, 8-25 with Create Collaboration wizard, 8-33, 8-34 XSLTCallout callout predefined callout for XML-to-XML transformations, 11-4 tutorial for using, 11-20 XSLTCalloutImpl class file predefined class file for XML-to-XML transformations, 11-4 X XML file Index-19 Index-20 ">
/
Unduh
Hanya pengingat ramah. Anda dapat melihat dokumen di sini. Tetapi yang paling penting, AI kami telah membacanya. Ia dapat menjelaskan hal-hal kompleks dengan istilah sederhana, menjawab pertanyaan Anda dalam bahasa apa pun, dan membantu Anda menavigasi dengan cepat bahkan dokumen terpanjang atau paling rumit.
Tautan publik diperbarui
Tautan publik ke obrolan Anda telah diperbarui. You may view and manage your chat links after registration here.
Tautan publik dokumen
Iklan
