tibco activematrix businessworks™ plug-in for

TIBCO ActiveMatrix BusinessWorks™ Plug-infor BusinessConnect™User's GuideSoftware Release 6.1March 2016

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO ActiveMatrixBusinessWorks Plug-in for BusinessConnect, TIBCO Administrator, TIBCO BusinessConnect, TIBCOBusiness Studio, and TIBCO Enterprise Administrator are either registered trademarks or trademarksof TIBCO Software Inc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE 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 ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2005-2016 TIBCO Software Inc. All rights reserved.

TIBCO Software Inc. Confidential Information

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for BusinessConnect™ User's Guide

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Creating a BC Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

BC Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

BC Connection - Server Access Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

BC Connection - Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Configuring Private Processes for Smart Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configuring Private Processes for Smart Routing at a Shared Resource Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Configuring Private Processes for Smart Routing at an Event Source Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

BC Connection - Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

JMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

JMS Auto Reconnect for the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

BusinessConnect Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

ReceiveMiscMsg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

ReceiveRequest/Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

ReceiveResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

SendMiscMsg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

SendRequest/Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

SendResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

3


TIBCO Documentation and Support Services

Documentation for this and other TIBCO products is available on the TIBCO Documentation site. Thissite is updated more frequently than any documentation that might be included with the product. Toensure that you are accessing the latest available help topics, please visit:

https://docs.tibco.com

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site at https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-businessconnect. To directly access documentation for this product, double-click the followingfile:

TIBCO_HOME/release_notes/TIB_bwpluginbc_version_docinfo.html

where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows,the default TIBCO_HOME is C:\Program Files\tibco. On UNIX systems, the default TIBCO_HOMEis /opt/tibco.

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect Installation● TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect User's Guide● TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect Release Notes

The following documents provide additional information and can be found on the TIBCODocumentation site:

● TIBCO ActiveMatrix BusinessWorks Documentation● TIBCO BusinessConnect Documentation● TIBCO Enterprise Administrator User's Guide

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

● 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 canrequest one.

How to Join TIBCO Community

TIBCO Community is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCO Community offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://community.tibco.com

4


https://docs.tibco.com

https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-businessconnect

https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-businessconnect

http://www.tibco.com/services/support

https://support.tibco.com

https://community.tibco.com

Product Overview

You can use TIBCO ActiveMatrix BusinessWorks™ Plug-in for BusinessConnect™ to receive messagesfrom and send messages to TIBCO BusinessConnect™ servers.

Messages received from trading partners can be packaged into different types of formats based on thebusiness-to-business (B2B) standard followed by the trading community. These messages are processedby TIBCO BusinessConnect, and converted into a canonicalized format, which are sent to enterpriseback office systems. TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect works as part ofTIBCO ActiveMatrix BusinessWorks™ processes to receive the canonicalized message from TIBCOBusinessConnect and forward it to the back office system.

TIBCO Rendezvous® or TIBCO Enterprise Message Service™ is used as the communication systembetween BusinessConnect and BusinessWorks processes, which plug TIBCO ActiveMatrixBusinessWorks Plug-in for BusinessConnect.

TIBCO ActiveMatrix BusinessWorks is a leading integration platform that can integrate a wide varietyof technologies and systems within enterprise and on cloud. TIBCO ActiveMatrix BusinessWorksincludes an Eclipse-based graphical user interface (GUI) provided by TIBCO Business Studio™ fordesign, testing, and deployment. If you are not familiar with TIBCO ActiveMatrix BusinessWorks, seethe TIBCO ActiveMatrix BusinessWorks documentation for more details.

TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect plugs into TIBCO ActiveMatrixBusinessWorks, which bridges TIBCO ActiveMatrix BusinessWorks with TIBCO BusinessConnect.

TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect includes the following sharedresource and activities:

● Shared resource

— BC Connection Shared Resource● Activities

— ReceiveMiscMsg— ReceiveRequest/Notification— ReceiveResponse— SendMiscMsg— SendRequest/Notification— SendResponse

You can add these plug-in activities to the business process that you are designing, and integrate themwith the process flow. At run time, these plug-in activities are executed as part of the ActiveMatrixBusinessWorks process execution. Each plug-in consists of activities that share the commonfunctionality and properties that are defined in the shared resource.

5


Getting Started

This tutorial is designed for the beginners who want to use TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect in TIBCO Business Studio.

All the operations are performed in TIBCO Business Studio. See TIBCO Business Studio Overview toget familiar with TIBCO Business Studio.

A basic procedure of using TIBCO ActiveMatrix BusinessWorks Plug-in for BusinessConnect includes:

1. Creating a Project

2. Creating a BC Connection Shared Resource

3. Configuring a Process

4. Testing a Process

5. Deploying an Application

Creating a ProjectThe first task using the plug-in is creating a project. After creating a project, you can add resources andprocesses.

An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. Anapplication module is the smallest unit of resources that is named, versioned, and packaged as part ofan application.

Procedure

1. Start TIBCO Business Studio using one of the following ways:

● Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version_number > Studio for Designers.

● Linux: run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/version_number/eclipse directory.

2. From the menu, click File > New > BusinessWorks Resources to open the BusinessWorks Resourcewizard.

3. In the "Select a wizard" dialog, click BusinessWorks Application Module and click Next to openthe New BusinessWorks Application Module wizard.

4. In the Project dialog, configure the project that you want to create:a) In the Project name field, enter a project name.b) By default, the created project is located in the workspace current in use. If you do not want to

use the default location for the project, clear the Use default location check box and click Browseto select a new location.

c) Use the default version of the application module, or enter a new version in the Version field.d) Keep the Create empty process and Create Application check boxes selected to automatically

create an empty process and an application when creating the project.e) Select the Use Java configuration check box if you want to create a Java module.

A Java module provides the Java tooling capabilities.f) Click Finish to create the project.

Result

The project with the specified settings is displayed in the Project Explorer view.

6


Creating a BC Connection Shared ResourceTo utilize the plug-in activities in BusinessWorks processes, you have to create a BC Connection sharedresource which contains the information needed to connect to a TIBCO BusinessConnect server.

Procedure

1. Expand the created project in the Project Explorer view.

2. Right-click the Resources folder and click New > BC Connection to open the BC Connectionwizard.

3. The resource folder, package name, and resource name of the BC connection are provided bydefault. If you do not want to use the default configurations, change them accordingly. Click Finishto open the BC Connection Configuration editor.

7


4. In the Server Access tab, configure fields to create a connection to the database used for theconfiguration store.For more details, see BC Connection - Server Access Tab.

5. In the Configuration tab, click Update from Configuration Store to connect to the TIBCOBusinessConnect configuration store and fetch the private process and protocol configuration.For more details, see BC Connection - Configuration Tab.

6. Click Import Selected Business Protocol to import the configuration of the selected businessprotocol and operations from the TIBCO BusinessConnect configuration store.

7. Click Save to save the configurations.

8. In the Transport tab, configure transport information.For more details, see BC Connection - Transport Tab.

The transport type for the communication between BusinessConnect and BusinessWorks privateprocesses has already been configured on BusinessConnect side by using TIBCO Administrator, asexplained in TIBCO BusinessConnect Trading Partner Administration Guide, "Private ProcessConfiguration." In TIBCO Business Studio, you can override the settings by using the providedGUI, but the transport type cannot be changed.

Configuring a ProcessAfter creating a project, an empty process is created. You can add activities to the empty process tocomplete a task. For example, receive miscellaneous messages from TIBCO BusinessConnect.

Prerequisites

Ensure that you have created an empty process when Creating a Project.

