TIBCO BusinessConnect™ SOAP Protocol User's Guide

hungryhorsecabinΛογισμικό & κατασκευή λογ/κού

14 Δεκ 2013 (πριν από 3 χρόνια και 6 μήνες)

333 εμφανίσεις

TIBCO BusinessConnect™
SOAP Protocol
User’s Guide
Software Release 5.1.0
January 2008
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN TIBCO BUSINESSCONNECT
TM
SOAP PROTOCOL USER"S
GUIDE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE
OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF
SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and
treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO
Software Inc.
TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO BusinessConnect,
TIBCO Runtime Agent, TIBCO BusinessWorks, TIBCO Administrator, TIBCO Designer, TIBCO Rendezvous,
and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in
the United States and/or other countries.
EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun
Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A
SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE
INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE
IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN
THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 1999-2008 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
TIBCO BusinessConnect SOAP Protocol User’s Guide
Contents
|
iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Related Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
BusinessConnect SOAP Protocol Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Third Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
How to Contact TIBCO Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Chapter 1 Introduction to SOAP and BusinessConnect SOAP Protocol 1
SOAP Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
BusinessConnect SOAP Protocol Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
SOAP Message Security 1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
BusinessConnect SOAP Protocol Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
BusinessConnect SOAP Protocol Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Private Messages and Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Public Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Operation Types and Process Flows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Notify Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Synchronous Request-Response Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Scenario 1: Synchronous Request-Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Scenario 2: Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 2 Tutorial — Standalone Private Processes 11
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Trading Partners. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Initiator Machine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Responder Machine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
TIBCO BusinessConnect SOAP Protocol User’s Guide
iv
|
Contents
Configuring the Initiator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Importing Operations on the Initiator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Setting Up the Initiator as a Trading Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Setting Up Initiator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Setting Up the Responder as a Trading Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Configuring the Business Agreement Between the Initiator and Responder. . . . . . . . . . . . . . . . . . . . . . . . . 20
Configuring the Responder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Importing Operations on the Responder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Setting Up the Responder as a Trading Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Setting Up Responder Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Setting Up the Initiator as a Trading Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Configuring the Business Agreements Between the Initiator and Responder. . . . . . . . . . . . . . . . . . . . . . . . 24
Running the Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Viewing the Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 3 Tutorial — BusinessWorks Private Processes 35
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Setting Up the Tutorial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Configure the Machines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Configuring BusinessWorks Private Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Unzipping the Project Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Setting the Global Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Configuring Connections to BusinessConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Initiator Process Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Responder Process Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Running the Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Running the TIBCO BusinessWorks Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Viewing the Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Chapter 4 Preparing Information with Your Trading Partners 49
Reaching Agreement on Shared Business Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Exchanging URI Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Exchanging Identity Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Chapter 5 Managing SOAP Operations 53
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Creating a SOAP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Adding a Version to an Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Adding an Operation to a Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
TIBCO BusinessConnect SOAP Protocol User’s Guide
Contents
|
v
SOAP Operation Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Notify Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Synchronous Request-Response Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Importing SOAP Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Sample Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Exporting SOAP Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Modifying SOAP Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Modify the Notify Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Chapter 6 Setting Up Trading Hosts and Partners 73
Configuring the SOAP Protocol for a Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Duplicate Message Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Inbound Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Outbound Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Configuring the SOAP Protocol for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Setting General Properties for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Configuring Transports for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Chapter 7 Configuring Agreement Protocol Bindings 81
Configure SOAP Agreement Protocol Binding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Edit Protocol Binding Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Operation Bindings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Edit an Operation Binding for Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Edit an Operation Binding for Partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Document Security Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Transports Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Show Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Chapter 8 Viewing Logs 89
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Accessing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Configure an Audit Log for SOAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Audit Log Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Non-Repudiation Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Configure a Non-Repudiation Log for SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Resend Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Configure a Resend Log for SOAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
TIBCO BusinessConnect SOAP Protocol User’s Guide
vi
|
Contents
Chapter 9 Advanced Topics 105
Partyinfo Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Trading with a Third-Party SOAP Implementation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
SOAP Messages without TIBCO-Specific Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Sending SOAP Messages without TIBCO-Specific Headers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Receiving SOAP Messages without TIBCO-Specific Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Using the Passthrough Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
BusinessConnect SOAP Protocol Public Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
SOAP Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
SOAP Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
SOAP XML Message with a BusinessConnect-Specific Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
SOAP Envelope Attributes and Namespaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Envelope Attributes and Namespaces Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Chapter 10 Private Messages 119
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Initiator Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Initiator Outbound Request — Private Process to BusinessConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Initiator Inbound Response — BusinessConnect to Private Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Responder Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Responder Inbound Request — BusinessConnect to Private Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Responder Outbound Response — Private Process to BusinessConnect . . . . . . . . . . . . . . . . . . . . . . . . . 130
Responder Acknowledgement — BusinessConnect to Private Process. . . . . . . . . . . . . . . . . . . . . . . . . . . 132
General Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Advisory Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Attachment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Attachment Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
TradingPartner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
SOAPFault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Detail Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Appendix A Status Codes 145
statusCode and statusMsg Field Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Appendix B Schema Validation 153
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Schema Validation Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
TIBCO BusinessConnect SOAP Protocol User’s Guide
Contents
|
vii
Appendix C BusinessConnect SOAP Protocol WSDL Tool 157
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
WSDL Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
WSDL Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
TIBCO BusinessConnect SOAP Protocol User’s Guide
viii
|
Contents
TIBCO BusinessConnect SOAP Protocol User’s Guide
Figures
|
ix
Figures
Figure 1 Synchronous Request-Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 2 Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Figure 3 Request Response Operation POSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 4 Imported Operations PONotify and POSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Figure 5 Audit Logs Search on the Initiator Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Figure 6 Transaction Detail on the Initiator Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Figure 7 Audit Log Search on the Responder Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 8 Transaction Detail on the Responder Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 9 Notify Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Figure 10 Imported Operations for SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Figure 11 Verify Trading Partner’s Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Figure 12 Send Notify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Figure 13 Receive Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 14 Receive Request and Send Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Figure 15 Test Send Notify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Figure 16 Audit Logs Search on the Initiator Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 17 Transaction Detail on the Initiator Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 18 Audit Log Search on the Responder Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Figure 19 Transaction Detail on the Responder Side . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Figure 20 Create a SOAP Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Figure 21 New Interface POInterface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Figure 22 Add a Version to an Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Figure 23 New Interface Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Figure 24 Add an Operation to a Version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Figure 25 Import Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Figure 26 Export SOAP Interface, Version, or Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Figure 27 Edit Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Figure 28 Edit Notify Operation: Notify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
TIBCO BusinessConnect SOAP Protocol User’s Guide
x
|
Figures
Figure 29 Edit Synchronous Request-Response Operation: Sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Figure 30 Synchronous Request-Response Operation: Sync. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Figure 31 Operation Bindings Added for Host and Partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Figure 32 Initiator Outbound Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Figure 33 Initiator Inbound Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Figure 34 Responder Inbound Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Figure 35 Responder Outbound Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Figure 36 Responder Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
TIBCO BusinessConnect SOAP Protocol User’s Guide
Tables
|
xi
Tables
Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Table 1 Notify Operation Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 2 Notify Request Action Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 3 Synchronous Request-Response Operation Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 4 Request Action Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 5 Response Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 6 Configuring a Host: General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Table 7 Configuring a Partner: General Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Table 8 Operation Bindings Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 9 Override Outbound Settings: Operation Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Table 10 Override Outbound Settings: Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Table 11 Override Inbound Settings: Operation Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Table 12 Transports Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Table 13 Show Advanced: Host’s Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Table 14 Show Advanced: Partner’s Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Table 15 Audit Log: Search Transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Table 16 Audit Log: Advanced Search Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Table 17 Audit Log Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Table 18 Transaction Detail Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Table 19 State Field Values for Initiator Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Table 20 State Field Values for Responder Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Table 21 Non-Repudiation Log: Search Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Table 22 Non-Repudiation Log: Advanced Search Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Table 23 Resend Log: Resendable Transactions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Table 24 State Values for Resend Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Table 25 Resend Log: Advanced Search Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Table 26 Resend Log: Resend History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Table 27 Resend Log: Advanced Search Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
TIBCO BusinessConnect SOAP Protocol User’s Guide
xii
|
Tables
Table 28 Initiator Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Table 29 Initiator Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Table 30 Responder Inbound Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Table 31 Responder Outbound Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Table 32 ResponderAck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Table 33 Advisory Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Table 34 Attachment Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Table 35 Trading Partner Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Table 36 Attribute Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Table 37 SOAP Fault Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Table 38 Detail Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Table 39 statusCode and statusMsg Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Table 40 BusinessConnect Database Configuration Properties for WSDL Import. . . . . . . . . . . . . . . . . . . . 159
Table 41 WSDL File, Trading Partner, and Local Host Name Properties for WSDL Import. . . . . . . . . . . . . 160
Table 42 BusinessConnect Database Configuration Properties for WSDL Export . . . . . . . . . . . . . . . . . . . 161
Table 43 WSDL File, Trading Partner, and Local Host Name Properties for WSDL Export . . . . . . . . . . . . 162
TIBCO BusinessConnect SOAP Protocol User’s Guide
|
xiii
Preface
This manual describes how to use TIBCO BusinessConnect
TM
SOAP Protocol.
Topics
• Related Documentation, page xiv
• Typographical Conventions, page xvi
• How to Contact TIBCO Support, page xvii
TIBCO BusinessConnect SOAP Protocol User’s Guide
xiv
|
Preface
Related Documentation
This section lists documentation resources that you may find useful.
BusinessConnect SOAP Protocol Documentation
The following documents form the BusinessConnect SOAP Protocol
documentation set:
• BusinessConnect SOAP Protocol User’s Guide: Read this guide to learn about
preparing information for use with trading partners, managing SOAP
interfaces, setting up trading hosts and partners, configuring agreement
protocol bindings, and so on. This guide also includes two tutorials:
Standalone Private Processes, and TIBCO BusinessWorks Private Processes.
• BusinessConnect SOAP Protocol Installation Guide: Read this guide in order to
properly install and configure the SOAP protocol.
• BusinessConnect SOAP Protocol Release Notes: Read this document to learn
about new features, changes in functionality, deprecated features, known
issues, and closed issues for each release. This document is supplied for each
release and is available only in PDF format.
Other TIBCO Product Documentation
You may also find useful to read the documentation for the following TIBCO
products, which may be used or integrated with BusinessConnect SOAP Protocol:
• TIBCO BusinessConnect™ software: This software allows you to configure
and manage trading partners to perform secure transmission of documents
and messages.
• TIBCO Administrator

