You are on page 1of 169

TIBCO BusinessConnect™ EZComm Protocol User’s Guide

Software Release 5.3 May 2009

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 LICENSE.PDF) 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 Software, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO BusinessConnect, TIBCO Runtime Agent, TIBCO ActiveMatrix 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, J2EE, JMS 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-2009 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

Contents iii

|

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii TIBCO BusinessConnect Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Chapter 1 Introduction to EZComm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
TIBCO BusinessConnect EZComm Protocol Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 TIBCO BusinessConnect EZComm Protocol Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2 EZComm Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Tutorial Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Create a Deployment Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Edit Application Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Assign Components to Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Deploy and Start the TIBCO BusinessConnect Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Import the Tutorial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Configuring the Initiator TIBCO BusinessConnect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Initiator Default Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Initiator Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Initiator Business Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Responder TIBCO BusinessConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Responder Default Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Responder Partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Responder Business Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 13 14 16 18 18 19 20

Configuring the Private Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Open the BusinessWorks Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Configure Connections to Initiator TIBCO BusinessConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
TIBCO BusinessConnect EZComm Protocol User’s Guide

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Add New Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run the Tutorial on the Buyer Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HTTP/S Transport . . . . . . . . . . . . . . . . 53 Managing EZComm Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up the Property ezcomm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Assign Default Host for Initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About EZComm Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .iv | Contents Configure Connections to Responder TIBCO BusinessConnect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .preserveSubject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Add New Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Duplicate Message Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Running the Tutorial . . . . . . . . . . . . . . . . . . . . About Schema Validation in EZComm. . . . . . . . . . . . . . . . 54 54 54 54 Chapter 6 Setting Up Trading Hosts and Partners . . . . . . . . . . . . . . . . . . . 26 26 27 30 Chapter 3 EZComm URIs . . . . Add New Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 34 34 35 36 Populating URIs . . . . 39 Overview . . . . . . . . . . . . . . . . 60 Enable Protocol for Initiator Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run the Tutorial on the Seller Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Asynchronous Request Response Operation . . . . . . . View the Logs . . . . . . . . . . . . . 59 Configuring EZComm for a Partner. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FTP Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Configuring EZComm for a Host . . . . . . . . . . . . . . . . . . 33 Exchanging URIs . . . . . . . . . . . . . . . . . Email Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .email. . . . . . . . . . . . 37 Chapter 4 Managing EZComm Operations . . . . . . 45 Configuring EZComm Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Delete a Property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .notify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Configure the Initiator Default Host . . . . . . . . . . . . . . . . . . . . 43 Synchronous Request Response Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 47 48 48 Chapter 5 Managing Properties . . . . . . . . . . . Add a Property. . . 60 TIBCO BusinessConnect EZComm Protocol User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . File Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 40 40 41 Notify Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . 87 Resending EZComm Private Process Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Configure a Resend Log for EZComm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Override Settings for the Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Show Advanced Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 New GUI Options for tibXML-to-EZComm Integration . . . . . . .Contents v | Chapter 7 Configuring Business Agreements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Chapter 9 Viewing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Chapter 10 File Pollers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Override Settings for the Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Operation Bindings Tab . . . . . . . . . . . . . 86 Multiple Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Edit Operation Bindings for the Host . . . . . . . 64 Configuring Agreement Protocol Binding for EZComm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Adding a New Business Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Responder Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 General Messages. . . . . . . . . . . . . . . . 93 Resend Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Example Usage Scenarios for EZComm-to-tibXML Integration . . . . . . . . . . . . . . . . . 90 Non-Repudiation Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 About EZComm Private Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Configure a Non-Repudiation Log for EZComm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Inbound File Pollers for EZComm . . . . . . . . . . . . . . . . . . 74 Chapter 8 EZComm Private Messages. . . . . . . . . . . . . . 76 Initiator Messages . . . . . . . 105 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Document Security Tab . . . . . . . . . . . . . . . . . . 101 Outbound File Pollers for EZComm . . . . . . . . . . 75 Overview . . . . . . . . . . . . . . . 71 Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Chapter 11 tibXML Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 TIBCO BusinessConnect EZComm Protocol User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Configure an Audit Log for EZComm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Shadow Credential Usage for EZComm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Edit Operation Bindings for a Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . .1 to 5. . . . . . 137 138 139 140 141 141 142 142 143 144 146 147 TIBCO BusinessConnect EZComm Protocol User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up the Second Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Overview . . . . . . . . . . . . . . . . 131 Troubleshooting EZComm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Setting Timing Restrictions in tibXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Chapter 12 EZComm 5. . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Appendix A FTP Script Examples . . . . . . . . . . . . . . . . . . . . . . . . . . Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tibXML Public Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tibXML Message Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 tibXML Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vi | Contents tibXML Private Process Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Outbound Public Messages in tibXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Second Tutorial Example . . . . . . . . . . . . . . . . . . . . . . . . . . Run the First Tutorial Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expected Results . . . . . . .3 Migration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Public Messages Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Private Process Migration . . Inbound Public Messages in tibXML . . . Inbound Processing Error in tibXML . . . . . . . 135 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 First Tutorial Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run the Third Tutorial Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Connection Between tibXML Public and Private Process Messages . . . . . . . . . Set Up the First Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Passthrough Mode in tibXML . . . . . . . . . . . . . . . . . . . . . . . . . 109 109 111 111 111 116 116 116 117 117 118 MIME Message Packaging Options in tibXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set Up the Third Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Chapter 13 Troubleshooting . . . . . . . . . . . . . . . . . . . . . Third Tutorial Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Run the Second Tutorial Example . . . . . . . . . . . . . . . . . . . . . . . . . . . Comparing Private Processes Messages Between tibXML and EZComm . . . . . . . . . . . . . . . . . . . 128 Outbound File Poller Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transports for tibXML Private Process Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tibXML Message Packaging. . . . . . . . . . . . . . . . . . . . Rules for Handling tibXML Messages . . . . . . . . . . . . . . . . . . . . . . .

Tables vii

|

Tables

Table 1 Table 2 Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 13 Table 14 Table 15 Table 16 Table 17 Table 18 Table 19 Table 20 Table 21 Table 22 Table 23 Table 24 Table 25

General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv New Transport for the Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 New HTTP Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Edit Protocol Binding: Operation Binding Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Override Outbound Settings: Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Edit Protocol Binding: Operation Binding Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Override Inbound Settings: Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Operation Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Request Action Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Response Action Tab: Synchronous and Asynchronous Request-Response Only . . . . . . . . . . . . 51 Host Settings: General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Partner Settings: General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 New Transport for the Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Edit Protocol Binding: Operation Binding Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Override Outbound Settings: Operation Settings Tab (All Operations) . . . . . . . . . . . . . . . . . . . . . 67 Override Outbound Settings: Actions Tab (Notify and Asynchronous Request-Response Operations) 68 Override Outbound Settings: Transports Tab (All Operations) . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Override Inbound Settings: Operation Settings Tab (All Operations). . . . . . . . . . . . . . . . . . . . . . . 69 Override Inbound Settings: Actions Tab (Synchronous and Asynchronous Request Response) . 70 Override Inbound Settings: Transports Tab (All Operations) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Configure Transports for the Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Edit Protocol Bindings: Advanced Settings for Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Edit Protocol Binding: Advanced Settings for Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Private Message: InitiatorRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Private Message: InitiatorResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Private Message: ResponderRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

TIBCO BusinessConnect EZComm Protocol User’s Guide

viii

| Tables
Table 26 Table 27 Table 28 Table 29 Table 30 Table 31 Table 32 Table 33 Table 34 Table 35 Table 36 Table 37 Table 38 Table 39 Table 40 Private Message: Responder.Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Private Message: Responder.Ack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Private Message: Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Audit Log: Search Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Audit Log: Advanced Search Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Non-Repudiation Log: Search Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Non-Repudiation Log: Advanced Search Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Resend Log: Resendable Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Resend Log: Advanced Search Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Resend Log: Resend History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Resend Log: Advanced Search Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 INITIATOR.REQUEST Fields in tibXML 3.6 and EZComm 5.3. . . . . . . . . . . . . . . . . . . . . . . . . . . 112 INITIATOR.RESPONSE Fields in tibXML 3.6 and EZComm 5.3 . . . . . . . . . . . . . . . . . . . . . . . . . 113 RESPONDER.REQUEST Fields in tibXML 3.6 and EZComm 5.3 . . . . . . . . . . . . . . . . . . . . . . . . 114 RESPONDER.RESPONSE Fields in tibXML 3.6 and EZComm 5.3 . . . . . . . . . . . . . . . . . . . . . . . 115

TIBCO BusinessConnect EZComm Protocol User’s Guide

Figures ix

|

Figures

Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21

Imported Operations Manage Widgets and Widget Inventory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 TIBCO Designer: BusinessWorks Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 BusinessConnect Server Access Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 INITIATOR (BusinessConnect Connection) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Select Process to Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 SendRequest (Input) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Create Job for the Send ASyncRequest operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Send INITIATOR.REQUEST and Receive INITIATOR.RESPONSE . . . . . . . . . . . . . . . . . . . . . . . . 28 Send Async Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 RESPONDER AsynchronousRequestResoponse Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Audit Log for the Buyer Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Audit Log for the Seller Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Notify Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Synchronous Request-Response Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Tutorial: Asynchronous Request Response Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Configure New Operation for EZComm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 New Operation Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Initiator Request: Initiator Using tibXML 3.x, Responder Using EZComm 5.3 . . . . . . . . . . . . . . . . 107 Initiator Request: Initiator Using EZComm 5.3, Responder Using tibXML 3.6 . . . . . . . . . . . . . . . . 107 tibXML to EZComm Private Process Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 EZComm 5.1 to EZComm 5.3 Private Process Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

TIBCO BusinessConnect EZComm Protocol User’s Guide

x | Figures TIBCO BusinessConnect EZComm Protocol User’s Guide .

Topics • • • Related Documentation.txt file for the availability of this software version on a specific operating system platform. page xii Typographical Conventions. page xiv How to Contact TIBCO Customer Support. Please see the readme. page xvii TIBCO BusinessConnect EZComm Protocol User’s Guide . not all operating system platforms for a specific software version are released at the same time. However.| xi Preface This software may be available on multiple operating systems. TIBCO BusinessConnect™ software is a B2B (business-to-business) gateway that allows your company to engage in electronic commerce with your business partners.

TIBCO BusinessConnect Palette Reference: Read this guide to learn about the resources available in the TIBCO BusinessConnect Palette for TIBCO BusinessWorks. protocols. and manage) the BusinessConnect server. and security. This document is supplied for each release and is available only in PDF format. operate. This guide contains a detailed tutorial. EZComm is installed with TIBCO BusinessConnect. TIBCO BusinessConnect Release Notes: Read this document to learn about new features. and closed issues for each release. which is a recommended reading for new TIBCO BusinessConnect users. TIBCO BusinessConnect EZComm Protocol User’s Guide: Read this guide to learn about using TIBCO BusinessConnect EZComm Protocol. machines and applications defined in a TIBCO Administration Domain.xii | Related Documentation Related Documentation This section lists documentation resources you may find useful. • TIBCO BusinessConnect Scripting Deployment User’s Guide: Read this guide to configure and manage TIBCO BusinessConnect using the command line interface. deprecated features. known issues. therefore no separate installation guide for this protocol is provided. TIBCO BusinessConnect Server Administration: Read this guide in order to administer (install. • • Other TIBCO Product Documentation You may find it useful to read the documentation for the following TIBCO products. which may be used or integrated with BusinessConnect: • TIBCO Administrator™ software: The software allows you to manage users. changes in functionality. TIBCO BusinessConnect Trading Partner Administration: Read this guide to configure and manage trading partners. deployment modes. TIBCO BusinessConnect Documentation The following documents form the BusinessConnect documentation set: • • • • TIBCO BusinessConnect Concepts: Read this guide to learn about TIBCO BusinessConnect architecture. The TIBCO BusinessConnect EZComm Protocol User’s Guide .

It includes two main components: the Rendezvous programming language interface (API) in several languages. The EAR can then be used by TIBCO Administrator for deploying and running the application. and easy to use integration platform that allows you to develop integration projects. TIBCO Rendezvous®: This software enables programs running on many different kinds of computers on a network to communicate seamlessly.Preface xiii | TIBCO Administrator graphical user interface enables users to deploy. TIBCO BusinessWorks includes a graphical user interface (GUI) for defining business processes and an engine that executes the process. TIBCO Hawk®. monitor. the software suite includes the third-party libraries used by other TIBCO products such as TIBCO Designer. Java Runtime Environment (JRE). TIBCO Runtime Agent™ software: This software suite is a prerequisite for other TIBCO software products. • • • • TIBCO BusinessConnect EZComm Protocol User’s Guide . • TIBCO ActiveMatrix BusinessWorks™ software: This software is a scalable. and start and stop TIBCO applications. 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. 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. and the Rendezvous daemon. In addition to TIBCO Runtime Agent components. and TIBCO Rendezvous®. extensible.

Table 1 General Typographical Conventions Convention TIBCO_HOME ENV_HOME Use Many TIBCO products must be installed within the same home directory. and output displayed in a command window. For example: Use MyCommand to start the foo process. the default value is C:\tibco. filenames. code font Code font identifies commands. The value of TIBCO_HOME depends on the operating system. bold code font Bold code font is used in the following ways: • • • In procedures. For example: Type admin. Incompatible products and multiple instances of the same product are installed into different installation environments. to indicate the parts of the sample that are of particular interest. to indicate the default parameter for a command. on Windows systems. to indicate what a user types. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. The value of ENV_HOME depends on the operating system. For example. code examples. The directory into which such products are installed is referenced in documentation as ENV_HOME. pathnames. To introduce new terms For example: A portal page may contain several portlets. For example: MyCommand PathName TIBCO BusinessConnect EZComm Protocol User’s Guide . In large code samples. In command syntax. MyCommand is enabled: MyCommand [enable | disable] italic font Italic font is used in the following ways: • • • To indicate a document title. To indicate a variable in a command or code syntax that you must replace. For example. This directory is referenced in documentation as TIBCO_HOME. on Windows systems the default value is C:\tibco. Portlets are mini-applications that run in a portal. if no parameter is specified.xiv | Typographical Conventions Typographical Conventions The following typographical conventions are used in this manual. Other TIBCO products are installed into an installation environment. For example.

The tip icon indicates an idea that could be useful. for example. The note icon indicates information that is of special interest or importance. For example: MyCommand [optional_parameter] required_parameter | A logical OR that separates multiple items of which only one may be chosen. for example. for example. a way to apply the information provided in the current section to achieve a specific result. For example: Ctrl+C. For example. Key names separated by a comma and space indicate keys pressed one after the other.Preface xv | Table 1 General Typographical Conventions (Cont’d) Convention Key combinations Use Key name separated by a plus sign indicate keys pressed simultaneously. Table 2 Syntax Typographical Conventions Convention [ ] Use An optional item in a command or code syntax. you can select only one of the following parameters: MyCommand para1 | param2 | param3 TIBCO BusinessConnect EZComm Protocol User’s Guide . an additional action required only in certain circumstances. Ctrl+Q. The warning icon indicates the potential for a damaging situation. data loss or corruption if certain steps are taken or not taken. For example: Esc.

MyCommand param1 [param2] {param3 | param4} TIBCO BusinessConnect EZComm Protocol User’s Guide .xvi | Typographical Conventions Table 2 Syntax Typographical Conventions Convention { } Use A logical group of items in a command. the command can accept either two or three parameters. the command requires two parameters. Other syntax notations may appear within each logical group. which can be either the pair param1 and param2. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 | param2} {param3 | param4} In the next example. the following command requires two parameters. The first parameter must be param1. or the pair param3 and param4. MyCommand {param1 param2} | {param3 param4} In the next example. For example. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4.

com Entry to this site requires a user name and password.tibco.com/services/support • If you already have a valid maintenance or support contract. • For an overview of TIBCO Support Services. visit this site: https://support.tibco. you can request one. visit this site: http://www. TIBCO BusinessConnect EZComm Protocol User’s Guide . please contact TIBCO Support Services as follows.Preface xvii | How to Contact TIBCO Customer Support For comments or problems with this manual or the software it addresses. If you do not have a user name. and information about getting started with TIBCO Product Support.

xviii How to Contact TIBCO Customer Support | TIBCO BusinessConnect EZComm Protocol User’s Guide .

page 3 TIBCO BusinessConnect EZComm Protocol User’s Guide . page 2 TIBCO BusinessConnect EZComm Protocol Features. which provides valuable insight for using other.|1 Chapter 1 Introduction to EZComm It is recommended that all users familiarize themselves with EZComm using this tutorial. Topics • • TIBCO BusinessConnect EZComm Protocol Overview. more complex protocols.

TIBCO BusinessConnect EZComm Protocol User’s Guide . TIBCO BusinessConnect EZComm Protocol allows tracking of each document sent to or received from a trading partner. Trading partners managed by BusinessConnect can quickly and efficiently be configured to exchange document securely with the BusinessConnect host over the Internet using EZComm without understanding or interpreting the document contents. With the introduction of the Request/Response operation type. which ensures that the response document is properly logged with the corresponding request document and delivered or received on time to or from the trading partner. RosettaNet. It provides the basic transport connectivity for trading partners to exchange documents with the BusinessConnect host without conforming to a particular business protocol standard such as EDI. independent of the transport mechanism. or SOAP. and correlates the corresponding response document with the trading partner. which allows you to securely exchange data over the Internet. an easy-to-use data transfer protocol.2 | Chapter 1 Introduction to EZComm TIBCO BusinessConnect EZComm Protocol Overview TIBCO BusinessConnect includes EZComm. The back office applications can focus on the processing of the document contents sent to or received from BusinessConnect.

To learn more about public transports and their configuration. These transports follow industry transport protocol standards such as AS1. FTP/S. Email. Chapter 14. HTTP/S. S/MIME. HTTP. TIBCO Rendezvous and JMS Transport. and SSHFTP transports. The complete installation for TIBCO BusinessConnect and EZComm is explained in the TIBCO BusinessConnect Server Administration Guide. HTTPS. TIBCO BusinessConnect EZComm Protocol User’s Guide . AS1 Transport Chapter 13. File Transport Support for Private Transports TIBCO BusinessConnect EZComm Protocol supported the following private transports: • • TIBCO Rendezvous JMS These private transports are explained in TIBCO BusinessConnect Concepts. SSHFTP Transport Chapter 16. see TIBCO BusinessConnect Trading Partner Administration Guide and the following chapters: • • • • • • Chapter 10. See also Content Disposition Filename. SSH. and HTTPSCA Transports Chapter 12. AS2. FTP and FTPS Transports Chapter 15. POP. Support for Public Transports The basic transport connectivity includes the File. SSL to provide document security by encryption and document authenticity by digital signature. SMTP.TIBCO BusinessConnect EZComm Protocol Features 3 | TIBCO BusinessConnect EZComm Protocol Features TIBCO BusinessConnect EZComm Protocol has the following features: Automatic Installation TIBCO BusinessConnect EZComm Protocol installs automatically with TIBCO BusinessConnect. Email Transport.

Its not capable of receiving the response from the trading partner. To learn more about validating schemas for EZComm. • Asynchronous Request Response Operation Asynchronous Request Response operation sends the document to trading partner and waits for the response. For more information. XML Validation EZComm supports XSD and DTD schema validation. For more details. Duplicate Message Detection EZComm allows both incoming and outgoing public messages to be verified for duplicates. Private process can send these attachments in a sequence and each Attachment has the following structure. tibXML Integration for more information. tibXML Protocol Integration EZComm enables interoperability with the legacy protocol tibXML: users of tibXML can communicate with TIBCO BusinessConnect using the EZComm protocol. • Synchronous Request Response Operation Synchronous Request Response operation sends the document to trading partner and waits for the response until the response is received. it suspends any further processing for that request. see Configuring EZComm Operations. but it allows further processing irrespective of the response arrival from the partner. It can simply send a document to the trading partner and receive the acknowledgement. TIBCO BusinessConnect EZComm Protocol User’s Guide . Support for Multiple Attachments TIBCO BusinessConnect EZComm Protocol allows multiple attachments.4 | Chapter 1 Introduction to EZComm Support for Operations The following operations are supported in TIBCO BusinessConnect EZComm Protocol: • Notify Operation Notify operation is a one way operation. see Duplicate Message Detection. See Chapter 11. see Multiple Attachments.

see TIBCO BusinessConnect Concepts. and binary data blobs TIBCO BusinessConnect EZComm Protocol User’s Guide . • • Exchange of notices with trading partners XML. • Audit logging. including the user transactionID in the audit log To learn more about audit logging in EZComm. Chapter 8. Security. see Audit Logs. plain text.TIBCO BusinessConnect EZComm Protocol Features 5 | Other Supported Features • Electronic signing and message encryption or decryption To learn more about security in BusinessConnect.

