TIBCO BusinessConnect™
Palette ReferenceSoftware Release 5.3May 2009
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.
TIB, TIBCO, TIBCO Software, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO BusinessConnect, TIBCO Runtime Agent, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO Designer, TIBCO Rendezvous, and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.
EJB, J2EE, JMS and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 1999-2009 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
TIBCO BusinessConnect Palette Reference
| iii
Contents
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiiTIBCO BusinessConnect Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiiOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Chapter 1 BusinessConnect Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Using Schemas in BusinessConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
BCServerConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Provide Information for the TIBCO BusinessConnect Server Access Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Update the Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Configure the Rendezvous or the JMS Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Configure Private Processes for Smart Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Working with Nested Schemas. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Receive Misc. Msg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Receive Request/Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Receive Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Send Misc. Msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Send Request/Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
TIBCO BusinessConnect Palette Reference
iv | Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Send Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
TIBCO BusinessConnect Palette Reference
| v
Tables
Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
Table 1 TIBCO BusinessConnect Server Access Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Table 2 TIBCO BusinessConnect Connection Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Table 3 Connection Transport Fields: Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Table 4 Configure the JMS Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Table 5 Configure the Secure JMS Transport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Table 6 Receive Misc. Msg Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table 7 Receive Misc. Msg Misc Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 8 Receive Request/Notification Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 9 Receive Request/Notification Misc Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 10 Receive Response Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Table 11 Receive Response Misc Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 12 Send Misc. Msg Configuration Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Table 13 Send Request/Notification Configuration Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 14 Send Response Configuration Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
TIBCO BusinessConnect Palette Reference
vi | Tables
TIBCO BusinessConnect Palette Reference
| vii
Preface
TIBCO BusinessConnect™ software is a B2B (business-to-business) gateway that allows your company to engage in electronic commerce with your business partners.
Topics
• Related Documentation, page viii
• Typographical Conventions, page x
• How to Contact TIBCO Customer Support, page xii
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. Please see the readme.txt file for the availability of this software version on a specific operating system platform.
TIBCO BusinessConnect Palette Reference
viii | Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
TIBCO BusinessConnect DocumentationThe following documents form the BusinessConnect documentation set:
• TIBCO BusinessConnect Concepts: Read this guide to learn about TIBCO BusinessConnect architecture, deployment modes, protocols, and security.
• TIBCO BusinessConnect Server Administration Guide: Read this guide in order to administer (install, operate, and manage) the BusinessConnect server.
• TIBCO BusinessConnect Trading Partner Administration Guide: Read this guide to configure and manage trading partners.
• TIBCO BusinessConnect Palette Reference: Read this guide to learn about the resources available in the TIBCO BusinessConnect Palette for TIBCO BusinessWorks.
• TIBCO BusinessConnect EZComm Protocol User’s Guide: Read this guide to learn about using TIBCO BusinessConnect EZComm Protocol. This guide contains a detailed tutorial, which is a recommended reading for new TIBCO BusinessConnect users.
EZComm is installed with TIBCO BusinessConnect, therefore no separate installation guide for this protocol is provided.
• TIBCO BusinessConnect Scripting Deployment User’s Guide: Read this guide to configure and manage TIBCO BusinessConnect using the command line interface.
• TIBCO BusinessConnect Release Notes: Read this document to learn about new features, changes in functionality, deprecated features, known issues, and closed issues for each release.
This document is supplied for each release and is available only in PDF format.
Other TIBCO Product DocumentationYou may find it useful to read the documentation for the following TIBCO products, which may be used or integrated with BusinessConnect:
• TIBCO Administrator™ software: The software allows you to manage users, machines and applications defined in a TIBCO Administration Domain. The
TIBCO BusinessConnect Palette Reference
Preface | ix
TIBCO Administrator graphical user interface enables users to deploy, monitor, and start and stop TIBCO applications.
• TIBCO ActiveMatrix BusinessWorks™ software: This software is a scalable, extensible, and easy to use integration platform that allows you to develop integration projects. TIBCO BusinessWorks includes a graphical user interface (GUI) for defining business processes and an engine that executes the process.
• TIBCO Designer™ software: This graphical user interface is used for designing and creating integration project configurations and building an Enterprise Archive (EAR) for the project. The EAR can then be used by TIBCO Administrator for deploying and running the application.
• TIBCO Runtime Agent™ software: This software suite is a prerequisite for other TIBCO software products. In addition to TIBCO Runtime Agent components, the software suite includes the third-party libraries used by other TIBCO products such as TIBCO Designer, Java Runtime Environment (JRE), TIBCO Hawk®, and TIBCO Rendezvous®.
• TIBCO Rendezvous®: This software enables programs running on many different kinds of computers on a network to communicate seamlessly. It includes two main components: the Rendezvous programming language interface (API) in several languages, and the Rendezvous daemon.
• TIBCO Enterprise Message Service ™ software: This software provides a message service that enables integration of applications within an enterprise based on the Java Message Service (JMS) specifications.
TIBCO BusinessConnect Palette Reference
x | Typographical Conventions
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention Use
TIBCO_HOME
ENV_HOME
Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco.
Other TIBCO products are installed into an installation environment. Incompatible products and multiple instances of the same product are installed into different installation environments. The directory into which such products are installed is referenced in documentation as ENV_HOME. The value of ENV_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco.
code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:
Use MyCommand to start the foo process.
bold code
font Bold code font is used in the following ways:
• In procedures, to indicate what a user types. For example: Type admin.
• In large code samples, to indicate the parts of the sample that are of particular interest.
• In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts.
• To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName
TIBCO BusinessConnect Palette Reference
Preface | xi
Key combinations
Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.
Table 1 General Typographical Conventions (Cont’d)
Convention Use
TIBCO BusinessConnect Palette Reference
xii | How to Contact TIBCO Customer Support
How to Contact TIBCO Customer Support
For comments or problems with this manual or the software it addresses, please contact TIBCO Support Services as follows.
• For an overview of TIBCO Support Services, and information about getting started with TIBCO Product 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 Palette Reference
| 1
Chapter 1 BusinessConnect Palette
This chapter provides information about the TIBCO BusinessConnectTM palette and shared resources.
Topics
• Overview, page 2
• BCServerConfig, page 3
• Receive Misc. Msg, page 18
• Receive Request/Notification, page 23
• Receive Response, page 26
• Send Misc. Msg, page 29
• Send Request/Notification, page 30
• Send Response, page 32
TIBCO BusinessConnect Palette Reference
2 | Chapter 1 BusinessConnect Palette
Overview
This chapter provides information about the TIBCO BusinessConnectTM palette and shared resources.
Using Schemas in BusinessConnectFor more information about schema implementation in BusinessConnect, see TIBCO BusinessConnect Concepts, Schemas.
To Implement Custom Schemas
If you need to implement partner-specific behavior with regards to validation, you can disable validation on the receiving event source and implement a validation task after the message was received and forwarded by the event source.
You can later use the custom schema to complete validation based on the partner name or any other property of the received message.
To Manage Schemas
To learn how to reference a schema for use in BusinessConnect, see TIBCO BusinessConnect Trading Partner Administration Guide, File Specification Dialog.
To learn how to export schemas for use in another BusinessConnect installation, see TIBCO BusinessConnect Trading Partner Administration Guide, Export Schemas.
This book assumes familiarity with TIBCO Designer and palette resources. To learn the basics of working with resources within TIBCO Designer, refer to the TIBCO Designer User’s Guide and the TIBCO Designer Palette Reference.
Only schemas that are loaded in the operations editor will be loaded down by the TIBCO BusinessConnect palette.
The TIBCO BusinessConnect palette does not evaluate partner-level overrides.
TIBCO BusinessConnect Palette Reference
BCServerConfig | 3
BCServerConfig
The BCServerConfig resource contains the information needed to connect to a TIBCO BusinessConnect server. This shared resource is used when specifying activities in the BusinessConnect palette. When you import the TIBCO BusinessConnect configuration store, a folder named BCSchemas, containing imported schemas, will become available.
To configure the BCServerConfig resource, follow these steps:
• Provide Information for the TIBCO BusinessConnect Server Access Tab
This tab provides access to the fields that allow you to configure a connection to the database used for the configuration store.
• Update the Configuration Tab
This tab provides access to the TIBCO BusinessConnect configuration store and allows you to refresh the list of available protocols.
• Configure the Rendezvous or the JMS Tab
The type of transport is selected and configured using TIBCO Administrator, as explained in TIBCO BusinessConnect Trading Partner Administration Guide, Private Process Configuration. Using TIBCO Designer, you can override the settings using the provided GUI, but the type of transport cannot be changed.
Do not rename the folder BCShemas, which is hard-coded and shared.
This folder is accessed through a configured path and its name must be preserved.
TIBCO BusinessConnect Palette Reference
4 | Chapter 1 BusinessConnect Palette
Provide Information for the TIBCO BusinessConnect Server Access TabTo provide the database parameters, follow the instruction given in Table 1.
Table 1 TIBCO BusinessConnect Server Access Fields
Field Description
JDBC Driver Type
Type of the JDBC driver. In the dropdown menu, select one of the available JDBC driver types:
• Oracle Thin
• Oracle OCI. Oracle OCI Client Path must be manually set at the deployed .tra file.
• Microsoft SQL Server
• MySQL
• Weblogic MSSQL (deprecated). Users must use the Weblogic driver from the Weblogic Server 10 and above. To do so, copy wlbase.jar, wlutil.jar, wlclient.jar and wlsqlserver.jar file from the installation to TIBCO_HOME/tpcl/version/jdbc.
The old Weblogic driver is JDBC 2.0 compliant and does not support JDBC 3.0 calls made by TIBCO BusinessConnect.
• TIBCO Oracle (deprecated)
• TIBCO MSSQL (deprecated)
• TIBCO DB2 (deprecated)
Note The deprecated drivers are currently still supported, but they will be removed in future releases. You should start using the listed vendor-specific native drivers that are supported by their corresponding databases.
JDBC Driver Available drivers for the database.
JDBC URL The URL for the configuration store database for the selected JDBC driver.
DB User A valid user name for the database. This is optional.
DB Password The password associated with the user name
TIBCO BusinessConnect Palette Reference
BCServerConfig | 5
Oracle Client Library Path Usage
If you are planning to use the Oracle OCI drivers, you must specify the Oracle Client Library path. When dealing with the TIBCO BusinessConnect configuration UI, you must specify this path in the TIBCO Administrator .tra file. Depending on the platform where TIBCO Administrator is installed, different library paths may need to be appropriately updated.
To be consistent, you can define the following environmental variable as follows:
1. Set tibco.env.ORACLE_CLIENT_PATH=<Oracle Client native library path>
2. Prepend %ORACLE_CLIENT_PATH% to the variables PATH, LD_LIBRARY_PATH, SHLIB_PATH and LIBPATH.
The value should point to the Oracle native client libraries directory as follows:
• On Windows This is typically ORACLE_CLIENT_HOME/BIN directory, such as C:\oracle\product\10.2.0\client\BIN
• On UNIX This is typically the directory ORACLE_CLIENT_HOME/lib or ORACLE_CLIENT_HOME/lib32
Update the Configuration TabOnce all database parameters are provided, click the button Update from Configuration Store to connect to the Tibco BusinessConnect Configuration and to fetch the private process and protocol configuration. Follow the instruction in Table 2.
Table 2 TIBCO BusinessConnect Connection Configuration Fields
Field Description
Name Any unique string identifying this connection resource
Description This optional field allows you to provide a text description of the resource. This is for design-time use only.
Server The installation name of the TIBCO BusinessConnect server. This field is read-only and appears after successful connection to the database used by TIBCO BusinessConnect (the configuration store). It provides valid parameters for the database on the TIBCO BusinessConnect Server Access tab.
PP Transport The method of transport for the private process: TIBCO Rendezvous or JMS. This field is read-only. TIBCO BusinessConnect retrieves the information from the configuration store.
TIBCO BusinessConnect Palette Reference
6 | Chapter 1 BusinessConnect Palette
Update Transport Settings
Retrieve the transport settings from the configuration store and overwrite any custom transport settings specified on the Transport tab for this connection resource. Clear the checkbox to retrieve only protocol-specific settings.
Note: During initial configuration of a connection resource, this checkbox is selected and you cannot deselect it until you retrieve the transport settings the first time. After the first time, TIBCO BusinessConnect activates this field for editing.
Protocol Name The available protocols. This list is populated using information from the configuration store.
You can choose one protocol, for which the information has to be retrieved from the configuration store. If you need to communicate with multiple protocols, you need to have multiple shared resources, one for each protocol.
Select Operations
Available if the selected protocol includes one or more operations and allows to define which operations to import instead of importing all operations.
• If you select this checkbox, TIBCO BusinessConnect displays a dialog box with a list of operations for the protocol. Entries in blue have already been imported but will be updated if selected. Entries in black will be imported if selected. Select the checkbox next to each operation you want to import/update, then click OK.
• If you do not select all of the operations in blue, TIBCO BusinessConnect gives you the option to delete those schemas from the project.
• If you re-import a protocol and select all operations, TIBCO BusinessConnect gives you the option of identifying and deleting any obsolete schemas from the project.
• If you clear this checkbox, TIBCO BusinessConnect imports all operations for the selected protocol.
Note When you import a business protocol, you can elect to have BusinessConnect delete obsolete schemas. To do this, do not select operations for which you want the associated schema deleted. BusinessConnect asks if you want to delete unimported schemas.
If there are unused schemas on the server for a protocol that has already been imported, reimport the protocol and select all operations. Then select Yes, delete unimported schemas.
Note Click on the button Import Selected Business Protocol to import the list of selected operations.
Table 2 TIBCO BusinessConnect Connection Configuration Fields
Field Description
TIBCO BusinessConnect Palette Reference
BCServerConfig | 7
Configure the Rendezvous or the JMS TabWhen you are configuring Private Processes for TIBCO BusinessConnect, you will get a different palette depending on the transport that was selected for communication with these processes.
One of these two tabs will be available, depending on the transport that was configured for a specific project:
• Rendezvous Tab
• JMS Tab
Imported Operations (read only)
Displays a list of operations that have been imported from the configuration store.
Use Smart ID Provide an identifier for the private process instance. Event sources that reference a shared resource can inherit the smart ID if you enable Smart Routing for the event source. You can also override an inherited smart ID by providing a different smart ID in the event source.
Use of Smart Routing requires that you define business rules in the TIBCO BusinessConnect console.
See Configure Private Processes for Smart Routing for detailed information.
If the checkbox Use Smart ID is selected, an additional row Smart ID appears on the screen to enter the Smart ID name.
Smart ID • Shared Smart ID
Select this checkbox to inherit the Smart ID from the shared resource directly into this event source. In this case, the event source will use the same Smart ID as the shared resource.
• Smart Routing ID
Type the desired Smart ID into this field in order to have a different Smart ID on the event source level . The messages will be routed to this private process event source.
Table 2 TIBCO BusinessConnect Connection Configuration Fields
Field Description
TIBCO BusinessConnect Palette Reference
8 | Chapter 1 BusinessConnect Palette
Rendezvous Tab
This tab provides access to the fields that allow you to configure TIBCO BusinessConnect for use with TIBCO Rendezvous. Table 3 provides brief descriptions of the fields on the TIBCO Rendezvous tab. For detailed information, refer to the TIBCO Rendezvous documentation.
Table 3 Connection Transport Fields: Rendezvous
Field Description
Installation Name
The name of the TIBCO BusinessConnect installation
Subject Prefix The subject prefix from the TIBCO BusinessConnect installation
Service Either the name of the Rendezvous service or its port number. If left blank, TIBCO Rendezvous uses the Rendezvous service, if it exists; otherwise it uses port 7500.
Network The network to be used by the Rendezvous daemon
Daemon The client socket used for the Rendezvous daemon
Quality of Service
Specifies the quality of service for messages transmitted to the TIBCO BusinessConnect server. This quality of service corresponds to TIBCO Rendezvous protocols. The available options are:
• Reliable
• Certified
• Distributed Queue
The remaining fields vary based on the quality of service you select. If you selected Reliable, you are done.
Server to PP CM Auto Confirm
If this checkbox is selected, it configures the certified listener transport to automatically confirm delivery of messages from the TIBCO BusinessConnect server to the private process. Otherwise, the private process is responsible for confirming delivery. You will need to create a Confirm task and specify which event to confirm. See TIBCO Designer User’s Guide for more information.
Note If this option is enabled and any listener using this BCServerConfig is loaded, messages are confirmed even though there is no active listener loaded in the palette for this message (messages are not dispatched successfully to any listener). To avoid this behavior, disable the option Auto Confirm and use the explicit confirmation: in such case, TIBCO Rendezvous messages will be confirmed only if the Confirm task is executed for the event.
TIBCO BusinessConnect Palette Reference
BCServerConfig | 9
Local CM Name The name of the local certified messaging transport.
Preregistered BC Queue Name
A comma-separated list of certified messaging sessions to register at TIBCO BusinessWorks.
Use Process Based Ledger
If this checkbox is selected, a process-based ledger is used for interaction between TIBCO BusinessWorks and the TIBCO BusinessConnect server.
File Based Ledger
TIBCO Rendezvous certified ledger file name for interaction between TIBCO BusinessWorks and the TIBCO BusinessConnect server.
If Use Process Based Ledger checkbox is selected, this option is not available.
QOS (Quality of Service) Properties specific for TIBCO Rendezvous
Local Distributed Queue
The name of the distributed queue. This name must be different from the name specified in the CM Name field (otherwise there is a name collision exception at runtime).
Queue Settings Specify the properties of the distributed queue.
Checking this field causes the Worker Weight, Worker Tasks, Scheduler Weight, Scheduler Heartbeat, and Scheduler Activation fields to appear.
Worker Weight The weight to assign to this worker member of the distributed queue. See the TIBCO Rendezvous documentation for more information about assigning worker weight.
Worker Tasks The maximum number of tasks this worker can accept. When the number of accepted tasks reaches this maximum, the worker cannot accept additional tasks until it completes one or more of them. See the TIBCO Rendezvous documentation for more information about setting the number of tasks.
Scheduler Weight
Weight represents the ability of this member to fulfill the role of scheduler, relative to other members with the same name. See the TIBCO Rendezvous documentation for more information about setting the scheduler weight.
Scheduler Heartbeat (seconds)
The scheduler sends heartbeat messages at this interval (in seconds). All members with the same distributed queue name must specify the same value for this parameter. See the TIBCO Rendezvous documentation for more information about setting the scheduler heartbeat.
Table 3 Connection Transport Fields: Rendezvous
Field Description
TIBCO BusinessConnect Palette Reference
10 | Chapter 1 BusinessConnect Palette
JMS Tab
The JMS tab provides access to the fields that allow you to configure TIBCO BusinessConnect for use with JMS.
Settings for configuring JMS are imported from the configuration store and are user modifiable.
Scheduler Activation (seconds)
When the heartbeat signal from the scheduler has been silent for this interval (in seconds), the member with the greatest scheduler weight takes its place as the new scheduler. See the TIBCO Rendezvous documentation for more information about setting the scheduler activation.
Worker Complete Time
The complete time property influences scheduler behavior.
If the complete time is non-zero, the scheduler waits for a worker member to complete an assigned task. If the complete time elapses before the scheduler receives completion from the worker member, the scheduler reassigns the task to another worker member.
Zero is a special value, which specifies no limit on the completion time—that is, the scheduler does not set a timer, and does not reassign tasks when task completion is lacking. All members implicitly begin with a default complete time value of zero.
The complete time must be non-negative.
Table 3 Connection Transport Fields: Rendezvous
Field Description
Table 4 Configure the JMS Transport
Field Explanation
Installation Name
The name of the TIBCO BusinessConnect installation.
Example: BC-user_name-BC_domain
Installation Prefix Prefix that defines an installation
JMS User Name User name to use when logging into the JMS server.
If the JMS provider does not require access control, this field can be empty.
Not all JMS servers require user names and passwords. Refer to your JMS provider documentation and consult your system administrator to determine if your JMS server requires a user name and password.
TIBCO BusinessConnect Palette Reference
BCServerConfig | 11
JMS Password Password to use when logging into the JMS server
If the JMS provider does not require access control, this field can be empty.
JNDI Context Factory
The initial context factory class for accessing JNDI. See TIBCO BusinessConnect Trading Partner Administration Guide, Table 21, JMS.
JNDI Context URL
This is the URL to the JNDI service provider. See TIBCO BusinessConnect Trading Partner Administration Guide, Table 21, JMS.
JNDI User Name If the deployed JMS/JNDI provider(s) requires no authentication with the client, the JMS/JNDI User Name field may be left blank.
JNDI Password If the deployed JMS/JNDI provider(s) requires no authentication with the client, the JMS/JNDIPassword field may be left blank.
Topic Connection Factory
The TopicConnectionFactory object stored in JNDI. See TIBCO BusinessConnect Trading Partner Administration Guide, Table 21, JMS.
Queue Connection Factory
The QueueConnectionFactory object stored in JNDI. See TIBCO BusinessConnect Trading Partner Administration Guide, Table 21, JMS.
Auto Confirm Specifies whether inbound JMS messages will be confirmed to the provider automatically (after successfully dispatching them to at least one of the subscribing event sources), or the process definition will need to explicitly take care of that by placing a Confirm activity in the process definition and confirming the corresponding event.
Once this checkbox is selected, inbound messages are automatically confirmed, which means that inbound JMS messages dispatched to BusinessWorks will be acknowledged so that the JMS provider can remove them accordingly.
Otherwise, messages may be left in the JMS provider's persistent store. TIBCO BusinessConnect business protocols may specify JMS topic transports and expect non-durable receivers on some miscellaneous messages (specified by the AE schemas of these messages) that can be lost without causing problems. This can help to reduce the load on JMS providers.
Regarding message types that are set on topics and will not need confirmation, consult the corresponding business protocol’s User’s Guide.
Table 4 Configure the JMS Transport
Field Explanation
TIBCO BusinessConnect Palette Reference
12 | Chapter 1 BusinessConnect Palette
Upon a successful connection, a dialog box reports the status and the name/version of the provider with whom the connection has been established. Upon failure, the cause is indicated if available.
Secure JMS
When you click on the Import Selected Business Protocol button and the TIBCO BusinessConnect Palette imports the configuration from the TIBCO BusinessConnect configuration store, the credentials for the JMS server and client identity will be fetched and stored in the project at a specific location.
Auto Create Destination
Managing administered objects, such as JMS topics and queues on the preferred JMS provider, is generally the responsibility of the JMS provider’s administrator.
If privileges allow it, the palette can create the required queues and topics automatically and dynamically. (See the checkbox Auto create destinations on the JMS configuration panel on the shared resource.) If checked, the starting JMS transport will attempt to create the needed destinations (queues and/or topics) in the specified transport modes. If unsuccessful, an exception will be raised and either the privileges need to be adjusted or the administered objects need to be created manually.
Regarding the requirements of the destinations, the user's guides of the specific protocols can provide more guidance.
Reconnect Max Duration (mins)
Timeout configuration property in minutes both for the TIBCO BusinessConnect server and the TIBCO BusinessConnect palette .
Secured If selected, the secure JMS transport will be used.
Secure JMS can only be selected if the TIBCO Enterprise Message Service specific JNDI Context Factory has been specified. If the context factory field is empty or it specifies a different provider's factory, a dialog box appears when selecting the box and gives an error. If the secured transport was already selected and the factory field receives an inconsistent value, then clicking the “Apply” button will result in the same error.
When the dialog box is accepted, the Secured checkbox moves back to the unselected state and the secure JMS transport remains (or becomes) disabled.
Test JMS Connection
Click the Test JMS Connection button to test whether a proper connection is established.
Table 4 Configure the JMS Transport
Field Explanation
TIBCO BusinessConnect Palette Reference
BCServerConfig | 13
The retrieved configuration properties can always be overridden on the TIBCO BusinessConnect Palette level using new values. That includes turning on or off the secure transport, as well as reconfiguring or changing the credentials that were configured for the TIBCO BusinessConnect server transport.
If the TIBCO Enterprise Message Service server requires a secure transport, then disabling this transport — although possible in the palette — will result in a connection failure when the project is building up the JMS transport at runtime.
First time when you import a configuration from the TIBCO BusinessConnect configuration store with the secure JMS transport enabled, a new folder structure will be created and you need to configure the secure JMS transport as follows:
1. A New Folder Named BCCredentials is Created
TIBCO BusinessConnect palette creates a new folder named BCCredentials, which contains a subfolder called TrustedCerts. This subfolder is used for storing the leaf and CA X509 certificates of the JMS server in PEM format).
Once this folder structure exists, further configuration imports will either update the existing credential objects or add new ones if their names are different:
• If a new certificate has a different issuer and a different serial number from the existing certificate, only the existing certificate will be updated.
• If the certificate name is different, the certificate will not be imported from the configuration store.
2. Configure the Secure JMS Transport
To configure the secure JMS transport, do the following:
1. Select or enter data as explained in Table 4, Configure the JMS Transport.
2. Continue with entering the fields listed in Table 5.
Table 5 Configure the Secure JMS Transport
Field Description
Verify JMS Server If selected, the JMS server's identity (its X509 certificate as well as the specified value in the “Expected JMS Server Host Name” field) will be verified against the data received during the SSL handshake. If either the trusted CA certificates or the expected host name do not match, the transport creation fails.
If this verification is not required, TIBCO BusinessConnect can establish a JMS connection with any TIBCO Enterprise Message Service server whose credentials are different from the configured properties.
TIBCO BusinessConnect Palette Reference
14 | Chapter 1 BusinessConnect Palette
JMS Auto Reconnect for the TIBCO BusinessConnect Palette
When JMS is used for private process communication in BusinessConnect, both BusinessConnect and BusinessConnect palette for BusinessWorks make connection to the configured JMS server during startup. If the connection to the JMS server could not be established during startup, such as when there is a network failure or the JMS server is down, BusinessConnect will terminate with a warning message. Also, if the connection to the JMS server is established during startup but terminated during runtime, both BusinessConnect and the BusinessConnect palette will not reestablish the connection. Therefore, after correcting the JMS problem, both BusinessConnect and BusinessConnect palette need to be restarted.
Using JMS auto reconnect, which is enabled by default, both the BusinessConnect server and the BusinessConnect palette will try to establish connection with the JMS server when the connection is down without restarting.
On the BusinessConnect palette, this will happen as follows:
Trusted JMS Server Certificates
Reference the trusted folder
Users can create arbitrary new folders for referencing the trusted certificates location. These objects will have to be created and maintained manually. If the credentials are supposed to be identical on both the TIBCO BusinessConnect server and the TIBCO BusinessConnect palette-based private process, no changes in the configuration are needed after the import of the configuration on the palette.
Strong Ciphers Only
See the corresponding field in TIBCO BusinessConnect Trading Partner Administration Guide, Table 21, JMS.
Use Trace See comments in TIBCO ActiveMatrix BusinessWorks Palette Reference, Chapter 9, JMS Palette, section Advanced.
Use Debug See comments in TIBCO ActiveMatrix BusinessWorks Palette Reference, Chapter 9: JMS Palette section Advanced.
Expected JMS Server Host name
This is the value of the common name component of the TIBCO Enterprise Message Service server's leaf certificate. It is usually the hostname of the resource that is running the TIBCO Enterprise Message Service server. If it is a test system, the common name (CN) value may be any arbitrary string, which must match the value of this field if the “Verify JMS Server” checkbox is selected.
Table 5 Configure the Secure JMS Transport
Field Description
TIBCO BusinessConnect Palette Reference
BCServerConfig | 15
• If the JMS server is down or the network connection is down when the palette starts up, the palette will try to establish connection with the JMS server. When the connection is established, the palette will send to and receive messages from BusinessConnect. The duration of the initial attempts to establish a valid JMS connection is infinite.
• If the connection between palette and the JMS server is terminated during runtime, the palette will try to establish connection with the JMS server. If the connection is not established within the specified period of time, the palette activity will time out and eventsources will no longer be able to receive messages even if the JMS provider comes back up after the timeout.
Configure Private Processes for Smart RoutingIf you have created business rules for Smart Routing through the TIBCO BusinessConnect application within TIBCO Administrator, you can route messages that include specific smart IDs to specific private processes.
Smart Routing for private processes can be configured at two levels:
• Shared resource level
• Event source level
Configure Private Process at the Shared Resource Level
To configure a private process for Smart Routing at a shared resource level, perform these steps:
1. Open your TIBCO BusinessConnect project in TIBCO Designer.
2. Navigate to the shared resource you want to configure, such as Initiator, and select it.
3. To enable or disable Smart Routing, select or clear the Use Smart ID checkbox.
Once this checkbox is selected, a new field SmartID appears.
Figure 1 Configure Smart Routing at the Shared Resource Level
4. Type the Smart ID into the field for the messages that you want to be routed to this private process shared resource.
TIBCO BusinessConnect Palette Reference
16 | Chapter 1 BusinessConnect Palette
Configure Private Process at the Event Source Level
1. Open your TIBCO BusinessConnect project in TIBCO Designer.
2. Navigate to the event source you want to configure, such as Receive Misc Msg, Receive Request Notification, or Receive Response, and select it.
3. To enable or disable Smart Routing, select or clear the Use Smart ID checkbox.
4. Once this checkbox is selected, two new fields appear:
— Shared Smart ID
— Smart Routing ID
Figure 2 Configure Smart Routing at the Event Source Level
5. Configure the fields as follows:
— Shared Smart ID If a user wants to inherit the Smart ID from the shared resource directly into this event source, then just enable this check box. In this case the event source would use the same Smart ID as the shared resource.
— Smart Routing ID If a user wants to have a different Smart ID at the event source level, type the desired Smart ID for the messages that you want to be routed to this private process event source.
6. Click Apply.
Subjects on Which Messages are Published
For any other private process implementations and/or message types subject to Smart Routing, the subject on which the message is published from BusinessConnect to the private process will always use the following format:
If the private process implementation uses the BusinessConnect Palette then INITIATOR.RESPONSE messages that are responses to synchronous (blocking) requests from the BusinessConnect Palette are not published on a Smart ID subject. This will happen if the checkbox Don’t Wait for Response is cleared (see Don’t Wait for Response).
In this case, the BusinessConnect Palette will automatically associate the reply with the response internally and forward it to the relevant event source.
TIBCO BusinessConnect Palette Reference
BCServerConfig | 17
For RV
AX.BC.installation_name.smart_routing_id.standardID.RESPONDER.REQUEST
AX.BC.BC-SERVER.SMARTID1.RosettaNet.RESPONDER.REQUEST.
For JMS
AX.BC.installation_name.RESPONDER.REQUEST
AX.BC.BC-SERVER.RESPONDER.REQUEST.
Working with Nested SchemasAfter importing operations into the TIBCO BusinessConnect palette from the configuration store, there are two cases when users of nested schemas may experience closure conflicts :
• Different operations of the same protocol using the same or overlapping nested schemas, or
• Different operations of different protocols using the same or overlapping nested schemas
In both cases, you should manually delete any closure on either of the operations from the project until TIBCO Designer reports no further closure conflicts. This applies to the file named rootElement_closureX in the folder BCSchemas/protocol/Operation/../
This task is simple in most cases, when schemas have a relatively small number of nested schemas.
TIBCO BusinessConnect Palette Reference
18 | Chapter 1 BusinessConnect Palette
Receive Misc. Msg
Any message that is not an inbound or outbound request or response is a miscellaneous message. Use the Receive Misc Msg process starter to start a process when a miscellaneous message is received from TIBCO BusinessConnect.
Not all business protocols support miscellaneous messages. This process starter requires a BCServerConfig shared configuration resource that is configured for a specific protocol. If there are no miscellaneous messages for the specified protocol, the Receive Misc Msg process starter cannot be used for that protocol.
Configuration
Table 6 Receive Misc. Msg Configuration Fields
Field Description
Name The name to appear as the label for the activity.
Description Short description of the activity.
Server Details The BCServerConfig shared configuration resource used to connect to the TIBCO BusinessConnect server. See BCServerConfig for more information.
Use Smart Routing
Provide an identifier for the private process instance. Event sources that reference a shared resource can inherit the smart ID if you enable Smart Routing for the event source. You can also override an inherited smart ID by providing a different smart ID in the event source.
Shared Smart ID Select this checkbox to inherit the Smart ID from the shared resource directly into this event source. In this case, the event source will use the same Smart ID as the shared resource.
Smart Routing ID Type the desired Smart ID into this field in order to have a different Smart ID on the event source level . The messages will be routed to this private process event source.
TIBCO BusinessConnect Palette Reference
Receive Misc. Msg | 19
Message Name This field contains a dropdown list of the available miscellaneous messages for BCServerConfig selected for the Server Details field above. Select one of the available miscellaneous messages from the drop down list.
Some miscellaneous messages are related to message disposition notifications.
A message disposition notification (MDN) receipt is a transport level acknowledgement.
Some of the protocols, such as EZComm and EDI, don’t suppress these messages, and some of them do (SOAP, RosettaNet, cXML). Consult documentation for a specific business protocol for more information.
These messages can occur when the AS1, AS2 or Email transports are used and receipts (MDNs) are utilized.
An MDNAlert message is sent to the Private Process in the case when a receipt was requested with an outbound message that was sent to a trading partner, and TIBCO BusinessConnect successfully received and verified the receipt returned by the trading partner.
In this scenario, notification to the Private Process is sent on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.INFO.RECEIPT.RECEIVED
JMS subject
prefix.installation_name.INFO.RECEIPT.RECEIVED
An MDNAlertError message is sent to the Private Process in the case when a receipt was requested with an outbound message that was sent to a trading partner, and the trading partner returned a receipt which indicated that the trading partner encountered an error in the outbound message it received.
In this scenario, notification to the Private Process is sent on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.ERROR.RECEIPT.RECEIVED
JMS subject
prefix.installation_name.ERROR.RECEIPT.RECEIVED
Table 6 Receive Misc. Msg Configuration Fields
Field Description
TIBCO BusinessConnect Palette Reference
20 | Chapter 1 BusinessConnect Palette
An MDNResponseAlert message is sent to the private process in the case when all three listed conditions are met:
• BusinessConnect received a receipt request for an inbound document.
• BusinessConnect could successfully unpackage the inbound document for which a receipt was requested; for example, the signature of the inbound document could be verified if the document was signed.
• BusinessConnect returned a receipt to the trading partner indicating the inbound document was received and unpackaged successfully.
In this scenario, notification to the private process is sent on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.INFO.RECEIPT.SENT
JMS subject
prefix.installation_name.INFO.RECEIPT.SENT
An MDNErrorResponseAlert message is sent to the private process in the following case:
• BusinessConnect receives a receipt request for an inbound document, but
• BusinessConnect could not successfully verify the signature for the document, and it returned a receipt to the trading partner indicating the inbound document was received but the signature could not be successfully verified
In this scenario, notification to the private process is sent on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.ERROR.RECEIPT.SENT
JMS subject
prefix.installation_name.ERROR.RECEIPT.SENT
Table 6 Receive Misc. Msg Configuration Fields
Field Description
TIBCO BusinessConnect Palette Reference
Receive Misc. Msg | 21
An MDNTimeout message is sent to the Private Process in the case when a receipt was requested for an outbound document, but the trading partner did not return a receipt within the receipt timeout period.
In this scenario, notification to the Private Process is sent on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.ERROR.TIMEOUT.RECEIPT
JMS subject
prefix.installation_name.ERROR.TIMEOUT.RECEIPT
An ErrorNotify message is sent to the Private Process whenever BusinessConnect encounters an error during the processing of an inbound or outbound message.
When an error occurs, notification to the private process is sent on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.ERROR
JMS subject
prefix.installation_name.ERROR
Table 6 Receive Misc. Msg Configuration Fields
Field Description
TIBCO BusinessConnect Palette Reference
22 | Chapter 1 BusinessConnect Palette
Misc
OutputThe output tab lists output schema information. The schema that displays is based on the input of the message selected in the Configuration tab for this process starter.
Table 7 Receive Misc. Msg Misc Fields
Field Description
Sequencing Key Can contain an XPath expression that specifies which processes should run in order. Process instances whose sequencing key evaluates to the same value will be executed sequentially in the order in which the process instance was created.
Custom Id Can contain an XPath expression that specifies a custom ID for the process instance. This ID is displayed in the View Service dialog of TIBCO Administrator, and it is also available in the $_processContext process variable.
TIBCO BusinessConnect Palette Reference
Receive Request/Notification | 23
Receive Request/Notification
Use the Receive Request/Notification process starter to process an incoming request/reply message forwarded by the TIBCO BusinessConnect server, or to process an incoming notify message forwarded by the TIBCO BusinessConnect server.
Receive Request/Notification activity will receive the messages that are published on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.RESPONDER.REQUEST
JMS subject
prefix.installation_name.RESPONDER.REQUEST
Configuration
Table 8 Receive Request/Notification Configuration Fields
Field Description
Name The name to appear as the label for the activity in the process definition
Description Short description of the activity
Server Details The BCServerConfig shared configuration resource used to connect to the TIBCO BusinessConnect server. See BCServerConfig for more information.
Operation Name Pre-configured operations that are available for the protocol associated with the server configuration
TIBCO BusinessConnect Palette Reference
24 | Chapter 1 BusinessConnect Palette
Parse XML Payload
• Checkbox selected The document in the inbound or outbound message is parsed and validated according to the corresponding Schema defined for this B2B operation.
• Checkbox cleared The XML document in the message is treated as a String. This is particularly useful in cases where the document need not be processed (parsed) immediately in the TIBCO BusinessConnect activity.
If the checkbox Parse XML Payload is cleared, the event sources will list a wild card (“*”) entry in their dropdown list. You can select this entry (“*” ) in order to start receiving multiple operations on the given event source instance, assuming that the operations belong to the same business protocol. In this case, no parsing or validation of the message happens at the event source level. If parsing or validation are required for the messages that are received on these wildcard listeners, a parse /validate task can be used after the event source.
Use Smart Routing
Provide an identifier for the private process instance. Event sources that reference a shared resource can inherit the smart ID if you enable Smart Routing for the event source. You can also override an inherited smart ID by providing a different smart ID in the event source.
Shared Smart ID Select this checkbox to inherit the Smart ID from the shared resource directly into this event source. In this case, the event source will use the same Smart ID as the shared resource.
Smart Routing ID
Type the desired Smart ID into this field in order to have a different Smart ID on the event source level . The messages will be routed to this private process event source.
Table 8 Receive Request/Notification Configuration Fields
Field Description
TIBCO BusinessConnect Palette Reference
Receive Request/Notification | 25
Misc
OutputThe Output tab lists output schema information, which is based on the input of the operation selected in the Configuration tab for this activity.
Table 9 Receive Request/Notification Misc Fields
Field Description
Sequencing Key Contain an XPath expression that specifies which processes should run in order. Process instances whose sequencing key evaluates to the same value will be executed sequentially in the order in which the process instance was created.
Custom Id Contain an XPath expression that specifies a custom ID for the process instance. This ID is displayed in the View Service dialog of TIBCO Administrator, and it is also available in the $_processContext process variable.
TIBCO BusinessConnect Palette Reference
26 | Chapter 1 BusinessConnect Palette
Receive Response
The Receive Response activity is used to receive a response to a previously sent request from the Send Request/Notification activity.
Receive Response activity would receive the messages that are published on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.INITIATOR.RESPONSE
JMS subject
prefix.installation_name.INITIATOR.RESPONSE
Configuration
Table 10 Receive Response Configuration Fields
Field Description
Name The name to appear as the label for the activity in the process definition
Description Short description of the activity
Server Details The BCServerConfig shared configuration resource used to connect to the TIBCO BusinessConnect server. See BCServerConfig for more information.
Operation Name Pre-configured operations available for the protocol associated with the server configuration
TIBCO BusinessConnect Palette Reference
Receive Response | 27
Parse XML Payload
• Checkbox selected The document in the inbound or outbound message is parsed and validated according to the corresponding Schema defined for this B2B operation.
• Checkbox cleared The XML document in the message is treated as a String. This is particularly useful in cases where the document need not be processed (parsed) immediately in the TIBCO BusinessConnect activity.
If the checkbox Parse XML Payload is cleared, the event sources will list a wild card (“*”) entry in their dropdown list. You can select this entry (“*”) in order to start receiving multiple operations on the given event source instance, assuming that the operations belong to the same business protocol.
In this case when no parsing or validation of the message will happen at the event source level. If parsing or validation are required for messages that are received on these wildcard listeners, a parse /validate task can be used after the event source.
Use Smart Routing
Provide an identifier for the private process instance. Event sources that reference a shared resource can inherit the smart ID if you enable Smart Routing for the event source. You can also override an inherited smart ID by providing a different smart ID in the event source.
Shared Smart ID Select this checkbox to inherit the Smart ID from the shared resource directly into this event source. In this case, the event source will use the same Smart ID as the shared resource.
Smart Routing ID
Type the desired Smart ID into this field in order to have a different Smart ID on the event source level . The messages will be routed to this private process event source.
Field Description
TIBCO BusinessConnect Palette Reference
28 | Chapter 1 BusinessConnect Palette
Misc
OutputThe output tab lists output schema information, which is based on the output of the operation selected in the Configuration tab for this activity.
Table 11 Receive Response Misc Fields
Field Description
Sequencing Key Contain an XPath expression that specifies which processes should run in order. Process instances whose sequencing key evaluates to the same value will be executed sequentially in the order in which the process instance was created.
Custom Id Contain an XPath expression that specifies a custom ID for the process instance. This ID is displayed in the View Service dialog of TIBCO Administrator, and it is also available in the $_processContext process variable.
TIBCO BusinessConnect Palette Reference
Send Misc. Msg | 29
Send Misc. Msg
This activity is provided for backward compatibility purposes only.
Configuration
Table 12 Send Misc. Msg Configuration Fields.
Input The input tab lists input schema information. The schema that displays is based on the input of the miscellaneous message selected in the Configuration tab for this activity.
OutputThis activity requires no output.
Field Description
Name The name to appear as the label for the activity in the process definition
Description Short description of the activity
Server Details The BCServerConfig shared configuration resource used to connect to the TIBCO BusinessConnect server. See BCServerConfig for more information.
Message Name Miscellaneous message types available for the selected protocol of the specified BusinessConnect Connection shared configuration resource.
TIBCO BusinessConnect Palette Reference
30 | Chapter 1 BusinessConnect Palette
Send Request/Notification
The Send Request/Notification activity can be used to send an outgoing request/reply message or an outgoing notify message to the TIBCO BusinessConnect server.
You can receive the response to the request on the same activity or in a different process instance by using the Receive Response process starter.
Send Request/Notification would publish the messages on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.INITIATOR.REQUEST
JMS subject
prefix.installation_name.INITIATOR.REQUEST
Configuration
Table 13 Send Request/Notification Configuration Fields.
Field Description
Name The name to appear as the label for the activity in the process definition
Description Short description of the activity.
Server Details The BCServerConfig shared configuration resource used to connect to the TIBCO BusinessConnect server. See BCServerConfig for more information.
Operation Name Pre-configured operations that are available for the protocol associated with the server configuration.
Parse XML Payload • Checkbox selected The document in the inbound or outbound message is parsed and validated according to the corresponding Schema definition defined for this B2B operation.
• Checkbox cleared The XML document in the message is treated as a String. This is particularly useful in cases where the document need not be processed (parsed) immediately in the TIBCO BusinessConnect activity.
Generate Unique Transaction ID
If selected, the unique transaction ID will be generated regardless of what is provided for the transactionID input field.
TIBCO BusinessConnect Palette Reference
Send Request/Notification | 31
InputThe input tab lists input schema information based on the input of the operation selected in the Configuration tab for this activity.
OutputThe output tab lists output schema information.
Don’t Wait for Response
Specifies that the activity should not wait for a response from the TIBCO BusinessConnect server.
Response Wait Time This option appears only if the checkbox Don’t Wait for Response is cleared. It lets you specify the exact time to wait for a response in days, hours, minutes and seconds.
Field Description
This tab is protocol specific. Refer to the documentation for a specific protocol for more information.
This tab is protocol specific. Refer to the documentation for a specific protocol for more information.
TIBCO BusinessConnect Palette Reference
32 | Chapter 1 BusinessConnect Palette
Send Response
The Send Response activity sends an outgoing response message to the local TIBCO BusinessConnect server.
Send Response would publish the messages on the following subjects:
TIBCO Rendezvous subject
prefix.installation_name.standardID.RESPONDER.RESPONSE
JMS subject
prefix.installation_name.RESPONDER.RESPONSE
Configuration
Table 14 Send Response Configuration Fields.
Field Description
Name The name to appear as the label for the activity in the process definition.
Description Short description of the activity.
Server Details The BCServerConfig shared configuration resource used to connect to the TIBCO BusinessConnect server.
See BCServerConfig for more information.
Operation Name Pre-configured operations that are available for the protocol associated with the server configuration.
Only the Request.Response operations will be populated for this activity.
Parse XML Payload • Checkbox selected: When checked, the document in the inbound or outbound message is parsed and validated according to the corresponding Schema definition defined for this B2B operation.
• Checkbox cleared: When this checkbox is cleared, the XML document in the message is treated as a String. This is particularly useful in cases where the document need not be processed (parsed) immediately in the TIBCO BusinessConnect activity.
TIBCO BusinessConnect Palette Reference
Send Response | 33
Figure 3 Send Response Configuration Tab
Input The input tab lists input schema information. The schema that displays is based on the input of the operation selected in the Configuration tab for this activity.
Output This activity produces no output.
Request Name Receive Request/Notification operations and custom requests. If you choose a non-custom request, the Server Details and Operation Name fields are filled automatically.
If you choose <Custom Request>, you must set the values for the Server Details and Operation Name fields.
This is typically used in conjunction with a Receive Request process starter, whereby in the same process definition a request is received, some processing occurs, and a response is sent back to TIBCO BusinessConnect.
Field Description
This tab is protocol specific. Refer to the documentation for a specific protocol for more information.
For EZComm, see TIBCO BusinessConnect EZComm Protocol User’s Guide, About Schema Validation in EZComm.
TIBCO BusinessConnect Palette Reference
34 | Chapter 1 BusinessConnect Palette
TIBCO BusinessConnect Palette Reference
| 35
Index
A
activity
Receive Response 26
Send Misc. Msg 29
Send Request/Notification 30
Send Response 32
auto confirm, JMS 11
B
BCServerConfig 3
BCServerConfig, configuration 5
C
configure private processes for smart routing 15
configuring
BusinessConnect Server Access 4
Receive Misc. Msg configuration fields 18
Receive Request/Notification configuration
fields 23
Receive Response 26
Send Misc. Msg 29
Send Request/Notification 30
Send Response 32
customer support xii
I
implement custom schemas 2
J
JMS auto reconnect 14
JMS, connection transport 10
JMS, setting up 10
JMS, test connection 12
M
manage schemas 2
O
Oracle client library path usage 5
P
process starter
Receive Misc. Msg 18
Receive Request/Notification 23
Q
QOS (quality of service) 8
quality of service (QOS) 8
R
Receive Misc. Msg, configuration 18
TIBCO BusinessConnect Palette Reference
36 | Index
Receive Misc. Msg, Misc fields 22
Receive Misc. Msg, output 22
Receive Request/Notification, configuration 23
Receive Request/Notification, Misc fields 25, 28
Receive Request/Notification, output 25
Receive Response, configuration 26
Receive Response, output 28
Rendezvous 5
Rendezvous, configuring BCServerConfig 8
resource
BCServerConfig 3
S
secure JMS 12
Send Misc. Msg, configuration 29
Send Misc. Msg, input 29
Send Misc. Msg, output 29
Send Request/Notification, configuration 30
Send Response, configuration 32
Smart ID 7
smart routing 7
support, contacting xii
T
technical support xii
TIBCO_HOME x
U
using schemas in BusinessConnect 2
Top Related