Procedure

1. In the Project Explorer view, click the created project and open the empty process from theProcesses folder.

8


2. Select an activity from the Palette view and drop it in the Process editor.For example, select and drop the Timer activity from the General Activities palette and theReceiveMiscMsg activity from the BusinessConnect Activities palette.

3. Drag the icon to create a transition between the added activities.

4. Configure the added activities, as described in BusinessConnect Activities Palette.The BusinessConnect Activities palette consists of several activities. Some are for sending orreceiving business messages to/from BusinessConnect, and some are for sending/receivingmiscellaneous messages such as errors to/from BusinessConnect. These activities provide the fullintegration between BusinessConnect and BusinessWorks processes. See BusinessConnect ActivitiesPalette for more details.

A BC Connection shared resource is required when configuring the activities. See Creatinga BC Connection Shared Resource for more details on how to create the BC Connectionshared resource.

5. Click File > Save to save the project.

Testing a ProcessAfter configuring a process, you can test the process to check whether the process completes your task.

Prerequisites

Ensure that you have configured a process, as described in Configuring a Process.

Procedure

1. On the toolbar, click Debug > Debug Configurations.

2. Click BusinessWorks Application > BWApplication in the left panel.By default, all the applications in the current workspace are selected in the Applications tab. Ensurethat only the application you want to debug is selected in the Applications tab in the right panel.

3. Click Debug to test the process in the selected application.TIBCO Business Studio changes to the Debug perspective. The debug information is displayed inthe Console view.

9


4. In the Debug tab, expand the running process and click an activity.

5. In the upper-right corner, click the Job Data tab, and then click the Output tab to check the activityoutput.

Deploying an ApplicationAfter testing, if the configured process works as expected, you can deploy the application that containsthe configured process into a runtime environment, and then use the bwadmin utility to manage thedeployed application.

Before deploying an application, you must generate an application archive, which is an enterprisearchive (EAR) file that is created in TIBCO Business Studio.

Deploying an application involves the following tasks:

1. Uploading an application archive

2. Deploying an application archive

3. Starting an application

See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

10


TIBCO Business Studio OverviewTIBCO Business Studio is an Eclipse-based integration development environment that is used todesign, develop, and test ActiveMatrix BusinessWorks applications.

TIBCO Business Studio provides a workbench in which you can create, manage, and navigate resourcesin your workspace. A workspace is the central location on your machine where all data files are stored.

The workbench consists of:

1. Menu: contains menu items such as File, Edit, Diagram, Navigate, Search, Project, Run, Window,and Help.

2. Toolbar: contains buttons for frequently used commands such as New , Save , Enable/Disable Business Studio Capabilities , Create a new BusinessWorks Application Module ,Create a new BusinessWorks Shared Module , Debug , Run , and so on.

3. Perspective: contains an initial set and layout of views that are required to perform a certain task.TIBCO Business Studio launches the Modeling perspective by default. You can change theperspective from the menu Window > Open Perspective > Perspective_Name.

4. View: displays resources. For example, the Project Explorer view displays the ActiveMatrixBusinessWorks applications, modules, and other resources in your workspace, and the Propertiesview displays the properties for the selected resource. You can open a view from the menu Window> Show View > View_Name.

5. Editor: provides a canvas to configure, edit, or browse a resource. Double-click a resource in a viewto open the appropriate editor for the selected resource. For example, double-click an ActiveMatrixBusinessWorks process (Process.bwp) in the Project Explorer view to open the process in theeditor.

6. Palette: contains a set of widgets and a palette library. A palette groups activities that performsimilar tasks, and provides quick access to activities when configuring a process.

11


BC Connection Shared Resource

BC Connection is a shared resource that describes the characteristics of the connection to the TIBCOBusinessConnect server. This shared resource is used when a business process has to connect to theBusinessConnect server.

The configuration of the BC Connection shared resource includes connecting to the BusinessConnectconfiguration store, from where the relevant information about the business protocol to be used for thetransactions, such as the enabled operations, schema of the relevant business documents and so on, isextracted and loaded to TIBCO ActiveMatrix BusinessWorks during design time. The communicationtransport between TIBCO BusinessConnect and TIBCO ActiveMatrix BusinessWorks processes, eitherTIBCO Rendezvous or TIBCO Enterprise Message Service, is also set automatically on theBusinessWorks side, according to the configuration on the BusinessConnect side.

When you import the business protocol information from the TIBCO BusinessConnect configurationstore, a folder named BCSchemas, containing imported schemas of all relevant business documents,becomes available.

Do not rename the BCShemas folder, which is hard-coded and shared. This folder is accessed througha configured path, and its name must be preserved.

BC Connection - Server Access TabIn the Server Access tab, you can configure information about the BusinessConnect server that theplug-in connects to.

The following table lists the configurations in the Server Access tab of the BC Connection sharedresource.

FieldModuleProperty? Description

JDBC DriverType

No The type of the JDBC driver.

The available JDBC driver types in this list include Oracle Thin,Oracle OCI, Microsoft SQL Server, MySQL, and IBM DB2Universal Type 4.

JDBC Driver Yes Available drivers for the database.

The Oracle Client Library path has to be specified if youuse the Oracle OCI drivers:● On Microsoft Windows

1. Click Start > Control Panel > System > Advancedsystem settings > Environment Variables.

2. In the System variables area, double-click thePath variable.

3. In the Edit System Variable dialog, addInstant_Client_Home to the value of theVariable value field.

4. Click OK.● On Linux

Add Instant_Client_Home to the values of the PATHand LD_LIBRARY_PATH environment variables.

12



JDBC URL Yes The URL for the configuration store database for the selected JDBCdriver.

DB User Yes A valid user name for the database. This field is optional.

DB Password Yes The password associated with the user name. This field is optional.

BC Connection - Configuration TabIn the Configuration tab, you can configure BC connection information.

The Configuration tab of the BC Connection shared resource consists of the General panel and BusinessConnect Configuration panel.

General

In the General panel, you can specify the package that stores the BC Connection shared resource andthe shared resource name.

The following table lists the configurations in the General panel of the Configuration tab of the BCConnection shared resource:


Package No The name of the package where the new shared resource is added.

Name No The name to be displayed as the label for the shared resource in theprocess.

Description No A short description for this shared resource.

BusinessConnect Configuration

In the BusinessConnect Configuration panel, you can provide the information of the TIBCOBusinessConnect server that the plug-in connects to.

The following table lists the configurations in the BusinessConnect Configuration panel of theConfiguration tab of the BC Connection shared resource:


Server No The installation name of the TIBCO BusinessConnect server.

This field is read-only. The plug-in retrieves information from theconfiguration store after a successful connection to the databaseused by TIBCO BusinessConnect.

13



PP Transport No The transport type for the BusinessWorks private process tocommunicate with BusinessConnect: TIBCO Rendezvous or JMS.

This field is read-only. The BC Connection shared resourceretrieves information from the configuration store after asuccessful connection to the database used by TIBCOBusinessConnect.

UpdateTransportSettings

No The retrieve of the transport settings from the configuration storeand overwrite any custom transport settings specified in theTransport tab of this shared resource. Clear the check box toretrieve only protocol-specific settings.

During the initial configuration of a connection resource,this check box is selected, and you cannot clear it untilyou retrieve the transport settings the first time. Afterthe first time, you can select or clear this check box.

Protocol Name No The available protocols. This list is populated by using informationfrom the configuration store which consists of all the available andenabled protocols configured on BusinessConnect side.