software: This software allows you to manage users,
machines and applications defined in a TIBCO Administration Domain. The
TIBCO Administrator graphical user interface enables users to deploy,
monitor, and start and stop TIBCO applications.
• TIBCO BusinessWorks

software: This software is a scalable, extensible, and
easy to use integration platform that allows you to develop integration
projects. TIBCO BusinessWorks includes a graphical user interface (GUI) for
defining business processes and an engine that executes the process.
• TIBCO Designer

software: This graphical user interface is used for
designing and creating integration project configurations and building an
Enterprise Archive (EAR) for the project. The EAR can then be used by TIBCO
Administrator for deploying and running the application.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Related Documentation
|
xv
• TIBCO Runtime Agent

software: This software suite is a prerequisite for
other TIBCO software products. In addition to TIBCO Runtime Agent
components, the software suite includes the third-party libraries used by
other TIBCO products such as TIBCO Designer, Java Runtime Environment
(JRE), TIBCO Hawk
®
, and TIBCO Rendezvous
®
.
• TIBCO Rendezvous: This software enables programs running on many
different kinds of computers on a network to communicate seamlessly. It
includes two main components: the Rendezvous programming language
interface (API) in several languages, and the Rendezvous daemon.
• TIBCO Enterprise Message Service

software: This software provides a
message service that enables integration of applications within an enterprise
based on the Java Message Service (JMS) specifications.
Third Party Documentation
The specification for the SOAP protocol can be found at
http://www.w3.org/TR/SOAP/.
TIBCO BusinessConnect SOAP Protocol User’s Guide
xvi
|
Preface
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention
Use
code font
Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example: Use
MyCommand
to start
the
foo
process.
bold code
font

Bold code font is used in the following ways:
• In procedures, to indicate what a user types. For example: Type
admin
.
• In large code samples, to indicate the parts of the sample that are of
particular interest.
• In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified,
MyCommand
is enabled:
MyCommand
[
enable
|
disable
]
italic font
Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO BusinessWorks Concepts.
• To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace.
For example:
MyCommand

