Sunteți pe pagina 1din 180

TIBCO BusinessConnect

RosettaNet Protocol
Users Guide
Software Release 5.2.0
January 2008

Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN TIBCO BUSINESSCONNECT ROSETTANET PROTOCOL
INSTALLATION GUIDE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP
END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE
SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR
USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE
SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and
treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO
Software Inc.
TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO Adapter, TIBCO
ActiveExchange, TIBCO BusinessConnect, TIBCO Administrator, TIBCO BusinessWorks, TIBCO Designer,
TIBCO Rendezvous, TIBCO BusinessPartner, TIBCO Enterprise Message Service, and TIBCO Hawk are either
registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.
EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun
Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A
SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE
INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE
IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN
THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright 1999-2008 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information

| iii

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Third Party Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

x
x
x
x

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
How to Contact TIBCO Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Chapter 1 Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol . . . 1


RosettaNet and TIBCO BusinessConnect RosettaNet Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
TIBCO BusinessConnect RosettaNet Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Private Messages and Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Public Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Process Flows and Activity Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Processing Private ProcessInitiated PIPs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Processing Trading PartnerInitiated PIPs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Duplicate Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Inbound Duplicate Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Outbound Duplicate Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2 Preparing to Use TIBCO BusinessConnect RosettaNet Protocol . . . . . . . . . . . . . . 11


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Exchanging Information with Your Trading Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Configuring Your BusinessConnect Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Transports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Large Payload and Attachment Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 3 Managing RosettaNet PIPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17


Managing RosettaNet PIPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Importing RosettaNet PIPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
TIBCO BusinessConnect RosettaNet Protocol Users Guide

iv

| Contents
Adding RosettaNet PIPs Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Notify and Request-Response Activity Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Action-Specific Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Understanding Action and Signal Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20
21
23
26

Exporting PIPs, Versions, and Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28


Creating XSD Files from DTD Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Chapter 4 Setting Up Trading Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31


Configuring RosettaNet Protocol for Trading Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Adding Domain Identities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Roles Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 5 Setting Up Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37


Configuring RosettaNet for Trading Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Adding Domain Identities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Roles Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Chapter 6 Configuring Agreement Protocol Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45


Configuring Business Agreements with RosettaNet Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring Operation Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Binding Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Operation Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Operation Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Action Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47
47
47
48
52
53

Setting Document Security Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54


Configuring Transports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound Transports for Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound Transports for Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overriding Outbound Transport Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

56
56
57
57

Scheduled Transmission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Overriding Participant Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 7 Private Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61


Configuring Private Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Standalone Private Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Contents v

TIBCO BusinessWorks Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62


Private Process Message Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound Request Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound Request Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advisory Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Additional Data Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Request and Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63
64
66
70
74
77
80
81
83

Advisory and Error Status Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84


Data Substitutions in PIP Request and Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Applicable XML Data for Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Configuring for Data Substitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Configuring Private Processes with TIBCO BusinessWorks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configuring BCServerConfig Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configuring Send and Receive Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Chapter 8 Viewing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93


Logging Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Viewing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Audit Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transaction Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
State Details View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

95
95
96
96

Non-Repudiation Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Summary View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Message Queue Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Resend Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Resending RECEIVED-TP-REQUEST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Resending RECEIVED-PP-REQUEST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Logging to the File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Directory Structure and Filenames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Unmatched Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Customizing Non-Repudiation Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Non-Repudiation Logging for PIP Transactions or Action and Signal Messages. . . . . . . . . . . . . . . . . . . . 104
Digital Signatures Without Non-Repudiation Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Chapter 9 Tutorial Standalone Private Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

TIBCO BusinessConnect RosettaNet Protocol Users Guide

vi

| Contents
Participant Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Setting Up Initiator on Machine 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Setting Up Responder on Machine 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Running the Tutorial Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Initiators Private Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring Responders Private Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running Simulated Private Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing the Audit Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Understanding the Flow of Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

124
124
125
125
125
127

Chapter 10 Tutorial TIBCO BusinessWorks Private Processes . . . . . . . . . . . . . . . . . . . . . 129


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Using Example Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opening the Example Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setting Up Example Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initiator Process Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Responder Process Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

131
131
132
134
135

Running the Tutorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Running Responder on Machine 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running Initiator on Machine 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

137
137
137
138

Appendix A PIP States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141


Appendix B Property Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Appendix C Configuration Store Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Appendix D Smart Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Appendix E Data Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Audit Table Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Non-Repudiation Table Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Table Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| vii

Tables

Table 1

General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Table 2

Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Table 3

General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 4

Private Process Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Table 5

RNIF 2_0 Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table 6

Action-Specific General Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Table 7

Action and Signal Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Table 8

Trading Host General Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Table 9

Trading Partner General Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Table 10

Override Operation Settings: General Sub-Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Table 11

Override Operation Settings: Private Process Sub-Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Table 12

Override Operation Settings: RNIF 2.0 Sub-Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Table 13

Action Settings Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Table 14

Transports Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Table 15

Document Security Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Table 16

Outbound Transports for Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Table 17

Inbound Transport Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Table 18

Scheduled Transmission Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Table 19

BCRequestFromPP Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Table 20

RNRequestFromPP Object Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Table 21

BCRequestoPP: TIBCO BusinessConnect to Responder Private Process Message . . . . . . . . . . 67

Table 22

RNRequestToPP Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Table 23

BCResponseFromPP: Responder Private Process to TIBCO BusinessConnect Message. . . . . . 70

Table 24

RNResponseFromPP Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Table 25

StatusInfo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Table 26

BCResponseToPP Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Table 27

RNResponseToPP Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Table 28

AdvisoryInfo Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
TIBCO BusinessConnect RosettaNet Protocol Users Guide

viii

| Tables
Table 29

RNAdvisoryInfo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Table 30

ErrorNotify Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Table 31

TPInfo Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Table 32

AttachmentInfo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Table 33

statusCode and statusMsg Field Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Table 34

Substitutable Pariticipant Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Table 35

Audit Log, Summary View Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Table 36

Audit Log, Transaction Details View Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Table 37

Non-Repudiation Log Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Table 38

Message Queue Log Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Table 39

Resend Log Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Table 40

Options for Configuring Non-Repudiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Table 41

Participant Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Table 42

PIP States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Table 43

Error States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Table 44

Property Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Table 45

RosettaNet metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Table 46

Smart Routing Fields for RosettaNet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| ix

Preface

This manual explains how to use TIBCO BusinessConnect RosettaNet Protocol.

Topics

Related Documentation, page x

Typographical Conventions, page xi

How to Contact TIBCO Support, page xiii

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Preface

Related Documentation
This section lists documentation resources that you may find useful.

TIBCO Product Documentation


The following documents form the TIBCO BusinessConnect RosettaNet Protocol
documentation set:

TIBCO BusinessConnect RosettaNet Protocol Installation Guide Read this manual


to learn about installing TIBCO BusinessConnect RosettaNet Protocol.

TIBCO BusinessConnect RosettaNet Protocol Users Guide Read this manual to


learn about using TIBCO BusinessConnect RosettaNet Protocol.

TIBCO BusinessConnect RosettaNet Protocol Release Notes Read the release notes
for a list of new and changed features. This document also contains lists of
known issues and closes issues for this release.

Other TIBCO Product Documentation


You may find it useful to read the documentation for the following TIBCO
products:

TIBCO BusinessConnect software

TIBCO BusinessWorks software

TIBCO Administrator software

TIBCO Rendezvous software

Third Party Documentation


The specification for all RosettaNet PIPs can be found at
http://www.rosettanet.org.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Typographical Conventions xi

Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention

Use

code font

Code font identifies commands, code examples, filenames, pathnames, and


output displayed in a command window. For example:
Use M y C o m m a n d to start the foo process.

bold code

Bold code font is used in the following ways:

font

In procedures, to indicate what a user types. For example: Type a d m i n .

In large code samples, to indicate the parts of the sample that are of
particular interest.

In command syntax, to indicate the default parameter for a command. For


example, if no parameter is specified, M y C o m m a n d is enabled:
MyCommand [e n a b l e | disable]

italic font

Key
combinations

Italic font is used in the following ways:

To indicate a document title. For example: See TIBCO BusinessWorks Concepts.

To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.

To indicate a variable in a command or code syntax that you must replace.


For example: M y C o m m a n d pathname

Key name separated by a plus sign indicate keys pressed simultaneously. For
example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

xii

Preface

Table 2 Syntax Typographical Conventions


Convention

Use

[ ]

An optional item in a command or code syntax.


For example:
MyCommand [optional_parameter] required_parameter

A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3

{ }

A logical group of items in a command. Other syntax notations may appear


within each logical group.
For example, the following command requires two parameters, which can be
either the pair p a r a m 1 and p a r a m 2 , or the pair p a r a m 3 and p a r a m 4 .
MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter
can be either p a r a m 1 or p a r a m 2 and the second can be either p a r a m 3 or p a r a m 4 :
MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters.
The first parameter must be p a r a m 1 . You can optionally include p a r a m 2 as the
second parameter. And the last parameter is either p a r a m 3 or p a r a m 4 .
MyCommand param1 [param2] {param3 | param4}

TIBCO BusinessConnect RosettaNet Protocol Users Guide

How to Contact TIBCO Support xiii

How to Contact TIBCO Support


For comments or problems with this manual or the software it addresses, please
contact TIBCO Support as follows.

For an overview of TIBCO Support, and information about getting started


with TIBCO Support, visit this site:
http://www.tibco.com/services/support

If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user
name, you can request one.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

xiv

Preface

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol 1

Chapter 1

Introduction to RosettaNet and TIBCO


BusinessConnect RosettaNet Protocol

This chapter describes RosettaNet and TIBCO BusinessConnect RosettaNet


Protocol.

Topics

RosettaNet and TIBCO BusinessConnect RosettaNet Protocol, page 2

Features, page 3

Messages, page 4

Process Flows and Activity Types, page 6

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| Chapter 1

Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol

RosettaNet and TIBCO BusinessConnect RosettaNet Protocol


RosettaNet is an international organization that has created a standardized
XML-based business protocol for conducting electronic business transactions.The
RosettaNet business protocol was designed to enable buyers, sellers, aggregators,
and intermediaries to conduct transactions over the Internet. RosettaNet
transactions involve the exchange of documents, most of which correspond to
hardcopy documents traditionally used in business. These documents are simple
text files, but they have well-defined structures and contents due to the use of
RosettaNet Partner Interface Processes (PIPs).
RosettaNet PIPs are business processes that define the interaction between
trading partners using standardized XML documents. PIPs represent common
formats, processes, content, and security for electronic business. Both partners in
a trading interaction agree to use the same PIPs and conform to the RosettaNet
security requirements.
RosettaNet is based on the RosettaNet Implementation Framework (RNIF), which
provides the necessary specifications for interoperability between applications,
allowing for the secure exchange of business messages.
Data is represented differently in every companys internal enterprise system. The
various forms of product data representation that exist in internal systems must
be converted by internal company processes into a common RosettaNet
compliant e-business document. Partners can then interact without altering their
internal systems.
The sharing of a common RosettaNet e-business interface between partners
enables electronic business transactions to proceed smoothly through automated
communication. RosettaNet security requirements ensure that transactions take
place in a secure environment and that they are not subject to repudiation.

TIBCO BusinessConnect RosettaNet Protocol


TIBCO BusinessConnect RosettaNet Protocol is the TIBCO implementation of
RosettaNet. It acts as a plug-in to TIBCO BusinessConnect and uses business
process models that conform to the RosettaNet Partner Interface Process
standard, which enables you to conduct e-business transactions with your trading
partners using RosettaNet.
TIBCO BusinessConnect RosettaNet Protocol implements the RNIF 1.1 and RNIF
2.0 standards. It is supported on several platforms and is highly scalable.
Moreover, it supports all PIPs listed as approved standards on the RosettaNet
web site at http://www.rosettanet.org.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Features 3

Features
The following are major features in TIBCO BusinessConnect RosettaNet Protocol:

Integrated with TIBCO BusinessWorks

Synchronous/asynchronous request-response and notify transaction types

HTTP, HTTPS, HTTPSCA, and SMTP transport protocols

Compression for compliance with the relevant RosettaNet technical advisory


(RNIF 2.0 only)

Authentication through signing with digital signatures (S/MIME)

Non-repudiation of PIPs

Document-level compression and encryption (RNIF 2.0 only)

Validation of XML documents with DTDs and XSDs

Configurable timing constraints, such as how long to wait for a response from
a private process

Smart routing of private messages

Multiple trading partner identities

Out-of-order forwarding of response documents. This allows the initiator's


private process to receive the response document even if the response
acknowledgment to the partner fails.

Automatic resend of response documents for duplicate inbound requests

Overriding settings in business agreements, including PIP roles, service codes,


and transports

Large file handling using file references

Cancelling transactions

Scheduled transmissions of outbound PIP requests

For a list of the features available with each instance of TIBCO BusinessConnect,
see Features in the TIBCO BusinessConnect Trading Partner Administration Guide.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| Chapter 1

Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol

Messages
In a RosettaNet transaction, two partners exchange business documents over the
Internet based on the pre-defined rules of RosettaNet. RosettaNet specifies what
message formats and transport protocols the partners have agreed to use, among
other options. See Anatomy of a Business Protocol in the TIBCO BusinessConnect
Trading Partner Administration Guide for more information on the partner
agreement.
The exchange of business documents is known as the process flow. In any process
flow, two types of messages are exchanged:

Private messages

Public messages

Private Messages and Processes


Private messages are exchanged between private processes and TIBCO
BusinessConnect RosettaNet Protocol. Private messages can contain a request,
response, or notification document. For a detailed description of TIBCO
BusinessConnect RosettaNet Protocol private messages, see Private Process
Message Formats on page 63.
Private processes handle conversion from internal to public data and back.

Outbound The private processes convert internal data to a RosettaNet PIP


request, notification, or response document.

Inbound The private processes convert the RosettaNet PIP documents to

internal company data, suitable for internal applications.


The following types of private processes are available with TIBCO
BusinessConnect RosettaNet Protocol:

Standalone Standalone private processes use TIBCO Rendezvous Certified


Messaging or JMS Messaging to communicate with TIBCO BusinessConnect
RosettaNet Protocol. For an example, see Chapter 9, Tutorial Standalone
Private Processes, on page 107.

TIBCO BusinessWorks TIBCO BusinessWorks processes can either send

requests to a TIBCO BusinessConnect RosettaNet Protocol server, or receive


replies from a TIBCO BusinessConnect RosettaNet Protocol server. For an
example, see Chapter 10, Tutorial TIBCO BusinessWorks Private Processes,
on page 129.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Messages 5

Besides messaging, private processes perform data conversion. Before you can
process electronic purchase requests from your customers, or initiate an order
going to your suppliers, you must translate your internal data representation into
the appropriate format. TIBCO BusinessConnect RosettaNet Protocol supports
unparsed XML documents.
The private processes that you create to initiate or respond to PIPs must transform
your internal data format into and out of XML, and typically needs to perform
translation of elements such as customer numbers, part numbers, and shipping
instructions into the appropriate RosettaNet XML format.

Public Messages
TIBCO BusinessConnect takes care of the public process exchanges documents
with a trading partner over the Internet using the message formats and protocols
specified by RosettaNet Implementation Framework (RNIF).

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| Chapter 1

Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol

Process Flows and Activity Types


This section describes in detail how TIBCO BusinessConnect RosettaNet Protocol
processes PIP request or notify messages initiated by private processes as well as
external trading partners.

Processing Private ProcessInitiated PIPs


The following steps occur when TIBCO BusinessConnect RosettaNet Protocol
processes trading private processinitiated PIP:
1. A private process publishes a message of class B C R e q u e s t F r o m P P on TIBCO
Rendezvous or on an implementation of Java Message Service (JMS), such as
TIBCO Enterprise Message Service.
2. TIBCO BusinessConnect RosettaNet Protocol performs the following
functions:
a. Retrieves the message from Rendezvous or JMS.
b. Verifies the PIP code, PIP transaction ID, and participant data specified in
the B C R e q u e s t F r o m P P message.
c. If configured, validates the XML-formatted request document.
d. Verifies the XML data in the request action against its configuration store
and determine if the outbound request.
e. Constructs a RosettaNet request action message using information
provided by the private process or from its configuration store, including
the host and partners participant information, digital signature, and so
on.
f.

Wrap the RosettaNet request action message along with any attachments
into a MIME-formatted envelope.

g. Establishes a connection at the trading partners URL with the appropriate


transport protocol based on the business agreement settings, and posts the
RosettaNet action message.
3. TIBCO BusinessConnect RosettaNet Protocol waits for the request signal
message (receipt acknowledgment) and resends the request action if
necessary.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Process Flows and Activity Types 7

4. Upon receiving the request signal from the trading partner, TIBCO
BusinessConnect RosettaNet Protocol performs the following functions:
a. Decrypts and authenticates the request signal.
b. If configured, validates the XML-formatted request signal.
c. Verifies the XML data in the request signal (except for the Supply Chain
Code and Partner Classification Code elements).
d. Completes the transaction (in a notify transaction) or continutes waiting
for the response action message from the trading partner (in a
request-response transaction).
5. Upon receiving the response action message, TIBCO BusinessConnect
RosettaNet Protocol performs the following functions:
a. Decrypts and authenticates the response action.
b. If configured, validates the XML-formatted response action.
c. Verifies the XML data in the response action (except for the Supply Chain
Code and Partner Classification Code elements).
d. Establishes a connection at the trading partners URL with the appropriate
transport protocol based on the business agreement settings, and sends a
response signal message (receipt acknowledgment) to the trading partner.
e. Formats the response into a B C R e s p o n s e T o P P message and publishes the
message on Rendezvous or JMS.
f.

Completes the transaction.

6. The private process retrieves the B C R e s p o n s e T o P P message from Rendezvous


or JMS and processes it.
If an error occurs at any point in the process, TIBCO BusinessConnect RosettaNet
Protocol terminates the transaction and sends an E r r o r N o t i f y message on
Rendezvous or JMS for the private process with the error information.

Processing Trading PartnerInitiated PIPs


The following steps occur when TIBCO BusinessConnect RosettaNet Protocol
processes trading partnerinitiated PIP:
1. Upon receiving a PIP request action message, TIBCO BusinessConnect
RosettaNet Protocol performs the following functions:

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| Chapter 1

Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol

a. Decrypts and authenticates the request action.


b. If configured, validates the XML-formatted request action.
c. Verifies the XML data in the request action against its configuration store
and determine if the inbound request is allowed (except for the Supply
Chain Code and Partner Classification Code elements).
d. Establishes a connection at the trading partners URL with the appropriate
transport protocol based on the business agreement settings, and sends a
request signal message (receipt acknowledgment) to the trading partner.
e. Formats the request action into a B C R e q u e s t T o P P message and publishes
the message along with attachments on Rendezvous or JMS.
2. For a notify transaction, TIBCO BusinessConnect RosettaNet Protocol
completes the transaction. For a request-response transaction, it waits for a
B C R e s p o n s e F r o m P P message from the private process.
3. The private process retrieves the B C R e q u e s t T o P P message from Rendezvous
or JMS and processes it. If the request action is for a request-response
transaction, it must respond by publishing a B C R e s p o n s e F r o m P P message on
Rendezvous or JMS.
4. TIBCO BusinessConnect RosettaNet Protocol retrieves the response from
Rendezvous or JMS and performs the following functions:
a. Verifies the PIP code, PIP transaction ID, and participant data specified in
the B C R e s p o n s e F r o m P P message.
b. If configured, validates the PIP response document in the message.
c. Verifies the XML data in the response action against its configuration
store.
d. Constructs a RosettaNet response action message using information
provided by the private process or from its configuration store, including
the host and partners participant information, digital signature, and so
on.
e. Wrap the RosettaNet response action message along with any attachments
into a MIME-formatted envelop.
f.

Establishes a connection at the trading partners URL with the appropriate


transport protocol based on the business agreement settings, and sends
the response action message to the awaiting trading partner.

g. Waits for a response signal message (receipt acknowledgment) from the


trading partner and resends the response action message if necessary.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Process Flows and Activity Types 9

5. Upon receiving the response signal message, TIBCO BusinessConnect


RosettaNet Protocol performs the following functions:
a. Decrypts and authenticates the response signal.
b. If configured, validates the response signal.
c. Verifies the XML data in the response signal against its configuration store
(except for the Supply Chain Code and Partner Classification Code
elements).
d. Completes the transaction.
If an error occurs at any point in the process, TIBCO BusinessConnect RosettaNet
Protocol terminates the transaction and sends an E r r o r N o t i f y message on
Rendezvous or JMS for the private process with the error information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

10

| Chapter 1

Introduction to RosettaNet and TIBCO BusinessConnect RosettaNet Protocol

Duplicate Detection
You can utilize the duplicate detection functionality in TIBCO BusinessConnect
RosettaNet Protocol to deal with duplicate inbound and outbound messages
according to your preferences.

Inbound Duplicate Detection


TIBCO BusinessConnect RosettaNet Protocol marks an inbound message as a
duplicate if it contains the process identifier of a successfully processed PIP. By
default, it forwards such a message to the private process with the i s D u p l i c a t e
field set to t r u e (see Inbound Request Format on page 66 and Inbound Response
Format on page 74).
You can change the behavior of TIBCO BusinessConnect RosettaNet Protocol
when it detects inbound duplicate messages. The options are:

Send an automatic response to the trading partner for a duplicate message


(see General Tab on page 33 for more information).

Do not forward the duplicate message to the private process but send an
exception signal to the trading partner (see Appendix B, Property Reference,
on page 145 for more information).

Outbound Duplicate Detection


By default, TIBCO BusinessConnect RosettaNet Protocol does not perform special
processing of duplicate outbound messages. You can, however, configure TIBCO
BusinessConnect RosettaNet Protocol to detect outbound messages and terminate
the processing (see Appendix B, Property Reference, on page 145 for more
information).
TIBCO BusinessConnect RosettaNet Protocol marks an outbound message from
the private process as a duplicate if it contains the process identifier of a
successfully processed PIP (in the t r a n s a c t i o n I D field of B C R e q u e s t F r o m P P
messages or the r e s p o n d e r T r a c k i n g I D field of B C R e s p o n s e F r o m P P messages, see
Outbound Request Format on page 64 and Outbound Response Format on
page 70 for more information). Once outbound duplicate detection is enabled,
TIBCO BusinessConnect RosettaNet Protocol terminates a transaction as soon as
it detects a duplicate outbound message.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 11
Chapter 2

Preparing to Use TIBCO BusinessConnect


RosettaNet Protocol

This chapter explains the necessary tasks you must perform before configuring
BusinessConnect participants with RosettaNet protocol.

Topics

Overview, page 12

Exchanging Information with Your Trading Partner, page 13

Configuring Your BusinessConnect Server, page 14

TIBCO BusinessConnect RosettaNet Protocol Users Guide

12

| Chapter 2

Preparing to Use TIBCO BusinessConnect RosettaNet Protocol

Overview
This chapter describes the preliminary information you need in order to configure
your BusinessConnect server for your RosettaNet transactions. It also gives the
instructions for configuring some of this information in your BusinessConnect
server. You must perform all the tasks in this chapter prior to configuring
BusinessConnect participants with RosettaNet protocol.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Exchanging Information with Your Trading Partner 13

Exchanging Information with Your Trading Partner


Before you start conducting e-commerce with your trading partner, you must
perform the following tasks:

Agree on the shared RosettaNet business documents. Trading partners that


use RosettaNet to conduct e-commerce must agree on the RosettaNet PIP
documents they wish to exchange. They can exchange this information via
email, the web, or any other method.

Agree on whether to use document authentication as well as the


authentication method.

Exchange the following information:


Domain Identity The DUNS IDs for you and your trading partner. If you do
not wish to use the default DUNS domain, then you must agree on an
alternate one and exchange IDs for that domain.
Server URLs You and your trading partner need to use each others server
URL to conduct e-commerce transactions. If you agree upon multiple
protocols, you must exchange server URLs for each of the agreed protocols.
Server URLs for TIBCO BusinessConnect RosettaNet Protocol follow the
formats below:
protocol: / / hostName: portNumber/ R o s e t t a N e t

For example:
http://www.myhost.com:6700/RosettaNet
https://www.myhost.com:6705/RosettaNet

Email Addresses If you wish to use email as a transport option, then you
must exhange email addresses.
Public Certificates In order to use HTTPS or HTTPSCA for your RosettaNet
transactions, as well as utilize digital signatures for document
authentication, you must also exchange public certificates.
Partner Classification Codes RosettaNet protocol-specific information
Supply Chain Codes RosettaNet protocol-specific information
Trading Partner Roles RosettaNet protocol-specific information
Location IDs RosettaNet protocol-specific information