You can select one protocol, for which the further information suchas all the operations to be used in the BusinessWorks processes hasto be retrieved from the configuration store. If you want tocommunicate with multiple protocols, you must have multipleshared resources, one for each protocol.

SelectOperations

No Whether to select specific operations.

This check box is available only if the selected protocol includesone or more operations and supports defining which operations toimport instead of importing all operations.

● If you select the check box, the Select Operations page isdisplayed with a list of operations for the protocol. Select thecheck box next to each operation you want to import or update,and then click OK.

● If you clear this check box, TIBCO BusinessConnect imports alloperations for the selected protocol.

Click Import Selected Business Protocol to import thelist of selected operations.

ImportedOperations

No A list of operations that are imported from the configuration store.

14



Use Smart ID Yes An identifier for the private process instance used for privateprocess smart routing. Event Source activities of the plug-in, suchas the ReceiveRequest/Notification and ReceiveResponse activities,that reference a shared resource can inherit the smart ID if youenable smart routing for the event source activities. You can alsooverride an inherited smart ID by providing a different smart ID inthe event source.

The use of private process smart routing requires that you definebusiness rules in the TIBCO BusinessConnect console.

See Configuring Private Processes for Smart Routing for detailedinformation.

If you select the Use Smart ID check box, the Smart ID field isdisplayed.

Smart ID Yes An identifier for the private process instance used for a privateprocess smart routing.

This field is displayed only when you select the Use Smart IDcheck box.

Configuring Private Processes for Smart RoutingIf you have created business rules for Smart Routing through the TIBCO BusinessConnect applicationwithin TIBCO Administrator, you can route messages that include specific smart IDs to specific privateprocesses.

You can configure smart routing for private processes at the following levels:

● Configuring Private Processes for Smart Routing at a Shared Resource Level● Configuring Private Processes for Smart Routing at an Event Source Level

Subjects on Which Messages Are Published

For any other private process implementations or message types subject to Smart Routing, the subjecton which the message is published from TIBCO BusinessConnect to the private process always uses thefollowing format:

● For TIBCO Rendezvous:prefix.installation_name.smart_routing_id.standardID.RESPONDER.REQUEST

Here is an example: AX.BC.BC-SERVER.SMARTID1.RosettaNet.RESPONDER.REQUEST.

● For JMS: prefix.installation_name.RESPONDER.REQUEST

Here is an example: AX.BC.BC-SERVER.RESPONDER.REQUEST.

Configuring Private Processes for Smart Routing at a Shared Resource Level

You can configure a private process for smart routing at a shared resource level.

Procedure

1. Open the TIBCO BusinessConnect project in TIBCO Business Studio.

15


2. Double-click the shared resource that you want to configure.

3. Select or clear the Use Smart ID check box to enable or disable smart routing.After you select this check box, the Smart ID field is displayed:

4. Configure the Smart ID field for the messages that you want to route to this private process sharedresource.

Configuring Private Processes for Smart Routing at an Event Source Level

You can configure a private process for smart routing at an event source level.

Procedure

1. Open the TIBCO BusinessConnect project in TIBCO Business Studio.

2. Navigate to the event source that you want to configure, such as ReceiveMiscMsg, ReceiveRequest/Notification, or ReceiveResponse.

3. Select or clear the Use Smart Routing check box to enable or disable smart routing.After you select this check box, the following new options are displayed:

● Shared Smart ID check box● Smart Routing ID field

4. Configure the following fields:

● Shared Smart ID: if you want to inherit the smart ID from the shared resource directly into thisevent source, just select this check box. In this case, the event source uses the same smart ID asthe shared resource.

● Smart Routing ID: if you want to have a different smart ID at the event source level, type therequired smart ID for the messages that you want to route to this private process event source.

5. Click Save to save the configurations.

If the private process implementation uses the plug-in, the INITIATOR.RESPONSEmessages that are responded to synchronous (blocking) requests from the plug-in are notpublished on a smart ID subject. This happens if the Don’t Wait for Response check box iscleared.

In this case, the plug-in automatically associates the reply with the response internally,and forwards it to the relevant event source.

BC Connection - Transport TabYou can use the Transport tab of the BC Connection shared resource to configure the communicationtransport between BusinessConnect and BusinessWorks private process.

The Transport tab is associated with different transport communications for private processes:

● Rendezvous: configurations of TIBCO Rendezvous transport for private process communication.

See the TIBCO Rendezvous documentation for more details.● JMS: configurations of JMS transport for private process communication.

Settings for configuring JMS are imported from the configuration store and are user modifiable.

16


RendezvousIn the Rendezvous panel, you can configure TIBCO Rendezvous transport for private processcommunication.

The following table lists the configurations in the Rendezvous panel of the Transport tab of the BCConnection shared resource:


InstallationName

Yes The name of the TIBCO BusinessConnect installation.

SubjectPrefix

Yes The subject prefix from the TIBCO BusinessConnect installation.

Service Yes Either the name of the Rendezvous service or its port number.

If you leave this field blank, TIBCO Rendezvous uses the Rendezvousservice if the service exists. Otherwise, TIBCO Rendezvous uses port7500.

Network Yes The network to be used by the Rendezvous daemon. This field isoptional.

Daemon Yes The client socket used for the Rendezvous daemon. The default valueis 7500.

Quality ofService

No The quality of service for messages transmitted to the TIBCOBusinessConnect server. This quality of service corresponds to TIBCORendezvous protocols.

The available options are:

● Reliable● Certified● Distributed-Queue

The remaining fields vary based on the quality of service that youselect. If you select Reliable, you are done.

17



Server to PPCM AutoConfirm

No Whether to configure the certified listener transport to automaticallyconfirm delivery of messages from the TIBCO BusinessConnectserver to the private process.

If this check box is selected, it configures the certified listenertransport to automatically confirm delivery of messages from theTIBCO BusinessConnect server to the private process. Otherwise, theprivate process is responsible for confirming delivery. You have toadd a Confirm activity in the private process and specify which eventto confirm. See TIBCO Designer User’s Guide for more information.

If this check box is selected and any listener using this BCconnection is loaded, all messages for this BC connectionare confirmed even though no active listener is loaded inthe panel for these messages (messages are not dispatchedsuccessfully to any listener). To avoid this behavior, clearthe Server to PP CM Auto Confirm check box and use theexplicit confirmation; in such a case, the TIBCORendezvous messages are confirmed only if the Confirmactivity is executed for the event.

Local CMName

Yes The name of the local certified messaging transport.

PreregisteredBC QueueName

Yes A comma-separated list of certified messaging sessions to registerwith TIBCO ActiveMatrix BusinessWorks.

Use ProcessBasedLedger

No Whether a process-based ledger is used for interaction betweenTIBCO ActiveMatrix BusinessWorks and the TIBCO BusinessConnectserver.

If you select the Use Process Based Ledger check box, the value in theFile Based Ledger field is ignored.

File BasedLedger

Yes The TIBCO Rendezvous certified ledger file name for interactionbetween TIBCO ActiveMatrix BusinessWorks and the TIBCOBusinessConnect server.

QOS (quality of service) properties specific for TIBCO Rendezvous

LocalDistributedQueue

Yes The name of the distributed queue.

This name must be different from the name specified in the Local CMName field; otherwise, a name collision exception occurs at run time.

QueueSettings

No The properties of the distributed queue.

Selecting this field causes the Worker Weight, Worker Tasks,Scheduler Weight, Scheduler Heartbeat, Scheduler Activation andWorker Complete Time fields to be displayed.

18



WorkerWeight

Yes The weight to assign to the worker member of the distributed queue.

See the TIBCO Rendezvous documentation for more informationabout assigning worker weight.