pathname
Key
combinations
Key name separated by a plus sign indicate keys pressed simultaneously. For
example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.
TIBCO BusinessConnect SOAP Protocol User’s Guide
How to Contact TIBCO Support
|
xvii
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, please
contact TIBCO Support as follows.
• For an overview of TIBCO Support, and information about getting started
with TIBCO Support, visit this site:
https://www.tibco.com/services/support
• If you already have a valid maintenance or support contract, visit this site:
http://support.tibco.com
Entry to this site requires a username and password. If you do not have a
username, you can request one.
TIBCO BusinessConnect SOAP Protocol User’s Guide
xviii
|
Preface
TIBCO BusinessConnect SOAP Protocol User’s Guide
|
1
Chapter 1
Introduction to SOAP and
BusinessConnect SOAP Protocol
This chapter describes SOAP and BusinessConnect SOAP Protocol.
Topics
• SOAP Overview, page 2
• BusinessConnect SOAP Protocol Overview, page 3
• BusinessConnect SOAP Protocol Features, page 4
• BusinessConnect SOAP Protocol Messages, page 5
• Operation Types and Process Flows, page 6
TIBCO BusinessConnect SOAP Protocol User’s Guide
2
|
Chapter 1 Introduction to SOAP and BusinessConnect SOAP Protocol
SOAP Overview
SOAP 1.1 (Simple Object Access Protocol) is a lightweight XML-based messaging
protocol for exchanging structured data in a decentralized, distributed
environment. SOAP allows buyers, sellers, and intermediaries to share business
documents and messages over the Internet. SOAP can also be used for other types
of supply chain integration transactions, such as collaborative forecasting,
inventory management, and design collaboration.
SOAP transactions involve the exchange of documents, most of which are
analogous to hardcopy documents traditionally used in business. These
documents are simple text files, but they have well-defined structure and
contents.
SOAP has the following parts:
• An envelope that defines a framework for describing what is in a message and
how to process the message. This defines the message package. The SOAP
envelope consists of an optional header and a mandatory body. The envelope
is the first element in the document and identifies it as a SOAP message. The
header allows the sender to add management or control information that can
be used for routing, security, or proper handling by the recipient. The body
contains the information sent to the receiver.
• A standard for representing request and response.
TIBCO BusinessConnect SOAP Protocol User’s Guide
BusinessConnect SOAP Protocol Overview
|
3
BusinessConnect SOAP Protocol Overview
BusinessConnect SOAP Protocol is the TIBCO implementation of the SOAP 1.1
specification. The protocol is developed by TIBCO for exchanging XML
documents used in e-commerce. Based upon an agreed-upon process flow and
common document format, you and your trading partner can conduct secure and
verifiable business transactions online using BusinessConnect SOAP Protocol.
For an overview of what a business protocol means, see TIBCO BusinessConnect
Concepts, Chapter 2 BusinessConnect Architecture, section Business Protocols.
SOAP Message Security 1.1
In TIBCO BusinessConnect SOAP Protocol 5.1.0, Web Services Security
(WS-Security 2004) is used to sign or to encrypt the SOAP body as a whole.
Individual elements of the body or any other parts, such as header elements or
attachments, can not be signed or encrypted.
For more details on enabling signing and encryption, see the Require Digital
Signature and Require Content Encryption fields for the following operations:
• Notify Request Action Tab on page 60
• Request Action Tab on page 62
• Response Action Tab on page 64
TIBCO BusinessConnect SOAP Protocol User’s Guide
4
|
Chapter 1 Introduction to SOAP and BusinessConnect SOAP Protocol
BusinessConnect SOAP Protocol Features
The following are some significant features of the BusinessConnect SOAP
Protocol:
• Support for the synchronous Request-Response and Notify operation types
See Notify Operations on page 6 and Synchronous Request-Response
Operations on page 7 for more details.
• Support for HTTP, HTTPS, and HTTPSCA transport protocols
• Multiple server certificate support for HTTPS
• Access control through trading partner identification and permissions
• Validation of XML documents with XSDs
• Signing or encryption of the SOAP body as a whole using Web Services
Security (WS-Security 2004).
See SOAP Message Security 1.1 on page 3 for more details.
• Ability to specify certain timing constraints
• Ability to generate audit records
See Audit Logs on page 91 for more details.
• Enabled non-repudiation logging in business agreements for all operations.
See Non-Repudiation Logs on page 98 for more details.
• Ability to send attachments
See Attachment on page 135 for more details.
• Ability to use the WSDL Tool to export and import WSDL files
See Appendix C, BusinessConnect SOAP Protocol WSDL Tool, on page 157
for more details.
BusinessConnect SOAP Protocol Compatibility
For information on the platforms with which BusinessConnect SOAP Protocol is
compatible, see the
readme.txt
file for each release.
TIBCO BusinessConnect SOAP Protocol User’s Guide
BusinessConnect SOAP Protocol Messages
|
5
BusinessConnect SOAP Protocol Messages
In a SOAP transaction, two partners exchange business documents over the
Internet based on a pre-defined business agreement. The business agreement
describes what message formats and transport protocols the partners have agreed
to use, among other options. The exchange of business documents is known as the
process flow. See Operation Types and Process Flows on page 6.
In a BusinessConnect process flow, two types of messages are exchanged: private
messages and public messages.
Private Messages and Processes
Private messages are exchanged between a private process and BusinessConnect.
For a detailed description of BusinessConnect SOAP Protocol private messages,
see Chapter 10, Private Messages, page 119. Private messages can contain a
request, a response, or a notification document.
Private processes handle conversion from internal to public data and back.
• On the Initiator side, the private process converts internal data to a SOAP
request, an acceptance, or a notification document.
• On the Responder side, the private process receives a SOAP request, converts
it to internal company format, receives back a response from inside the
company, and converts it to SOAP format.
The following private processes are available with BusinessConnect SOAP
Protocol:

Standalone
Standalone private processes use TIBCO Rendezvous Certified
Messaging to communicate with BusinessConnect SOAP Protocol. For an
example, see Chapter 2, Tutorial — Standalone Private Processes, on page 11.

BusinessWorks
The BusinessWorks

processes can send requests to
BusinessConnect SOAP Protocol, or receive replies from BusinessConnect
SOAP Protocol. For an example, see Chapter 3, Tutorial — BusinessWorks
Private Processes, on page 35.
Public Messages
Public messages are exchanged over the Internet between two BusinessConnect
installations. These can use the HTTPS or HTTP transport protocols. Synchronous
request-response and notify transaction types are supported.
TIBCO BusinessConnect SOAP Protocol User’s Guide
6
|
Chapter 1 Introduction to SOAP and BusinessConnect SOAP Protocol
Operation Types and Process Flows
When you use BusinessConnect to send a SOAP document to a partner, you use
different operation types for different kinds of transactions. There are two
operation types in SOAP:

Notify
Use this operation when the Initiator just wants an acknowledgment
from the Responder to verify business document receipt.