6 | Chapter 1 Introduction to EZComm TIBCO BusinessConnect EZComm Protocol User’s Guide .

page 13 Configuring the Responder TIBCO BusinessConnect. page 18 Configuring the Private Processes. page 22 Running the Tutorial. page 26 TIBCO BusinessConnect EZComm Protocol User’s Guide .|7 Chapter 2 EZComm Tutorial This chapter presents a complete tutorial on installing and configuring the TIBCO BusinessConnect EZComm Protocol for the Asynchronous Request Response operation. Topics • • • • • • Overview. page 8 Prerequisites. page 9 Configuring the Initiator TIBCO BusinessConnect.

5. 3. For an overview of the operation. Configuring the Private Processes This step is performed both on the Initiator and on the Responder machine. see Asynchronous Request Response Operation. Tutorial Steps This tutorial requires that you follow through the following steps: 1. 4. This step is performed both on the Initiator and on the Responder machine.8 | Chapter 2 EZComm Tutorial Overview This tutorial gives an example of an asynchronous Request Response operation in EZComm and shows the following: • • How to create private processes on the Initiator and the Responder side How to create and process an asynchronous Request Response operation Two machines are needed to run the tutorial: Buyer and Seller. Configuring the Responder TIBCO BusinessConnect This step is performed only on the Responder machine. Configuring the Initiator TIBCO BusinessConnect This step is performed only on the Initiator machine. 6. Running the Tutorial This step is performed both on the Initiator and on the Responder machine. the Initiator machine is called Buyer and the Responder machine is called Seller. Prerequisites. 2. TIBCO BusinessConnect EZComm Protocol User’s Guide . In this tutorial. Import the Tutorial This step is performed both on the Initiator and on the Responder machine.

TIBCO BusinessConnect EZComm Protocol 2. Create a Deployment Configuration 1. log in. This will locate all TIBCO BusinessConnect components on one machine. using the single server deployment mode: a. Create a Deployment Configuration b. Start TIBCO Administrator.Prerequisites 9 | Prerequisites Before starting this tutorial. 6. Select the Single Server Mode radio button. 2. and in the left panel expand BusinessConnect by clicking on the plus sign (+). Click on System Settings. Chapter 2. TIBCO BusinessConnect 5. Deploy and start TIBCO BusinessConnect by performing the steps described in TIBCO BusinessConnect Server Administration Guide. Deployment.3. Assign Components to Machines d. When complete. Click Done. 4. Deploy and Start the TIBCO BusinessConnect Instance 4.0 b. the following message will be displayed: “Deployment Configuration Successfully Created”. Perform all pre-deployment configuration procedures described in TIBCO BusinessConnect Server Administration Guide. 3. Click on Deployment Configuration. Pre-Deployment Configuration. Chapter 3. provide the following prerequisites: 1. These steps are also explained in the following sections. TIBCO BusinessConnect EZComm Protocol User’s Guide . Edit Application Configuration c. Click Create Deployment Configuration. Install the following software packages: a. as explained in the section Import the Tutorial. 3. 5. Import the pre-configured operations to use in the tutorial.

there is a message Needs configuration next to the BusinessConnect and Single Server. TIBCO BusinessConnect EZComm Protocol User’s Guide . Select the Enable HTTP Transport checkbox.par links. Expand BusinessConnect. For the HTTP Port.par: Need to deploy in a Service Container Set Up Server Transport 1. In the left panel of TIBCO Administrator. The Configuration dialog appears in the right panel. 2./”. as explained in the following sections: — Configure Advanced Settings — Set Up Server Transport Configure Advanced Settings Large. Configure Large. Shared. Click the Configuration link. In the Deployability column. and temp files will be posted by default to the location “. you can leave this directory as is. Process Configuration The Edit Application Configuration dialog shows up with the Public tab already selected. shared. You can configure large and shared file location (optional). 4. 5. If you need to configure specific directories. Click on the TIBCO BusinessConnect link. 3. expand Application Management. Click the BusinessConnect link. Click Save twice.10 | Chapter 2 EZComm Tutorial Edit Application Configuration 1. • Click Save twice. 2. Click the HTTP link. keep the default value of 6700. see TIBCO BusinessConnect Server Administration Guide. which uses the engine’s running directory as the root folder for all temporary files. 4. If you don’t have any specific requirements. The Edit Application Configuration dialog appears. 3. as well as the server transport. The configuration dialog appears indicating the following: TIBCO BusinessConnect: Services require configuration Single Server. and Temp File Locations.

Keep the Enable Service checkbox selected. 4. 5. (New) Deploy and Start the TIBCO BusinessConnect Instance 1. In the Deploy Configuration dialog. the TIBCO BusinessConnect engine will be deployed and then started. TIBCO BusinessConnect: Success TIBCO BusinessConnect EZComm Protocol User’s Guide . TIBCO BusinessConnect: Synchronized Deployed Configuration. Click OK. 2. Click Add to Additional Machines. 3. 6. select the checkbox next to the machine on which you want to deploy this component.par: Deployable. searching for it if necessary. The configuration dialog appears indicating the following: Configuration Builder.Prerequisites 11 | Assign Components to Machines 1. If you have left the checkbox Start successfully deployed services selected. Click Deploy. keep the following defaults: — Stop running services before deployment: keep selected — Kill services that haven’t stopped after (seconds) : keep 5 — Start successfully deployed services: keep selected — Force redeployment of all services: default is to keep cleared 2. the machine you added is now displayed in the Service Instance column. Click the Single_Server. Click OK. services require deployment Single Server. The configuration dialog appears indicating the following: TIBCO BusinessConnect: Deployable. Click Save. In the Edit Service Configuration dialog. The Edit Service Configuration dialog appears with the General tab already selected.par link in the Configuration Builder panel. In the Bind to Containers dialog.

Using TIBCO Administrator. This tutorial will use pre-configured operations. Click the link change and upload the following file: BC_home/samples/EZComm/interfaces/ezcommtutorial-operations. continue with configuring the machines. Click Edit. In the Operations Editor dialog. Click Import. In the Edit Operations dialog. TIBCO BusinessConnect EZComm Protocol User’s Guide . 6. select BusinessConnect>Operations Editor. To import the tutorial on both machines (Initiator and Responder). which will be imported together with the tutorial. 4. This will import two operations named Manage Widgets and Widget Inventory. select EZComm in the dropdown list 2.12 | Chapter 2 EZComm Tutorial Import the Tutorial Before you can configure partners for an EZComm transactions. do the following: 1. click Import.csx 5. you must first configure an operation for EZComm as explained in Configuring EZComm Operations. Enter the password if desired. The default Notify operation and the two imported operations will appear in the Edit Operations dialog: Figure 1 Imported Operations Manage Widgets and Widget Inventory Once the operations are imported. 3.

Follow the steps as described in these sections: • • • Configure the Initiator Default Host Configure the Initiator Partner Configure the Initiator Business Agreement Configure the Initiator Default Host For more information about setting up a host in a business agreement. select the Active checkbox. 9. Type Buyer in the Participant Name field. Click the Buyer link. see Configuring EZComm for a Host. 12. 10. 1. the hosts machine’s name is Buyer. 11. 7. 5. Click Apply.Configuring the Initiator TIBCO BusinessConnect 13 | Configuring the Initiator TIBCO BusinessConnect In this tutorial. In the Edit Host Participant dialog. 3. The Edit System Settings: General Settings dialog appears. there is no need to further edit protocol configuration. 6. Select Host in the Participant Type dropdown list. Select Buyer in the Default Host dropdown list. TIBCO BusinessConnect EZComm Protocol User’s Guide . Click Finish. 4. Click Save. Select BusinessConnect>System Settings in the left panel. Click the General Settings link. and the partner’s machine name is Seller. Click the Participant Wizard button. Select BusinessConnect>Participants. For this tutorial. 2. 8.

4. see Configuring EZComm for a Partner. Click on EZComm link. Click the Participant Wizard button. The EZComm protocol is now in the Protocol Name list. TIBCO BusinessConnect EZComm Protocol User’s Guide . Click OK. Both participants (Buyer and Seller) now appear in the panel. Click Finish. select the Active checkbox. Click Enable. there is no need to further edit protocol configuration. 3. In the Edit Partner Participant dialog. 1. In the Edit Host Participant dialog. The dialog with installed protocols appears. Type Seller in the Participant Name field. Click the Seller link. 5. Add Transport for Initiator Partner 1. 8. Click Apply. 6. In the New Transport dialog. 2. 7. Click Add. 11. Select the Transports tab. 4. Select BusinessConnect>Participants. select the Protocols tab. 3. Select Partner in the Participant Type dropdown list. 2. For this tutorial. 12. Enable Protocol for Initiator Partner 9. Select the checkbox next to EZComm. 10. enter the transport name.14 | Chapter 2 EZComm Tutorial Configure the Initiator Partner For more information about setting up a partner in a business agreement.

hostname:6700/EZComm. 6. 8. Table 2 New HTTP Transport Field Transport Name URL Use HTTP Basic Authentication Username Password Retry Count Retry Interval Socket Timeout (seconds) Description Enter a name for this transport (required) URL of the company (required): www. Leave the default (60).Configuring the Initiator TIBCO BusinessConnect 15 | 5. Enter information according to Table 2. Define URL 7. select HTTP. For this tutorial. Click Save three times. Enter data for the new transport as explained in Table 1. Leave the default (300). The New HTTP Transport dialog appears. No entry required for this tutorial No entry required for this tutorial Leave the default (3). Table 1 New Transport for the Partner Field Transport Name Transport Type Description Enter the name for the transport (required) Select the transport type from the dropdown list. Click OK. TIBCO BusinessConnect EZComm Protocol User’s Guide . Clear the checkbox Use HTTP Basic Authentication for this tutorial.

general dialog appears. Click the Add Protocol Bindings button. Select the host Buyer from the Host Party list. 3. 4. 2.16 | Chapter 2 EZComm Tutorial Configure the Initiator Business Agreement This section contains only the steps that are necessary for this tutorial. To add a protocol binding for this business agreement. Add Operation Bindings for the Initiator Business Agreement This section contains only the steps that are necessary for this tutorial. 2. Select the business agreement link and then click on the EZComm link. Select the partner Seller from the Partner Party list 5. do the following: 1. The New Agreement dialog appears. For a complete explanation on this topic. Click OK. 4. Verify that EZComm appears in the Protocols column for both trading partners. This will make the agreement valid immediately. If it is missing. For a complete explanation on this topic. 6. 1. return to Enable Protocol for Initiator Partner and enable the EZComm protocol. Click Save. Confirm that the Valid checkbox is selected. see Adding a New Business Agreement. 5. Click the New button. Select the EZComm checkbox. EZComm now appears on the Agreement Protocol Binding list. The New Agreement. TIBCO BusinessConnect EZComm Protocol User’s Guide . After both trading partners are configured. Select BusinessConnect>Business Agreements. you will now configure their business agreement. 3. Click OK. The Edit Protocol Binding dialog appears with the Operation Bindings tab selected by default. see Configuring Agreement Protocol Binding for EZComm.

Configure transport settings using Table 4. you can select the desired value in the Operation Settings tab for this binding. Host can Initiate: Override Outbound Settings 1. select the Override Transports checkbox. select the Manage Widgets/1. select HTTP. Enter information according to Table 3. The same binding is used for the incoming response for this request. for example. Click the operation Manage Widgets/1. click Add Operation Binding. clear the Allow All Operations checkbox. This creates an operation binding for the operation buyWidget that will override any outgoing request for this operation. The selected operation appears in the Operation Name list. Override Outbound Transports Primary Transport For this tutorial. 7. Table 3 Edit Protocol Binding: Operation Binding Tab Field Allow All Operations Non-Repudiation Logging Add Binding for the Host Description For this tutorial.0/buyWidgets in the section Host can initiate. Click the Transports tab. 2. For this tutorial.0/buyWidgets operation. Transports Tab 3. In the Host can initiate section. Table 4 Override Outbound Settings: Transports Tab Field Override Transports Description For this tutorial. leave the Non-Repudiation Logging checkbox selected. if you want to override the schema validation for an incoming response.Configuring the Initiator TIBCO BusinessConnect 17 | Operation Bindings Tab 6. Click OK. 4. 8. Click Save. For this tutorial. TIBCO BusinessConnect EZComm Protocol User’s Guide .

18 | Chapter 2 EZComm Tutorial Configuring the Responder TIBCO BusinessConnect This section describes how to configure the Responder TIBCO BusinessConnect. 2. Click the Participant Wizard button. Follow the steps as described in these sections: — Configure the Responder Default Host — Configure the Responder Partner — Configure the Responder Business Agreement Configure the Responder Default Host For more information about setting up a host in a business agreement. If the second machine doesn’t contain a deployed version of TIBCO BusinessConnect. 6. see Configuring EZComm for a Host. and the previous partner is now the host. For this tutorial. 7. In the Edit Host Participant dialog. Configure the Responder on another machine. Type Seller in the Participant Name field. select the Active checkbox. 5. Select BusinessConnect>System Settings in the left panel. 2. The Edit System Settings: General Settings dialog appears. Select BusinessConnect>Participants. 8. Select Host in the Participant Type dropdown list and click Finish. as described in Prerequisites and Import the Tutorial. Click the Seller link. Click Apply. Select Seller in the Default Host dropdown list and click Save. 1. there is no need to further edit protocol configuration. where your previous host becomes a partner. Click the General Settings link. 10. TIBCO BusinessConnect EZComm Protocol User’s Guide . 3. Start TIBCO Administrator and click the TIBCO BusinessConnect link. proceed as follows: 1. 9. 3. 4. Repeat all pre-deployment and deployment steps for the second machine.

3. see Configuring EZComm for a Partner. Select HTTP from the dropdown list. TIBCO BusinessConnect EZComm Protocol User’s Guide . there is no need to further edit protocol configuration. In the Edit Partner Participant dialog. Click Enable. For this tutorial. 12. In the Edit Host Participant dialog. 4. Select Partner in the Participant Type dropdown list. enter the transport name. 6. 8. Add Transport for the Responder Partner 1. Click the Buyer link. 2. 10. The dialog with installed protocols appears. The New HTTP Transport dialog appears. Select the Transports tab. select the Active checkbox. 4. 5. 5. 11. Define URL 7. In the New Transport dialog. Click Apply. Type Buyer in the Participant Name field. 6. 7. 1. Click OK. The EZComm protocol is now in the Protocol Name list. For more details. Click OK. Click the Participant Wizard button. see Add Transport for Initiator Partner. 3. Click on EZComm link. Click Add. select the Protocols tab. 2.Configuring the Responder TIBCO BusinessConnect 19 | Configure the Responder Partner For more information about setting up a partner in a business agreement. Enable Protocol for Responder Partner 9. Click Finish. Select BusinessConnect>Participants. Select the checkbox next to EZComm.

10. 7. 9. 8. Configure the Responder Business Agreement This section contains only the steps that are necessary for this tutorial. Select the partner Buyer from the Partner Party. 2. In the Edit Agreement dialog. EZComm now appears on the Agreement Protocol Binding list. 9. 4. For a complete explanation on this topic. Click OK. 6. This will make the agreement valid immediately. Click OK. see Adding a New Business Agreement. see Configuring Agreement Protocol Binding for EZComm. Select the EZComm checkbox. For a complete explanation on this topic. Confirm that the Valid checkbox is selected. Click Save three times. Click Save. TIBCO BusinessConnect EZComm Protocol User’s Guide . 1.20 | Chapter 2 EZComm Tutorial 8. Select the host Seller from the Host Party list. Click the Add Protocol Bindings button. The Edit Protocol Binding dialog appears with the Operation Bindings tab selected by default. Select BusinessConnect>Business Agreements. Click the New button.hostname.com:6700/EZComm. Select the Business Agreement link. as explained in Table 2: www. click on the EZComm link. Add Operation Bindings for the Responder Business Agreement This section contains only the steps that are necessary for this tutorial. 1. Enter the data about this new transport. 3. 5. 2.

Configuring the Responder TIBCO BusinessConnect 21

|

Operation Bindings Tab

3. Enter information according to Table 5.

Table 5 Edit Protocol Binding: Operation Binding Tab Field Allow All Operations Non-Repudiation Logging
Add Binding for the Partner

Description Clear the checkbox for this tutorial. Select the checkbox for this tutorial.

4. In the Partner can initiate section, click Add Operation Binding. For this tutorial, select the Manage Widgets/1.0/buyWidgets operation. 5. Click OK. The selected operation appears in the Operation Name list. Partner can Initiate: Override Inbound Settings 1. Click the operation Manage Widgets/1.0/buyWidgets in the panel Partner can initiate. 2. Click the Transports tab.

Transports Tab

3. Configure transport settings using Table 6.

Table 6 Override Inbound Settings: Transports Tab Field Override Transports Description Select the checkbox for this tutorial.

Override Outbound Transports Primary Transport For this tutorial, select HTTP. 4. Click Save. This creates an operation binding for the operation buyWidget that will override any incoming request for this operation. The same binding is used for the outgoing response for this request; for example, if you want to override the schema validation for an outgoing response, you can select the desired value in the Operation Settings tab for this binding.

TIBCO BusinessConnect EZComm Protocol User’s Guide

22

| Chapter 2

EZComm Tutorial

Configuring the Private Processes
This section describes how to configure the private processes on the Initiator and Responder machines.

Open the BusinessWorks Project
To open the example TIBCO ActiveMatrix BusinessWorks project in TIBCO Designer, do the following: 1. Start TIBCO Designer. 2. Click New empty project. 3. In the Save Project dialog, click Cancel. 4. Select Project>Import Full Project. 5. Click the ZIP Archive tab. 6. Navigate to //BC_home/samples/EZComm/tutorial For Windows: C:\tibco\bc\n.n\samples\EZComm\tutorial Click Yes. 7. Select EZComm.zip. 8. Click Open and OK. 9. In the Options tab, select the Try rename in case of name conflict radio button. 10. Click Apply. 11. Select Project>Save As. 12. In the Project Directory file chooser, navigate to a folder where you want to save the sample project. If you want to be able to restore the project for later use, be sure to select a directory other than BC_installation_directory\samples\EZComm\tutorial. If your select the directory BC_installation_directory\samples\EZComm\tutorial, the zip archive file will be deleted. 13. Click OK. 14. Open the project by clicking on the (+) signs next to the project elements. The window similar to the one shown in Figure 2 will display.

TIBCO BusinessConnect EZComm Protocol User’s Guide

Configuring the Private Processes 23

|

Figure 2 TIBCO Designer: BusinessWorks Project

Configure Connections to Initiator TIBCO BusinessConnect
To configure connections to TIBCO BusinessConnect on the Initiator machine, do the following: 1. In the expanded project tree, double-click the Initiator TIBCO BusinessConnect connection icon . 2. Click the TIBCO BusinessConnect Server Access tab.

TIBCO BusinessConnect EZComm Protocol User’s Guide

3. The INIATOR (BusinessConnect Connection) screen appears. Click the Import Selected Business Protocol button. Type the URL for the configuration store in the JDBC URL field. Select the JDBC driver you use to communicate with the TIBCO BusinessConnect configuration store from the JDBC Driver dropdown list. Type the configuration store user name and password in the DB User and Password fields. In the dialog Confirmation on importing 'EZComm' operations. d. 4. b. Click the Update from Configuration Store button. 6. Click the Configuration tab. c. select all operations and click OK.24 | Chapter 2 EZComm Tutorial Figure 3 BusinessConnect Server Access Tab a. TIBCO BusinessConnect EZComm Protocol User’s Guide . If you select the checkbox Select Operations. Click the Apply button. click Yes for Maintenance on EZComm Schemas 8. Select EZComm on the Protocol Name dropdown list . 7. you will be allowed to select any of the configured/imported operations For this tutorial. 5.

When you import the protocol. BusinessWorks retrieves information from the TIBCO BusinessConnect configuration store and puts it in the project folder. 9. you will see the operations that you have imported in Import the Tutorial. TIBCO BusinessConnect EZComm Protocol User’s Guide . Configure Connections to Responder TIBCO BusinessConnect On the Responder machine. complete all steps explained in Configure Connections to Initiator TIBCO BusinessConnect. replacing all instances of Initiator with Responder. 10.Configuring the Private Processes 25 | Figure 4 INITIATOR (BusinessConnect Connection) In the Imported Operations field. Click the Save icon to save the project. Click Apply.