WorkerTasks

Yes The maximum number of tasks that this worker can accept. When thenumber of accepted tasks reaches this maximum, the worker cannotaccept additional tasks until it completes one or more of them.

See TIBCO Rendezvous documentation for more information aboutsetting the number of tasks.

SchedulerWeight

Yes The weight that represents the ability of this member to fulfill the roleof scheduler, relative to other members with the same name.

See the TIBCO Rendezvous documentation for more informationabout setting the scheduler weight.

SchedulerHeartbeat(seconds)

Yes The interval, expressed in seconds, at which the scheduler sendsheartbeat messages. All members with the same distributed queuename must specify the same value for this parameter.

See the TIBCO Rendezvous documentation for more informationabout setting the scheduler heartbeat.

SchedulerActivation(seconds)

Yes The interval, expressed in seconds, at which the heartbeat signal fromthe scheduler is silent.

When the heartbeat signal from the scheduler has been silent for thisinterval (in seconds), the member with the greatest scheduler weighttakes its place as the new scheduler.

See the TIBCO Rendezvous documentation for more informationabout setting the scheduler activation.

WorkerCompleteTime

Yes The complete time for worker members. The complete time propertyinfluences scheduler behaviors.

If the complete time is non-zero, the scheduler waits for a workermember to complete an assigned task. If the complete time elapsesbefore 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 completiontime—that is, the scheduler does not set a timer, and does notreassign tasks when task completion is lacking. All membersimplicitly begin with a default complete time value of zero.

The complete time must be non-negative.

JMSIn the JMS panel, you can configure JMS transport for private process communication.

The following table lists the configurations in the JMS panel of the Transport tab of the BC Connectionshared resource:

19



InstallationName

Yes The name of the TIBCO BusinessConnect installation.

InstallationPrefix

Yes The prefix that defines an installation.

JMS UserName

Yes The user name to be used when logging into the JMS server.

If the JMS provider does not require access control, this field can beempty. Not all JMS servers require user names and passwords. Referto your JMS provider documentation and consult your systemadministrator to determine whether your JMS server requires a username and password.

JMS Password Yes The password to be used when logging into the JMS server.

If the JMS provider does not require access control, this field can beempty.

JNDI ContextFactory

Yes The initial context factory class for accessing JNDI.

See TIBCO BusinessConnect Trading Partner Administration Guide fordetails.

JNDI ContextURL

Yes The URL to the JNDI service provider.


JNDI UserName

Yes If the deployed JMS/JNDI provider(s) requires no authenticationwith the client, the JMS User Name/JNDI User Name fields mightbe left blank.

JNDIPassword

Yes If the deployed JMS/JNDI provider(s) requires no authenticationwith the client, the JMS Password/JNDI Password fields might beleft blank.

TopicConnectionFactory

Yes The TopicConnectionFactory object stored in JNDI.


QueueConnectionFactory

Yes The QueueConnectionFactory object stored in JNDI.


20



Auto Confirm Yes Whether inbound JMS messages are confirmed to the providerautomatically (after being successfully dispatched to at least one ofthe subscribing event sources), or the process definition has toexplicitly take care of that by placing a Confirm activity in theprocess definition and confirming the corresponding event.

If this check box is selected, inbound messages are automaticallyconfirmed, which means that inbound JMS messages dispatched toTIBCO ActiveMatrix BusinessWorks are acknowledged so that theJMS provider can remove them accordingly.

Otherwise, messages might be left in persistent store of the JMSprovider. TIBCO BusinessConnect business protocols might specifyJMS topic transports and expect non-durable receivers on somemiscellaneous messages (specified by the AE schemas of thesemessages) that can be lost without causing problems. Thisimplementation can help to reduce the load on JMS providers.

Regarding message types that are set on topics and do not needconfirmation, see the user's guides of the corresponding businessprotocols.

Auto CreateDestinations

Yes Managing administered objects, such as JMS topics and queues onthe preferred JMS provider, is generally the responsibility of the JMSprovider administrator.

If privileges support it, the palette can create the required queuesand topics automatically and dynamically. If this check box isselected, the starting JMS transport attempt to create the requireddestinations (queues and/or topics) in the specified transport modes.If unsuccessful, an exception is raised and either the privileges haveto be adjusted or the administered objects have to be createdmanually.

Regarding the requirements of the destinations, see the user's guidesof the specific protocols.

ReconnectDuration (>=mins)

Yes The timeout configuration property in minutes both for the TIBCOBusinessConnect server and the TIBCO BusinessConnect palette.

Secured Yes Whether to use the secure JMS transport.

Secure JMS can only be selected if the TIBCO Enterprise MessageService specific JNDI context factory is specified. If the JNDIContext Factory field is empty or a different provider factory isspecified, a dialog is displayed when selecting the check box andreports an error. When the dialog is accepted, the Secured check boxmoves back to the unselected state, and the secure JMS transportremains or becomes disabled.

21



Test JMSConnection

Click Test JMS Connection to test whether a proper connection isestablished.

Upon a successful connection, a dialog reports the status and thename/version of the provider with whom the connection has beenestablished. If the connection is unsuccessful, the cause is indicatedif available.

Secure JMS Transport

When you click Import Selected Business Protocol in the Configuration tab and the plug-in importsthe configuration from the TIBCO BusinessConnect configuration store, the credentials for the JMSserver and client identity are fetched and stored in the BC Connection shared resource.

The retrieved configuration properties can always be overridden at the plug-in level by using newvalues. That includes turning on or off the secure transport, and reconfiguring or changing thecredentials that are configured for the TIBCO BusinessConnect server transport.

If the TIBCO Enterprise Message Service server requires a secure transport, disabling this transport,although possible in the plug-in, results in a connection failure when the project is building up the JMStransport at run time.

The secure JMS transport includes the following fields:


Verify JMSServer

Yes If you select this check box, the identity of the JMS server (its X509certificate and the specified value in the Expected JMS Server HostName field) is verified against the data received during the SSLhandshake. If either the trusted CA certificates or the expected hostname do not match, the transport creation fails.

If this verification is not required, TIBCO BusinessConnect canestablish a JMS connection with any TIBCO Enterprise MessageService server whose credentials are different from the configuredproperties.

Trusted JMSServerCertificates

No If the credentials are supposed to be identical on both the TIBCOBusinessConnect server and the TIBCO BusinessConnect palette-based private process, no changes in the configuration are requiredafter the import of the configuration on the palette.

ExpectedJMS ServerHost name

Yes This is the value of the common name component of the TIBCOEnterprise Message Service server leaf certificate. It is usually thehost name of the resource that is running the TIBCO EnterpriseMessage Service server. If it is a test system, the common name (CN)value might be any arbitrary string, which must match the value ofthis field if the Verify JMS Server check box is selected.

StrongCiphersOnly

Yes See the corresponding field in TIBCO BusinessConnect Trading PartnerAdministration Guide for details.

22



Use Trace Yes See comments in TIBCO ActiveMatrix BusinessWorks Palette Reference,"JMS Palette" for details.

JMS Auto Reconnect for the Plug-in

Using JMS auto reconnect, which is enabled by default, both the BusinessConnect server and theBusinessConnect palette try to establish connections with the JMS server when the connection is downwithout restarting.

When JMS is used for private process communication in TIBCO BusinessConnect, both TIBCOBusinessConnect and BusinessConnect palette for ActiveMatrix BusinessWorks make connections tothe configured JMS server during startup. If the connection to JMS server cannot be established duringstartup, such as when a network failure occurs or the JMS server is down, TIBCO BusinessConnectterminates with a warning message. Also, if the connection to JMS server is established during startupbut terminated during run time, both TIBCO BusinessConnect and the BusinessConnect palette do notre-establish the connection. Therefore, after correcting the JMS problem, the BusinessConnect palettehas to be restarted.