TIBCO BusinessConnect RosettaNet Protocol Users Guide

14

| Chapter 2

Preparing to Use TIBCO BusinessConnect RosettaNet Protocol

Configuring Your BusinessConnect Server


You must perform a few tasks in the BusinessConnect console in TIBCO
Administrator before you can sucessfully configure a BusinessConnect
participant with RosettaNet protocol.

Transports
Before you can configure a BusinessConnect participants transport protocol, you
must enable the transport protocols. TIBCO BusinessConnect RosettaNet Protocol
supports four types of transports: HTTP, HTTPS, HTTPSCA, and email.
To configure the transport settings for your BusinessConnect server, see TIBCO
BusinessConnect Trading Partner Administration Guide.
If you wish to use HTTPS or HTTPSCA, you must also install valid certificates in
the Server Identities tab of the Certificate Store configuration panel, which is
accessible at BusinessConnect > System Settings > Certificate Store. For more
information, see TIBCO BusinessConnect Trading Partner Administration Guide.

Large Payload and Attachment Directories


TIBCO BusinessConnect RosettaNet Protocol stores large message payload as
files on the BusinessConnect server. You must configure the directory path and
the threshold of the payload size in the BusinessConnect console.
Follow the instructions below to configure BusinessConnect to place large
messages and attachments to a specific directory:
1. In TIBCO Administrator, click the Application Management >
BusinessConnect > Configuration link in the left panel.
2. Click the BusinessConnect link in the right panel.
3. In the BusinessConnect tab, click the Component Settings sub-tab.
4. Click the Intercomponent Advanced link to open the Intercomponent
Advance Settings panel.
5. Specify a threshold value in the Skip Content Threshold field (in kilobytes).
See Handling Large Payload Size on page 15 for more information on this
field.
6. Specify a valid directory path in the Shared Temporary Directory field.
See Configuring Directories for Large and Shared Files in TIBCO
BusinessConnect Server Administration Guide for more information on this field.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Your BusinessConnect Server 15

Also, see Table 32 on page 82 for more information on specifying and


obtaining the file references for message attachments.
Handling Large Payload Size
When TIBCO BusinessConnect RosettaNet Protocol receives a large inbound
message, it saves the RosettaNet PIP document in the payload and the
attachments into separate files and sends their file references to the private
process.
TIBCO BusinessConnect RosettaNet Protocol determines the payload size by
totalling the size of the PIP document and all the attachments. When this size of
the entire payload exceeds the value of the Skip Content Threshold field, TIBCO
BusinessConnect RosettaNet Protocol saves the PIP document into a separate file
in the directory specified in Shared Temporary Directory, while saving the
attachments each into its own file. For example, if an inbound message payload
contains three attachments, when the payload is saved to file, it is saved into four
separate files: one for the PIP document and three for the attachments.
You can disable large payload handling in the Operations Editor panel via a
checkbox called Send Actual Payload to Private Process Instead of File Refrence.
See Private Process Sub-Tab on page 50 for more information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

16

| Chapter 2

Preparing to Use TIBCO BusinessConnect RosettaNet Protocol

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 17
Chapter 3

Managing RosettaNet PIPs

This chapter explains how to manage RosettaNet PIPs.

Topics

Managing RosettaNet PIPs, page 18

Importing RosettaNet PIPs, page 19

Adding RosettaNet PIPs Manually, page 20

Exporting PIPs, Versions, and Activities, page 28

Creating XSD Files from DTD Files, page 29

TIBCO BusinessConnect RosettaNet Protocol Users Guide

18

| Chapter 3

Managing RosettaNet PIPs

Managing RosettaNet PIPs


The Operations Editor panel organizes RosettaNet PIPs in containers of various
levels. In Operations Editor, RosettaNet PIPs of the same PIP code are grouped
into the same PIP container (for example, 3 A 4 ). Within a PIP container, RosettaNet
PIPs of the same version are further grouped into a version container (for example
1 . 1 ). Within a version container, each RosettaNet PIP transaction is represented
by an activity, which is the most basic unit for a RosettaNet PIPs.
While you can give a container any name you wish, it is recommended that you
follow the naming convention described above in order to keep your RosettaNet
PIPs organized in the Operations Editor panel.
Before you can use RosettaNet in business transactions, you must add these
activities in the Operations Editor panel in TIBCO Administrator. You can add
them in two ways:

Importing PIP Activities The TIBCO BusinessConnect RosettaNet Protocol

installation directory contains configuration data files for each currently


available RosettaNet PIP and version at the time of the software release. You
can import one or more PIPs directly in the Operations Editor panel and
customize them to fit your own needs. See Importing RosettaNet PIPs on
page 19 for more information.

Manually Adding PIP Activities If you wish to use RosettaNet PIPs or versions

for which there are no existing configuration data files (such as RosettaNet
versions later than 1.4), you must add the PIPs and versions manually in the
Operations Editor panel and configure each one accordingly. See Adding
RosettaNet PIPs Manually on page 20 for more information.
To export the PIP activities you have already added in the Operations Editor
panel, see Exporting PIPs, Versions, and Activities on page 28.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Importing RosettaNet PIPs 19

Importing RosettaNet PIPs


Follow the instructions below to import a RosettaNet PIP and version in the
Operations Editor:
1. In TIBCO Administrator, click the BusinessConnect > Operations Editor link
in the left panel.
2. Select RosettaNet from the Protocol drop-down list in the right panel.
3. Click the Edit button.
4. Click Import.
5. Click the Change... link.
6. Click Browse.
7. Navigate to TIBCO_HOME/ b c / version/ p r o t o c o l s / r n / s a m p l e s / P I P S
/ cluster/ segment/ PIP/ version

For example:
TIBCO_HOME/ b c / version/ p r o t o c o l s / r n / s a m p l e s / P I P S / 3 / A / 3 A 4 / 1 . 4 .

8. Select the .csx file for the PIP you wish to import and click Open.
9. Click OK.
10. Click Import.
11. Click Done.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

20

| Chapter 3

Managing RosettaNet PIPs

Adding RosettaNet PIPs Manually


This section gives an overview of the steps required to make a new PIP available
as part of TIBCO BusinessConnect RosettaNet Protocol. The steps are as follows:
1. Download the PIP package from http://www.rosettanet.org.
2. Unzip the PIP package. You should have a set of files consisting of
documentation, Message Guideline, and DTD or XSD schemas.
3. Derive the XML Schema Definition (XSD) file from the DTD and the Message
Guideline. See Creating XSD Files from DTD Files on page 29 for detailed
information.
4. Augment the XSD with constraints specified in the message guideline.
5. Add the new PIP to TIBCO BusinessConnect RosettaNet Protocol. To add a
RosettaNet PIP in Operations Editor, you must perform the following tasks:
Task A, Adding PIP Containers, page 20
Task B, Adding Version Containers, page 20
Task C, Adding PIP Activities, page 21
Task A Adding PIP Containers
Follow the instructions below to add a PIP container:
1. In TIBCO Administrator, click the BusinessConnect > Operations Editor link
in the left panel.
2. Select RosettaNet from the Protocol drop-down list in the right panel.
3. Click the Edit button.
4. Click the RosettaNet radio button.
5. Click New PIP.
6. Type the PIP code as defined in the PIP specification in the Name field.
7. Click Save.
Task B Adding Version Containers
Follow the instructions below to add a version container:
1. Click the radio button for the PIP container you created in Task A.
2. Click New Version.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Adding RosettaNet PIPs Manually 21

3. Type a PIP version number as defined in the PIP specification in the Name
field.
4. Type the PIP code in the PIP Name field. This should be the same PIP code as
the one you used in Task A.
5. Click Save.
Task C Adding PIP Activities
Follow the instructions below to add a PIP activity:
1. Click the radio button for the version container you created in Task B.
2. Click New Activity.
3. Select either Notify or Request-Response from the Operation Type
drop-down list.
4. Click OK.
5. Configure the operation in each tab. For the descriptions of the properties, see
Notify and Request-Response Activity Properties.
6. Click Save.

Notify and Request-Response Activity Properties


Depending on the type of PIP activity you specify in Task C, you see either the
Notify Activity tab or the Request-Response Activity tab when you configure the
activity in the Edit Activity panel. There are three sub-tabs in the Notify Activity
tab and the Request-Response Activity tab. See the respective table for a
description of the tab fields.

General tab (see Table 3 on page 22)

Private Process tab (see Table 4 on page 22)

RNIF 2_0 tab (see Table 5 on page 23)

You can override certain PIP activity settings when configuring protocol bindings
for a business agreement. See Operation Settings Tab on page 48 for more
information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

22

| Chapter 3

Managing RosettaNet PIPs

The following tables contain the settings for Notify and Request-Response
activities.
Table 3 General Tab
Field

Description

Name

The displayed name of the activity.

Description

(Optional) A short description of the activity.

Default RNIF
Version

The default RNIF version to use when the private


process does not specify a valid RNIF version.

From Role
Classification Code

The From role for this activity as specified in RNIF.


Example: Forecast Owner.

To Role
Classification Code

The To role for this activity as specified in RNIF.


Example: Forecast Recipient.

From Business
Service Code

The From business service code for this activity as


specified in RNIF. Example: Forecast Owner Service.

To Business Service
Code

The To business service code for this activity as


specified in RNIF. Example: Forecast Recipient Service.

Table 4 Private Process Tab


Field

Description

Send Parsed XML to


Private Process

(deprecated) Send the XML document as a nested


TIBCO Rendezvous message to the private process.

Send Actual
Payload to Private
Process Instead of
File Reference

Always send the actual payload data to the private


process instead of a file reference. If this checkbox is
selected, then large payload handling is disabled. See
Large Payload and Attachment Directories on page 14
for more information on large payload handling.
Note You must also select the protocol property
b c r n . p p . r e s o l v e F i l e R e f T o A c t u a l D a t a in order to
enable this option. See Appendix B, Property Reference,
on page 145 for more information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Adding RosettaNet PIPs Manually 23

Table 4 Private Process Tab


Field

Description

Private Process
Wait Time

The time in seconds that the BusinessConnect server


waits for the private process to respond to a request
before the server returns an error to the trading partner.

Table 5 RNIF 2_0 Tab


Field

Description

RNIF Payload
Compression

Select this checkbox to enable payload compression for


any outgoing documents. (For inbound PIPs, TIBCO
BusinessConnect RosettaNet Protocol accepts both
compressed and uncompressed documents.)

RNIF 2.0 Payload


Encryption

Choices are:

None

Payload Only

Payload Container

Action-Specific Properties
If the activity is a request-response PIP, there are two additional tabs in the Edit
Activity panel: Request Action and Response Action. If the activity is a notify PIP,
there is only one additional tab called Notify Request Action. These
action-specific tabs enable you to specify details of individual actions in the PIP
activity.
Each of these tabs has three sub-tabs. See the respective sections for each of these
sub-tabs.

General tab (see General Tab on page 24)

Action tab (see Action Tab and Signal Tab on page 26)

Signal tab (see Action Tab and Signal Tab on page 26)

TIBCO BusinessConnect RosettaNet Protocol Users Guide

24

| Chapter 3

Managing RosettaNet PIPs

General Tab
These settings determine how an initiator TIBCO BusinessConnect processes this
request from the local private process before it forwards it to a trading partner,
and how a responder TIBCO BusinessConnect processes this request before
forwarding it to its local private process.
Table 6 Action-Specific General Fields (Sheet 1 of 3)
Field

Description

Name

Name of the action. This name differs for the request


action and the response action. For example, the Create
Purchase Order activity has Purchase Order Acceptance
Action and Purchase Order Cancellation Action.

Description

Optional description of the activity.

Validation DTD
Name

The DTD file RosettaNet provided for this action.


Example: 4 A 4 _ M S _ P D 0 2 _ 0 0 _ F o r e c a s t N o t i f i c a t i o n . d t d

Validation XSD
Name

The XSD file created for this action. Example:


4A4_MS_PD02_00_ForecastNotification.xsd.

See

Creating XSD Files from DTD Files on page 29.


Root XML
Element Name

The top-level DTD/XSD element. The XML document


must conform to the schema of this element.

Maximum
Acknowledgment
Wait (seconds)

The maximum time to wait for an acknowledgement


receipt from the trading partner. When this time expires,
TIBCO BusinessConnect RosettaNet Protocol retransmits
the request or response message to the trading partner for
as many times as is specified in the Maximum Number of
Retransmits field.
You can override the here value per business agreement.
See Action Settings Tab on page 52.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Adding RosettaNet PIPs Manually 25

Table 6 Action-Specific General Fields (Sheet 2 of 3)


Field

Description

Maximum
Response Wait
(seconds)

The maximum time to wait for a response message from


the trading partner. When this time expires, TIBCO
BusinessConnect RosettaNet Protocol retransmits the
request message to the trading partner for as many times
as is specified in the Maximum Number of Retransmits
field.
You can override the value here per business agreement.
See Action Settings Tab on page 52.
Note Do not input anything here if its value is N / A .

Maximum
Number of
Retransmits

The maximum number of times to retransmit the request


or response message. You can override the value here per
business agreement. See Action Settings Tab on page 52.
Note Do not input anything here if its value is N / A .

Synchronous Settings
Maximum
Acknowledgment
Wait (seconds)

In a synchronous transaction, the maximum time to wait


for an acknowledgement receipt from the trading partner.
When this time expires, TIBCO BusinessConnect
RosettaNet Protocol retransmits the request or response
message to the trading partner for as many times as is
specified in the Maximum Number of Retransmits field.
You can override the value here per business agreement.
See Action Settings Tab on page 52.

Maximum
Response Wait
(seconds)

In a synchronous transaction, the maximum time to wait


for a response message from the trading partner. When
this time expires, TIBCO BusinessConnect RosettaNet
Protocol retransmits the request message to the trading
partner for as many times as is specified in the Maximum
Number of Retransmits field.
You can override the value here per business agreement.
See Action Settings Tab on page 52.
Note Do not input anything here if its value is N / A .

TIBCO BusinessConnect RosettaNet Protocol Users Guide

26

| Chapter 3

Managing RosettaNet PIPs

Table 6 Action-Specific General Fields (Sheet 3 of 3)


Field

Description

Maximum
Number of
Retransmits

In a synchronous transaction, the maximum number of


times to transmit the request or response message. You
can override the value here per business agreement. See
Action Settings Tab on page 52.
Note Do not input anything here if its value is N / A .

Action Tab and Signal Tab


The Action tab and the Signal tab let you specify properties for the action and
signal messages. Both pages prompt for the same information, described in
Table 7 on page 26. For information on action and signal messages, see
Understanding Action and Signal Messages on page 26.
Table 7 Action and Signal Fields
Field

Description

Secure Transmission
Required

Require SSL transport (HTTPS or HTTPSCA) when


sending or receiving this action or signal.

Non-Repudiation
Required

Require non-repudiation for this action or signal.

Role Authorization
Required

Verify whether the trading partner is authorized to


receive action or signal messages for this PIP.

Understanding Action and Signal Messages


RNIF 1.1 and 2.0 distinguish between action and signal messages.
You need to be familiar with the distinction between actions and signals that is
establishd by the RNIF standard. The following paragraphs are quoted directly
from RNIF V02.00.00, July 16, 2001:
The messages involved in a PIP business document exchange can be
classified into two broad categories business action
messages and a business signal message.
Business actions are messages with content that is of a business
nature, such as a Purchase Order or a Request For Quote. The
DTDs and the associated Message Guidelines for business actions
are specified as part of the corresponding PIP specification.
Business signals are positive and negative acknowledgment
messages that are sent in response to business actions. Business
signals are specified by and are part of the RosettaNet

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Adding RosettaNet PIPs Manually 27

Implementation Framework. RNIF 2.0 contains one positive and one


negative business signal.
Note: Only business actions are acknowledged. Business signals
are never acknowledged.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

28

| Chapter 3

Managing RosettaNet PIPs

Exporting PIPs, Versions, and Activities


You can export all the RosettaNet PIP configurations in the Operations Editor
panel. You can also export the RosettaNet PIPs by individual activities (Export
Activity), by version containers (Export Version), and by PIP containers (Export
PIP).
Follow the instructions below to export RosettaNet PIPs:
1. In TIBCO Administrator, click the BusinessConnect > Operations Editor link
in the left panel.
2. Select RosettaNet from the Protocol drop-down list in the right panel.
3. Click Edit.
4. To export all RosettaNet PIPs:
a. Select the RosettaNet radio button.
b. Click Export Data.
Alternatively, to export a subset of the RosettaNet PIPs:
a. Select the radio button next to the PIP, version, or activity you wish to
export.
b. Click Export PIP, Export Version, or Export Activity, depending on what
you selected in the previous step.
You will now see the File Download dialog with o p e r a t i o n s . c s x as the
suggested filename.
5. Click Save in the File Download dialog.
6. Change to a desired filename and click Save.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Creating XSD Files from DTD Files 29

Creating XSD Files from DTD Files


If the PIP package you download from RosettaNet contains only DTD schemas
and you prefer to use XSD schemas for PIP document validation during
RosettaNet transactions, you must convert the DTD schemas in the PIP package
into XSDs.
The creation of the XSD file is a two-step process. Because the DTD does not fully
specify all of the constraints specified in the Message Guide, a direct translation of
DTD to XSD is not sufficient; manual editing is required after the DTD-XSD
translation. The recommended tool to generate a XSD from the DTD is TIBCO
XML Authority.
Follow the steps below to perform the translation. Basic understanding of XML
Schema data types is required.
1. Start TIBCO XML Authority.
2. Open the DTD file.
3. Export the DTD file as an XSD file.
After you have successfully generated the XSD file, use TIBCO XML Authority to
update the XSD file. You can also use your favorite editor to perform this task.
Typically, you perform these steps:
1. Update Fundamental Business Data Entities that are part of the RosettaNet
Message Guideline document.
2. Update Enumerated Values that are specified in the Message Guideline
document for specific fields under the Guideline Information section.
3. Add additional types from the Fundamental Business Data Entities section
if needed by this PIP.
4. Define new types that will hold an enumerated list of values for fields that
need enumerated types. This step has to be done manually.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

30

| Chapter 3

Managing RosettaNet PIPs

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 31
Chapter 4

Setting Up Trading Hosts

This chapter explains how to set up trading hosts in TIBCO BusinessConnect


RosettaNet Protocol.

Topics

Configuring RosettaNet Protocol for Trading Hosts, page 32

General Tab, page 33

Roles Tab, page 36

TIBCO BusinessConnect RosettaNet Protocol Users Guide

32

| Chapter 4

Setting Up Trading Hosts

Configuring RosettaNet Protocol for Trading Hosts


This section explains how to configure the RosettaNet protocol for a trading host
in TIBCO BusinessConnect. It assumes that you have already set up a trading host
in the Participants panel. See TIBCO BusinessConnect Trading Partner
Administration Guide for detailed information on setting up a trading host.
You must specify the following information in the
Edit Business Location: Headquarters panel in order to use TIBCO
BusinessConnect RosettaNet Protocol:

Phone

Fax

Email

Primary Legal Contact

Primary Support Contact

Follow the instructions below to configure the RosettaNet protocol for a trading
host:
1. In TIBCO Administrator, click the BusinessConnect > Participants link in the
left panel.
2. Click a host participant link in the right panel.
3. Click the Protocols tab.
4. Click the RosettaNet link.
You will see the following tabs in the Edit Enabled Protocol: RosettaNet panel:
General Tab See General Tab on page 33 for detailed information on
configuring this tab.
Roles Tab See Roles Tab on page 36 for detailed information on
configuring roles.
5. Click Save twice.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

General Tab 33

General Tab
Use the General tab to set general properties.
To add partner classification and supply chain codes, see Appendix C,
Configuration Store Metadata, on page 149.
Table 8 Trading Host General Properties (Sheet 1 of 3)
Field

Description

Default Domain Identity

The default domain identity to use for this host. Select from the list
of domain-identity pairs you created in the Domain Identities
dialog. See Adding Domain Identities on page 35 to add or edit a
domain identity.

Partner Classification Code

The partner classification code for this participant as specified in


RNIF. This field is not used for inbound data verification.

Supply Chain Code

The supply chain code for this participant as specified in RNIF. This
field is not used for inbound data verification.

Valid Email Address List

The identifier to use in the From header field of the SMTP MIME
message. This can be a comma-separated list of email addresses. For
an outbound document sent to the trading partner through SMTP
transport, the first email address is used in the From header. For
incoming email from the mail server, the To email address from the
email is matched to one of the email addresses in this list.

Assume all Roles

Link this host to all roles in the Roles metadata. See Appendix C,
Configuration Store Metadata, on page 149. If selected, it is not
necessary to link any roles in the Roles tab. See Roles Tab on page 36.

Outbound Document
Validation

Specify the validation schema type for validating outbound


documents. To disable outbound document validation, select None
in this drop-down list.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

34

| Chapter 4

Setting Up Trading Hosts

Table 8 Trading Host General Properties (Sheet 2 of 3)


Field

Description

Document Validation Settings


Inbound Document
Validation (XSD)

Enable inbound XSD-based document validation. This property


must be enabled for TIBCO BusinessConnect RosettaNet Protocol to
validate inbound documents.
To override this option for a particular partner participant, see the
Host Document Validation Settings section in Table 9 on page 40 for
more information.

Audit Log Settings


Enable Audit Logging to
File

Log and save your inbound and outbound messages to a file as part
of the auditing process. By default, audit logs are only saved in the
audit log database. Saving them in a file allows you to move or share
the audit logs more easily. See Logging to the File System on
page 102 for more information.
In order to use this feature, you must also enable the
b c r n . a u d i t . t o . d i r . m e s s a g e s property in System Settings >
Installed Protocols > RosettaNet. See Appendix B, Property
Reference, on page 145.

Directory for Audit Log


Files

The directory in which your audit log file should be saved (if you
select Enable Audit Logging to File).

Private Process Settings


Forward Response
Document Only When
Response Acknowledgment
Succeeds

Enforce that the response acknowledgment be sent successfully to a


partner before TIBCO BusinessConnect RosettaNet Protocol
forwards the inbound response document to the private process.
This checkbox is selected by default.
Clear this checkbox to allow the private process to receive the
response document even if the response acknowledgment to a
partner fails. Note that the same checkbox must be cleared in the
partner RosettaNet protocol panel in order to disable this option. See
Forward Response Document Only When Response
Acknowledgment Succeeds on page 42.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

General Tab 35

Table 8 Trading Host General Properties (Sheet 3 of 3)


Field

Description

Enable Automatic Response


for Duplicate Request

If this checkbox is selected, TIBCO BusinessConnect RosettaNet


Protocol treats duplicate messages in the following manner:

Duplicate Request PIP and Response Document Found in Audit


Database Resends the stored response document to the trading

partner and completes the PIP.

Duplicate Request PIP and Response Document Not Found in


Audit Database Forwards the request to its private process with

the i s D u p l i c a t e field set to true. This is the case if the private


process has not responded to the original request or if the
response document has already been archived.

Duplicate Notify PIP Simply forwards the notify message to the

private process with the i s D u p l i c a t e field set to t r u e .


See Inbound Duplicate Detection on page 10 for more information
on duplicate detection.

Adding Domain Identities


You must configure at least one domain-identity credential for your host
participant. Follow the instructions below to add a domain-identity pair for the
RosettaNet protocol:
1. Click the Add New link to the right of the Default Domain Identity
drop-down list.
2. Click the Add New button.
3. Select D U N S from the Domain drop-down list.
4. Type a nine-digit DUNS number for the host participant in the Identity field.
TIBCO BusinessConnect RosettaNet Protocol does not verify the DUNS ID in the
outbound XML-formatted PIP documents from the private process.
5. Click Save.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

36

| Chapter 4

Setting Up Trading Hosts

Roles Tab
You must link a host to a particular role before you can use a PIP that requires that
role. Follow the instructions below to link a trading host to roles:
1. Click the Roles tab in the Edit Enabled Protocol: RosettaNet panel.
2. Click Link Roles.
3. Select the roles you wish to link with the host participant. There is more than
one page of roles in the Select Roles panel. You can move through the pages by
clicking the << and >> links as well as selecting a page from the Items
drop-down list in the upper-right corner of the panel.
To add roles not already in this panel, see Appendix C, Configuration Store
Metadata, on page 149.
4. Click OK.
5. Click Save.
You can add cusotmized roles to the list in this tab. See Appendix C,
Configuration Store Metadata, on page 149 for a list of all configuration store
metadata for RosettaNet.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 37
Chapter 5