4. Buyer and Seller. you have to run it on both machines. Select the Receive Async Request process under Responder/Asynchronous Request Response. The Select Process to Load dialog appears. You can also run the Synchronous Request Response and Notify transactions using the processes provided in this tutorial. TIBCO BusinessConnect EZComm Protocol User’s Guide . Select the Tester tab. Figure 5 Select Process to Load 5. 2. Using TIBCO Designer. Select the Read File >Input Tab >ReadActivityInput and verify that the path given in the filename field is valid. select Projects and then the Receive Async Request process under Responder/Asynchronous Request Response. Run the Tutorial on the Seller Machine 1. 3.26 | Chapter 2 EZComm Tutorial Running the Tutorial In order to see the complete tutorial for the Asynchronous Request Response operation. Click on the green triangle next to the icon Jobs.

Once the request is received from the Buyer machine. select Projects and then the operation Send ASync Request under INITIATOR/Asynchronous Request Response.REQUEST and then send the message RESPONDER. In TIBCO Designer. Click on SendRequest in the operation panel. Select Read File >Input Tab >ReadActivityInput and verify that the path given in the filename field is valid. Run the Tutorial on the Buyer Machine 1. Click Apply and Save. 2. 5. Figure 6 SendRequest (Input) 3. Click Load Selected. TIBCO BusinessConnect EZComm Protocol User’s Guide . as shown inFigure 6. 4.RESPONSE to TIBCO BusinessConnect.Running the Tutorial 27 | 6. Be sure to enter “Buyer” in the field fromTP and “Seller” in the field toTP under the Input Tab. this process will receive the message RESPODER.

Figure 8 Send INITIATOR. 9. Figure 7 Create Job for the Send ASyncRequest operation 10. Select the Tester tab. Click Load selected. 8. Select two processes: — INITIATOR/Asynchronous Request Response/Send Async Request — INITIATOR/Asynchronous Request Response/Receive Response processes.RESPONSE TIBCO BusinessConnect EZComm Protocol User’s Guide . the Receive Response activity will receive the INITIATOR. In the Tester window. 7. This will send an INITIATOR. select the operation Send ASyncRequest and click on the Create Job button.RESPONSE message. At the same time.28 | Chapter 2 EZComm Tutorial 6.REQUEST and Receive INITIATOR.REQUEST to the INITIATOR TIBCO BusinessConnect.

Running the Tutorial 29 | Figure 9 Send Async Request Figure 10 RESPONDER AsynchronousRequestResoponse Process TIBCO BusinessConnect EZComm Protocol User’s Guide .

Select the protocol. Figure 11 Audit Log for the Buyer Machine TIBCO BusinessConnect EZComm Protocol User’s Guide . such as ANY. host and status of the log.30 | Chapter 2 EZComm Tutorial View the Logs On the Buyer Machine 1. In TIBCO Administrator select BusinessConnect>Log Viewer>Audit Logs 2. The complete audit log for the Buyer machine is displayed.

The complete audit log for the Seller machine is displayed. Figure 12 Audit Log for the Seller Machine TIBCO BusinessConnect EZComm Protocol User’s Guide . such as ANY. host and status of the log. Select the protocol.Running the Tutorial 31 | On the Seller Machine 1. In TIBCO Administrator select BusinessConnect>Log Viewer>Audit Logs 2.

32 | Chapter 2 EZComm Tutorial TIBCO BusinessConnect EZComm Protocol User’s Guide .

Topics • • Exchanging URIs. page 34 Populating URIs. page 37 TIBCO BusinessConnect EZComm Protocol User’s Guide .| 33 Chapter 3 EZComm URIs This chapter provides more detailed information about the EZComm URIs.

you have the option of specifying the mail subject. Available transports and their URI formats are listed in this section. since the same information is derived from the internet headers such as AS2 TO/FROM ID and the EMAIL FROM/TO address.1 the only allowed value in an email subject was operationID=<opID>. and the operation ID of the transaction.com When using Email transport. While in TIBCO BusinessConnect EZComm Protocol 5. the subject. For an outgoing HTTP message. File Transport The URI format is file://BaseDir/*.34 | Chapter 3 EZComm URIs Exchanging URIs Partners must exchange Uniform Resource Identifiers (URIs) as part of the business agreement before they can transact e-commerce. then the value defaults to BC/version/Notify.3 allows any value to be specified in the subject: the operationID and other required values will be appended to the subject. Such information becomes redundant and ambiguous if provided in the URI. release 5. Additional information in the URI. If the operation ID is not specified in the subject. the URI. If the subject contains the string operationID=”category/version_number/operation_name” then OperationID is taken as the operation ID for that transaction. is available only for transports other than AS1.* TIBCO BusinessConnect EZComm Protocol User’s Guide . Email Transport The URI format is mailto://username@domain. such as toTP and fromTP. For EZComm. or EMAIL. and the headers can encode information about the from trading partner. EZComm populates trading partner and operation information in the outgoing URI only if the URI ends with /EZComm. such as mailto://john@tibco. for an incoming HTTP message it can interpret these values from an HTTP header or an HTTP URL. Business Connect always populates these values in an HTTP URL. However. in that order. to trading partner. AS2.

Exchanging URIs 35

|

This causes all directories under BaseDir to be checked for files. In order for the file to be handled by EZComm, the document must appear as follows: • Default behavior, such as for the operation BC/version/Notify:
BaseDir/EZComm/TpName

Non-default behavior, for other operations:
BaseDir/EZComm/TpName/Category_OperationID

where BaseDir is a user selected base directory, TpName is the name of the trading partner, Category is the operation category, and OperationID is the operation ID. If OperationID is not provided, then it defaults to BC/version/Notify. A file name can be specified in the file mask field. See TIBCO BusinessConnect Trading Partner Administration Guide, Table 41, Outbound File Transport for information on how to specify the file mask field in File transport. You should provide a file mask *.* for a file. If you, for example, provide a file mask 101.xml, the file that is written out will be 101.xml. If you don’t provide a filer mask for a file, the file will not be picked up by the File transport.

FTP Transport
URI format ftp://server:port/dir. dir can be anything or can be absent. A file name can be specified in the file mask field. See TIBCO BusinessConnect Trading Partner Administration Guide, Table 37, Inbound FTP/S Settings and Table 38, Outbound FTP/S Settings for information on how to specify the file mask field in FTP transport. With EZComm, FTP inbound transactions always defaults to the BC/version/Notify operation. You should provide a file mask *.* for a file. If you, for example, provide a file mask 101.xml, the file that is written out will be 101.xml. If you don’t provide a filer mask for a file, the file will not be picked up by the FTP transport.

TIBCO BusinessConnect EZComm Protocol User’s Guide

36

| Chapter 3

EZComm URIs

HTTP/S Transport
URI for the HTTP Transport URI format: http://server:port/EZComm
Example: http://www.gizmo.com:555/EZComm

For HTTP transport, the partner name, host name, and operation ID can be specified as parameters in the request URI or as transport headers. The parameters or headers EZComm expects are as follows: • • • •
fromTp This is a required field for the incoming message. toTp If this parameter is missing, it defaults to the default host. operationID If this parameter is missing, it defaults to

BC/version_number/Notify.
fileName

If you specify the parameters in the URI, the format is:

http://host:port/EZComm?fromTp=fromTP&toTp=toTP&operationID=opI D&fileName=fileName

The fileName feature is not supported for the AS2-HTTP transport.

URI for the HTTPS Transport URI format: https://server:port/EZComm
Example: https://www.gizmo.com:555/EZComm

TIBCO BusinessConnect EZComm Protocol User’s Guide

Populating URIs 37

|

Populating URIs
The AS2 specification does not support custom headers.

URIs are populated as follows: • On the outbound side, URI fields have precedence over the headers. EZComm 5.3 populates the URIs with the required fields, such as fromTp, toTp, operationID, transactinID, and so on. If these fields are already specified in the GUI, they will be replaced. This is a change in behavior from the release 5.1 , where the values specified in the GUI are not altered. • • EZComm 5.3 does not populate headers any more. On the inbound side, if values are specified in headers as well as URI places, the transport headers take precedence over the request URI values.

Special Handling for migrated EZComm 5.1 Operations The operations migrated from EZComm 5.1 will have an Empty version number. In order to preserve the backward compatibility with EZComm 5.1, the values fromTp, toTp and others will be handled in the following way for the outbound messages: • • If the values are not specified in the GUI, they will be updated in the transport headers (same as in EZComm 5.1) URI precedence is still honored, but the values specified in GUI will be replaced with the current transaction values.

Specify Subjects For the HTTP transport you also have the option of specifying the subject. If the subject contains a string operationID=”BC/Version/OperationID”, then BC/Version/OperationID is taken as the operationID for that transaction. The precedence by which the operationID is determined is as follows: header, URI, and subject: header has the highest precedence and subject the lowest

TIBCO BusinessConnect EZComm Protocol User’s Guide

38 | Chapter 3 EZComm URIs TIBCO BusinessConnect EZComm Protocol User’s Guide .

| 39 Chapter 4 Managing EZComm Operations This chapter describes how to manage the EZComm operations. page 45 Configuring EZComm Operations. Topics • • • • • Overview. page 40 Notify Operation. page 44 Asynchronous Request Response Operation. page 43 Synchronous Request Response Operation. page 47 TIBCO BusinessConnect EZComm Protocol User’s Guide .

but it instead indicates if there is a change in the uploaded file object. TIBCO BusinessConnect EZComm Protocol User’s Guide . See EZComm Private Messages. About EZComm Operations Public messages are exchanged over the Internet between TIBCO BusinessConnect and another B2B installation. The following message types are supported in TIBCO BusinessConnect EZComm Protocol: • • • Notify Operation Synchronous Request Response Operation Asynchronous Request Response Operation About Schema Validation in EZComm Schema validation in TIBCO BusinessConnect EZComm Protocol is performed based on the following: • • • Schema type: XSD or DTD Direction of messages Whether the validation is done for a request or for a response Caching of Schemas The referenced schema is updated in the validator cache during runtime validation. See also Validation Schema Name for more information on how to choose which schema to use: XSD od DTD. This means that the TIBCO BusinessConnect configuration store does not scan the referenced object each time the validation occurs.40 | Chapter 4 Managing EZComm Operations Overview The exchange of business documents is known as the process flow. you will not observe any schema changes in the referenced object but you will see the change on the reference instead. two types of messages are exchanged: • • Public messages or operations Private messages. You need to update the reference in the GUI — re-save the schema reference — and the new referenced object will be updated in the cache. In any TIBCO BusinessConnect process flow. in the same way as if it was saved through the GUI. When a schema is used by reference.

For each message. all the incoming private process messages will be checked for duplicate detection. A message is determined to be a duplicate based on the certain message field values such as transactionID. • • • • Payload: plainRequest. inputFileName (file content) Trading partner host name Operation ID Host name TIBCO BusinessConnect EZComm Protocol User’s Guide . all incoming requests are checked for duplicates. while it is up to the private process to take further action. The following fields from the private process will be used in calculating the message digest for duplicate detection for outbound requests: • TransactionID received from the user When the outbound File poller initiates a transaction. and so on. the private process will be notified by setting the duplicate field to true. Outbound Duplicate Detection Criteria For asynchronous and synchronous responses. If any subsequent message has the same message digest. binaryRequest. the transactionID will not be used for calculating the message digest. outbound duplicate detection is not supported (only inbound duplicate detection is supported). If a request is found to be a duplicate. For the inbound requests. TIBCO BusinessConnect creates a message digest from these predetermined fields and stores it in a table. operationID . it is considered to be a duplicate message.Overview 41 | Duplicate Message Detection EZComm allows both incoming and outgoing public messages to be verified for duplicates. If requested by the user. If the duplicate detection for the outbound messages is enabled. Both the inbound and outbound requests for a trading partner can be configured for the duplicate detection. the transaction is terminated and an error advisory is sent to the private process.

42 | Chapter 4 Managing EZComm Operations Inbound Duplicate Detection Criteria For asynchronous and synchronous responses. TIBCO BusinessConnect EZComm Protocol User’s Guide . the duplicate detection entry from the table BC_DUP will be deleted. The following values from the incoming request will be used in calculating the message digest for duplicate detection for inbound requests. • • • Payload Trading partner name Operation ID If an error occurs during the transaction processing. only inbound duplicate detection is supported.

REQUEST message to the Responder private process. 3. FTPS. See Initiator Inbound Response — BusinessConnect to Private Process. Supported Transports for the Notify Operation are: HTTP. 4. FTP. The Initiator TIBCO BusinessConnect retrieves relevant information and sends the message to the Responder TIBCO BusinessConnect. SSHFTP. AS1. 2. Its not capable of receiving the response from the trading partner. The Responder TIBCO BusinessConnect then forwards the message to the local private process. The Initiator private process sends a message to the Initiator TIBCO BusinessConnect. The Initiator TIBCO BusinessConnect sends an INITIATOR. and AS2. which sends a RESPONDER. TIBCO BusinessConnect EZComm Protocol User’s Guide .Notify Operation 43 | Notify Operation Notify is a one way operation: it can simply send a document to the trading partner and receive the acknowledgement. The Responder TIBCO BusinessConnect considers the operation complete. The operation flow in a Notify operation is presented in Figure 13. Figure 13 Notify Operation Initiator Request Initiator Private Process Internet Initiator Response Error Initiator BusinessConnect Responder BusinessConnect Error Responder Request Responder Private Process The following process flow occurs with the Notify operation: 1. The Responder TIBCO BusinessConnect immediately sends a transport response (acknowledgment) to the Initiator TIBCO BusinessConnect on the same channel as the Initiator business request. This message is sent independently from the Responder TIBCO BusinessConnect. File. See Responder Inbound Request — BusinessConnect to Private Process. HTTPSCA. 5. Email. HTTPS.RESPONSE message to the private process.

It doesn't indicate whether the trading partner has received it or not. the Responder TIBCO BusinessConnect times out and ends the transaction. The operation flow is presented in Figure 14. 6. The Responder TIBCO BusinessConnect sends the request to the Responder private process. Resending of Responder. and the connection is closed. It waits until the response is received and suspends any further processing for that request. 7.Response for the Synchronous Request Response operation is not supported for EZComm. The Responder acknowledgement will be sent to the private process indicating whether the response has been forwarded to the trading partner. a timeout error advisory is sent. Supported transports are: HTTP. Upon receiving the response from the Responder.44 | Chapter 4 Managing EZComm Operations Synchronous Request Response Operation The Synchronous Request Response operation can send a document to the trading partner and wait for a response. 4. 5. This operation is used to send documents to trading partners and require response for further processing to proceed. Figure 14 Synchronous Request-Response Operation Responder Request Responder Response 3 Internet Initiator 7 Response Initiator BusinessConnect Initiator Private Process Initiator Request 1 2 4 Responder BusinessConnect Responder Private Process 5 6 Responder Acknowledgement 1. TIBCO BusinessConnect EZComm Protocol User’s Guide .Request and Responder. the message will be rejected and an error will be thrown. 2. The Responder private process send a response. 3. an audit log entry is generated. The response is forwarded to the Initiator TIBCO BusinessConnect. the Initiator sends the Initiator Response message. HTTPS. The Initiator private process sends the request to the Initiator. If the response from the private process arrives after this time out. and HTTPSCA. The Initiator sends the request to the Responder and waits for the response until the timeout specified in the appropriate transport has expired. If the Initiator times out. If the private process doesn't respond on time.

the Initiator will send the Initiator Response message. Figure 15 Tutorial: Asynchronous Request Response Operation Responder Request Responder Response 3 Internet Initiator 7 Response Initiator BusinessConnect Initiator Private Process Initiator Request 1 2 4 Responder BusinessConnect Responder Private Process 5 6 Responder Acknowledgement The following process flow occurs: 1. the Responder TIBCO BusinessConnect will time out and end the transaction. 2. It allows further processing. 5. 7. The Responder private process sends the response. Figure 15 shows what happens when you run an asynchronous Request Response operation. If the response from the Responder private process arrives after the timeout. 6.Asynchronous Request Response Operation 45 | Asynchronous Request Response Operation The asynchronous Request Response operation can send a document to the trading partner and wait for a response. 4. The Initiator TIBCO BusinessConnect sends the request to the Responder and waits for the response until the timeout specified in the operation has expired. If the private process doesn't respond on time. After receiving the response from the Responder. the response is forwarded to the Initiator TIBCO BusinessConnect. the message will be rejected and an error advisory will be sent. The Initiator private process sends a request to the Initiator TIBCO BusinessConnect. If the response from Responder private process is received on time. 3. The Responder TIBCO BusinessConnect sends a request to the Responder private process. irrespective of the arrival of the response from the partner. TIBCO BusinessConnect EZComm Protocol User’s Guide . A Responder acknowledgement will be sent to the Responder private process indicating whether the response has been forwarded to the trading partner.

there won’t be any corresponding request present. an audit log entry will be generated and a timeout error advisory will be sent out. an error advisory will be published.Response is not supported for the asynchronous Request Response operation. It can generate a response from the private process that will not be sent to the trading partner. Supported transports are: HTTP. and an internal system error will be sent to the partner.46 | Chapter 4 Managing EZComm Operations If the Initiator TIBCO BusinessConnect times out. When the response arrives at a later time.Request is supported for the asynchronous Request Response operation. In this case. the advisory will be rejected. HTTPSCA. and AS1_EMAIL. In this case. Email. TIBCO BusinessConnect EZComm Protocol User’s Guide . a proper error message and an audit log will be generated. HTTPS. Resending of Responder. the request will be cancelled. AS2_HTTP. Resending of Responder.

perform these steps: 1. 3. In the New Category dialog. Select the radio button associated with EZComm. it is always available on this list. Since EZComm gets installed with TIBCO BusinessConnect. The Edit Operations: EZComm dialog appears. type a brief description for this category (optional). 2. 2. Click Save. 1. 3. Click Edit. do the following: — In the Name field. Click New Category. TIBCO BusinessConnect EZComm Protocol User’s Guide . Figure 16 Configure New Operation for EZComm Add New Category Category is used to group operations based on their type. In the left panel under TIBCO BusinessConnect. 4. Select EZComm from the Protocol dropdown list. click the link Operations Editor. Any other protocol must be installed first. type a category name (required) — In the Description field.Configuring EZComm Operations 47 | Configuring EZComm Operations To configure an EZComm operation.

For example. 3. To configure an EZComm 5. The New Operation dialog appears. TIBCO BusinessConnect EZComm Protocol User’s Guide . 1.48 | Chapter 4 Managing EZComm Operations Add New Version Version is used to allow various subgroups of operations. which does not use the version subgroups for identifying an operation. such as Notify only. the reserved Empty version will be omitted when generating the operation ID identifier for the public message. Figure 17 New Operation Dialog 2. Each version can contain same or different operation sets. MyCategory/Empty/MyOperation will be converted into MyCategory/MyOperation on the public message to interoperate with the EZComm 5. type a brief description for this version (optional). In the New Version dialog.3 operation for exchanging documents with an existing EZComm 5. do the following: — In the Name field. and so on.1 system. Add New Operation Operations are added to a specific version. Click OK. At runtime. With the radio button for the new version selected. or Notify and Synchronous Request Response. specify the reserved version Empty for interoperability. click New Version.1 system. Select one operation from the Operation Type dropdown list. With the radio button for the new category selected. 2. click New Operation. Click Save. 1. 3. type a version name (required) — In the Description field.

This checkbox should be selected in the following cases: • • Initiator needs that the request to the partner be validated Responder needs that the response be validated Click Save. Note This flag is used only for the Responder. will be validated. either the request or response will be validated. This should be selected if the Initiator needs the response from the partner to be validated. the Responder private process will receive the message in tibXML format. TIBCO BusinessConnect EZComm Protocol User’s Guide . Outbound Validate Message When selected. If selected. which means that only the Enter/Select Name of the operation (required) Brief description for the operation Publish tibXML Private Process Message ResponderRequest message will be published based on this flag.Configuring EZComm Operations 49 | The Operation dialog appears with the following tabs: — Operation Tab — Request Action Tab — Response Action Tab Operation Tab In the Operation tab. Table 7 Operation Tab Field Name Description Inbound Validate Message When selected. if the Responder needs the request to be validated. enter information according to Table 7. any inbound message (either request or response).