On the BusinessConnect palette, the following situations occur:

● If the JMS server is down or the network connection is down when the palette starts up, theBusinessConnect palette tries to establish a connection with the JMS server. When the connection isestablished, the BusinessConnect palette sends messages to and receive messages from TIBCOBusinessConnect. The duration of the initial attempts to establish a valid JMS connection can be setin the Reconnect Duration field of the BC Connection shared resource.

● If the connection between the BusinessConnect palette and the JMS server is terminated during runtime, the BusinessConnect palette tries to establish connection with the JMS server. If the connectionis not established within the specified period of time that is set in the Reconnect Duration field ofthe BC Connection shared resource, the BusinessConnect palette activity times out. Furthermore,event sources can no longer receive messages even if the JMS provider comes back up after thetimeout.

23


BusinessConnect Activities Palette

A palette groups the activities that connect the same external applications together. TheBusinessConnect Activities palette is added after installing TIBCO ActiveMatrix BusinessWorks Plug-infor BusinessConnect.

The BusinessConnect Activities palette contains the following activities:

● ReceiveMiscMsg● ReceiveRequest/Notification● ReceiveResponse● SendMiscMsg● SendRequest/Notification● SendResponse

ReceiveMiscMsgAny message that is not an inbound or outbound request or response is a miscellaneous message. Youcan use the ReceiveMiscMsg activity to start a process when a miscellaneous message is received fromTIBCO BusinessConnect.

Not all business protocols support miscellaneous messages. The ReceiveMiscMsg activity requires a BCConnection shared resource that is configured for a specific protocol. If no miscellaneous messages existfor the specified protocol, the ReceiveMiscMsg activity cannot be used for that protocol.

General

In the General tab, you can establish a connection to a TIBCO BusinessConnect server, and configuresmart routing.

The following table lists the configurations in the General tab of the ReceiveMiscMsg activity:


Name No Specify the name to be displayed as the label for the activity in theprocess.

ServerDetails

Yes Specify the BC Connection shared resource used to connect to theTIBCO BusinessConnect server.

24



MessageName

Yes Select one of the available miscellaneous messages from the list. Thisfield contains a list of the available miscellaneous messages for the BCConnection shared resource selected for the Server Details field.

Some miscellaneous messages are related to message dispositionnotifications.

A message disposition notification (MDN) receipt is a transport levelacknowledgment.

Some of the protocols, such as TIBCO BusinessConnect Services™Plug-in and tibEDI, do not suppress these messages, and some ofthem do (RosettaNet, cXML). For more information, see thedocumentation for a specific business protocol.

These messages can occur when the AS1, AS2 or Email transports areused and receipts (MDNs) are utilized.

An MDNAlert message is sent to the private process when a receipt isrequested with an outbound message that is sent to a trading partner,and TIBCO BusinessConnect successfully receives and verifies thereceipt returned by the trading partner.

In this scenario, the notification to the private process is sent on thefollowing subjects:

● TIBCO Rendezvous subject

prefix.installation_name.standardID.INFO.RECEIPT.RECEI

VED

● JMS subject

prefix.installation_name.INFO.RECEIPT.RECEIVED

An MDNAlertError message is sent to the private process when areceipt is requested with an outbound message that is sent to a tradingpartner, and the trading partner returns a receipt which indicates thatthe trading partner encounters an error in the outbound message itreceives.



prefix.installation_name.standardID.ERROR.RECEIPT.RECE

IVED

● JMS subject

prefix.installation_name.ERROR.RECEIPT.RECEIVED

25



An MDNResponseAlert message is sent to the private process whenall the following listed conditions are met:

● TIBCO BusinessConnect receives a receipt request for an inbounddocument.

● TIBCO BusinessConnect can successfully un-package the inbounddocument for which a receipt is requested; for example, thesignature of the inbound document can be verified if the documentis signed.

● TIBCO BusinessConnect returns a receipt to the trading partnerindicating that the inbound document is received and unpackagedsuccessfully.



prefix.installation_name.standardID.INFO.RECEIPT.SENT

● JMS subject

prefix.installation_name.INFO.RECEIPT.SENT

An MDNErrorResponseAlert message is sent to the private process inthe following cases:

● TIBCO BusinessConnect receives a receipt request for an inbounddocument.

● TIBCO BusinessConnect cannot successfully verify the signaturefor the document, and it returns a receipt to the trading partnerindicating that the inbound document is received but the signaturecannot be successfully verified.



prefix.installation_name.standardID.ERROR.RECEIPT.SENT

● JMS subject

prefix.installation_name.ERROR.RECEIPT.SENT

26



An MDNTimeout message is sent to the private process when areceipt is requested for an outbound document, but the tradingpartner does not return a receipt within the receipt timeout period.



prefix.installation_name.standardID.ERROR.TIMEOUT.RECE

IPT

● JMS subject

prefix.installation_name.ERROR.TIMEOUT.RECEIPT

An ErrorNotify message is sent to the private process wheneverTIBCO BusinessConnect encounters an error during the processing ofan inbound or outbound messages.

When an error occurs, the notification to the private process is sent onthe following subjects:


prefix.installation_name.standardID.ERROR.

● JMS subject

prefix.installation_name.ERROR.

Use SmartRouting

No Select this check box to enable smart routing, and then provide anidentifier for the private process instance. Event sources that referencea shared resource can inherit the smart ID if you enable smart routingfor the event source. You can also override an inherited smart ID byproviding a different smart ID in the event source.

SharedSmart ID

No Select this check box to inherit the smart ID from the shared resourcedirectly into this event source. In this case, the event source uses thesame smart ID as the shared resource.

This check box is displayed only when you select the Use SmartRouting check box.

SmartRouting ID

Yes Type the required smart ID in this field to have a different smart ID atthe event source level . The messages are routed to this private processevent source.

This field is displayed only when you select the Use Smart Routingcheck box.

Description

In the Description tab, you can enter a short description for the ReceiveMiscMsg activity.

27


Advanced

In the Advanced tab, you can configure advanced settings.

The following table lists the configurations in the Advanced tab of the ReceiveMiscMsg activity:

Field Description

Sequence Key This field contains an XPath expression that specifies the order in which theprocess run. Process instances with sequencing keys that have the same value areexecuted sequentially in the order in which the process instances were created.

Custom Job Id This field contains an XPath expression that specifies a custom job ID for theprocess instance. This ID is displayed in the TIBCO Administrator View Servicedialog, and it is also available in the $_processContext process variable.

Conversations

In the Conversations tab, you can click Add New Conversation to initiate a conversation. Aconversation represents two or more related message exchanges in the same process that are correlatedby the BusinessWorks engine.

See TIBCO ActiveMatrix BusinessWorks Application Development for more details about how to useconversations.

Output

The Output tab lists output schema information. The schema that is displayed depends on the input ofthe message selected in the General tab for this activity.

Fault

In the Fault tab, you can find the error code and error message of the ReceiveMiscMsg activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the ReceiveMiscMsg activity:

Error Element Data Type Description

msg String Displays the error message.

msgCode String Displays the error code.

ReceiveRequest/NotificationYou can use the ReceiveRequest/Notification activity to process an incoming request/reply messageforwarded by the TIBCO BusinessConnect server, or to process an incoming notify message forwardedby the TIBCO BusinessConnect server.