Setting Up Trading Partners

This chapter explains how to manage trading partner information.

Topics

Configuring RosettaNet for Trading Partners, page 38

General Tab, page 40

Roles Tab, page 43

Transports Tab, page 44

TIBCO BusinessConnect RosettaNet Protocol Users Guide

38

| Chapter 5

Setting Up Trading Partners

Configuring RosettaNet for Trading Partners


This section explains how to configure the RosettaNet protocol for a trading
partner in TIBCO BusinessConnect. It assumes that you have already set up a
trading partner in the Participants panel. See TIBCO BusinessConnect Trading
Partner Administration Guide for detailed information on setting up a trading
partner.
You must specify the following information in the
Edit Business Location: Headquarters panel in order to use TIBCO
BusinessConnect RosettaNet Protocol:

Phone

Fax

Email

Primary Legal Contact

Primary Support Contact

Follow the instructions below to configure the RosettaNet protocol for a trading
partner:
1. In TIBCO Administrator, click the BusinessConnect > Participants link in the
left panel.
2. Click a partner participant link in the right panel.
3. Click the Protocols tab.
4. If RosettaNet does not appear in the list of protocols:
a. Click Enable Protocol.
b. Select the RosettaNet checkbox.
c. Click OK.
5. Click the RosettaNet link.
You will see the following tabs in the Edit Enabled Protocol: RosettaNet panel:
General Tab See General Tab on page 40 for detailed information on
configuring this tab.
Roles Tab See Roles Tab on page 43 for detailed information on
configuring roles.
Transports Tab See Transports Tab on page 44 for detailed information on
configuring transports.
TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring RosettaNet for Trading Partners 39

6. Click Save twice.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

40

| Chapter 5

Setting Up Trading Partners

General Tab
Use the General tab to manage general information for the RosettaNet trading
partner.
To add codes, see Appendix C, Configuration Store Metadata, on page 149.

Table 9

Trading Partner General Properties (Sheet 1 of 3)

Field

Description

Default Domain Identity

The default domain identity to use for this partner. Select from the
list of domain identities created in the Domain Identity dialog. See
Adding Domain Identities on page 42 to add or edit a domain
identity.

Partner Classification Code

The partner classification code for this participant as specified in


RNIF. This field is not used for inbound data verification.

Supply Chain Code

The supply chain code for this participant as specified in RNIF. This
field is not used for inbound data verification.

Valid Email Address List

The email address that is used to match against incoming email from
the mail server. This can be a comma-separated list of email
addresses. If the incoming email From address matches any email
address in this list, then this trading partner is used as the receiving
party.

Assume all Roles

Link this partner to all roles in the Roles metadata. See Appendix C,
Configuration Store Metadata, on page 149. If selected, it is not
necessary to link any roles in the Roles tab. See Roles Tab on page 36.

Support Client
Authentication Where
Required

Require HTTPS with client authentication for all incoming


documents from this partner, except when the partner responds to a
request that has been sent via HTTP or email. If selected, this
requirement will also be applied to all partner-initiated PIPs.

Use Digital Signature


Where Required

Enable the use of digital signatures when exchanging messages with


this partner. You must select this option in order to sign any
outbound document for this partner or verify the digital signature in
any inbound document from this partner.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

General Tab 41

Table 9

Trading Partner General Properties (Sheet 2 of 3)

Field

Description

Outbound Document Inline


Replacement

Enable field substitutions when sending messages to this partner.


See Data Substitutions in PIP Request and Response on page 86 for
more information.

Enable Exchange of PIP0A1


(NOF)

Enable the exchange of PIP 0A1 messages.

RNIF 2.0 Settings


Enable Debug Header with
RNIF2.0

(Test mode only) Allow debug headers to be used.

MIME Content Transfer


Encoding

(RNIF 2.0 only) The encoding of the outbound message.

Host Document Validation Settings


Override Host Inbound
Document Validation

Override the validation of inbound documents as configured in the


General tab of a host participants Edit Enabled Protocol: RosettaNet
panel. You must also specify a schema type in the Host Inbound
Document Validation drop-down list.
Note Implementation of this feature also requires that the Inbound

Document Validation (XSD) checkbox is selected for the host that is


in a business agreement with this partner. See General Tab on
page 33.
Host Inbound Document
Validation

Specifies the typeXSD, DTD, or NONEof validation of inbound


documents from this trading partner.

Override Host Outbound


Document Validation

Override the Outbound Document Validation setting in the General


tab of a host participants Edit Enabled Protocol: RosettaNet panel.
You must also specify a schema type in the Outbound Document
Validation drop-down list.
See General Tab on page 33 for more information on the host
participants Outbound Document Validation setting.

Outbound Document
Validation

Specifies the typeXSD, DTD, or NONEof validation of outbound


documents from this trading partner.

Private Process Settings

TIBCO BusinessConnect RosettaNet Protocol Users Guide

42

| Chapter 5
Table 9

Setting Up Trading Partners

Trading Partner General Properties (Sheet 3 of 3)

Field

Description

Forward Response
Document Only When
Response Acknowledgment
Succeeds

Enforce that the response acknowledgment be sent successfully to


this trading partner before TIBCO BusinessConnect RosettaNet
Protocol forwards the inbound response document to the private
process. This checkbox is selected by default.
Clear this checkbox to allow the private process to receive the
response document even if the response acknowledgment to this
partner fails. Note that the same checkbox must be cleared in the host
RosettaNet protocol panel in order to disable this option. See
Forward Response Document Only When Response
Acknowledgment Succeeds on page 34.

Adding Domain Identities


You must configure at least one domain-identity credential for your partner
participant. Follow the instructions below to add a domain-identity pair for the
RosettaNet protocol:
1. Click the Add New link to the right of the Default Domain Identity
drop-down list.
2. Click the Add New button.
3. Select D U N S from the Domain drop-down list.
4. Type a nine-digit DUNS number for the partner participant in the Identity
field.
TIBCO BusinessConnect RosettaNet Protocol does not verify the DUNS ID in
outbound XML-formatted PIP documents from the private process.
5. Click Save.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Roles Tab 43

Roles Tab
You must link a partner participant to a particular role before you can use a PIP
that requires that role. Follow the instructions below to link a trading partner to
roles:
1. Click the Roles tab in the Edit Enabled Protocol: RosettaNet panel.
2. Click Link Roles.
3. Select the roles you wish to link with the partner participant. There is more
than one page of roles in the Select Roles panel. You can move through the
pages by clicking the << and >> links as well as selecting a page from the
Items drop-down list in the upper-right corner of the panel.
To add roles not already in this panel, see Appendix C, Configuration Store
Metadata, on page 149.
4. Click OK.
5. Click Save.
You can add cusotmized roles to the list in this tab. See Appendix C,
Configuration Store Metadata, on page 149 for a list of all configuration store
metadata for RosettaNet.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

44

| Chapter 5

Setting Up Trading Partners

Transports Tab
Use the Transports tab to configure outbound transport settings for this trading
partner. To add an outbound transport, click Add in the Transports tab. The
following transports can be used with TIBCO BusinessConnect RosettaNet
Protocol:

HTTPS (including HTTPSCA)

HTTP

EMAIL

The steps required for configuring transports are the same for all protocols. Refer
to the transports chapters in TIBCO BusinessConnect Trading Partner Administration
Guide.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 45
Chapter 6

Configuring Agreement Protocol Bindings

This chapter describes setting up business agreements to use TIBCO


BusinessConnect RosettaNet Protocol.

Topics

Configuring Business Agreements with RosettaNet Protocol, page 46

Configuring Operation Bindings, page 47

Setting Document Security Properties, page 54

Configuring Transports, page 56

Scheduled Transmission, page 58

Overriding Participant Settings, page 60

TIBCO BusinessConnect RosettaNet Protocol Users Guide

46

| Chapter 6

Configuring Agreement Protocol Bindings

Configuring Business Agreements with RosettaNet Protocol


Follow the instructions below to configure a business agreement with the
RosettaNet protocol binding:
1. In TIBCO Administrator, click the BusinessConnect > Business Agreements
link in the left panel.
2. Click a business agreement link in the right panel.
3. Click the Add Protocol Bindings button.
4. Select RosettaNet.
5. Click OK.
6. Click the RosettaNet link to open the Edit Protocol Bindings: RosettaNet
panel.
7. Configure each of the following tabs:
Operation Bindings See Configuring Operation Bindings on page 47.
Document Security Setting Document Security Properties on page 54.
Transports See Configuring Transports on page 56.
Scheduled Transmission See Scheduled Transmission on page 58.
Participant Configurations (Override) See Overriding Participant Settings
on page 60.
8. Click Save twice.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Operation Bindings 47

Configuring Operation Bindings


Use the Operation Bindings tab to configure the RosettaNet activities that each
party in a business agreement can initiate and respond to. The following
properties apply to all PIP activities in the Operations Editor:

Allow All Operations Allow all activities configured in the Operations Editor

between participants. If you select this option, you can still modify the
behavior of one or more activities by binding the activities in the Host X Can
Initiate and Partner Y Can Initiate areas.
If you do not select this option, you must explicitly bind each activity for each
party in the Host X Can Initiate and Partner Y Can Initiate areas.

Non Repudiation Logging Log all activities in the non-repudiation log.

Binding Operations
The Host X Can Initiate area (where X is the host participant in the business
agreement) lists the activities that the host is allowed to initiate in this agreement.
The Partner Y Can Initiate area (where Y is the partner participant in the
business agreement) lists the activities that the partner is allowed to initiate.
Follow the instructions below to bind RosettaNet PIPs in either area:
1. Click Add Operation Binding.
2. Click the

icons to expand the browser tree.

3. Select the RosettaNet PIPs you wish to bind.


4. Click OK.

Editing Operation Bindings


Follow the instructions below to edit a RosettaNet operation binding:
1. Click the name of a PIP in the Host X Can Initiate area or Partner Y Can
Initiate area.
2. Configure this particular operation binding in the following tabs:
Operation Settings Override the default settings for this transaction. See
Operation Settings Tab on page 48.
Action Settings Override settings chosen in Action Settings Tab on page 52.
Transports Override the default transport settings for this transaction. See
Transports Tab on page 53.
TIBCO BusinessConnect RosettaNet Protocol Users Guide

48

| Chapter 6

Configuring Agreement Protocol Bindings

3. Click Save.

Operation Settings Tab


When binding a PIP activity to a business agreement, you can override the default
activity settings, which can be found in the Operations Editor panel (in the PIPs
Request-Response Activity tab or Notify tab). See Notify and Request-Response
Activity Properties on page 21 for information on configuring a PIPs default
activity settings in the Operations Editor.
Follow the instructions below to override the settings for a PIP activity:
1. Select the Override Operation Settings checkbox at the top.
2. Select one of the following items from the drop-down list to reveal a different
set of fields:
General. See General Sub-Tab on page 48 for fields related to this item.
Private Process. See Private Process Sub-Tab on page 50 for fields related to
this item.
RNIF 2_0. See RNIF 2.0 Sub-Tab on page 50 for fields related to this item.
General Sub-Tab
Table 10 Override Operation Settings: General Sub-Tab
Field

Description

Default RNIF Version

The RNIF version to use when the private process does not
specify an RNIF version. If either RNIF 11 or RNIF 20 is selected,
it overrides the private processspecified version, as well as the
PIP setting in the Operations Editor panel.

Override Message Properties

Override the following two settings in the Operations Editor:

Digital Signature is Required

Non Repudiation is Required

See Customizing Non-Repudiation Logging on page 104 for


more information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Operation Bindings 49

Table 10 Override Operation Settings: General Sub-Tab (Contd)


Field

Description

Digital Signature is Required

Digitally sign outbound documents and verify the digital


signatures in inbound documents. If an inbound document does
not contain a digital signature, TIBCO BusinessConnect
RosettaNet Protocol sends an exception message to the trading
partner.
See Customizing Non-Repudiation Logging on page 104 for
more information.

Non Repudiation is Required

Enforce non-repudiation logging for all inbound and outbound


dodcuments.
See Customizing Non-Repudiation Logging on page 104 for
more information.

Enable Overriding of
Roles/Services

Override the role and service codes defined in the Operations


Editor panel. If this field is selected, role and service codes for
this PIP is defined by the next four fields in this tab.

From Role Classification Code

The role for this PIPs initiator.

To Role Classification Code

The role for this PIPs responder.

From Business Service Code

The service for this PIPs initiator.

To Business Service Code

The service for this PIPs responder.

Override Inbound Document


Validation

Override the validation of documents using the schema type


selected in the Document Validation drop-down list.

Inbound Document Validation

Specifies the typeXSD, DTD, or NONEof validation of


incoming documents from this trading partner.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

50

| Chapter 6

Configuring Agreement Protocol Bindings

Private Process Sub-Tab


Table 11 Override Operation Settings: Private Process Sub-Tab
Field

Description

Send Parsed XML to Private


Process

(deprecated) Send the XML document as a nested TIBCO


Rendezvous message to the private process.

Send Actual Payload to


Private Process Instead of
File Reference

Always send the actual payload data to the private process instead
of a file reference. If this checkbox is selected, then large payload
handling is disabled. See Large Payload and Attachment
Directories on page 14 for more information on large payload
handling.
Note You must also select the protocol property
b c r n . p p . r e s o l v e F i l e R e f T o A c t u a l D a t a in order to enable this
option. See Appendix B, Property Reference, on page 145 for more
information.

Private Process Wait Time


(seconds)

Specifies how long TIBCO BusinessConnect will wait for a response


from the private process.

RNIF 2.0 Sub-Tab


Table 12 Override Operation Settings: RNIF 2.0 Sub-Tab
Field

Description

RNIF 2.0 Settings


Payload Compression

Select this checkbox to enable payload compression for this PIP, or


clear the checkbox to disable it.

Payload Encryption

None No payload encryption.


Payload Only Encryption of the payload but not the service

header.

Payload Container Encryption of both payload and service

header.
RNIF 2.0 Third Party Content Settings
Third Party Content Bind ID

Unique ID agreed by both trading partners to identify this third


party payload change.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Operation Bindings 51

Table 12 Override Operation Settings: RNIF 2.0 Sub-Tab (Contd)


Field

Description

Non RosettaNet Message


Standard

(RNIF 2.0 only) The name of the e-Standard that the payload
content follows. For example, OAGIS.

Non RosettaNet Message


Standard Version

(RNIF 2.0 only) The version of the e-Standard. For example, Release
7.2.5.

Request Settings
XML Root Element Name

The name of the XML root element for the request payload, defined
in the DTD or XSD files specified below.

Third Party DTD Name

DTD file used to validate the request payload.

Third Party XSD Name

XSD file used to validate the request payload.

Response Settings
XML Root Element Name

The name of the XML root element for the request payload, defined
in the DTD or XSD files specified below.

Third Party DTD Name

DTD file used to validate the response payload.

Third Party XSD Name

XSD file used to validate the response payload.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

52

| Chapter 6

Configuring Agreement Protocol Bindings

Action Settings Tab


When binding a PIP activity to a business agreement, you can customize or
override the default settings of a specific PIP action. A PIPs default action
settings be found in the Operations Editor (in the General sub-tab of a PIPs
Request Action tab or Notify Request Action tab). See Action-Specific Properties
on page 23 for information on configuring a PIPs default action settings in the
Operations Editor.
Follow the instructions below to override action settings:
1. Click the Action Settings tab.
2. Select the Override Action Settings checkbox.
3. Consult Table 13 to configure the settings in this tab.
Table 13 Action Settings Tab
Field

Description

Maximum Acknowledgment
Wait (seconds)

The maximum time to wait for an acknowledgement receipt from


the trading partner. When this time expires, TIBCO
BusinessConnect RosettaNet Protocol retransmits the request or
response message to the trading partner for as many times as is
specified in the Maximum Number of Retransmits field.

Maximum Response Wait


(seconds)

The maximum time to wait for a response message from the trading
partner. When this time expires, TIBCO BusinessConnect
RosettaNet Protocol retransmits the request message to the trading
partner for as many times as is specified in the Maximum Number
of Retransmits field.
Note Do not input anything here if its value is N / A .

Maximum Number of
Retransmits

The maximum number of times to retransmit the request or


response message.
Note Do not input anything here if its value is N / A .

Synchronous Settings
Maximum Acknowledgment
Wait (seconds)

In a synchronous transaction, the maximum time to wait for an


acknowledgement receipt from the trading partner. When this time
expires, TIBCO BusinessConnect RosettaNet Protocol retransmits
the request or response message to the trading partner for as many
times as is specified in the Maximum Number of Retransmits field.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Operation Bindings 53

Table 13 Action Settings Tab (Contd)


Field

Description

Maximum Response Wait


(seconds)

In a synchronous transaction, the maximum time to wait for a


response message from the trading partner. When this time expires,
TIBCO BusinessConnect RosettaNet Protocol retransmits the
request message to the trading partner for as many times as is
specified in the Maximum Number of Retransmits field.
Note Do not input anything here if its value is N / A .

Maximum Number of
Retransmits

In a synchronous transaction, the maximum number of times to


retransmit the request or response message.
Note Do not input anything here if its value is N / A .

Transports Tab
In addition to configuring the outbound transport settings for a business
agreement (see Configuring Transports on page 56), you can also override the
settings for a particular PIP. Follow the instructions below to override outbound
transport settings:
1. Click the Transports tab.
2. Select the Override Transports checkbox.
Consult Table 14 to configure the settings in this tab.
Table 14 Transports Tab
Field

Description

Primary (Production)
Transport

The transport used for this PIP when sending messages in P r o d u c t i o n


mode.

Secondary (Test)
Transport

The transport used for this PIP when sending messages in T e s t mode. If
this field is not specified, then Primary (Production) Transport is used.

Error Transport

The transport used for sending 0A1 Notification of Failure messages. If


this field is not specified, then Primary (Production) Transport is used.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

54

| Chapter 6

Configuring Agreement Protocol Bindings

Setting Document Security Properties


You can use the Document Security tab to specify security information for the
transacted PIP documents between the participants in this business agreement.
The keys and certificates selected in the tab are configured in a participants
Credentials tab. See TIBCO BusinessConnect Trading Partner Administration Guide
for information on configuring participant credentials.
Follow the instructions in Configuring Business Agreements with RosettaNet
Protocol on page 46 to get to the Document Security tab. Then, consult Table 15 to
configure the document security properties.
Table 15 Document Security Properties
Field

Description

Outbound Doc Exchange


Signing Info Settings
Signing Key

The private key you wish to use for the selected host to sign outbound
messages in this business agreement. If TIBCO BusinessConnect
RosettaNet Protocol is configured to use digital signatures for the selected
partner (See Customizing Non-Repudiation Logging on page 104 for more
information), it will use the key specified here to sign outbound messages
that are sent to this partner.
You must have already installed a private key for this host during
participant configuration. See TIBCO BusinessConnect Trading Partner
Administration Guide for more information on installing private keys for
host participants.

Digest Algorithm

The algorithm used to create the message digest. The available options are
SHA1 and MD5.

Encryption Info Settings


Encryption Certificate

The selected partners certificate you wish to use to encrypt outbound


messages in this business agreement.
You must have already installed a certificate for this partner during
participant configuration. See TIBCO BusinessConnect Trading Partner
Administration Guide for more information on installing certificates for
partner participants.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Document Security Properties 55

Table 15 Document Security Properties (Contd)


Field

Description

Encryption Algorithm

The algorithm used to encrypt documents. The available options are


DES3, RC2-40, RC2-128, AES-128, AES-192, AES-256.

Inbound Doc Exchange


Signing Info Settings
Verification Certificate

The public key for the selected partner in this business agreement. If
TIBCO BusinessConnect RosettaNet Protocol is configured to use digital
signatures for the selected partner (see Customizing Non-Repudiation
Logging on page 104), it will use the certificate specified here to verify the
signed documents from the selected partner.
You must have already installed a certificate for this partner during
participant configuration. See TIBCO BusinessConnect Trading Partner
Administration Guide for more information on installing certificates for
partner participants.

Encryption Info Settings


Decryption Key

The private key you wish to use for the selected host to decrypt inbound
messages in this business agreement.
You must have already installed a private key for this host during
participant configuration. See TIBCO BusinessConnect Trading Partner
Administration Guide for more information on installing private keys for
host participants.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

56

| Chapter 6

Configuring Agreement Protocol Bindings

Configuring Transports
As part of the RosettaNet protocol binding in a business agreement, you must
specify which transports to allow for the host and the partner.
To get to the Transports tab, follow the instructions in Configuring Business
Agreements with RosettaNet Protocol on page 46.

Outbound Transports for Host


This area of the Transports tab allows you to assign transports for a business
agreement. The transports that are available for selection here are the ones you
defined when configuring the partner participant in this business agreement. The
partners transport configuration is located at:
Participants > partner > Protocols > RosettaNet > Transports.
See TIBCO BusinessConnect Trading Partner Administration Guide for detailed
information on configuring transports for a partner participant.
Table 16 lists the options available in the Outbound Transports for Host area. You
can also override the settings here for a particular operation binding. See
Transports Tab on page 53 for more information.
Table 16 Outbound Transports for Host
Field

Description

Primary (Production)
Transport

(Required) The transport used for this PIP when


sending messages in P r o d u c t i o n mode.

Secondary (Test)
Transport

The transport used for this PIP when sending


messages in T e s t mode. If this field is not
specified, then Primary (Production) Transport is
used.

Error Transport

The transport used for sending 0A1 Notification


of Failure messages. If this field is not specified,
then Primary (Production) Transport is used.

Client Authentication
Identity

The key identity used when the remote server


requires client authentication for an HTTPS
connection.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Transports 57

Inbound Transports for Partner


This area of the Transports tab allows you to specify which transports your
partner can use to send RosettaNet messages to your BusinessConnect
implementation. The transports available for selection here reflect the transports
configured for this BusinessConnect deployment. Transports for the deployment
are configured in the Application Management console of TIBCO Administrator:
Application Management>BusinessConnect>Configuration>
BusinessConnect>Public Process Configuration.
The TIBCO BusinessConnect Trading Partner Administration Guide provides detailed
information on configuring transports in the Public Process Configuration tab.
Depending on your deployment configuration, the following transports may be
available for selection:
Table 17 Inbound Transport Fields
Field

Description

HTTPSCA

Allow HTTPS (Client Authentication) connections from this partner directly.


Click Edit Settings to set the Client Authentication Identity.

HTTPS

Allow HTTPS connections from this partner directly.

HTTP

Allow HTTP connections from this partner directly.

EMAIL

Allow email from this partner.

Overriding Outbound Transport Settings


Follow the instructions below to override the outbound transport settings for a
particular. Follow the instructions below to do so:
1. In the Edit Protocol Bindings: RosettaNet panel, click the Operation Bindings
tab.
2. Click a PIP in the Host X Can Initiate or Partner Y Can Initiate area.
3. Continue by following the instructions in Transports Tab on page 53.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

58

| Chapter 6

Configuring Agreement Protocol Bindings

Scheduled Transmission
The Scheduled Transmission tab enables you to initiate PIPs at a predetermined
window of time on a specific day or dates. If you enable this feature, all
RosettaNet PIPs initiated by private processes (with the exception of PIP 0A1) will
be scheduled by the settings in this tab.
After you enable this feature, TIBCO BusinessConnect RosettaNet Protocol
behaves as follows:
1. It keeps all PIP documents initiated by private processes in a message queue
(see note below for exceptions).
2. On the specified day or date and at the time specified in the Start Time
parameter, it sends out the PIPs one by one to the intended trading partners.
3. When the time specified in the End Time parameter has past, it stops sending
any remaining PIPs in the queue and keeps them until the start time of the
next specified day or date.
Note the following caveats:

If a PIP is initiated by the private process during the time interval specified by
Start Time and End Time, that PIP is sent out immediately and is not placed
into the message queue.

If a PIP is resent to the trading partner, it is sent out immediately and is not
placed into the message queue, even if it was scheduled originally. See Resend
Log on page 100 for more information resending messages.

PIP 0A1 and response documents to trading partnerinitiated PIPs are


forwarded to the trading partner immediately and are not scheduled.

TIBCO BusinessConnect RosettaNet Protocol does not guarantee that