In the Change File dialog. a.xsd file you wish to use. Used only for HTTP transport. In this tutorial. select one of the following two choice from the dropdown list: • • File Reference If you select file reference. enter information according to Table 8. c. File selected here should match the validation type selected in the field XML Document Validation. Click Open. Table 8 Request Action Tab Field Name Description Direction Validation Schema Name Enter/Select Name of the request action Brief description for the request action Initiator to Responder (pre-defined) Either XSD or DTD schema can be defined. this option will sign the outgoing messages and force the incoming messages to be signed. the XSD validation is used. If selected. Click on the change link.50 | Chapter 4 Managing EZComm Operations Request Action Tab In the Request Action tab. In this tutorial. the new Change File dialog will appear. it is located in the directory BC_home\samples\EZComm\sampleXML\xsd\ Select the schema document (101.xml). Require Digital Signature Require Content Encryption Used only for HTTP transport. Click OK. To select the schema document: 1. Uploaded File If you select uploaded file. This schema document is associated with the XML document used for validation (101. enter the path to the . Click the Browse button and navigate to the directory containing the schema file.xsd). Note: EZComm supports XSD and DTD schema validation. If selected. this option will encrypt the outgoing messages and force the incoming messages to be encrypted. b. 2. TIBCO BusinessConnect EZComm Protocol User’s Guide .

The default is 3600 seconds. this option will encrypt the outgoing messages and force the incoming messages to be encrypted. enter information according to Table 9. see Validation Schema Name. If selected. Require Digital Signature Require Content Encryption Used only for HTTP transport. File selected here should match the validation type selected in the field XML Document Validation.Configuring EZComm Operations 51 | Table 8 Request Action Tab Field Wait time for Response (seconds) Enter/Select This field is available only for the asynchronous Request-Response operation. Table 9 Response Action Tab: Synchronous and Asynchronous Request-Response Only Field Name Description Direction Validation Schema Name Enter/Select Name of the response action Brief description for the response action Responder to Initiator (pre-defined) Either XSD or DTD schema can be defined. Click Save. For more information on how to select the schema document. Response Action Tab This tab is not available for the Notify operation. Root XML element name. In the Edit Operation dialog. which is the top-level XML element in the document. For BC Palette use only XML Document Validation Root XML Element Name Select XSD or DTD from the dropdown list. It is only required if you are going to use the TIBCO BusinessConnect palette. Used only for HTTP transport. If selected. TIBCO BusinessConnect EZComm Protocol User’s Guide . this option will sign the outgoing messages and force the incoming messages to be signed.

52 | Chapter 4 Managing EZComm Operations Table 9 Response Action Tab: Synchronous and Asynchronous Request-Response Only Field Private Process Wait (seconds) Enter/Select Specifies the amount of time the Responder waits for the response from the private process. The default is 3600 seconds (60 minutes). Click Save. It is only required if you are going to use the TIBCO BusinessConnect palette. TIBCO BusinessConnect EZComm Protocol User’s Guide . Root XML element name. which is the top-level XML element in the document. For BC Palette use only XML Document Validation Root XML Element Name Select XSD or DTD from the dropdown list.

page 54 TIBCO BusinessConnect EZComm Protocol User’s Guide .| 53 Chapter 5 Managing Properties This chapter explains how to add and remove EZComm properties. Topics • Managing EZComm Properties.

perform these steps: 1. Add a Property To add a property. or integer. Click Save. 3.preserveSubject When sending email messages for EMAIL and AS1 transports.notify. users can send their own email subject to trading partners.email.54 | Chapter 5 Managing Properties Managing EZComm Properties You can add. perform these steps: 1. Type a description of the new property in the Description field.email. Type a name for the property in the Property Name field. 5. TIBCO BusinessConnect EZComm Protocol User’s Guide . Type the name of the property you want to delete and click OK.preserveSubject. 4. Select EZComm and then click Add. Set Up the Property ezcomm. it is possible to preserve the subject specified by the user on EMAIL and AS1 transports by enabling the EZComm property ezcomm. In TIBCO Administrator. Keep in mind that you may remove only user defined properties. 3. However. and that default properties should not be removed. string. 6. TIBCO BusinessConnect EZComm Protocol will generate the email subject based on operation and transaction IDs. select TIBCO BusinessConnect>System Settings>Installed Protocols.notify. 2. or remove EZComm properties using the Edit Plug-in Properties dialog. Select EZComm and then click Delete. Select a data type from the Property Type dropdown list: boolean. Select TIBCO BusinessConnect>System Settings>Installed Protocols. change. 2. Delete a Property To remove a property. By setting this property to true.

select TIBCO BusinessConnect>System Settings>Installed Protocols. In TIBCO Administrator. Set true for the Boolean property ezcomm. Click Save.preserveSubject 4.email.notify.notify.preserveSubject can be set as follows: 1.email. TIBCO BusinessConnect EZComm Protocol User’s Guide .Managing EZComm Properties 55 | The property ezcomm. Select EZComm plugin 3. 2.

56 | Chapter 5 Managing Properties TIBCO BusinessConnect EZComm Protocol User’s Guide .

| 57 Chapter 6 Setting Up Trading Hosts and Partners This chapter explains how to set up trading hosts and partners for TIBCO BusinessConnect EZComm Protocol. Topics • • Configuring EZComm for a Host. page 60 TIBCO BusinessConnect EZComm Protocol User’s Guide . page 58 Configuring EZComm for a Partner.

In the Edit Host Participant dialog. 3. select the Protocols tab. Click the host link. Table 10 Host Settings: General Tab Field AS2 Identifier) Description An identifier to use in the AS2-From header field of the HTTP message. separated by semicolon or by a comma. Select Host in the Participant Type dropdown list. Configuring HTTP/S for a Trading Partner: General Tab. Select BusinessConnect>Participants.58 | Chapter 6 Setting Up Trading Hosts and Partners Configuring EZComm for a Host To configure the default host in a business agreement do the following: Configure the Initiator Default Host 1. 6. Table 28. 2. 8. TIBCO BusinessConnect EZComm Protocol User’s Guide . 11. Select or enter the information according to Table 10. For more details. Click Apply. For more information about AS2 Identifiers. Click the Participant Wizard button. see TIBCO BusinessConnect Server Administrator’s Guide. 7. 9. Disabling Session Cache for HTTPS. select the Active checkbox. 4. This identifier should be mutually agreed upon between trading partners. In the Edit Host Participant dialog. Click Save. Valid Email Address List Enter the list of valid email addresses for this participant. 5. see TIBCO BusinessConnect Trading Partner Administration Guide. Click Finish. Type the host’s name in the Participant Name field. Click on the EZComm link. 10.

Click the General Settings link. 3.Configuring EZComm for a Host 59 | Assign Default Host for Initiator 1. TIBCO BusinessConnect EZComm Protocol User’s Guide . Click Save. The Edit System Settings: General Settings dialog appears. Select BusinessConnect>System Settings in the left panel. Select the appropriate host in the Default Host dropdown list. 4. 2.

The Edit Enabled Protocol dialog appears. 2. with the following tabs: — General Tab — Transports Tab TIBCO BusinessConnect EZComm Protocol User’s Guide . Click Finish. 5. 5. Click the partner link. 6. Click Enable. In the Edit Partner Participant dialog. Select BusinessConnect>Participants. Click OK. Click Apply. Click the Participant Wizard button. The EZComm protocol is now in the Protocol Name list. 4. 3. 4. Click on the EZComm link. Both the Buyer (Host) and Seller (Partner) now appear in the Participants panel. 7.60 | Chapter 6 Setting Up Trading Hosts and Partners Configuring EZComm for a Partner To configure a partner in a business agreement do the following: 1. In the Edit Host Participant dialog. Enable Protocol for Initiator Partner 1. 2. The dialog with installed protocols appears. 8. Select the checkbox next to EZComm. Select Partner in the Participant Type dropdown list. 3. select the Protocols tab. select the Active checkbox. Type partner’s name in the Participant Name field.

then the name of the file is passed on to the Responder in an HTTP header called filename. For more information. Allow override of filename via HTTP parameter If this checkbox is selected. Configuring HTTP/S for a Trading Partner: General Tab. all incoming private process messages and the outgoing responses are checked for duplicate detection. For more information about AS2 Identifiers. For more details. Disabling Session Cache for HTTPS. see TIBCO BusinessConnect Trading Partner Administration Guide. the duplicate field in the private process message will be set to true. Click Save. Duplicate Detection for Inbound Use tibXML Packaging TIBCO BusinessConnect EZComm Protocol User’s Guide . see TIBCO BusinessConnect Trading Partner Administration Guide. Valid Email Address List Enter the list of valid email addresses for this participant. This identifier should be mutually agreed upon between trading partners. If a request is found to be a duplicate. separated by semicolon or by a comma. and a file reference is being passed from the private process. Duplicate Detection for Outbound If selected. If any duplicates are found.Configuring EZComm for a Partner 61 | General Tab Select or enter information as explained in Table 11. This option is used for forcing the packaging of the outbound public message to a tibXML public message format. the transaction is terminated and an error advisory is sent. All incoming requests for Responder and incoming responses for Initiator will be checked for duplicates. Table 28. Table 11 Partner Settings: General Tab Field AS2 Identifier Description An identifier to use in the AS2-From header field of the HTTP message. see Allow override of filename via HTTP parameter (applies only to HTTP/S transports). See Use tibXML Packaging for more information.

see TIBCO BusinessConnect Trading Partner Administration Guide.62 | Chapter 6 Setting Up Trading Hosts and Partners Transports Tab To add a transport for the partner. SSHFTP Transport Chapter 16. File Transport 3. HTTP. and then refer to the appropriate chapter for the transport such as: • • • • • Chapter 10. Click on the Transports tab. do the following: 1. Email Transport Chapter 14. and HTTPSCA Transports Chapter 13.hostname:6700/EZComm. Enter data for the new transport as explained in Table 1. Click Add. HTTPS. Table 12 New Transport for the Partner Field Transport Name Transport Type Description Enter the name for the transport (required) Select the transport type from the dropdown list. TIBCO BusinessConnect EZComm Protocol User’s Guide . Define URL To define the URL for the partner. FTP and FTPS Transports Chapter 15. 2. Click OK. enter the following information: URL (required): www. To configure a specific transport for the partner.

page 65 Operation Bindings Tab. Topics • • • • • • Adding a New Business Agreement. page 64 Configuring Agreement Protocol Binding for EZComm. page 72 Show Advanced Tab on page 73 TIBCO BusinessConnect EZComm Protocol User’s Guide .| 63 Chapter 7 Configuring Business Agreements This chapter explains how to configure business agreements and protocol bindings for TIBCO BusinessConnect EZComm Protocol. page 71 Transports Tab. page 66 Document Security Tab.

Verify that EZComm appears in the Protocols column for both trading partners between which you wish to configure a business agreement.64 | Chapter 7 Configuring Business Agreements Adding a New Business Agreement After both trading partners are configured. This will make the agreement valid immediately. This date has to be later than the start date. 2. 4. 6. 1. If EZComm is missing. you will now configure their business agreement. The New Agreement. If you wish to make the agreement valid for a certain time period. Select BusinessConnect>Business Agreements. Select a partner from the Partner Party list 5. — Use the End Date dropdown lists to specify the stop date. return back to Enable Protocol for Initiator Partner and enable the EZComm protocol. The New Agreement dialog appears. Click the New button. do the following: — Use the Start Date dropdown lists to specify the start date. Click OK. general dialog appears. TIBCO BusinessConnect EZComm Protocol User’s Guide . 3. Confirm that the Valid checkbox is selected. Select a host from the Host Party list.

Click the EZComm link in the Agreement Protocol Binding list. Click OK. 3. select the checkmark next to EZComm. follow these steps: 1. click Add Protocol Bindings. The New Agreement dialog appears. 2. 4. The following tabs for configuring protocol binding options are available: — Operation Bindings Tab — Document Security Tab — Transports Tab — Show Advanced Tab TIBCO BusinessConnect EZComm Protocol User’s Guide . In the Select Protocol dialog. In the New Agreement dialog.Configuring Agreement Protocol Binding for EZComm 65 | Configuring Agreement Protocol Binding for EZComm To configure EZComm agreement protocol bindings.

The following tabs for configuring options are available: • • • Operation Settings Tab Action Settings Tab. The Host ’X’ Can Initiate and Partner ’Y’ Can Initiate areas list the activities that the host/partner can initiate and the partner/host can respond to. Transports Tab TIBCO BusinessConnect EZComm Protocol User’s Guide . click Add Operation Binding. Edit Operation Bindings for the Host Click the operation in the panel Host can initiate. you don’t need to specify operation bindings that the host or partner can initiate. Non-Repudiation Logging The non-repudiation log is used to provide proof of the delivery of messages. as explained in Enter information according to Table 3. 1. For more details. Click OK. Click the topmost (+) to expand the operation tree and select the operation. as explained in Enter information according to Table 3. Table 13 Edit Protocol Binding: Operation Binding Tab Field Allow All Operations Description This checkbox is selected by default. 3. see TIBCO BusinessConnect Concepts. 2. If you leave it selected. 4. Enter information according to Table 13. Non-Repudiation. In the Host can initiate section. If the checkbox is cleared..66 | Chapter 7 Configuring Business Agreements Operation Bindings Tab Use the Operations Binding tab to configure the EZCOmm operations that each participant in a business agreement can initiate and respond to. you need to define the specific operation bindings.. The selected operation appears in the Operation Name list.

See Publish tibXML Private Process Messages for more information.Operation Bindings Tab 67 | Operation Settings Tab Override the operation settings using Table 14. as explained in Import the Tutorial. If selected. Such overriding does not apply to the outbound responses of an Asynchronous Request Response operation in cases when the BusinessConnect server acts as the Responder. an inbound message (either request or response) will be validated. Publish tibXML Private Process Message Outbound Validate Message When selected. the transport for sending an outbound document can be overridden for all operation types bound in this section. Note When a BusinessConnect sever acts as the Initiator. TIBCO BusinessConnect EZComm Protocol User’s Guide . Inbound Validate Message When selected. Table 14 Override Outbound Settings: Operation Settings Tab (All Operations) Field Override Operation Settings Description Select the checkbox to override the operation settings for this operation. if the Responder needs the request to be validated. either the request or response will be validated. This should be selected if the Initiator needs the response from the partner to be validated. This checkbox should be selected in the following cases: • • Initiator needs that the request to the partner be validated Responder needs that the response be validated Click Save or Cancel (if no changes have been made). These settings have been previously configured. private process on the Responder side will receive the message in tibXML format.

(Notify operation only) Select to override the originally configured signature settings for the host. Wait Time for Response (seconds) Override Outbound Transports Primary Transport Select any of the transports previously configured for the partner. (Notify operation only) Select to override the originally configured encryption settings for the host. See tibXML Passthrough for more information. Click Save or Cancel (if no changes have been made). Table 16 Override Outbound Settings: Transports Tab (All Operations) Field Override Transports Description Select to override the originally configured transport for the host. TIBCO BusinessConnect EZComm Protocol User’s Guide . See Add Transport for Initiator Partner for more details. Transports Tab Configure transport settings using Table 16. Table 15 Override Outbound Settings: Actions Tab (Notify and Asynchronous Request-Response Operations) Field Override Action Settings Require Digital Signature Require Content Encryption tibXML Passthrough Description Select to override the originally configured action settings for the host. The default is 3600 seconds (60 minutes). (Notify operation only) Used to replicate the tibXML passthrough feature in EZComm. Click Save or Cancel (if no changes have been made).68 | Chapter 7 Configuring Business Agreements Action Settings Tab. (Asynchronous Request-Response operation only) Select to override the originally configured Wait time for the Initiator. Override the action settings using Table 15.

TIBCO BusinessConnect EZComm Protocol User’s Guide . as explained in Import the Tutorial. See Publish tibXML Private Process Messages for more information. These settings have been previously configured. Description Select the checkbox to override the operation settings for this operation. This checkbox should be selected in the following cases: • • Initiator needs that the request to the partner be validated Responder needs that the response be validated Click Save or Cancel (if no changes have been made). if the Responder needs the request to be validated. an inbound message (either request or response) will be validated.Operation Bindings Tab 69 | Edit Operation Bindings for a Partner When a BusinessConnect sever acts as the Responder. Click the operation in the panel Partner can initiate. This should be selected if the Initiator needs the response from the partner to be validated. Table 17 Override Inbound Settings: Operation Settings Tab (All Operations) Field Override Operation Settings Inbound Validate Message When selected. either the request or response will be validated. the transport for sending an outbound document can only be overridden when sending the response for asynchronous operation types bound in this section. private process on the responder side will receive the message in tibXML format. If selected. The following tabs for configuring options are available: • • • Operation Settings Tab Action Settings Tab Transports Tab Operation Settings Tab Override the operation settings using Table 17. Publish tibXML Private Process Message Outbound Validate Message When selected.

Click Save or Cancel (if no changes have been made). Transports Tab Override transport settings using Table 19. The default is 3600 seconds (60 minutes). Select to override the originally configured Wait time (amount of time the Responder waits for the response from the private process). Override Outbound Transports Primary Transport Select any of the transports previously configured for the partner. TIBCO BusinessConnect EZComm Protocol User’s Guide .70 | Chapter 7 Configuring Business Agreements Action Settings Tab To configure either the Synchronous or Asynchronous Request Response operation. click on the Action Settings tab and override the action settings using Table 18. Note For the Synchronous Request Response operation. this option is invalid. Click Save or Cancel (if no changes have been made). Table 18 Override Inbound Settings: Actions Tab (Synchronous and Asynchronous Request Response) Field Override Action Settings Private Process Wait (seconds) Description Select to override the originally configured action settings for the partner. Table 19 Override Inbound Settings: Transports Tab (All Operations) Field Override Transports Description Select to override the originally configured transport for the partner.

the original credential is tried. see TIBCO BusinessConnect Trading Partner Administration Guide. or HTTPSCA transports.Document Security Tab 71 | Document Security Tab To learn about this topic. Chapter 8. If this fails. Receiving Signed or Encrypted Messages When receiving signed or encrypted messages from a trading partner over HTTP. you will use shadow credentials during overlay and shadow credential period to sign or encrypt these messages. TIBCO BusinessConnect EZComm Protocol User’s Guide . or HTTPSCA transports. Document Security Tab. Shadow Credential Usage for EZComm Sending Signed or Encrypted Messages When sending signed or encrypted messages over HTTP. HTTPS. HTTPS. credentials are picked during the overlay period in the following order: a. Shadow credential is tried for authentication or decryption b. See also TIBCO BusinessConnect Concepts. only the shadow credential is tried. Security. For the shadow credential period.

Edit Protocol Bindings: Transports Tab. For more information. Table 7. HTTPS CA Client Authentication Identity for SSHFTP For more information. Table 7. Table 7. FTPS. or trading partner to host. See Add Transport for Initiator Partner for more details. Allowed Inbound Transports for Partner (list of configured partner transports) Select the appropriate checkboxes to allow certain inbound transports for the partner. see TIBCO BusinessConnect Trading Partner Administration Guide. Edit Protocol Bindings: Transports Tab. The bottom section is used for specifying transport information for the inbound. Edit Protocol Bindings: Transports Tab.72 | Chapter 7 Configuring Business Agreements Transports Tab The Transports tab is divided in two sections as follows: • • The top section is used for specifying transport information for the outbound. For more information. Click Save twice. or host to trading partner. see TIBCO BusinessConnect Trading Partner Administration Guide. Table 7. direction. see TIBCO BusinessConnect Trading Partner Administration Guide. TIBCO BusinessConnect EZComm Protocol User’s Guide . AS2 Remote Server Certificate Client Authentication Identity for HTTPS. Table 20 Configure Transports for the Host Field Description Outbound Transports for Host Primary Transport Select the outbound transport that was previously configured. AS2 MDN Async Reply Transport Select any of the configured transports. Edit Protocol Bindings: Transports Tab. see TIBCO BusinessConnect Trading Partner Administration Guide. For more information. Configure transports for the host according to Table 20. direction.