Synchronous request-response
Use this operation when the Initiator and the
Responder need to do a more complex business exchange of business
documents.
Notify Operations
The following process flow occurs in a notify operation:
1.A private process inside the initiating company sends a message to the local
BusinessConnect. See Initiator Outbound Request — Private Process to
BusinessConnect on page 121 for details.
2.The Initiator BusinessConnect retrieves relevant information and sends the
message to the Responder BusinessConnect.
3.The Responder BusinessConnect then forwards the message to the local
private process. See Responder Inbound Request — BusinessConnect to
Private Process on page 127. The Responder BusinessConnect considers the
operation complete.
4.The Responder BusinessConnect immediately sends a transport response
(acknowledgment) to the Initiator on the same channel as the Initiator business
request.
5.Alternatively, if the Responder BusinessConnect could not process the notify
operation, BusinessConnect SOAP Protocol sends a SOAP Fault to the
Initiator.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Operation Types and Process Flows
|
7
Synchronous Request-Response Operations
The following process flow occurs in a synchronous request-response operation.
1.A private process inside the initiating company sends a request to the local
BusinessConnect.
See Initiator Outbound Request — Private Process to BusinessConnect on
page 121.
2.The Initiator BusinessConnect retrieves relevant information and sends the
business request to the Responder BusinessConnect.
3.The Responder BusinessConnect validates and forwards the business request
to the local private process and waits for the local private process to respond.
See Responder Inbound Request — BusinessConnect to Private Process on
page 127.
If the validation of the inbound SOAP message fails, then the Responder
BusinessConnect SOAP Protocol sends a SOAP Fault on the same channel to
the Initiator BusinessConnect, which then forwards the fault content to the
private process.
4.The Responder private process can send an error to BusinessConnect if it
cannot process the request. The Responder BusinessConnect sends a SOAP
Fault message to the Initiator BusinessConnect, which then forwards the fault
message to the Initiator private process.
5.The Responder private process responds to the local BusinessConnect.
See Responder Outbound Response — Private Process to BusinessConnect on
page 130.
The Responder private process can also return an error message to
BusinessConnect, which sends a SOAPFault message to the trading partner.
To send the SOAPFault as the response, the Responder private process should
set the
statusCode
field of the
ae/SOAP/ResponderResponse
AE message to
values outside the range of 200-299.
The
ae/SOAP/ResponderResponse
AE message class includes a field called
soapFault
. BusinessConnect SOAP Protocol uses the values in the
soapFault

field to generate the public
SOAPFault
response message.
6.The Responder BusinessConnect forwards the business response from the
local private process on the same channel to the Initiator’s waiting
BusinessConnect.
7.The Responder BusinessConnect sends an acknowledgment to the local
private process if it receives no error message from the Initiator
BusinessConnect.
TIBCO BusinessConnect SOAP Protocol User’s Guide
8
|
Chapter 1 Introduction to SOAP and BusinessConnect SOAP Protocol
See Responder Acknowledgement — BusinessConnect to Private Process on
page 132.
8.The Initiator BusinessConnect forwards the response to the local private
process.
See Initiator Inbound Response — BusinessConnect to Private Process on
page 124.
Scenario 1: Synchronous Request-Response
For asynchronous request-response operation, you can specify the following:
• For the Initiator:
— Response Wait
— Time to Wait between Retransmits
— Number of Retries
• For the Responder:
— Private Process Wait
Figure 1 Synchronous Request-Response
From Initiator
From the Initiator, an operation is processed with the following timing
restrictions:
1.The Initiator sends out a request to the Responder.
2.If communication cannot be established, a specified number of retries occurs.
Request
# of retires
Initiator
Responder
Response
Response wait
Time to wait
between
retransmits
Private Process
wait
TIBCO BusinessConnect SOAP Protocol User’s Guide
Operation Types and Process Flows
|
9
From Responder
From the Responder, an operation is processed with the following timing
restrictions:
1.The Initiator sends out a request to the Responder.
2.The Responder BusinessConnect server hands off the document to the
Responder private process.
3.The Responder private process returns the response to the Initiator
BusinessConnect server. The time between the request sent to the private
process and the response from by the private process can be specified as the
Private Process Wait.
4.Unless a transport-level error is returned, the Responder sends an
acknowledgment to the local private process.
Scenario 2: Notification
When you are defining a notify operation, you cannot configure the timing
restrictions. The flow of information and the associated predefined timing
restrictions are as shown in Figure 2.
Figure 2 Notification
1.The initiating trading partner sends a notification to its partner.
2.The receiving partner sends back an acknowledgment and hands off the
notification to the private process.
3.If communication cannot be established, a specified number of retries occurs.
Notification
# of retires
Initiator
Responder
Acknowledgement
Acknowledgement
wait
TIBCO BusinessConnect SOAP Protocol User’s Guide
10
|
Chapter 1 Introduction to SOAP and BusinessConnect SOAP Protocol
TIBCO BusinessConnect SOAP Protocol User’s Guide
|
11
Chapter 2
Tutorial

Standalone Private Processes
This tutorial guides you through the steps necessary for running a
BusinessConnect SOAP Protocol B2B transaction.
The example in this chapter uses standalone private processes.
Topics
• Overview, page 12
• Prerequisites, page 15
• Configuring the Initiator, page 16
• Configuring the Responder, page 21
• Running the Tutorial, page 26
TIBCO BusinessConnect SOAP Protocol User’s Guide
12
|
Chapter 2 Tutorial — Standalone Private Processes
Overview
This chapter provides a short tutorial that demonstrates how to use an operation
to send a sample document from a trading host to a trading partner.
Operations
Two operations are defined in the sample interface file:

PONotify
This operation is used when the Initiator just wants an
acknowledgment from the Responder to verify business document receipt.

POSync
This is a synchronous request-response operation that is used when
the Initiator and the Responder need to do a more complex business exchange
of business documents.
Only the
POSync
operation is used in this tutorial.
Trading Partners
The trading host is known as the Initiator. The trading partner is known as the
Responder.
Using the notify operation, the Initiator sends a document to the Responder,
which then provides the Initiator with an acknowledgment that the business
document has been received.
This tutorial includes the sample Initiator, Responder and operation configuration
files along with the standalone Initiator and Responder private processes.
Two machines are used in the tutorial: an Initiator machine and a Responder
machine. Each machine hosts a private process and BusinessConnect.
Transactions
The
POSync
operation consists of the following transactions:
1.The Initiator private process sends a message to BusinessConnect.
2.The Initiator BusinessConnect sends the message to the Responder
BusinessConnect.
3.The Responder BusinessConnect then sends the message to the Responder
private process.
4.The Responder private process sends a response to the Responder
BusinessConnect.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Overview
|
13
5.The Responder BusinessConnect sends a response to the Initiator
BusinessConnect.
6.The Responder BusinessConnect sends an acknowledgement (ack) to the
Responder private process.
7.The Initiator BusinessConnect sends a response to the Initiator private
process.
A detailed diagram of the POSync operation is displayed in Figure 3.
Figure 3 Request Response Operation POSync
Legend
Request
Response
BusinessConnect
SOAP Protocol
TIBCO BusinessWorks
Send Request-
Response
Company A
BusinessWorks
Receive Request
Send Response
Company B
Private Process Outbound Request
Private Process Inbound Request
1
2
3
4
Internet
ACK
5
6
BusinessConnect
SOAP Protocol
7
TIBCO BusinessConnect SOAP Protocol User’s Guide
14
|
Chapter 2 Tutorial — Standalone Private Processes
Initiator Machine
The following sample files for the Initiator machine are used in the tutorial and
available in
BC_install_dir
\protocols\soap\samples\client
:

SOAPClient.properties
Contains information on the operation ID, trading
partner, and attachments.

runSOAPClient.bat
or
runSOAPClient
Executes the Initiator.