messages are sent in the first-in-first-out order.

If outbound duplicate detection is enabled, TIBCO BusinessConnect


RosettaNet Protocol performs duplicate detection when scheduling the
messages, not when sending the messages from the message queue. See
Duplicate Detection on page 10 for more information on duplicate detection.

See Table 18 on page 59 for a description of each property in the Scheduled


Transmission tab.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Scheduled Transmission 59

Table 18 Scheduled Transmission Fields


Field

Description

Enable

Select to enable scheduled transmission.

Transmission
Mode

Select when or how often to initiate PIP transmissions. The available options are
as follows:

Everyday Initiate PIP transmissions every day in the time interval specified in

Start Time and End Time.

Day of Week Initiate PIP transmissions on the days selected in Days of the
Week (see below), in the time interval specified in Start Time and End Time.

Specific Dates Initiate PIP transmissions on specific dates specified in


Scheduled Dates, in the time interval specified in Start Time and End Time.

Start Time

The start time of PIP transmissions on the specified days or dates.

End Time

The end time of PIP transmissions on the specified days or dates. If there are
messages not yet sent when the end time has past, they will be kept in the
message queue until the start time of the next scheduled day or date.

Days of the
Week

Select the days of the week for which you wish to schedule PIP transmissions.

Scheduled
Dates

The specified dates for which you wish to schedule PIP transmissions.
To add a new date, click the Add button.
To remove a scheduled date, select the date in the Scheduled Dates area and click
the Remove button.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

60

| Chapter 6

Configuring Agreement Protocol Bindings

Overriding Participant Settings


There are two additional hidden tabs in the Edit Protocol Bindings: RosettaNet
panel that enable you to override each participants general protocol settings,
which are configured in the General tab of the participants RosettaNet protocol
configuration panel. See General Tab on page 33 and General Tab on page 40 for
information on configuring these default settings.
Follow the instructions below to override the participant settings for a business
agreement:
1. Follow the instructions in Configuring Business Agreements with RosettaNet
Protocol on page 46 to get to the Edit Protocol Bindings: RosettaNet panel.
2. Click the Show Advanced button in the upper-right corner.
You will see two configuration tabs, one for each participant in this business
agreement.
3. Click the configuration tab for the desired participant.
4. Select the Override Settings checkbox.
5. Configure the settings in this tab. See General Tab on page 33 (for a host) or
General Tab on page 40 (for a partner) for a description of each parameter.
6. Click Save twice.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

s 61

Chapter 7

Private Processes
s

This chapter describes the interaction between TIBCO BusinessConnect


RosettaNet Protocol and its private processes and gives specifications for private
process messages.

Topics

Configuring Private Processes, page 62

Private Process Message Formats, page 63

Advisory and Error Status Codes, page 84

Data Substitutions in PIP Request and Response, page 86

Configuring Private Processes with TIBCO BusinessWorks, page 89

TIBCO BusinessConnect RosettaNet Protocol Users Guide

62

| Chapter 7

Private Processes

Configuring Private Processes


You can use the following two types of private processes with TIBCO
BusinessConnect RosettaNet Protocol:

Standalone Standalone private processes must directly use Rendezvous or


JMS to communicate with BusinessConnect.

TIBCO BusinessWorks TIBCO BusinessWorks processes can send requests to

BusinessConnect or receive replies from BusinessConnect using the


BusinessConnect palette resources in TIBCO Designer.

Standalone Private Processes


If you wish to design standalone private processes for use with TIBCO
BusinessConnect RosettaNet Protocol, you must understand Rendezvous or JMS
message exchange. TIBCO BusinessConnect RosettaNet Protocol uses TIBCO
ActiveExchange messages to exchange RosettaNet messages with private
processes. See Private Process Message Formats on page 63 for formatting
information of RosettaNet messages.
Also, see Chapter 9, Tutorial Standalone Private Processes, on page 107 for an
example of using TIBCO BusinessConnect RosettaNet Protocol with standalone
private processes.

TIBCO BusinessWorks Processes


The BusinessConnect palette, which is installed into TIBCO Designer during the
BusinessConnect installation, encapsulates the message exhange configurations.
The variety of TIBCO BusinessWorks palettes in TIBCO Designer also enables you
to define elaborate private processes to suit the needs of your business
transactions.
See Configuring Private Processes with TIBCO BusinessWorks on page 89 for
more information on using TIBCO BusinessWorks private processes.
Also, see Chapter 10, Tutorial TIBCO BusinessWorks Private Processes, on
page 129 for a tutorial on configuring TIBCO BusinessWorks private processes to
send and receive messages with TIBCO BusinessConnect RosettaNet Protocol.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 63

Private Process Message Formats


TIBCO BusinessConnect RosettaNet Protocol uses ActiveExchange messages to
exchange RosettaNet messages with private processes via Rendezvous or JMS.
This section describes the RosettaNet-specific data classes that are used in the
messages. You must format outbound messages and include all required
information as prescribed by the respective data classes.
For Rendezvous transport, TIBCO BusinessConnect RosettaNet Protocol uses
aeRvMsg messages to communicate with private processes, transmitting message
data in the ^ d a t a ^ control tag of the aeRvMsg messages. For JMS transport, it
transmits message data in the message body of JMS ObjectMessage messages
using JMS queue. See the Private Processes section in TIBCO BusinessConnect
Concepts for more information.
The JMS topics that TIBCO BusinessConnect RosettaNet Protocol uses do not
contain the protocol name. You must make sure that the J M S T y p e attribute in the
< h e a d e r > element contains the string "RosettaNet" when exchanging JMS
messages with TIBCO BusinessConnect RosettaNet Protocol.
Go to one of the sections below for formatting details of the respective RosettaNet
message type:

Outbound Request Format, page 64

Inbound Request Format, page 66

Outbound Response Format, page 70

Inbound Response Format, page 74

Advisory Message Format, page 77

Data Types and Data Fields


See the following sections for formats of specific message fields and other data
objects:

Advisory Message Format, page 77

Error Message Format, page 80

Additional Data Objects, page 81

Request and Response Fields, page 83

TIBCO BusinessConnect RosettaNet Protocol Users Guide

64

| Chapter 7

Private Processes

Outbound Request Format


The initiator private process uses this message class to send outbound request or
notify messages to TIBCO BusinessConnect RosettaNet Protocol.
Initiator Request

Initiator
Private
Process
BC
Initiator

Class
Subject name

Responder
Private
Process

Internet
BC
Responder

BCRequestFromPP

prefix.installation.R o s e t t a N e t . I N I T I A T O R . R E Q U E S T (Rendezvous)
Example: A X . B C . B C - A C M E . R o s e t t a N e t . I N I T I A T O R . R E Q U E S T
prefix.installation. I N I T I A T O R . R E Q U E S T (JMS queue)

Message Fields

See Table 19.

Table 19 BCRequestFromPP Message Fields


Message
Field

Type

Required

Description

transaction
ID

String

Yes

Specified by the private process to


cross-reference this transaction. If this
field is empty, TIBCO BusinessConnect
RosettaNet Protocol generates a
transactionID when transmitting the
request.

standardID

String

Yes

The string "RosettaNet".

operationID

String

Yes

A three-part PIP ID of the following


format: PIP/ version/ activity. For eample:
3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

tpName

RosettaNet/Info/
TPInfo

Yes

The responder trading partner. This field


takes precedence over the t p N a m e L i s t
field when both fields are specified.
See Table 31 on page 82 for formatting
information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 65

Table 19 BCRequestFromPP Message Fields (Contd)


Message
Field

Type

Required

Description

tpNameList

Sequence of

No

A sequence of trading partners. This field


is not fully utilized in TIBCO
BusinessConnect RosettaNet Protocol. If
you supply multiple trading partners in
this field, only the first trading partner is
used. Also, t p N a m e takes precedence over
this field.

RosettaNet/Info/
TPInfo

See Table 31 on page 82 for formatting


information.
from

RosettaNet/Info/
TPInfo

No

The trading host. When multiple hosts are


configured in TIBCO BusinessConnect
RosettaNet Protocol, this field is used to
indicate which host is used.
See Table 31 on page 82 for formatting
information.

extraInfo

RosettaNet/Request/
RNRequestFromPP

Yes

RosettaNet protocol specific data.


See Table 20, RNRequestFromPP Object
Fields, on page 66 for formatting
information.

closure

String

No

Reserved

attachment
List

Sequence of

No

A sequence of attachments. See Table 32


on page 82 for formatting information.

RosettaNet/Info/
AttachmentInfo

request

String

No

The content of the entire RosettaNet PIP


request. See Request and Response Fields
on page 83 for formatting information.

file
Reference

String

No

The absolute path to the RosettaNet PIP


document you wish to send. You may use
this field instead of the r e q u e s t field if
the document is too large or for any other
reason.
This field takes precedence over the
field.

request

TIBCO BusinessConnect RosettaNet Protocol Users Guide

66

| Chapter 7

Private Processes

RNRequestFromPP Object
Included in the e x t r a I n f o field is the R N R e q u e s t F r o m P P object. See Table 20 for a
description of each of its fields:
Table 20 RNRequestFromPP Object Fields
Message
Field

Type

Description

globalUsage
Code

String

Specify T e s t or P r o d u c t i o n . The value provided


here is copied to the < G l o b a l U s a g e C o d e > element
in the outbound PIP documents preamble header.
TIBCO BusinessConnect RosettaNet Protocol
decides which transport to use based on the mode
specified here. See Transports Tab on page 53 for
information on configuring transport settings.

responseType

String

Specify s y n c or a s y n c to indicate whether you wish


to receive a synchronous response or asynchronous
response. The value provided here is copied to the
x - R N - R e s p o n s e - T y p e field of the outbound PIP
documents MIME header.

rnifVersion

String

Specify 1 . 1 or 2 . 0 to indicate the RNIF version you


wish to use. The value provided here is copied to
the < V e r s i o n I d e n t i f i e r > element in the
outbound PIP documents preamble header.

Inbound Request Format


TIBCO BusinessConnect RosettaNet Protocol uses this message class to forward
inbound request or notify messages to the responder private process.

Initiator
Private
Process
BC
Initiator

Class
Subject

Responder
request

Internet
BC
Responder

BCRequestToPP

prefix.installation.R o s e t t a N e t . R E S P O N D E R . R E Q U E S T (Rendezvous)

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Responder
Private
Process

Private Process Message Formats 67

Example: A X . B C . B C - A C M E . R o s e t t a N e t . R E S P O N D E R . R E Q U E S T
prefix.installation. R E S P O N D E R . R E Q U E S T (JMS queue)
Message Fields

See Table 21.

Table 21 BCRequestoPP: TIBCO BusinessConnect to Responder Private Process Message


Field

Type

Required

Description

standardID

String

Yes

The string "RosettaNet".

transactionID

String

Yes

A concatenation of the initiating trading


partners DUNS ID and the value of the
p r o c e s s I n s t a n c e I d e n t i f i e r field in the
R N R e q u e s t T o P P object, separated by the
character ^. For example:
123456789^PID000000001.

operationID

String

Yes

A three-part PIP ID of the following format:


PIP/ version/ activity. For eample:
3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

message
FingerPrint

String

Yes

ID derived from
processInstanceIdentifier

to uniquely

identify this incoming request.


isDuplicate

String

Yes

t r u e or f a l s e . Indicates that the message


contains a duplicate request.

closure

String

No

Reserved.

operation
TimeOut

Integer

No

Time to perform (in seconds).

extraInfo

RosettaNet/
Request/
RNRequestToPP

Yes

RosettaNet protocol specific data.

Sequence of

No

attachment
List

RosettaNet/Info/
AttachmentInfo

See Table 22, RNRequestToPP Object, on


page 68 for formatting information.
A sequence of attachments.
See Table 32 on page 82 for formatting
information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

68

| Chapter 7

Private Processes

Table 21 BCRequestoPP: TIBCO BusinessConnect to Responder Private Process Message (Contd)


Field

Type

Required

Description

request

String

Yes

The content of the entire RosettaNet PIP


request, without headers and attachments.
The request document may also be placed in
a file whose path is specified in the
f i l e R e f e r e n c e field, leaving this field
empty.
See Request and Response Fields on page 83
for formatting information.

sender

RosettaNet/
Info/TPInfo

Yes

The initiating trading partner. See Table 31 on


page 82 for formatting information.

receiver

RosettaNet/
Info/TPInfo

Yes

The recipient trading host. See Table 31 on


page 82 for formatting information.

file
Reference

String

No

The absolute path of the file containing the


PIP request document. See Handling Large
Payload Size on page 15 for more
information.

RNRequestToPP Object
Included in the e x t r a I n f o field is the R N R e q u e s t T o P P object. This object contains
useful information extracted from the MIME-formatted message. See Table 22 for
a description of object fields.
Table 22 RNRequestToPP Object
Message
Field

Type

Description

messageSent

String

The time stamp of the received PIP request.


This field is formatted as follows: Y Y Y Y / M M / D D
For example:
2007/08/30 14:41:35.500.
HH:MM:SS.SSS.

rnifVersion

String

The RNIF version extracted from the


element in the inbound
PIP documents preamble header.

<VersionIdentifier>

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 69

Table 22 RNRequestToPP Object (Contd)


Message
Field

Type

Description

globalUsage
Code

String

The PIP mode extracted from the


element in the inbound PIP
documents preamble header.

pipCode

String

<GlobalUsageCode>

The PIP code extracted from the


element of the
inbound PIP documents service header.

<GlobalProcessIndicatorCode>

pipVersion

String

The PIP version extracted from the


element of the inbound
PIP documents service header.

<VersionIdentifier>

pip
Transaction

String

The name of the PIP transaction extracted from


the < G l o b a l T r a n s a c t i o n C o d e > (RNIF 1.1) or
< B u s i n e s s A c t i v i t y I d e n t i f i e r > (RNIF 2.0)
element of the inbound PIP documents service
header.

pipAction

String

The name of the PIP transaction extracted from


the A c t i o n C o n t r o l / A c t i o n I d e n t i t y /
G l o b a l B u s i n e s s A c t i o n C o d e element of the
inbound PIP documents service header.

process
Instance
Identifier

String

transaction
Identifier

String

The instance identifier extracted from the


(RNIF
1.1) or p i p I n s t a n c e I d / I n s t a n c e I d e n t i f i e r
(RNIF 2.0) element of the inbound PIP
documents service header.
ProcessIdentity/InstanceIdentifier

(RNIF 1.1 only) The transactions instance


identifier extracted from the
TransactionIdentity/InstanceIdentifier

element of the inbound PIP documents service


header. RNIF 1.1 only.
transaction
AttemptCount

Integer

(RNIF 1.1 only) Number for the current attempt


(first one is 1) extracted from the < A t t e m p t C o u n t >
element of the inbound PIP documents service
header.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

70

| Chapter 7

Private Processes

Table 22 RNRequestToPP Object (Contd)


Message
Field
proprietary
Document
Identifier

Type

Description

String

The value of the


<proprietaryDocumentIdentifier>

element in

the inbound PIP document.

Outbound Response Format


The responder private process uses this message class to send outbound response
messages to TIBCO BusinessConnect RosettaNet Protocol.

Initiator
Private
Process

Internet

BC
Initiator

Class
Subject

Responder
response

Responder
Private
Process

BC
Responder

BCResponseFromPP

prefix.installation.R o s e t t a N e t . R E S P O N D E R . R E S P O N S E (Rendezvous)
Example: A X . B C . B C - A C M E . R o s e t t a N e t . R E S P O N D E R . R E S P O N S E
prefix.installation. R E S P O N D E R . R E S P O N S E (JMS queue)

Remarks

Message Fields

When sending a response message using this message class, you must copy the
value of the s e n d e r field (with all fields in the T P I n f o object),
p r o c e s s I n s t a n c e I d e n t i f i e r , t r a n s a c t i o n I D , and t r a n s a c t i o n A t t e m p t C o u n t
from the original inbound B C R e q u e s t T o P P message.
See Table 23.

Table 23 BCResponseFromPP: Responder Private Process to TIBCO BusinessConnect Message


Field

Type

Required

Description

standardID

String

Yes

RosettaNet.

operationID

String

Yes

A three-part PIP ID of the following format:


PIP/ version/ activity. For eample:
3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 71

Table 23 BCResponseFromPP: Responder Private Process to TIBCO BusinessConnect Message (Contd)


Field

Type

Required

Description

transaction
ID

String

Yes

A concatenation of the initiating trading


partners DUNS ID and the value of the
p r o c e s s I n s t a n c e I d e n t i f i e r field in the
R N R e q u e s t T o P P object, separated by the
character ^. For example:
123456789^PID000000001.
Note You must copy the value of this field

from the original B C R e q u e s t T o P P message.


responder
TrackingID

String

No

(Optional) Private process tracking ID.

closure

String

No

Reserved.

extraInfo

RosettaNet/
Response/
RNResponse
FromPP

Yes

RosettaNet protocol specific data.

RosettaNet/Info/
StatusInfo

Yes

status

See Table 24, RNResponseFromPP Object, on


page 72 for formatting information.
An object describing the status of the
transaction.
See StatusInfo Object on page 73 for
formatting information.

attachment
List

Sequence of

No

RosettaNet/Info/

See Table 32 on page 82 for formatting


information.

AttachmentInfo

sender

RosettaNet/Info/
TPInfo

A sequence of attachments.

Yes

The initiator trading partner.


See Table 31 on page 82 for formatting
information.
Note You must copy the value of this field

from the original B C R e q u e s t T o P P message.


response

String

No

The content of the entire RosettaNet PIP


response. See Request and Response Fields
on page 83 for formatting information.
Do not use this field to send an exception
response, but use the s t a t u s field instead.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

72

| Chapter 7

Private Processes

Table 23 BCResponseFromPP: Responder Private Process to TIBCO BusinessConnect Message (Contd)


Field

Type

Required

Description

file
Reference

String

No

The absolute path to the RosettaNet PIP


response document you wish to send. You
may use this field instead of the r e s p o n s e
field if the document is too large or for any
other reason.
This field takes precedence over the
field.

response

RNResponseFromPP Object
Included in the e x t r a I n f o field is the R N R e s p o n s e F r o m P P object
(R o s e t t a N e t / R e s p o n s e / R N R e s p o n s e F r o m P P ). See Table 24 for a description of
each field:
Table 24 RNResponseFromPP Object
Message
Field

Type

Description

rnifVersion

String

Specify 1 . 1 or 2 . 0 to indicate the RNIF version


you wish to use. The value provided here is copied
to the < V e r s i o n I d e n t i f i e r > element in the
outbound response documents preamble header.

globalUsage
Code

String

Specify T e s t or P r o d u c t i o n . The value provided


here is copied to the < G l o b a l U s a g e C o d e > element
in the outbound response documents preamble
header.

process
Instance
Identifier

String

The instance identifier to be copied to the


(RNIF
1.1) or p i p I n s t a n c e I d / I n s t a n c e I d e n t i f i e r
(RNIF 2.0) element of the outbound response
documents service header.
ProcessIdentity/InstanceIdentifier

Note You must copy the value of this field from the
original B C R e q u e s t T o P P message.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 73

Table 24 RNResponseFromPP Object (Contd)


Message
Field

Type

Description

transaction
Identifier

String

(RNIF 1.1 only) The transactions instance


identifier. The value provided here is copied to the
TransactionIdentity/InstanceIdentifier

element of the outbound response documents


service header.
transaction
AttemptCount

Integer

(RNIF 1.1 only) Number for the current attempt


(first one is 1). The value provided here is copied to
the < A t t e m p t C o u n t > element of the outbound
response documents service header.

StatusInfo Object
The S t a t u s I n f o object (R o s e t t a N e t / I n f o / S t a t u s I n f o ) is used to indicate a
success or error of the transaction. An indicated error in this object causes TIBCO
BusinessConnect RosettaNet Protocol to send an exception response to the
trading partner. See Table 25 for a description of each field:
Table 25 StatusInfo Object
Field

Type

Description

code

String

Either s u c c e s s or e r r o r to indicate whether the PIP


succeeded or failed. If the value here is e r r o r, an
exception response is sent to the trading partner.

reason

String

The reason for error in case an error occurred. The value


of this field is copied into the
/ExceptionDescription/errorDescription/FreeFor
m T e x t element in the exception response that is sent to
the trading partner.

rnCode

String

The RNIF 2.0 exception code.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

74

| Chapter 7

Private Processes

Inbound Response Format


TIBCO BusinessConnect RosettaNet Protocol uses the following message class to
forward inbound response messages to the initiator private process.

Initiator
Private
Process

Class
Subject

Responder
Private
Process

Internet
Initiator Response

BC
Initiator

BC
Responder

BCResponseToPP

prefix.installation.R o s e t t a N e t . I N I T I A T O R . R E S P O N S E (Rendezvous)
Example: A X . B C . A C M E _ S E R V E R . R o s e t t a N e t . I N I T I A T O R . R E S P O N S E
prefix.installation. I N I T I A T O R . R E S P O N S E (JMS queue)

Message Fields

See Table 26.

Table 26 BCResponseToPP Fields


Field

Type

Required

Description

standardID

String

Yes

The string "RosettaNet".

transactionID

String

No

The tracking identifier specified by the


initiator private process when it initiates the
PIP request. See the description of
t r a n s a c t i o n I D in Table 19,
BCRequestFromPP Message Fields, on
page 64 for more information on how to
specify a tracking identifier for a PIP
transaction.
This field is empty if no t r a n s a c t i o n I D is
defined by initiator private process in the
corresponding B C R e q u e s t F r o m P P message.

operationID

String

Yes

A three-part PIP ID of the following format:


PIP/ version/ activity. For eample:
3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 75

Table 26 BCResponseToPP Fields


Field
sender

Type

Required

Description

RosettaNet/
Info/TPInfo

Yes

The initiator trading host.


See Table 31 on page 82 for formatting
information.

receiver

RosettaNet/
Info/TPInfo

Yes

The responder trading partner.


See Table 31 on page 82 for formatting
information.

closure

String

No

Reserved.

extraInfo

RosettaNet/
Response/
RNResponseToPP

Yes

RosettaNet protocol specific data.

Sequence of

No

A sequence of attachments. See Table 32 on


page 82 for formatting information.

attachment
List

See RNResponseToPP Object on page 76 for


formatting information.

RosettaNet/Info/
AttachmentInfo

response

String

Yes

The content of the entire RosettaNet PIP


response. See Request and Response Fields
on page 83 for formatting information.

file
Reference

String

No

The absolute path of the file containing the


PIP response document. See Handling Large
Payload Size on page 15 for more
information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

76

| Chapter 7

Private Processes

RNResponseToPP Object
Included in the e x t r a I n f o field is the R N R e s p o n s e T o P P object,
R o s e t t a N e t / R e s p o n s e / R N R e s p o n s e T o P P. This object contains useful information
extracted from the MIME-formatted message. See Table 27 for a description of
each field:
Table 27 RNResponseToPP Object
Field

Type

Description

messageSent

String

The time stamp of the received PIP response.


This field is formatted as follows: Y Y Y Y / M M / D D
H H : M M : S S . S S S . For example: 2 0 0 7 / 0 8 / 3 0
14:41:35.500.

rnifVersion

String

The RNIF version extracted from the


element in the inbound
response documents preamble header.

<VersionIdentifier>

globalUsage
Code

String

pipCode

String

The PIP mode extracted from the


< G l o b a l U s a g e C o d e > element in the inbound
response documents preamble header.
The PIP code extracted from the
element of the
inbound response documents service header.

<GlobalProcessIndicatorCode>

pipVersion

String

pip
Transaction

String

pipAction

String

The PIP version extracted from the


< V e r s i o n I d e n t i f i e r > element of the inbound
response documents service header.
The name of the PIP transaction extracted from the
(RNIF 1.1) or
< B u s i n e s s A c t i v i t y I d e n t i f i e r > (RNIF 2.0)
element of the inbound response documents
service header.
<GlobalTransactionCode>

The name of the PIP transaction extracted from the


ActionControl/ActionIdentity/

element of the
inbound response documents service header.

GlobalBusinessActionCode

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 77

Table 27 RNResponseToPP Object (Contd)


Field

Type

process
Instance
Identifier

String

transaction
Identifier

String

Description
The instance identifier extracted from the
(RNIF
1.1) or p i p I n s t a n c e I d / I n s t a n c e I d e n t i f i e r
(RNIF 2.0) element of the inbound response
documents service header.
ProcessIdentity/InstanceIdentifier