The ReceiveRequest/Notification activity receives the messages that are published on the followingsubjects:


prefix.installation_name.standardID.RESPONDER.REQUEST

● JMS subject

28


prefix.installation_name.RESPONDER.REQUEST

General

In the General tab, you can establish a connection to a TIBCO BusinessConnect server, and configuresmart routing.

The following table lists the configurations in the General tab of the ReceiveRequest/Notificationactivity.



ServerDetails


OperationName

Yes Specify the pre-configured operations that are available for the protocolassociated with the server configuration.

Parse XMLPayload

Yes Select this check box to parse and validate the document in receivedmessages.

● Check box selected:

The document in the received message is parsed and validatedaccording to the corresponding schema defined for this B2Boperation.

● Check box cleared:

The XML document in the message is treated as a string. This isparticularly useful in cases where the document does not have to beprocessed or parsed immediately in the TIBCO BusinessConnectactivity.

If the Parse XML Payload check box is cleared, the event sources list awildcard (*) entry in the list. You can select this entry (*) to startreceiving multiple operations on the given event source instance,assuming that the operations belong to the same business protocol. Inthis case, no parsing or validation of the message happens at the eventsource level. If parsing or validation is required for the messages that arereceived on these wildcard listeners, a parse/validate task can be usedafter the event source.

Use SmartRouting

No Select this check box to enable smart routing, and then provide anidentifier for the private process instance. Event sources that reference ashared resource can inherit the smart ID if you enable smart routing forthe event source. You can also override an inherited smart ID byproviding a different smart ID in the event source.

29



SharedSmart ID



SmartRoutingID

No Type the required smart ID in this field to have a different smart ID atthe event source level. The messages are routed to this private processevent source.


Description

In the Description tab, you can enter a short description for the ReceiveRequest/Notification activity.

Advanced


The following table lists the configurations in the Advanced tab of the ReceiveRequest/Notificationactivity:

Field Description



Conversations



Output

The Output tab lists output schema information. The schema that is displayed depends on the input ofthe operation selected in the General tab for this activity.

Fault

In the Fault tab, you can find the error code and error message of the ReceiveRequest/Notificationactivity. See Error Codes for more detailed explanation of errors.

30


The following table lists error schema elements in the Fault tab of the ReceiveRequest/Notificationactivity:




ReceiveResponseYou can use the ReceiveResponse activity to receive a response to a request previously sent from theSendRequest/Notification activity.

The ReceiveResponse activity receives the messages that are published on the following subjects:


prefix.installation_name.standardID.INITIATOR.RESPONSE

● JMS subject

prefix.installation_name.INITIATOR.RESPONSE

General

The General tab contains the following fields.



ServerDetails


OperationName

Yes Specify the pre-configured operations that are available for theprotocol associated with the server configuration.

31



Parse XMLPayload

No Select this check box to parse and validate the document in receivedmessages.

● Check box selected:

The document in the received message is parsed and validatedaccording to the corresponding schema definition defined for thisB2B operation.

● Check box cleared:

The XML document in the message is treated as a string. This isparticularly useful in cases where the document does not need tobe processed or parsed immediately in the TIBCOBusinessConnect activity.

If the Parse XML Payload check box is cleared, the event sources list awildcard (*) entry in their drop-down list. You can select this entry (*)to start receiving multiple operations on the given event sourceinstance, assuming that the operations belong to the same businessprotocol.

In this case when no parsing or validation of the message happen atthe event source level, if parsing or validation is required for themessages that are received on these wildcard listeners, a parse/validate task can be used after the event source.

Use SmartRouting

No Select this check box to enable smart routing, and then provide anidentifier for the private process instance. Event sources that referencea shared resource can inherit the smart ID if you enable smart routingfor the event source. You can also override an inherited smart ID byproviding a different smart ID in the event source.

SharedSmart ID



SmartRouting ID

Yes Type the required smart ID in this field to have a different smart ID atthe event source level . The messages are routed to this privateprocess event source.


Description

In the Description tab, you can enter a short description for the ReceiveResponse activity.

Advanced


The following table lists the configurations in the Advanced tab of the ReceiveResponse activity:

32


Field Description



Conversations



Output

The Output tab lists output schema information. The schema that is displayed depends on the input ofthe operation selected in the General tab for this activity.

Fault

In the Fault tab, you can find the error code and error message of the ReceiveResponse activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the ReceiveResponse activity:




SendMiscMsgThe SendMiscMsg activity is provided for backward compatibility purposes only.

General

In the General tab, you can establish a connection to a TIBCO BusinessConnect server.

The following table lists the configurations in the General tab of the SendMiscMsg activity:


Name No The name to be displayed as the label for the activity in the process.

ServerDetails

Yes The BC Connection shared resource used to connect to the TIBCOBusinessConnect server.

33



MessageName

Yes Miscellaneous message types available for the selected protocol in thespecified BC Connection shared resource.

Description

In the Description tab, you can enter a short description for the SendMiscMsg activity.

Input

The Input tab lists input schema information. The schema that is displayed depends on the input of themiscellaneous message selected in the General tab for this activity.

Output

This activity requires no output.

Fault

In the Fault tab, you can find the error code and error message of the SendMiscMsg activity. See ErrorCodes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SendMiscMsg activity:




SendRequest/NotificationYou can use the SendRequest/Notification activity to send an outgoing request/reply message or anoutgoing 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 byusing the ReceiveResponse activity.

The SendRequest/Notification activity publishes messages on the following subjects:


prefix.installation_name.standardID.INITIATOR.REQUEST

● JMS subject

prefix.installation_name.INITIATOR.REQUEST

General


The following table lists the configurations in the General tab of the SendRequest/Notification activity:

34


Field

ModuleProperty? Description


ServerDetails


OperationName


Parse XMLPayload

No Select this check box to parse and validate the document in sentmessages.

● Check box selected

The document in the sent message is parsed and validated accordingto the corresponding schema definition defined for this B2Boperation.

● Check box cleared

The XML document in the message is treated as a string. This isparticularly useful in cases where the document does not need to beprocessed or parsed immediately in the TIBCO BusinessConnectactivity.

GenerateTransactionID

No Select this check box to generate the transaction ID regardless of what isprovided for the transactionID input item.

Don’t WaitforResponse

No Select this check box to make the activity not wait for a response fromthe TIBCO BusinessConnect server.

ResponseWait Time

No Specify the exact time for the activity to wait for a response, expressed inmilliseconds.

This field is displayed only when you clear the Don’t Wait forResponse check box.

Description

In the Description tab, you can enter a short description for the SendRequest/Notification activity.

Input

The Input tab lists input schema information. The schema that is displayed depends on the input of theoperation selected in the General tab for this activity.

● In TIBCO ActiveMatrix BusinessWorks 6, the message format of all binary type fields now supportsxsd:base64Binary(tib:string-to-base64). However, in TIBCO ActiveMatrix BusinessWorks 5,the format is tib:string-to-base64.

● This tab is protocol specific. For more information, see the documentation of a specific protocol.

35


Output

The Output tab lists output schema information.

This tab is protocol specific. For more information, see the documentation of a specific protocol.

Fault

In the Fault tab, you can find the error code and error message of the SendRequest/Notification activity.See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SendRequest/Notificationactivity:




SendResponseYou can use the SendResponse activity to send an outgoing response message to the local TIBCOBusinessConnect server.

The SendResponse activity publishes messages on the following subjects:


prefix.installation_name.standardID.RESPONDER.RESPONSE

● JMS subject

prefix.installation_name.RESPONDER.RESPONSE

General


The following table lists the configurations in the General tab of the SendResponse activity:



ServerDetails


36



Parse XMLPayload

No Select this check box to parse and validate the document in sentmessages.

● Check box selected

The document in the sent message is parsed and validated accordingto the corresponding schema definition defined for this B2Boperation.

● Check box cleared

The XML document in the message is treated as a string. This isparticularly useful in cases where the document does not have to beprocessed or parsed immediately in the TIBCO BusinessConnectactivity.

CustomRequest

No Specify whether operation names are pre-configured.

● If you select the Custom Request check box, you can select anoperation from the Operation Name list.

● If you clear the Custom Request check box, the request in theRequest Name list is ReceiveRequest by default.

OperationName


This field is displayed only when you select the Custom Request checkbox. If you select the Custom Request check box, you can select anoperation from the Operation Name list.

Only the Request-Response operations are populated for this activity.

RequestName

No Specify the request name.

If you clear the Custom Request check box, the request in the RequestName list is ReceiveRequest by default.

Description

In the Description tab, you can enter a short description for the SendResponse activity.

Input

The Input tab lists input schema information. The schema that is displayed depends on the input of theoperation selected in the General tab for this activity.

This tab is protocol specific. For more information, see the documentation of a specific protocol.

Fault

In the Fault tab, you can find the error code and error message of the SendResponse activity. See ErrorCodes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the SendResponse activity:

37





38


Managing Logs

When an error occurs, you can check logs to trace and troubleshoot the plug-in exceptions.

By default, error logs are displayed in the Console view when you run a process in debug mode. Youcan change the log level of the plug-in to trace different messages and export logs to a file. Different loglevels correspond to different messages, as described in Log Levels.

Log LevelsDifferent log levels include different information.

The plug-in supports the following log levels:

Log Level Description

Trace Includes all information regarding the running process.

Debug Indicates a developer-defined tracing message.

Info Indicates normal plug-in operations. No action is required. A tracing messagetagged with Info indicates that a significant processing step is reached, andlogged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

Warn Indicates that an abnormal condition occurred. Processing continues, but forbest practice, you can contact the administrator to investigate it.

Error Indicates that an unrecoverable error occurred. Depending on the severity ofthe error, the plug-in might continue with the next operation or might stop.

Setting Up Log LevelsYou can configure different log levels for the plug-in and plug-in activities to trace different messages.

If you do not configure any log levels, the plug-in uses the default log level of TIBCO ActiveMatrixBusinessWorks. The default log level is Error.

If neither the plug-in log nor the BusinessWorks log is configured in the logback.xml file, the errorlogs of the plug-in are displayed in the Console view by default.

If the plug-in log is not configured but the BusinessWorks log is configured in the logback.xml file, theconfiguration for the BusinessWorks log is implemented by the plug-in.

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe logback.xml file.

2. Add the following node in the BusinessWorks Palette and Activity loggers area to specify a loglevel for the plug-in:<logger name="com.tibco.bw.palette.bc.runtime"> <level value="DEBUG"/></logger>

The value of the level element can be Error, Info, or Debug.

39


If you set the log level to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. See Log Levels for more details regarding each log level.

3. Optional: Add the following node in the BusinessWorks Palette and Activity loggers area tospecify a log level for an activity:<logger name="com.tibco.bw.palette.bc.runtime.ActivityName"> <level value="DEBUG"/></logger>

For example,

● If you want to set the log level of the ReceiveMiscMsg, ReceiveRequest/Notification, andReceiveResponse activities to Debug, add the following node:<logger name="com.tibco.bw.palette.bc.runtime.ReceiveMiscMsgEventSource/ReceiveRequestNotificationEventSource/ReceiveResponseEventSource"> <level value="DEBUG"/></logger>

● If you want to set the log level of the SendMiscMsg, SendRequest/Notification, andSendResponse activities to Debug, add the following node:<logger name="com.tibco.bw.palette.bc.runtime.SendMiscMsgActivity/SendRequestNotificationActivity/SendResponseActivity"> <level value="DEBUG"/></logger>

● If you want to set the log level of the shared resource to Debug, add the following node:<logger name="com.tibco.bw.sharedresource.bc.runtime.BcConnectionSharedRecourceFactory"> <level value="DEBUG"/></logger>

The activities that are not configured with specific log levels use the log level configuredfor the plug-in.

4. Save the file.

Exporting Logs to a FileYou can update the logback.xml file to export plug-in logs to a file.

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe logback.xml file.

After deploying an application in TIBCO Enterprise Administrator, navigate to theTIBCO_HOME/bw/version_number/domains/domain_name/appnodes/space_name/

node_name directory to find the logback.xml file.

2. Add the following node to specify the file where the log is exported:<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-bwpluginbc.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The value of the file element is the absolute path of the file that stores the exported log.

3. Add the following node to the root node at the bottom of the logback.xml file: <appender-ref ref="FILE" />

<root level="DEBUG"> <appender-ref ref="STDOUT" />

40


<appender-ref ref="FILE" /></root>

4. Save the file.

41


Error Codes

The following table lists the log levels used by the software and the corresponding message code range.

Log Level Palette Error Code Shared Resource Error Code

TRACE 100000 - 109999 100000 - 109999

DEBUG 200000 - 209999 200000 - 209999

INFO 300000 - 309999 300000 - 309999

WARN 400000 - 409999 400000 - 409999

ERROR 500000 - 509999 500000 - 509999

The message describes the issue. Sometimes, the message can contain parameters shown as ({N}),where N is an integer. For example. consider the message for error code TIBCO-BW-PALETTE-BC-200002: Send Request: Activity Name {0} - Runtime Data {0}. These parameters aresubstituted with appropriate values at run time.

The following table lists error codes, detailed explanation of each error, and where applicable, ways tosolve different errors:

Error Code Error Message Solution

TIBCO-BW-PALETTE-BC-200002

Send request: Activity Name

{0} - Runtime Data {0}.

No action.


Send response: Activity Name


No action.


Send miscellaneous message:

Activity Name {0} - Runtime

Data {0}.

No action.


Receive request: Activity Name


No action.


Receive response: Activity

Name {0} - Runtime Data {0}.

No action.


Receive miscellaneous message:


Data {0}.

No action.


Receive error request:


Data {0}.

No action.

42




Receive error response:


Data {0}.

No action.


Receive error miscellaneous

message: Activity Name {0} -

Runtime Data {0}.

No action.


Send message error: Message

Context {0}.

Check the transportconfiguration of the BCConnection shared resource.


Request is not found: Activity

Name {0}.

Check the Request Name fieldof the SendResponse activity.


Failed to confirm message:

Message Details {0}.

Check the transportconfiguration of the BCConnection shared resource,and then check whether themessages have already beenconfirmed.


Failed to start the event

source: Message Details {0}.

Check the transportconfiguration of the BCConnection shared resource.


Failed to stop the event

source: Message Details {0}.

No action.


Receive error message:

Activity Name {0} - Rendezvous

or JMS Message Details {0}.

Check whether the BCConnection shared resource issynchronized withBusinessConnect, and thencheck whetherBusinessConnect operationsettings and operation schemaare correct.


Failed to construct schema

element.

Check the activityconfiguration. Make sure thatthe activity can generate theoutput schema correctly.


Missing <aeInfoList> element

in the shared configuration.

Do not use this protocol withthis activity.

TIBCO-BW-SR-BC-200002 Create shared resource

configurations: Runtime Data

{0}.

No action.

43



TIBCO-BW-SR-BC-200003 Delete shared resource

configurations: Runtime Data

{0}.

No action.

TIBCO-BW-SR-BC-200004 Start shared resource