operations.csx
Contains sample SOAP operations to be imported by the
Initiator.
Responder Machine
The following sample files for the Responder machine are used in the tutorial and
available in
BC_install_dir
\protocols\soap\samples\server
:

SOAPServer.properties
Contains information on attachments.

runSOAPServer.bat
or
runSOAPServer
Executes the Responder.

operations.csx
Contains sample SOAP operations to be imported by the
Responder.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Prerequisites
|
15
Prerequisites
Before starting this tutorial, provide the following prerequisites:
1.Install the following software packages:
a.BusinessConnect Server
b.BusinessConnect SOAP Protocol
2.If you are unfamiliar with the SOAP standard, read Chapter 1, Introduction to
SOAP and BusinessConnect SOAP Protocol, page 1.
3.See TIBCO BusinessConnect Server Administration Guide and TIBCO
BusinessConnect Trading Partner Administration Guide for complete information
on setting up and running BusinessConnect.
TIBCO BusinessConnect SOAP Protocol User’s Guide
16
|
Chapter 2 Tutorial — Standalone Private Processes
Configuring the Initiator
This section steps you through the activities you need to perform to configure the
Responder trading partner:
1.Importing Operations on the Initiator on page 16
2.Setting Up the Initiator as a Trading Host, page 17
3.Setting Up Initiator Server, page 18
4.Setting Up the Responder as a Trading Partner, page 19
5.Configuring the Business Agreement Between the Initiator and Responder,
page 20.
Importing Operations on the Initiator
Two operations are defined in the sample interface file:

PONotify
This operation is used when the Initiator just wants an
acknowledgment from the Responder to verify business document receipt.

POSync
This is a synchronous request-response operation that is used when
the Initiator and the Responder need to do a more complex business exchange
of business documents.
Only the
POSync
operation is covered in this tutorial.
Import the Initiator Operation Interfaces
Start TIBCO Administrator and do the following:
1.Click the BusinessConnect > Operations Editor link in the left panel.
2.In the Operations Editor dialog, select SOAP from the dropdown list and click
Edit.
3.Click Import.
4.Click change....
5.Browse to the location and select
BC_install_dir
\protocols\soap\samples\client\operations.csx
6.Click Open.
7.Click OK.
8.Enter a password (not required).
TIBCO BusinessConnect SOAP Protocol User’s Guide
Configuring the Initiator
|
17
9.Click Import.
The Edit Operations dialog appears with imported operations.
Figure 4 Imported Operations PONotify and POSync
10.Click Done.
Setting Up the Initiator as a Trading Host
On the Initiator machine, you will set up the Initiator as a trading host.
Setting up the Responder as the Initiator’s trading partner is discussed in Setting
Up the Responder as a Trading Partner on page 19.
The trading host setup for the Initiator consists of these steps:
• Set Up Initiator Host, page 17
• Set Up the SOAP Protocol for the Initiator Host, page 18
Set Up Initiator Host
The trading host is typically defined when setting up BusinessConnect.
• If the host is set, go to Set Up the SOAP Protocol for the Initiator Host on
page 18.
• If the host is not set, complete the following steps.
1.Click the BusinessConnect > Participants link in the left panel.
2.Click the New button.
3.Type
SOAPClient
in the Participant Name field.
4.Select Host in the Participant Type dropdown list.
5.Click OK.
TIBCO BusinessConnect SOAP Protocol User’s Guide
18
|
Chapter 2 Tutorial — Standalone Private Processes
6.In the New Host Participant dialog with the participant name
SOAPClient
,
select the Active checkbox.
7.Click Save.
8.Click the BusinessConnect > System Settings link in the left panel.
9.Click the General Settings link in the right panel.
10.Confirm that SOAPClient is selected in the Default Host dropdown list.
11.Click Save.
Set Up the SOAP Protocol for the Initiator Host
1.Click the BusinessConnect > Participants link in the left panel.
2.Click the SOAPClient link in the right panel.
3.Click the Protocols tab.
4.Verify that SOAP is listed in the Protocol Name list.
If SOAP does not appear in the list of protocols:
a.Click Enable.
b.Select the SOAP checkbox.
c.Click Save.
Setting Up Initiator Server
The Initiator server must be set up to communicate with its trading partners. To
do so, follow these steps:
• Create the deployment configuration.
See TIBCO BusinessConnect Server Administration Guide for information on
deployment configurations.
• Set Up the Initiator Server Transport.
Set Up the Initiator Server Transport
To set up the server transport, follow these steps:
1.Click the Application Management > BusinessConnect > Configuration link
in the left panel.
2.Click the BusinessConnect link in the Configuration Builder panel.
3.On the Public Process Configuration tab, click the HTTP link.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Configuring the Initiator
|
19
4.Verify that the Enable HTTP Transport checkbox is selected.
5.Keep the default port of 6700.
6.Click Save twice.
7.Click Deploy.
8.Verify that the Start Successfully Deployed Services checkbox is selected.
9.Click OK.
This will deploy BusinessConnect and start the server.
Setting Up the Responder as a Trading Partner
The Responder trading partner setup consists of these steps:
• Set Up the Responder Partner
• Set Up the SOAP Protocol for the Responder Partner
Set Up the Responder Partner
1.Click the BusinessConnect > Participants link in the left panel.
2.Click the New button.
3.Type
SOAPServer
in the Participant Name field.
4.Select Partner in the Participant Type dropdown list.
5.Click OK.
6.In the New Partner Participant dialog with SOAPServer in the Participant
Name filed, select the Active checkbox.
Set Up the SOAP Protocol for the Responder Partner
1.In the New Partner Participant dialog with SOAPServer in the Participant
Name filed, click the Protocols tab.
2.Verify that SOAP is listed in the Protocol Name list.
If SOAP does not appear in the list of protocols:
a.Click Enable.
b.Select the SOAP checkbox.
c.Click OK.
3.Click the SOAP link.
TIBCO BusinessConnect SOAP Protocol User’s Guide
20
|
Chapter 2 Tutorial — Standalone Private Processes
4.Click the Transports tab.
5.Click the Add button.
6.In the New Transport dialog, type
HTTP
in the Transport Name field.
7.Select HTTP from the Transport Type dropdown list.
8.Click OK.
9.In the NewHTTP Transport dialog, type the following in the URL field:
hostname:port
/SOAP
where
hostname
is the name of the Responder host and
port
is the HTTP port set
in the Responder’s deployment configuration and is set to 6700 by default.
Example:
http://www.widgets.com:6700/SOAP
10.Click Save twice.
Configuring the Business Agreement Between the Initiator and Responder
1.Click the BusinessConnect > Business Agreements link in the left panel.
2.Click the New button in the right panel.
3.Select the SOAPClient radio button in the Host Party area and the
SOAPServer radio button in the Partner Party area.
4.Click OK.
5.In the New Agreement dialog, click the Add Protocol Binding button.
6.In the Select Protocol dialog, select the SOAP checkbox.
7.Click OK.
8.Click the SOAP link that appears in the Agreement Protocol Binding list.
9.In the Operation Binding tab, verify that the Allow All Operations checkbox is
selected. This allows the host and trading partner to initiate all enabled
operations.
10.Select the Transports tab.
11.In the Outbound Transports for Host 'SOAPClient' area, select HTTP from the
Primary Transport dropdown list.
12.In the Allowed Inbound Transports for Partner 'SOAPServer' area, ensure that
the HTTP checkbox is selected.
13.Click Save twice.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Configuring the Responder
|
21
Configuring the Responder
This section steps you through the activities you need to perform to configure the
Responder trading partner:
1.Importing Operations on the Responder on page 21
2.Setting Up the Responder as a Trading Host, page 21
3.Setting Up Responder Server, page 23
4.Setting Up the Initiator as a Trading Partner, page 23
5.Configuring the Business Agreements Between the Initiator and Responder,
page 24.
Importing Operations on the Responder
To set up the Responder on the Responder machine, import the Responder
operation interfaces as follows:
1.Click the BusinessConnect > Operations Editor link in the left panel.
2.Select SOAP from the Protocol dropdown list in the right panel.
3.Click Edit.
4.Click Import.
5.Click Change....
6.Browse to the location and select
BC_install_dir
\protocols\soap\samples\server\operations.csx
7.Click Open.
8.Click OK.
9.Enter a password (not required).
10.Click Import.
11.Click Done.
Setting Up the Responder as a Trading Host
On the Responder machine, you set up the Responder as a trading host. Setting
up the Initiator as the Responder’s trading partner is discussed Setting Up the
Initiator as a Trading Partner on page 23.
TIBCO BusinessConnect SOAP Protocol User’s Guide
22
|
Chapter 2 Tutorial — Standalone Private Processes
The trading host setup for the Responder consists of these steps:
• Set Up the Responder Host
• Set Up the SOAP Protocol for the Responder Host
Set Up the Responder Host
The trading host name property is typically defined when setting up
BusinessConnect.
If the property is set, go to Set Up the SOAP Protocol for the Responder Host on
page 22.
If the property is not set, complete the following steps:
1.Click the BusinessConnect > Participants link in the left panel.
2.Click the New button.
3.Type
SOAPServer
in the Participant Name field.
4.Select Host in the Participant Type dropdown list.
5.Click OK.
6.In the New Participant dialog with the participant name SOAPServer, select
the Active checkbox.
7.Click Save.
8.Click the BusinessConnect > System Settings link in the left panel.
9.Click the General Settings link in the right panel.
10.Confirm that SOAPServer is selected in the Default Host dropdown list.
11.Click Save.
Set Up the SOAP Protocol for the Responder Host
1.Click the BusinessConnect > Participants link in the left panel.
2.Click the SOAPServer