(RNIF 1.1 only) The transactions instance


identifier extracted from the
TransactionIdentity/InstanceIdentifier

element of the inbound response documents


service header. RNIF 1.1 only.
transaction
AttemptCount

Integer

proprietary
Document
Identifier

String

(RNIF 1.1 only) The number for the current attempt


(first one is 1) extracted from the < A t t e m p t C o u n t >
element of the inbound response documents
service header.
The value of the
<proprietaryDocumentIdentifier>

element in

the inbound response document.

Advisory Message Format


TIBCO BusinessConnect RosettaNet Protocol uses advisory messages
(A d v i s o r y I n f o ) to update private processes on the state of PIP transactions.
When a transaction is proceeding normally, TIBCO BusinessConnect RosettaNet
Protocol publishes A d v i s o r y I n f o messages every time the transaction changes
states.
The field names map to (but are not the same as) column names in the audit
database, and their values match the values that are written to the audit database.
Do not use A d v i s o r y I n f o messages to send transaction errors to
BusinessConnect.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

78

| Chapter 7

Private Processes

Class
Subject

AdvisoryInfo

prefix.installation.R o s e t t a N e t . I N F O (Rendezvous)
Example: A X . B C . A C M E . R o s e t t a N e t . I N F O
prefix.installation. I N F O (JMS queue)

Message Fields

See Table 28.

Table 28 AdvisoryInfo Fields


Field

Type

Description

statusCode

Integer

One of the internal status codes.

statusMsg

String

Indicates the state of a PIP. For example:


S E N T - T P - R E Q U E S T. See Appendix A, PIP States,
on page 141.

details

String

A description of the state.

operationID

String

A three-part ID of the form: PIP/version/activity.

transaction
ID

String

Used by the private process to cross-reference


this PIP.

standardID

String

The string "RosettaNet".

timestamp

String

The timestamp for this message.

host

RosettaNet/Info/TPInfo

The trading host. See Table 31 on page 82 for


formatting information.

trading
Partner

RosettaNet/Info/TPInfo

The trading partner in this transaction. See


Table 31 on page 82 for formatting information.

extraInfo

RosettaNet/Info/
RNAdvisoryInfo

RosettaNet specific data. See RNAdvisoryInfo


Object on page 79.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 79

RNAdvisoryInfo Object
The R N A d v i s o r y I n f o object (R o s e t t a N e t / I n f o / R N A d v i s o r y I n f o ) has the
following fields:
Table 29 RNAdvisoryInfo Object
Field

Type

Description

rnifVersion

String

The RNIF version from the < V e r s i o n I d e n t i f i e r >


element in the PIP documents preamble header.

globalUsage
Code

String

The PIP mode from the < G l o b a l U s a g e C o d e >


element in the PIP documents preamble header.

pipCode

String

The PIP code from the


<GlobalProcessIndicatorCode>

element in the

PIP documents service header.


pipVersion

String

The PIP version from the < V e r s i o n I d e n t i f i e r >


element in the PIP documents service header.

pip
Transaction

String

(RNIF 1.1 only) The name of the PIP transaction


from the < G l o b a l P r o c e s s C o d e > (RNIF 1.1) or
< B u s i n e s s A c t i v i t y I d e n t i f i e r > (RNIF 2.0)
element in the PIP documents service header.
Note This field is empty in an A d v i s o r y I n f o

message for inbound messages.


pipAction

String

The most recent PIP action from the


ActionControl/ActionIdentity/
GlobalBusinessActionCode

element in the PIP

documents service header.


process
Instance
Identifier

String

transaction
Identifier

String

The instance identifier from the


(RNIF
1.1) or p i p I n s t a n c e I d / I n s t a n c e I d e n t i f i e r
(RNIF 2.0) element in the PIP documents service
header.
ProcessIdentity/InstanceIdentifier

(RNIF 1.1 only) The transactions instance identifier


from the
TransactionIdentity/InstanceIdentifier

element in the PIP documents service header. RNIF


1.1 only.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

80

| Chapter 7

Private Processes

Table 29 RNAdvisoryInfo Object (Contd)


Field

Type

Description

transaction
Attempt
Count

Integer

(RNIF 1.1 only) Number for the current attempt


(first one is 1) from the < A t t e m p t C o u n t > element in
the PIP documents service header.

proprietary
Document
Identifier

String

The value of the


<proprietaryDocumentIdentifier>

element in

the PIP document.

Error Message Format


When an error occurs, TIBCO BusinessConnect RosettaNet Protocol terminates
the transaction and publishes an E r r o r N o t i f y message.
Do not use E r r o r N o t i f y messages to send transaction errors to BusinessConnect.
You can notify BusinessConnect of a transaction error in the s t a t u s field of a
B C R e s p o n s e F r o m P P message.
BusinessConnect communicates state changes using advisory messages. See
Appendix A, PIP States, on page 141 for a list of states and their descriptions.
Class
Subject

ErrorNotify

prefix.installation.R o s e t t a N e t . E R R O R (Rendezvous)
Example: A X . B C . A C M E . R o s e t t a N e t . E R R O R
prefix.installation. E R R O R (JMS queue)

Message Fields

See Table 28.

Table 30 ErrorNotify Fields


Field

Type

Description

statusCode

Integer

One of the internal error codes. See Advisory


and Error Status Codes on page 84 for a
description of each code.

statusMsg

String

The name of the error. See Appendix A, PIP


States, on page 141.

details

String

A description of the error.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Private Process Message Formats 81

Table 30 ErrorNotify (Contd)Fields


Field

Type

Description

msgDirection

String

Either I n b o u n d or O u t b o u n d . This field indicates


the direction of the message.

operationID

String

A three-part ID of the form: PIP/version/activity.

transaction
ID

String

(Optional but recommended) Used by the


private process to cross-reference this PIP.

standardID

String

The string "RosettaNet".

timestamp

String

The timestamp for this message.

host

String

The trading host. See Table 31 on page 82 for


formatting information.

tpName

String

The trading partner in this transaction.

extraInfo

String

A series of name-value pairs separated by a


comma and space character. For example:
rnifVersion=1.1, pipCode=3A4, ...

The name-value pairs in this field are the same


as the data in the R N A d v i s o r y I n f o object. See
RNAdvisoryInfo Object on page 79 for a
description of each name-value pair.

Additional Data Objects


T P I n f o (R o s e t t a N e t / I n f o / T P I n f o ) and A t t a c h m e n t I n f o
(R o s e t t a N e t / I n f o / A t t a c h m e n t I n f o ) are additional complex types that are
commonly used by some or all of the private process message classes.

For description of T P I n f o fields, see Table 31.

For description of A t t a c h m e n t I n f o fields, see Table 32.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

82

| Chapter 7

Private Processes

Table 31 TPInfo Fields


Field

Type

Description

id

String

The identifier of the trading partner. By default,


RosettaNet uses the 9-digit DUNS numbers.

locationID

String

Used to support multiple destination URL for remote


trading partner.

domain

String

The domain for this id. Currently there is only one


domain (DUNS), so this field is optional.

Table 32 AttachmentInfo Object


Field

Type

Description

content-type

String

The attached data type. For example:


a p p l i c a t i o n / b i n a r y.

content-id

String

The order of this attachment in the list of


attachments in the following format:
< a t t a c h m e n t : number> . For example,
< a t t a c h m e n t : 2 > indicates that this is the second
attachment in a list.

dispositionfilename

String

The filename of the attachment. This field


corresponds to the f i l e n a m e parameter in the
MIME headers c o n t e n t - d i s p o s i t i o n field.
If you do not supply a value in an outbound
message, TIBCO BusinessConnect RosettaNet
Protocol generates one automatically. If an inbound
public message does not contain the filename
parameter in the attachment MIME headers
c o n t e n t - d i s p o s i t i o n field, then TIBCO
BusinessConnect RosettaNet Protocol does not
include this field when forwarding the attachment
to the private process.

content

Binary

TIBCO BusinessConnect RosettaNet Protocol Users Guide

The content of the attachment.

Private Process Message Formats 83

Table 32 AttachmentInfo Object (Contd)


Field

Type

Description

file
Reference

String

In BCRequestFromPP and BCResponseFromPP The


absolute path to the attached file you wish to use.
You may use this field instead of the c o n t e n t field
if the attachment is too large or for any other
reason. This field takes precedence over the
c o n t e n t field.
In BCRequestToPP and BCResponseToPP The

absolute path of the file containing the attachment.


See Handling Large Payload Size on page 15 for
more information.

Request and Response Fields


The r e q u e s t or r e s p o n s e field in a private process message contains the
XML-formatted RosettaNet PIP document, without the service header, the
preamble header, and attachments. If the f i l e R e f e r e n c e field is used, the
content of the document file follows the same format as the r e q u e s t and
r e s p o n s e fields.
The content in the r e q u e s t or r e s p o n s e field is eventually composed with other
information by TIBCO BusinessConnect RosettaNet Protocol into a valid PIP
document, which conforms to the RosettaNet PIP Action Message Guideline. It
contains an XML declaration, followed by a request or response PIP document as
the single root element. The example below is a PIP 3A4 Purchase Order Request
document in the r e q u e s t field:
<?xml version="1.0">
<Pip3A4PurchaseOrderRequest>
...
</Pip3A4PurchaseOrderRequest>

TIBCO BusinessConnect RosettaNet Protocol can provide participant data to your


PIP document content. See Data Substitutions in PIP Request and Response on
page 86 for more information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

84

| Chapter 7

Private Processes

Advisory and Error Status Codes


This section describes all the status codes that TIBCO BusinessConnect
RosettaNet Protocol generates, some of which are forwarded to the private
process. In advisory and error messages, the code and its description are found in
the s t a t u s C o d e and s t a t u s M s g fields, respectively.
See Table 33 for descriptions to the codes, as well as suggestions for resolutions
when meeting a specific code.
Table 33 statusCode and statusMsg Field Reference
statusCode

statusMsg

Role

Category

Resolution

200

OK

201-299

HTTP(S) OK codes

300 - 499

HTTP(S) error codes

Error

900

HTTP(S) send of
action/signal
failed...attempt retry

Error

System

TIBCO BusinessConnect
RosettaNet Protocol attempts
retry internally.

901

HTTP(S) send of
action/signal failed...retry
count exceeded

Error

System

Contact your trading partner to


verify their gateway's stability
or any network problems.

922

Time out waiting for


Response Document from
Private Process

Error

System

Check your private process for


problems.

924

PIP terminated

Error

System

925

Fatal error in incoming


Message

Error

System

Contact your trading partner to


verify the incoming message as
it appears to be corrupted.

926

Error in incoming message


service header

Error

System

Contact your trading partner to


verify the incoming message as
it appears malformed in the
Service Header.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Advisory and Error Status Codes 85

Table 33 statusCode and statusMsg Field Reference (Contd)


statusCode

statusMsg

Role

Category

Resolution

927

Error in incoming message


service content

Error

System

Contact your trading partner to


verify the incoming message as
it appears malformed in the
Service Content

928

Failed to store
Non-Repudiation
information

Error

System

Contact your DBA to verify


stability of the database.

929

Retry attempts exceeded,


no incoming
acknowledgment from
trading partner

Error

System

Contact your Trading Partner


to verify their gateway's
stability or any network
problems.

933

Received Response
Document, expecting
acknowledgment receipt
from trading partner

Error

System

Contact your trading partner to


verify their gateway's software
as it appears that they have a
messaging sequencing issue.

999

Unsupported Response
Type

Error

System

Contact your trading partner to


verify their gateway's software
as it appears that this PIP
transaction is not configured to
perform the nominated
response-type.

1000 - 1999

Trading partnerdefined
codes

Error

TIBCO BusinessConnect RosettaNet Protocol Users Guide

86

| Chapter 7

Private Processes

Data Substitutions in PIP Request and Response


TIBCO BusinessConnect RosettaNet Protocol can be configured to supply data for
specific XML message elements when forwarding outbound PIP documents from
the private process. It does so by looking in the r e q u e s t or r e s p o n s e field of the
B C R e q u e s t F r o m P P or B C R e s p o n s e F r o m P P message and search for the string "XXX"
in a select group of elements. When it finds the string "XXX", it replaces the string
with the data in its configuration store that corresponds to that child element.
If you choose to provide the values of these elements yourself, note that TIBCO
BusinessConnect RosettaNet Protocol does not verify these values against its
corresponding configuration store data.

Applicable XML Data for Substitution


Two groups of XML elements, and the options that control them are not the same:

Basic Document Data Four XML elements, which contain general information
about the message, can have their values supplied by TIBCO BusinessConnect
RosettaNet Protocol:

/DocumentHeader/DocumentInformation/Creation

/DocumentHeader/DocumentInformationDocumentIdentification
/Identifier

/thisDocumentGenerationDateTime/DateTimeStamp

/thisDocumentIdentifier/ProprietaryDocumentIdentifier

To configure data substitution for these XML elements, you must select the
RosettaNet-specific property b c r n . o u t b o u n d . d o c . i n l i n e . r e p l a c e m e n t . See
Configuring for Data Substitution on page 88 for detailed instructions.

Participant Data Table 34 on page 87 lists the XML elements in the r e q u e s t

and r e s p o n s e fields whose values can be substituted, as well as their


corresponding data in the BusinessConnect configuration store. All of these
elements can be found under the following parent elements:

/fromRole/PartnerRoleDescription

/toRole/PartnerRoleDescription

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Data Substitutions in PIP Request and Response 87

Unlike the basic document data group, you must select a few different options
in the BusinessConnect console in order to configure data substitutions for the
participant data group:
The b c r n . o u t b o u n d . d o c . i n l i n e . r e p l a c e m e n t property in System
Settings > Installed Protocols > RosettaNet
The Outbound Document Inline Replacement checkbox in the trading
partners Edit Enabled Protocol: RosettaNet panel
See Configuring for Data Substitution on page 88 for detailed instructions.
Table 34 Substitutable Pariticipant Elements
Element

Data in BusinessConnect Console

/fromRole/PartnerRoleDescription
/GlobalPartnerRoleClassificationCode

(For outbound request) Operations Editor >

RosettaNet > PIP Activity > Request-Response


Activity tab > General sub-tab > From Role
Classification Code
(For outbound response)

From the following field of the inbound request:


/toRole/PartnerRoleDescription/GlobalPartn
erRoleClassificationCode

Note: This element cannot be substituted for RNIF


1.1 for outbound response messages.
/toRole/PartnerRoleDescription
/GlobalPartnerRoleClassificationCode

(For outbound request) Operations Editor >

RosettaNet > PIP Activity > Request-Response


Activity tab > General sub-tab > To Role
Classification Code
(For outbound response)

From the following field of the inbound request:


/fromRole/PartnerRoleDescription/GlobalPar
tnerRoleClassificationCode

Note: This element cannot be substituted for RNIF


1.1 outbound response messages.
/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/ContactInformation/EmailAddress

Participant > Business Locations > Headquarters >


Email

/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/ContactInformation/contactName
/FreeFormText

Participant > Business Locations > Headquarters >


Primary Legal Contact

TIBCO BusinessConnect RosettaNet Protocol Users Guide

88

| Chapter 7

Private Processes

Table 34 Substitutable Pariticipant Elements (Contd)


Element

Data in BusinessConnect Console

/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/ContactInformation/telephoneNumber
/CommunicationsNumber

Participant > Business Locations > Headquarters >


Phone

/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/ContactInformation/facsimileNumber
/CommunicationsNumber

Participant > Business Locations > Headquarters >


Fax

/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/PartnerDescription
/GlobalPartnerClassificationCode

Participant > Protocols > RosettaNet > General tab >


Partner Classification Code

/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/PartnerDescription
/BusinessDescription
/GlobalBusinessIdentifier

Participant > Protocols > RosettaNet > General tab >


Default Domain Identity

/ from_or_toR o l e / P a r t n e r R o l e D e s c r i p t i o n
/PartnerDescription
/BusinessDescription
/GlobalSupplyChainCode

Participant > Protocols > RosettaNet > General tab >


Supply Chain Code

Configuring for Data Substitution


To configure TIBCO BusinessConnect RosettaNet Protocol to supply information
for your outbound PIP document, follow the instructions below:
1. In the BusinessConnect console in TIBCO Administrator, go to
BusinessConnect > System Settings > Installed Protocols > RosettaNet.
2. Select the b c r n . o u t b o u n d . d o c . i n l i n e . r e p l a c e m e n t property.
3. (Participant data only) Go to the General tab of the Edit Enabled Protocol:
RosettaNet panel for the partner participant.
4. (Participant data only) Select the Outbound Document Inline Replacement
checkbox to enable data substitution when sending outbound documents to
the trading partner.
5. When constructing the outbound message to this trading partner in the
private process, specify X X X for the value of the XML element in the r e q u e s t
or r e s p o n s e field. For example:
<EmailAddress>XXX</EmailAddress>

After TIBCO BusinessConnect RosettaNet Protocol processes the Rendezvous


message, the example line in the final forwarded PIP document looks as
follows:
<EmailAddress>b2b@company.com</EmailAddress>

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Private Processes with TIBCO BusinessWorks 89

Configuring Private Processes with TIBCO BusinessWorks


To define a TIBCO BusinessWorks private process to interact with
BusinessConnect requires the following resources:

BusinessConnect Connection (BCServerConfig) a shared resource that


connects to the BusinessConnect configuration store for the settings in TIBCO
BusinessConnect RosettaNet Protocol.

Activities to handle outbound and inbound BusinessConnect messages.

Configuring BCServerConfig Resource


In order for your private process to communicate with your BusinessConnect
server, you must include exactly one (1) BCServerConfig resource in the root
project view.
Follow the instructions below to configure the BCServerConfig resource:
1. In TIBCO Designer, click Palettes in the menu bar and select Browse....
2. Select BusinessConnect under the BusinessConnect folder to make the
BusinessConnect palette available.
3. Click Close.
4. Click the root project directory of your TIBCO BusinessWorks project.
5. Open the palette panel.
6. Drag a BusinessConnect Connection resource into the design panel.
You will see the resource in the design panel with the name "BCServerConfig".
You can change its name in the configuration panel if you wish.
7. Click the BusinessConnect Server Access tab.
8. Select the JDBC driver you will use to communicate with the BusinessConnect
configuration store in the JDBC Driver drop-down list.
The settings in step 8, step 9, and step 10 should be the same as the settings in
your BusinessConnect installation. To see the JDBC settings in your
BusinessConnect installation, log into TIBCO Administrator and go to
BusinessConnect > System Settings > JDBC Configuration; then select the
bc-db connection alias.
9. Type the URL for the BusinessConnect configuration store in the JDBC URL
field.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

90

| Chapter 7

Private Processes

10. Type the configuration store username and password in the DB User and DB
Password fields.
11. Click the Apply button.
12. Click the Configuration tab.
Note that the Update Transport Settings checkbox is selected. By default, the
resource synchronizes its Rendezvous or JMS settings with the settings in the
BusinessConnect configuration store.
13. Click the Update from Configuration Store button.
14. Select RosettaNet from the Protocol Name drop-down list.
15. Click the Import Selected Business Protocol button. TIBCO Designer will
now retrieve all installed operations in the BusinessConnect configuration
store and place them in the BCSchemas project folder in the form of schemas.
Do not move, modify, or delete the BCSchemas folder or the contents therein.

16. Click Apply.


For more information on the BusinessConnect Connection (BCServerConfig)
resource, see TIBCO BusinessConnect Palette Reference.

Configuring Send and Receive Activities


There are three BusinessConnect Send activities for sending requests (or receipts),
responses and miscellaneous messages. There are also three BusinessConnect
receive activities for receiving requests (or receipts), response, and miscellaneous
messages.
When configuring a Send activity, you must ensure that all required fields are
supplied to the activity before the Send activity can be executed. When a Send
activity is executed, the resource sends a request of the selected operation to
BusinessConnect.
Unlike Send activities, Receive activities are process starters. Therefore, there can
be only one Receive activity in a process definition and the Receive activity acts to
start the process. A process definition with the Receive start activity is invoked
when BusinessConnect receives a message from a trading partner and sends it to
TIBCO BusinessWorks. You can configure the process definition to use the output
of the Receive activity to perform different tasks, such as formulating a response
message and invoking a Send activity.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Configuring Private Processes with TIBCO BusinessWorks 91

For more information on configuring each of the Send and Receive activities, see
TIBCO BusinessConnect Palette Reference. You may also step through the tutorial in
Chapter 10, Tutorial TIBCO BusinessWorks Private Processes, on page 129 to
learn how to configure a TIBCO BusinessWorks project to send and receive
RosettaNet messages.
The following sub-sections give you a quick glance at the resources you need to
configure different kinds of private processes.
Configuring Initiators
In order for your TIBCO BusinessWorks processes to initiate request-response or
notify PIPs, you need the following resources:

BCServerConfig for connecting to your BusinessConnect server.

Send Request/Notifiction for sending request or notify messages to trading


partners.

Receive Response (request-response only) for receiving responses from


trading partners.

Receive Misc. Msg for receiving any error messages from BusinessConnect.

Configuring Responders
In order for your TIBCO BusinessWorks processes to receive request messages,
you need the folowing resources:

BCServerConfig for connecting to your BusinessConnect server.

Receive Request/Notification for receiving request messages from trading


partners.

Send Response for sending response messages to BusinessConnect.

Receive Misc. Msg for receiving any advisory or error messages from
BusinessConnect.

Configuring Notification Receivers


In order for your TIBCO BusinessWorks processes to receive notify messages, you
need the following resources:

BCServerConfig for connecting to your BusinessConnect server.

Receive Request/Notification for receiving notify messages from trading


partners.

Send Misc. Msg for sending any advisory or error messages to


BusinessConnect.
TIBCO BusinessConnect RosettaNet Protocol Users Guide

92

| Chapter 7

Private Processes

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 93
Chapter 8

Viewing Logs

This chapter discusses how to view audit, non-repudiation, and resend logs after
conducting business transactions. It also discusses how to use message queue log
for scheduled transactions.

Topics

Logging Overview, page 94

Audit Log, page 95

Non-Repudiation Log, page 98

Message Queue Log, page 99

Resend Log, page 100

Logging to the File System, page 102

Customizing Non-Repudiation Logging, page 104

TIBCO BusinessConnect RosettaNet Protocol Users Guide

94

| Chapter 8

Viewing Logs

Logging Overview
TIBCO BusinessConnect RosettaNet Protocol provides four logs that track which
messages have been processed: audit log, non-repudiation log, message queue
log, and resend log. These logs are accessible in the log viewer. See Viewing Logs
on page 94 for more information on accessing the log viewer.
The audit log is used to stored information about the RosettaNet transactions and
documents processed by TIBCO BusinessConnect.
The non-repudiation log is used to provide proof of the delivery of messages and
message content. It is a persistent record of all successfully completed
transactions. You can configure any or all RosettaNet transactions to be stored
into the non-repudiation log. This protects against any attempts by trading
partners to subsequently deny the occurance or content of the transaction. See
Non-Repudiation Log on page 98 for more information.
The message queue log displays the PIP requests in the message queue. Messages in
this log are waiting for the next scheduled transmission. See Message Queue Log
on page 99 for more information.
The resend log displays the audit log transactions that are eligible to be resent, as
well as a history of the resent messages. See Resend Log on page 100 for more
information.
Alternatively, you can log transaction information to the file system. See Logging
to the File System on page 102

Viewing Logs
Follow the instructions below to view logs of RosettaNet PIPs in the log viewer:
1. Click the BusinessConnect > Log Viewer link in the left panel.
2. Click one of the links in the right panel to select which log to view: Audit
Logs, Non-Repudiation Logs, Message Queue Logs, or Resend Logs.
3. Select RosettaNet in the Protocol drop-down list.
For information on searching the logs, see TIBCO BusinessConnect Trading
Partner Administration Guide.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Audit Log 95

Audit Log
The audit log for RosettaNet protocol is used to store information about the
messages and documents processed by TIBCO BusinessConnect RosettaNet
Protocol. You can use the audit log to follow the processing states of inbound or
outbound documents, as well as cancel pending transactions (see TIBCO
BusinessConnect Trading Partner Administration Guide for more information).
Information stored in the audit log for RosettaNet protocol includes sent and
received documents, host and partner names, processing status, and errors and
exceptions.

Summary View
Table 35 lists the columns that appear in the audit log.
Table 35 Audit Log, Summary View Columns
Column Name