Show Advanced Tab 73 | Show Advanced Tab The Show Advanced button in the Edit Protocol Bindings dialog allows you to configure additional settings for the host in a business agreement. AS2 Identifier Select an AS2 identity that will be used to override the default AS2 identity. click the button Hide Advanced. 3. 1. 2. TIBCO BusinessConnect EZComm Protocol User’s Guide . Set the Host’s AS2 Identifier for a Protocol TIBCO BusinessConnect Trading Partner Administration Guide. Enter or select information according to Table 21. Disabling Session Cache for HTTPS If you don’t select the checkbox Override Settings. the default AS2 identity for the host will remain valid. The Edit Protocol Bindings dialog appears with two additional tabs: Host’s Configuration and Partner’s Configuration. Table 21 Edit Protocol Bindings: Advanced Settings for Host Field Override Settings Description If you select the checkbox Override Settings. Click Save. Click on Show Advanced. 2. To hide the Host’s and Partner’s Configuration tabs. Select the tab representing the host. do the following: 1. this will override the values set on the host level: the AS2 Identity selected on the AS2 Identifier dropdown list will be used to override the default AS2 identity for the host configured using the procedure described in the following sections: • • TIBCO BusinessConnect Trading Partner Administration Guide. Override Settings for the Host To override general settings for the host.

AS2 Identifier Allow override of filename via HTTP parameter (applies only to HTTP/S transports) Select an AS2 identity that will be used to override the default AS2 identity. this will override the values set on the partner level: the AS2 Identity selected on the AS2 Identifier dropdown list will be used to override the default AS2 identity for the host configured using the procedure described in the following sections: • • TIBCO BusinessConnect Trading Partner Administration Guide. This file is created in the shared directory located under the partner’s name directory. Set the Host’s AS2 Identifier for a Protocol TIBCO BusinessConnect Trading Partner Administration Guide. do the following: 1. Each partner has this checkbox. 3. Note This feature is fully supported for the Notify and Asynchronous Request Response operations. TIBCO BusinessConnect EZComm Protocol User’s Guide . Disabling Session Cache for HTTPS If you don’t select the checkbox Override Settings. See Use tibXML Packaging for more information. The file size is irrelevant in this case. Enter or select information according to Table 22. 2. and a file reference is being passed from the private process. the message will be written to a file fileName. Select the tab representing the partner. the default AS2 identity for the partner will remain valid. For the Synchronous Request Response operations. Table 22 Edit Protocol Binding: Advanced Settings for Partner Field Override Settings Description If you select the checkbox Override Settings.74 | Chapter 7 Configuring Business Agreements Override Settings for the Partner To override general settings for the partner. then the name of the file is passed on to the Responder in an HTTP header called filename. Use tibXML Packaging This option is used for forcing the packaging of the outbound public message to a tibXML public message format. If this checkbox is selected. only request can send the filename to the partner while the partner cannot send the filename on the response: a synchronous response cannot be written to the file that the partner wants. Click Save. If it is selected and there is a fileName field in the HTTP message header or in QueryString (in that order).

| 75 Chapter 8 EZComm Private Messages This chapter describes how to configure the EZComm private messages. page 76 Initiator Messages. page 87 TIBCO BusinessConnect EZComm Protocol User’s Guide . page 77 Responder Messages. page 81 General Messages. Topics • • • • • Overview. page 86 Multiple Attachments.

The TIBCO BusinessConnect server has two major roles: • • Initiator This role receives request messages from private processes and transmits the EZComm documents to your trading partners. or notification document. On the Responder side. two types of messages are exchanged: • • Private messages Public messages See Managing EZComm Operations About EZComm Private Messages Private messages are exchanged between a private process and the local TIBCO BusinessConnect installation. the private process receives an EZComm request and converts it to internal company format. The message fields are packaged in the ^data^ control tag as part of the aeRvMsg format. Private Process Configuration for more information. In any TIBCO BusinessConnect process flow. Private messages can contain a request. TIBCO BusinessConnect EZComm Protocol User’s Guide . Responder The following sections describe the messages used for private request and response document exchange in TIBCO BusinessConnect EZComm Protocol. response. the private process converts internal data to an EZComm notification document. • • On the Initiator side. The private process handles conversion from internal to public data and back.76 | Chapter 8 EZComm Private Messages Overview The exchange of business documents is known as the process flow. See TIBCO BusinessConnect Trading Partner Administration Guide. Chapter 7. You can generate EZComm private messages from TIBCO ActiveMatrix BusinessWorks private processes that use the TIBCO BusinessConnect Palette. This role receives EZComm documents from trading partners and submits the converted request messages to their private processes.

BC. the plainRequest node will be used.Initiator Messages 77 | Initiator Messages Initiator Outbound Request — Private Process to TIBCO BusinessConnect The Initiator private process uses this message to handle outbound requests.INITIATOR.installation.EZComm.REQUEST Table 23 Field fromTp toTp Private Message: InitiatorRequest Type String String String String Required No Yes No Yes Description Name of the trading partner initiating the transaction Name of the trading partner receiving the transaction A three-part ID of the form: category/version_number/operation_Name An ID unique within Initiator private processes environment for this transaction. Private processes use the binaryRequest field to send binary data to TIBCO BusinessConnect. which is required to return this closure contents back in the InitiatorResponse to ensure that the private process can match it with the original Initiator.INITIATOR. If both binaryRequest and inputFile are passed. The private process creates this ID. the binaryRequest node will be used.EZComm. The private process generates the closure message and sends it to TIBCO BusinessConnect. If both plainRequest and inputFile are passed.BC-ACME.Request. Data that is sent is in a string or in binary form.REQUEST External example: AX. Subject Name prefix. Content type of the passed data operationID transactionID closure String No binaryRequest base64Bi nary String No No content-type TIBCO BusinessConnect EZComm Protocol User’s Guide .

the file reference specified in the filename field will be deleted after the completion (successful or otherwise) of the transaction processing. fileName deleteFile Boolean No If set to true. if provided. this field is used. will be set in the MIME Internet headers. content-id String No content-type String No Represents the content type of the message content. If this field is not specified. it will be populated as transactionID-sequence number. A file reference can be sent as an attachment. TIBCO BusinessConnect EZComm Protocol User’s Guide . Represents the content Id for the attachment. For more information.78 | Chapter 8 Table 23 Field EZComm Private Messages Private Message: InitiatorRequest (Cont’d) Type String String Required No No Description Maps to MIME's content-disposition. If a file reference is being passed to TIBCO BusinessConnect. For more information. This value. content-dispos ition inputFile Attachment name String No Name of the attachment file. It must be specified and enforcement is performed at the BusinessWorks palette level. see Multiple Attachments. see Multiple Attachments. For more information. content Base64Bi nary String No No Content for the attachment. see Multiple Attachments.

INITIATOR.RESPONSE Table 24 Field Private Message: InitiatorResponse Type String String String String String Required Yes No Yes No No Description Protocol name Name of the trading partner initiating the transaction Name of the trading partner receiving the transaction A three-part ID of the form: category/version_number/operation_Name An ID unique within Initiator private processes environment for this transaction. duplicate Boolean String String No binaryResponse responseFile No File name containing the response TIBCO BusinessConnect EZComm Protocol User’s Guide . Subject Name prefix.installation.EZComm.EZComm. a code that represents the type of error. Otherwise.RESPONSE External example: AX.INITIATOR.Initiator Messages 79 | Initiator Inbound Response — BusinessConnect to Private Process The Initiator private process uses this message to handle inbound responses.BC. Response is sent to this field if it contains binary data. The private process creates this ID. TIBCO BusinessConnect is required to return this closure contents back in the InitiatorResponse to ensure that the private process can match it with the original InitiatorRequest. Code indicating the status of the message. 200 for success.ACME. Specifies whether the incoming response is a duplicate. OK standardID fromTp toTp operationID transactionID statusCode String No statusMsg closure String String No No or a description of the cause of the error The private process generates the closure message and sends it to TIBCO BusinessConnect.

see Multiple Attachments. For more information. originalFileName Attachment name String No Name of the attachment file. content-id content-type String No Body stringData (plainResponse) String No Response is sent to this field if it contains string data. Represents the content Id for the attachment. then the private process can decide to delete the inbound attachment file. Represents the content type of the message content. see Multiple Attachments. it will be populated as transactionID-sequence number. It must be specified and enforcement is performed at the BusinessWorks palette level. If this field is not specified. For more information. for example.80 | Chapter 8 Table 24 Field EZComm Private Messages Private Message: InitiatorResponse (Cont’d) Type String Required No Description This field contains the filename of the original request file. For more information. A file reference can be sent as an attachment. content fileName any String No No Content for the attachment. for the File and FTP transports this is the actual filename that is in the directory or on the FTP server. deleteFile Boolean String No No If set to true. TIBCO BusinessConnect EZComm Protocol User’s Guide . see Multiple Attachments.

EZComm. Represents the type of the operation.installation.REQUEST External example: AX.RESPONDER. or Asynchronous Request Response. such as Notify. .BC. This field shows whether the file specified in the field inputFile is a binary file.Responder Messages 81 | Responder Messages Responder Inbound Request — BusinessConnect to Private Process The Responder private process uses this message to handle inbound requests.RESPONDER. A closure message generated by the private process and sent to TIBCO BusinessConnect Used by TIBCO BusinessConnect to send data when binary data is being passed to a partner.EZComm.REQUEST Table 25 Field Private Message: ResponderRequest Type String String String String String Required Yes Yes Yes No Yes Description Protocol name Name of the trading partner who initiated the transaction Name of the trading partner who received the transaction A three-part ID of the form: category/version_number/operation_Name A unique ID generated by TIBCO BusinessConnect when publishing the transaction to the private process's environment.BC-ACME. standardID fromTp toTP operationID transactionID closure String base64Bi nary Boolean String String No No No No No binaryRequest isBinaryFile inputFile operationType TIBCO BusinessConnect EZComm Protocol User’s Guide . Used for a file reference that was passed to TIBCO BusinessConnect. Subject Name prefix. Synchronous Request Response.

Represents the content Id for the attachment. content fileName any String No No Content for the attachment. If this field is not specified. then the private process can decide to delete the inbound attachment file. Represents the content type of the message content. for example. for the File and FTP transports this is the actual filename that is in the directory or on the FTP server. For more information. content-id content-type String No TIBCO BusinessConnect EZComm Protocol User’s Guide . For more information. It must be specified and enforcement is performed at the BusinessWorks palette level. This field contains the filename of the original request file. it will be populated as transactionID-sequence number. see Multiple Attachments. deleteFile Boolean String No No If set to true. A file reference can be sent as an attachment. see Multiple Attachments.82 | Chapter 8 Table 25 Field EZComm Private Messages Private Message: ResponderRequest (Cont’d) Type Boolean String Required No No Description Specifies whether the incoming request is a duplicate. see Multiple Attachments. duplicate originalFileName Attachment name String No Name of the attachment file. For more information.

EZComm. For more information. TIBCO BusinessConnect will interpret this value.RESPONDER. . content-type String String No No content-disposit ion Attachment name String No Name of the attachment file.installation. content fileName Any String No No Content for the attachment. see Multiple Attachments. if provided.Responder Messages 83 | Responder Outbound Response — Private Process to BusinessConnect The Responder private process uses this message to handle outbound responses. Content type of the response. see Multiple Attachments. Deletes the response file if the value is true. Maps to MIME's content-disposition.RESPONDER.EZComm. A file reference can be sent as an attachment.BC. a code that represents the type of error. will be set in the MIME Internet headers. If not specified.BC-ACME. this response is correlated to the request. TIBCO BusinessConnect EZComm Protocol User’s Guide . For more information. OK statusCode statusMsg String Base64B inary String Boolean String Yes No No or a description of the cause of the error binaryResponse responseFile Response is sent to this field if it contains binary data. Otherwise. This value.Response Type Integer Required Yes Description Code indicating the status of the message (200 for success). This is the name of the file that contains the response.RESPONSE Table 26 Field Private Message: Responder. deleteResponseFile closure Yes This is the closure that is received from the Responder Request Based on this value.RESPONSE External example: AX. Subject Name prefix.

the file reference specified in the filename field will be deleted after the completion (successful or otherwise) of the transaction processing. it will be populated as transactionID-sequence number. Represents the content type of the message content. Represents the content Id for the attachment. It must be specified and enforcement is performed at the BusinessWorks palette level. For more information. If this field is not specified. see Multiple Attachments.84 | Chapter 8 Table 26 Field EZComm Private Messages Private Message: Responder. deleteFile content-id String No content-type String No Body stringData (plainResponse) String No Response is sent to this field if it contains string data. TIBCO BusinessConnect EZComm Protocol User’s Guide .Response Type Boolean Required No Description If set to true.

RESPONDER.Ack Type String Required Yes Description Code indicating the status of the message (200 for success).RESPONDER. a code that represents the type of error. In this case it is ack. The acknowledgement indicates whether the Responder Response has been forwarded to the trading partner.BC. indicating that the message is of the type Acknowledgement. A closure sent by the Responder Response message.EZComm.ACK Table 27 Field Private Message: Responder. OK statusCode statusMsg operationType String String Yes No or a description of the cause of the error Represents the type of the operation. Subject Name prefix.Responder Messages 85 | Responder Acknowledgement — Private Process to BusinessConnect The Responder TIBCO BusinessConnect sends this acknowledgement after it receives the Responder Response.EZComm. Otherwise.installation. .ACK External example: AX.BC-ACME. closure String Yes TIBCO BusinessConnect EZComm Protocol User’s Guide .

86

| Chapter 8

EZComm Private Messages

General Messages
Error Messages TIBCO BusinessConnect uses the error message to publish status information.
Subject Name

prefix.installation.EZComm.ERROR Example: AX.BC.BC-ACME.EZComm.ERROR

Table 28 Field

Private Message: Error Message Type String String String String Required No No No No Description One of the private party-defined status and error codes The string representing the cause of one of the private party-defined status or error codes Additional information The flow of the message, either inbound or outbound Reserved String String No No A three-part ID of the form: category/version_number/operation_Name A unique ID generated by TIBCO BusinessConnect when publishing the transaction to the private process's environment Protocol name Time stamp for this message Host name Trading partner name This field contains the originalFileName when available.

statusCode statusMsg

details msgDirection closure operationID

transactionID

standardID timestamp host tpName extraInfo

String String String String String

Yes No No No No

Body
stringData

String

No

TIBCO BusinessConnect EZComm Protocol User’s Guide

Multiple Attachments 87

|

Multiple Attachments
TIBCO BusinessConnect EZComm Protocol 5.3 allows you to send attachments to the trading partner. The current private process schema accommodates attachments so that the attachment field represents a sequence which allows any number of attachments to be specified. The fields available for configuring an attachment are as follows: •
name This represents the name of the attachment. If none is specified, it will

be named AttachmentsequenceNumber.second part of the content type. For example, if you are sending an xml file, the content type will be text/xml and the attachment name will be Attachment0.xml. (1 is the sequence number for the first element of the attachment sequence). • •
content Content of the attachment. fileName A file reference can be sent as an attachment. The content of this file

will be read and set to the content of the attachment. — If both the content and fileName fields are specified, then content will be set as the attachment data. — If neither the content nor the fileName fields are specified, then this attachment element will not be processed. Specifying of these fields is not enforced by the private process. •
deleteFile This is a Boolean field. If set to true, the file reference specified in the filename field will be deleted after the completion (successful or otherwise) of the transaction processing. contentID Represents the content Id for the attachment. It must be specified

and enforcement is performed at the BusinessWorks palette level. If this field is not specified, it will be populated as transactionID-sequence number. • Represents the content type of the message content. If not specified, it will be inferred by the protocol.
contentType

If there is no contentType field specified, such as when neither content nor the fileName fields are specified, the attachment will not be processed. EZComm writes an attachment to a file and sends the reference to the private process, with one exception: if the private process message is in the tibXML format, the attachment will be sent as part of the TIBCO Rendezvous message. Based on the content-type of the attachment, it will be populated either in the message type field STRING or OPAQUE.

TIBCO BusinessConnect EZComm Protocol User’s Guide

88

| Chapter 8

EZComm Private Messages

Resending EZComm Private Process Messages
EZComm can resend the private process messages that are in audit states RECEIVED_FROM_PP and SEND_TO_PP. Following is the relationship between the audit states and private process message types: • On the Initiator side
RECEIVED_FROM_PP SEND_TO_PP INITIATOR.REQUEST INITIATOR.RESPONSE

On the Responder side
RECEIVED_FROM_PP SEND_TO_PP RESPONDER.RESPONSE RESPONDER.REQUEST

The message RESPONDER.REQUEST is not resendable for the synchronous transactions: it is only resendable for the Notify and asynchronous transactions. The message RESPONDER.RESPONSE is not resendable for any transaction type. Once a message is sent in a particular format, such as tibXML or EZComm, the resent message will also be in the same format. The configuration option “Publish tibXML Private Process Message” is not considered while resending the RESPONDER.REQUEST message. The original standard ID is always used when resending the private process message on the subject with the same protocol.

TIBCO BusinessConnect EZComm Protocol User’s Guide

page 93 Resend Logs.| 89 Chapter 9 Viewing Logs This chapter explains the use of logs in EZComm. Topics • • • Audit Logs. page 90 Non-Repudiation Logs. page 96 TIBCO BusinessConnect EZComm Protocol User’s Guide .

but represents a part of a name. For more information on audit logs. TIBCO BusinessConnect EZComm Protocol does not record advisory messages. processing status. since this is required for the resend. and validation errors. Configure an Audit Log for EZComm To configure an audit log for EZComm. Search Transactions 2. do the following: 1. Select BusinessConnect>Log Viewer>Audit Logs. Some of the types of information stored in the audit log include: sent and received documents. in the audit log. When doing searches. Table 29 Audit Log: Search Transactions Column Name Protocol Connection Host Definition Select a protocol (EZComm) Select a connection name Select a specific host name or ANY TIBCO BusinessConnect EZComm Protocol User’s Guide . document originator. trading partner name.90 | Chapter 9 Viewing Logs Audit Logs The audit log is used to store information about the messages and documents processed by TIBCO BusinessConnect EZComm Protocol. Configure transactions to search. The entire AESchema is stored in the fields REQUEST_FROM_PP and SEND_TO_PP fields in the audit log. You can use the audit log to follow the processing states of inbound or outbound documents. Audit Logs. such as the Responder Acknowledgement. see TIBCO BusinessConnect Trading Partner Administration Guide. remember that the character “*” is not considered to work as a wild card. Table 29 lists the options to select in the Search Transactions section of the audit log.

this column is left blank. Table 30 lists the options to select in the Advanced Search Section Settings section of the audit log. additional fields for defining exact dates will become available. If Custom Date Range is selected. ERROR. This way.Audit Logs 91 | Table 29 Audit Log: Search Transactions (Cont’d) Column Name Status Date Range Criteria Definition SECURITY. is not like User TranID The user transactionID column displays the transaction ID received from the private process on the Initiator side. a transaction initiated by the Initiator can be cross-referenced on the Responder side. is not like TIBCO BusinessConnect EZComm Protocol User’s Guide . Configure the advanced search settings. is not. contains. Previous From this dropdown list. This feature works only for HTTP/S and Email transports. For File and FTP/S transports. such as ANY. Boolean search using: is. Table 30 Audit Log: Advanced Search Settings Column Trading Partner Definition Trading Partner name Boolean search using: is. One Month. Select a specific status.PENDING. is not like Document ID (This is always a unique name) Boolean search using: is. is not. the additional field Previous for defining the date range will become available. Previous predefined period can be One Day. or RECEIPT PENDING Date Range COMPLETED. is DocumentID not. Initiator forwards this ID to the Responder and at the same displays it in this column. ERROR Select Custom or Predefined Date Range. you can select the previous period to search: • • • • Audit Log: Advanced Search Settings One Day One Week One Month One Year 3. If Predefined Date Range is selected. CANCELED. contains. or One Year. contains. One Week.