link in the right panel.
3.Click the Protocols tab.
4.Verify that SOAP is listed in the Protocol Name list.
If SOAP does not appear in the list of protocols:
a.Click Enable.
b.Select the SOAP checkbox.
c.Click Save.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Configuring the Responder
|
23
Setting Up Responder Server
The Responder server must be set up to communicate with its trading partners.
To do so, follow these steps:
• Create the deployment configuration. See TIBCO BusinessConnect Server
Administration Guide for information on deployment configurations.
• Set Up the Responder Server Transport
Set Up the Responder Server Transport
To set up the server transport, follow these steps:
1.Click the Application Management > BusinessConnect > Configuration link
in the left panel.
2.Click the BusinessConnect link in the right panel.
3.On the Public Process Configuration tab, click the HTTP link.
4.Select Enable HTTP Transport.
5.Keep the default port of 6700.
6.Click Save twice.
7.Click Deploy.
8.Notice that the Start Successfully Deployed Services checkbox is checked.
9.Click OK.
This will deploy BusinessConnect and start the server.
Setting Up the Initiator as a Trading Partner
This section discusses the Initiator trading partner setup, which consists of these
steps:
• Setting Up the Initiator Partner
• Setting Up the SOAP Protocol for the Initiator Partner
Setting Up the Initiator Partner
1.Click the BusinessConnect > Participants link in the left panel.
2.Click the New button.
3.Type
SOAPClient
in the Participant Name field.
4.Select Partner in the Participant Type dropdown list.
TIBCO BusinessConnect SOAP Protocol User’s Guide
24
|
Chapter 2 Tutorial — Standalone Private Processes
5.Click OK.
6.In the New Participant dialog with SOAPClient in the Participant Name field,
select the Active checkbox.
Setting Up the SOAP Protocol for the Initiator Partner
1.In the New Participant dialog with SOAPClient in the Participant Name field,
click the Protocols tab.
2.Verify that SOAP is listed in the Protocol Name list.
If SOAP does not appear in the list of protocols:
a.Click Enable.
b.Select the SOAP checkbox.
c.Click OK.
3.Click the SOAP link.
4.Click the Transports tab.
5.Click the Add button.
6.In the New Transport dialog, type
HTTP
in the Transport Name field.
7.Select HTTP from the Transport Type dropdown list.
8.Click OK.
9.In the NewHTTP Transport dialog, type the following in the URL field:
hostname:port/SOAP
where
hostname
is the name of the Initiator host and
port
is the HTTP port set in
the Initiator’s deployment configuration and is set to 6700 by default.
Example:
http://www.acme.com:6700/SOAP
10.Click Save twice.
Configuring the Business Agreements Between the Initiator and Responder
1.Click the BusinessConnect > Business Agreements link in the left panel.
2.Click the New button.
3.Select the SOAPServer radio button in the Host Party area and the
SOAPClient radio button in the Partner Party area.
4.Click OK.
5.In the New Agreement dialog, click the Add Protocol Binding button.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Configuring the Responder
|
25
6.In the Select Protocol dialog, select the SOAP checkbox.
7.Click OK.
8.Click the SOAP link that appears in the Agreement Protocol Binding list.
9.In the Operation Binding tab, verify that the Allow All Operations checkbox is
selected. This allows the host and trading partner to initiate all enabled
operations.
10.Select the Transports tab.
11.In the Outbound Transports for Host 'SOAPServer' area, select HTTP from the
Primary Transport dropdown list.
12.In the Allowed Inbound Transports for Partner 'SOAPClient' area, ensure that
the HTTP checkbox is selected.
13.Click Save twice.
TIBCO BusinessConnect SOAP Protocol User’s Guide
26
|
Chapter 2 Tutorial — Standalone Private Processes
Running the Tutorial
To run the tutorial example, follow these steps:
1.Start the Initiator and Responder runtime servers with TIBCO Administrator.
2.Open the file BC_install_dir/protocols/soap/samples/server/
runsoapserver.bat (or /runsoapserver) on the Responder machine with a text
editor and make the following change:
— In the line
SET BC_INSTANCE=%%BC_INSTANCE%%
replace
%%BC_INSTANCE%
with the name of your installation, such as
BC-Responder
.
— In the line
SET JDK_DIR = %%JDK_DIR%%
replace
%%JDK_DIR%%
with JAVA_directory, such as
C:\tibco\jre\1.5.0
— In the line
SET RV_DIR=%%RV_DIR%%
replace the value
%%RV_DIR%%
with the RV library location, such as
C:\tibco\TIBRV.
A sample edited file runsoapserver.bat looks such as follows:
@ECHO OFF