Definition

Time Stamp

The time when the message was processed.

Start Time

The time when the transaction was initiated.

Trading Partner

The trading partner name.

Process Identifier

The process identifier generated by TIBCO BusinessConnect RosettaNet


Protocol.

Operation ID

A concatenation of the PIP code, PIP version, and PIP activity of this
transaction. For example: 3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

Proprietary
Document ID

The value in the Proprietary Document ID element within the XML


document.

Host Initiates

Indicates whether the host participant initiated the transaction.

RNIF

The RNIF version.

Private Process
Tracking ID

Tracking ID specified by the initiator private process. See Outbound Request


Format on page 64.

Usage Mode

Either T e s t or P r o d u c t i o n .

TIBCO BusinessConnect RosettaNet Protocol Users Guide

96

| Chapter 8

Viewing Logs

Transaction Details View


To view the details of a transaction, click the
audit log entry.

icon in the left-most column of an

The Log Viewer first displays the general information for this transaction at the
top and a table with information for each event at the bottom. The table columns
are listed in Table 36.
Table 36 Audit Log, Transaction Details View Columns
Column

Definition

Time Stamp

That time the transaction passed through the state displayed in the
State column.

State

The state of the PIP. See Advisory Message Format on page 77.

Description

A more verbose description of the state listed in the State column.

Process Identifier

The process identifier generated by TIBCO BusinessConnect


RosettaNet Protocol.

Transaction Identifier

RNIF 1.1 only. The transaction identifier generated by TIBCO


BusinessConnect RosettaNet Protocol.

Attempt

RNIF 1.1 only. The number of times TIBCO BusinessConnect


RosettaNet Protocol attempted this transaction. Starts with 1 and
increments by 1. If you resend a PIP, the transaction attempt count
restarts at 1.
When using RNIF 2.0, this value is always 1.

Responder Tracking ID

The tracking ID specified by the responder private process. See


Outbound Response Format on page 70.

Status

The status of the entire transaction at the particular state.

State Details View


To view the details of a specific state, click the
icon in the left-most column of a
state detail entry. The state details view displays the following information:

The time that the transaction passed through the selected state

All fields in the transaction summary and the state summary views.

A description of the selected state (the D e s c r i p t i o n property).

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Audit Log 97

The status of the entire transaction at the selected state.

In this view you are also able to save the message to a file for viewing, as well as
resend the message if the state in view is a resendable state. See Resend Log on
page 100 for more information on resendable states.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

98

| Chapter 8

Viewing Logs

Non-Repudiation Log
Non-repudiation logging protects against any attempts by the sender of a
document to subsequently deny the occurance or content of the document. In
TIBCO BusinessConnect RosettaNet Protocol, non-repudiation and digital
signatures are coupled together by default.
In contrast to the audit information, non-repudiation information is intended for
long-term storage, so there is only one entry per PIP. The non-repudiation log
view does not display all the information that it stores for a PIP transaction. For
example, digital signatures are stored but not displayed.
By default, non-repudiation logging is enabled for all inbound and outbound PIP
activities, including all action and signal messages. Also, it is coupled together
with digital signatures, meaning that they are either both used or both unused.
For information on customizing non-repudiation logging, see Customizing
Non-Repudiation Logging on page 104.

Summary View
The non-repudiation log displays one PIP per row in the columns list in Table 37.
Table 37 Non-Repudiation Log Columns
Field

Definition

Time Stamp

Time this non-repudiation log entry was entered.

Protocol Name

The string "RosettaNet".

Installation Name

The name of your BusinessConnect installation.

Process Identifier

A process identifier generated by TIBCO BusinessConnect RosettaNet


Protocol.

Operation ID

A concatenation of the PIP code, PIP version, and PIP activity of this
transaction. For example: 3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

TP ID

The trading partner DUNS number.

Trading Partner

The trading partner name.

RNIF

The version of the RosettaNet protocol being used.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Message Queue Log 99

Message Queue Log


The message queue log displays outbound PIP requests that are scheduled to be
sent out (see Scheduled Transmission on page 58 for more information). In this
view, you can select specific PIP requests from the list and send them out
immediately by clicking the Send button or cancel the transaction by clicking the
Cancel button.
The message queue log displays the columns listed in Table 38.
Table 38 Message Queue Log Columns
Column

Definition

Time Stamp

The time when the message was received from the private process.

Start Time

The time the next scheduled transmission starts.

End Time

The time the next scheduled transmission ends.

Trading Partner

The trading partner name.

Operation ID

A concatenation of the PIP code, PIP version, and PIP activity of this
transaction. For example: 3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

Proprietary Document ID

The value in the Proprietary Document ID element within the


XML-formatted PIP document.

Process Identifier

A process identifier generated by TIBCO BusinessConnect


RosettaNet Protocol.

Host Initiates

Indicates whether the host participant initiated the transaction.

RNIF

The RNIF version.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

100

| Chapter 8

Viewing Logs

Resend Log
The resend log displays the columns list in Table 39. Transactions in the following
states are resendable:

HTTP-FAILURE

RECEIVED-TP-REQUEST (see Resending RECEIVED-TP-REQUEST on


page 101)

RECEIVED-PP-REQUEST (see Resending RECEIVED-PP-REQUEST on


page 101)

RECEIVED-PP-RESPONSE

SENT-PP-REQUEST

SENT-PP-RESPONSE

Table 39 Resend Log Columns


Column

Definition

Time Stamp

The time when the message was processed.

Start Time

The time when the transaction was initiated.

Trading Partner

The trading partner name.

Operation ID

A concatenation of the PIP code, PIP version, and PIP activity of this
transaction. For example: 3 A 4 / 1 . 4 / C r e a t e P u r c h a s e O r d e r.

Proprietary
Document ID

The value in the Proprietary Document ID element within the XML document.

Host Initiates

Indicates whether the host participant initiated the transaction.

RNIF

The RNIF version.

Private Process
Tracking ID

Tracking ID specified by the initiator private process. See Outbound Request


Format on page 64.

State

The state of the PIP. See Appendix A, PIP States, on page 141.

Description

A more verbose description of the state listed in the State column.

Process Identifier

The process identifier generated by TIBCO BusinessConnect RosettaNet


Protocol.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Resend Log 101

Resending RECEIVED-TP-REQUEST
TIBCO BusinessConnect RosettaNet Protocol behaves in the following way when
you resend an inbound PIP transaction at the RECEIVED-TP-REQUEST state:

If the original transaction is being processed, TIBCO BusinessConnect


RosettaNet Protocol resends the inbound request document to the private
process, but does not resend the acknowledgement receipt to the trading
partner. However, it does forward the response document from the private
process to the trading partner.

If the transaction status is C O M P L E T E D and T E R M I N A T E D , TIBCO


BusinessConnect RosettaNet Protocol does nothing more than resending the
inbound request to the private process. In other words, it does not resend
receipt acknowledgement to the trading partner nor process the response
document from the private process.

TIBCO BusinessConnect RosettaNet Protocol does not detect duplicate


messages when resending a PIP at this state. See Duplicate Detection on
page 10 for more information on duplicate detection.

When TIBCO BusinessConnect RosettaNet Protocol sends a request document


to the private process using a file reference, it saves a copy of the payload file
in the Shared Temporary Directory (see Large Payload and Attachment
Directories on page 14) with the prefix of
R e s e n d _ R e c e i v e d - T P - R e q u e s t _ PID_ . It then uses this payload file when
resending the same PIP to the private process. Note that TIBCO
BusinessConnect RosettaNet Protocol does not remove this file automatically.
You must remove it manually when archiving your data.

Resending RECEIVED-PP-REQUEST
You can resend any PIP at the RECEIVED-PP-REQUEST state, with the following
exceptions:

If a PIP is scheduled, it enters the RECEIVED-PP-REQUEST state twice, once


when it is scheduled and placed into the message queue, and once after it
enters the scheduled time frame. When a scheduled PIP enters
RECEIVED-PP-REQUEST a second time, its Description field is appended
with the string "Scheduled". This second RECEIVED-PP-REQUEST state
cannot be resent.

TIBCO BusinessConnect RosettaNet Protocol does not detect duplicate


messages when resending a PIP at this state. See Duplicate Detection on
page 10 for more information on duplicate detection.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

102

| Chapter 8

Viewing Logs

Logging to the File System


By default, TIBCO BusinessConnect RosettaNet Protocol logs transactions to the
audit log database. However, you can also log messages to a file system. This
section provides the procedure for enabling logging to the file system, describes
the directory structure and filenames, and discusses a scenario that can result in
unmatched messages.
To enable the file logging feature, perform these steps:
1. In the BusinessConnect console, navigate to the RosettaNet configuration
panel for installed protocols: BusinessConnect > System Settings > Installed
Protocols > RosettaNet.
2. Enable the b c r n . a u d i t . t o . d i r . m e s s a g e s property by selecting the
checkbox.
3. Navigate to the RosettaNet General tab: BusinessConnect >
Participants >Host >RosettaNet>General.
4. Select Enable Audit Logging to File.
5. Type a valid directory path to act as the root directory for your log files in the
Directory for Audit Log Files field.

Directory Structure and Filenames


The structure of the storage directory hierarchy is as follows:
root_directory/ yyyymmdd/ host_ip/ tp_identity/ pip_code

For example:
c : \ t i b c o \ b c \ version\ a u d i t \ 2 0 0 5 1 0 0 4 \ 1 0 . 2 . 1 0 0 . 1 0 5 \ 9 8 7 6 5 4 3 2 1 \ 3 A 4

The name of each file is prefix-PID-sequence_no, where prefix can be one of the
following:

Inbound

Outbound

Unmatched

Error

(for incoming messages)


(for outgoing messages)
(for messages that do not match any pending transactions)

(for messages that triggered a transaction termination)

For example: O u t b o u n d - P I D 1 1 2 8 3 8 4 9 7 4 4 7 5 - 1

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Logging to the File System 103

In general, you may want to log messages for successful transactions to file and
may not be interested in logging the unmatched or error messages. To control
what can be logged to file, set the b c r n . a u d i t . t o . d i r . * properties, which are
described in Table 44, Property Reference, on page 145.

Unmatched Messages
The following scenario may create unmatched messages:
Your business partner, who is new to RosettaNet implementation, sends a receipt
acknowledgment for a 3A4 PIP, but the partner constructs the RosettaNet
message incorrectly. When TIBCO BusinessConnect RosettaNet Protocol inspects
the message, it cannot extract enough information to match the pending 3A4
transaction, and therefore drops the message.
If you enable the log-to-file feature and set the b c r n . a u d i t . t o . d i r . u n m a t c h e d
property to true, TIBCO BusinessConnect RosettaNet Protocol will log this
message to file. You can then inspect this document and identify the problem and
notify the trading partner.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

104

| Chapter 8

Viewing Logs

Customizing Non-Repudiation Logging


In TIBCO BusinessConnect RosettaNet Protocol, you can customize how
non-repudiation logging is applied to PIP transactions by using different
conbinations of options.

Non-Repudiation Logging for PIP Transactions or Action and Signal Messages


Follow the instructions below to apply non-repudiation to a specific PIP
transaction or one of its action or signal messages (see Table 40 on page 105 for
information on each option):
1. Select Action: Non-Repudiation Required to apply non-repudiation logging
to a PIP action.
2. Select Signal: Non-Repudiation Required to apply non-repudiation logging
to a PIP signal.
To apply non-repudiation to an entire PIP transaction, select Action:
Non-Repudiation Required and Signal: Non-Repudiation Required for both the
request action and the response action.
3. Select Use Digital Signature Where Required to enable digital signatures and
non-repudiation logging.

Digital Signatures Without Non-Repudiation Logging


By default, non-repudiation logging and digital signatures are coupled together
in TIBCO BusinessConnect RosettaNet Protocol. However, you can use digital
signatures without non-repudiation logging for a specific PIP in a business
agreement. You can also have separate settings for outbound actions and inbound
actions.
In order to override PIP activity settings in a business agreement, you must add
the activities to the Edit Operation Binding: RosettaNet panel manually.
Follow the instructions below to use digital signatures without non-repudiation
logging (see Table 40 on page 105 for information on each option):
1. Select Use Digital Signature Where Required to enable digital signatures and
non-repudiation logging.
2. Select Override Operation Settings for a PIP action (inbound or outbound).

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Customizing Non-Repudiation Logging 105

3. Select Override Message Properties.


4. Select Digital Signature is Required for that PIP action.
5. Keep Non Repudiation is Required cleared for that PIP action.
Table 40 Options for Configuring Non-Repudiation
Option

Description

In the General tab of a partner participants RosettaNet configuration panel (See Configuring
RosettaNet for Trading Partners on page 38):
Use Digital Signature
Where Required

Controls all non-repudiation and digital signature functionalities with that


specific partner. You cannot use non-repudiation or digital signatures with
a partner unless you select this checkbox. See Configuring RosettaNet for
Trading Partners on page 38 for more information on locating this
checkbox.

In the Edit Protocol Binding: RosettaNet panel for a business agreement:


Non Repudiation
Logging

Specifies whether your business partner requires non-repudiation for its


transactions. If selected, TIBCO BusinessConnect RosettaNet Protocol signs
all outbound documents in the business agreement.

In the Edit Activity panel of a PIP activity in Operations Editor (in the Request Action, Response
Action, and Notify Request tabs; see Adding RosettaNet PIPs Manually on page 20 for more
information)
Action:
Non-Repudiation
Required
(Action sub-tab)
Signal:
Non-Repudiation
Required
(Signal sub-tab)

Specifies whether a PIP action requires non-repudiation. If selected, TIBCO


BusinessConnect RosettaNet Protocol signs the outbound action message
or verifies the digital signature of the inbound action message for that PIP,
and logs the action in the non-repudiation database.
Specifies whether a PIP signal requires non-repudiation. If selected, TIBCO
BusinessConnect RosettaNet Protocol signs the outbound signal message
or verifies the digital signature of the inbound signal message for that PIP,
and logs the action in the non-repudiation database.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

106

| Chapter 8

Viewing Logs

Table 40 Options for Configuring Non-Repudiation


Option

Description

In the Override Outbound Settings and Override Inbound Settings panels for a specific
RosettaNet PIP activity in a business agreement:
Override Message
Properties

Override the non-repudiation settings in Operations Editor as well as the


business agreements Edit Protocol Binding: RosettaNet panel. The main
purpose of this checkbox is to enable the decoupling of digital signatures
and non-repudiation logging with the two related options (see below).
Note The Override Operation Settings checkbox must be selected at the top

of the configuration panel.


Digital Signature is
Required

Requires digital signatures for all outbound or inbound action messages,


depending on which panel the checkbox is located. If this checkbox is
selected, digital signatures are used even if non-repudiation logging is
disabled.

Non Repudiation is
Required

Requires non-repudiation for all outbound or inbound action messages,


depending on which panel the checkbox is located. If this checkbox is
selected, non-repudiation logging is used even if digital signatures are
disabled.
Note: it is not recommended for you to use non-repudiation logging
without digital signatures, as digital signatures are the legal signatures of
electronic documents.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 107
Chapter 9

Tutorial Standalone Private Processes

This tutorial guides you through the steps necessary for running a TIBCO
BusinessConnect RosettaNet Protocol transaction. The example in this chapter
uses standalone private processes.

Topics

Overview, page 108

Setting Up Initiator on Machine 1, page 110

Setting Up Responder on Machine 2, page 117

Running the Tutorial Example, page 124

TIBCO BusinessConnect RosettaNet Protocol Users Guide

108

| Chapter 9

Tutorial Standalone Private Processes

Overview
This tutorial demonstrates the entire process of configuring TIBCO
BusinessConnect RosettaNet Protocol to perform RosettaNet operations using
HTTP transport, as well as sending and receiving RosettaNet documents with
private processes. The RosettaNet PIP used in this tutorial is 3A4, a
request-response PIP that manages purchase orders.
This tutorial uses RNIF 1.1.

In this tutorial you will use two machines, each acting as a BusinessConnect
server. You are going to simulate PIP 3A4, a request-response PIP that manages
purchase orders, between an initiator and a responder: the initiator sends a 3A4
document to the seller, and the responder sends a 3A4 response to complete the
PIP.
The following figure describes the flow of events.
2.
TIBCO
BusinessConnect

TIBCO
BusinessConnect

Request

5.
Response
1.

6.
Request

Response

4.

3.

Response

Request

Initiator
Private Process

Responder
Private Process

Machine 1

Machine 2

1. A private process on Machine 1 (the initiator) triggers the purchase order by


sending a Purchase Order XML document for PIP 3A4 to its BusinessConnect
server.
TIBCO BusinessConnect RosettaNet Protocol Users Guide

Overview 109

2. The BusinessConnect server on Machine 1 packages and sends the Purchase


Order XML document to the responder, which is configured as a trading
partner, via an HTTP post.
3. The BusinessConnect server on Machine 2 receives the inbound Purchase
Order XML document, and sends an acknowledgment receipt back to
Machine 1. It then repackages the PIP 3A4 document and fowards the
document to its private process (the responder).
4. The responder private process receives the Purchase Order XML document,
then sends a 3A4 acceptance document back to its BusinessConnect server.
5. The BusinessConnect server on Machine 2 packages the acceptance document
and sends it to the initiator on Machine 1 via an HTTP post.
6. The BusinessConnect server on Machine 1 sends an acknowledgement receipt
back to Machine 2, and forwards the the response document to the initiator
private process.

Prerequisites
Before starting the tutorial, make sure that you have performed all the tasks listed
below on the two machines you will use:

Installed TIBCO BusinessConnect

Installed TIBCO BusinessConnect RosettaNet Protocol

Created deployment configuration for BusinessConnect and fully deployed


BusinessConnect. See TIBCO BusinessConnect Server Administration Guide for
instructions.

Obtained access to the following directory and all its subdirectories:


TIBCO_HOME/ B C / 5 . 2 / p r o t o c o l s / r n / s a m p l e s

Participant Information
See Table 41 for the participant information used in this tutorial.
Table 41 Participant Information
Initiator

Responder

Trading Partner Name

Company1

Company2

Private Process
Executable

ppinitiate.exe

ppresponse.exe

ppinitiate

(UNIX)

ppresponse

(UNIX)

TIBCO BusinessConnect RosettaNet Protocol Users Guide

110

| Chapter 9

Tutorial Standalone Private Processes

Setting Up Initiator on Machine 1


This section gives the instructions for setting up the BusinessConnect server on
Machine 1, which will act as the initiator in the transaction. The following is a
general sketch of the tasks:

Task A, Installing RosettaNet 3A4 PIP, page 110

Task B, Configuring Server Transport, page 110

Task C, Configuring Trading Host, page 111

Task D, Configuring Trading Partner, page 113

Task E, Configuring Business Agreement, page 116

Task A Installing RosettaNet 3A4 PIP


Follow the instructions below to install the RosettaNet PIP that will be used in the
transaction:
1. On Machine 1, log into TIBCO Administrator.
2. Click the BusinessConnect > Operations Editor link in the left panel.
3. Select RosettaNet from the Protocol drop-down list in the right panel.
4. Click Edit.
5. Click Import.
6. Click change....
7. Click Browse and navigate to the following directory:
TIBCO_HOME/bc/5.2/protocols/rn/samples/PIPS/3/A/3A4/1.4.

8. Select M a n a g e

Purchase Order.csx

and click Open.

9. Click OK.
10. Click Import.
11. Click Done.
Task B Configuring Server Transport
Follow the instructions below to configure the BusinessConnect server on
Machine 1:
1. Click the Application Management > BusinessConnect > Configuration link
in the left panel.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Initiator on Machine 1 111

2. Click the BusinessConnect link in the right panel.


3. On the Public Process Configuration tab, click the HTTP link.
4. Select the Enable HTTP Transport checkbox.
5. Keep HTTP Port as default (6 7 0 0 ).
6. Click Save twice.
7. Click Deploy.
8. Make sure that the Start successfully deployed services checkbox is selected.
9. Select the Force redeployment of all services checkbox.
10. Click OK.
BusinessConnect on Machine 1 is now deployed with HTTP transport and
started.
Task C Configuring Trading Host
You will set up the initiating party as a trading host, which consists of the
following steps:

Setting Up Trading Host Properties, page 111

Setting Up RosettaNet Protocol, page 112

Setting Up Trading Host Properties


Follow the steps below to set up the trading host properties:
1. Click the BusinessConnect > Participants link in the left panel.
2. Click the New button in the right panel.
3. Type C o m p a n y 1 in the Participant Name field.
4. Select Host in the Participant Type drop-down list.
5. Click OK.
6. Select the Active checkbox.
7. Click the Business Locations tab.
8. Click the Headquarters link.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

112

| Chapter 9

Tutorial Standalone Private Processes

9. Specify the following information:


Phone: 1 1 1 - 1 1 1 - 1 1 1 1
Fax: 1 1 1 - 1 1 1 - 1 1 1 1
Email: c o m p a n y 1 @ c o m p a n y 1 . c o m
10. Click the New button in the Contacts area.
11. Specify the following information:
First Name: J o e
Last Name: S m i t h
Contact Type: L e g a l
12. Click Save.
13. Select Joe Smith in the Primary Legal Contact drop-down list.
14. Click the New button in the Contacts area again.
15. Add another contact with the following information:
First Name: J a n e
Last Name: J o n e s
Contact Type: S u p p o r t
16. Click Save.
17. Select Jane Jones in the Primary Support Contact drop-down list.
18. Click Save.
Setting Up RosettaNet Protocol
Follow the steps below to set up the trading hosts Protocols tab:
1. Click the Protocols tab.
2. Click the RosettaNet link.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Initiator on Machine 1 113

3. Follow the steps below to configure the General tab.


a. Click the Add New link next to the Default Domain Identity field.
b. Click the Add New button.
c. Select DUNS from the Domain drop-down list.
d. Type 1 2 3 4 5 6 7 8 9 in the Identity field.
e. Click Save.
f.

Click OK.

g. Select DUNS-123456789 from the Default Domain Identity drop-down list.


h. Select Retailer in the Partner Classification Code drop-down list.
i.

Select Electronics Component in the Supply Chain Code drop-down list.

4. Click the Roles tab, then follow the steps below to configure this tab.
a. Click the Link Roles link.
b. Select the Buyer checkbox.
c. Click OK.
5. Click Save twice.
Checking Your Work
1. Click the BusinessConnect > System Settings link in the left panel.
2. Click the General Settings link in the right panel.
3. Confirm that Company1 is selected in the Default Host drop-down list.
4. Click Save.
Task D Configuring Trading Partner
Next, you will set up a trading partner configuraion on Machine 1 for the
responding party, which consists of the following steps:

Setting Up Trading Partner Properties, page 113

Setting Up RosettaNet Protocol, page 114

Setting Up Trading Partner Properties


Follow the steps below to set up the trading partner properties:
1. Click the BusinessConnect > Participants link in the left panel.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

114

| Chapter 9

Tutorial Standalone Private Processes

2. Click the New button in the right panel.


3. Type C o m p a n y 2 in the Participant Name field.
4. Select Partner in the Participant Type drop-down list.
5. Click OK.
6. Click the Active checkbox.
7. Click the Business Locations tab.
8. Click the Headquarters link.
9. Specify the following information:
Phone: 2 2 2 - 2 2 2 - 2 2 2 2
Fax: 2 2 2 - 2 2 2 - 2 2 2 2
Email: c o m p a n y 2 @ c o m p a n y 2 . c o m
10. Click the New button in the Contacts area.
11. Specify the following information:
First Name: J a c k
Last Name: S m i t h
Contact Type: L e g a l
12. Click Save.
13. Select Jack Smith in the Primary Legal Contact drop-down list.
14. Click the New button in the Contacts area again.
15. Add another contact with the following information:
First Name: J i l l
Last Name: J o n e s
Contact Type: S u p p o r t
16. Click Save.
17. Select Jill Jones in the Primary Support Contact drop-down list.
18. Click Save.
Setting Up RosettaNet Protocol
1. Click the Protocols tab.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Initiator on Machine 1 115

2. If RosettaNet does not appear in the list of protocols:


a. Click Enable.
b. Select the RosettaNet checkbox.
c. Click OK.
3. Click the RosettaNet link.
4. Follow the steps below to configure the General tab.
a. Click the Add New link next to the Default Domain Identity field.
b. Click the Add New button.
c. Select DUNS from the Domain drop-down list.
d. Type 9 8 7 6 5 4 3 2 1 in the Identity field.
e. Click Save.
f.