configuration: Runtime Data

{0}.

No action.

TIBCO-BW-SR-BC-200005 Stop shared resource


{0}.

No action.

TIBCO-BW-SR-BC-200006 Update shared resource


{0}.

No action.

TIBCO-BW-SR-BC-200007 Create Rendezvous transport:

Shared Resource Name {0}.

No action.

TIBCO-BW-SR-BC-200008 Create JMS transport: Shared

Resource Name {0}.

No action.

TIBCO-BW-SR-BC-200011 Wrap message: Activity Name


No action.

TIBCO-BW-SR-BC-200012 Unwrap message: Activity Name

{0} - Received Rendezvous or

JMS Message {1}.

No action.

TIBCO-BW-SR-BC-200013 Send message: Activity Name

{0} - Sent Rendezvous or JMS

Message {1}.

No action.

TIBCO-BW-SR-BC-200014 Auto confirm message: Received

Rendezvous or JMS Message {0}.

No action.

TIBCO-BW-SR-BC-200015 Ignore confirm message:

Received Rendezvous or JMS

Message {0}.

No action.

TIBCO-BW-SR-BC-200016 Manual confirm message:


Message {0}.

No action.

TIBCO-BW-SR-BC-200017 Duplicate confirm message:


Message {0}.

No action.

TIBCO-BW-SR-BC-300001 Create shared resource: Shared

Resource Name {0}.

No action.

44



TIBCO-BW-SR-BC-300002 Delete shared resource: Shared

Resource Name {0}.

No action.

TIBCO-BW-SR-BC-300003 Start shared resource: Shared

Resource Name {0}.

No action.

TIBCO-BW-SR-BC-300004 Stop shared resource: Shared

Resource Name {0}.

No action.

TIBCO-BW-SR-BC-300005 Update shared resource: Shared

Resource Name {0}.

No action.

TIBCO-BW-SR-BC-300006 Attempting to reconnect to the

JMS server: Shared Resource

Name {0} - JNDI Context URL

{1}.

No action.

TIBCO-BW-SR-BC-300007 Reconnect to the JMS server

successfully: Shared Resource

Name {0} - JNDI Context URL

{1}.

No action.

TIBCO-BW-SR-BC-300008 Start the JMS or Rendezvous

transport: Shared Resource

Name {0}.

No action.

TIBCO-BW-SR-BC-300009 Stop the JMS or Rendezvous


Name {0}.

No action.

TIBCO-BW-SR-BC-300010 Dispatch Name {0} starts to

dispatch message: Shared

Resource Name {1}.

No action.

TIBCO-BW-SR-BC-300011 Dispatch Name {0} stops to

dispatch message: Shared

Resource Name {1}.

No action.

TIBCO-BW-SR-BC-400002 Exception happened when

getting Smart ID from JMS

message: Message Details {0}.

No action.

TIBCO-BW-SR-BC-500001 Error occurred when creating

shared resource: Shared

Resource Name {0}.

Check the BC Connectionshared resource configuration.

TIBCO-BW-SR-BC-500002 Error occurred when starting


Resource Name {0}.

Check the BC Connectionshared resource configuration.

45



TIBCO-BW-SR-BC-500003 Error occurred when stopping


Resource Name {0}.

No action.

TIBCO-BW-SR-BC-500004 Failed to initialize

Rendezvous: Shared Resource

Name {0}.

Check the Rendezvousconfiguration.

TIBCO-BW-SR-BC-500005 Error occurred when getting

B2B transport: Shared Resource

Name {0}.

Check the Rendezvous or JMSruntime status.

TIBCO-BW-SR-BC-500006 Error occurred when starting


Resource Name {0} - Unknown

Transport type {1}.

Change the BC transport type.

TIBCO-BW-SR-BC-500007 Error occurred when opening

Rendezvous: Shared Resource

Name {0}.

Check the Rendezvousconfiguration or Rendezvousinstallation.


Rendezvous Queue: Shared

Resource Name {0}.

Check the Rendezvousruntime or the Rendezvousinstallation.

TIBCO-BW-SR-BC-500009 Missing JMS Context Factory:


Specify a value in the JMSContext Factory field of theBC Connection sharedresource.

TIBCO-BW-SR-BC-500010 Missing JMS Context URL:


Specify a value in the JNDIContext URL field of the BCConnection shared resource.

TIBCO-BW-SR-BC-500011 Error occurred when loading

JMS trusted certificates:


Update the trusted JMS servercertificates.



Name {0}.

Check the JMS configuration.

TIBCO-BW-SR-BC-500013 JMS Server disconnected:

JMS_Name {0} - Exception [{1}:

{2}].

Check the network or JMSserver status.

TIBCO-BW-SR-BC-500014 Missing AE Schema: Shared

Resource Name {0} - AE Schema

Namespace {1}.

Re-import operations.

46



TIBCO-BW-SR-BC-500016 Missing Message Shared

Resource Name {1} in AE schema

{0}.

Change the protocol or updatethe plug-in to the latestversion.

TIBCO-BW-SR-BC-500017 Element {0} is not a complex

type.


TIBCO-BW-SR-BC-500018 Missing IO Schema {0} header. Change the protocol or updatethe plug-in to the latestversion.

TIBCO-BW-SR-BC-500019 Missing AE class Info data:

XML Element {0}.


TIBCO-BW-SR-BC-500020 Rendezvous Message Error {0}. Change the protocol or updatethe plug-in to the latestversion.

TIBCO-BW-SR-BC-500022 Find JMS Destination {0} Error

- Error Message {1}.

Configure the JMS server andcreate a related destination.

TIBCO-BW-SR-BC-500023 Create JMS Destination {0}

Error - Exception {1}.

Configure the JMS server andgrant permission of thecreating destination.

TIBCO-BW-SR-BC-500024 JMS transport is not available

for sending: JNDI Context URL

{0}.

Check the JMS server ornetwork.

TIBCO-BW-SR-BC-500025 Missing AE Class field

closure: Shared Resource Name

{0} - AE_Message_Name {1}.

Change a protocol or updatethe plug-in to the latestversion.

TIBCO-BW-SR-BC-500026 Time is up for reconnecting

attempts: Shared Resource Name

{0} - JNDI Context URL {1}.

Check the network or JMSserver after restartingapplications.

TIBCO-BW-SR-BC-500027 Failed to reconnect to the JMS

server : Shared Resource Name

{0} - JNDI Context URL {1}

cause by: Exception {3}.

Check the network or JMSserver status.

TIBCO-BW-SR-BC-500028 Register Preregistered CM

Queue Name {0} for Message {1}

failed: Exception {3}.

Check the Preregistered BCQueue Name field of theRendezvous configuration.

TIBCO-BW-SR-BC-500029 Failed to create Rendezvous

listener.

Check the Rendezvousconfiguration.

47



TIBCO-BW-SR-BC-500030 Failed to create JMS listener

session.

Check the JMS serverconfiguration or status.

TIBCO-BW-SR-BC-500031 Cause_By_Message {0}. Check the JMS serverconfiguration.

TIBCO-BW-SR-BC-500032 Error occurred when auto

confirm JMS Message: Exception

{0}.

Check the JMS server status ornetwork.

TIBCO-BW-SR-BC-500033 Received JMS Message Type

Error: Message_Java_Class_Name

{0}.

Update the plug-in to thelatest version.

TIBCO-BW-SR-BC-500034 Initialize JMS Connection

Error: Shared Resource Name

{0} - Exception [{1}: {2}].

Check the JMS configuration.

48


tibco activematrix businessworks™ plug-in for

Documents