SET BC_INSTANCE=BC-Responder
SET JDK_DIR=C:\tibco\jre\1.5.0
SET RV_DIR=C:\tibco\TIBRV
SET CLASSPATH=.;%RV_DIR%\lib\tibrvj.jar;%CLASSPATH%
%JDK_DIR%\bin\java SOAPServer SOAPServer.properties %BC_INSTANCE%
body.xml header.xml
3.Using the command line interface, start the Responder private process on the
Responder machine by executing the following command:
on Windows:
BC_install_dir
\protocols\soap\samples\server\
runsoapserver.bat
on UNIX:
BC_install_dir
\protocols\soap\samples\server\
runsoapserver
The screen output provided in this tutorial is from a Windows machine.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Running the Tutorial
|
27
Example: runsoapserver
C:\tibco\bc\5.1\protocols\soap\samples\server>runsoapserver.bat

**** SOAP Server Private Process *****
listening on: AX.BC.BC-Responder.SOAP.RESPONDER.REQUEST
4.Open the file
BC_install_dir/
protocols/soap/samples/client/runSOAPClient.bat
(or
/runsoapclient
on UNIX) on the Initiator machine with a text editor and
make the following change:
— In the line
SET BC_INSTANCE=%%BC_INSTANCE%%
replace
%%BC_INSTANCE%
with the name of your installation, such as
BC-Initiator
.
— In the line
SET JDK_DIR = %%JDK_DIR%%
replace
%%JDK_DIR%%
with JAVA_directory, such as
C:\tibco\jre\1.5.0.
— In the line
SET RV_DIR=%%RV_DIR%%
replace the value
%%RV_DIR%%
with the RV library location, such as
C:\tibco\TIBRV
.
A sample edited file
runSOAPClient.bat
looks such as follows:
@ECHO OFF

SET BC_INSTANCE=BC-Initiator
SET JDK_DIR=C:\tibco\jre\1.5.0
SET RV_DIR=C:\tibco\TIBRV

TITLE SOAP Client private process