Click OK.

g. Select DUNS-987654321 from the Default Domain Identity drop-down list.


h. Select Manufacturer in the Partner Classification Code drop-down list.
i.

Select Electronic Component in the Supply Chain Code drop-down list.

5. Click the Roles tab, then follow the steps below to configure this tab.
a. Click the Link Roles link.
b. Select the Seller checkbox. To see the Seller checkbox, select 31-60 in the
Items drop-down list on the upper-right corner of the Role Name list.
c. Click OK.
6. Click the Transports tab, then follow the steps below to configure this tab.
a. Click Add.
b. Type H T T P in the Transport Name field.
c. Select HTTP from the Transport Type drop-down list.
d. Click OK.
e. In the URL field, type h o s t n a m e : 6 7 0 0 / R o s e t t a N e t , where h o s t n a m e is
the name of Machine 2, which will configure the responding party as its
trading host, and 6 7 0 0 is the HTTP port set in the deployment
configuration on Machine 2s BusinessConnect server (see Configuring
Server Transport on page 117).
7. Click Save three times to finish configuring this trading partner.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

116

| Chapter 9

Tutorial Standalone Private Processes

Task E Configuring Business Agreement


1. Click the BusinessConnect > Business Agreements link in the left panel.
2. Click the New button in the right panel.
3. Select Company1 in the Host Party area and Company2 in the Partner Party
area.
4. Click OK.
5. Click the Add Protocol Bindings button.
6. Select the RosettaNet checkbox.
7. Click OK.
8. Click the RosettaNet link.
9. On the Operation Bindings tab, select the Allow All Operations checkbox.
This allows the selected host and partner to initiate all RosettaNet PIPs
installed in the Operations Editor.
10. Click the Transports tab.
11. In the Outbound Transports for Host 'Company1' area, select HTTP from the
Primary (Production) Transport drop-down list.
12. In the Allowed Inbound Transports for Partner 'Company2' area, make sure
that the HTTP checkbox is selected.
13. Click Save twice to finish configuring this business agreement.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Responder on Machine 2 117

Setting Up Responder on Machine 2


This section gives the instructions for setting up the BusinessConnect server on
Machine 2, which will act as the responder in the transaction. The following is a
general sketch of the tasks:

Task A, Installing RosettaNet 3A4 PIP, page 117

Task B, Configuring Server Transport, page 117

Task C, Configuring Trading Host, page 118

Task D, Configuring Trading Partner, page 120

Task E, Configuring Business Agreement, page 123

Task A Installing RosettaNet 3A4 PIP


Follow the instructions below to install the RosettaNet PIP that will be used in the
transaction:
1. On Machine 2, log into TIBCO Administrator.
2. Click the BusinessConnect > Operations Editor link in the left panel.
3. Select RosettaNet from the Protocol drop-down list in the right panel.
4. Click Edit.
5. Click Import.
6. Click change....
7. Click Browse and navigate to the following directory:
TIBCO_HOME/bc/5.2/protocols/rn/samples/PIPS/3/A/3A4/1.4.

8. Select M a n a g e

Purchase Order.csx

and click Open.

9. Click OK.
10. Click Import.
11. Click Done.
Task B Configuring Server Transport
Follow the instructions below to configure the BusinessConnect server on
Machine 2:
1. Click the Application Management > BusinessConnect > Configuration link
in the left panel.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

118

| Chapter 9

Tutorial Standalone Private Processes

2. Click the BusinessConnect link in the right panel.


3. On the Public Process Configuration tab, click the HTTP link.
4. Select the Enable HTTP Transport checkbox.
5. Keep HTTP Port as default (6 7 0 0 ).
6. Click Save twice.
7. Click Deploy.
8. Make sure that the Start successfully deployed services checkbox is selected.
9. Select the Force redeployment of all services checkbox.
10. Click OK.
BusinessConnect on Machine 2 is now deployed with the HTTP transport and
started.
Task C Configuring Trading Host
You will set up the responding party as a trading host, which consists of the
following steps:

Setting Up Trading Host Properties, page 118

Setting Up RosettaNet Protocol, page 119

Setting Up Trading Host Properties


Follow the steps below to set up the trading host properties:
1. Click the BusinessConnect > Participants link in the left panel.
2. Click the New button in the right panel.
3. Type C o m p a n y 2 in the Participant Name field.
4. Select Host in the Participant Type drop-down list.
5. Click OK.
6. Select the Active checkbox.
7. Click the Business Locations tab.
8. Click the Headquarters link.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Responder on Machine 2 119

9. Specify the following information:


Phone: 2 2 2 - 2 2 2 - 2 2 2 2
Fax: 2 2 2 - 2 2 2 - 2 2 2 2
Email: c o m p a n y 2 @ c o m p a n y 2 . c o m
10. Click the New button in the Contacts area.
11. Specify the following information:
First Name: J a c k
Last Name: S m i t h
Contact Type: L e g a l
12. Click Save.
13. Select Jack Smith in the Primary Legal Contact drop-down list.
14. Click the New button in the Contacts area again.
15. Add another contact with the following information:
First Name: J i l l
Last Name: J o n e s
Contact Type: S u p p o r t
16. Click Save.
17. Select Jill Jones in the Primary Support Contact drop-down list.
18. Click Save.
Setting Up RosettaNet Protocol
Follow the steps below to set up the trading hosts Protocols tab:
1. Click the Protocols tab.
2. Click the RosettaNet link.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

120

| Chapter 9

Tutorial Standalone Private Processes

3. Follow the steps below to configure the General tab.


a. Click the Add New link next to the Default Domain Identity field.
b. Click the Add New button.
c. Select DUNS from the Domain drop-down list.
d. Type 9 8 7 6 5 4 3 2 1 in the Identity field.
e. Click Save.
f.

Click OK.

g. Select DUNS-987654321 from the Default Domain Identity drop-down list.


h. Select Manufacturer in the Partner Classification Code drop-down list.
i.

Select Electronics Component in the Supply Chain Code drop-down list.

4. Click the Roles tab, then follow the steps below to configure this tab.
a. Click the Link Roles link.
b. Select the Seller checkbox. To see the Seller checkbox, select 31-60 in the
Items drop-down list on the upper-right corner of the Role Name list.
c. Click OK.
5. Click Save twice.
Checking Your Work
1. Click the BusinessConnect > System Settings link in the left panel.
2. Click the General Settings link in the right panel.
3. Confirm that Company2 is selected in the Default Host drop-down list.
4. Click Save.
Task D Configuring Trading Partner
Next, you will set up a trading partner configuraion on Machine 2 for the
initiating party, which consists of the following steps:

Setting Up Trading Partner Properties, page 120

Setting Up RosettaNet Protocol, page 121

Setting Up Trading Partner Properties


Follow the steps below to set up the trading partner properties:

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Responder on Machine 2 121

1. Click the BusinessConnect > Participants link in the left panel.


2. Click the New button in the right panel.
3. Type C o m p a n y 1 in the Participant Name field.
4. Select Partner in the Participant Type drop-down list.
5. Click OK.
6. Click the Active checkbox.
7. Click the Business Locations tab.
8. Click the Headquarters link.
9. Specify the following information:
Phone: 1 1 1 - 1 1 1 - 1 1 1 1
Fax: 1 1 1 - 1 1 1 - 1 1 1 1
Email: c o m p a n y 1 @ c o m p a n y 1 . c o m
10. Click the New button in the Contacts area.
11. Specify the following information:
First Name: J o e
Last Name: S m i t h
Contact Type: L e g a l
12. Click Save.
13. Select Joe Smith in the Primary Legal Contact drop-down list.
14. Click the New button in the Contacts area again.
15. Add another contact with the following information:
First Name: J a n e
Last Name: J o n e s
Contact Type: S u p p o r t
16. Click Save.
17. Select Jane Jones in the Primary Support Contact drop-down list.
18. Click Save.
Setting Up RosettaNet Protocol
1. Click the Protocols tab.
TIBCO BusinessConnect RosettaNet Protocol Users Guide

122

| Chapter 9

Tutorial Standalone Private Processes

2. If RosettaNet does not appear in the list of protocols:


a. Click Enable.
b. Select the RosettaNet checkbox.
c. Click OK.
3. Click the RosettaNet link.
4. Follow the steps below to configure the General tab.
a. Click the Add New link next to the Default Domain Identity field.
b. Click the Add New button.
c. Select DUNS from the Domain drop-down list.
d. Type 1 2 3 4 5 6 7 8 9 in the Identity field.
e. Click Save.
f.

Click OK.

g. Select DUNS-123456789 from the Default Domain Identity drop-down list.


h. Select Retailer in the Partner Classification Code drop-down list.
i.

Select Electronic Component in the Supply Chain Code drop-down list.

5. Click the Roles tab, then follow the steps below to configure this tab.
a. Click the Link Roles link.
b. Select the Buyer checkbox.
c. Click OK.
6. Click the Transports tab, then follow the steps below to configure this tab.
a. Click Add.
b. Type H T T P in the Transport Name field.
c. Select HTTP from the Transport Type drop-down list.
d. Click OK.
e. In the URL field, type h o s t n a m e : 6 7 0 0 / R o s e t t a N e t , where h o s t n a m e is
the name of Machine 1, which configures the initiating party as its trading
host, and 6 7 0 0 is the HTTP port set in the deployment configuration on
Machine 1s BusinessConnect server (see Configuring Server Transport on
page 110).
7. Click Save three times to finish configuring this trading partner.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Setting Up Responder on Machine 2 123

Task E Configuring Business Agreement


1. Click the BusinessConnect > Business Agreements link in the left panel.
2. Click the New button in the right panel.
3. Select Company2 in the Host Party area and Company1 in the Partner Party
area.
4. Click OK.
5. Click the Add Protocol Bindings button.
6. Select the RosettaNet checkbox.
7. Click OK.
8. Click the RosettaNet link.
9. On the Operation Bindings tab, select the Allow All Operations checkbox.
This allows the selected host and partner to initiate all RosettaNet PIPs
installed in the Operations Editor.
10. Click the Transports tab.
11. In the Outbound Transports for Host 'Company2' area, select HTTP from the
Primary (Production) Transport drop-down list.
12. In the Allowed Inbound Transports for Partner 'Company1' area, make sure
that the HTTP checkbox is selected.
13. Click Save twice to finish configuring this business agreement.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

124

| Chapter 9

Tutorial Standalone Private Processes

Running the Tutorial Example


This section describes how to run the private processes to simulate RosettaNet
PIPs using the initiator and responder you configured in the previous sections.
Running the simulation consists of the following tasks:
1. Configuring Initiators Private Process, page 124
2. Configuring Responders Private Process, page 125
3. Running Simulated Private Processes, page 125
4. Viewing the Audit Log, page 125
The instructions described in this section apply to both Windows and UNIX
platforms, except that only the files used for Windows platforms
(p p i n i t i a t e . e x e and p p r e s p o n s e . e x e ) are mentioned. For UNIX platforms,
simply use the corresponding UNIX files in place of the Windows files
(p p i n i t i a t e and p p r e s p o n s e ) as you step through the instructions.

Configuring Initiators Private Process


You will use an executable called p p i n i t i a t e . e x e on Machine 1 to simulate a
standalone initiator private process. This program sends a sample PIP 3A4
message to BusinessConnect via Rendezvous Certified, then prints the response
in the command prompt.
You must edit the p p i n i t i a t e . t r a file to correspond to the settings in your
BusinessConnect installation. Follow the instructions below:
1. On Machine 1, open the p p i n i t i a t e . t r a file in
TIBCO_HOME/ b c / 5 . 2 / p r o t o c o l s / r n / s a m p l e s / s r c in a text editor.

2. Set the j a v a . p r o p e r t y . S e r v e r N a m e parameter to the installation name. To


find this name:
a. Click the BusinessConnect > System Settings link in TIBCO
Administrator.
b. Click the General Settings link in the right panel.
c. Set j a v a . p r o p e r t y . S e r v e r N a m e to the name displayed in the Installation
Name field.
3. Set the j a v a . p r o p e r t y . D e s t D U N S parameter to 9 8 7 6 5 4 3 2 1 .
4. Save the file.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Running the Tutorial Example 125

Configuring Responders Private Process


You will use an executable called p p r e s p o n s e . e x e or on Machine 2 to simulate a
standalone responder private process. This program does the following:

Waits for an inbound RosettaNet request from BusinessConnect.

Outputs the inbound request in the command prompt.

Sends the response to its BusinessConnect server via Rendezvous Certified.

You must edit the p p r e s p o n s e . t r a file to correspond to the settings in your


BusinessConnect installation. Follow the instructions below:
1. On Machine 2, open the p p r e s p o n s e . t r a file in
TIBCO_HOME/ b c / 5 . 2 / p r o t o c o l s / r n / s a m p l e s / s r c in a text editor.

2. Set the j a v a . p r o p e r t y . S e r v e r N a m e parameter to the installation name.


3. Save the file.

Running Simulated Private Processes


Follow the instructions below to run the tutorial:
1. On Machine 2 (responder side), click Application Management >
BusinessConnect > Service Instances in TIBCO Administrator. Verify that the
state of the BusinessConnect service instance is Running. If not, deploy and
start BusinessConnect.
If you are using BusinessConnect in the DMZ mode, verify that both the DMZ
instance and the BusinessConnect server instance are running.
2. Execute the p p r e s p o n s e . e x e in a command prompt on Machine 2.
3. On Machine 1, click Application Management > BusinessConnect > Service
Instances in TIBCO Administrator. Verify that the state of the service instance
is Running. If not, deploy and start BusinessConnect.
4. Execute p p i n i t i a t e . e x e in a command prompt on Machine 1.
5. Watch the command prompt outputs to see messages being exchanged
between the two machines.

Viewing the Audit Log


You can view logs of the interaction on both the initiator and the responder side.
Follow the instructions below to view the audit logs:
1. Click the BusinessConnect > Log Viewer link in TIBCO Administrator.
TIBCO BusinessConnect RosettaNet Protocol Users Guide

126

| Chapter 9

Tutorial Standalone Private Processes

2. Click the Audit Logs link in the right panel.


3. Select RosettaNet in the Protocol drop-down list.
4. Verify that bc-db is selected in the Connection drop-down list.
5. In the Previous drop-down list, keep the selected value One Day.
6. Click the Search button.
7. Click the Details icon
in the left-most column of the Search Results area to
view the details of the transaction.
8. Compare the audit log entries on the initiator side and the responder side with
Figure 1 on page 126 and Figure 2 on page 127. The figures contain transaction
detail examples for the initiator and the responder for a successfully
completed transaction.
Figure 1 Initiator Transaction Detail

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Running the Tutorial Example 127

Figure 2 Responder Transaction Detail

Understanding the Flow of Information


The information flow in the transaction is as follows:
1. On Machine 1, p p i n i t i a t e . e x e sends out a TIBCO Rendezvous message.
The message contains a Create Purchase Order XML document.
2. The BusinessConnect server on Machine 1 has been set up to listen for private
process messages. It looks up trading partner information based on the
message content and performs an HTTP post of the document to the
responders URL (on Machine 2).
3. On Machine 2, the BusinessConnect server receives the HTTP post, checks the
signature and validates header information and sends a receipt
acknowledgment back to the initiator (on Machine 1). The BusinessConnect

TIBCO BusinessConnect RosettaNet Protocol Users Guide

128

| Chapter 9

Tutorial Standalone Private Processes

server then sends out a TIBCO Rendezvous message containing the purchase
order document to the listening p p r e s p o n s e . e x e .
4. Upon receiving the purchase order, p p r e s p o n s e . e x e sends out the purchase
order confirmation as another TIBCO Rendezvous certified message.
5. The BusinessConnect server on the responder side receives the purchase order
acceptance, adds signature information, and sends the document to the
initiators URL (on Machine 1) as an HTTP post.
6. The BusinessConnect server on the initiator side validates the response
document and returns either a receipt acknowledgment or receipt
acknowledge exception to the responder.
7. The BusinessConnect server forwards the acceptance document to
ppinitiate.exe.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 129
Chapter 10

Tutorial TIBCO BusinessWorks Private


Processes

This chapter gives an overview of how to use TIBCO BusinessWorks with TIBCO
BusinessConnect RosettaNet Protocol.
The example in this chapter runs only on the Windows platform.

Topics

Overview, page 130

Using Example Project Files, page 131

Running the Tutorial, page 137

TIBCO BusinessConnect RosettaNet Protocol Users Guide

130

| Chapter 10

Tutorial TIBCO BusinessWorks Private Processes

Overview
The TIBCO BusinessConnect palette in TIBCO Designer enables business process
designers to integrate the processes in TIBCO BusinessWorks with
BusinessConnect. Configuring Private Processes with TIBCO BusinessWorks on
page 89 includes some instructions on how to set up the palette resources in
TIBCO Designer. For more information on each resource in the TIBCO
BusinessConnect palette, see TIBCO BusinessConnect Palette Reference.
This tutorial demonstrates the configuration of TIBCO BusinessWorks private
processes using the BusinessConnect palette in TIBCO Designer. Knowledge of
RosettaNet protocol, TIBCO BusinessWorks and TIBCO Designer is necessary to
run this tutorial.

Prerequisites
In order to use this tutorial, you must have done the following:

Installed TIBCO BusinessWorks before installing TIBCO BusinessConnect on


the two machines used in Chapter 9.

Completed the tutorial in Chapter 9, Tutorial Standalone Private Processes.


You will use the same setup on the two machines to run the tutorial in this
chapter.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Using Example Project Files 131

Using Example Project Files


The TIBCO BusinessWorks project files used in this tutorial can be found in the
TIBCO_HOME/ b c / 5 . 2 / p r o t o c o l s / r n / s a m p l e s / b w directory. This example
project demonstrates how to send and receive messages from TIBCO
BusinessConnect RosettaNet Protocol with TIBCO BusinessWorks private
processes.

Opening the Example Project


Follow the instructions below to set up the example project on the initiator and
the responder machines:
1. Start TIBCO Designer.
2. Click New empty project.
3. Specify a directory for this new project or click the
empty directory.

button to browse to an

4. Click OK.
5. Click the Project menu in the menu bar of TIBCO Designer window and select
Import Full Project....
6. Click the ZIP Archive tab in the Import Project dialog.
7. Click the

button and navigate to the following directory:

T I B C O _ H O M E / b c / 5 . 2 / p r o t o c o l s / r n / s a m p l e s / b w.

8. Select b w S a m p l e s . z i p and click Open.


9. Click OK.
10. In the Import - Options dialog, select the Try rename in case of name conflict
radio button.
11. Click Apply.
After the project finishes loading, you will see the main project view, as shown
in Figure 3.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

132

| Chapter 10

Tutorial TIBCO BusinessWorks Private Processes

Figure 3 TIBCO BusinessWorks Project

Setting Up Example Project


Follow the instructions below to set up the example project.
1. Click the Global Variables tab.
2. Click the

button.

3. Click the cell to the right of b c _ h o m e (in the Value column) and type
TIBCO_HOME/bc/5.2.
4. Click OK.
5. Click the Project tab to view the project panel.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Using Example Project Files 133

6. Click the root folder in the project panel. It is the name of the folder in which
you saved your new project (In Figure 3 above, the root folder is called
bwSamples).
7. In the design panel, click the BCServerConfig icon
. This is the
BusinessConnect Connection shared resource your project uses to connect to
your BusinessConnect server and the configuration store.
8. Click the BusinessConnect Server Access tab.
9. Specify JDBC Driver, JDBC URL, DB User, and DB Password.
JDBC settings here should be the same as the settings in your
BusinessConnect installation. To see the JDBC settings in your
BusinessConnect installation, log into TIBCO Administrator and go to
BusinessConnect > System Settings > JDBC Configuration; then select the
bc-db connection alias.
10. Click the Apply button.
11. Click the Configuration tab.
12. If the Update Transport Settings checkbox is not selected, select it.
13. Click the Update from Configuration Store button.
14. Select R o s e t t a N e t from the Protocol Name drop-down list.
15. Click the Import Selected Business Protocol button. You should now see all
installed RosettaNet operations in the BusinessConnect configuration store.
16. Click Apply.
17. Click the Save button

to save the project.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

134

| Chapter 10

Tutorial TIBCO BusinessWorks Private Processes

Initiator Process Definition


The initiator process definition PPInitiator can be accessed from the TIBCO
Designer project panel under the Initiator folder.

The activities in PPInitiator perform the following functions:


1. HTTP Receiver receives the data posted from I n i t i a t o r . h t m l .
2. Input Data parses the data returned by HTTP Receiver.
3. Prepare Payload determines the payload data file.
4. Parse 3A4 verifies that the payload is in the correct format.
5. 3A4 sends the I n i t i a t o r . R e q u e s t message to TIBCO BusinessConnect and
waits for the I n i t i a t o r . R e s p o n s e message from TIBCO BusinessConnect.
6. When I n i t i a t o r . R e s p o n s e is returned, Write 3A4 intiator.txt writes the
information contained in the message to the file i n i t i a t o r . t x t .
7. Wait for Response polls the file i n i t i a t o r . t x t . When the file is written by
3A4, Wait for Response transitions to Send HTTP Response.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Using Example Project Files 135

8. Send HTTP Response sends a reply to I n i t i a t o r . h t m l with the contents of


the I n i t i a t o r . R e s p o n s e message.

Responder Process Definitions


The responder process definitions can be accessed from the TIBCO Designer
project panel under the Responder folder. The following processes are available:

3A4 Responder

submitPPResponse

3A4 Responder

The activities in 3A4 Responder perform the following functions:


1. Receive 3A4 Request waits to receive the R e s p o n d e r . R e q u e s t message.
2. After Receive 3A4 Request receives the message, Report What I Have
Received writes the contents of R e s p o n d e r . R e q u e s t to r e s p o n s e . t x t .
3. Get 3A4 Response determines the contents of the response payload.
4. Parse 3A4 response verifies that the payload is in the correct format.
5. The Sleep activity models the processing delay that occurs in real-world
private processes.
6. Send 3A4 Response sends a response back to the initiator TIBCO
BusinessConnect.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

136

| Chapter 10

Tutorial TIBCO BusinessWorks Private Processes

submitPPResponse

The activities in submitPPResponse perform the following functions:


1. HTTP Receiver listens for the Wait Response post from R e s p o n d e r . h t m l .
2. Wait for Response polls the file r e s p o n s e . t x t .
3. When r e s p o n s e . t x t is written by the 3A4 Responder process in step 2 of 3A4
Responder on page 135, the process transitions to the Read File activity.
4. Read File reads the contents of the file.
5. Send HTTP Response returns a response to R e s p o n d e r . h t m l that contains the
information contained in the R e s p o n d e r . R e q u e s t message.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Running the Tutorial 137

Running the Tutorial


This section gives the instructions for running the TIBCO BusinessWorks
processes to complete a RosettaNet 3A4 PIP.

Running Responder on Machine 2


Follow the instructions below to start the responder processes on Machine 2:
1. In the opened TIBCO Designer project on Machine 2, select the Tester tab in
the project panel.
2. Click the

button.

3. Select the Responder > 3A4 Responder process definition.


4. Select the Responder > submitPPResponse process definition.
5. Click Load Selected.
6. Open R e s p o n d e r . h t m l in Internet Explorer. This file can be found in
yourProjectDirectory/ h t m l .
7. Click the Wait Response button in the Web page.

Running Initiator on Machine 1


You must start the responder processes on Machine 2 prior to proceeding with
this section. Follow the instructions below to start the initiator processes on
Machine 1:
1. In the opened TIBCO Designer project on Machine 1, click the Tester tab in the
project panel.
2. Click the

button.

3. Select the Initiator > PP Initiator process definition.


4. Click Load Selected.
5. Open I n i t i a t o r . h t m l in Internet Explorer. This file can be found in
yourProjectDirectory/ h t m l .
6. In the web page, click the Browse button next to the Payload field.
7. Browse to
TIBCO_HOME/bc/5.2/protocols/rn/samples/sampleDocs/3/A/3A4.

8. Select 3 A 4 P u r c h a s e O r d e r R e q u e s t _ 1 _ 4 . x m l and click Open.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

138

| Chapter 10

Tutorial TIBCO BusinessWorks Private Processes

9. Type 9 8 7 6 5 4 3 2 1 in the Destination DUNS Number field.


10. Type 1 2 3 4 5 6 7 8 9 in the My DUNS Number field. The page should look like
Figure 4.
Figure 4 Initiator.html