This value is true for outgoing requests. is not like Transaction Type Type of the transaction you are searching. or Asynchronous Request Response). this value will be true for any type of transaction (Notify . see TIBCO BusinessConnect Trading Partner Administration Guide. which is important to differentiate since EZComm handles the tibXML messages. Saving and Reusing Queries. is not. For the Responder. Synchronous Request Response. contains. is not like For the Initiator. is Host Initiates not.92 | Chapter 9 Viewing Logs Table 30 Audit Log: Advanced Search Settings (Cont’d) Column Operation ID Definition Operation ID Boolean search using: is. contains. TIBCO BusinessConnect EZComm Protocol User’s Guide . here are also buttons available that allow you to do the following: — Remove Query — Execute Query — Save Current Query — Search To learn more about these options. while for incoming requests and for outgoing responses this value will be false. this value is always false. In addition to these search entry fields. contains. Boolean search using: is. The valid values for the field are as follows: • • • • • • • EZComm-Notify (Notify operation for EZComm) EZComm-Async (Async operation for EZComm) EZComm-Sync (Sync operation for EZComm) tibXML-Notify (Notify operation for tibXML) tibXML_Async (Async operation for tibXML) tibXML-Sync (Sync operation for tibXML) tibXML-passthrough (Passthrough operation) not. is 4. is not like Boolean search using: is.

Table 31 Non-Repudiation Log: Search Transactions Column Name Protocol Connection Host Status Date Range Criteria Definition Select a protocol (EZComm) Select a connection name.Non-Repudiation Logs 93 | Non-Repudiation Logs The non-repudiation log is used to provide proof of the delivery of messages. Select Custom Date Range ERROR. Select a specific host name or ANY. Configure transactions to search. If Custom Date Range is selected. COMPLETED. Non-repudiation depends on authentication using digital signatures. Table 31 lists the options to select in the Search Transactions section of the non-repudiation log. the additional field Previous for defining the date range will become available. Select a specific status. ERROR or Predefined Date Range. For more information on non-repudiation logs. TIBCO BusinessConnect EZComm Protocol User’s Guide . or RECEIPT PENDING. or One Year. Non-Repudiation. Select BusinessConnect>Log Viewer>Non Repudiation Logs. Search Transactions 2. Incoming messages which have been digitally signed are authenticated and stored in the non-repudiation database. SECURITY. Configure a Non-Repudiation Log for EZComm To configure a non-repudiation log for EZComm. do the following: 1. such as CANCELED. If Predefined Date Range is selected. Outbound messages that have been digitally signed are also stored in the database. additional fields for defining exact dates will become available. see TIBCO BusinessConnect Concepts. One Month. Previous predefined period can be One Day. PENDING. One Week.

is not like Operation ID Operation ID Boolean search using: is. is not like not. contains.94 | Chapter 9 Viewing Logs Table 31 Non-Repudiation Log: Search Transactions (Cont’d) Column Name Previous Definition From this dropdown list. contains. is not like User TranID The user transactionID column displays the transaction ID received from the private process on the Initiator side. contains. you can select the previous period to search: • • • • Non-Repudiation Log: Advanced Search Settings One Day One Week One Month One Year 3. Boolean search using: is. Boolean search using: is. Table 32 lists the options to select in the Advanced Search Section Settings section of the non-repudiation log. is Transaction Type not. is not. is not like TIBCO BusinessConnect EZComm Protocol User’s Guide . Configure the advanced search settings. contains. is Document ID Document ID Boolean search using: is. Table 32 Non-Repudiation Log: Advanced Search Settings Column Trading Partner Definition Name of the Trading Partner Boolean search using: is. is not. contains. is not. is not like Type of the transaction you are searching.

there are also buttons available that allow you to do the following: — Remove Query — Execute Query — Save Current Query — Search To learn more about these options.Non-Repudiation Logs 95 | 4. In addition to these search entry fields. see TIBCO BusinessConnect Trading Partner Administration Guide. Saving and Reusing Queries. TIBCO BusinessConnect EZComm Protocol User’s Guide .

do the following: 1. the Outbound File Poller messages can appear in the list of resendable transactions. There are two tabs available in the Resend Logs dialog: Resendable Transactions and Resend History. Resendable Transactions Tab Search Transactions 2. Configure the search for resendable transactions. only the messages sent over or received from Rendezvous (or JMS) transport will be displayed.96 | Chapter 9 Viewing Logs Resend Logs For the state RECEIVED_FROM_PP. Configure a Resend Log for EZComm To configure a resend log for EZComm. The resendable transactions that are shown on the screen depend on the Private Processes that are configured. see TIBCO BusinessConnect Trading Partner Administration Guide. If TIBCO Rendezvous (or JMS) is configured for Private Process communication. Resend history Allows you to view messages that have been resent. The resend log provides two views into the audit log: • • Resendable transactions Allows you to resend a transaction. the Outbound File Poller messages cannot appear in the list of resendable transactions and therefore cannot be resent. TIBCO BusinessConnect EZComm Protocol User’s Guide . For more information about resend logs. Resend Logs. For the state SEND_TO_PP. Select BusinessConnect>Log Viewer>Resend Logs.

Select a specific status. COMPLETED. Select a specific host name or ANY. Performing a Log Search. SECURITY. see TIBCO BusinessConnect Trading Partner Administration Guide. the additional field Previous for defining the date range will become available. additional fields for defining exact dates will become available. Previous predefined period can be One Day. Table 33 Resend Log: Resendable Transactions Column Name Protocol Connection Host Status Date Range Criteria Definition Select a protocol. If Custom Date Range is selected. or RECEIPT PENDING. such as CANCELED. ERROR or Predefined Date Range. One Week. or One Year. PENDING. Select Custom Date Range ERROR. TIBCO BusinessConnect EZComm Protocol User’s Guide .Resend Logs 97 | Table 33 lists the options to select in the Search Transactions section of the resend log. you can select the previous period to search: • • • • One Day One Week One Month One Year State Select the transaction state: RECEIVED_FROM_PP or SEND_TO_PP 3. here are also buttons available that allow you to do the following: — Search (execute a search) — Done (finish using the dialog) To learn more about these options. If Predefined Date Range is selected. Select a connection name. One Month. In addition to these search entry fields. Previous From this dropdown list.

TIBCO BusinessConnect EZComm Protocol User’s Guide . a transaction initiated by the Initiator can be cross-referenced on the Responder side. is not like not. this column is left blank. contains. Configure the advanced search settings. This value is true for outgoing requests. is not like Type of the transaction you are searching. contains. is not like For the Initiator. Synchronous Request Response. Operation ID Operation ID Boolean search using: is. This feature works only for HTTP/S and Email transports. is not like not. contains.98 | Chapter 9 Viewing Logs Resend Log: Advanced Search Settings 4. is not like The user transactionID column displays the transaction ID received from the private process on the Initiator side. this field will be true for any type of transaction (Notify. contains. is Boolean search using: is. Table 34 lists the options to select in the Advanced Search Section Settings section of the resend log. For File and FTP/S transports. Initiator forwards this ID to the Responder and at the same displays it in this column. is not. it is always false. is • • not. contains. contains. This way. is not like not. or Asynchronous Request Response). Table 34 Resend Log: Advanced Search Settings Column Trading Partner Document ID Transaction Type Definition Boolean search using: is. is not. Host Initiates Boolean search using: is. is User TranID Boolean search using: is. For the Responder. is Boolean search using: is. while for incoming requests and for outgoing responses this value will be false.

PENDING. Configure the search for resend history.Resend Logs 99 | Resend History Tab Search Transactions 5. ERROR Select Custom Date Range or Predefined Date Range. ERROR. Select a connection name. you can select the previous period to search: • • • • One Day One Week One Month One Year TIBCO BusinessConnect EZComm Protocol User’s Guide . such as ANY. Select a specific status. If Predefined Date Range is selected. Table 35 Resend Log: Resend History Column Name Protocol Connection Host Status Date Range Criteria Definition Select a protocol. COMPLETED. additional fields for defining exact dates will become available. One Month. or One Year. or RECEIPT PENDING. SECURITY. CANCELED. the additional field Previous for defining the date range will become available. One Week. If Custom Date Range is selected. Table 35 lists the options to select in the Search Transactions section of the resend log. Select a specific host name or ANY. Previous predefined period can be One Day. Previous From this dropdown list.

it is always false. is not like not. is Boolean search using: is. Operation ID Operation ID Boolean search using: is. contains. Performing a Log Search. Transaction Type Boolean search using: is. is not like For the Initiator. see TIBCO BusinessConnect Trading Partner Administration Guide. is not like not. is • • not. contains. TIBCO BusinessConnect EZComm Protocol User’s Guide . while for incoming requests and for outgoing responses this value will be false. 7. Table 36 Resend Log: Advanced Search Settings Column Trading Partner Document ID User TranID Definition Boolean search using: is. contains. this field will be true for any type of transaction (Notify . For the Responder. This way. Synchronous Request Response. Table 36 lists the options to select in the Advanced Search Section Settings section of the resend log. is not like. Initiator forwards this ID to the Responder and at the same displays it in this column. is not like not. there are also buttons available that allow you to do the following: — Search (execute a search) — Done (finish using the dialog) To learn more about these options. contains. In addition to these search entry fields. or Asynchronous Request Response). This feature works only for HTTP/S and Email transports.100 | Chapter 9 Viewing Logs Advanced Search Settings 6. Configure the advanced search settings. contains. this column is left blank. is not. For File and FTP/S transports. The user transactionID column displays the transaction ID received from the private process on the Initiator side. contains. This value is true for outgoing requests. is not. is Host Initiates Boolean search using: is. a transaction initiated by the Initiator can be cross-referenced on the Responder side. is not like Type of the transaction you are searching. is Boolean search using: is.

page 103 TIBCO BusinessConnect EZComm Protocol User’s Guide . page 102 Inbound File Pollers for EZComm.| 101 Chapter 10 File Pollers This chapter explains outbound and inbound File pollers for EZComm. Topics • • Outbound File Pollers for EZComm.

see TIBCO BusinessConnect Trading Partner Administration Guide. URI format is as follows: file://BaseDir/*. This contrasts with the other transports.* This causes all directories under BaseDir to be checked for files.0/Notify. for example.102 | Chapter 10 File Pollers Outbound File Pollers for EZComm The outbound File poller provides a simple way for private processes to transmit documents to TIBCO BusinessConnect. To read general information on how to enable an outbound File poller. TIBCO BusinessConnect EZComm Protocol User’s Guide . In order for the file to be handled by EZComm. such as for the operation BC/1. files in the directory Category_operationID will be treated as Category_Empty_operationID. The sending partner for outbound File pollers is assumed to be the default host. TIBCO BusinessConnect will look for an operation Category/Empty/operationID in the configuration store. the document must appear as follows: • Default behavior.0/Notify: BaseDir/TpName • Non-default behavior. for other operations: BaseDir/TpName/Category_Version_OperationID where • • • • • BaseDir is a user selected base directory TpName is the name of the trading partner Category is the operation category Version is the operation version OperationID is the operation ID If Category_Version_OperationID is not provided. Outbound File Pollers. then it defaults to BC/1. which are used for communication between trading partners. Outbound File pollers are used by enterprises that do not wish to use TIBCO Rendezvous to transfer documents to TIBCO BusinessConnect. URI Format for EZComm Outbound File Pollers For the File transport. Since the default operation has changed from BC/Notify to BC/1.0/Notify.

Inbound File Pollers for EZComm 103 | Inbound File Pollers for EZComm When File outbound is used as a transport. Inbound File Pollers. the trading partner uses an inbound File poller to check for the documents. To read general information on how to enable an inbound File poller. For the inbound File pollers. see TIBCO BusinessConnect Trading Partner Administration Guide. the receiving partner is assumed to be the default host. TIBCO BusinessConnect EZComm Protocol User’s Guide .

104 | Chapter 10 File Pollers TIBCO BusinessConnect EZComm Protocol User’s Guide .

page 119 Passthrough Mode in tibXML. page 116 MIME Message Packaging Options in tibXML.| 105 Chapter 11 tibXML Integration The tibXML protocol users are now able to substitute it with the TIBCO BusinessConnect EZComm Protocol. page 120 Setting Timing Restrictions in tibXML. page 109 Private Process Migration. Topics • • • • • • • • Overview. which can work with projects generated using tibXML. page 106 New GUI Options for tibXML-to-EZComm Integration. page 128 tibXML Public Messages. page 108 tibXML Private Process Messages. page 121 TIBCO BusinessConnect EZComm Protocol User’s Guide .

If it receives such message. • TIBCO BusinessConnect EZComm 5. Two sample usage scenarios for using tibXML 3.3 is backward compatible with the private process messages coming from any tibXML private process. It is assumed that these messages adhere to the schema provided by tibXML. the response and any errors for the transaction will be published on tibXML subjects and in the tibXML format. Receive tibXML requests and send response in the tibXML format Interpret private process messages coming from the tibXML 3. tibXML can also be used for other types of supply chain integration transactions. and design collaboration. such as collaborative forecasting.x private processes as tibXML messages.106 | Chapter 11 tibXML Integration Overview TIBCO BusinessConnect tibXML Protocol is a business protocol developed by TIBCO for exchanging XML used in e-commerce. inventory management.3 can do the following: • • • Interoperate with the systems using the tibXML protocol and receive responses from these systems. sellers.3 on two systems is shown in Example Usage Scenarios for EZComm-to-tibXML Integration. It can be configured to send private process (Responder Request) messages in the tibXML format. which is enabled by selecting the checkbox Publish tibXML Private Process Message in the Operations Editor dialog under BusinessConnect>Operations Editor>EZComm><operation Type>>General. and intermediaries to share business documents and messages over the Internet. TIBCO BusinessConnect EZComm Protocol 5.6 and EZComm 5. It allows buyers. TIBCO BusinessConnect EZComm Protocol User’s Guide .

3 Initiator Request tibXML 3.3 Error Public message format on both sides is tibXML In the second example. the Initiator is using TIBCO BusinessConnect 5. Responder Using tibXML 3.6 Public message format on both sides is tibXML TIBCO BusinessConnect EZComm Protocol User’s Guide .3 Responder Request Responder Response Error tibXML 3.6 Responder Request Responder Response EZComm 5.6 and TIBCO BusinessConnect tibXML Protocol.3. while the Responder is using TIBCO BusinessConnect 3. Figure 19 Initiator Request: Initiator Using EZComm 5.3 and the TIBCO BusinessConnect EZComm Protocol. while the Responder is using TIBCO BusinessConnect 5.x Private Process Responder BusinessConnect 3.3 and the TIBCO BusinessConnect EZComm Protocol.x.3 Private Process Responder BusinessConnect 5.6 and the TIBCO BusinessConnect tibXML Protocol.x Private Process Internet Initiator Response Initiator BusinessConnect 3.6 Initiator Request EZComm 5. Responder Using EZComm 5.Overview 107 | Example Usage Scenarios for EZComm-to-tibXML Integration In the first example.3 Private Process Internet Initiator Response Initiator BusinessConnect 5. Figure 18 Initiator Request: Initiator Using tibXML 3. the Initiator is using TIBCO BusinessConnect 3.

to a tibXML public message format. It is used for forcing the packaging of the outbound public message. • Use tibXML Packaging This option is available in the dialog under BusinessConnect>Partner> EZComm->General. TIBCO BusinessConnect EZComm Protocol User’s Guide . a message with an additional MIME part that contains the element <header>. URL/subject is updated with tibXML-passthrough. when the URL suffix does not contain EZComm or tibXML.108 | Chapter 11 tibXML Integration New GUI Options for tibXML-to-EZComm Integration There are three new fields in the EZComm GUI that facilitate tibXML-to-EZComm integration: • Publish tibXML Private Process Messages This option is available under BusinessConnect> EZComm><operation_name>>General as an operation property for inbound and allows the Responder to send tibXML private process messages. When this checkbox is selected and when the outbound URL/subject contains tibXML. For more information. for example. see Passthrough Mode in tibXML. • tibXML Passthrough This option is available as an action property only for the Notify operation and enables it to send any XML or non-XML message resembling the Pass Through Message in tibXML.

RESPONSE.REQUEST. the following criteria will be used to determine the private process message format. If tibXML processing is found either in the standardID or in the subject field. During this transaction.RESPONSE) it receives. and ERROR. If any tibXML message (the message with a subject containing tibXML) contains EZComm in the field standardID.ACK on the tibXML subject. RESPONDER. they will be published in the tibXML message format. The subject will have tibXML as the protocol name. it will be treated as EZComm and will fail.REQUEST arrives in tibXML message format. TIBCO BusinessConnect expects RESPONDER.RESPONSE is sent out in the tibXML message format. Responder Messages On the Responder side. a message INITIATOR. Since TIBCO BusinessConnect EZComm can send these messages both in the EZComm and in tibXML format. When the standardID is not present.REQUEST and RESPONDER. it checks the subject or the RV message to determine the protocol. If the RESPONDER.RESPONSE in the tibXML format and sends the RESPONDER. Initiator Messages When an INITITATOR.3 looks for the standardID value of tibXML for all private process messages (INITIATOR. if there are any errors or advisories. the message will be interpreted as an tibXML private process message and TIBCO BusinessConnect will look for the tibXML aeschema for fetching the values from that message.ACK. a user must configure to send the messages in the tibXML format by selecting the option Publish tibXML Private Process Message on the operation tab. RESPONDER.tibXML Private Process Messages 109 | tibXML Private Process Messages TIBCO BusinessConnect EZComm 5.REQUEST message is sent out on the tibXML subject in tibXML format. TIBCO BusinessConnect EZComm Protocol User’s Guide . Rules for Handling tibXML Messages BusinessConnect can send INITIATOR.NOTIFY messages to the private process.

REQUEST message that was sent. the original message is retrieved from the log and sent as is . The original standard ID is always used when resending the private process message on the subject with the same protocol.REQUEST message because the resend log stores the original RESPONDER.110 | Chapter 11 tibXML Integration The configuration option “Publish tibXML Private Process Message” is not considered while resending the RESPONDER. When you choose to resend this message. TIBCO BusinessConnect EZComm Protocol User’s Guide .

If the option Publish tibXML private process Messages is selected and the configured transport in TIBCO BusinessConnect EZComm Protocol is JMS. Transports for tibXML Private Process Messages tibXML has only TIBCO Rendezvous as a private process. TIBCO BusinessConnect can receive a tibXML private process message (or an EZComm message).3 are explained in the following sections: • • • • INITIATOR REQUEST INITIATOR RESPONSE RESPONDER.tibXML Private Process Messages 111 | Connection Between tibXML Public and Private Process Messages Private process messages do not depend on the public message format. yet it can send the public message to the trading partner in the EZComm format (or in the tibXML format. an error entry is made in the audit log and the transaction is terminated.REQUESt or error advisories. respectively). This scenario occurs only when sending the messages on the Responder side.RESPONSE TIBCO BusinessConnect EZComm Protocol User’s Guide .REQUEST RESPONDER. On the Initiator side.6 and EZComm 5. this scenario doesn’t exist since for a tibXML transaction to be initiated the INITOATOR.REQUEST message should arrive using the TIBCO Rendezvous transport. BusinessConnect can receive a public message in the EZComm or in tibXML format and still be able to send the private process message based on the option Publish in tibXML Format selected by a user. No advisories will be published on the JMS transport. such as RESPONDER. Comparing Private Processes Messages Between tibXML and EZComm Differences between private process messages in tibXML 3.

BinaryRequest. n/a requestFile deleteRequestFile n/a TIBCO BusinessConnect EZComm Protocol User’s Guide .REQUEST Fields in tibXML 3.6 and EZComm 5. toTP can be specified using either the tpName field or using a list of trading partners in the tpNameList.3.3: Table 37 INITIATOR. If specified in tibXML message.6 and EZComm 5.6 Field hostName tpName What are the differences? In tibXML.3 EZComm 5. In EZComm 5. request and requestFile. or an inputFile. a request can be sent on stringData (plainRequest). Since EZComm doesn't support this feature.REQUEST fields that are different between tibXML3. tibXML has only two types.3.3 Field fromTP toTP tibXML 3.3 will check for the request data from these two types. it will be ignored in EZComm 5.112 | Chapter 11 tibXML Integration INITIATOR REQUEST Table 37 shows the INITIATOR. and EZComm 5. n/a stringData (plainRequest) binaryRequest inputFile tpNameList request The list specifying trading partner names. tibXML sends the requests to all listed trading partners. When toTP is specified. it takes the first partner name from this sequence and sends the request to that partner.

n/a stringData (plainResponse) binaryResponse tpNameList response The list specifying trading partner names.6 and EZComm 5.RESPONSE fields that are different between tibXML3. the payload field will be populated in the responseFile field.3: Table 38 INITIATOR.Installation_Name.RESPONSE is published on the EZComm subject.tibXML Private Process Messages 113 | INITIATOR RESPONSE The message INITIATOR. toTP can be specified using either the tpName field or using a list of trading partners in the tpNameList. tibXML sends the requests to all listed trading partners.RESPONSE. such as AX. the message INITIATOR. When toTP is specified.6 and EZComm 5. If the field is received as a reference.BC. Table 38 shows the INITIATOR.REQUEST is received on tibXML.6 Field hostName tpName What are the differences? Only the first trading partner from the tpNameList sequence will be selected. The field stringData (plainResponse) contains text data and binaryRespose contains binary data. n/a deleteResponseFile n/a originalFileName n/a This field represents the actual file name of the file reference specified in the RESPONDER.EZComm.RESPONSE will be published on the tibXML subject if the message INITIATOR. Since EZComm doesn't support this feature.RESPONSE Fields in tibXML 3.3 Field fromTP toTP tibXML 3. it takes the first partner name from this sequence and sends the request to that partner. When the outbound File poller is used as the private process that invokes a tibXML transaction.REQUEST message TIBCO BusinessConnect EZComm Protocol User’s Guide .INITIATOR. In tibXML.3 EZComm 5.

6 and EZComm 5. (hostName) toTP destinationTP (tpName) stringData (plainRequest) binaryRequest request n/a EZComm 5.REQUEST Table 39 shows the RESPONDER.114 | Chapter 11 tibXML Integration RESPONDER. isBinaryFile inputFile originalFileName n/a requestFile n/a The field originalFileName will be populated as follows: • Inbound File and FTP transports The actual filename at the time of polling from the source will be populated.3 will populate the fields stringData (plainRequest). while the field tpNameList will never be populated.3 EZComm 5.6 Field sourceTP What are the differences? EZComm 5.6 and EZComm 5. The source is a directory in case of the File transport.3 Field fromTP tibXML 3.REQUEST message should have the field inputFile populated. • Inbound MIME message Any filename specified in the content disposition will be populated in the originalFileName field.REQUEST fields that are different between tibXML3. on the outbound (Initiator) side the following must occur: the option Allow override Filename should be enabled for the partner and the INITIATOR. binaryRequest or requestFile field.3 will always populate the fields hostname and tpName. For the above scenario to work. the private process message should come from an outbound File Poller (OBFP). TIBCO BusinessConnect EZComm Protocol User’s Guide . it will be populated on originalFileName. • HTTP If the URL/header carries the expression filename=<value>.REQUEST Fields in tibXML 3.3: Table 39 RESPONDER. and an FTP server in case of the FTP transport. The field requestFile will be populated if filename is received on the HTTP query string or if the request exceeds the large file threshold.

3 Field stringData (plainResponse) binaryResponse content-type content-disposit ion tibXML 3.6 Field response What are the differences? n/a n/a n/a TIBCO BusinessConnect EZComm Protocol User’s Guide .RESPONSE Fields in tibXML 3.REQUEST — outbound File poller is used as private process.3 EZComm 5. or attachments are specified.RESPONSE There are no significant differences between fields for tibXML 3.tibXML Private Process Messages 115 | Table 39 RESPONDER.6 and EZComm 5.6 and for EZComm 5.3 EZComm 5.) — payload comes in as file reference and signing.REQUEST private process message. RESPONDER.REQUEST Fields in tibXML 3. INITIATOR. encryption. — the content disposition populated with the filename comes from the INITIATOR.3: Table 40 RESPONDER.6 and EZComm 5.3 Field originalFileName tibXML 3.6 Field n/a What are the differences? • Content disposition will be populated with the originalFilename field in the following cases: Outbound MIME message (cont.

• EZComm determines the outbound message packaging format based on the URL suffix of the primary outbound transport. transactionID. — The second part of the MIME message contains the request.3 is capable of sending or receiving messages either in the EZComm or tibXML format. BusinessConnect — while processing the incoming requests — publishes certain errors both on EZComm and tibXML subjects . The transport URL/subject is used to determine the public message format.116 | Chapter 11 tibXML Integration tibXML Public Messages TIBCO BusinessConnect EZComm Protocol 5. Inbound Processing Error in tibXML When an EZComm operation is configured to publish the private process message in the tibXML format. — HTTP If the URL contains /tibXML. the outbound message will be packaged in the tibXML format. and so on). This happens when an error occurs and if any of the following in the incoming request can not be determined or is invalid: • • • • • Transaction type operationID fromTp toTp business agreement between the partners Outbound Public Messages in tibXML The following applies to outbound public messages in tibXML: • The tibXML outbound public message are always MIME messages (except for passthrough) with multiple parts: — The first MIME part always contains an XML that contains the header information (fromTP. TIBCO BusinessConnect EZComm Protocol User’s Guide . toTP.

provided that the checkbox Use tibXML packaging for the partner is selected. the URLs and subjects will be populated with the value tibXML and users don’t have to change these values after migration — File or FTP For these transports tibXML packaging is not available. tibXML Message Formatting The tibXML public messages are formatted differently than the EZComm messages: • The tibXML messages are always multi-part MIME messages. TIBCO BusinessConnect EZComm Protocol User’s Guide . • A message can be packaged in the tibXML format also when the URL doesn't contain the tibXML or EZComm suffix. while for the EZComm messages all transaction information is carried in URL/subject. this message will be sent out to EZComm.tibXML Public Messages 117 | — Email For this transport. The second body part for the tibXML messages is payload. Inbound Public Messages in tibXML TIBCO BusinessConnect EZComm Protocol inspects the incoming URL suffix. to. from. • For more information on determining the public message format refer to MIME Message Packaging Options in tibXML. EZComm will try to extract the multi-part MIME message.3. and so on. The first part of the MIME message will be the header XML and the partner information is extracted from this for unpacking the request. the packaging format will be determined by the expression tibXML: in the subject. If a tibXML messages comes from the private process when one of these transports is used. This applies to situations when a partner is using a third-party system with the tibXML message format and when the URL doesn't contain tibXML. During the migration of tibXML 3. such as operationID. where the first part is always XML that contains the information about the transaction. If it contains tibXML.x to EZComm 5.

see MIME Message Packaging Options in tibXML. they must make sure that the outbound transport for response has tibXML in its URL/subject. TIBCO BusinessConnect EZComm Protocol User’s Guide . the outbound transport is not used for sending the response and users don’t have to take care of the transport URL/subject for the synchronous response. see Passthrough Mode in tibXML. the software does not package the data in any way. • Pass-through mode — In this mode. users must make sure that the outgoing response is in the same format as the incoming request. For more information.118 | Chapter 11 tibXML Integration tibXML Message Packaging Since the TIBCO BusinessConnect EZComm Protocol can package messages based on the URL/subject. The tibXML protocol supports the following public messaging options: • MIME (Multipurpose Internet Mail Extensions) with optional S/MIME. The software takes the original notify message that the private process sent and forwards it over the Internet to the trading partner. For more information. for example. users are responsible for making sure that the correct packaging format is specified in the URL. For the synchronous Request Response message. For asynchronous transactions. if the request arrives in the tibXML format.

Content-Transfer-Encoding is binary. but can be in any other format. Both parts are packaged as an encrypted S/MIME object. The resultant byte array is returned.MIME Message Packaging Options in tibXML 119 | MIME Message Packaging Options in tibXML There are four MIME packaging options for the payload (content): • Cleartext The payload is usually an XML string. The signed payload is then encrypted. The following combination of Content-Type and Content-Transfer-Encoding applies in this case: — — — Content-Type=text/plain. The string is returned as is. In this case. — The string is base64-decoded. Content-Type=application/xxx. The string is base64-decoded. Charset=UTF-8. When TIBCO BusinessConnect packages a private message as a public MIME message before sending it over the Internet. Signed The payload is signed and packaged as a signed S/MIME object. Content-Type for the header should be set to text/plain. the content should be a text string. but this may be left blank. where the payload is neither signed nor encrypted. • • • Ciphertext (encrypted) The payload is encrypted and packaged as an encrypted S/MIME object. Content-Transfer-Encoding=base64. The header is always an XML string that is packaged with the payload to form a two-part MIME object. it packages only the contents of the ^data^ control tag from the aeRvMsg. Content-Transfer-Encoding=base64. A new string is formed from the resultant byte array and is returned. TIBCO BusinessConnect strips the TIBCO Rendezvous subject name and message control block tags from the private aeRvMsg message before packaging the message for public transmission. Content-Type=text/xxx. Charset=UTF-8. TIBCO BusinessConnect EZComm Protocol User’s Guide . Content-Type=text/xxx. Ciphertext (encrypted) and signed The payload is signed.

No trading partner validation and no binding will occur. duplicate detection based on the whole message is performed. • The outbound schema validation is available for the outbound passthrough messages In Inbound Passthrough Mode • • • • Inbound messages are inspected for tibXML-passthrough The Responder identifies the incoming request as passthrough based on the value (tibXML-passthrough) supplied in the URL. not for EZComm tibXML-passthrough.120 | Chapter 11 tibXML Integration Passthrough Mode in tibXML The passthrough mode is available with tibXML messages. only for HTTP and SMTP transports and only for the Notify operation. To send a message in the passthrough mode.0/Notify The inbound schema validation is not available for the inbound passthrough messages. Requests will be sent as a plain text and no MIME header. the tibXML-passthrough option will be ignored. TIBCO BusinessConnect won’t be able to use audit tables. the following will happen: • TIBCO BusinessConnect will forward the outbound messages received from the private process without adding an envelope. select BusinessConnect>Operations Editor>EZComm>Notify_operation>Notify Request Action>tibXML Passthrough. Audit logs are performed with the partner name as <unknown> and the operation ID as BC/1. When the checkbox tibXML Passthrough is selected. TIBCO BusinessConnect EZComm Protocol User’s Guide . no signing. while in pass-through mode data is handled as a single block. • • • In Outbound Passthrough Mode • • The Initiator modifies the outbound URL to contain tibXML-passthrough Available only when the outbound URL /subject contains available only for the tibXML partners. However. If the File or FTP transports. and no encryption will be available. Audit logging requires mandatory fields. with no discernible fields.

You can accept the defaults or customize the settings for an operation. you override the default settings for the operation. the defaults are used.Setting Timing Restrictions in tibXML 121 | Setting Timing Restrictions in tibXML You can set timing restrictions in two places. If you override the default settings on any of these timing restrictions. and that field is considered for an operation. For each trading partner. you specify the interfaces that a partner initiates and the interfaces that a partner responds to. If you are changing the timing parameters in the Interfaces Initiated or Interfaces Responded to dialog. If you don’t enter a value into a field. Set customized timing restrictions for operations when used by a particular trading partner. as follows: • • Set default timing restrictions for an operation using the request and response panels in the Protocol Editor. you override the settings that were made for each operation in the selected interface. TIBCO BusinessConnect EZComm Protocol User’s Guide . If you customize an operation’s settings for a particular trading partner. be sure to coordinate with your partner so that you both use the same restrictions.

TIBCO BusinessConnect EZComm Protocol User’s Guide .3 using TIBCO Administrator. Still. Figure 20 shows the diagram for migrating projects between tibXML 3.x to the Release 5.6 palette tibXML 3. See TIBCO BusinessConnect Server Administrator’s Guide. Migrating of TIBCO BusinessConnect 3. and to rely on the backward compatibility of EZComm 5. enabling the usage of your existing tibXML private processes to interact with an EZComm 5.3 running the EZComm protocol.3 with tibXML private process messages only for situations where the tibXML private process is a custom Rendezvous program or an Integration Manager (IM) process.3 system.0.6 Legend BC = TIBCO BusinessConnect BW = TIBCO ActiveMatrix BusinessWorks The migration process contains several steps: 1.3 palette 2a = Open BW project 2b = Import migrated configuration data 1 2 3 4 BW project with tibXML 3. it is recommend that you migrate your tibXML TIBCO ActiveMatrix BusinessWorks projects to EZComm TIBCO ActiveMatrix BusinessWorks projects. Migrating From the Release 3. Figure 20 tibXML to EZComm Private Process Migration Server BC 5.6 and TIBCO BusinessConnect 5.3 is capable of understanding the tibXML private process messages.122 | Chapter 11 tibXML Integration tibXML Migration TIBCO BusinessConnect EZComm Protocol 5.6 (tibXML ) data to TIBCO BusinessConnect 5.3.3 5 Private Process BW project with BC 5.

3 schemas.3 configuration store (2b). As a result.3 palette. Updating of the Business Connect connection resource with the configuration store values (specified in Step 1. you need to perform the following step sequence: 1.3 palette b. 3.3 configuration store.3 (EZcomm) 5.5 that contains the Business Connect 5. the migrated projects will still be able to communicate with the tibXML 3. 2a. these processes will no longer be able to communicate with the tibXML processes. concluding with the complete migration (5). TIBCO BusinessConnect EZComm Protocol User’s Guide .6 palette does not match the one in TIBCO BusinessConnect 3.6. the messages continue to be sent on tibXML subjects. Sending messages from tibXML 3. the TIBCO BusinessConnect 3. From this point on.3 (EZcomm) to tibXML 3. This incomplete migration path is not recommended for the following reasons: • The private process message schema in the TIBCO BusinessConnect 3.6 palette into new TIBCO ActiveMatrix BusinessWorks project with the EZComm 5. In this process. cdata migration) and importing the configuration store data. for example. 2b.6 4. Finishing migration of the TIBCO ActiveMatrix BusinessWorks project with the TIBCO BusinessConnect 5.6 BusinessWorks project with the EZComm 5.3 BusinessWorks palette (2a) and then import the data from the BusinessConnect 5. and 5.6 palette is not able to receive some of the messages generated by TIBCO BusinessConnect 3. which contains two substeps: a.tibXML Migration 123 | 2. The Recommended Migration Path In order to properly migrate the old TIBCO ActiveMatrix BusinessWorks projects with the tibXML 3.3 palette.6. Once the migrated projects import the data from the EZComm 5.3 configuration store is not imported. such as after importing EZComm 5.x systems.6 to TIBCO BusinessConnect 5. Migrating of the TIBCO ActiveMatrix BusinessWorks project. The Migration Path that Does Not Import the Configuration Data If you only perform the sub-step 2a but not the sub-step 2b. you will first open a tibXML 3. The tibXML TIBCO ActiveMatrix BusinessWorks projects are automatically migrated when they are opened using TIBCO Designer 5. which means that the data from the BusinessConnect 5. Sending messages from TIBCO BusinessConnect 5. the migrated projects will send messages on the EZComm subject.

or by the TIBCO BusinessConnect 3.6.6 palette.3 palette (such as the TIBCO BusinessConnect 3. the TIBCO BusinessConnect 3.124 | Chapter 11 tibXML Integration • Since EZComm 5.6 palette schema: if an Initiator Response message has such fields.6 project opened in TIBCO Designer 5. deleteResponseFile TIBCO BusinessConnect EZComm Protocol User’s Guide .6 palette opened using the TIBCO BusinessConnect 5.6 palette migrated before the import) will fail.5 that has the TIBCO BusinessConnect 5.3 palette).3 generates the private process messages the same way as TIBCO BusinessConnect 3. the TIBCO BusinessConnect 3. they will not be received by the TIBCO BusinessConnect 3.6 palette (TIBCO BusinessConnect 3.6 palette schema: if the Responder Request message contains such fields.6 palette will fail. • Receive Response Activity There are no responseFile or elements defined in migrated 3. The two activities that are affected are: • Receive Request Activity There are no requestFile or deleteRequestFile elements defined in the TIBCO BusinessConnect 3.

page 127 Private Process Migration. page 128 Outbound File Poller Migration. Topics • • • • Overview. page 130 TIBCO BusinessConnect EZComm Protocol User’s Guide .3 Migration This appendix explains migration of TIBCO BusinessConnect EZComm Protocol from version 5.1 to version 5. page 126 Public Messages Migration.1 to 5.| 125 Chapter 12 EZComm 5.3.

3. All operations migrated from the version 5. BC/Notify will be migrated to BC/Empty/Notify.1.0.1 will have Empty in the middle level. for example.126 | Chapter 12 EZComm 5. section Changes in Functionality. which are available in the Operations tab. • • TIBCO BusinessConnect EZComm Protocol 5.3 Migration Overview Configuration changes in TIBCO BusinessConnect EZComm Protocol 5. TIBCO BusinessConnect EZComm Protocol User’s Guide . XML schema validation is split into inbound and outbound schema validations. Signing and encryption options are moved to the Request Action Tab.1 to 5.0 is backward compatible with TIBCO BusinessConnect EZComm Protocol 5.3 are as follows: • Operations have been changed to contain three instead of two levels. Important migration points are explained in the following sections: • • • Public Messages Migration Private Process Migration Outbound File Poller Migration Operation changes between tibXML and EZComm are explained in the TIBCO BusinessConnect Release Notes.

3 is defined in three levels as <category>/<version>/<operation>. TIBCO BusinessConnect EZComm 5.3 verifies the version number of the operation. for Notify operation TIBCO BusinessConnect 5. TIBCO BusinessConnect EZComm 5. It will then interpret it as three level operation with Empty as the middle level (such as BC/Empty/Notify).3 as Responder and 5.1 is defined in two levels as <category>/<operation>. The migrated Notify operation from TIBCO BusinessConnect 5. while the same operation in TIBCO BusinessConnect 5.3 as the Responder.1 configuration store are migrated to version 5.1 is denoted with an 'Empty' version identifier. it will receive a two level operation (such as BC/Notify).1 as Initiator When using EZComm 5.3 as Initiator and 5. as Responder When sending the request to the trading partner. which is done when operations or the TIBCO BusinessConnect 5. then it generates a two-level operation(<Category>/<Operation>) and sends the request to the trading partner.1. If this value is 'Empty'.3. TIBCO BusinessConnect EZComm Protocol User’s Guide .Public Messages Migration 127 | Public Messages Migration The Notify operation from TIBCO BusinessConnect 5.

1 Private processes should be able to interpret the version 5.1. See TIBCO BusinessConnect Trading Partner Administration Guide. 2.1 palette Legend BC = TIBCO BusinessConnect BW = TIBCO ActiveMatrix BusinessWorks The migration process contains these steps: 1. EZComm 5. Once opened.3 palette 1 2 BC 5.3 palette.3 Migration Private Process Migration TIBCO BusinessConnect EZComm Protocol version 5.1 configuration store and import it into BusinessConnect 5.1 BW project with BC 5.3 Private Process Migration Server BC 5.3 3 Private Process BW project with BC 5.3 private process messages without any changes. BusinessWorks Palette Migration A migration diagram for private processes is presented in Figure 21.1 private processes can continue to send messages to version 5.3 system. The OperationID field will contain a version number as empty .3 projects by opening them with TIBCO Designer that contains the Business Connect 5.3 without any changes.1 to 5. TIBCO BusinessConnect EZComm Protocol User’s Guide . Figure 21 EZComm 5.1 projects into EZComm 5.1 system. Export Schemas. but the message format will still be as in EZComm 5.128 | Chapter 12 EZComm 5. these projects can no longer communicate with the BusinessConnect 5. Migrate the BusinessConnect Palette Migrate EZComm 5.1 to EZComm 5. Migrate the Configuration Store Export the 5.

TIBCO BusinessConnect EZComm Protocol User’s Guide .Private Process Migration 129 | 3. Complete Migration To complete the migration. and messages will be published in the EZComm 5. After the migration. the configuration store must be imported into the BusinessWorks project.3 format.3 schema will be available in the BusinessWorks activities. the EZComm 5.

they will be published on the version 5.1 can be one of the following: • • EZComm\Partner.1 to 5. they will be published on operation Category/Empty/Operation.3 Migration Outbound File Poller Migration The directory structure for the EZComm 5. or EZComm\Partner\Category_Operation. TIBCO BusinessConnect EZComm Protocol User’s Guide .130 | Chapter 12 EZComm 5.3 default operation (BC\1. the files will be published as follows: • • If files are placed in the folder EZComm\Partner. Depending on their placement in these folders.0\Notify) If files are placed in the folder EZComm\Partner\Category_Operation.

page 132 TIBCO BusinessConnect EZComm Protocol User’s Guide .| 131 Chapter 13 Troubleshooting This appendix offers troubleshooting advice for the EZComm protocol. Topics • Troubleshooting EZComm.

but it cannot verify the signature on the message. there are two types of signed messages that can be exchanged: • Inbound signed messages These messages are posted to the non-repudiation log. there can be no dispute that the message came from this specific trading partner. TIBCO BusinessConnect EZComm Protocol User’s Guide . When using HTTP with EZComm. if TIBCO BusinessConnect would post such outbound signed message into the non-repudiation log. these properties are not set but the location of the source file is set on the OUTPUT_SOURCE_DIR and SRC_FILE_NAME properties instead. are used for signed messages to avoid disputes between trading partners. Therefore. HTTP transport in EZComm does not enter outbound signed messages in the non-repudiation log. upon importing the . For that reason. in general. • Outbound signed messages When a signed message is sent using HTTP outbound. Since the trading partner already signed such message and the signature can be verified. the operation is not imported When an operation in a . there is no ability to request a receipt. The ORIG_FILE_NAME and ORIG_FILE_PATH properties are populated by the protocol to indicate the original source of data. When you use outbound File poller in EZComm. The acknowledgement from the HTTP server about the message arrival is not the same as the acknowledgement from the trading partner who actually received and processed the message.132 | Chapter 13 Troubleshooting Troubleshooting EZComm ORIG_FILE_NAME and ORIG_FILE_PATH are not populated when using outbound File poller to send files from private processes When using outbound File poller to send files from private processes.3 system.csx file already exists in the BusinessConnect 5.csx file this operation will not be imported. When I import the whole configuration in EZComm. The trading partner’s HTTP server can officially acknowledge that the message was received. Outbound transactions for HTTP in EZComm are not entered in the non-repudiation log Non-repudiation logs. the other trading partner could still dispute that they received the message. if any. the file slots ORIG_FILE_NAME and ORIG_FILE_PATH may not be populated.

you need to rename the existing BC/version/operation (such as BC/5. which cannot be renamed or deleted: this operation has to be updated manually. TIBCO BusinessConnect EZComm Protocol User’s Guide . The exception is the default operation BC/1. if you try to import the operation BC/version/operation. which exists by default.Troubleshooting EZComm 133 | For example.0/Notify.3/operation1) in order to import a new operation with the same name.

134 | Chapter 13 Troubleshooting TIBCO BusinessConnect EZComm Protocol User’s Guide .

page 141 Third Tutorial Example. page 143 TIBCO BusinessConnect EZComm Protocol User’s Guide . page 137 Second Tutorial Example.| 135 Appendix A FTP Script Examples This appendix contains some sample scripts for EZComm. page 136 First Tutorial Example. Topics • • • • Overview.

Second Tutorial Example shows how to call Java methods from inside the FTP scripts and how to execute a batch/shell program before sending the file to the FTP server.136 | Appendix A FTP Script Examples Overview The following script examples are included with TIBCO BusinessConnect: • • First Tutorial Example shows simple FTP file transfers using the FTP API provided with TIBCO BusinessConnect. • TIBCO BusinessConnect EZComm Protocol User’s Guide . Third Tutorial Example shows how to connect the SSHFTPClient object to the SSHFTP server.

that directory is created before the file is actually stored in the FTP server.First Tutorial Example 137 | First Tutorial Example The putexample. it puts the file created by the Initiator's outbound process. then the examples/BC directory is not removed.txt BC_installation_directory\samples\bc\ftpscripts\mgetexample. for example. How to Send Files Send a document using BusinessWorks process as described in Chapter 10. This works only in non-proxy mode. The FTPClient object is used to connect to the FTP server. Tutorial Files The following files are part of this tutorial: • • BC_installation_directory\samples\bc\ftpscripts\putexample.txt These are both EcmaScript files. FTPClient object is used to connect to the FTP server. the examples/BC directory is deleted. How putexample. which in this example is the trading host name. If the examples/BC directory is not present. If it is. How mgetexample. TIBCO BusinessConnect EZComm Protocol User’s Guide . Once the files are successfully retrieved.txt Works This script gets the FTPClient object from the job variable that is created at runtime by TIBCO BusinessConnect. the script calls executeMgetCmd to get all the files from the FTP Server. If the files could not be retrieved for some reason. a flag called retryScripts is set to true and passed on to TIBCO BusinessConnect to retry the execution when retry of the outbound process occurs. If it is.txt script puts the document to the FTP server. If there are connection failures. It checks to see if the examples/BC directory is available. if a put is happening at the same time and the file descriptor is being locked by another process. It checks to see if the examples/BC directory is available.txt script does an mget from the FTP server of all files that match a particular search filter. The mgetexample.txt Works This script gets the FTPClient object from the job variable that is created at runtime by BusinessConnect. File Pollers.

4.txt. Enter a name for the transport in the Transport Name field. 13. 3. Click Browse. FTP/S Outbound if you need help. Click change in the Scripts field. 19. Configure trading partners and a business agreement as described in Import the Tutorial. 11. Click Add. Select BC_installation_directory\samples\bc\ftpscripts\putexample. Click Open. 2. Click Save twice. 20. Select Uploaded File from the Type dropdown list. Select FTP as the Primary Transport in the Outbound Transports for Host ’Buyer’ area. 8. 10. 16. Click the EZComm protocol binding. See TIBCO BusinessConnect Trading Partner Administration Guide. Select FTP in the Transport Type dropdown list. click the Transports tab for the EZComm protocol. 9. Enter other information as needed. Steps to Perform on the Responder Machine The following steps must be performed for the Responder machine: 1. Click Save. Click OK. TIBCO BusinessConnect EZComm Protocol User’s Guide . 14.138 | Appendix A FTP Script Examples Set Up the First Tutorial Steps to Perform on the Initiator Machine The following steps must be performed for the Initiator machine: 1. Click TIBCO BusinessConnect > BusinessAgreements > Buyer-Seller. 7. 17. 18. 12. 5. 15. Configure trading partners and a business agreement as described in Configuring the Responder TIBCO BusinessConnect. 6. Click the Transports tab. Click OK. For the participant Seller. Select Script in the File Processing dropdown list.

Click Browse. do the following: a. b. 7. Click Save twice.First Tutorial Example 139 | 2. Select and Configure FTP/S Inbound. Configure FTP. Click Edit FTP Settings in the Inbound Transports for Partner ’Buyer’ area. Start TIBCO BusinessConnect on the Initiator and Responder machines. Send a document using the outbound File poller. click the Application Management > BusinessConnect > Configuration link in the left panel. Click the EZComm protocol binding. 9. c. the directory path should be BaseDir/Seller. 10. Outbound File Poller Fields. 13. 4. Click the BusinessConnect link in the right panel. Select Uploaded File from the Type dropdown list. 3.txt. This directory needs to be named according to the conventions explained in TIBCO BusinessConnect Trading Partner Administration Guide. Click change in the Scripts field. Select Script in the File Processing dropdown list. 6. TIBCO BusinessConnect EZComm Protocol User’s Guide . 5. Click the Transports tab. Specify Seller for the TpName directory. do the following: 1. Select the Delete File checkbox. d. 15. To configure TIBCO BusinessConnect to poll a directory. 12. 14. If you need help. 11. 2. Click OK. If your base directory is BaseDir. Run the First Tutorial Example To run the first tutorial example. see TIBCO BusinessConnect Trading Partner Administration Guide. Click TIBCO BusinessConnect > BusinessAgreements > Buyer-Seller. Click the Private Process Configuration tab. field Directory to Monitor in Table 43. In TIBCO Administrator. Create a directory in which you will put the document that will be transmitted using the FTP script. Click Open. 8. e. Select BC_installation_directory\samples\bc\ftpscripts\mgetexample.

h. In the Directory to Monitor field.txt script. BusinessConnect runs the mgetexample. BusinessConnect polls the directory specified in the inbound FTP configuration in the business agreement. Expected Results After the Initiator BusinessConnect receives the file from the TIBCO ActiveMatrix BusinessWorks process or picks up the file from the outbound file poller directory. the following will happen: • • BusinessConnect establishes contact with the FTP server. BusinessConnect then invokes the putexample. 3.xml into BaseDir/Seller. passing the user name and password specified in the FTP transport configuration for Seller. TIBCO BusinessConnect EZComm Protocol User’s Guide .*. Restart the BusinessConnect server if it was not started when you clicked Deploy. Finally.140 | Appendix A FTP Script Examples f. type BaseDir/Seller/*. When a file is detected. i. j. l. which looks for all the files in the examples/BC directory. Copy the file BC_home\samples\EZComm\sampleXML\xsd\101. the file is written to examples/BC. Click the EZComm link in the Outbound File Poller Configuration area.txt script. • On the Responder. k. g. Select the Enable checkbox. The script looks for the directory examples/BC in the FTP root directory and creates them if they do not exist. Click Save twice. Click Deploy. Click OK.

Copy ftpexample. Stop the BusinessConnect server. is sent to the executeProgram method in the RunProgram class. This example is a demonstration that Java classes can be called from scripts at runtime and external programs can be called by using the Java runtime class. If you want to perform a full round trip of your transaction. the source file name. which is a reference to the file that is stored locally before the script execution takes place. This method sends the fileName reference to a batch/shell program BC_installation_directory\samples\bc\ftpscripts\bcfilemodifier.txt except for one minor change. which adds a CRLF at the end of the document file that is being transferred to the FTP server. Before connecting to the FTP server. you can upload mgetexample. How modifyexample.txt from the first example to retrieve the files from the FTP server so that the Responder trading partner can process the document that was uploaded after the modification.jar Set Up the Second Tutorial The following steps are necessary to set up this tutorial: 1.txt script shows how to call Java methods from inside the FTP scripts and how to execute a batch/shell program before sending the file to the FTP server.txt Works This script is the same as putexample.Second Tutorial Example 141 | Second Tutorial Example The modifyexample. 3. TIBCO BusinessConnect EZComm Protocol User’s Guide . Tutorial Files The following files are part of this tutorial: • • BC_installation_directory\samples\bc\ftpscripts\modifyexample. The batch file/shell program calls the Java class ModifyFile. 2. Once the file is modified it is stored on the FTP server that is available to the trading partner.jar to BC_installation_directory/hotfix/lib. Configure the participants and business agreement on the Initiator following the procedure described in Set Up the First Tutorial.txt BC_installation_directory\samples\bc\ftpscripts\ftpexample. The executePutCmd method is then executed to store the file at the FTP server. The batch/shell program calls a Java program that modifies the document by adding CRLF (\r\n) at the end of the document.

there will be extra CRLF at the end of the file.bc.property.execProgramDir: BC_installation_directory\samples\bc\ftpscripts Run the Second Tutorial Example To run modifyexample. Start the BusinessConnect server.execProgramName: bcfilemodifier java. Expected Results You will notice that the file that is transferred to the FTP server location will contain the extra CRLF. TIBCO BusinessConnect EZComm Protocol User’s Guide . 2. do the following: 1. Add these two properties in the . — — java.tra file in the directory TIBCO_HOME/tra/domain/domain/application/BusinessConnect directory. Send a document using one of the mechanisms described in Run the First Tutorial Example.user.property.user. There is a .142 | Appendix A FTP Script Examples 4.bc.tra file for every BusinessConnect engine. If you are trying to process this document on the Responder.

which in this example is the extension of the filename as well as the size of the file.txt Works The ssh_putexample.runtime.sshftp. it is created before the file is actually stored on the SSHFTP server. TIBCO BusinessConnect EZComm Protocol User’s Guide .transport. the script puts in the file created by the Initiator's outbound process. the files from the examples1 directory are deleted. If the examples1 directory is not present. the script retrieves all files from the examples2 directory whose extension is *.txt script. These files match a particular search filter. In such case. and passed on to BusinessConnect to retry the execution when retry of the outbound process occurs. It checks whether the examples1 directory is available and proceeds as follows: • • If the examples1 directory is present. Once the files are successfully retrieved.ax.txt script gets the SSHFTPClient object from the job variable that is created at runtime by BusinessConnect. which puts the document to the SSHFTP server The ssh_mgetexample. both in proxy or non-proxy mode.bin and whose size is greater than or equal to 200 KB.RETRY_SLOT) may be used to set the value as true. a flag called retryScripts (with the constant name defined in the API com. How ssh_mgetexample. The SSHFTPClient object is used to connect to the SSHFTP server. How ssh_putexample.fw. If it is. which retrieves multiple files from the SSHFTP server. The SSHFTPClient object is used to connect to the SSHFTP server. It checks whether the examples1 directory is available.SSHFTPClient. If the files could not be retrieved for some reason (such as when a communication failure happens). the corresponding tracing and auditing entries are created. Upon successful retrieval. If there are connection failures.tibco.txt Works The ssh_mgetexample. the script calls executeMgetCmd to get all the files from the SSHFTP Server. the retrieved files are deleted.txt script.txt script gets the SSHFTPClient object from the job variable that is created at runtime by BusinessConnect.Third Tutorial Example 143 | Third Tutorial Example Two scripts are used for the third tutorial example: • • The ssh_putexample.

click the Transports tab for the EZComm protocol. 3. 4.txt These are both EcmaScript files. Click Open. 6. Configure SSHFTP Outbound for more information. Set Up the Third Tutorial Steps to Perform on the Initiator Machine The following steps must be performed on the Initiator machine: 1. Click Browse. Enter other information as needed. 11. 7. 2. Enter the transport name in the Transport Name field. TIBCO BusinessConnect EZComm Protocol User’s Guide . 10. 14. Click Add. send a document using BusinessWorks process as described in Chapter 10.txt bc_home\examples\bc\sshftpscripts\ssh_mgetexample. Click OK.144 | Appendix A FTP Script Examples Tutorial Files The following files are part of this tutorial: bc_home\examples\bc\sshftpscripts\ssh_putexample. 13. 8. Select Script in the File Processing dropdown list.txt. File Pollers. How to Send Files For this example. 12. See the TIBCO BusinessConnect Trading Partner Administration Guide. 9. Select Uploaded File from the Type dropdown list. For the participant Seller. Select bc_home\examples\bc\sshftpscripts\ssh_putexample. Select SSHFTP in the Transport Type dropdown list. Configure trading partners and a business agreement as described in Configuring the Initiator TIBCO BusinessConnect. Click OK. Click change in the Scripts field. Click Save. 15. 5.

Select Script in the File Processing dropdown list. Click Edit SSHFTP Settings in the Inbound Partner'Buyer' area. Click OK. 20. Select the Delete File checkbox. Configure trading partners and a business agreement as described in Configuring the Responder TIBCO BusinessConnect. 8. Steps to Perform on the Responder Machine The following steps must be performed for the Responder machine: 1. 10. Select Uploaded File from the Type dropdown list. 18. Click Browse. 9. Click the Transports tab.txt. see the TIBCO BusinessConnect Trading Partner Administration Guide. 14. 13. 19. 3. 17. 15. Select bc_home\examples\bc\sshftpscripts\ssh_mgetexample. 2.Third Tutorial Example 145 | 16. Click the Transports tab. Select SSHFTP as the Primary Transport in the Outbound Transports for the Host 'Buyer' area. Click the EZComm protocol binding. Click Open. 11. 6. Configure FTP. Click the EZComm protocol binding. 7. 4. Select and Configure SSHFTP Inbound. Click change in the Scripts field. Click BusinessConnect > BusinessAgreements > Buyer-Seller. 12. Click BusinessConnect > BusinessAgreements > Buyer-Seller. Transports for TIBCO BusinessConnect EZComm Protocol User’s Guide . Click Save twice. 5. Click Save twice. For more information.

click the Application Management > BusinessConnect > Configuration link in the left panel. in the field Directory to Monitor in Table 43. d. In the Directory to Monitor field. l. To configure BusinessConnect to poll a directory. e. Copy the file bc_home\samples\EZComm\sampleXML\xsd\101. Select the Enable checkbox. Create a directory in which you will put the document that will be transmitted using the FTP script. 2. do the following: a. Outbound File Poller Fields.xml into the directory BaseDir/Seller. Click OK.146 | Appendix A FTP Script Examples Run the Third Tutorial Example To run the third tutorial example. Click the EZComm link in the Outbound File Poller Configuration area. Start BusinessConnect on the Initiator and Responder machines. k. Restart the BusinessConnect server if it was not started when you clicked Deploy. Click Save twice. Specify Seller for the TpName directory. Click the BusinessConnect link in the right panel. h. If your base directory is BaseDir. the directory path should be BaseDir/Seller. type BaseDir/Seller/*. j. Click Deploy. Send a document using the outbound File poller. f. do the following: 1. In TIBCO Administrator. Click the Private Process Configuration tab. i.*. g. This directory must be named according to the conventions explained in the TIBCO BusinessConnect Trading Partner Administration Guide. b. TIBCO BusinessConnect EZComm Protocol User’s Guide . 3. c.

the following will happen: • BusinessConnect will establish contact with the SSHFTP server and authenticate with the selected authentication method specified in the SSHFTP transport configuration for Seller (either rsa/dsa public key or user name/password).Third Tutorial Example 147 | Expected Results After the Initiator BusinessConnect receives the file from the BusinessWorks process. TIBCO BusinessConnect EZComm Protocol User’s Guide . BusinessConnect retrieves this file through the script ssh_mgetexample. • • On the Responder machine.txt. BusinessConnect then invokes the ssh_putexample. the file is written to the directory examples1. or picks up the file from the outbound File poller directory. When a file is detected.txt script. This script looks for files in the examples1 and examples2 directories as described above. and creates it if it does not exist. The script looks for the directory examples1 in the SSHFTP root directory. BusinessConnect runs the configured script that polls the specified directories. Finally.

148 | Appendix A FTP Script Examples TIBCO BusinessConnect EZComm Protocol User’s Guide .

Index 149 | Index A about EZComm 2 about EZComm public messages 40 about schema validation in EZComm 40 add binding for the host 66 add new category 47 add new operation 48 add new version 48 add properties 54 Asynchronous Request Response operation 45 audit logs for EZComm 90 C caching of schemas 40 configure agreement protocol binding for EZComm 65 customer support xvii D delete properties 54 Document Security for Business Agreements 71 duplicate message detection 4.notify.preserveSubject 54 F E edit agreement for Initiator Show Advanced 73 error codes 121 File transport 103 fileName 36 first tutorial example 137 TIBCO BusinessConnect EZComm Protocol User’s Guide .email. 41 exchanging URIs Email transport 34 File transport 34 FTP transport 35 HTTP transport 36 EZComm error messages 86 features 3 general messages 86 Initiator Inbound Response 79 Initiator messages 77 Initiator Outbound Request 77 logging support 4 operation support 4 Responder Acknowledgement 85 Responder Inbound Request 81 Responder messages 81 Responder Outbound Response 83 security 4 support for multiple attachments 4 support for private transports 3 support for public transports 3 tibXML protocol integration 4 XML validation 4 EZComm public messages overview 40 EZComm URIs exchange 34 ezcomm.

email.preserveSubject 54 set up the second tutorial 141 set up the third tutorial 144 shadow credential usage for EZComm 71 statuscode and statusmsg field reference 121 support.interior.notify.txt 143 ssh_putexample. contacting xvii Synchronous Request Response operation 44 N non-repudiation logs for EZComm 93 Notify operation 43 T O Operation tab 49 outbound duplicate detection criteria 41 outbound File Poller migration 130 outbound File Pollers for EZComm 102 technical support xvii third tutorial example 143 expected results 147 how to send files 144 ssh_mgetexample.150 | Index H Host can Initiate Override Outbound Settings 67 R Request Action tab 50 resend logs for EZComm 96 resending EZComm private process messages 88 Response Action tab 51 run the first tutorial example 139 run the third tutorial example 146 running the tutorial 26 I inbound duplicate detection criteria 42 S M managing properties 54 mgetexample.txt example 137 TIBCO BusinessConnect EZComm Protocol User’s Guide .pp.txt example 137 migration overview 126 modifyexample.threshold 57 set up the property ezcomm.txt example 141 second tutorial example 141 set up the first tutorial 138 set up the property ezcomm.txt 143 steps on the Initiator machine 144 steps on the Responder machine 145 tutorial files 144 TIBCO_HOME xiv P Partner Can Initiate Override Inbound Settings 69 private process migration 128 public messages migration 127 putexample.

Index 151 | tibXML deprecated features 125 packaging 108 passthrough 108 private process integration 109 protocol Integration 105 tibXML message formatting 117 tibXML message packaging 118 tibXML private process migration 122 Transports for Business Agreements 72 troubleshooting EZComm 132 troubleshooting the tutorial 39 tutorial about 8 assign components to machines 11 configure connections to Initiator BusinessConnect 23 configure connections to Responder BusinessConnect 25 configure Initiator business agreement 16 configure Responder business agreement 20 configure Responder default host 18 configure Responder partner 19 configure the Initiator default host 13 configure the Initiator partner 14 configuring Initiator BusinessConnect 13 configuring Responder BusinessConnect 18 configuring the private processes 22 create deployment configuration 9 deploy and start BusinessConnect 11 edit application configuration 10 import operation 12 open the BusinessWorks project 22 operation bindings for Initiator business agreement 16 operation bindings for Responder business agreement 20 override transport for Initiator business agreement 17 override transport for Responder business agreement 21 set up server transport 10 U using shadow credentials to receive signed or encrypted messages 71 using shadow credentials to send signed or encrypted messages 71 TIBCO BusinessConnect EZComm Protocol User’s Guide .