SET CLASSPATH=.;%RV_DIR%\lib\tibrvlib.jar;%CLASSPATH%
%JDK_DIR%\bin\java SOAPClient SOAPClient.properties %BC_INSTANCE%
body.xml header.xml
5.On the Initiator machine, start the Initiator private process by executing the
following command:
on Windows:
BC_install_dir\
protocols\soap\samples\client\
runSOAPClient.bat
on UNIX:
TIBCO BusinessConnect SOAP Protocol User’s Guide
28
|
Chapter 2 Tutorial — Standalone Private Processes
BC_install_dir
\protocols\soap\samples\client\
runsoapclient
In this example, the following will be processed:
— The operation POSync containing a purchase order for five copies of a
word processing application is sent from the Initiator to the Responder
— The Responder confirms the receipt of that order
— The Responder sends an invoice to the Initiator
The following text will be displayed:
Example: runSOAPClient
t
**** SOAPClient Private Process *****
listening on: AX.BC.BC-Initiator.SOAP.INITIATOR.RESPONSE
Hit [Enter] to send request:
Sending request...
publishing on subject: AX.BC.BC-Initiator.SOAP.INITIATOR.REQUEST
Sending request:
Trading partner: SOAPServer
Operation ID: POInterface/1.0/POSync
Header: <ep:endpoints xmlns:ep="http://user.org/header" >
<ep:to>
<ep:address>
<name>Book Orders</name>
<street>1st Street</street>
<city>New York</city>
<zip>1111</zip>
</ep:address>
</ep:to>
<ep:from>
<ep:address>
<name>Book Lovers</name>
<street>1st Street</street>
<city>Los Angeles</city>
<zip>90210</zip>
</ep:address>
</ep:from>
</ep:endpoints>
<prop:properties xmlns:prop = "http://user.org/header" >
<identity>uuid:74b9f5d0-33fb-4a81-b02b-5b760641c1d6</identity>
<sentAt>2000-05-14T03:00:00+08:00</sentAt>
<expiresAt>2000-05-15T04:00:00+08:00</expiresAt>
<topic>http://electrocommerce.org/purchase_order/</topic>
</prop:properties>
Body: <cpo:CommonPO xmlns:cpo="http://po.org/body" >
<cpo:POHeader CreationDate="2000-06-23" Number="12345" Purpose="PO" Type="
EZ" />
TIBCO BusinessConnect SOAP Protocol User’s Guide
Running the Tutorial
|
29
<cpo:BillTo/>
<cpo:ShipTo ContactName="BonifazLuis" ContactNumber="12345" ContactType ="
CT"/>
<cpo:Item>
<cpo:ItemHeader ExtendedPrice="499.75" Price="99.95" Quantity="5" UnitOf
Measure="EA"/>
<cpo:ItemDescription Description="Word Processing Application" Type="F"/
>
</cpo:Item>
<cpo:Total LineItemTotal="87" POTotal="544.15" QuantityTotal="34">12.34</
cpo:Total>
</cpo:CommonPO>
Attachment : po.txt
Attachment : image.gif
Hit [Enter] to send request:
Received message from BusinessConnect:
Status code: 200
Status message: OK
operation id: POInterface/1.0/POSync
transaction id: 8ae924d70cb0cb32010cb16aac8001d4
response header: <ep:endpoints xmlns:ep="http://user.org/header">
<ep:to>
<ep:address>
<name>Book Orders</name>
<street>1st Street</street>
<city>New York</city>
<zip>1111</zip>
</ep:address>
</ep:to>
<ep:from>
<ep:address>
<name>Book Lovers</name>
<street>1st Street</street>
<city>Los Angeles</city>
<zip>90210</zip>
</ep:address>
</ep:from>
</ep:endpoints>
response: <ci:CommonInvoice xmlns:ci="http://ci.org/body">
<ci:InvoiceHeader Date="2000-05-16" Number="12345" PODat
e="2000-05-16" PONumber="12345" Type="EZ" ShipDate="2000-05-16"></ci:InvoiceHead
er>
<ci:Seller ContactType="CT" ContactName="BonifazLuis" Co
ntactNumber="12345"></ci:Seller>
<Buyer></Buyer>
<ci:Item>
<ci:ItemHeader LineNumber="1" Quantity="5" Price
="99.95" UnitOfMeasure="EA" QuantityDiff="10"></ci:ItemHeader>
<ci:ItemTaxReference Description="VAT" Amount="3
.75"></ci:ItemTaxReference>
<ci:ItemDescription Type="F" Description="Word P
TIBCO BusinessConnect SOAP Protocol User’s Guide
30
|
Chapter 2 Tutorial — Standalone Private Processes
rocessing Application"></ci:ItemDescription>
</ci:Item>
<ci:InvoiceSummary Amount="544.15"></ci:InvoiceSummary>
</ci:CommonInvoice>
On the Responder machine, the complete transaction log looks as follows:
**** SOAP Server Private Process *****
listening on: AX.BC.BC-Responder.SOAP.RESPONDER.REQUEST
Request header:
<ep:endpoints xmlns:ep="http://user.org/header">
<ep:to>
<ep:address>
<name>Book Orders</name>
<street>1st Street</street>
<city>New York</city>
<zip>1111</zip>
</ep:address>
</ep:to>
<ep:from>
<ep:address>
<name>Book Lovers</name>
<street>1st Street</street>
<city>Los Angeles</city>
<zip>90210</zip>
</ep:address>
</ep:from>
</ep:endpoints><prop:properties xmlns:prop="http://user.org/header">
<identity>uuid:74b9f5d0-33fb-4a81-b02b-5b760641c1d6</identity>
<sentAt>2000-05-14T03:00:00+08:00</sentAt>
<expiresAt>2000-05-15T04:00:00+08:00</expiresAt>
<topic>http://electrocommerce.org/purchase_order/</topic>
</prop:properties>
request body:
<cpo:CommonPO xmlns:cpo="http://po.org/body">
<cpo:POHeader CreationDate="2000-06-23" Number="12345" Purpose="PO" Type="
EZ"></cpo:POHeader>
<cpo:BillTo></cpo:BillTo>
<cpo:ShipTo ContactName="BonifazLuis" ContactNumber="12345" ContactType="C
T"></cpo:ShipTo>
<cpo:Item>
<cpo:ItemHeader ExtendedPrice="499.75" Price="99.95" Quantity="5" UnitOf
Measure="EA"></cpo:ItemHeader>
<cpo:ItemDescription Description="Word Processing Application" Type="F">
</cpo:ItemDescription>
</cpo:Item>
<cpo:Total LineItemTotal="87" POTotal="544.15" QuantityTotal="34">12.34</
cpo:Total>
</cpo:CommonPO>
operation ID: POInterface/1.0/POSync
closure:8ae9266f0cb0d114010cb16747a701d5
Attachment saved to file po.txt
TIBCO BusinessConnect SOAP Protocol User’s Guide
Running the Tutorial
|
31
Attachment saved to file image.gif
Hit [Enter] to send response:
Sending response...
publishing on subject: AX.BC.BC-Responder.SOAP.RESPONDER.RESPONSE
response header: <ep:endpoints xmlns:ep="http://user.org/header">
<ep:to>
<ep:address>
<name>Book Orders</name>
<street>1st Street</street>
<city>New York</city>
<zip>1111</zip>
</ep:address>
</ep:to>
<ep:from>
<ep:address>
<name>Book Lovers</name>
<street>1st Street</street>
<city>Los Angeles</city>
<zip>90210</zip>
</ep:address>
</ep:from>
</ep:endpoints>
response: <ci:CommonInvoice xmlns:ci="http://ci.org/body">
<ci:InvoiceHeader Date="2000-05-16" Number="12345" PODat
e="2000-05-16" PONumber="12345" Type="EZ" ShipDate="2000-05-16"/>
<ci:Seller ContactType="CT" ContactName="BonifazLuis" Co
ntactNumber="12345"/>
<Buyer/>
<ci:Item>
<ci:ItemHeader LineNumber="1" Quantity="5" Price
="99.95" UnitOfMeasure="EA" QuantityDiff="10"/>
<ci:ItemTaxReference Description="VAT" Amount="3
.75"/>
<ci:ItemDescription Type="F" Description="Word P
rocessing Application"/>
</ci:Item>
<ci:InvoiceSummary Amount="544.15"/>
</ci:CommonInvoice>
Change the Message Type
To change the type of the message that will be sent from the Initiator to the
Responder using the command line interface, you can do the following:
1.Using a text editor, open the file
BC_install_dir
/protocols/soap/samples/client/SOAPClient.properties
The content of the file SOAPClient.properties looks as follows:
TIBCO BusinessConnect SOAP Protocol User’s Guide
32
|
Chapter 2 Tutorial — Standalone Private Processes
#
# SOAP Client Private process property file.
#
#client.operationID: POInterface/1.0/PONotify
client.operationID: POInterface/1.0/POSync
client.tradingPartnerID:SOAPServer
client.encoding:ISO8859_1
#client.transactionID:uuid:1234567917
attachment1.name:po.txt
attachment1.contentID:<process-1@xyz.com>
attachment1.contentType:text/plain
attachment2.name:image.gif
attachment2.contentID:<process-2@xyz.com>
attachment2.contentType:binary
2.Comment out one of the two following lines:
#client.operationID: POInterface/1.0/PONotify
or
#client.operationID: POInterface/1.0/POSync
3.The operation that is not commented out will be executed:
PONotify
or
POSync
.
Viewing the Audit Logs
To view the audit logs on the Initiator or Responder machines, do the following:
1.Click the Business Connect > Log Viewer link in the left panel.
2.Click the Audit Logs link in the right panel.
3.In the Search Transactions area, select SOAP in the Protocol dropdown list.
4.If transaction processing proceeds normally, select COMPLETED in the Status
dropdown list.
5.In the Date Range Criteria dropdown list, select Predefined Date Range.
6.Click Search to search logs.
A list of logs appears, as shown in Figure 5.
TIBCO BusinessConnect SOAP Protocol User’s Guide
Running the Tutorial
|
33
Figure 5 Audit Logs Search on the Initiator Side
7.Click on the transaction for which you would like to see the details.
The Transaction Details screen appears with the details of this transaction, as
shown in Figure 6.
Figure 6 Transaction Detail on the Initiator Side
8.Repeat steps 1 -7 on the Responder machine.
TIBCO BusinessConnect SOAP Protocol User’s Guide
34
|
Chapter 2 Tutorial — Standalone Private Processes
The following audit log search window appears, as shown in Figure 7.
Figure 7 Audit Log Search on the Responder Side
9.Click on the transaction for which you would like to see the details.
The Transaction Details screen appears with the details of this transaction, as
shown in Figure 8.
Figure 8 Transaction Detail on the Responder Side
TIBCO BusinessConnect SOAP Protocol User’s Guide
|
35
Chapter 3
Tutorial

BusinessWorks Private
Processes
This chapter gives an overview of how to use BusinessWorks with
BusinessConnect SOAP Protocol.
Topics
• Overview, page 36
• Setting Up the Tutorial, page 38
• Configuring BusinessWorks Private Processes, page 39