11. Click the Send Request button.

Expected Results
If everything works as expected, you will observe the following sequence of
events:
1. The tester on Machine 1 finishes sending a 3A4 PIP request to Machine 2 and
the Wait for Response turns yellow as it waits for a response from Machine 2.
2. The tester on Machine 2 is triggered and sends the request message to the
R e s p o n d e r . h t m l web page.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Running the Tutorial 139

3. The request message is displayed in R e s p o n d e r . h t m l , demonstrating that the


responder on Machine 2 has received the request.
4. The tester on Machine 2 prepares and sends a response back to Machine 1.
5. The tester on Machine 1 resumes and sends the response to the
I n i t i a t o r . h t m l web page.
6. The response message is diplayed in I n i t i a t o r . h t m l , demonstrating that the
initiator on Machine 1 has received the response. The audit logs on both
machines also display PIP-COMPLETED for the transaction state.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

140

| Chapter 10

Tutorial TIBCO BusinessWorks Private Processes

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 141
Appendix A

PIP States
s

A PIP goes through various states in its TIBCO BusinessConnect RosettaNet


Protocol life cycle. Each PIP state change is published in an A d v i s o r y I n f o
message (see Advisory Message Format on page 77). See Table 42 for description
of all possible states.
Table 42 PIP States
State

Description

INIT-TP-NOF

Sent notification of failure to trading partner.

PIP-CANCELLED

PIP cancelled by user.

PIP-COMPLETED

BusinessConnect successfully completed the transaction.

PKGD-PP-REQUEST

Packaged request document to private process.


Or, in the case of resending a PIP in the R E C E I V E D - T P - R E Q U E S T
state:
Packaged request document to private process - Resend.

PKGD-PP-RESPONSE

Packaged response document to private process.

PKGD-TP-EXCEPTION

Packaged general exception to trading partner.

PKGD-TP-RECEIPT

Packaged acknowledgement receipt back to trading partner.

PKGD-TP-REQUEST

Packaged request document to trading partner.

PKGD-TP-RESPONSE

Packaged response document to trading partner.

RESEND_RECEIVED-TPREQUEST

Resending request document to private process.

RECEIVED-HTTP/S-POST

Received HTTP or HTTPS post

RECEIVED-PP-REQUEST

Received request document from private process.

RECEIVED-PP-RESPONSE

Received response document from private process.

RECEIVED-TP-EXCEPTION

Received exception signal from trading partner.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

142

| Appendix A

PIP States

Table 42 PIP States (Contd)


State

Description

RECEIVED-TP-RECEIPT

Received acknowledgement receipt from trading partner.

RECEIVED-TP-REQUEST

Received request document from trading partner.

RECEIVED-TP-RESPONSE

Received response document from trading partner.

REQUEST-SCHEDULED

PIP request has been scheduled for transmission.

RESENT-PP-RESPONSE

Forwarded response document to private process.

RESENT-PP-REQUEST

Forwarded request document to private process.

OUT-OF-BAND-RESPONSECOMPLETED

Completed transaction without processing out-of-band response


document.

OUT-OF-BAND-RECEIPTCOMPLETED

Completed transaction without processing out-of-band


acknowledgement.

SENT-PP-REQUEST

Forwarded request document to private process.


Or, in the case of resending a PIP in the R E C E I V E D - T P - R E Q U E S T
state:
Forwarded request document to private process - Resend.

SENT-PP-RESPONSE

Forwarded response document to private process.

SENT-TP-EXCEPTION

Sent general exception to trading partner.

SENT-TP-RECEIPT

Sent acknowledgement receipt back to trading partner.

SENT-TP-REQUEST

Sent request document to trading partner.

SENT-TP-RESPONSE

Sent response document to trading partner.

If an error occurred in a transaction, TIBCO BusinessConnect RosettaNet Protocol


reaches one of the states listed in Table 43.
Table 43 Error States
State

Description

DOCUMENT-ERROR

Error in incoming service content.

FATAL-ERROR

Fatal error in incoming message.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

PIP States 143

Table 43 Error States


State

Description

HTTP-FAILURE

HTTP/S action or signal failed; retry is attempted.

HTTP-FAILURE-END

HTTP/S action or signal failed and retry count exceeded.

SMTP-FAILURE

Email sent action or signal failed.

MESSAGE-ERROR

Error in incoming service header.

INTERNAL-ERROR

Internal error occurred.

UNSUPPORTED-PIP

PIP not configured in Edit Operation Binding: RosettaNet panel.

NOT-CONFIGURED-PIP

PIP not configured in Operations Editors.

SERVICE-CONTENT-ERROR

Error in PIP service header.

NOT-MATCHED-TRANSACTION

Inbound or outbound response or receipt cannot be matched with


a transaction.

RECEIVED-BADHOST-IDENTITY

Host identity not found in configuration store.

PIP-TERMINATED

There was a problem with the transaction that prevented


BusinessConnect from successfully completing it.

TIMEOUT-PP-RESPONSE

Time out waiting for response document from private process.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

144

| Appendix A

PIP States

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 145
Appendix B

Property Reference

Table 44 lists the properties you can set in the BusinessConnect > System Settings
> Installed Protocols > RosettaNet panel in the TIBCO BusinessConnect console.
Table 44 Property Reference (Sheet 1 of 3)
Property

Description

bcrn.outbound.doc.inline.replacement

Enable data substitution of outbound PIP message


elements. See Data Substitutions in PIP Request and
Response on page 86 or more information.

bcrn.autogen.0A1

Automatically send PIP 0A1 Notification of Failure to


trading partner.

bcrn.support.malformed.
schemaLocationURI

Allow URI location in schemaLocation that is not


well-formed.

bcrn.outbound.request.dupdetection

If the outbound request document is a duplicate,


terminate the transaction. See Outbound Duplicate
Detection on page 10 for more information.

bcrn.inbound.dupdetection.sendTPEx
ception

When detecting a duplicate inbound message, do not


forward it to the private process and also send an
exception to the trading partner. See Inbound Duplicate
Detection on page 10 for more information.

bcrn.pp.advisory.info.messages

Publish A d v i s o r y I n f o messages for private processes.

bcrn.pp.advisory.error.messages

Publish E r r o r N o t i f y messages for private processes.

bcrn.audit.to.dir.messages

Audit messages in successful transactions to the file


system.

bcrn.audit.to.dir.unmatched

Audit messages that dont match a transaction to the file


system.

bcrn.audit.to.dir.error

Audit messages that contain errors to the file system.

bcrn.pipversion.include.patch

Include the patch number of the PIP version in the


outbound PIP documents service header.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

146

| Appendix B

Property Reference

Table 44 Property Reference (Sheet 2 of 3)


Property

Description

bcrn.pp.withNoDOCTYPE

Remove the XML DOCTYPE elements when sending


messages to the the private process.

bcrn.accept.outofband.response

Accept and process unsolicited (out-of-band) response


documents from the trading partner.

bcrn.complete.outofband.message

Accept and complete unsolicited (out-of-band) response


or receipt documents from the trading partner without
processing the response or receipt document. If selected,
the audit log displays the following S t a t u s and S t a t e
values for the automatically completed transaction:

Status

State

=
or
=

OUT-OF-BAND-RESPONSE-COMPLETED
OUT-OF-BAND-RECEIPT-COMPLETED

COMPLETED WITH ERRORS

Note When b c r n . a c c e p t . o u t o f b a n d . r e s p o n s e is
selected, b c r n . c o m p l e t e . o u t o f b a n d . m e s s a g e applies to
receipt documents only and not response documents.

bcrn.ignore.from.identity

Ignore the F r o m field in B C R e q u e s t F r o m P P messages from


private process.

bcrn.ignore.malformedfrom.identity

Use default host in configuration store if the identity in the


F r o m field of a B C R e u q u e s t F r o m P P message is not found in
configuration store.

bcrn.throttle.max.thread.count

Maximum number of concurrent threads for sending


messages to private process.

bcrn.throttle.message.threshold

Threshold of message size for sending messages to private


process (in bytes).

bcrn.0A1.sent.viaJMSTopic

If JMS transport is used, send PIP 0A1 to private process


via JMS topic. The JMS topic used is
prefix.installation. R E S P O N D E R . R E Q U E S T . T O P I C .
By default, BusinessConnect sends all action messages via
JMS queue when JMS transport is used, including the PIP
0A1 message. See the Private Processes section in TIBCO
BusinessConnect Concepts for more information.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Property Reference 147

Table 44 Property Reference (Sheet 3 of 3)


Property

Description

bcrn.pp.resolveFileRefToActualData

Resolve all file references to actual payload data when


sending messages to the private process. This applies to
both the DMZ server and TAW.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

148

| Appendix B

Property Reference

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 149
Appendix C

Configuration Store Metadata

Table 45 describes RosettaNet metadata in the configuration store. You can add,
delete, or edit entries for these metadata types.
Table 45 RosettaNet metadata
Metadata Type

BusinessConnect Console Location

Roles

Participants > Participant > Protocols >


RosettaNet > Roles
Operations Editor > RosettaNet > Activity >
General

Domains

Participants > Participant > Protocols >


RosettaNet > General

Partner Classification Codes

Participants > Participant > Protocols >


RosettaNet > General

Supply Chain Codes

Participants > Participant > Protocols >


RosettaNet > General

For information about how to edit this metadata, see the section on Metadata
Configuration in TIBCO BusinessConnect Trading Partner Administration Guide.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

150

| Appendix C

Configuration Store Metadata

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 151
Appendix D

Smart Routing

TIBCO BusinessConnect enables you to define business rules to route messages to


specific private processes. This feature is called smart routing, which requires
configuration of the BusinessConnect server through the BusinessConnect
console, as well as configuration of the BusinessConnect palette resources in
TIBCO Designer. In the BusinessConnect console, you can set up the business
rules and specify the smart ID to be assigned to messages that meet the conditions
of the rule. In the BusinessConnect palette resources, you can configure which
private processes will receive messages that include specific smart IDs.
Table 46 Smart Routing Fields for RosettaNet
Field

Description

Protocol

The business protocol for the message. Use the asterisk character (*) to match all
protocols.
This is a required field.

From

The DUNS ID for the trading partner that sends the original message. If Host
(your company) sends a request to Partner and Partner sends a response, you
may want to use smart routing for the response. In this case, the from field is
matched by Host because Host is the originator of the business transaction.
Use the asterisk character (*) to match all hosts and partners, but do not use the
asterisk character with a string. For example, do not use T I B * .
This is a required field.

To

The DUNS ID for the trading partner that receives the original message. If Partner
sends a request to Host (your company), you may want to use smart routing for
the request. In this case, the To field is matched by Host because Host is the
recipient of the request.
Use the asterisk character (*) to match all hosts and partners, but do not use the
asterisk character with a string. For example, do not use T I B * .
This is a required field.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

152

| Appendix D

Smart Routing

Table 46 Smart Routing Fields for RosettaNet


Field

Description

Direction

The business direction of the message: inbound or outbound. For example, if


Partner sends a request to Host (your company), both the business direction and
the message direction are inbound. However, if Host sends a request to Partner
and Partner sends a response, the message direction of the response is inbound,
but the business direction of the response is outbound because the original
message was outbound.
The asterisk character (*) matches both directions. This is a required field.

Operation ID

The location and identifier of the operation. This takes the form of a series of
nodes, for example: 3A4/1.4/Create Purchase Order.
Use one asterisk character (*) to match all operations directly under a specific
node. For example:
BC/*/*

matches B C / M y N o t i f y / T e s t but not B C / M y N o t i f y / T e s t / n o t i f y 1

Use two asterisk characters (**) to match operations recursively. Use double
asterisks alone or use them as the last node. For example:
BC/MyNotify/**

matches B C / M y N o t i f y / 1 . 3 / T e s t

B C / M y N o t i f y / * * / n o t i f y 1 is the same as B C / M y N o t i f y / * * . The software ignores


any nodes after a double asterisk.

You can use both a single asterisk and a double asterisk, for example:
BC/*/1.0/**

matches B C / T e s t - 0 1 / 1 . 0 / A / B

This is a required field.


CMName

The name of the listening CM (certified messaging) transport for the private
process. This is optional. If you provide the CM name for the listening CM
transport, BusinessConnect pre-registers the CM name, assuring creation of a
ledger and persistence of messages in the event that the listening transport is
down. If the CM name is not pre-registered, and BusinessConnect has not yet had
an opportunity to create a ledger, and the listening CM transport is down,
messages do not persist.
Note: Do not use the asterisk character (*) in this field.
Note: Verify the accuracy of the CM name before deploying the rule. If the CM
name you provide does not exist, the ledger will grow indefinitely.
For more information about CM listeners and CM names, see TIBCO Rendezvous
Concepts.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Smart Routing 153

Table 46 Smart Routing Fields for RosettaNet


Field

Description

Smart ID

An identifier that indicates which smart routing rules the message satisfied. Any
combination of alphanumeric characters is allowed, with a minimum of one
character and a recommended maximum of twenty-five characters.
This is a required field.

Protocol
Version

The version of RosettaNet, for example, RNIF 2.0. You can use the asterisk
character (*) to match all versions, but do not use the asterisk character with a
string. For example, do not use 4 . * . If you leave this field blank, it will only
match data if the field exists in the data and the field is blank (an empty string).
Use the asterisk to match all possible cases.

Location ID

This field supports backward compatibility with TIBCO BusinessConnect


RosettaNet Protocol 2.x releases. You can use the asterisk character (*) to match all
location IDs, but do not use the asterisk character with a string. For example, do
not use C A * . If you leave this field blank, it will only match data if the field exists
in the data and the field is blank (an empty string). Use the asterisk to match all
possible cases.

PP Tracking ID

The private process tracking ID. You can use the asterisk character (*) to match all
private process tracking IDs, but do not use the asterisk character with a string.
For example, do not use P P b u y e r * . If you leave this field blank, it will only
match data if the field exists in the data and the field is blank (an empty string).
Use the asterisk to match all possible cases.

TIBCO BusinessConnect RosettaNet Protocol Users Guide

154

| Appendix D

Smart Routing

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 155
Appendix E

Data Models

This appendix provides audit table and non-repudiation table diagrams as a


reference for users who want to generate custom scripts or graphics. It also
provides a sample audit table schema and information about how to export the
schemas for your audit, non-repudiation, or runtime tables.

Topics

Audit Table Diagram, page 156

Non-Repudiation Table Diagram, page 157

Table Schemas, page 158

TIBCO BusinessConnect RosettaNet Protocol Users Guide

156

| Appendix E

Data Models

Audit Table Diagram


Figure 5 shows the audit log tables and their relationships. These relationships
may change.
Figure 5 Audit Table Relationships

TIBCO BusinessConnect RosettaNet Protocol Users Guide

Non-Repudiation Table Diagram 157

Non-Repudiation Table Diagram


Figure 6 shows the non-repudiation log tables and their relationships. These
relationships may change.
Figure 6 Non-Repudiation Table Diagram

TIBCO BusinessConnect RosettaNet Protocol Users Guide

158

| Appendix E

Data Models

Table Schemas
This section provides an example audit table schema. You can view the schema
for your audit, non-repudiation, or runtime tables by exporting the JDBC
configuration:
1. In the TIBCO BusinessConnect console, click System Settings.
2. Click JDBC Configuration.
3. Click the appropriate export link.
Here is example code from an audit table schema:
audit.sql
IF EXISTS (SELECT * FROM dbo.sysobjects WHERE
id=object_id('GetNextAuditSeqNumber')) DROP PROCEDURE
GetNextAuditSeqNumber;
--:
IF EXISTS (SELECT * FROM dbo.sysobjects WHERE
id=object_id('BC_SEQ_GEN_AUDIT')) DROP TABLE BC_SEQ_GEN_AUDIT;
--:
..............

CREATE TABLE BC_TRANSACTIONS (


BC_TRANS_IDVARCHAR(512)
PARENT_IDVARCHAR(512)
USER_TRANS_ID
OPERATION_ID
TPNAME
TPDOMAIN
TPID
HOSTNAME
HOSTDOMAIN
HOSTID
PROTOCOL_VERSION
PROTOCOL_NAME
INSTALLATION_NAME
STATUS
HOST_INITIATES
USAGE_MODE
RESEND_USERNAME
AUX1
AUX2
AUX3
AUX4
AUX5
AUX6
AUX7
AUX8
AUX9

TIBCO BusinessConnect RosettaNet Protocol Users Guide

PRIMARY KEY,
NULL,
VARCHAR(512)
VARCHAR(512)
VARCHAR(128)
VARCHAR(32)
VARCHAR(32)
VARCHAR(128)
VARCHAR(32)
VARCHAR(32)
VARCHAR(32)
VARCHAR(32)
VARCHAR(32)
VARCHAR(64)
VARCHAR(5)
VARCHAR(16)
VARCHAR(128)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)
VARCHAR(512)

NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,

Table Schemas 159

STARTDATE
NOT NULL,
TS
NOT NULL
);
--:

DATETIME DEFAULT CURRENT_TIMESTAMP


DATETIME DEFAULT CURRENT_TIMESTAMP

TIBCO BusinessConnect RosettaNet Protocol Users Guide

160

| Appendix E

Data Models

TIBCO BusinessConnect RosettaNet Protocol Users Guide

| 161

Index

Numerics

0A1 (see Notification of Failure)

BCRequestFromPP 6
BCRequestFromPP format 64
BCRequestToPP 8
BCRequestToPP format 66
BCResponseFromPP 8
BCResponseFromPP format 70
BCResponseToPP 7
BCResponseToPP format 74
business agreement 6, 8, 45, 58
configuring transports 56
document security properties 54
operation bindings 47
overriding participant settings 60
protocol configuration 46
BusinessWorks private processes 89

A
accessing audit log 94
acRvMsg messages
BCRequestFromPP 6
BCRequestToPP 8
BCResponseFromPP 8
BCResponseToPP 7
ErrorNotify 7, 9
action and signal messages 26
action and signal messages, definition 26
Action tab 26
action-specific properties 23
adding a PIP activity 21
adding a PIP version 20
adding domain identities 35
adding PIP (see PIP)
adding PIP manually (see PIP)
advisory messages 77, 145
AdvisoryInfo format 77
applicable XML data for substitution 86
attachment directory 14
audit log
access 94
audit log (see logs)
audit logging to file 34, 145
automatic forward of response documents to private
processs 34, 42
automatic responses for duplicate requests 35

C
certificate 13
compression 3, 23, 50
configuration store metadata 149
configuring BCServerConfig resource 89
configuring BusinessConnect server 14
transport 14
configuring for data substitution 88
configuring private processes 62
converting DTD to XSD 29
creating XSD files 29
customer support xiii

D
data substitution 41, 86, 145
TIBCO BusinessConnect RosettaNet Protocol Users Guide

162

| Index
data types and data fields 63
digital signatures
digest algorithm 54
enabling 40
verifying certificates 55
digital signatures without non-repudiation
logging 104
document security 54
documents, related x
domain identities 35, 42
domain identity 13
DUNS ID 13
duplicate handling 10, 58, 101, 145
duplicate message handling 35

E
email 13, 14, 44, 57
encryption 50
algorithm 55
certificates 54
decrypting inbound message 55
error codes 84
error handling 7, 9
error messages 80, 145
ErrorNotify 7, 9
ErrorNotify format 80
exchanging information with trading partners 13
exporting PIPs, versions, and activities 28
extraInfo field 71

H
handling large payload size 15
host transport 14
HTTP 14
HTTPS 14, 26, 44, 57
HTTPSCA 14, 26, 44, 57
enforcing 40

I
importable PIP files 19
importing PIP (see PIP)
inbound response format 74
initiator inbound response 74
initiator outbound requests 64

J
JMS transport 146

K
key 13

L
F
features 3
file reference 147
file reference for large files (see large file handling)
forwarding response documents only when response
acknowledgements succeed 34, 42

TIBCO BusinessConnect RosettaNet Protocol Users Guide

large file handling 65, 68, 72, 75, 83


large payload 14
location ID 13
logging to the file system 102, 145
directory structure and filenames 102
unmatched messages 103

Index 163

logs
audit log 94, 95
message queue log 94, 99
non-repudiation log 94, 98
overview 94
resend log 94, 100
viewing 94

M
maintaining properties in the configuration store 149
malformed URI in schemaLocation 145
message formats private 62
message queue log (see logs)
metadata, configuration store 149
MIME 6, 8

Private Process sub-tab 50


RNIF 2.0 sub-tab 50
overriding operation settings 48
Transports tab 53
Operation Settings tab 48
operations editor 18
PIP action properties 23
PIP activity properties 21
out-of-band messages 146
override
action settings 52
default operation settings 48
inbound document validation 49
participant settings 60
roles and services 49
transports 53, 57

P
N
NOF (see Notification of Failure)
non-repudiation log 98
non-repudiation logging
configuring 26, 47
customizing 104
non-repudiation logs (see logs)
Notification of Failure 58, 145
enabling 41
via JMS topic 146
notify activity properties 21
notify and request-response activity properties 21
notify transactions 7, 8

O
operation bindings (see also business agreement) 47
Action Settings tab 52
editing 47
Operation Settings tab
General sub-tab 48

parsed and unparsed documents 83


parsed documents 83
participants
configuring hosts (see trading host configuration)
configuring partners (see trading partner configuration)
Partner Classification Code 13, 33, 40
partner interface process (see PIPs)
payload compression 23, 50
PIP
adding 18, 20
exporting 28
importing 18, 19
parsed 83
state matrix 141
timeout (see timeout settings)
unparsed 83
PIPs 2
managing 18
PIPs, importable 19
preparing to use TIBCO BusinessConnect RosettaNet
Protocol 11
private message formats 62

TIBCO BusinessConnect RosettaNet Protocol Users Guide

164

| Index
private messages 4, 63
advisory message format 77
AttachmentInfo object 81
error message format 80
inbound request format 66
inbound response format 74
outbound request format 64
outbound response format 70
Rendezvous format 63
request and response fields 83
RNAdvisoryInfo object 79
RNRequestFromPP object 66
RNRequestToPP object 68
RNResponseFromPP object 72
RNResponseToPP object 76
StatusInfo object 73
TPInfo object 81
private messages (see also acRvMsg messages) 6, 7, 8,
9
private processes 4, 6, 7, 8, 61
message formats (see private messages)
simulated 124
standalone 62
TIBCO BusinessWorks 62, 89
configuirng initiators 91
configuirng notification receivers 91
configuirng responders 91
Send and Receive activities 90
process flow
private processinitiated PIPs 6
trading partnerinitiated PIPs 7
process flows 6
public messages 5

responder inbound requests 66


responder outbound response 70
retransmitting messages 25, 26
RNAdvisoryInfo object 79
RNIF 2
versions supported 2
RNIF payload compression 23, 50
RNRequestToPP object 68
roles 13, 36
roles, linking 36, 43
RosettaNet
implementation framework 2
RosettaNet overview 2

S
scheduled transmissions 58
configuring 58
schemaLocation, malformed URI 145
schemas
converting 29
server URL 13
setting up the responder trading partner
properties 120
setting up trading partner properties 120
Signal tab 26
simulated private processes 124
state of PIP 141
status codes 84
substitution, data (see data substitution)
summary view 95
Supply Chain Code 13, 33, 40
support, contacting xiii

R
related documents x
Rendeavous message format 63
request-response activity properties 21
request-response transaction 7
request-response transactions 8
resend log (see logs)
resending transactions 100
TIBCO BusinessConnect RosettaNet Protocol Users Guide

T
technical support xiii
TIBCO BusinessConnect RosettaNet Protocol
overview 2
TIBCO XML Authority 29
timeout settings 23, 24, 25, 50, 52

Index 165

trading host configuration 31


General tab 33
Roles tab 36
Transports tab 44
trading partner configuration 37
basic configuration 38
General tab 40
Roles tab 43
transports 6, 8
configuring 44
in business agreement 56
override 53
overriding 57
tutorial
standalone private processes 107
TIBCO BusinessWorks private processes 129
typographical conventions xi

U
unmatched messages 103, 145
unparsed documents 83
URL, server (see server URL)

V
validation 6, 7, 8, 9, 33
override 49
overriding host settings 41
schema 24

TIBCO BusinessConnect RosettaNet Protocol Users Guide

166

| Index

TIBCO BusinessConnect RosettaNet Protocol Users Guide

S-ar putea să vă placă și