TIBCO® BusinessWorks Process Design Guide

Software Release 5.2.1 May 2005

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 THE TIBCO BUSINESSWORKS CONCEPTS). 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, Information Bus, The Power of Now, TIBCO Rendezvous, TIBCO InConcert,TIBCO Administrator, TIBCO Adapter, and TIBCO BusinessWorks 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. Please 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. Copyright © 2001-2005 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii TIBCO BusinessWorks Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii Other Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Chapter 1 Getting Started With TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Welcome to TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Starting TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Starting the Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Startup Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 TIBCO Designer Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 TIBCO Designer Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Project Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Palette Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Design Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Configuration Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Customizing the Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Choosing Panel Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Choosing Palette Mode or Non-palette Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Palettes in a Separate Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Working With User Palettes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 13 15 17 17

Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 2 Managing Projects and Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Overview of Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Project Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using a Version Control System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Project Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 20 21 21

Creating Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
TIBCO BusinessWorks Process Design Guide

iv

| Contents
Validating Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Saving Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Saving a Project as a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Project Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Opening and Reopening Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Adding Resources To Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 If Adding a Resource Results in an Error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Deleting Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Tips and Tricks for Working With Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Chapter 3 Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Business Process Modeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 TIBCO BusinessWorks Solves Enterprise Integration Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Overview of Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Process Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Shared Configuration Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Subprocesses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Developing Process Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Chapter 4 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Activity Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Activity Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Mapping and Transforming Activity Input Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Process Starters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Misc Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Start Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 61 61 61

TIBCO BusinessWorks Process Design Guide

Contents v

|

End Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62 62 62 63 63

Chapter 5 Transitions and Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Creating a Transition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Chapter 6 Grouping Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Overview of Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Activity Output and Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Group Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 No Action Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Overview of Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Index Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Accumulate Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Iterate Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Iteration Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Repeat Until True Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Repeat On Error Until True Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Suspend If Still Error Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Critical Section Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Synchronization Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Usage Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Pick First Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Chapter 7 Working With Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Overview of Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Advanced Variables Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Changing Global Variable Values at Runtime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Process Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Activity Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Predefined Process Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Error Process Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 User-Defined Process Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Memory Usage of Process Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

TIBCO BusinessWorks Process Design Guide

vi

| Contents
Shared Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Job Shared Variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Shared Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning and Retrieving the Variable’s Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 101 101 101 103

Chapter 8 Mapping and Transforming Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Overview of Mapping and Transformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Data Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Activity Input Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping and Transforming Process Data to Activity Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Statements, Hints, and Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Buttons, Menus, and Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Toolbar and Right-Click Menu on the Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Icons for Schema Element Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Qualifier Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 106 107 107 108 108 108 111 112

Specifying Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Date and Datetime Strings in Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 Data Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Repairing Incorrect Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Shortcuts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Right-Click Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dragging to the Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cutting and Pasting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Examples of Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using XPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting an Element Explicitly to Nil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Merging Input from Multiple Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Converting a List Into a Grouped List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Merging Two Corresponding Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Coercions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XSLT Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Choose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copy-Contents-Of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Copy-Of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . For-Each . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . For-Each-Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 119 119 120 121 124 124 124 126 131 134 137 141 141 142 142 142 142 143 143 143 144

TIBCO BusinessWorks Process Design Guide

. . . . . . . . . . . . . . . . . . . . . . . . . Variable. . . . 162 Group Error Propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Called Process Error Propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 148 149 149 150 150 150 The XPath Formula Builder . . . . . . . . . . 144 144 144 145 145 Chapter 9 XPath . . . . . . . . . 164 Process Error Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Types of Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Date and Time Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 $_error Process Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . If . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Third-Party Transaction Managers . . . . . . . . . . . . . . . . 161 $_error_<activityName> Process Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing For Nil. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Evaluation Context . . . . . . . . . . . . . . . . . . . . . Namespaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transaction Recovery . . . . . . . . . . . . . . . . . . . . . . . 179 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Overview of Transactions . . . . . . . . . . . . . . . . . . 168 JDBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Java Transaction API (JTA) UserTransaction . . . . . . . . . Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring XA Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 XPath Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Chapter 11 Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Error Propagation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Configuring JTA UserTransaction Transactions . . . . . . . . . . . Value-Of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search Predicates . . . . . . . . . . . . . . 160 The Error Process Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents vii | Generate Comment . . . 151 String Representations of Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generate PI . . . . . . . . . . . . . . . . . . . 172 172 174 176 Nested Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Multiple JDBC Connections In Transaction Groups . . . . . . . . . . . . . . . . . . . Addressing Schema Elements . . . . . . . . . . . 169 Configuring JDBC Transactions . . . . . . . . 159 Overview of Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 XATransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Chapter 10 Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Overview of Inter-Process Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 1: Processing Orders As They Are Received . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Chapter 12 Process Instance Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 The Test Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Working With Process Instances . 195 196 196 197 198 Chapter 14 Testing Process Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Overview of Testing. . . . . . . . . . . . . . . . . . . . . . Specifying the Duplicate Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Specifying the Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 185 185 186 186 187 187 188 188 189 Logging for Third-Party Components . . . . . . . . . . . . . . . . . . . . Sequencing Process Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . Specific Protocol Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Colors in Test Mode . . . . . 194 Timeouts for Notify and Wait . . . . . . . . . . . . . . . 203 203 203 204 Stepping Through a Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Loading Processes to Test. . . . . . . . . . . . . . . . 193 Coordinating Inter-Process Communication . . . . . . . . . . . . . . . . . . . . . . Example 3: Handling Client Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiple Types of Incoming Events Resume a Running Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Database Storage for Wait/Notify/Receive Notification Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scalability With Incoming Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 2: Periodic Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Detecting Duplicate Process Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii | Contents Summary of Transactions . . . . . . . . . . . 206 Test Mode Buttons and Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enforcing Order for Process Execution . . . . . . . . . . . . . . . . . . . . . . . When to Perform Checkpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Process Instances During Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Handling Duplicate Messages . . . . . . . . . . . . . . . . . . . . . Process Engine Properties for Duplicate Detection . . . . . . . . . . . . . . . 192 Data for Inter-Process Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transactions and Duplicate Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Examples of Inter-Process Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Chapter 13 Inter-Process Communication . . . . . . . .

. . . . . . . . . Mail Properties . . . . . . . . 218 Visual SourceSafe Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features . . . . . . . . . . . . Using File Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Appendix B Custom Engine Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting XML Canon Projects. . . . . . . . Tips and Tricks . . . . . . . . . 238 Setting Custom Engine Properties in Deployed Projects. . . . . . . . . . . . . . . . . . . . . . . 240 Available Custom Engine Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Using Perforce . . . . . . . 213 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HTTP Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Icons Used by RCS Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Enabling TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO Hawk Properties . . . . . . . . . . . . . . . . JMS Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Access Rights on Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Revision Control Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites. . . . . . . . . . .Contents ix | Appendix A Working with a Revision Control System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . JDBC Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Deleting RCS Projects . . . . . . . . . . . . . . . . . . Preparing for File Sharing on Microsoft Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 Using Microsoft Visual SourceSafe . . . . 241 241 242 244 246 247 249 250 250 251 Appendix C TIBCO Hawk MicroAgent Methods . . . . . . . . . . . . . . . . . . . . . . . . 238 Setting Custom Engine Properties for the Testing Environment . 224 225 225 225 231 233 233 Tips and Tricks for Using Version Control Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Overview of Custom Engine Properties. . . . . . . . . . . . . . . . . Checking In and Acquiring Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Engine Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 216 216 216 Microsoft Visual SourceSafe . . . . . . . . . . . . . . . . . . . . . . . . 215 File Sharing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Perforce Fast Software Configuration Management System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Properties for Backwards Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preparing for File Sharing on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . 256 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . . . . . . Trace Properties . . TIBCO Rendezvous Advisory Messages . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ResetActivityStats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IsAllTracingEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KillAllProcesses . . . OnProcessRemoved . . . . . . . . . . . . GetProcessesExceptions. . . . . . . . . . . . . . . . . . . . . OnProcessActivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . getHostInformation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DelayedStopApplicationInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . stopApplicationInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ResumeProcessStarter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IsRoleEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ConfigureProcessStarterTracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetTraceProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetProcessStarters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .x | Contents TIBCO Hawk Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetProcesses . . . . . OnProcessStatusChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetExecInfo . . . . . . . . . . . . . . . . . . . . . . . ConfigureAllTracing . . . . . . . . . . . . . . . . . . . . . . . . . ConfigureActivityTracing . . . . . . SuspendAll. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ListTraceProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ConfigureRole . . . . . . . . . ListInstrumentProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ResumeProcess. . . . . . . GetActivities . . . . . . . KillProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IsProcessStarterTracingEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ListAllRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetProcessDefinitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ResetProcessDefinitionStats . SuspendProcessStarter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SuspendProcess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IsActivityTracingEnabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ResumeAll . . . . . . . . . . . . . . GetProcessCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . OnProcessAdded. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SetInstrumentProperty. . . . ConfigureUserDefinedTracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetStaticActivityInfo. . . . . . . . . . . . 256 256 257 259 259 261 262 264 264 265 265 266 266 267 267 268 268 268 269 269 270 270 271 271 272 272 272 273 274 274 275 275 276 277 277 277 278 278 279 279 280 280 280 281 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . . . . . . . . . . . . . . . _onUnsolicitedMsg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GetMemoryUsage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ListUserDefinedRoles . . . . GetStatus . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . 283 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents xi | Index . . . . . . . . . . .

xii | Contents TIBCO BusinessWorks Process Design Guide .

. . . . . . . . . . . . . . . . . . . . . 69 Minimizing and maximizing groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 The TIBCO Designer window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . non-palette mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Examples of mapping required. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 An invalid transition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 The three-panel view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 An example enterprise computing environment . . . . . . . . . . . . 9 Global variables in project panel . . . . . . . . and nillable elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Three-panel view with palettes selected . . . . . 4 Startup panel Administration options . . . . . . . . . 14 Layout options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 A newly created process definition. . . . . . . . . . . . . . . . . . . . . . . . 106 Mapper check and repair dialog . 74 Creating a process variable . . . . 40 Developing process definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 A business process flow of an example enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .| xiii Figures Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21 Figure 22 Figure 23 Figure 24 Figure 25 Figure 26 Figure 27 Figure 28 TIBCO Designer startup panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Valid transitions . . . . . optional. . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 An activity’s input tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Palette mode vs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 A process engine creating process instances . . . . . . . . . . . . 8 Project tree in the project panel . . . . . . . . 151 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 The XPath formula builder . . . . . . . . . . . . . . . . . 16 Adding a resource to a project . . . . . . . . . . 99 Assigning a value to a user-defined process variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Dragging to the left to change a hint to a statement . . . . . . . . . . . 10 Palette panel changed depending on current selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 The transition dialog. . . . . . . . . . . . . . . . . . . . . . . . 36 A main process calling a subprocess . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Setting a breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 Browse for an XML Canon category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 The Error Schemas tab . . . . . . . . . . . . . . . . . . . . . . . . . 227 XML Canon Check In Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 TIBCO BusinessWorks Process Design Guide . . . 153 A simple error-handling procedure . . . . . . . . . . . . . . . 219 Save Project Options for Perforce Version Control System . 223 XML Canon tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Example of process data for error schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 Set BreakPoints dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Multiple event sources to continue a process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv | Figures Figure 29 Figure 30 Figure 31 Figure 32 Figure 33 Figure 34 Figure 35 Figure 36 Figure 37 Figure 38 Figure 39 Figure 40 Figure 41 Figure 42 Figure 43 Figure 44 Figure 45 Figure 46 Figure 47 Figure 48 Figure 49 Figure 50 Figure 51 Figure 52 Creating an XPath formula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 The Generate Error Configuration tab . . . . 163 Propagating errors from a called process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Example of periodic processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Acquire failed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Multiple process instances in the test panel . . . . . . . 189 Example of handling incoming messages . . . . . . . . . . . . . . . . . . . . 202 Process instance stopped at a breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 A project checked into XML Canon. . . . . . . . . . . . . . . . . . . . . . . . . 166 Example order-entry system . . . . . . . . . . . . . . 202 The test panel . . . . . . . . . 204 Save Project Options for Microsoft VSS . . . . . . . . . . . . . . . . . . . 160 Propagating errors from a group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Ordering incoming events . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Toolbar icons for testing . . . . . . . . . 155 Example date and time format patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 JDBC transaction type . . . . . . . . . . 50 Content types for schema elements. . . . . . . . . . . . . . 208 Revision control system information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 XA transaction type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Activity icon elements. . . . . . . . . . . . . . . . . . . 180 JTA UserTransaction type . . . . . . . . . . . . . . . . . . . . . 52 Icons for schema datatypes . . . . . . . . . . . . . . . . . . . . . . . . 111 Additional icons for hints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 XPath formula builder elements . . . . . . . . . . . . . . 113 Datatype validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Formatting characters in date or time strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .| xv Tables Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 13 Table 14 Table 15 Table 16 Table 17 Table 18 Table 19 Table 20 Table 21 Table 22 Table 23 Table 24 Table 25 Table 26 Startup panel Project options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Effects of nesting transaction groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Actions on resources that are not locked . . . . . . . . . . . . . . . . . . . . . 6 Example activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Process starters . . . . . . . . . . . 235 Actions on locked resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Test panel icons . . . . . . . 109 Icons for schema items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Startup panel Administration options . . . . . . . . . . . . . . . . . . . . 235 TIBCO BusinessWorks Process Design Guide . . . . . . . . . . . . 181 Colors in test mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Activities with Event tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Input tab toolbar buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Group Configuration tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

xvi | Tables TIBCO BusinessWorks Process Design Guide .

page xix TIBCO BusinessWorks Process Design Guide . This manual describes how to create process definitions using TIBCO BusinessWorks. easy to deploy solution for companies looking to integrate their enterprise computing environment and automate their business processes. page xviii How to Contact TIBCO Customer Support. Topics • • Related Documentation.| xvii Preface TIBCO BusinessWorks is a standards-based.

• • • • • Other Documentation TIBCO BusinessWorks is bundled with other products. TIBCO Designer includes online help for each palette. and the other manuals in the documentation set assume you are familiar with the information in this manual. TIBCO Administrator is the monitoring and managing interface for new-generation TIBCO products such as TIBCO BusinessWorks. TIBCO Administrator documentation. TIBCO BusinessWorks Quick Start This manual steps you through a very simple example of designing. This document also contains lists of known issues and closes issues for this release. deploying. TIBCO BusinessWorks Installation Read this manual for information on installing one or more components of TIBCO BusinessWorks and setting up a TIBCO BusinessWorks domain. TIBCO BusinessWorks Palette Reference This manual describes each of the palettes available in TIBCO BusinessWorks. TIBCO BusinessWorks Error Codes This manual describes errors returned by TIBCO BusinessWorks. and monitoring a TIBCO BusinessWorks process. the following documents are part of the TIBCO BusinessWorks documentation set: • TIBCO BusinessWorks Concepts Read this manual before reading any other manual in the documentation set. This manual describes terminology and concepts of TIBCO BusinessWorks. TIBCO BusinessWorks Documentation In addition to this manual.xviii | Preface Related Documentation You may find the following documentation resources useful. TIBCO Designer is an easy to use graphical user interface for design-time configuration of TIBCO applications. TIBCO Adapter product documentation • • TIBCO BusinessWorks Process Design Guide . You will therefore find the documentation for those products useful: • TIBCO Designer documentation. TIBCO BusinessWorks Release Notes Read the release notes for a list of new and changed features.

TIBCO BusinessWorks Process Design Guide . visit this site: http://support.com Entry to this site requires a username and password.jsp • If you already have a valid maintenance or support contract. you can request one.com/services/support/default. If you do not have a username. and information about getting started with TIBCO Product Support. please contact TIBCO Support Services as follows. • For an overview of TIBCO Support Services. visit this site: http://www.tibco.tibco.How to Contact TIBCO Customer Support xix | How to Contact TIBCO Customer Support For comments or problems with this manual or the software it addresses.

xx | Preface TIBCO BusinessWorks Process Design Guide .

page 3 TIBCO Designer Administration. page 13 Documentation. you learn about creating and managing projects and working with global variables. page 6 Customizing the Display. page 18 TIBCO BusinessWorks Process Design Guide . Topics • • • • • • • Welcome to TIBCO Designer. you learn about TIBCO Designer basics. page 7 TIBCO Designer Administration. In this chapter. page 2 Starting TIBCO Designer. Product-specific information is available in the product-specific manuals. In the next chapter.|1 Chapter 1 Getting Started With TIBCO Designer TIBCO Designer is an easy to use graphical user interface for creating ActiveEnterprise integration projects. This chapter and the next give an introduction to TIBCO Designer that is product independent. You drag and drop components into a project and then specify configuration information for each component. page 6 TIBCO Designer Interface Overview.

TIBCO BusinessWorks Workflow uses TIBCO Designer for configuration of FormFlows processes and for preparing Enterprise Archive files. and easy to use integration platform that allows you to develop. • TIBCO BusinessWorks is a scalable. and a web-based GUI for monitoring and managing run-time components. • • • This chapter describes starting TIBCO Designer and explains the basic navigation model. such as an SAP R/3 applications or a database.. Depending on the product you installed. TIBCO BusinessWorks Process Design Guide . measure their efficiency. which are discussed in the TIBCO Designer Palette Reference.2 | Chapter 1 Getting Started With TIBCO Designer Welcome to TIBCO Designer TIBCO Designer allows you to easily create integration projects for your enterprise computing environment. use TIBCO Designer to create TIBCO BusinessWorks process definitions or create or modify adapter configurations. along with the ability to collaborate on the modeling and modification of the rules and flows that define business those activities. TIBCO Designer is available as a GUI (Graphical User Interface) to different TIBCO products and is used by those products for configuration. extensible. TIBCO Designer is used for adapter configuration. for example. and optimize them over time. and the TIBCO ActiveEnterprise environment. deploy. and run integration projects. Adapters are available as separate products. you can. TIBCO BusinessWorks Workflow gives companies the ability to coordinate business activities. Custom adapters are created using the TIBCO Adapter SDK. Adapters allow you to configure the interface between an external system. You can prepare an adapter configuration for custom adapters using the Adapter Resources and Adapter Schemas palettes. TIBCO Designer is the graphical user interface (GUI) for defining business processes. TIBCO BusinessWorks also includes an engine that executes the process. The product facilitates complete visibility into business activities.

TIBCO BusinessWorks). UNIX 1. See Startup Options on page 3. 2.g./designer 3. Startup Options When you launch TIBCO Designer. you may be able to access TIBCO Designer via the Start menu option for that product (e. Select one of the Startup Options. Select one of the Startup Options. Type .Starting TIBCO Designer 3 | Starting TIBCO Designer The following sections describe how to start TIBCO Designer and explain the options available once TIBCO Designer starts. See Startup Options on page 3. Starting the Program Start TIBCO Designer using the steps for the platform you are using. the startup panel is displayed: TIBCO BusinessWorks Process Design Guide . 2. Click Start>Programs>TIBCO>Designer_version If you have installed TIBCO Designer palettes for another TIBCO product. Windows 1. Navigate to the <tibco_core_home>/designer/<version>/bin directory.

TIBCO BusinessWorks Process Design Guide . By default when you open a new project.4 | Chapter 1 Getting Started With TIBCO Designer Figure 1 TIBCO Designer startup panel Table 1 describes the startup options. describes the options available when you select the Administration tab. Startup panel Administration options. TIBCO Designer prompts you immediately where you wish to save it. If you do not want to see this dialog each time you create a new project. Table 2. An empty project includes the TIBCO Designer default palettes and their resources. Table 1 Startup panel Project options Option New empty project Description Opens a new empty project in TIBCO BusinessWorks. You may provide the location or click the Cancel button. choose Edit>Preferences>General and unselect Show save dialog for new project.

this panel reappears when no other TIBCO Designer windows are open. Exit Show this panel only on startup Exits TIBCO Designer. A project template can be preconfigured to include all the resources you may need for a certain type of project such as. A project template is a pre-built project. May prompt for information. Note: You need to specify this path only once. and partially configured resources. Using a template makes it possible to leverage an existing configuration when creating new projects. After that. the startup panel is only displayed during startup and closed after you’ve made your selection. TIBCO Designer remembers the location even if you uninstall the current version and install a new version. See Opening and Reopening Projects on page 25. If checked. a password. Web Services configuration. Open existing project Reopen project Delete project Help Opens an existing project. configured resources. TIBCO BusinessWorks Process Design Guide . Leaving the panel on screen can be useful for project maintenance. See Deleting Projects on page 28. Allows you to delete a project. Displays TIBCO Designer documentation.Starting TIBCO Designer 5 | Table 1 Startup panel Project options Option New project from template Description Opens a predefined project template. Resources are the components of each project (see Resources on page 10). Information on browser locations on some operating systems is included in the prompt screen. You may be prompted for your browser if you are using TIBCO Designer for the first time on a machine. If unchecked. for example. Allows you to choose from a list of recently saved projects. See Saving a Project as a Template on page 24 for information on creating project templates. It can contain folders.

dat files are a legacy format.6 | Chapter 1 Getting Started With TIBCO Designer TIBCO Designer Administration When you start TIBCO Designer. the startup panel allows you to open projects (see Startup Options on page 3). TIBCO BusinessWorks Process Design Guide .dat file you wish to convert and the folder for the multi-file project. you must convert to a multi-file project before you can open a project from TIBCO Designer. Because . When you select the Administration tab. You can also use the startup panel to perform some TIBCO Designer administrative tasks. the panel presents the choices shown in Figure 2: Figure 2 Startup panel Administration options Table 2 Startup panel Administration options Option Convert DAT to files Description Displays a dialog that lets you specify the .

TIBCO Designer converts the multi-file project in the directory to the . See TIBCO Designer User’s Guide for more information.dat file. You have these options: • Extended Class Path—classpath to be used by TIBCO Designer.TIBCO Designer Interface Overview 7 | Table 2 Startup panel Administration options Option Convert files to DAT Configure preferences Configure runtime Description Displays a dialog that lets you choose a project directory and a . This section describes the TIBCO Designer main window and explains what you see in each of its panels. Command Line Arguments—Allows command line arguments to be passed to Designer. If they specify directories then all . Currently -d (debug) is supported.jar files will be loaded. If you specify -d. The order in which they are loaded depends on the file system. User Directory—Default location for the application to store files. Maximum Heap Size—Maximum JVM heap size. When you specify both.dat file. the log that is sent to the Console becomes more detailed.class. Users can specify file names or directories. TIBCO BusinessWorks Process Design Guide .zip and . • • • • TIBCO Designer Interface Overview The TIBCO Designer interface allows you to perform various functions. . Palette Path—Location from which TIBCO Designer loads palettes. Displays the Preferences dialog. Allows you to configure the TIBCO Designer runtime environment.

8 | Chapter 1 Getting Started With TIBCO Designer Main Window Figure 3 illustrates the TIBCO Designer window. Tabs in the leftmost area allow you to change what is displayed in the panel. See Customizing the Display on page 13. See TIBCO Designer User’s Guide. • Four panels. This helps you see at one glance where the focus is. the panel is highlighted. Toolbar icons. When you select an item in the design panel or the configuration panel. See TIBCO Designer User’s Guide. TIBCO BusinessWorks Process Design Guide . Figure 3 The TIBCO Designer window Menu bar Toolbar Tabs Design panel Project panel Palette panel Configuration panel The TIBCO Designer window has these components: • • • Menu bar and Menus. which are (starting in the top left corner and continuing clockwise): — Project panel (can display the project tree or the project’s global variables) — Design panel — Configuration panel — Palette panel You can rearrange the panels and what they display. the project panel and palettes can be combined to share one set of tabs. See Customizing the Display on page 13 for more information. For example.

By default. Project Display With the Project tab selected. See Global Variables on page 94 for more information. ProcessNewComputer. To display them. any business logic that may be applied to that information. the panel may be used for other purposes. in conjunction with the TIBCO BusinessWorks tester. When used in conjunction with other project. The hierarchy of folders and resources corresponds to the hierarchy of folders and files in the project folder. click the Global Variables tab of the project panel. in the project panel. This includes services (producers and consumers of information). the project panel displays the project tree. Figure 4 illustrates an example project. the project panel allows you to view the Project Display or Global Variables Display. and deployment information. Figure 4 Project tree in the project panel ProcessNewComputer project Global Variables Display Global variables are associated with each project. Project Panel A project contains resources that implement the enterprise integration. TIBCO BusinessWorks Process Design Guide .TIBCO Designer Interface Overview 9 | The following sections explain the contents of each panel. Multiple TIBCO products were used to create the integration project — it contains two TIBCO BusinessWorks process definitions (ProcessOrder and ProcessSoap) and a Siebel adapter (SBLAccount). This includes the top-level (root) folder and the hierarchy of resources. for example.

TIBCO BusinessWorks Process Design Guide . Resources can be complex and contain other resources. Each top-level resource (for example. an adapter service. such as an adapter configuration. each adapter configuration) corresponds to a file in the hierarchy of files in the project directory. A simple TIBCO Designer resource corresponds to an object in a TIBCO application. or an FTP activity. a process definition. For example.10 | Chapter 1 Getting Started With TIBCO Designer Figure 5 Global variables in project panel Resources Resources are the components of a project. This design allows developers to use a source control system and to check out only the top-level resources they are working with from a source control system. an adapter configuration may contain multiple folders with multiple publisher or subscriber service resources. thus sharing their work. much like a folder can contain other folders on your computer's file system.

TIBCO BusinessWorks Process Design Guide . You select resources in the palette panel and drag and drop them into the design panel to add them to your project. In addition. Right-click on the resource and choose What Is This? from the popup menu for more information on configuring the resource. Which palettes are displayed depends on: • • • the installed TIBCO products the resource selected in the project tree your preferences (see Customizing the Display on page 13) Current Selection and Palette Panel Display When the default view is set as your view preference. This can mean. the current selection in the project tree determines which palettes are displayed in the palette panel. it displays it as a special icon. source control systems may hide files from the user. TIBCO Designer contains a small number of native palettes. each TIBCO application you install adds one or more palettes during installation. that the palette for that resource is not installed. or that it has a misleading extension. for example. that the file is not really part of your project. If you open a Designer project that was under source control without the revision control system. these files will become visible and treated as unknown resources.TIBCO Designer Interface Overview 11 | Most resources have context-sensitive help available for the configuration of that resource. Palette Panel Palettes organize resources and allow you to add them to your project. For example. If TIBCO Designer cannot determine the type of a resource.

You can change your view preferences to change what’s displayed in the palette panel. For resources that contain other resources.12 | Chapter 1 Getting Started With TIBCO Designer Figure 6 Palette panel changed depending on current selection Top-level folder selected Adapter Services folder selected For example: • • Select the top-level project folder to see a palette for each adapter and some other palettes for general resources. its contents is displayed. if you select a folder. The tabs organize the configuration options for the resource. Usually there are one or more tabs in the configuration panel that allow you to access the various configuration options. Drag any service resource into the design panel to add that resource to that adapter. Select the Adapter Services folder of an adapter in the project tree to see a palette of service resources. Design Panel The design panel displays the current resource selected in the project panel. the contents of the selected resource are shown in the design panel. For example. You can click the question mark (?) in the top right corner of the configuration panel for online help on the current selection. TIBCO BusinessWorks Process Design Guide . See Customizing the Display on page 13 for more information about how TIBCO Designer functions in palette mode. The type and the purpose of the selected resource determine the contents of the configuration panel. Configuration Panel The configuration panel allows you to specify various configuration options for each resource.

TIBCO BusinessWorks Process Design Guide . even if you do not save your project. This section gives an overview of the most frequently used display preferences. Display preferences are maintained for each user. you must click the Apply button for each tab. but not both in the left panel. Display preferences and other preferences are saved when you exit TIBCO Designer. you can set TIBCO Designer to display the three-panel view shown in Figure 7. select Edit > Preferences and click Restore Default Settings. even if that user completely uninstalls the product and installs a different version. Choosing Panel Layout If you prefer to view either the project tree or the palette panel. click Reset before you apply any changes to return to the previous values for each field in the tab. Customizing the Display You can customize how TIBCO Designer displays panels and palettes. If you decide you do not want to add the configuration information.Customizing the Display 13 | After you have added the configuration information. To return to the default settings.

click the Palettes tab on the left (see Figure 8). 2. To navigate to palettes in this view. Figure 8 Three-panel view with palettes selected Select Palettes TIBCO BusinessWorks Process Design Guide . Choose Edit>Preferences>View.14 | Chapter 1 Getting Started With TIBCO Designer Figure 7 The three-panel view Project panel Design panel Configuration panel To choose the three-panel view: 1. Under Layout. select the appropriate icon and click OK. The next diagram shows the results of this action.

Figure 9 Layout options Choosing Palette Mode or Non-palette Mode TIBCO Designer allows you to change the palette panel display to use palette mode or non-palette mode.Customizing the Display 15 | Additional layout options are available when you choose Edit > Preferences > View. each resource is shown in the palette it belongs to. • • In palette mode. In non-palette mode. unusable resources are grayed out. and only currently usable resources are displayed. TIBCO BusinessWorks Process Design Guide . In that case. and each palette shows all resources. resources are displayed directly in the panel. Figure 10 illustrates the palette panel in palette mode and non-palette mode.

TIBCO BusinessWorks Process Design Guide . non-palette mode Palette mode All resources display in each palette Non-palette mode Only currently usable resources display Close box To switch palette modes: • Choose Palettes>Options>Switch Palette Modes or • Click the Switch Palette Modes button located in the tool bar.16 | Chapter 1 Getting Started With TIBCO Designer Figure 10 Palette mode vs.

Displaying Palettes in a Separate Window You can display the palette panel in a separate window by choosing Palettes > Options > Show Palettes in New Window. 3. if you closed the Adapter Resources palette.Customizing the Display 17 | While in palette mode. When you later save your project. the palette is saved to the location specified by the User Palette Directory General Preference. Choose Palettes > My Palettes > New Palette. To redisplay a closed palette. choose Palettes. For example. Drag resources from the project tree or from the design panel into the user palette. follow these steps: 1. Specify the name of the palette. choose Palettes > General > Adapter Resources to redisplay it. You can also access this menu command from the right-button menu of any palette in the palette panel. If Close markers are not visible. 2. then select the palette either from the top-level menu or from the submenu. close the separate window in which the palette panel is displayed. Creating User Palettes To add a user palette. you can close individual palettes using the Close marker (X) on the right. choose Palettes > Options> Show Close Boxes. TIBCO BusinessWorks Process Design Guide . Working With User Palettes User palettes allow you to save a collection of resources to a predefined location and either share it with other users or use it yourself at a later time. To restore the palette panel to its location in the main window.

Location information for many operating systems is included in the prompt. When you save your project. you can use the Start menu to access TIBCO Designer documentation. 2. Loading User Palettes To load a user palette that was previously created. Make sure the palette is loaded. Palette Directory Documentation Documentation for TIBCO BusinessWorks is available in several ways: • • If you are using Microsoft Windows. 2. the custom palette is then saved to the location specified by the User Palette Directory General Preference. When you invoke Designer help for the first time. From TIBCO Designer: — Use Help > Designer Help at any time to view this manual. you can also choose the Help button for online help. You only need to supply this location once. Deleting User Palettes To delete a user palette. Choose Palettes > My Palettes > Reload Palettes. which discusses how to use TIBCO BusinessWorks regardless of the application you are building. Place the palette in the directory specified by the User General Preference. you are prompted for the location of the HTML browser. If information is displayed in the Configuration panel. — Use Help > Help For to access the product-specific documentation.18 | Chapter 1 Getting Started With TIBCO Designer 4. follow these steps: 1. — Right click on most resources and choose the What Is This? menu item to view specific help for that resource. Choose Palettes > My Palettes > Delete Palettes. You are prompted for the palette(s) you wish to delete. TIBCO BusinessWorks Process Design Guide . follow these steps: 1.

page 21 Validating Projects. This chapter explains how to manage projects and the resources inside them. page 20 Creating Projects. page 23 Opening and Reopening Projects. page 28 Tips and Tricks for Working With Projects. page 29 TIBCO BusinessWorks Process Design Guide . Topics • • • • • • • • Overview of Projects. page 25 Adding Resources To Your Project. page 22 Saving Projects. page 26 Deleting Projects.| 19 Chapter 2 Managing Projects and Resources Projects are the key organizational principle for the configuration information you specify with TIBCO BusinessWorks.

For adapters. that may mean one file per activity. TIBCO Designer creates a hierarchy of folders and files in the location you choose for the project. Directories in the file system become folders in TIBCO Designer. not all folders in TIBCO Designer are directories in the file system: — Folders created from a Folder resource in the General Palette (displays a multi-folder icon) become folders in the file system. Each TIBCO Designer window contains only one project. For TIBCO BusinessWorks. these resources define the configuration of your integration project. be sure no other files reside in that folder. Adapter Services data is stored in the Adapter Configuration file. • • TIBCO BusinessWorks Process Design Guide .20 | Chapter 2 Managing Projects and Resources Overview of Projects A project is a collection of resources. The actual data for these elements is stored in the file of the top-level resource. When you create a multi-file project: • There is one file per top-level resource. The project root directory identifies the project. such as the Adapter Services folder inside an adapter configuration are logical folders. In the TIBCO BusinessWorks window. the startup panel remains available for project maintenance or for opening a different project unless you selected the Display this window only on startup check box on that window. more resources may be considered part of a top-level resource. TIBCO Designer opens a new window. Together. For example. a project is represented by the top-level (root) folder in the project panel. Project Structure When you save a project. The top-level folder is initially named Untitled and is renamed to the name of the project when you save the project for the first time. These folders only exist in memory in the resource that holds them. However. — Other folders. When you supply a project location. The project root can be located anywhere in the file system and is determined when you first save the project. adapter resources and process definitions. When you close a project. If you open a second project. All components of a project are located under this common project root. including for example. TIBCO Designer removes any existing files before placing the project files into the folder.

Creating Projects You create a new project using the startup panel when starting TIBCO BusinessWorks. Using a Version Control System Multi-file projects support the use of different version control systems because they consist of separate files for each versionable component. and description. configured resources. TIBCO BusinessWorks allows you to create a new. TIBCO Rendezvous encoding. TIBCO BusinessWorks Process Design Guide . you can leverage your work when performing similar configurations. This file can be used for identification in place of the project root directory and can be used as the repository locator string (repoUrl).dat in the project root directory when you first save the project. In that case. standard version control system tools can be used. This file is used to store properties such as display name. Once the root directory is defined under the control of a version control system.Creating Projects 21 | • TIBCO Designer creates a file named vcrepo. You can also choose Project > New Project from the TIBCO Designer menu bar with TIBCO Designer already open. Using a template. Project Templates A project template is a pre-built project. and partially configured resources. blank project or to create a project based on an existing template. TIBCO Designer opens a new window for the new project. The following version control systems are supported and discussed separately: • • • File Sharing on page 216 Microsoft Visual SourceSafe on page 218 Perforce Fast Software Configuration Management System on page 221 Support for other version control systems will be provided in future releases. You can use a project template as the foundation for other projects similar in nature. It can contain folders for organization.

See Project Templates on page 21. you are by default prompted immediately to save it. hand it to another user. See Validating Projects on page 22 for some additional information on the behavior of resources included with TIBCO Designer by default.22 | Chapter 2 Managing Projects and Resources • New Empty Project — A new project contains a single AESchemas folder that will be used for adapter schema resources. • When you create a new project. See Saving Projects on page 23 for a discussion of the information you must supply. To validate resource. you add resources to it and supply configuration information for your resources. do one of the following: • • Select the resource to be validated. then choose Resources > Validate Resource from the menu bar. choose the Validate icon. Many resources have other resource-specific validation behavior. TIBCO BusinessWorks Process Design Guide . Click the Validate Project icon. Before you save a project. During validation. etc. To validate all resources in a project. Validating Projects After you have created a project. TIBCO Designer includes reference-checking and other validation facilities that allow you to make sure a project is internally consistent. you can later load that template and customize it to create a new project. each resource always checks for broken references. This is essential if you intend to run the project. See Project Structure on page 20 for more information. Project from Template — When you save a project as a template (Project > Save As Template). do one of the following: • • Choose Project > Validate Project for deployment. it is critical that you validate it. With the resource selected.

Warning: Designer will remove any files in this directory when you save the project. however. TIBCO BusinessWorks Process Design Guide . In the main window. for example. possible to have "broken" references. for example. make sure the Multi-File selected and provide the following information: Project Directory Project tab is Directory that will contain the project files. follow these steps: 1. In the dialog that is displayed. Saving Projects To save a project. and so forth). rename. Click Browse to select the directory. — Choose Project>Save As and specify the storage directory. if you delete a resource and ignore the warnings displayed by TIBCO Designer.Saving Projects 23 | Note that TIBCO Designer handles references as strings. — Click the Save icon. when you move a resource to a different location. 2. You can change the default behavior using the Edit>Preferences >References tab. You can use the validation commands to find broken references. It is. do one of the following: — Choose Project>Save. TIBCO Designer will help keep these references up to date. By default. TIBCO Designer prompts whether you wish to perform reference checking each time you perform an activity that might result in a broken reference (move.

Project Settings Once you have saved a project to a repository. This includes most languages. Choose Project>Save As Template. • Note: After deployment. and so on). The communication transport could be either TIBCO Rendezvous or TIBCO Enterprise for JMS. Multi-User System Allows you to use a multi-user system such as file sharing. data loss may result. this encoding will be superseded by the encoding setting of the TIBCO Administration Server. If this encoding is used for languages that do not belong to the Latin-1 character set (such as Japanese. Click OK. Perforce. or if the project is running as a legacy local file-based project. you can select the Project Settings tab to: TIBCO BusinessWorks Process Design Guide . Provide the appropriate information. Arabic.24 | Chapter 2 Managing Projects and Resources Message Encoding Character Encoding used for the communication between TIBCO product components in this project at design time (debug mode). 2. follow these steps: 1. 3. See Working with a Revision Control System on page 213 for more information. Saving a Project as a Template To save a project as a template. which is the same as discussed in Saving Projects on page 23. except for English and western European languages. UTF-8—The preferred encoding for projects dealing with languages that do not belong to the Latin-1 character set. or Visual SourceSafe. You have two choices: • ISO8859-1 (Latin-1)—Should be used for projects that deal only with English and other Western European languages that belong to the ISO Latin-1 character set.

you need to provide the appropriate information. See Appendix A. If this encoding is used for languages not belonging to the Latin-1 character set (such as Japanese. You have two choices: — ISO8859-1 (Latin-1). If you are opening a project under a version control system. 2. Supply the name of the project directory when prompted. These include almost all the languages except for English and western European languages.Opening and Reopening Projects 25 | • • View information about the project. In that case. Choose Project>Open from the TIBCO BusinessWorks main window if Designer is already open. choose DAT to Files. it may result in data loss in the data communication among TIBCO components. The preferred encoding for projects dealing with languages not belonging to the Latin-1 character set. Arabic. You can then open the multi-file project from TIBCO Designer. Opening and Reopening Projects You can open a project in two ways: • • From the startup panel when you launch TIBCO BusinessWorks. The information displayed depends on how the project was saved. or when the project is running as a legacy local file-based project. TIBCO Designer will create a new window for your project. This is only used in design mode. You can reopen a project you opened recently in two ways: TIBCO BusinessWorks Process Design Guide . and so on). This should be used for projects that deal only with English and other western European languages that belong to ISO Latin-1 character set. After deployment. Working with a Revision Control System. In the Startup panel. — UTF-8. this encoding setting is superseded by the encoding settings of TIBCO Administration Server.dat project. you must convert it first: 1. If you need to open a . View and change the project’s messaging encoding for the data communication among the components in this project.

Select the palette in which the resource can be found. 2. you first select it in the palette panel. TIBCO BusinessWorks Process Design Guide . TIBCO Designer will create a new window for your project Adding Resources To Your Project Once you have created or opened a project. follow these steps: 1. If the palettes are not visible in your palette panel. To add a resource to your project. Figure 11 illustrates adding a resource to a project. Select a resource in the palette and drag and release it in the design panel.26 | Chapter 2 Managing Projects and Resources • • From the startup panel when you launch TIBCO BusinessWorks. Choose Project>Reopen from the TIBCO BusinessWorks main window if Designer is already open. For example. click the Switch Palette Modes icon. you can add resources to your project. The resource instance is displayed in the design panel and also added to your project tree. In that case. The configuration panel allows you to specify configuration information for the resource. you find an adapter configuration resource in the palette named after the adapter. then drag and drop it into the design panel. To add a resource.

If you try to add a resource that cannot be added to the current resource. In the design panel.Adding Resources To Your Project 27 | Figure 11 Adding a resource to a project Drag into design panel You can also add resources in other ways: • • In the palette panel. select the resource and choose Add This To The Project from the right-button menu. TIBCO BusinessWorks Process Design Guide . an error results. choose Add Resource from the right-button menu and choose the appropriate submenu. If Adding a Resource Results in an Error Whether adding a resource is possible depends on what is currently displayed in the design panel.

— For File Sharing. If any other resource is displayed. 2. Usually.28 | Chapter 2 Managing Projects and Resources For example. Click Delete Project. You must also be sure to specify a user that has appropriate privileges for deleting the project. close all windows. To delete such a project. — For other version control systems you must make sure that both the (local) project directory and the directory you specify for the version control system are correct. all resources that cannot be dragged into the design panel should be greyed out (palette mode) or not visible (non-palette mode). choose the Administration tab. start it. If TIBCO Designer is running. any user with access to a project can delete the project. Specify a version control system if the project was used in conjunction with a version control system. The startup panel is displayed unless Show this panel only on startup has been checked. Deleting Projects You do not delete projects from the TIBCO Designer main window but from the startup panel. To access the startup panel: • • If TIBCO Designer isn’t running. To delete a project. if the root folder is displayed in the design panel. However. Specify the project directory b. you can add an adapter instance. You cannot delete projects based on XML Canon from TIBCO Designer. you must use a WebDAV client. some custom palettes do not conform to this rule. In the startup panel. follow these steps: 1. In the panel that appears: a. TIBCO BusinessWorks Process Design Guide . you cannot add the adapter instance. 3.

you do so at your own risk. Avoid naming collision. place schema files under /AESchemas when possible. See Global Variables on page 94 for more information. Each group has its own file in the multi-file project. union. class. Use Global Variable groups to allow multiple developers to work on global variables simultaneously. The project root folder name corresponds to the project name. • Use ASCII project names. Do not place a multi-file project and a single-file project into the same directory. and a project name must use ASCII. and so forth). Note. that an excessive amount of global variables (over 500) can lead to problems. ALso. • • TIBCO BusinessWorks Process Design Guide . you must place schema files into /AESchemas if you wish to edit your project using TIBCO Designer. however. For simplicity. scalar. Place schema in the AESchemas folder. Note that while editing schema files is not prohibited. the schema are placed in a directory called __NON__DEFAULT__SCHEMA__FOLDER__ in /tibco/public/<type> where type is the kind of object (that is. • Consider using global variable groups. Use an ASCII name for the project when saving the project from TIBCO Designer. If you edit your project file in an XML editor and define schema outside the /AESchemas folder.Tips and Tricks for Working With Projects 29 | Tips and Tricks for Working With Projects This section contains additional information on using multi-file projects.

30 | Chapter 2 Managing Projects and Resources TIBCO BusinessWorks Process Design Guide .

page 32 Overview of Processes. page 34 Process Definitions. page 38 Shared Configuration Resources. Topics • • • • • • • • • Business Process Modeling. This chapter describes how to create business processes in TIBCO BusinessWorks. page 38 Subprocesses. page 36 Transitions. page 35 Activities. page 40 TIBCO BusinessWorks Process Design Guide .| 31 Chapter 3 Processes TIBCO BusinessWorks allows you to graphically model your business processes and execute them automatically. page 39 Developing Process Definitions. page 37 Groups.

the flow of information and processing between each application is what drives the day-to-day operations of the business. Figure 12 An example enterprise computing environment Inventory Order Entry Shipping Manual Data Transfer Reporting Tracking TIBCO BusinessWorks Process Design Guide . In a typical enterprise. accurate and up-to-date reporting information is required from all systems.32 | Chapter 3 Processes Business Process Modeling Most businesses choose the best application or environment for processing each component of their core business. Also. The tracking system relies on order information and shipping information. For example. the order-entry application receives and processes orders based on availability information taken from the inventory system. Figure 12 illustrates an example enterprise computing environment with various systems running in different environments.

because the task of creating the custom business logic is so complex. That tool should also allow you to automate your business processes for the greatest efficiency.Business Process Modeling 33 | Many companies implement the business rules that tie the systems together using custom-written code or by manual processes. These business rules in themselves can involve complex processing and automating these processes is crucial to lowering the total cost of operating the complete enterprise environment. Figure 13 A business process flow of an example enterprise Order Entry IF available. TIBCO BusinessWorks Process Design Guide . sometimes known as a workflow. tracking. such as the REPORT SHIPPED ORDER STATUS process in the shipping system. Figure 13 illustrates a business process flow. paper-based processes instead of automating the process for greater efficiency. shipping. TIBCO BusinessWorks Solves Enterprise Integration Problems An ideal solution for handling business process automation would be a tool that can handle the different environments and applications and allow you to create programmatic business rules easily. inventory. THEN IF credit check approved. that describes the business rules between the various systems in an enterprise. These rules are characterized by business processes. businesses often rely on manual. and reporting systems. THEN PROCESS ORDER ELSE HOLD ORDER ELSE DENY ORDER ELSE RESTOCK INVENTORY REPORT ORDER STATUS Inventory WHEN qty < 5 of prod_id 798 RESTOCK INVENTORY PROCESS INVENTORY CHECK REPORT INVENTORY STATUS Shipping WHEN orderIDStatus == complete SHIP ORDER REPORT SHIPPED ORDER STATUS Tracking CHECK ORDER STATUS CHECK INVENTORY ITEM STATUS Reporting GET SHIPPED ORDER REPORT GET INVENTORY REPORT GET REVENUE REPORT GET UNUSED INVENTORY REPORT The business process flow describes an integrated enterprise that contains order-entry. Tying together different systems from different vendors that run in different environments is a labor-intensive and error-prone process that usually takes months of planning and implementation. Each of these systems have rules for processing incoming data and more rules for passing data between the systems. Also. THEN IF priority order.

and process instances. You can use the BusinessWorks process definition palette to diagram complex business logic easily. This allows you to reduce the time to implement an integrated. BusinessWorks can help you specify the business logic and automate the processing of the interaction between the systems in your enterprise. Once the business rules have been specified. You develop and test process definitions using TIBCO Designer. enterprise-wide computing environment and ultimately lower the cost of deploying and maintaining the system. The process definition is executed by a TIBCO BusinessWorks process engine. BusinessWorks can execute the business processes. allowing you to easily automate the critical functions of your business. These process instances automate your business processes by executing the business process described by the process definition. TIBCO BusinessWorks Process Design Guide . Figure 14 illustrates the relationship between process definitions. Overview of Processes A process definition is the graphical representation of your business process. A process engine creates instances of process definitions.34 | Chapter 3 Processes TIBCO BusinessWorks allows you to model business processes with a graphical tool. a process engine.

The design panel displays the business process model. Process Definitions A process definition is a graphical representation of your business process model. Newly created process definitions contain a Start activity and an End activity.Process Definitions 35 | Figure 14 A process engine creating process instances Machine A TIBCO Designer Project Process Definition A TIBCO BusinessWorks Process Engine Process Instance A-1 Process Instance A-2 Process Definition B Process Instance B-1 Process Instance B-2 Process Instance B-3 Process engines are started using TIBCO Administrator after you deploy your project. see the TIBCO Administrator User’s Guide. For more information about deploying a project. Figure 15 illustrates a newly created process definition. TIBCO BusinessWorks Process Design Guide . Selecting the process definition in the project panel changes the palette panel and the design panel to allow you to create your business process model. The palette panel contains a set of activity palettes for use in the process definition. The remainder of this manual describes how to create the process definitions that eventually become running process instances. You create process definitions by dragging and dropping a Process Definition resource from the Process palette to the design panel.

Activities are available on the various palettes in TIBCO Designer. Process definitions consist of these components: • • • • • Activities Transitions Groups Shared Configuration Resources Subprocesses The following sections describe these components. the Adapter palette has activities that can publish messages to a specified adapter or invoke an operation by way of an adapter. For example. Activities Activities are the individual units of work in a process definition. See Developing Process Definitions on page 40 for a description of how to develop your process definitions. but activities can also perform internal processing. TIBCO BusinessWorks Process Design Guide . it is known as a process instance. Activities are generally operations that interface to external systems. There is also an FTP palette that can invoke the PUT and GET commands on an FTP server. Each palette has a set of activities that can be performed for that palette. When the process definition is executed.36 | Chapter 3 Processes Figure 15 A newly created process definition The process definition describes the business process.

A transition is represented by an arrow between two activities. You can have transitions from one activity to many other activities. Control flow in a process definition must proceed sequentially beginning with the Start activity (or a process starter) and ending with the End activity. begin a process when the specified event occurs. The condition determines if the transition is taken when an activity completes processing. all transitions whose conditions are met are taken. A transition can optionally specify a condition. Process execution is controlled by the process engine. The arrows are unidirectional. TIBCO BusinessWorks Process Design Guide . also known as process starters. you can have several branches of activity processing in your diagram. but some palettes contain activities that can start a process. For example. These activities. on page 65 describes transitions and conditions. Each activity in a process definition must have a transition to it. Chapter 5. If this is placed in a process definition. the Mail palette has a Receive Mail activity. Transitions and Conditions. Therefore. or the activity is not executed when the process executes. A process definition can begin with a Start activity. There is also a general-purpose Java code activity that allows you to write and execute standard Java code to perform custom processing in your process definition. See TIBCO Administrator User’s Guide for more information about configuring the TIBCO BusinessWorks process engine. After an activity completes. Transitions Transitions describe the flow of processing in a process definition. and you cannot draw a transition to a previously executed activity. Transitions describe control flow of the process definition. not the concurrency of execution of activities. Activities. it replaces the Start activity and a process instance is started when a mail message is received. Having multiple branches in a process definition does not imply that each branch is processed concurrently.Transitions 37 | Activities are available to communicate with a variety of systems. Chapter 4. on page 43 describes activities and their use in process diagrams.

this is similar to a try. Shared configuration resources are created outside of process definitions. Shared Configuration Resources Shared configuration resources are specifications that are shared among activities. To create sets of activities that are to be repeated. instead of trying to individually catch errors on each activity.. or if an error occurs.. TIBCO BusinessWorks Process Design Guide . on page 71 describes groups and how to use them in a process definition. WSDL files.38 | Chapter 3 Processes Groups Groups are used to specify related sets of activities. and connections to other servers. To create sets of activities that participate in a transaction. • • Chapter 6. Basically. but they are used when specifying the Configuration tab of some activities. schema definitions. TIBCO BusinessWorks Palette Reference describes shared configuration resources. These are resources. or rolled back. depending upon whether the transaction commits or rolls back. You can repeat the activities once for each item in a list. Grouping Activities.catch block in Java. such as database connections. until a condition is true. The main uses of groups are the following: • To create a set of activities that have a common error transition. This allows you to have a set of activities with only one error-handling transition. Activities in the group that can take part in a transaction are processed together.

when necessary. That is. If you select the checkbox in the Spawn field of the configuration tab of the Call Process activity. Specify the input. See Developing Process Definitions on page 40 for more information about creating process definitions. output. Create a process definition that will call the subprocess. the called process is known as a subprocess. 4.Subprocesses 39 | Subprocesses Business processes are often very complex and it is difficult to diagram the complete process in one process definition. a subprocess executes in the same process instance as the calling process. and the output of the subprocess is available to all subsequent activities in the process. output. Normally. See Start Activity on page 60 and End Activity on page 62 for more information about specifying the input. follow this procedure: 1. When you call a process definition. You can then call each process definition from another process definition. To create and call a subprocess. Create a process definition for the subprocess. 2. the subprocess is spawned into a new process instance. You can call specific processes. Place a Call Process activity (located on the General Activities palette) in the process definition. and any error schemas of the subprocess on the Start and End activities in the subprocess. or you can dynamically determine which process to call when the process instance executes. TIBCO BusinessWorks Process Design Guide . When a subprocess spawns a new process instance. and optionally allows you to spawn the subprocess into another process instance. Using subprocesses helps to make more readable process diagrams and you can reuse subprocesses across many process definitions. See TIBCO BusinessWorks Palette Reference for more information about dynamically calling subprocesses. You can create several smaller process definitions instead of one monolithic process definition. they must begin with the Start activity. not any activity that receives an event from an outside source. 3. Figure 16 illustrates a main process calling a subprocess. The Call Process activity allows you to map input values into the called process. the parent process cannot access the called process’ output. Subprocesses cannot have process starters. and error schemas of a process.

The End activity defines the outcome of the credit check as the output for the process. TIBCO BusinessWorks Process Design Guide .40 | Chapter 3 Processes Figure 16 A main process calling a subprocess Main Process Pass customer ID to CreditCheck subprocess. The subprocess returns whether the customer has sufficient credit. Subprocess Customer ID is defined as input on Start activity. Developing Process Definitions Figure 17 describes the general procedure for developing process definitions.

The business process has a Start and an End activity by default. This describes the username. 5. Name each process definition and give the process a description. See Chapter 4. For example. JDBC URL and other information about the connection. See the documentation for the activity you are configuring for more information about the fields on each of the tabs for the activity. on page 43 for more information about activities. locate the HTTP Receiver process starter activity. and drag and drop it into the design panel. password. Select the activities that start the business process. Configure the process starter activities. Create one or more process definitions by dragging Process Definition resources from the process palette to the design panel. Create any Shared Configuration resources you will require for your process definition. These activities are known as event sources or process starters. See TIBCO BusinessWorks Palette Reference for more details about each of the shared resources.Developing Process Definitions 41 | Figure 17 Developing process definitions Create Shared Configuration Resources Create Process Definition Add Process Starter Add Activities Create Transitions Between Activities Specify Each Activity's Input Test/Debug/ Redesign The following is a more detailed description of how to develop process definitions: 1. 3. These items are located in the Shared Configuration palette. Activities. Select one of the process definitions you created in Step 1 in the project panel. Drag these event sources from their palettes into the design panel. if you are going to connect to a database. 2. you should drag and drop a JDBC Connection into the design panel. 4. if you wish to start a process when an HTTP request is received. TIBCO BusinessWorks Process Design Guide . select the HTTP activity palette. This causes a blank business process to appear in the design panel. For example. You can then use this connection in many process tasks that require a connection to a database.

on page 199 for more information about testing process definitions. Mapping and Transforming Data. 8. See Chapter 5.42 | Chapter 3 Processes 6. Testing Process Definitions. Drag and drop more activities to define the business process. Once the process definition is complete. 7. TIBCO BusinessWorks Process Design Guide . Click the transition button on the tool bar to draw transitions between activities. See Chapter 8. on page 65 for more information about specifying transitions. Transitions and Conditions. 9. use the test mode tool to enter testing mode. In testing mode. Test and debug your process definition until it operates as expected. on page 105 for more information about mapping and transforming data. Perform mapping and transformation of data for each activity’s input. See Chapter 14. a TIBCO BusinessWorks engine is started to perform the processing described in the process definition.

page 45 Configuration. Topics • • • • • • • • • • • Activity Overview. page 47 Advanced. page 49 Editor. page 58 Start Activity. This chapter describes activities and how to use them in a process definition. page 44 Activity Icons. page 58 Process Starters. page 62 TIBCO BusinessWorks Process Design Guide . page 56 Output. page 48 Event. page 60 End Activity.| 43 Chapter 4 Activities Activities perform the work in a process definition. page 50 Input.

For example. Each palette has a set of activities that can be performed for that palette. Receives a message from the specified adapter and starts a process. the following activities are included in the ActiveEnterprise Adapter palette: Table 3 Example activities Activity Name Publish to Adapter Adapter Subscriber Respond to Adapter Request Function Sends a message to the specified adapter. The following are examples of palettes and some of the activities the palettes contain: • File — Create File — Remove File — Write File — Read File • FTP — FTP Put — FTP Get • JDBC — JDBC Query — JDBC Call Procedure — JDBC Update • Mail — Send Mail TIBCO BusinessWorks Process Design Guide . Activities are generally operations that interface to external systems. Activities are available on the various palettes in TIBCO Designer. Replies to a message sent by an adapter. but activities can also perform internal processing.44 | Chapter 4 Activities Activity Overview Activities are the individual units of work in a process definition.

TIBCO BusinessWorks Process Design Guide . such as HTTP requests or incoming TIBCO Rendezvous messages. and the user must specify their own schema. Activity Icons Each activity is represented by an icon in the palette and design panels. Each activity usually has two or more of the following tabs for specifying the characteristics of the activity: • • • Configuration — Used for general configuration of the activity. this tab specifies the adapter service to use for an Adapter activity. Advanced — Any advanced configuration parameters are specified here. Output — The activity’s data is output to activities that follow in the process definition. Output or both tabs of the activity. the activity palettes are available to drag and drop activities into the process definition. Editor — A data schema for the activity. Once specified. There are some common elements of activity icons that represent the type of activity and the direction of data between the activity and the process. There are two activities that are included in a process definition by default: the Start activity and the End activity. Event — For activities that wait for incoming events. this tab specifies the timeout for the incoming event and a condition to determine whether the incoming event is the correct one for the specific process instance. There is a chapter for each available activity palette. These icons represent the function of the activity. See Start Activity on page 60 and End Activity on page 62 for more information about these activities. Input — The output data from all activities that precede this activity in the process definition is available for mapping to this activity’s input schema. • • • The sections that follow describe each tab used to specify an activity. This is used when the input or output data is not known by the activity. See the activity palette chapter for more information about the specific activity you wish to use. the schema becomes available on the Input. Table 4 describes the various elements in activity icons. For example.Activity Icons 45 | When you are in a process definition in TIBCO Designer.

46 | Chapter 4 Activities Table 4 Activity icon elements Element Example Description Arrows indicate the direction of information between the process and the external system. In the example. TIBCO BusinessWorks Process Design Guide . A yellow square with two parallel lines inside (similar to a "Pause" button on a media player) indicates the activity waits for an incoming event from the external system. These activities. as opposed to performing an operation (see the description of single arrows below). the information is flowing from the process to the adapter (the adapter is represented by the purple and blue sphere). A green circle with an arrow inside (similar to a "Play" button on a media player) indicates the activity is a process starter. also known as "Event activities" cause the process to suspend until the incoming event is received. These activities start new processes based on the receipt of an event from the external system. See Event on page 49 for more information about Event activities. See Process Starters on page 58 for more information about process starters. Multiple arrows indicate either sending or receiving data.

the activity starts a process based on the receipt of a request from an adapter. In the Invoke an Adapter Request-Response activity example. or sending a request and receiving a response. For example. Configuration The configuration tab contains the general specifications for the activity.Configuration 47 | Table 4 Activity icon elements Element Example Description A single arrow going into or out of the external system indicates that the activity is performing a request. In the Respond to Adapter Request activity example. This is different from simply receiving a message or data (indicated by multiple arrows) because the activity is performing or responding to a remote operation call. The direction of the arrow indicates whether the activity is receiving a request. In the Adapter Request-Response Server activity example. such as whether the type of data being sent is text or binary or whether the FTP server resides outside of a firewall. sending a response. the activity is sending a request to an adapter and expects to get a response from the adapter. an FTP activity would contain specifications for the FTP session. sending a response. TIBCO BusinessWorks Process Design Guide . or performing a request and receiving a response. Required fields on the configuration tab are displayed in bold so that it is easy to see the minimum required information for configuration of an activity. the activity is sending a response to a previously received adapter request.

See the chapter for the palette you are interested in TIBCO BusinessWorks Palette Reference for more information about the Configuration tab of the activities in that palette. TIBCO BusinessWorks Process Design Guide . See the chapter for the palette you are interested in TIBCO BusinessWorks Palette Reference for more information about the Advanced tab of the activities in that palette. Any other items on the configuration tab are the required configuration elements you must specify to make the activity work. all activities allow you to specify a name for the activity and provide a short description on the Configuration tab.48 | Chapter 4 Activities The following illustrates the configuration tab. In general. Advanced The Advanced tab is available on some activities for specifying additional configuration options.

The following illustrates the Event tab. the message waits indefinitely. See Chapter 9. The amount of time a message will wait (in milliseconds) if it is received before this task is reached in the process. an error is logged and the event is discarded.Event 49 | Event The Event tab is available on activities that expect an incoming event. Event Timeout (msec) TIBCO BusinessWorks Process Design Guide . These are activities that wait for an incoming event in a process. unless this has already been reached. If no value is specified in this field. An Event tab has the following fields: Field Candidate Event Key Description Expression used to evaluate whether the incoming message is appropriate for this process. XPath. These activities cause the process instance to suspend until the incoming event is received. and only data from the incoming event is available for use in this XPath expression. If the event timeout expires. If zero is specified. the event is discarded immediately. This expression is specified in XPath. on page 147 for more information about XPath expressions.

See the chapter for the palette you are interested in for more information about tasks that have Event tabs. The data schema may also be for a more specialized use. Editor The Editor tab is used to specify a data schema for input or output of an activity. The name of the Editor tab differs depending upon what the schema is used for. An HTTP request.. Waits For . The specified file to change. Either a JMS queue or topic message. the Input Editor tab of the Publish Rendezvous Message activity allows you to define the schema for the message you wish to publish. This tab is useful when the data does not have a well-known structure.50 | Chapter 4 Activities Table 5 describes the available activities with Event tabs. An adapter message or request. The associated Notifiy activity to execute. TIBCO BusinessWorks Process Design Guide . Table 5 Activities with Event tabs Palette ActiveEnterprise Adapter Event Activities Wait for Adapter Message Wait for Adapter Request File General Activities HTTP JMS Wait for File Change Wait Wait for HTTP Request Wait for JMS Queue Message Wait for JMS Topic Message Manual Work Rendezvous Wait For Completion Wait for Rendezvous Message A manual task to complete. For example. such as for defining the output headers of an incoming HTTP request.. A TIBCO Rendezvous message.

Field Content Description Defines the content of the element. the Schema tab is labeled Input Editor indicating this defines the schema for the activity’s input.Editor 51 | You can use a simple datatype. The name of the element. Name TIBCO BusinessWorks Process Design Guide . See Table 6 for more information about the content type. In this example. You can also reference XML schema or ActiveEnterprise classes stored in the project. To define a schema on this tab. or move data items. The other fields that apear depend upon which content type is selected. or you can define a group of data elements on this tab. The data in the schema then becomes available to other activities in the process definition. Then use the fields of the dialog to specify the datatype of each item. use the buttons above the schema tree to add. delete. The following illustrates the Schema tab. the schema appears on the appropriate tabs of the activity. Once defined.

and it can contain other complex elements. Type The type of data. Repeating. Table 6 Content types for schema elements Content Type Complex Element Description An element that contains other elements. Can be any of the following: • • XML Type Reference — must locate the stored XML schema definition.52 | Chapter 4 Activities Field Cardinality Description The qualification for the data item. Type in a stored XML schema you wish to reference. Optional (?) — the data item is optional. One or More (+) — The data item is a list that has one or more items. Schema Name Type Name Stored XML schema that contains the element or type you wish to reference. The complext element can contain zero or more elements of other types. This is like a structure in a programming language. Repeating. Table 6 describes the potential content types for data elements. Data items can be specified as one of the following: • • • • Required — the data item is required and must be supplied when the process is called. Zero or More (*) — The data item is a list that has zero or more elements. Any of the datatypes described in Table 7. Other Fields for This Content Type Name Cardinality TIBCO BusinessWorks Process Design Guide .

and so on).Editor 53 | Table 6 Content types for schema elements Content Type Element of Type Description An element with a specified datatype. integer. Each item in the sequence is a structure of the sub-elements of this element. you can reference an XML type. The datatype of this element can be all of the datatypes of the sub-elements defined. or specify the TIBCO ActiveEnterprise Any dataype. Other Fields for This Content Type Name Cardinality Type Other fields depending upon the datatype selected Cardinality Schema Element Name Cardinality Type Other fields depending upon the datatype selected Cardinality XML Element Reference A reference to an element in a stored XML schema. integer. See TIBCO Designer documentation for more information about XML schema. or specify the TIBCO ActiveEnterprise Any dataype. You can specify a scalar datatype (string. Attribute of Type Sequence A sequence of elements. A choice of elements. The datatype of this element can be one of the sub-elements defined. See TIBCO Designer documentation for more information about XML schema. A reference to an XML group in a stored XML schema. and so on). Choice Cardinality All Cardinality XML Group Reference Cardinality Schema Model Group TIBCO BusinessWorks Process Design Guide . An attribute with a specified datatype. you can reference an XML type. You can specify a scalar datatype (string.

Table 7 Icons for schema datatypes Icon Description String or character value. You can use the Coercions button to supply a reference to the XML Element for this item when it appears in the input or process data. Other Fields for This Content Type Cardinality Validation Table 7 describes the datatypes available for data. You can specify the type of string as one of the following: • • • • • • • • • • • • • • String Normailzed String Token Language Name NC-Name Q-Name Name Token Name Tokens ID ID ref ID refs Entity Entites TIBCO BusinessWorks Process Design Guide .54 | Chapter 4 Activities Table 6 Content types for schema elements Content Type Any Element Description A reference to any XML Element.

double. You can specify the size of the integer as one of the following: • • • • • • • • • • • • Byte Short Int Long Unsigned Byte Unsigned Int Unsigned Long Integer Positive Integer Negative Integer Non-positive Integer Non-negative Integer Floating point number.Editor 55 | Table 7 Icons for schema datatypes Icon Description Integer value. You can specify the size of the schema item as float. Date or Time. or decimal. This can be any of the following datatypes: • • • • • • • • • Time Date Date & Time Duration Day Month Year Year & Month Month & Day TIBCO BusinessWorks Process Design Guide . Boolean value.

Any Type. The following illustrates the input tab. Choice. You can use the Coercions button to supply a reference to the XML Element for this element. Specifies that the schema element can be one of a specified set of datatypes. The Process Data area contains the output from all of the activities that appear prior to the activity in the process definition. Input The Input tab allows you to map and transform output data from the previous activities in the process (including the event that starts the process) to input data for the activity. The Activity Input area lists the current activity’s required and optional input data. Sequence. XML element or group reference. Container for other datatypes.56 | Chapter 4 Activities Table 7 Icons for schema datatypes Icon Description Base 64 or hexidecimal value. Any Element. Complex element. Represents a schema element that can be a reference to any XML Element. You can use the Coercions button to supply a datatype for this element. Represents a schema element with the TIBCO ActiveEnterprise datatype any. This element can be specified as any other datatype or a reference to an XML Type or AE Class. An HTTP Uniform Resource Identifier. TIBCO BusinessWorks Process Design Guide . Signifies that the contained sub-elements are repeated in an ordered sequence.

to create a mapping. you click on the desired item in the available schema in the Process Data panel and drag the item to the desired item in the Activity Input panel. You can also specify constants (strings enclosed in quotes or numbers) for any input values.Input 57 | Mapping and Transforming Activity Input Data You can create mappings between the available output from previous activities and the current activity’s input. Mapping and Transforming Data. or you can specify conditions on the mappings. There are also several icons above the Activity Input area. Table 10 on page 109 describes the icons and their function. you can click on the schema item in the Activity Input panel and type the constant or expression into the field. In general. If you wish to type in a constant or expression. See Chapter 8. TIBCO BusinessWorks Process Design Guide . on page 105 for more information about using the Input tab to create mappings between process data and the activity’s input.

58 | Chapter 4 Output Activities The output tab displays the activity output schema. there is an activity named File Poller. You can only have one process starter in a process definition. in the File palette. This activity detects changes in a specified file and starts a process when the change occurs. Table 8 describes the available process starters. You will receive a warning if you attempt to add more than one process starter to a process definition. The following illustrates the output tab. it replaces the default Start activity. This kind of activity is known as a process starter. This name appears in subsequent activities input tabs. The activity output data is displayed for informational purposes only and cannot be modified or altered. When a process starter is placed into a process definition. For example. Process Starters Some activities are used to start a process when an event occurs. and becomes the first activity in the process. TIBCO BusinessWorks Process Design Guide .

A message or a request from an adapter is received. An HTTP request is received. you can place processes with different process starters on different machines. A SOAP web services request is received. You can start processes for one-time events or schedule processes to start on recurring time intervals. Receive Notification HTTP JMS HTTP Receiver JMS Queue Receiver JMS Topic Subscriber Mail Rendezvous SOAP Receive Mail Rendezvous Subscriber SOAP Event Source TIBCO BusinessWorks Process Design Guide . File General Activities The specified file is created. A TIBCO Rendezvous message is received. See TIBCO Administrator User’s Guide for more information about deployment and specifying where process starters run. For example. Mail for the specified user is received by the mail server. or deleted. Either a JMS queue or topic message is received. you may wish to place all processes with a Receive Mail process starter on the same machine as the mail server so that the processes can poll the mail server more efficiently.. The specified time interval occurs. Table 8 Process starters Palette ActiveEnterprise Adapter Process Starter Adapter Subscriber Adapter Request-Response Server File Poller Timer Starts a process when..Process Starters 59 | When you deploy your project. changed. A corresponding Notify activity has executed.

See Chapter 9. on page 147 for more information about XPath expressions. and it is also available in the $_processContext process variable. This ID is displayed in the View Service dialog of TIBCO Administrator. The Start activity has the following tabs: • • Configuration Output Editor TIBCO BusinessWorks Process Design Guide . Custom Id This field can contain an XPath expression that specifies a custom ID for the process instance. See Chapter 12. The Misc tab contains the following fields: Field Sequencing Key Description This field can contain an XPath expression that specifies which processes should run in order. on page 147 for more information about XPath expressions. XPath. on page 183 for more information about controlling the execution order of process instances. Working With Variables. and the Start activity is used to define the input expected by the process.60 | Chapter 4 Activities Misc Tab All process starters have a Misc tab that allows you to configure features common to all process starters. Process instances whose sequencing key evaluates to the same value will be executed sequentially in the order in which the process instance was created. See Chapter 7. Process Instance Execution. Start Activity The Start activity is the first activity in a process definition (process starters replace the Start activity when they are used in a process definition). A process can be called from another process. on page 93 for more information about process variables. XPath. See Chapter 9.

Field Name Description Description The name to appear as the label for the activity in the process definition. See Editor on page 50 for a description of how to define a schema. This data then becomes available to other activities in the process definition. You can define your own datatype on this tab. Output The output for the activity is defined by the specified data elements on the Output Editor tab. TIBCO BusinessWorks Process Design Guide . Short description of the activity. the data specified on the Output Editor tab becomes the output schema of the Start activity. Configuration The configuration tab has the following fields.Start Activity 61 | • Output See Subprocesses on page 39 for more information about calling a process from another process. Once defined. Any process that calls this process definition must supply the data specified on the Output Editor tab. and you can reference XML schema or ActiveEnterprise classes stored in the project. Output Editor The Output Editor tab defines the data that the process is expecting as input.

Once defined. This becomes the output of the process. Any process that calls this process definition will receive this data when the process call completes. See Editor on page 50 for a description of how to define a schema. Input Editor The Input Editor tab defines the data that the process will output. and this becomes the output of the process when the process completes. You can define your own datatype on this tab. the data specified on the Input Editor tab becomes the input schema of the End activity.62 | Chapter 4 Activities End Activity The End activity is the last activity in a process definition. Field Name Description Description The name to appear as the label for the activity in the process definition. and you can reference XML schema or ActiveEnterprise classes stored in the project. You can map data from the activities in the process to an output schema specified on the End process. Short description of the activity. Configuration The configuration tab has the following fields. You can then map data from other activities in the process to the End activity’s input. TIBCO BusinessWorks Process Design Guide . you may wish to have the called process process definition output data to the calling process. The End activity has the following tabs: • • • • Configuration Input Editor Input Error Schemas See Subprocesses on page 39 for more information about calling a process from another process. When a process definition is called from another process.

See Chapter 10. on page 159 for more information on error handling. Error Handling. See Editor on page 50 for a description of how to define a schema. TIBCO BusinessWorks Process Design Guide . and you can reference XML schema or ActiveEnterprise classes stored in the project. each for use in specific error cases. You can define multiple schemas.End Activity 63 | Input The input for the activity is defined by the specified data elements on the Input Editor tab. Error Schemas The Error Schemas tab defines schemas to contain data for errors thrown by the process definition. You can define your own datatype on this tab.

64 | Chapter 4 Activities TIBCO BusinessWorks Process Design Guide .

Topics • • Transitions. page 68 TIBCO BusinessWorks Process Design Guide .| 65 Chapter 5 Transitions and Conditions Transitions and conditions control the flow of activities in a process diagram. page 66 Conditions. This chapter explains how to create transitions and specify conditions on those transitions.

Therefore. use groups to specify multiple executions of grouped activities (see Chapter 6. The arrows are unidirectional. If you wish to perform looping. Control flow in a process definition must proceed sequentially beginning with the starting activity and ending with the End activity. Grouping Activities. not the concurrency of execution of activities. Each activity in a process definition must have a transition to it. TIBCO BusinessWorks Process Design Guide . all transitions whose conditions are met are taken. Process execution is controlled by the process engine. After an activity or group completes processing. You can have transitions from one activity to many other activities. Transitions describe control flow of the process definition. Figure 18 illustrates examples of valid transitions in a process. Having multiple branches in a process definition does not imply that each branch is processed concurrently. on page 71 for more information on groups). See TIBCO Administrator User’s Guide for more information about configuring the TIBCO BusinessWorks process engine. A transition is represented by an arrow between two activities or groups of activities in a process definition. Figure 19 illustrates an invalid transition. or the activity is not executed when the process executes. you can have several branches of activity processing in your diagram. and you cannot draw a transition to a previously executed activity.66 | Chapter 5 Transitions and Conditions Transitions Transitions describe the flow of processing.

you may specify whether the transition is taken always. Figure 19 An invalid transition You cannot transition to a previously executed activity A transition is taken depending upon the condition specified on the transition. Creating a Transition To create a transition. See Conditions on page 68 for more information. you may find the Null activity in the General Activities palette useful for joining the multiple branches into a single execution path. only if no other transitions are taken. See TIBCO BusinessWorks Palette Reference for more information about the Null activity. only when an error is encountered. When a transition is created. follow this procedure: TIBCO BusinessWorks Process Design Guide . or when a custom-specified condition based on process data values is true.Transitions 67 | Figure 18 Valid transitions One path from Start to End Two transitions from the Start activity form multiple paths If you have multiple branches in a complex process definition.

5. the condition dialog is presented. choose the line type and color for the transition. 2. Release the mouse button. When a transition is created. Click and hold the mouse button. Optionally. 3. 7. Drag the mouse until the cursor is positioned over the activity that you would like to transition to. 6. Click on the Create Transition icon on the TIBCO Designer toolbar. Once the transition is created. First create or open a process definition that contains at least two activities. See Conditions on page 68 for more information about specifying conditions.68 | Chapter 5 Transitions and Conditions 1. Position the cursor over the first activity. you are presented with the transition dialog. You can choose any of the following line types for your transition: — Default (straight line) — Straight — Multiple Bends — One Bend — Curved — S-Shaped Conditions Conditions are specified on transitions to determine whether to take the transition to the next activity or not. TIBCO BusinessWorks Process Design Guide . Figure 20 illustrates the transition dialog. 4. The condition dialog allows you to specify when this transition is taken.

Success if no matching condition Take this transition when the activity completes successfully. always transition to the activity the transition points to. Condition Type Success Description Take this transition unconditionally. You can also specify a condition type for the transition. The following table describes each condition type. This is the default condition for transitions. and you can use the XPath formula builder to drag and drop XPath expressions and data into the condition. on page 147 for more information about specifying XPath conditions and using the XPath formula builder. This condition type can be used to handle any cases not handled by the conditions on the other transitions. if the activity completes successfully. and background color for the transition. line type. See Chapter 9. and the condition you create evaluates to true. Success with condition Specify a custom condition using XPath. This is useful when multiple transitions with conditions are drawn to other activities. but only if no other transitions are taken. If the activity completes successfully. That is. the transition is taken to the activity it points to. XPath. TIBCO BusinessWorks Process Design Guide . You can type in an XPath condition.Conditions 69 | Figure 20 The transition dialog The transition dialog allows you to specify a label. description.

If a condition other than Success is specified. on page 159 for more information on error handling in process definitions. There can be only one Error and one Success if no matching condition transition out of each activity. When a transition is created. it is displayed on the transition line in the process definition if a label is not specified in the Label field. Error Handling. the default condition type is Success. See Chapter 10. TIBCO BusinessWorks Process Design Guide .70 | Chapter 5 Transitions and Conditions Condition Type Error Description Take this transition if there is an error during processing of the activity.

page 84 Repeat On Error Until True Loop. page 88 Critical Section Groups. page 82 Repeat Until True Loop. error-handling. page 80 Iterate Loop. page 88 TIBCO BusinessWorks Process Design Guide . page 79 Overview of Loops. Topics • • • • • • • • Overview of Groups. page 72 No Action Groups. page 86 Critical Section Groups.| 71 Chapter 6 Grouping Activities This chapter describes groups and how to use them for transactions. and looping.

until a condition is true. To specify that the first activity that completes should determine which transition(s) to take to continue processing. See Chapter 11. This allows you to have a set of activities with only one error-handling transition. To create sets of activities that are to be repeated.catch block in Java. draw a box around the desired activities. The main uses of groups are the following: • To create a set of activities that have a common error transition — similar to a try. TIBCO BusinessWorks Process Design Guide . groups can be maximized to display all activities in the group or minimized to show only a small icon for the whole group. Maximized groups can also be resized.72 | Chapter 6 Grouping Activities Overview of Groups Groups are used to specify related sets of activities. or if an error occurs. Transactions. In the design panel. 4.. Choose View>Create a Group from the menu. depending upon whether the transaction commits or rolls back. This allows you to wait for one or more incoming events and continue processing based on what incoming event was received first. on page 167 for more information about transactions. perform the following procedure: 1. To group a set of activities. or rolled back. Also. 2. instead of trying to individually catch errors on each activity. 3. Activities in the group that can take part in a transaction are processed together. This allows you to collapse and expand groups in a process definition to better display the relevant portions of the process you wish to view. • • • • Activities can be grouped or ungrouped. or click the Create a group icon. Choose the Select tool (the arrow pointer in the tool bar). See Pick First Groups on page 90 for more information about this type of group. You can repeat the activities once for each item in a list. The group configuration appears in the configuration panel. See No Action Groups on page 79 for more information. See Overview of Loops on page 80 for more information about loops.. See Critical Section Groups on page 88 for more information about critical sections. To create a critical section that synchronizes process definitions. To create sets of activities that participate in a transaction.

Select the group in the design panel. Specify the type of group to create and any other configuration parameters required for the group. 7. To minimize or maximize the display of a group. or click the Undo the group button. Choose the Select tool (the arrow pointer in the tool bar). Figure 21 illustrates minimizing and maximizing a group. Choose View>Remove a Group from the menu. Draw a transition from the start of the group to the first activity to execute in the group. For groups that are currently minimized.Overview of Groups 73 | 5. 3. 2. For groups that are currently maximized. perform the following procedure: 1. TIBCO BusinessWorks Process Design Guide . To ungroup a set of grouped activities. Draw a transition from the last activity to execute in the group to the end of the group. The start of the group is the green start arrow on the left side of the group box. See Table 9 for more information about the fields of the group configuration tab. click the down arrow in the upper right-hand corner of the group or double click anywhere in the group to minimize the group. The end of the group is the red end square on the right side of the group box. perform the following procedure: 1. 6. 2. double click the group icon to maximize the group.

Also. When a group has completed executing. Choose the Select tool (the arrow pointer in the toolbar) and select the group in the process definition. 2. perform the following procedure: 1. If the group is used for a loop (iterate. and so on). In the case of loop groups. repeat until true. 3. activity output in the group is reset so that activities in subsequent iterations of the group will not have access to output data from previous iterations. Activity Output and Groups Each activity in the group can access the output of previously executed activities inside or outside the group. TIBCO BusinessWorks Process Design Guide . Click and drag the desired anchor point on any side or on the corners until the group is the desired size. if it is not already maximized. any loop indexes for loops contained in loops are reset when the parent loop begins a new iteration. output from the activities in the group is available to subsequent activities in the process definition. only output from the last execution of the activity is available.74 | Chapter 6 Grouping Activities Figure 21 Minimizing and maximizing groups Click the down arrow or double click anywhere in a group to minimize a group that is currently maximized Double click a group to maximize a group that is currently minimized To resize a maximized group. Maximize the group.

• • • • • None — See No Action Groups on page 79 for more information. you can create a process variable and use the Assign activity in the loop to store or alter data for each iteration. Table 9 Group Configuration tab Field Name Description Group Action Description The name to appear as the label for the group in the process definition. Iterate Loop — See Iterate Loop on page 82 for more information. Group Configuration Tab Table 9 describes the fields in the Configuration tab for groups. Critical Section — See Critical Section Groups on page 88 for more information. This list becomes the group’s output and the list is available to subsequent activities in the process definition. Transactions. The type of group. you can optionally accumulate the output of each execution of one activity in the group into a list. on page 167 for more information. Pick First — See Pick First Groups on page 90 for more information. Transaction Groups — See Chapter 11. • • TIBCO BusinessWorks Process Design Guide . Repeat Until True Loop — See Repeat Until True Loop on page 84 for more information Repeat On Error Until True Loop — See Repeat On Error Until True Loop on page 86 for more information.Group Configuration Tab 75 | If you wish to store data from each successive iteration of a loop. For Iterate and Repeat Until True loops. Short description of the group. Groups can be of the following types.

Accumulate Output TIBCO BusinessWorks Process Design Guide . activities in a loop could potentially see activity output from previous iterations of the loop. The group iterates once for each item in the list.x.x. In 2. activity output was not reset at the start of every iteration of a loop. Group Action: Iterate Index Name The index variable for the loop. Therefore. See Iteration Element on page 83 for more information on this field. See Index Variable on page 81 for more information. Iteration Element A name to use for the process variable containing the current iteration element of the data supplied in the Variable List field. Once a process variable is chosen. activity output in loop groups behaves as described in Activity Output and Groups on page 74. See Accumulate Output on page 81 for more information.x Compatibility Mode Description This field is only available for loop groups in process definitions that were migrated from TIBCO BusinessWorks 2.x semantics. Variable List A process variable containing the list you wish to use as the source of the iterations. Checking this field indicates that you would like activity output in a group to be handled using the TIBCO BusinessWorks 2. Specifies that you wish to accumulate the output of each execution of one of the activities in the group into a process variable. This variable will be used to store the current iteration number of the loop. the correct XPath expression for that process variable is automatically entered into this field. Use the button to choose from a list of available process variables for this field.76 | Chapter 6 Grouping Activities Table 9 Group Configuration tab Field 2. The index starts at one and increments by one with each execution of the loop. If you uncheck this field.

Conditions The condition that specifies when the loop should stop. The activities in the group are executed once. the loop stops. This variable will be used to store the current iteration number of the loop. The index starts at one and increments by one with each execution of the loop. See Index Variable on page 81 for more information. See Accumulate Output on page 81 for more information. See Chapter 9. The activity in a group for which you wish to accumulate output for each execution of the loop. You may select only one activity in the group. You may select only one activity in the group. The loop continues to repeat until the condition evaluates to true.Group Configuration Tab 77 | Table 9 Group Configuration tab Field Output Activity Description The activity in a group for which you wish to accumulate output for each execution of the loop. Output Name Group Action: Repeat-Until-True Index Name The index variable for the loop. Accumulate Output Specifies that you wish to accumulate the output of each execution of one of the activities in the group into a process variable. The process variable to store the successive output of the selected activity in the Output Activity field. If the condition evaluates to false. on page 147 for more information. the loop repeats. The name of the process variable to store the successive output of the selected activity in the Output Activity field. then the condition is checked. Output Activity Output Name TIBCO BusinessWorks Process Design Guide . XPath. The condition is specified as an XPath condition and the XPath formula builder is available to help to create the condition. if the condition evaluates to true.

TIBCO BusinessWorks Process Design Guide . This variable will be used to store the current iteration number of the loop. If the condition evaluates to false. and that error does not have an associated error transition. The loop continues to repeat if unhandled errors are encountered. See Suspend If Still Error Option on page 87 for more information about this field. The condition is specified as an XPath condition and the XPath formula builder is available to help to create the condition. See Index Variable on page 81 for more information. the loop stops. See Chapter 9. on page 147 for more information. the loop repeats. until the specified condition evaluates to true. if the condition evaluates to true. The index starts at one and increments by one with each execution of the loop.78 | Chapter 6 Grouping Activities Table 9 Group Configuration tab Field Description Group Action: Repeat-On-Error-Until-True Index Name The index variable for the loop. Conditions The condition that specifies when the loop should stop. XPath. If an error occurs during the processing of the activities. the condition is checked. The activities in the group are executed once. Suspend (If Still Error) Suspends the process if the error still occurs when the specified condition is true.

with a common set of transitions into and out of the group. you only need one error transition instead of an error transition for each activity.No Action Groups 79 | Table 9 Group Configuration tab Field Description Group Action: Critical Section Scope Defines the scope of the critical section group.. This option requires the Lock resource to be specified in the Lock Object field. • Single Group — specifies that all process instances in the same process engine for the current process definition will be synchronized on the current group. If you are synchronizing across multiple process engines. If you do not wish for the activities in the group to repeat. Multiple Group — specifies that all process instances for the current process definition and any other process definition with a critical section group specifying the same lock resource will be synchronized. you should select the Multiple Group option. specify the group action to be None. This behavior is similar to a try. No action groups are primarily useful for specifying a single error transition out of the group so that if an unhandled error occurs in the group. No Action Groups You can group a set of related activities.. • Lock Object The Lock shared configuration resource that synchronizes critical section groups across process definitions and potentially across process engines.catch block in Java. TIBCO BusinessWorks Process Design Guide .

TIBCO BusinessWorks Process Design Guide . an email message is sent. you can iterate until a given condition is true. 4. An FTP Get activity retrieves a file from an FTP server. The process performs the following operations: 1. a TIBCO Rendezvous message is published so that an administrative application can be notified of the error. Overview of Loops Loops allow you to execute a series of activities more than once.80 | Chapter 6 Grouping Activities The following process definition illustrates a no action group that has one error transition out of the group to process any unhandled errors that occur when the grouped activities execute. If all activities in the group succeed. The following are the types of loops that are available: • • • Iterate Loop Repeat Until True Loop Repeat On Error Until True Loop Iterate and repeat until true loops allow you to accumulate the output of a single activity in the loop for each execution of the loop. This allows you to retrieve output from each execution of the activity in the loop. In the event of an error. See Accumulate Output on page 81 for more information about accumulating the output of each iteration of a loop. The contents of the file are used to create an HTTP request to a web server. 2. A Write File activity writes the retrieved file so that its contents are available at a later time. 3. You can iterate based on the items in an array stored in the process data. or you can iterate if an error is encountered while processing.

For nested loops. The iteration count starts at one the first time the loop is executed. Therefore. Because you can accumulate output from only one activity in a group. if the index variable is i. the condition would be $i=3. you can select one of the activities in the group. or you may wish to accumulate the sum of the amounts for line items in an order. For example. You can access this variable like any other process data by referencing it with a dollar sign ($) in front of it. this variable can be accessed in the same way other process data can be accessed by other activities. Because you can only select one activity in the Accumulate Output field. the activity is executed and the output is added to the list before the condition is checked. You can then choose the Java Code activity as the Output Activity to accumulate for each iteration of the loop. The Mapper TIBCO BusinessWorks Process Design Guide . you should design your group so that only one activity in the group holds the data to accumulate for each iteration. you may wish to use a Mapper activity in the loop to accumulate the output.Overview of Loops 81 | Index Variable The index variable holds the current number of times a loop has executed. After the loop exits. if you choose to accumulate the output of the same activity used in the condition of a Repeat Until True loop. you must use a different approach. Alternatively. you may want to accumulate a list of customer names from repeated executions of a JDBC Database Query task. to accumulate ouptut from several activities. the selected activity’s output is placed into a list. and each time the loop is executed. you can use a Java Code activity to concatenate the data into the output parameters for the Java Code activity. For example. In this case. The list of accumulated output for that activity is stored in a variable whose name is specified in the Output Name field. One approach is to create a process variable to hold the data and use the Assign activity to assign values from each iteration of the loop to the process variable. If you check this field. The output for the selected activity is accumulated each time the activity is executed. and the count increases by one for each iteration of the loop. you can accumulate the output of one of the activities in a group by checking the Accumulate Output field. Accumulate Output For iteration and repeat until true loops. and you want to specify a condition that the loop should execute three times (for a repeat until true loop). the index of the contained loop resets at the beginning of each iteration of the parent loop.

The customer records are then passed to a group containing one activity. WriteCustomerList. The process then reads the file that was written so that its data is available to the process. The WriteCustomerList activity writes the name and address of each customer to a file. appending to the file as each record is written. 3. The group iterates once for every customer record returned by the QueryCustomer activity. The following is an example of an iterate loop. and transitions to the ReadCustomerList activity once the last record is processed. TIBCO BusinessWorks Process Design Guide . The list can be items of any datatype. Iterate Loop An Iterate loop repeats the series of grouped activities once for every item in an existing sequence or list. 4. then transitions to a Send Mail activity to send the contents of the customer list by way of email. A JDBC Query activity is used to query a database and populate a list of customer records. you can place a Mapper activity outside of the loop to strip out the unwanted value from the output list after the loop exits. The process performs the following operations: 1. Alternatively.82 | Chapter 6 Grouping Activities activity is placed after the activity used for the condition of the loop so that the loop exits before the value is accumulated. 2.

For example. You can use a simple expression containing a complete list as in the example above. One iteration is performed for every element contained in the repeating element. a process variable with the specified name appears in the Process Data tree in the Input tab.Iterate Loop 83 | The following is the configuration for this example: In this example. When you specify a value for this field. the repeating element $QueryCustomer/Customer/Record is used to determine the number of iterations to perform. This allows you to easily map the value of the current iteration element instead of using predicates on the process variable used for iteration. on page 147 for more information on creating XPath expressions. The Variable List field is an XPath expression. For example. This causes the following to appear in the process data tree: TIBCO BusinessWorks Process Design Guide . Iteration Element The Iteration Element field on the Configuration tab allows you to supply a name for a process variable containing the current iteration element. if you wish to skip over the first 10 records returned. XPath. in the Iterate group above. or your expression can be more complex and only process certain items in the list. we specified curent-record as the name for the current element. the expression in the Variable List field would be the following: $QueryCustomer/Customer/Record[position() > 10] See Chapter 9.

and the loop exits when the condition evaluates as true. TIBCO BusinessWorks traverses the $QueryCustomer/Customer/Record element to retrieve the current element each time the loop iterates. $current-record/Record is a copy of the $QueryCustomer/Customer/Record[i] element.84 | Chapter 6 Grouping Activities Notice that both $QueryCustomer/Customer and $current-record contain the element Record. the current element being processed. the condition is checked. The activities are always executed once before checking if the condition is true. After executing the series of activities. The following is an example of a Repeat Until True loop. If you use $QueryCustomer/Customer/Record[i] in an input mapping. Repeat Until True Loop The Repeat Until True loop repeats the series of grouped activities until the given condition evaluates as true. By using the $current-record/Record element instead. the greater the performance improvement you will notice by using $current-record/Record instead of $QueryCustomer/Customer/Record[i]. The larger number of elements contained in the $QueryCustomer/Customer/Record repeating element. The process performs the following operations: TIBCO BusinessWorks Process Design Guide . you save processes time in proportion to how many times the iteration loop repeats.

the loop can exit. b. A Java Code activity that outputs all the valid customer IDs. the loop stops executing and transitions to the WriteCustomerList activity so that the customer list will be stored in a file. A JDBC Query activity that takes each ID and queries a database for the record matching the ID. c. A group of activities executes until the customer records have all been queried. When the condition of the loop evaluates to true. The following is the configuration for this example Repeat Until True loop: TIBCO BusinessWorks Process Design Guide . The group consists of: a. so the condition examines the value and when it is -1. A Send Mail activity that uses the customer information retrieved from the database to send an email to the customer notifying the customer of new product offerings. The Customer ID activity outputs -1 when there are no more customers. the activity will output -1 to indicate no more records can be queried. the output of the QueryCustomer activity is placed into a variable named customerList. 2. For each iteration of the loop. The condition evaluates the value of CustomerID/ID_num.Repeat Until True Loop 85 | 1. When all valid IDs have been output.

86 | Chapter 6 Grouping Activities Repeat On Error Until True Loop The Repeat On Error Until True loop allows you to repeat a series of activities when an unhandled error occurs. the loop terminates. If an error occurs for which there is no error transition. the condition of the loop is evaluated — if the condition is true. 3. the loop terminates. However. An FTP Get activity retrieves a file from an FTP server. In this case. if the condition is false. the loop repeats until there is no error occurs or the condition is true. For example. to avoid an infinite loop if the error occurs repeatedly. specify a repeat on error until true loop with a condition that terminates the execution after five tries. The process performs the following operations: 1. you wish to retry the execution only five times. The following illustrates a repeat on error until true loop. you may wish to execute a series of activities and retry the execution in the event of an unhandled error. The activities in the group are executed once. 2. If there are no unhandled errors. The contents of the file are sent by email. TIBCO BusinessWorks Process Design Guide . The contents of the file are written so the data is available at a later time.

the loop terminates if the condition evaluates to true. which means that when the index variable is equal to five (that is. The process instance executes the loop. The loop is entered again. a machine may be down. When this option is checked. If an error is encountered. This option allows the administrator to correct the problem causing the error. When a process instance resumes execution. Therefore. For example. the execution resumes before the Repeat On Error Until True loop. The condition is only evaluated upon encountering an unhandled error in the group. the fifth iteration of the loop). and all process variables are reset to their values before the loop was executed the first time. or until the group is executed five times. the loop condition is checked as it normally would be. After the problem is corrected. the process instance suspends if the error still exists when the condition of the loop is true. and if an error occurs. the administrator can resume the process execution. the loop exits. and the deployment configuration allows you to specify an action to perform if the process is suspended. the process instance resumes execution as if the Repeat On Error Until True loop had never executed. TIBCO BusinessWorks Process Design Guide .Repeat On Error Until True Loop 87 | The following is the configuration for this example loop: The condition is specified as $i = 5. The suspended process is displayed by TIBCO Administrator. The resulting behavior in this example is that the group of activities executes and loops until either a successful completion of all activities. Suspend If Still Error Option Repeat On Error Until True loops have the Suspend If Still Error option. or an adapter service may not have been started on the machine.

or you can synchronize process instances for multiple process definitions. Critical Section Groups Critical section groups are used to synchronize process instances so that only one process instance executes the grouped activities at any given time. or you can synchronize process instances across multiple process engines. The administrator can decide whether to resume or kill the process if the error cannot be fixed. as well as information about how to view suspended processes and resume or kill them.88 | Chapter 6 Grouping Activities If the error persists. For more information about deployment configuration and specifying actions to perform if processes are suspended. Single Group If you wish to synchronize process instances for a single process definition in a single process engine. Only one process instance at any given time will execute the activities contained in the Critical Section group. Specify Critical Section for the Group Action field. 2. other situations may occur where you wish to ensure that only one process instance is executing a set of activities at a time. Synchronization Options Critical section groups can be used to synchronize all process instances for a particular process definition in a single process engine. see TIBCO Administrator User’s Guide. perform the following: 1. Any concurrently running process instances that contain a corresponding critical section group wait until the process instance that is currently executing the critical section group completes. TIBCO BusinessWorks Process Design Guide . Specify Single Group for the Scope field. 3. the process instance continues to be suspended. Critical Section groups are particularly useful for controlling concurrent access to shared variables (see Synchronizing Access to Shared Variables on page 103 for more information). However. Create a group around the activities you wish to synchronize.

check the Multi-Engine field of the Lock resource. 2. Use the Browse button in the Lock Object field to locate the Lock shared configuration resource you created in Step 1. and a database transaction is performed to ensure that only one process instance is executing the critical section group at any given time. Do not include any activities that wait for incoming events or have long durations. put only a very few activities in a Critical Section group. Avoid nesting Critical Section groups. Perform steps 3 to 6 for any process definitions you wish to synchronize. there may be performance implications when using these groups. Sleep activities. 4. When the process instances are executed across multiple engines. perform the following: 1. Specify Multiple Groups for the Scope field. In general. or if you wish to synchronize process instances across multiple process engines. When the process instances are executed by the same process engine. To perform the synchronization across multiple process engines. 6. such as Request/Reply activities. or activities that require a long time to execute. ensure that Lock shared configuration resources are used in the same order in all process definitions. and only use activities that execute very quickly. the process engines must be configured to use a database for storage. 7. Specify Critical Section for the Group Action Field. Make sure you specify the same Lock shared configuration object for all Critical Section groups. If you must use nesting.Critical Section Groups 89 | Multiple Groups If you wish to synchronize process instances for multiple process definitions. Create a group around the activities you wish to synchronize. Create a Lock shared configuration resource and specify a name for the resource. Wait For activities. 3. 5. Deadlocks can occur if you do not specify the Lock resources in the same order in nested Critical Section groups for all process definitions. locking is performed in memory. • • TIBCO BusinessWorks Process Design Guide . Usage Guidelines Because Critical Section groups cause many process instances to wait for one process instance to execute the activities in the group. you should use the following guidelines when creating critical section groups: • Keep the duration of a Critical Section group as short as possible. That is.

Pick First Groups Pick first groups allow process execution to wait for one or more events. If either PollInventory or PollReturnedStock complete first. the transition to the ProcessOrder activity is taken. or the Timeout activity. both the Lock and the Shared Variable shared configuration resources should have the Multi-Engine field checked. If neither system returns the information about available inventory. as part of an order-entry system. For example. If the Timeout activity completes first. Whichever system returns the information first is used to fill the order. The group then waits for either the return message from PollInventory.90 | Chapter 6 Grouping Activities • When using Critical Section groups to retrieve or assign a value to a shared variable across multiple process engines. the return message from PollReturnedStock. The process is called and then a transition is taken to the Pick First group. a check is made to see if the order can be filled from stocked inventory or from returned merchandise. the transition to the CancelOrder activity is taken. The first activity to complete determines the next transition taken. The first event that completes determines which transition to take to continue processing. TIBCO BusinessWorks Process Design Guide . The following illustrates an example sub-process that uses the Pick First group to implement the business logic described above. when an order is placed. You can use a global variable to ensure that the Multi-Engine field is set to the same value for both resources. the order times out and cancels.

activities. and activities that have the pause symbol can have valid transitions from the start of the Pick First group. the activity is highlighted in red. Wait for . if the transition from the start of the group is drawn to an invalid activity.. If the transition is valid. draw transition lines from the start of the group to the desired activities.Pick First Groups 91 | To specify the events that you would like to wait for. Only request/reply. the activity is highlighted in green. TIBCO BusinessWorks Process Design Guide ..

92 | Chapter 6 Grouping Activities TIBCO BusinessWorks Process Design Guide .

page 94 Process Variables. page 98 Shared Variables. page 94 Global Variables. Topics • • • • Overview of Variables.| 93 Chapter 7 Working With Variables This chapter describes the various types of variables available in TIBCO BusinessWorks and how to use these variables in your process definitions. page 101 TIBCO BusinessWorks Process Design Guide .

The constants can be specified and changed while designing and testing your project. The values you specify are then used at runtime. • TIBCO BusinessWorks Process Design Guide . Predefine a variable using TIBCO Designer. For example. You can also override values for predefined variables. each with their own purpose and usage. publication service or TIBCO BusinessWorks process) at deployment time using TIBCO Administrator. You can also create user-defined process variables for containing process-specific data.94 | Chapter 7 Working With Variables Overview of Variables There are several types of variables in TIBCO BusinessWorks. You can also override values for predefined variables. then override the value for individual services (for example. You can also specify different values for each deployment of your project. TIBCO BusinessWorks provides the following types of variables: • Global Variables — these variables allow you to specify constants that can be used throughout the project. • • The following sections describe the types of variables available in your project in greater detail. there are predefined process variables containing the process ID. There are several ways in which they can be used: • Define a variable using TIBCO Designer. Process Variables — these variables allow you to access various data in your project. you can also synchronize access across processes when setting or retrieving the shared variable. project name. unless the GUI does not allow you to make them settable later. and other information. Global Variables Global variables provide an easy way to set defaults for use throughout your project. Because multiple process instances can access the same variable. Shared Variables — these variables allow you to specify data for use across multiple process instances. then override the value for individual applications at deployment time using TIBCO Administrator. unless the GUI does not allow you to make them settable later.

allow you to drag and drop global variables into the field. Global Variable groups are used for grouping variables. With the group icon selected. in-place editor for global variables or an advanced global variables editor (see Advanced Variables Editor on page 96). such as user name and password fields. Advanced Editor Delete Add Global Variable Add Global Variable Group — To add a new global variable group. The project panel is updated to display all currently defined global variables. you can click the abc icon to add variables to the group. You can then use the variable in different sessions in an adapter. then press Enter. Some fields in the configuration panel. select that region and triple-click the variable. TIBCO Designer provides a simple. select the Global Variables tab. follow these steps: 1. Specify the name of the group. click the left-most icon. TIBCO BusinessWorks Process Design Guide . If you wish to change the TIBCO Rendezvous daemon for the adapter. The variable expands so you can change either the variable name or the variable value. You now have these choices: — To assign or change a variable value.Global Variables 95 | For example. Press Enter when you’re done. They are especially useful if multiple developers share a project using a version control system. you could assign the value 7474 to the predefined global variable RvDaemon. In the project panel. To use the simple global variables editor. you can globally set it to a different value.

For example. optionally.96 | Chapter 7 Working With Variables — To add a global variable. TIBCO Designer provides anumber of default global variables. 2. the variable RvServiceTest is used as the service. A new global variable item is added to the bottom of the list. TIBCO BusinessWorks replaces all occurrences of the global variable name with the global variable value. TIBCO BusinessWorks includes all service-level variables regardless of usage. enter the variable name surrounded by %% on both sides. TIBCO BusinessWorks Process Design Guide . In the illustration below. — Right-button a global variable for a menu that allows you to edit or delete it. When the project is deployed and the configured components run. See TIBCO Designer User’s Guide for information. you must also have marked the variable as settable at the service level. Supply the variable name and. the value. You can also drag from the Global Variable tree in the display into a text field in the configuration panel. Service level variables are only included in the service archive if the service uses the variable. RvServiceTest would be replaced with 7800. Advanced Variables Editor The Advanced Variables Editor is useful in the following cases: • • • When you need to make multiple modifications to substitution variables When you wish to mark variables as settable from TIBCO Administrator at runtime on a per-deployment basis (or not) When you wish to mark variables as settable on a per-service basis (or not). Press Enter when you’re done. You may add definitions of any variables you need to the predefined variables. The Adapter Archive resource allows you to specifically force inclusion of selected service-level variables if there are problems with inclusion. click the abc icon. In that case. When you want to use the global variable in the fields of a resource.

you can: — Triple-click an item to edit it. 2. Click OK to exit the editor and save the new or modified variables.clientVar. See the section on modifying runtime variables in the TIBCO Administrator User’s Guide for more information on using TIBCO Administrator. — Click the Add — Click the Add Variables Group a Variable icon to add a group of variables. To do this. specify the following as a command line argument when starting the process engine: -tibco. See the TIBCO Administrator User’s Guide for additional information. You can also specify values for global variables when starting a process engine on the command line. For example. you can click the Deployment or Service check box to make that variable settable from TIBCO Administrator for each deployment or for each service. then click the Open Advanced Editor (pen) icon. follow these steps: 1. or add a constraint or description (by clicking on the associated column) — For each variable.clientVar. icon to add a variable. In the project panel. if you have a global variable named item1 contained in a folder named myGroup and you wish to set its value to 500. In the Advanced Editor. 3. Changing Global Variable Values at Runtime You can change the value of a global variable when you deploy your project in TIBCO Administrator.<variablePathAndName> <value> where variablePathAndName is the name of the variable you wish to set. including the path to the variable if it is contained in a folder. add the following argument to the command line when starting the process engine: -tibco. value is the value you wish to set the variable to. select the Global Variables tab.Global Variables 97 | A variable that is settable on a per-service basis can be set for each adapter service or TIBCO BusinessWorks top-level process. — Change the datatype of the variable (by clicking on the type column). To use the Advanced Variables Editor.myGroup/item1 500 TIBCO BusinessWorks Process Design Guide .

and so on. See Input on page 56 for more information about the Input tab and mapping process data to an activity’s input. Only global variables that have the Deployment option checked (on the advanced editor dialog) are visible in the $_globalVariables process variable. Activities have access to any data that is output from previously executed activities in the process definition. This allows you to use process data to supply input values for an activity. such as the process ID. Also. There are four types of process variables: • • • • Activity Output Predefined Process Variables Error Process Variables User-Defined Process Variables Activity Output Some activities produce output. See Global Variables on page 94 for more information about global variables. the project name. Activities can use output from previously executed activities by mapping data from the process variable to the activity’s input. Process variables are displayed in the Process Data panel of each activity’s Input tab.98 | Chapter 7 Working With Variables Process Variables Process variables are data structures available to the activities in the process. $_globalVariables contains the list of global variables defined on the Global Variables tab of the project. An activity’s output is placed into a process variable with the same name as the activity (with a dollar sign placed in front of the name to indicate it is a process variable). only global variables with well-formed XML names (for example. $_processContext contains general information about the process. names containing a % are not well-formed) appear in the $_globalVariables process variable. Each process variable name starts with a dollar sign ($). Predefined Process Variables There are two process variables that are available to all activities that accept input: $_globalVariables and $_processContext. TIBCO BusinessWorks Process Design Guide .

Figure 23 illustrates assigning a value to a user-defined process variable. Activities can also have error process variables named $_error_<activityName>.Process Variables 99 | Error Process Variables When an error occurs in a process. Process variables are defined on the Process Variables tab of the Process Definition resource. User-Defined Process Variables You can define your own process variables and assign values to them in your process definition. The $_error process variable contains general error information. the activity’s error variable is populated with the appropriate error schema. See Editor on page 50 for more information about creating data schemas. Error Handling. on page 159 for more information about handling errors and error process variables. You create a process variable in the same way you create data schemas for activities. Only user-defined process variables can be modified. then you create its schema in the middle panel. Figure 22 illustrates creating a process variable. Assign allows you to specify which process variable you wish to modify. You add a process variable and give it a name in the left-most panel. use the Assign activity. See Chapter 10. TIBCO BusinessWorks Process Design Guide . You can then specify a new value for the process variable in the Input tab of the Assign activity. the data pertaining to the error is placed into process variables. Figure 22 Creating a process variable To assign a value to a user-defined process variable. In the event of an error.

Therefore. if you do not supply a value for an element in a process variable. Memory saving mode can reduce the memory used by actively running process instances. as well as potentially improve the performance of checkpoints. Custom Engine Properties. on page 237 for more information about setting properties. Memory Usage of Process Variables All process variables in a running process instance are stored in memory and therefore consume system resources. See TIBCO BusinessWorks Palette Reference for more information about the Assign activity. When using memory saving mode. That is. By default. that element no longer contains a value at run time. use the Assign activity to reset the value of a process variable. the entire contents of the process variable is replaced by the specified new contents. the memory used by the variable is released.* property to true. the list of process variables is evaluated to determine if subsequent activities in the process refer to the variable. memory saving mode is disabled. Memory saving mode allows memory used by a process variable to be released when the value of the variable is no longer needed. as each activity is executed. If no activities refer to the variable. but you can enable memory saving mode for specific process instances by setting the EnableMemorySavingMode.100 | Chapter 7 Working With Variables Figure 23 Assigning a value to a user-defined process variable When you use the Assign activity. See Appendix B. and make sure to supply the correct values for all elements in the process variable.<processname> property to true. TIBCO BusinessWorks Process Design Guide . You can enable memory saving mode for all process instances by setting the EnableMemorySavingMode.

if a called process has the Spawn configuration field checked. This type of shared variable is useful for passing data to and from sub-processes without creating an input or output schema for the called process. There are two types of shared variables: • • Shared Variable Job Shared Variable Shared Variable A Shared Variable resource allows you to share data across process instances. Configuring Shared Variables You configure a shared variable by providing the following: • • • a name for the variable the schema of the data contained in the variable optionally. This type of shared variable is useful if you wish to pass data across process instances or if you wish to make a common set of information available to all process instances. you may have a set of approval codes for incoming orders that change daily for security purposes.Shared Variables 101 | Shared Variables A shared variable is a shared configuration resource in the General Activities palette. but its scope is limited to the current job. For example. You can then retrieve the shared variable in all processes that require the current approval codes. a new process instance is created and the process instance receives a new copy of the Job Shared Variable. Therefore. You can create a shared variable to hold the approval codes and create one process definition for setting the codes. A copy of the variable is created for each new process instance. All process instances can read and update the data stored in a shared variable. New process instances receive a copy of the Job Shared Variable. You can use the Get Shared Variable and Set Shared Variable activities to access the data instead of mapping data to a called processes input or output schemas. an initial value for the variable TIBCO BusinessWorks Process Design Guide . Job Shared Variable A Job Shared Variable resource is similar to a Shared Variable. so data cannot be shared across process instances.

To preserve the current state of a Shared Variable resource. you can check the Multi-Engine field on the Configuration tab. See Editor on page 50 for more information about specifying data schema. The Persistent field is not available on Job Shared Variable resources. When a shared variable is persistent. Making the Variable Persistent The current value of the shared variable is stored in memory for efficient access by process instances. whether the variable is persistent and whether the variable should be available across process engines Setting the Schema of the Shared Variable The Schema tab allows you to specify a complex schema for shared variable data. When you choose Select Value. an Edit button appears that allows you to bring up a dialog to construct the initial value of the variable. Setting the Initial Value of the Variable While configuring the shared variable. However. you can check the Persistent field on the Configuration tab. you can specify an initial value for the variable on the Initial Value tab. Therefore. You can choose either None (no initial value). or Build Value. it is not necessary to store these variables in a separate location in the process engine storage. The current state of the shared variable is only updated in the process engine persistent storage when the value of the variable changes. its current state is written to the process engine storage location (either the file system or a database depending upon how the process engine was deployed). the current state of the shared variable may be lost. if a process engine crashes. you can choose a stored XML Instance resource containing data that matches the specified schema. Select Value. TIBCO BusinessWorks Process Design Guide . Sharing the Variable Across Multiple Process Engines If you wish to make the value of a Shared Variable resource available to process instances across multiple process engines. but the state of these variables is saved by a checkpoint.102 | Chapter 7 Working With Variables • for Shared Variable resources. no initial value is set and the variable value must be set in a process definition before it can be retrieved. When you choose None. This field is not available on Job Shared Variable resources. When you choose Build Value.

TIBCO BusinessWorks Process Design Guide .This ensures that only one process instance attempts to assign a value to the variable and ensures that no process assigns a value to the variable when the current process attempts to read the value. the Lock shared configuration object and critical section group allow you to synchronize access to Shared Variable resources. See TIBCO Administrator User’s Guide for more information on specifying load balancing groups and specifying a database for process engine storage during deployment. Assigning and Retrieving the Variable’s Value You can retrieve the current value of a shared variable by using the Get Shared Variable activity. Both of these activities can be found in the General Activities palette. Also. Both retrieving the current value of the variable and assigning a new value to the variable requires I/O to the process engine database storage. You can assign a value to the shared variable by using the Set Shared Variable activity. This would result in an unpredictable value for the variable. only engines that are in the same deployment and part of the same load-balancing group can share variables. Because multiple process engines access the shared variable. This provides access to the variable’s current value in subsequent activities in the process definition. Without a mechanism for locking. Before you retrieve the value of a shared variable. Synchronizing Access to Shared Variables Because multiple process instances can potentially access and assign values to Shared Variable resources. a database must be used to store process engine data. You can also configure the Set Shared Variable activity to include the current value of the variable as output for the activity.Shared Variables 103 | If you choose this option. You should use critical section groups to contain the Set Shared Variable and Get Shared Variable activities. a process instance could update the value of a variable while another process instance is attempting to read the value. the current value of the variable is not stored in memory. See Critical Section Groups on page 88 for more information about using the critical section group. you must either set an initial value in the variable’s configuration or use the Set Shared Variable activity to set the variable value.

104 | Chapter 7 Working With Variables TIBCO BusinessWorks Process Design Guide .

page 141 TIBCO BusinessWorks Process Design Guide . page 119 Examples of Mappings. page 124 XSLT Statements. page 117 Shortcuts. page 106 Buttons.| 105 Chapter 8 Mapping and Transforming Data This chapter describes mapping data from a process to a specific activity’s input and how to transform the data using the activity’s Input tab. page 114 Data Validation. page 115 Repairing Incorrect Mappings. Menus. page 108 Specifying Constants. and Icons. Topics • • • • • • • • Overview of Mapping and Transformation.

TIBCO BusinessWorks Process Design Guide . The process data and activity input are represented as schema trees. All activities also have access to global variables. you can see the available process data and the activity’s expected input. but you can use the data to supply input to the activity. On the Input tab. An activity has access to all output data from any activity that has been previously executed in the process definition. Figure 24 An activity’s input tab Process Data Panel The process data is the list of available data in the process definition at the point where the activity is located. and information about the current process context. You cannot modify the process data on an activity’s input tab. Figure 24 illustrates an activity’s Input tab.106 | Chapter 8 Mapping and Transforming Data Overview of Mapping and Transformation The Input tab of an activity allows you to supply the data that an activity expects as input. process variables.

if you are familiar with XSLT and you wish to see the actual code. Once a mapping or formula is specified. You may also wish to refer to XSLT Statements on page 141 for a reference of XSLT statements when deciding which XSLT statement can be used to achieve the result you desire. you can right-click on any item in the input schema and choose Copy from the popup menu. a hint becomes an XSLT statement. Most options in the Mapping Wizard dialog are straightforward. You can specify XPath formulas to transform an element if you need to perform more complex processing. you do not need detailed knowledge of XSLT to specify an activity’s input. see Chapter 9. These hints show you the data the activity expects as input. Mapping and Transforming Process Data to Activity Input When an activity is first dragged from a palette to the design panel. You map data by selecting an item in the Process Data panel. You can paste XSLT into your activity input or use the XSLT File shared configuration resource and the Transform XML activity. However. See TIBCO BusinessWorks Palette Reference for more information and examples of using XSLT to perform mapping. When you perform mapping. then drag and drop that item into the desired schema element you wish to map in the Activity Input panel. Each element can be required or optional. simple mappings appear in the formula area next to the input element after you release the mouse button. See Statements. Many of these situations are described in the section Examples of Mappings on page 124. There are also a variety of third-party books and resources about XSLT and XPath. on page 147. TIBCO BusinessWorks Process Design Guide . However. The XSLT is displayed in your text document. For more advanced use of XPath. Then open a blank text document and choose Paste. The XPath Formula Builder allows you to easily create XPath formulas. Normally. XPath. the activity’s input elements are displayed as hints.Overview of Mapping and Transformation 107 | Activity Input Panel The activity’s input is an Extensible Stylesheet Language Transformation (XSLT) template that specifies how process data should be transformed to provide the expected input. You can also use your own XSLT templates to perform transformations instead of using the techniques described in this chapter. Hints. Required elements must have a mapping or formula specified. and Errors on page 108 for more information about hints and statements. the Mapping Wizard dialog allows you to select which kind of mapping you wish to perform. For more complex mappings. there are some complex scenarios that require multiple steps.

TIBCO BusinessWorks Process Design Guide . Hints are displayed in italics with a light blue background. Hints. These statements are saved as part of the activity in the repository. Any statement or hint that has an error is displayed in red. you must fix the error before executing this process definition. See Repairing Incorrect Mappings on page 117 for more information about fixing errors. and Errors When you display the Input tab for an activity. All required input elements must have statements specified. Buttons. Hints are reminders that you can specify a statement for the input element. your statements may no longer be valid. If a statement is red. but they are not stored as part of the XSLT template for the activity’s input. Once you specify a statement in the Activity Input panel and apply the change to the activity. or if you use the Mapper Check and Repair button to automatically fix errors. popup menus. Therefore. There is also a popup menu when you right-click on elements in each panel. The Mapper Check and Repair button can help you automatically fix some errors. A hint is only displayed in red if it is a required input element. and Icons The Input tab contains several toolbar buttons. and icons. Toolbar and Right-Click Menu on the Input Tab The Process Data panel and the Activity Input panel have several buttons for performing various functions. Once you specify a mapping or a formula for a hint. the existing statements are examined. Statements are only deleted if you manually delete them using the delete button. Menus. Table 10 describes the buttons and right-click menu items available in the panels of the Input tab. You can also drag the hint to the left past the dividing line between the panels and the hint becomes a blank statement. This section describes the various graphical elements of the Input tab.108 | Chapter 8 Mapping and Transforming Data Statements. and any input elements that do not have a statement are displayed as hints. the input element becomes a statement. it becomes part of the XSLT template used to create the activity’s input data. if the input schema for the activity changes. See Repairing Incorrect Mappings on page 117 for more information about using the Mapper Check and Repair button to fix statements in the activity’s input.

Copies the selected element. Deletes the selected element. Allows you to specify or view documentation for schema elements. a choice element can be coerced into one of the possible datatypes for the element. Expand>All expands all sub-elements of the currently selected element. Move Down. Promotes the selected element to the next highest level in the activity input tree. Moves the selected element up in the activity input tree. Menus. For example. and Icons 109 | Table 10 Input tab toolbar buttons Button Right-Click Menu Description Process Data Area Coercions. Allows you to specify a type for Process Data elements that are not a specific datatype. Move Out Move Out. Expand>Content expands the current element so that all elements that are currently used in a mapping are visible. Move Up. Show Connected Delete Copy Activity Input Area Shows/hides the mapping formulas for the input elements. Moves the selected element down in the activity input tree. Expands the elements in the Activity Input area to display elements that are mapped to the currently selected element or its sub-elements. The element can be later pasted.Buttons. Type Documentation. or an element of datatype any can be coerced into a specific datatype. TIBCO BusinessWorks Process Design Guide . Expand This menu item has two sub-menus: Content and All.

Inserts a new element or XSLT statement in the activity input schema on the same level of the hierarchy as the currently selected element. Deletes the selected element and all of its child elements. XPath. This displays the Move Into New Statement dialog that allows you to choose the statement you wish to move the element into. See XSLT Statements on page 141 for more information about XSLT statements. See XSLT Statements on page 141 for more information about XSLT statements. See Chapter 9. on page 147 for more information about XPath and the XPath formula builder.110 | Chapter 8 Mapping and Transforming Data Table 10 Input tab toolbar buttons Button Right-Click Menu Move In Description Moves the currently selected element into a new statement. such as Choice or If. You can use this editor to create an XPath statement for this input element. Add Child. Delete Delete All Insert. Verifies the XSLT template you have created in the Activity Input panel against the activity’s expected input. See Repairing Incorrect Mappings on page 117 for more information. Invokes the XPath formula builder. Mapper Check and Repair. Edit Statement. See the description of the Statement menu item below for more information. A list of errors and warnings appear and you can choose which items you wish to fix. Allows you to modify an XSLT statement for the element. See XSLT Statements on page 141 for more information about XPath statements. TIBCO BusinessWorks Process Design Guide . TIBCO BusinessWorks attempts to fix simple problems such as adding missing activity input items that are expected. The right-click menu item Statement provides a shortcut for multi-line statements. You can add one element or XSLT statement at a time with this button. Adds a statement for a child element to the currently selected element. Edit XPath Formula Builder.

Rolls back the last operation performed. You can use the Type Documentation button to obtain any available documentation on any node in the Process Data or Activity Input schema trees.Buttons. TIBCO BusinessWorks Process Design Guide . Expand>Errors expands the currently element so that all sub-elements that have an error in their expression are visible. The element can be later pasted to a new location. and Icons 111 | Table 10 Input tab toolbar buttons Button Right-Click Menu Expand Description This menu item has three sub-menus: Content. This is also called a branch in the schema tree. See Right-Click Menu on page 119 for a description of the sub-items of this menu. Performs the last operation that was undone with the Undo menu item. Deletes the selected element. Expands the elements in the Process Data area to display elements that are mapped to the currently selected element or its sub-elements. Menus. Expand>All expands all sub-elements of the currently selected element. Pastes the last element that was copied or cut. Table 11 describes the icons used for schema items. Copies the selected element. Show Connected Statement Undo Redo Cut Copy Paste Icons for Schema Element Datatypes Schema elements also have a set of associated icons to indicate their type. and All. This menu item contains shortcuts that allow you to easily add the desired XSLT statement(s) with one menu item instead of adding the statement(s) with the Insert button. Table 11 Icons for schema items Icon Description Complex element that is a container for other datatypes. Expand>Content expands the current element so that all sub-elements that have a mapping or expression are visible. Errors.

However. a question mark icon signifies an element is optional in the Process Data schema or in a hint in the Activity Input. Data in this schema element can be any datatype. This can be any of the following datatypes: • • • • • • • • • Time Date Date & Time Duration Day Month Year Month & Year Day & Month Simple binary (base 64) or hex binary value. The qualifier icons have different meanings depending upon where they appear. Choice. Simple decimal (floating point) number. Simple boolean value. Specifies that the actual schema element can be one of a specified set of datatypes. but not displayed in the Activity Input area. For example. in an XSLT statement.112 | Chapter 8 Mapping and Transforming Data Table 11 Icons for schema items Icon Description Simple string or character value. TIBCO BusinessWorks Process Design Guide . Simple Date or Time. Represents a schema item that can be any datatype. the question mark signifies the statement is "collapsed" and an implicit "if" statement is set. Simple integer value. Qualifier Icons Schema elements can have additional icons that specify qualifications.

An asterisk indicates the item repeats zero or more times. Table 12 Additional icons for hints Qualifier Process Data or Hint No qualifier indicates the element is required. TIBCO BusinessWorks Process Design Guide . You can set an element explicitly to null by clicking the Edit Statement button for the element. Menus. A plus sign indicates the item repeats one or more times. This occurs when you map an optional element from the process data to an optional element in the Activity Input schema or if you specify Surround element with if test on the Content tab of the Edit Statement dialog. then checking the Set Explicit Nil field on the Content tab of the Edit Statement dialog. Statement N/A An implicit "if" statement is set for this statement. A question mark indicates an optional Item. N/A N/A A null sign indicates the item is explicitly set to null. A null sign indicates the item may be set to null.Buttons. and Icons 113 | Table 12 describes the additional qualifiers that appear next to the name of schema items.

you can specify a constant. Date and Datetime Strings in Constants In constant expressions used in activity input bindings. Constants can also be used in functions and search predicates. Constants can be strings or numeric values. To specify a string. When TIBCO BusinessWorks generates datetime strings (for example in the process debugger display for process data). the value: "2002-02-10T14:55:31. 31 seconds and 112 milliseconds after 2pm on February 10th. 2002 in a timezone that is 8 hours. For example. UTC time is always used. so you are encouraged to always use timezones. TIBCO BusinessWorks Process Design Guide . enclose the string in quotes. To learn more about complex XPath expressions that use functions and search predicates. the value is interpreted in the timezone of the machine that is performing the parsing. 0 minutes behind UTC.114 | Chapter 8 Mapping and Transforming Data Specifying Constants For each element in the activity input schema tree. on page 147. type the number into the schema element’s mapping field. This can lead to complications if you are processing data from different timezones. see Chapter 9.112-08:00" is 55 minutes. datetime values are read in according to the ISO 8601 standard. as described in the XML Schema specification. The following illustrates specifying the string "USA" for the Country item and 94304 for the PostalCode item of an input schema. If no timezone field is present. To specify a number.112Z which is the equivalent time in the UTC timezone. The output for the example above is: 2002-02-10T14:55:31. XPath.

org/2001/XMLSchema. the content of the document is checked to ensure that elements in the document are actually of the specified datatypes.0 and Xpath 2. For example. See Xquery 1. See XML Schema Part2: Datatypes specification at http://www.org/2003/11/xpath-datatypes. if you pass an XML document to a Parse XML activity.w3.w3.org/TR/2003/WD-xpath-functions-20031112/ for more information on the proper representation of these datatypes.org/TR/2004/PER-xmlschema-2-20040318/ for more information on the proper representation of these datatypes.w3. Datatype validation listed with the prefix xsd: is defined in the namespace http://www.0 Functions and Operators specification at http://www. Datatype validation listed with the prefix xdt: is defined in the namespace http://www. Table 13 describes the validation behavior.Data Validation 115 | Data Validation Data passed as input to an activity or from an event received by a process starter is validated to ensure that it conforms to its specified datatype. Table 13 Datatype validation Data Type Built-In Primitive Types boolean decimal float double string duration yearMonthDuration dayTimeDuration dateTime time date xsd:boolean xsd:decimal xsd:float xsd:double xsd:string xsd:duration xdt:yearMonthDuration xdt:dayTimeDuration xsd:dateTime xsd:time xsd:date Validation TIBCO BusinessWorks Process Design Guide .w3.

116 | Chapter 8 Mapping and Transforming Data Table 13 Datatype validation Data Type gYearMonth gYear gMonthDay gDay gMonth hexBinary base64Binary anyURI QName NOTATION untypedAtomic Validation xsd:gYearMonth xsd:gYear xsd:gMonthDay xsd:gDay xsd:gMonth xsd:hexBinary xsd:base64Binary xsd:anyURI xsd:QName xsd:NOTATION xdt:untypedAtomic Built-In Derived (Atomic) Types integer nonPositiveInteger negativeInteger long int short byte nonNegativeInteger unsignedLong unsignedInt unsignedShort unsignedByte positiveInteger xsd:integer xsd:nonPositiveInteger xsd:negativeInteger xsd:long xsd:int xsd:short xsd:byte xsd:nonNegativeInteger xsd:unsignedLong xsd:unsignedInt xsd:unsignedShort xsd:unsignedByte xsd:positiveInteger TIBCO BusinessWorks Process Design Guide .

click the Mapper Check and Repair button. Errors can occur for a number of reasons. and therefore must be specified the activity’s input schema has changed and existing statements may no longer be valid the XPath formula for an element may contain an error You should correct any errors before attempting to test or deploy your process definition. and TIBCO BusinessWorks will attempt to fix the problem. For example. • • • a required element has no statement. TIBCO BusinessWorks Process Design Guide . This button displays a dialog with all potential problems in the specified mappings. You can select the Fix checkbox for potential errors.Repairing Incorrect Mappings 117 | Table 13 Datatype validation Data Type normalizedString token language Name NCName ID IDREF ENTITY NMTOKEN Validation xsd:normalizedString xsd:token xsd:language xsd:Name xsd:NCName xsd:ID xsd:IDREF xsd:ENTITY xsd:NMTOKEN Repairing Incorrect Mappings Any incorrect statements are displayed in red in the Activity Input panel. To help find potential problems in your mappings.

When you click OK. you can simply select the root input element and press the delete key on your keyboard as a shortcut for the procedure above. depending upon whether you wish to fix the problem or leave the problem until a later time. You must repair these items manually. perform the following: 1. and therefore there is no checkbox in the Fix column for these items. Delete the root element of the activity’s input by selecting it and clicking the Delete button. If you want to return to the original expected activity input and remove all of the currently specified mappings. You can select or clear the Fix checkbox for each item. Click the Mapper Check and Repair button. Figure 25 Mapper check and repair dialog Some potential problems in the Mapper Check or Repair dialog cannot be fixed easily. 3. and therefore TIBCO BusinessWorks cannot automatically fix the problem. For example. 2. if an element expects a string and you supply a complex type. Click OK. A new element named foo has been added to the schema and the expected element token has been removed. any items that are marked for fixing are repaired. TIBCO BusinessWorks Process Design Guide . The Mapper Check and Repair dialog displays these problems with the Fix checkbox checked.118 | Chapter 8 Mapping and Transforming Data For example. the corrective action to fix the problem is not clear. 4. Alternatively. Figure 25 illustrates an activity input schema for the External Command activity. Select the Fix checkbox for all items.

only add or modify one statement at a time. Figure 26 illustrates dragging an element to the left. Shortcuts The Move In. the activity’s input reverts to the state when the activity is first dragged into the design panel. Duplicate — a shortcut for creating a duplicate of the currently selected element (including any mappings or XPath formulas for the element). • • • • Dragging to the Left Dragging an element in the Activity Input schema to the left past the divider between the two areas of the Input tab changes a hint into an XSLT statement. and Edit Statement buttons on the Input tab toolbar are ways to manually manipulate XSLT statements in the Activity Input area. however. Surround with For-Each-Group — a shortcut for moving the current element into a For-Each-Group statement and adding a Group-By grouping statement. Surround with If — a shortcut for adding an if statement and placing the currently select element as the sub-element of the if.Shortcuts 119 | After deleting all mappings and schema items and then repairing the input schema. a popup menu appears. Right-Click Menu When you select an element in the Activity Input schema and right-click. • Surround with Choice — a shortcut for adding a choice statement and its associated conditions or otherwise statements around the currently selected element. The duplicate is added below the currently selected element. These buttons. Add Child. Insert. Also. This section describes shortcuts for manipulating XSLT statements. The Statement menu item contains several sub-items that are useful shortcuts for creating XSLT statements. TIBCO BusinessWorks Process Design Guide . there are some situations where you wish to convert a hint into a statement without performing any mapping. Surround with For-Each — a shortcut for moving the current element into a For-Each statement.

Dragging the ID element past the divider turns the hint into a statement. This shortcut is useful in the following situations: • • • When you have a complex element with no sub elements and no content. TIBCO BusinessWorks Process Design Guide . you can paste it into a text editing tool to view or modify the code. You can choose any element in the Activity Input area and select Copy from the right-click menu or press the Control-C keys to copy the XSLT statement for the element.120 | Chapter 8 Mapping and Transforming Data Figure 26 Dragging to the left to change a hint to a statement Before dragging. When you have a choice element. Once the XSLT is copied. Cutting and Pasting The Activity Input area is an XSLT template for specifying the activity’s input schema. dragging to the left brings up the Mapping Wizard and allows you to choose a type for the element. Pasting XSLT code from the copy buffer places the code above the currently selected element in the Activity Input area. You can also paste arbitrary XSLT code into the Activity Input area using the right-click menu or the Control-V keys. dragging to the left brings up a dialog that allows you to specify the type for the element. the ID element is a hint. When you have an element of type Any.

If the element exists. TIBCO BusinessWorks Process Design Guide . Optional to Nillable Specifies that the statement should test if the optional process data element exists. the value of the activity input element is set to the value of the process data element. Required to Required Specifies that the statement should always include the required activity input element and its value should be obtained from the required process data element that the element is mapped to. This section describes the result of mapping different types of elements. Optional to Optional Specifies that the statement should test if the process data element is present. the activity input element should be created and set to the value of the process data element. the optional element is omitted from the activity’s input. the value of the process data element is assigned to the required activity input element. If the process data element does not exist. then an example is given that illustrates these mappings and shows the XSLT code that is generated automatically when these mappings are performed.Shortcuts 121 | Automatic Testing When you map process data elements to activity input elements. If the process data element is not present. Nillable to Nillable Specifies that both the process data and activity input elements can be nil. The value of the activity input element is set explicitly to nil if that is the value of the process data element. The types of mappings are described. Therefore. the necessary tests are automatically placed into the activity input XSLT template. However. In the simplest case of mapping a required element in the process data schema to a required activity input element. and if so. more complex tests are necessary. When you drag the process data element to the activity input element. the behavior of the mapping depends upon the types of elements you are mapping. the element is omitted from the activity input schema. when elements are optional or nillable. include the optional element in the activity’s input.

Item and Amount illustrate mapping required elements to other required elements. Optional & Nillable to Optional & Nillable Specifies that if the optional process data element exists. Otherwise. The Pickup element illustrates mapping an optional element to a nillable element. Below is the XSLT template illustrated by the mappings in Figure 27. and Nillable Elements Figure 27 illustrates the different types of mappings when elements are required. The Discount element illustrates mapping an optional element to an optional element. the optional element is omitted from the activity input. <?xml version="1. if the process data element is nil. Example of Mapping Required.122 | Chapter 8 Mapping and Transforming Data Nillable to Optional Specifies that the statement should test if the process data element has a value specified. Optional. the optional element in the activity input should be set to the value of the process data element. set the value of the activity input element explicitly to nil.org/2001/XMLSchema-instance" TIBCO BusinessWorks Process Design Guide .0" encoding="UTF-8"?> <xsl:template xmlns:xsi="http://www. or nillable. If the process data element is not present. The CustomerAddr and ShipTo elements illustrate mapping an optional and nillable element to an optional and nillable element. then include the optional activity input element in the input schema. If the process data element is nil. optional. then omit the optional element from the activity input schema. optional. and nillable elements In the example above. set the value of the activity input element to the value of the process data element. You can see from the XSLT code that certain mappings are automatically surrounded by tests to create the appropriate input schema. The OnSale element illustrates mapping a nillable element to an optional element. and if so.w3. Figure 27 Examples of mapping required. If the process data element is not nil.

.org/1999/XSL/Transform" xmlns:xsd="http://www.tibco.)"> <OnSale> <xsl:value-of select="$RetrieveOrder/IncomingOrder/Order/OnSale"/> </OnSale> </xsl:if> <xsl:if test="$RetrieveOrder/IncomingOrder/Order/Discount"> <Discount> <xsl:value-of select="$RetrieveOrder/IncomingOrder/Order/Discount"/> </Discount> </xsl:if> <pfx:ShipTo> <Pickup> <xsl:choose> <xsl:when test= "exists($RetrieveOrder/IncomingOrder/Order/Pickup)"> <xsl:value-of select= "$RetrieveOrder/IncomingOrder/Order/Pickup"/> </xsl:when> <xsl:otherwise> <xsl:attribute name="xsi:nil">true</xsl:attribute> </xsl:otherwise> </xsl:choose> </Pickup> <xsl:if test="$RetrieveOrder/IncomingOrder/Order/StoreLocation"> <StoreLocation> <xsl:value-of select= "$RetrieveOrder/IncomingOrder/Order/StoreLocation"/> </StoreLocation> </xsl:if> <xsl:if test="$RetrieveOrder/IncomingOrder/Order/CustomerAddr"> <ShipTo> <xsl:copy-of select= "$RetrieveOrder/IncomingOrder/Order/CustomerAddr/@xsi:nil"/> <xsl:value-of select= "$RetrieveOrder/IncomingOrder/Order/CustomerAddr"/> </ShipTo> </xsl:if> </pfx:ShipTo> </Order> </xsl:template> TIBCO BusinessWorks Process Design Guide .com/bw/process/2003" xmlns:xsl="http://www.org/2001/XMLSchema" xmlns:pfx="http://www.Shortcuts 123 | xmlns:pd="http://xmlns.w3.true&quot.&quot.com/xmlns/ae2xsd/2002/05/ae/Order"> <Order> <Item> <xsl:value-of select="$RetrieveOrder/IncomingOrder/Order/Item"/> </Item> <Amount> <xsl:value-of select="$RetrieveOrder/IncomingOrder/Order/Amount"/> </Amount> <xsl:if test="$RetrieveOrder/IncomingOrder/Order/OnSale/@xsi:nil!= (&quot.tibco.1&quot.w3.

you may wish to select a specific order from a list of orders where the item ordered is itemID #34129. See Chapter 9. Using XPath TIBCO BusinessWorks uses XPath (XML Path Language) to specify and process elements of the Activity Input schema. perform the following: 1. One situation is when you wish to insert a row into a database table and you wish to supply a NULL for one of the columns. There are many methods to insert or modify XSLT statements in the Activity Input schema. TIBCO BusinessWorks Process Design Guide . This section describes some complicated mapping scenarios and how to achieve the desired mappings using the tools available. you do not have to follow the same procedures outlined in this section to achieve the correct set of statements. you may wish to set an element explicitly to nil. 3.124 | Chapter 8 Mapping and Transforming Data Examples of Mappings Some mappings require several steps to achieve the desired results. Select the input element you wish to set to nil. In the Activity Input area. XPath. Click the Edit Statement button on the Input tab toolbar. 2. However. For example. numbers. and booleans. One of the most common uses of XPath is to filter a list for specific elements. You can also use XPath to perform basic manipulation and comparison of strings. dates. on page 147 for more information on how to use XPath. You can use any valid XPath expression in the XSLT statements in the Activity Input area. Click the Content tab of the Edit Statement dialog. The examples in this section illustrate the simplest procedures to obtain the desired results. the XPath expression might be: $RetrieveOrders/Order[itemID=34129]. Setting an Element Explicitly to Nil In some situations. To do this. To set an input element explicitly to nil. it appears as [<< Filter >>] to indicate that you must supply the filter expression. when a search predicate is required. XPath expressions have search predicates for performing filtering.

TIBCO BusinessWorks Process Design Guide . The element’s formula becomes blank and uneditable (because nil is the value of the element) and the explicit nil qualifier icon appears next to the statement .Examples of Mappings 125 | 4. Check the checkbox in the Set Explicit Nil field.

For example.126 | Chapter 8 Mapping and Transforming Data Merging Input from Multiple Sources You may have multiple elements in the Process Data that you wish to map to one repeating element in the Activity Input. you may have multiple formats for customer records and you wish to create a single. the schemas are the following: You wish to combine customers into a single repeating structure to create a mailing list. each having a different format for the address. TIBCO BusinessWorks Process Design Guide . merged mailing list containing all customers in one format. The following procedure describes how to map multiple elements into a single repeating element. In this example. Multiple types of customers are retrieved.

Select the repeating element in the Activity Input area. map $Retrieve-Customer-Type1/Customer to MergeMailingList/CustomerList/Customer. you need two copies of the repeating element.Examples of Mappings 127 | 1. For example. right-click. but the two copies in the Activity Input area make it simpler to perform two different mappings. one for each format. Map one of the elements from the Process Data to the first copy of the repeating element in the activity input. and select Statement > Duplicate from the popup menu. Because you are creating two different formulas for mapping. 2. The resulting output contains only one repeating customer element. TIBCO BusinessWorks Process Design Guide .

The mapping wizard asks if you wish to automatically map items with the same names. map $Retrieve-Customer-Type2/Record to MergeMailingList/CustomerList/Customer. Click Finish to accept the default mappings. 3. choose the For Each option and click Next. In the Mapping Wizard dialog. TIBCO BusinessWorks Process Design Guide . Map the other element from the Process Data to the second copy of the repeating element in the activity input. Choose the For Each option and click Next.128 | Chapter 8 Mapping and Transforming Data The Mapping Wizard dialog appears and presents choices for what you would like to accomplish. For example.

TIBCO BusinessWorks Process Design Guide .Examples of Mappings 129 | The mapping wizard presents you with an option to automatically map elements with the same name. Select the Address element and click the XPath Formula Builder icon in the Input tab toolbar. drag a concat() function into the XPath Formula field. This function is used to concatenate the three elements in the Record element in the process data area to one Address element in the activity’s input. Click Finish to accept the default mappings. 4. In the XPath Formula Builder.

Click Apply. TIBCO BusinessWorks Process Design Guide . Then.130 | Chapter 8 Mapping and Transforming Data Click the Data tab. Drag the $current()/Address/state element into the << string2 >> placeholder in the concat() function. 5. then click Close to dismiss the XPath Formula Builder dialog. then drag the $current()/Address/street element into the << string1 >> placeholder in the concat() function. Drag the $current()/Address/zip element into the position of the third string in the concat() function. add a comma to the end of the function to include a third string to concatenate.

1. Choose the repeating element in the Activity Input schema that holds the grouped data. that element is Orders. Each customer ID will. you may have list of all orders that have been completed. In this example.. For example..Examples of Mappings 131 | 6. contain a list of orders. You may want to organize that list so that you can group the orders placed by each customer. This scenario typically occurs when you retrieve records from a relational database and the records must be structured differently. Right-click on this element and choose Statement > Surround with For-Each-Group. This results in the following mapping: Converting a List Into a Grouped List You may need to convert a flat list of items into a more structured list. The following procedure describes how to map the flat list of orders into a list grouped by customer ID. the schemas are the following: Flat list of orders placed by all customers. Each item in the repeating element Requests lists an order. This is a shortcut to create a For-Each-Group statement with TIBCO BusinessWorks Process Design Guide . In this example. in turn. The resulting schema is a repeating list of Orders. each item in the list is a customer ID. The same customer can have mutliple orders in this list. from the pop-up menu.

and the current-group() function allows you to access the items in the Requests repeating element that correspond to the group that is currently being processed. TIBCO BusinessWorks Process Design Guide . 3.132 | Chapter 8 Mapping and Transforming Data the Orders element as a child element and a Grouping statement to contain the element you wish to group-by. 2. Adding the Grouping statement creates the $=current-group() element in the Process Data area. The Grouping statement creates the list grouped by the desired element. customerID is the grouping element. Drag the element you wish to group by from the Process Data area to the Grouping statement in the Activity Input area. In this example. Drag the repeating element from the Process Data area to the For-Each-Group statement.

Examples of Mappings 133 | 4. TIBCO BusinessWorks Process Design Guide . In this case. Map the remaining element from the current-group() element into the desired element in the For-Each group. Choose this option in the mapping wizard. 5. Map the current-group() element in the Process Data area to the repeating element Order under the Customer element in the Activity Input area. The default choice in the mapping wizard for this mapping is to create a For-Each. The mapping wizard asks if you wish to map items with the same name in the current group and the orders group. quantity would map to Quantity automatically. and Item must be mapped to ItemName. This creates an item in the Order list for each item in the current customer ID group that is being processed.

134 | Chapter 8 Mapping and Transforming Data 6. each grade corresponds to the student ID in the same position in the student ID list. you may have a list of student IDs and a list of grades. Two repeating lists contain corresponding student IDs and grades. In this example. The following procedure describes how to merge the two repeating elements containing corresponding data into one repeating element. Map the customerID element in the Requests element into the Customer element in the Activity Input area. For example. Merging Two Corresponding Lists You may need to merge two lists that have corresponding items. TIBCO BusinessWorks Process Design Guide . the schemas are the following: The resulting merged list will contain a both student ID and grade in a single repeating element.

Examples of Mappings 135 | 1. Drag the second repeating element into the For-Each statement. TIBCO BusinessWorks Process Design Guide . This brings up the mapping wizard with the default choice of creating a For-Each statement. 2. the $RetrieveStudentIDs/Students/Record is the first repeating element. Click Finish in the Mapping Wizard dialog to create the For-Each statement. Map the first repeating element from the Process Data area into the Grades repeating element in the Activity Input area. In this example.

One variable is to hold the position number of the current item being processed. The two variables appear in the Process Data area once you have completed this step. Create the variables with the default names supplied by the mapping wizard. TIBCO BusinessWorks Process Design Guide . 4. The $=[item=] element contains a statement to retrieve the item in the second repeating element that corresponds to the position of the item in the first list that is currently being processed. or choose your own names for these variables. The $=[index=] element contains the XPath formula position() to set the element with the current position number of the list item being processed. The Mapping Wizard dialog appears asking you to chose an option. Merging two parallel repeating structures requires two variables. The mapping wizard prompts you to name these two variables. Click Finish to proceed. and the other variable is to hold the item in the second list that corresponds to the position of the item in the first list. The two variables also appear in the Activity Input area with the correct XPath statement to produce the desired result. Choose the Merge parallel repeating structure option and click Next.136 | Chapter 8 Mapping and Transforming Data 3.

The schema is for a generic incoming message that can have any type of body.Examples of Mappings 137 | 5. 6. the any element is coerced into an Order type so that it can be mapped to a choice element. TIBCO BusinessWorks Process Design Guide . you may know the datatype of the element. Map the ID element to the StudentID element in the Activity input. and you can coerce the element into a specific type. In these situations. The Coercions button in the Input tab toolbar allows you to create and manage your coercions. Map the $=item/Grade element to the Grade element in the Activity Input area. however. The following example illustrates a schema with an element defined as the "any element" datatype. the datatype of a Process Data element may be undefined. Coercions In some situations. In the example.

1. You can create. the schemas are the following: The incoming message can have a body of type any element. modify. use the XPath field to specify the location of the element. Click the Coercions button in the Input tab toolbar.138 | Chapter 8 Mapping and Transforming Data In this example. Click the Element radio button to specify that you are specifying a schema element. click the Insert button (+) to add a coercion for the currently selected element. This example attempts to illustrate the simplest method to achieve the desired result. Select the element of type any element in the Process Data schema. The Coercions dialog allows you to manage all of your coercions for an activity in one dialog. or delete coercions for any element in the Process Data schema using this dialog. The activity input is expecting either an Order or a CreditLimitIncrease for the incoming message. In the Coercions dialog. The following procedure describes how to coerce the Body element of the incoming message into a specific datatype and map it to a choice element. not just the currently selected element. If you are creating a coercion for an element that is not currently selected. There are many ways of accomplishing the same result as this example. TIBCO BusinessWorks Process Design Guide .

3. dialog. select the schema that you would like to specify Click OK to coerce the element into the datatype of the selected schema element.. map the coerced Order element to the choice element in the Activity Input area. The following would be the resulting schema where the element of the datatype any element has been replaced with the Order schema. Map the Name element to the Name element in the Activity Input area.Examples of Mappings 139 | 2. Click the Browse Resources button next to the Schema field to browse a list of schemas that can be used. Then.. In the Select a Resource. TIBCO BusinessWorks Process Design Guide .

Click Next to continue. Select Order and click Next. TheMmapping Wizard then asks if you wish to automatically map elements with the same name.140 | Chapter 8 Mapping and Transforming Data The Mapping Wizard dialog appears and asks if you wish to create an Order or a CreditLimitIncrease element. Click Finish to accept the default mappings. a For Each is used because this construct allows you to map the individual items of the Order element. TIBCO BusinessWorks Process Design Guide . Even though there is only one element in the Process Data schema (the Message element is not repeating). The Mapping Wizard then asks you to create a For Each.

you can optionally specify the kind of value the attribute will have and whether the attribute should be surrounded by an if statement. You can also specify the type of value for the attribute. and optionally the namespace for the attribute. Attribute Allows you to specify an attribute.XSLT Statements 141 | 4. <ns:attribute namespace="mns" name="lastName"/> When attributes are created. For example. You can add or edit these statements by clicking the Edit Statement button or these statements can be added automatically by selecting them from the dialogs that appear when you drag and drop elements from the Process Data tree to the Activity Input tree. XSLT Statements The following sections describe the XSLT statements you can add to your Activity Input. like so: <ns:attribute namespace="mns" name="lastName"/> "Smith" </ns:attribute> TIBCO BusinessWorks Process Design Guide . you can specify the value of the last name attribute to be a constant. The following is the completed mapping. XSLT Equivalent The following is an attribute named "lastname".

. performs an action. Specify the condition in the when element as an XPath expression. Comments are delimited by <!-. If the node set is empty (no files were transferred). TIBCO BusinessWorks Process Design Guide ...org/1999/XSL/Transform"> <ns0:when test="$FTP-Put/FTPPutOutputFile/FileTransferred" > < something here .and -->. and if so.> </ns0:otherwise> </ns0:choose> Comment Places a comment in the XSLT template. XSLT Equivalent <ns0:copy xmlns:ns0="http://www. Only the node is copied.142 | Chapter 8 Choose Mapping and Transforming Data Provides a way to select transformation to perform based on an expression. no children of the node are copied.w3. XSLT Equivalent <!-.org/1999/XSL/Transform" select="$Query/resultSet"/> Copy-Contents-Of Copies the selected node’s contents.comment here --> Copy Copies the selected node to the current node in the input tree. > </ns:0when> <ns0:otherwise> < something here . This is useful if you wish to copy an element to a new element with a different name.w3. XSLT Equivalent The following determines if the node set for FilesTransferred contains any files. <ns0:choose xmlns:ns0="http://www.. a different action is performed. You can optionally specify an otherwise condition for processing all elements that do not meet any of the specified when conditions.

This is useful if you wish to process each item of a repeating element once.org/1999/XSL/Transform" select=""/> Element Creates an element with the specified name.XSLT Statements 143 | XSLT Equivalent <ns:element namespace="foo" name="bar"> <ns:copy-of select="null/@*"/> <ns:copy-of select="null/node()"/> </ns:element> Copy-Of Creates a copy of the selected node. XLST Equivalent <ns0:copy-of xmlns:ns0="http://www. XSLT Equivalent The following iterates over the list of files transferred from an FTP Put activity and outputs an element with the name of each file for each file transferred. including the node’s children.w3. XSLT Equivalent <elementName>value</elementName> For-Each Performs the specified statements once for each item in the selected node. <ns:for-each select="$FTP-Put/FTPPutOutputFile/FileTransferred"> <fileName> <ns:value-of select="$FTP-Put/FTPPutOutputFile/FileTransferred/Name"/> </fileName> </ns:for-each> TIBCO BusinessWorks Process Design Guide . Both the copied node and the destination node must have the same name and structure.

144 | Chapter 8 Mapping and Transforming Data For-Each-Group Groups the items in a list by a specified element.org/1999/XSL/Transform"/> Generate PI Places a processing instruction into the XSLT template. If the test attribute evaluates to true.w3.w3. See Converting a List Into a Grouped List on page 131 for an example of using the For-Each-Group statement.org/1999/XSL/Transform" name=""/> If An if statement is used to surround other statements in an XSLT template to perform conditional processing.org/1999/XSL/Transform" select=""/> Generate Comment Places a comment element into the XSLT template. XSLT Equivalent <ns0:for-each-group xmlns:ns0="http://www.org/1999/XSL/Transform" test="not(position()=last())"> <ns:attribute name="OrderItem"> <ns:value-of select= "$GetOrderInformation/OrderInformation/OrderDetails/OrderItem"/> TIBCO BusinessWorks Process Design Guide . otherwise they are not output. XSLT Equivalent The following if statement surrounds an attribute for processing order items. All items except the last order item are retrieved from the output of the GetOrderInformation activity. the statements in the if are output. The last order item is not output. This comment will be generated into the activity’s output.w3. This statement requires a Grouping statement to specify which element to group-by. Comment elements have the following syntax: <ns0:comment xmlns:ns0="http://www. XSLT Equivalent <ns0:processing-instruction xmlns:ns0="http://www.w3. <ns:if xmlns:ns="http://www.

org/1999/XSL/Transform" select=""/> Variable Adds a local variable for use in the current mapping. Adding a variable is also useful if you perform the same computation repeatedly. You can supply any XPath expression to the new variable in the Activity Input area (either through mapping or through the XPath Formula Builder). in this case 40 times. XSLT Equivalent <ns0:variable xmlns:ns0="http://www. the variable (in the Process Data area) can be mapped to any activity input item. create a local variable to hold process variables with a large number of elements and use the local variable in XPath expressions instead of the process variable. it appears in the Activity Input and Process Data areas. TIBCO BusinessWorks must retrieve the current process variable for each XPath expression. to improve performance. Adding a variable is useful when you wish to join two repeating elements into a single list. the retrieval of the current process variable occurs 40 times per iteration of the loop. You can specify the name of the variable and whether you wish the variable to have a select attribute.XSLT Statements 145 | </ns:attribute> </ns:if> Value-Of Specifies a value-of statement. and you map each of the sub-elements to a corresponding input item. but you may insert this statement explicitly. When you add a local variable. if you have a process variable with 40 sub-elements. the data is retrieved only once and used for all mappings containing the variable. You can map the results of the computation to several activity input items instead of recreating the computation for each item.w3. This is normally done implicitly by specifying the formula for an activity input item. Once the variable’s contents have been supplied. Therefore.org/1999/XSL/Transform" name="var" select="$RetrieveResults/resultSet"/> TIBCO BusinessWorks Process Design Guide . Variables can also improve performance of mappings for large data structures.w3. For example. then map the combined list to an activity input item. XSLT Equivalent <ns:value-of xmlns:ns="http://www. If this mapping appears in a loop. With a variable.

146 | Chapter 8 Mapping and Transforming Data TIBCO BusinessWorks Process Design Guide .

refer to the XPath specification (which can be obtained from www. page 151 String Representations of Datatypes. page 153 Date and Time Functions. Topics • • • • XPath Basics. This section covers the basics of XPath and its use in TIBCO BusinessWorks.org). For a complete description of XPath. page 155 TIBCO BusinessWorks Process Design Guide .w3. TIBCO BusinessWorks uses XPath as the language for defining conditions and transformations. numbers. page 148 The XPath Formula Builder.| 147 Chapter 9 XPath XPath (XML Path Language) is an expression language developed by the World Wide Web Consortium (W3C) for addressing parts of XML documents. and booleans. XPath also has basic manipulation functions for strings.

or it can be a complex element. numbers. That is.148 | Chapter 9 XPath XPath Basics TIBCO BusinessWorks uses XPath (XML Path Language) to specify and process elements of data schema. Complex elements are structures that contain other schema elements. Both simple and complex elements can also repeat. To use XPath in TIBCO BusinessWorks. and so on). the following schema may be available for an activity’s input: TIBCO BusinessWorks Process Design Guide . TIBCO BusinessWorks represents the data as a schema tree. numbers. These data schema are either process variables or input schema for an activity. Regardless of where the data comes from or its format. and booleans. either simple elements or other complex elements. Addressing Schema Elements All process data and activity input are represented as an XML schema. refer to the XPath specification (which can be obtained from www. XPath is used to specify which schema element you would like to refer to.w3. For example. You can also use XPath to perform basic manipulation and comparison of strings. but you may wish to learn more about XPath when building complex expressions.org). For a complete description of XPath. you need only be familiar with the basic XPath concepts. booleans. they can be lists that store more than one element of the given type. The data can be simple (strings.

if your evaluation context is $GetOrderInformation/ShipName. until the desired location is named. or a particular starting node in a schema tree. The path is relative to the evaluation context — RequiredDate is one level higher in the schema tree than the elements of ShipName. each a root node in the process data area: GetCustomerInformation.. For example.XPath Basics 149 | The process data area of the example input tab illustrates the output schema of the activities in the process. GetOrderInformation. For example. If you have an evaluation context. There are three output schema. you start with the root node and then use slashes (/) to indicate a path to the desired data element. if you wish to specify the Street attribute in the ShipName complex element that is in the GetOrderInformation node. you can specify the relative path to other elements in the tree. then continues with node names using slashes. Evaluation Context XPath also has a method for referencing relative paths from a particular node. Namespaces Some schema elements must be prefixed with their namespace. then you can reference the sub-items of ShipName without specifying the entire path. you would use the following syntax: $GetOrderInformation/ShipName/Street The path starts with a dollar sign to indicate it begins with a root node. The namespace is automatically added to elements that require this when creating mappings on the Input tab of an activity or when dragging and dropping data in the XPath formula builder. If you wish to reference $GetOrderInformation/RequiredDate. like a file or directory structure. To reference a particular data item in any of these schema. and GetOrderId. TIBCO BusinessWorks Process Design Guide . Each of these schema has its own associated structure. GetCustomerInformation has a set of simple values and GetOrderInformation has simple data and other complex data. for example./RequiredDate. the relative path would be .

<comment here> --} For example. if you wish to find all elements after the first. For example. For example. to select the element whose ProductId is equal to "3A54". the following XPath expression contains a comment: $GetOrderInformation/ShipName/Street {-. You can test an element to determine if it is set to nil or not. For example. the $GetOrderInformation/OrderDetails/OrderItem item is a repeating element.150 | Chapter 9 XPath Search Predicates An XPath expression can have a search predicate. Testing For Nil Some elements can be explicitly set to nil. you would specify the following: $GetOrderInformation/OrderDetails/OrderItem[position()>1] See the online documentation available in the XPath formula builder for a list of the available operators and functions in XPath. you would specify the following: $GetOrderInformation/OrderDetails/OrderItem[ProductId="3A54"] You can also use functions and expressions in the search predicate. The search predicate is used to locate a specific element of a repeating schema item. the following XPath expression returns true if the $Order/Item/OnSale element is set to nil: $Order/Item/OnSale/@xsi:nil="true" Comments You can add comments to XPath expressions using the XPath 2. For example. you would specify the following: $GetOrderInformation/OrderDetails/OrderItem[1] The [1] specifies the first element of a repeating item. The syntax is: {-. See the description of the Java Custom Function shared configuration resource in TIBCO BusinessWorks Palette Reference for more information about creating custom functions and making them available in XPath. If you wish to select only the first item in the repeating element. Sub-items can also be examined and used in a search predicate.returns the street --} TIBCO BusinessWorks Process Design Guide . You can also build custom Java functions and make them available in XPath by using the Java Custom Function shared resource.0 syntax for comments.

TIBCO BusinessWorks Process Design Guide . Figure 28 illustrates using the XPath formula builder to drag and drop schema elements into function placeholders. If a function is dragged into the XPath formula window. The XPath formula builder allows you to drag and drop schema elements and XPath functions to create XPath expressions. All elements in this tree are available to drag and drop into the XPath Formula field. Table 14 XPath formula builder elements Element Data tab Description Displays the process data schema tree. Figure 28 The XPath formula builder Table 14 describes the different areas of the XPath formula builder. The schema elements. there are placeholders for each parameter of the function. such as when creating transformations on the Input tab of an activity. automatically become valid XPath location paths for the desired item.The XPath Formula Builder 151 | The XPath Formula Builder The XPath formula builder can be used where XPath expressions are allowed. You can drag and drop schema elements over the parameter placeholders to replace each placeholder. when dragged into the XPath Formula field.

they are listed there as well. See Evaluation Context on page 149 for more information about the evaluation context. These are categorized into groups and each constant can be dragged from the constants list into the XPath Formula field. The result of evaluating the function is displayed in the "Expression Evaluates To" panel. placeholders are displayed for the function’s parameters. Evaluation Context field XPath Formula field TIBCO BusinessWorks Process Design Guide .152 | Chapter 9 XPath Table 14 XPath formula builder elements Element Functions tab Description Displays the available XPath functions. When the function is placed into the XPath formula. If there are any errors in the expression. As you click on a function in the Function tab. You can drag and drop schema elements from the Data tab into the function’s placeholders. such as tabs. the documentation panel gives a brief description of the function and one or more examples. Constants are also defined for commonly used items. Displays the evaluation context of the expression field that the editor was invoked from. symbols. Displays the XPath formula you wish to create. These are categorized into groups and each function can be dragged from the function list into the XPath Formula field. Documentation panel Describes each selected function. into XPath formulas. Constants tab Displays the constants available for use in XPath expressions. see the description of the function that is displayed when it is selected in the XPath formula builder. You can drag and drop items from the Data tab or the Functions tab to create the formula. Constants are useful for inserting special characters. For more information about XPath functions. such as date formats. and so on.

the data is represented as a string. Also. Figure 29 illustrates using the XPath formula builder to create a valid function.String Representations of Datatypes 153 | Table 14 XPath formula builder elements Element Expression Evaluates To Panel Description Displays the result of evaluating the formula shown in the XPath Formula field. For example. supplying a floating point number to an XPath function in the Input tab of an activity often involves typing the number as a string into the input element. The function concatenates the data elements $GetCustomerInformation/Street and $GetCustomerInformation/City and places a space between the two elements. Figure 29 Creating an XPath formula String Representations of Datatypes When data must be represented in the input or output of an activity. If there are errors in the formula. TIBCO BusinessWorks Process Design Guide . TIBCO BusinessWorks follows the XPath 1. TIBCO BusinessWorks follows the XML Schema canonical format for all other datatypes. writing the output of an activity to a file requires that numeric data be serialized into string form. they are displayed here.0 standard for representing all numeric datatypes.

Date Datatypes Activities in TIBCO BusinessWorks implement dates in one of two ways. Mapper. Not a number is represented as NaN. xs:float. The XPath function false() is also represented as false. All decimal. and double numbers are compressed to an integer when represented.234E05’)" is represented as 123400). Boolean The boolean datatype is used to indicate a true or false state.000" is represented as 1). float. or the date is implemented according to the XPath 2. Positive and negative infinity are represented as Infinity and -Infinity. Therefore mapping a date output by a Java Code activity to the input of any other Java activity will result in the loss of the time zone information. 1970. xs:time. xs:boolean(’false’) and xs:boolean(’0’) are represented by false. Java Code. if there are only zeros following the decimal point (for example. Other Java activities (Java Method. Data is truncated if the number of digits exceeds the maximum precision for the datatype (for example. Conversion between these representations may result in a loss of information either because of the difference in time zone representation or the precision of the seconds. Activities that are associated with XML (for example. Java Method. "xs:float(’1. and xs:double. The second implementation supports arbitrary precision of the seconds component. xs:decimal.0 standards as a set of normalized components (xs:date. TIBCO BusinessWorks Process Design Guide . Numeric Datatypes Numeric datatypes include all types derived from xs:integer. Both zero and negative zero are represented as 0. Either a date is stored as the number of milliseconds since January 1. The XPath function true() is also represented as true. "xs:double(’1. xs:boolean(’true’) and xs:boolean(’1’) are represented by true.23456789’)" is represented as 1. and so on) with an optional time zone offset.2345679). and so on) do not use the time zone. Parse XML. "1. xs:dateTime. Java to XML. Dates output by the Java Code activity contain the time zone. Activities that are associated with Java (for example. and so on) use the first implementaton. Scientific notation is never used to represent a floating point number as a string (for example. and so on) use the second implementation.154 | Chapter 9 XPath The following sections describe the string representations of datatypes.0 or XQuery 1.

These functions are: • • • • • • format-dateTime(<<format>>. <<string>>) parse-date(<<format>>. Aug. August. 2003.text. Example AD y year Two ys return two-digit year. <<date>>) format-time(<<format>>. <<string>>) parse-time(<<format>>. Table 15 describes the alphabetic characters and their associated presentation in a date or time string. <<dateTime>>) format-date(<<format>>. unquoted alphabetic characters from A to Z and a to z represent the components of the date or time string. <<string>>) The format parameter of these functions is based on the format patterns available for the java. <<time>>) parse-dateTime(<<format>>. use ’’.SimpleDateFormat Java class. You can include non-pattern alphabetic characters in the string by quoting the text with single quotes. Table 15 Formatting characters in date or time strings Letter G Description Era Four or more Gs return the full name of the era. 03 M Month in year Three or more Ms return text name. 08 w W D d Week in year Week in month Day in year Day in month 48 3 254 28 TIBCO BusinessWorks Process Design Guide . In the format parameter.Date and Time Functions 155 | Date and Time Functions There are some functions in the XPath formula builder that allow you to parse or format strings that represent dates and times. To include a single quote.

RFC 822 four-digit time zone format Reserved 23 1 11 1 59 48 456 GMT-8:00 -8:00 — Z all other letters For any format pattern letter that returns a numeric value (for example.156 | Chapter 9 XPath Table 15 Formatting characters in date or time strings Letter F E Description Day of week in month Day in week Four or more Es return the full name of the weekday. the output is padded with zeros. TIBCO BusinessWorks Process Design Guide . Fri a AM/PM marker Four or more as return the full name. when the date or time has fewer digits than the number of characters in the format pattern. AM H k K h m s S z Hour in day (0-23) Hour in day (1-24) Hour in AM/PM (0-11) Hour in AM/PM (1-12) Minute in hour Second in minute Millisecond Time zone represented as a GMT offset. For parsing functions. Example 3 Friday. h. unless they are needed to determine the boundaries of adjacent fields. the number of letters in the format pattern represents the minimum number of digits. if the date or time has fewer digits than the number of pattern letters. w. and m). For formatting functions. the extra characters are ignored.

Table 16 Example date and time format patterns Date/Time Pattern "yyy.Date and Time Functions 157 | Table 16 illustrates some example date and time format patterns and the resulting string.MM. GMT-8:00 0:08 PM 010704120856-700 TIBCO BusinessWorks Process Design Guide . ’’yy" "hh ’o’’clock’ a. ’03 9 o’clock AM.dd G ’at’ HH:mm:ss" "EEE.3. MMM d. Mar 11.11 AD at 09:43:56 Tue. zzzz" "K:mm a" "yyMMddHHmmssZ" Result 2003.

158 | Chapter 9 XPath TIBCO BusinessWorks Process Design Guide .

Topics • • • • Overview of Error Handling. This chapter describes error handling in process definitions. page 160 Error Propagation. activities can encounter errors. page 164 TIBCO BusinessWorks Process Design Guide . page 160 The Error Process Variables. You may wish to add procedures to your process definitions for handling any expected or unexpected errors. page 162 Process Error Schemas.| 159 Chapter 10 Error Handling When executing business processes.

If the update is successful. There are two types of process variables that contain error data. and all activities that have an error transition are available in the Process Data panel after an error transition is taken. the following illustrates a simple process that begins with an HTTP request and updates a database based on the incoming request. You can use the data in these process variables to perform the desired processing. The error transition is used to specify the activities to execute in case of an error. Figure 30 illustrates this simple error-handling procedure. The following sections describe the two kinds of error process variables. This allows you to create error-handling procedures for dealing with potential runtime errors in your process definitions. The Error Process Variables When an error transition is taken. The following sections describe error handling in more detail. Activity error variables are named $_error_<activityName>. You then specify activities you wish to execute in the event of an error. and then the process ends. the process ends. Figure 30 A simple error-handling procedure Error handling can also involve significantly more complex processing. the $_error process variable and the activity error variables. the database is down). For example. For example. depending upon what error occurred. an error may occur during a Send Mail activity if the specified mail host does not exist. If an error is encountered (for example. an email is sent to a system administrator. TIBCO BusinessWorks Process Design Guide . error data is available to activities that execute after the error transition. You can specify that one transition out of an activity is to be taken in the case of an error.160 | Chapter 10 Error Handling Overview of Error Handling Errors can occur during activity processing.

TIBCO BusinessWorks Process Design Guide . For example. Typically. $_error_<activityName> Process Variables Each activity has one or more predefined error schemas. The schema of the $_error variable is the following: The contents of each schema item are dependent upon the activity that throws the error.The Error Process Variables 161 | $_error Process Variable The $_error process variable contains general information about the process in which the error occurred. and these are represented as a choice element in the error output schema. When you create an error-handling procedure. You can use a coercion to change the Data element into the specific type for the activity. you may find the data in the $_error process variable useful. The Data schema item contains activity-specific error information. You can map data from this process variable into Input items for activities in your error-handling procedure. Refer to the description of each activity for more information about the Error Output tab. TIBCO BusinessWorks Palette Reference describes the error schemas on the Error Output tab of all activities and lists possible causes for each error type. the following illustrates the error output schema of the Create File activity: This activity can encounter the FileAlreadyExistsException or the FileIOException. there are two or three types of exceptions an activity can encounter. The error schemas are displayed on the activity’s Error Output tab.

162 | Chapter 10 Error Handling When an error is encountered. The following expression can be used to determine if the FileAlreadyExistsException occurred: boolean($_error_MyCreateFile/ActivityErrors/ ns2:FileAlreadyExistsException) You can use the msgCode element to determine the kind of error that occurred. TIBCO BusinessWorks Process Design Guide . You can obtain the error by examining the $_error_<activityName> process variable in subsequent activities after an error transition. Error Propagation Called processes and groups propagate any unhandled errors to the parent process. you can use the Generate Error activity to create an unhandled error. but the text of the message may change. then that node is not empty. so any error created by the Generate Error activity is propagated to the parent process. The Generate Error activity does not permit any transitions to another activity. Unhandled errors occur where there is no error transition that specifies the activities to execute in the case of an error. The following illustrates the Process Data panel that is available after the activity named MyCreateFile encounters an error: You can use XPath expressions to determine which error occurred and handle the error accordingly. The name of the process variable is dependent upon the activity’s specified name. if the FileAlreadyExistsException error occurs. in the above error schema. Also. TIBCO BusinessWorks Error Codes lists all error codes that activities can return. The error code should remain constant from release to release. For example. You should use the error code instead of the error message text to detect and handle errors. the $_error_<activityName> process variable is created and populated with the error data.

then the error transition out of the group is taken to the Send Mail activity. The transition to the Send Mail activity is taken if there is either an error when committing the transaction or if the Generate Error activity is executed (because of an error in the iterate group). The Generate Error activity is used to propagate an error outside of the transaction group to the parent process. an error transition out of the group is taken to the WriteLogEntry activity. See Process Error Schemas on page 164 for more information about process error schemas. TIBCO BusinessWorks Process Design Guide . If the iterate group experiences an error. then inserts the records into a database table. A second group surrounds the iterate group to enclose all updates in a transaction. the error transition is taken out of the transaction group to the SendMail activity. If the transaction succeeds. parses the files into an XML schema.Error Propagation 163 | The following sections describe propagation of errors for groups and called processes. The first group is an iterate group that performs one update for each record. The Generate Error activity can use any error schemas defined on the process to propagate a specific schema to the parent process. Figure 31 Propagating errors from a group The process definition uses two group activities. The error process variables contain the error information for the activity where the error occurred. If any of the updates fail. the process ends. If the transaction fails. Figure 31 illustrates a process definition that waits for new text files. the WriteLogEntry activity is executed. Group Error Propagation Unhandled errors halt the execution of a group and the error transition out of the group is taken.

TIBCO BusinessWorks Process Design Guide . a response is sent back to the customer stating there was an error in the order and the process definition terminates. If the order processing is successful. If the GetCreditLimit or ProcessOrder processes encounter an error. the ProcessOrder process is called. If the credit limit check succeeds. Also.164 | Chapter 10 Error Handling Called Process Error Propagation When a process definition calls another process definition. Figure 32 illustrates a process definition that waits for an incoming HTTP request that contains an order. Each process can define a number of error schemas by creating these schemas on the Error Schema tab of the process definition’s End Activity. Any unhandled errors encountered when executing the called process cause the called process to halt execution and return the error to the parent process. Process Error Schemas The error process variables contain the default data returned in the event of an error. a response is sent back to the customer stating the order is complete and the process definition terminates. a process can define an error schema and use the Generate Error activity to propagate specific data to the parent process. the called process can encounter errors. Figure 32 Propagating errors from a called process The GetCreditLimit process is called to check the credit limit of the customer that places the order. You can define specific error schemas to hold error data when errors are propagated from a group or a called process. See Process Error Schemas on page 164 for more information about process error schemas. The error process variables contain the error information for the activity where the error occurred.

only the $_error process variable contains the propagated error data. Figure 34 illustrates the Configuration tab of the Generate Error activity. the Error Schema tab of the End activity allows you to create more than one error schema. Figure 33 illustrates the Error Schemas tab with two error schemas.Default . The right panel of the tab allows you to modify each schema item. Figure 33 The Error Schemas tab Error schemas are used by the Generate Error activity.is chosen for the error schema. When the Generate Error activity is executed. TIBCO BusinessWorks Process Design Guide . The Select Error Schema field contains a drop-down list of error schemas defined for the process. However. The middle portion allows you to modify the selected schema. the specified error schema is propagated to the parent process. Figure 34 The Generate Error Configuration tab If .Process Error Schemas 165 | Error schemas are created like any other schema (see Editor on page 50). The left panel of the tab allows you to create or delete schemas.

This item will contain either the InvalidCustomer or the NotEnoughCredit error schema. Figure 35 Example of process data for error schemas The available error schemas for the GetCreditLimit process are presented as a schema item of type Choice. the SendErrorInOrder activity has access to the error schema supplied by any GenerateError activity in the GetCreditLimitProcess. the <activity-name> portion is the name of the Generate Error activity in the group. You can use XPath to determine which schema is actually contained in the element. If the Generate Error occurred in a group. the schema appears in the Input tab for the Generate Error activity and you can map data to the specified error schema. At run time. The process variable is derived from the activity where the Generate Error occurred. In the example described in Called Process Error Propagation on page 164. This process specifies two error schemas.166 | Chapter 10 Error Handling If a process error schema is chosen. If the Generate Error occurs in a called process. and then map the data in the schema accordingly. the <activity-name> portion of the process variable is the name of the Call Process activity. the Generate Error propagates the specified error schema to the parent process in the $_error_<activity-name> process variable. TIBCO BusinessWorks Process Design Guide . Figure 35 illustrates the process data available to the SendErrorInOrder activity. See TIBCO BusinessWorks Palette Reference for more information about the Generate Error activity. InvalidCustomer and NotEnoughCredit.

page 172 Summary of Transactions. Transactions ensure that all participants in the transaction either complete or are rolled back together.| 167 Chapter 11 Transactions TIBCO BusinessWorks allows you to group some activities into a transaction group. page 180 TIBCO BusinessWorks Process Design Guide . page 169 Java Transaction API (JTA) UserTransaction. page 170 XATransaction. Topics • • • • • Overview of Transactions. page 168 JDBC. This chapter describes how to incorporate transactions into your process definitions.

All activities that can participate in a transaction must either complete successfully or be undone or rolled back together. The Write File activity. The activities that can participate in the transaction are determined by the transaction type. you must specify the type of transaction. To create a transaction. TIBCO BusinessWorks Process Design Guide . For more information about creating groups. For example. The following sections describe each of these types of transactions and the situations in which they are used in more detail. any activity can be contained in a transaction group.168 | Chapter 11 Transactions Overview of Transactions In TIBCO BusinessWorks a transaction is a logical unit of work. All the JDBC Update activities either complete or roll back at the end of the transaction. Types of Transactions TIBCO BusinessWorks offers a variety of types of transactions that can be used in different situations. For example. you may have three JDBC Update activities and one Write File activity in a transaction group. and the type of the activity. Not all TIBCO BusinessWorks activities can participate in a transaction. When you create a transaction group. does not participate in the transaction and executes whether the transaction commits or fails. only JDBC activities whose JDBC Connection type is "JDBC" can participate in a JDBC transaction. Transactions allow you to group multiple activities into an atomic execution unit. however. see Grouping Activities on page 71. you use a group to surround the activities in the transaction. the configuration of the activity. Only the following types of activities have transactional capabilities: • • • JDBC activities JMS activities EJB activities Although only the activities above can be part of a transaction. You can use the type of transaction that suits the needs of your integration project. TIBCO BusinessWorks supports the following types of transactions: • • • JDBC Java Transaction API (JTA) UserTransaction XA Transaction A transaction group can have only one transaction type.

It is possible to use more than one JDBC Connection in the same transaction group. all JDBC activities using the same JDBC connection in the transaction group commit. and C. If any errors occur while processing the activities in the group. the updates for activities A and B are part of one transaction and the update for activity C is part of a different transaction. Multiple JDBC Connections In Transaction Groups All activities that use the same JDBC Connection shared configuration resource are part of the same transaction. Also. but other activities can be part of the transaction group. in the JDBC Connection resource(s) used by JDBC and Checkpoint activities in the group. B. If you have more than one JDBC Connection in the transaction group. the transaction is rolled back and an error is returned (you should have an error transition out of the group to handle this situation). Individual JDBC activities can override the default transaction behavior and commit separately. but C uses JDBC Connection Y. However.JDBC 169 | JDBC The JDBC transaction allows multiple JDBC activities that access the same database connection to participate in a transaction. TIBCO BusinessWorks Process Design Guide . For example. The transaction group commits automatically if all activities in the group complete and a non-error transition is taken out of the transaction group. Configuring JDBC Transactions To configure a JDBC transaction. select JDBC Transaction as the transaction type of the group. If the transaction rolls back. all JDBC activities using the same JDBC connection in the transaction group roll back. only activities that use the same JDBC Connection are guaranteed to commit or rollback together when the transaction completes. you have three JDBC Updates in a transaction group. A. To create a distributed transaction across multiple databases. select JDBC in the Connection Type field. use the XA transaction type. each set of activities that uses a JDBC Connection is considered a separate transaction. See the description of the JDBC palette in TIBCO BusinessWorks Palette Reference for more information about using JDBC activities. Only JDBC activities that use the same JDBC Connection participate in this transaction type. even errors in non-JDBC activities. A and B use JDBC Connection X. If the transaction commits. In this case.

TIBCO BusinessWorks Process Design Guide . Refer to your application server documentation for more information about supported operations. the following transaction servers implement the JTA transaction interface: • • • BEA WebLogic Application Server IBM Websphere Application Server JBoss Application Server Not all application servers permit JMS and JDBC operations to participate in the JTA transaction. JMS.transaction. If the transaction commits. and EJB activities to participate in transactions. the application server. even errors in activities that do not participate in the transaction.170 | Chapter 11 Transactions Java Transaction API (JTA) UserTransaction The Java Transaction API (JTA) UserTransaction type allows JDBC. The transaction group commits automatically if all activities in the group complete and a non-error transition is taken out of the transaction group. See http://java. the transaction is rolled back and an error is returned. If any errors occur while processing the activities in the group. all eligible activities in the transaction group commit. Using this type of transaction requires an installed and configured application server that implements the JTA interface javax. and the application. However. select JTA UserTransaction as the transaction type of the group. Sun Microsystems developed and maintains the API. no exception is raised and the operations that are not supported by the application server are performed independent of the transaction.sun. JTA specifies standard Java interfaces between a transaction manager and the parties involved in a distributed transaction system: the resource manager. request/reply operations cannot participate in a JTA transaction. You should create an error transition out of the group to handle this situation. TIBCO BusinessWorks still allows you to configure the operations in the transaction.UserTransaction. If the transaction rolls back. If the application server does not permit an operation. For example. all eligible activities in the transaction group roll back. For activities that use the JMS transport. Configuring JTA UserTransaction Transactions To configure a JTA UserTransaction.com/products/jta/ for more information about the API.

Activities that use the JMS transport must be configured to use the XA connection factory in the application server. you can specify a duplicate key in this field to perform duplicate checking.Java Transaction API (JTA) UserTransaction 171 | JDBC Connections used by JDBC activities in the transaction group must be configured to use JNDI as the connection type and specify the data source in the application server. When the Include Checkpoints field is checked. restarted process instances can use the duplicate key to determine if the transaction has already committed. This is useful if the checkpoint included in the transaction is the first checkpoint in the process definition. If the process engine crashes after the checkpoint. an implicit checkpoint is performed after the last activity in the group completes successfully and before the transaction is committed. See TIBCO BusinessWorks Palette Reference for more information about this resource. The JNDI configuration for JMS. See Detecting Duplicate Process Instances on page 184 for more information about specifying duplicate keys. or JDBC activities must specify the appropriate connection and JNDI Context information for the application server. Include Checkpoint Checkpoint Duplicate Key TIBCO BusinessWorks Process Design Guide . The deployment configuration must specify a database for storing process engine information and the JDBC Connection used must specify JNDI as the connection type for this checkpoint to participate in the transaction. EJB. When this field is checked. The JTA UserTransaction transaction group has the following fields on the transaction group’s Configuration tab: Field Transaction Manager Description A JTA UserTransaction shared configuration resource.

the transaction is rolled back and an error is returned. TIBCO BusinessWorks Process Design Guide .3 Java Open Transaction Manager (JOTM) 1. If the transaction rolls back.Transaction. EJB activities cannot participate in an XA Transaction group. even errors in activities that do not participate in the transaction. and JMS activities to participate in transactions. For JMS activities. all eligible activities in the transaction group roll back. checkpoints can participate in an XA Transaction.3 (this transaction manager does not support transaction recovery) The XA Transaction type allows JDBC activities.tra and designer. The transaction group commits automatically if all activities in the group complete and a non-error transition is taken out of the transaction group. all eligible activities in the transaction group commit.5.tra files. if your process engine is configured to use a database for storage of process engine data. The following XA-compliant transaction managers have been tested with TIBCO BusinessWorks: • • Arjuna Transaction Service 3. You should have an error transition out of the group to handle this situation. Also. If any errors occur while processing the activities in the group. select XA Transaction as the transaction type of the group.transaction.transaction. If the transaction commits.172 | Chapter 11 Transactions XATransaction The XA Transaction type allows you to specify an XA-compliant transaction manager provided by a third party that supports the interfaces javax.TransactionManager and javax. the path to the files needed to run the transaction manager must be placed in the TIBCO BusinessWorks classpath in the bwengine. The third-party transaction manager is executed in the same Java VM as TIBCO BusinessWorks. request/reply operations cannot participate in an XA transaction. JDBC Connections used by JDBC activities in the transaction group must be configured to use XA as the connection type. Transactions across multiple databases are also supported. Because of this. Also. JMS activities must be configured to use the XA connection factory. Configuring XA Transactions To configure an XA Transaction.

Include In Transaction TIBCO BusinessWorks Process Design Guide . such as JMS Queue Receiver. Note: Transactional acknowledge mode is not supported for Wait for JMS Topic Message activities. There is no need for a Confirm activity for the resources specified in this field. Wait for JMS Queue Message. this is done by using a Confirm activity. Certain resources. See TIBCO BusinessWorks Palette Reference for more information about this resource.XATransaction 173 | The XA Transaction group has the following fields on the transaction group’s Configuration tab: Field Transaction Manager Description An XA Transaction shared configuration resource. These resources can also specify an acknowledge mode of "Transactional" that specifies their acknowledgement should be part of a transaction. Include Checkpoint When this field is checked. an implicit checkpoint is performed after the last activity in the group completes successfully and before the transaction is committed. if the transaction completes successfully. Normally. This message is part of the transaction. This field allows you to specify the resource for which you would like to send an acknowledgement message. or JMS Topic Subscriber expect acknowledge messages to be sent to the server. The deployment configuration must specify a database for storing process engine information and the JDBC Connection used must specify XA as the connection type for this checkpoint to participate in the transaction.

logger. If the process engine crashes after the checkpoint.properties). 1. the following JOTM directory must be included in classpath properties in the designer. TIBCO BusinessWorks must be configured as follows to interact with JOTM.5. you can specify a duplicate key in this field to perform duplicate checking. There are several JOTM logger properties with the prefix. To each of these properties. This is useful if the checkpoint included in the transaction is the first checkpoint in the process definition. TIBCO BusinessWorks Process Design Guide .174 | Chapter 11 Transactions Field Checkpoint Duplicate Key Description When the Include Checkpoints field is checked. restarted process instances can use the duplicate key to determine if the transaction has already occurred. See Detecting Duplicate Process Instances on page 184 for more information about specifying duplicate keys.objectweb.jotm.5. no changes are required to the JOTM environment to interact with TIBCO BusinessWorks. However. you must modify the TIBCO BusinessWorks log4j property file. you must configure the transaction manager and TIBCO BusinessWorks to work together properly.2\lib\log4j. By default. Configuring Third-Party Transaction Managers When using a third-party transaction manager with TIBCO BusinessWorks. The classpath for TIBCO Designer and TIBCO BusinessWorks must be modified to include the JOTM jar files.3\config <JOTM_HOME>\jotm-1. add jotm_log_file.3\lib 2. The logging details for JOTM is specified in the TIBCO BusinessWorks log4j property file (<BW_HOME>\5. Java Open Transaction Manager (JOTM) For Java Open Transaction Manager (JOTM). log4j.tra files: <JOTM_HOME>\jotm-1. To send JOTM log messages to a separate file.org. the log4j property file is configured to send JOTM log messages to the TIBCO BusinessWorks log file (BWLogFileAppender). See Logging for Third-Party Components on page 190 for more information about the TIBCO BusinessWorks log4j file. This section details the requirements for configuring the supported transaction managers.tra and bwengine. To accomplish this.

arjuna.UserTran sactionImple"/> 2. ATS provides two transaction manager implementations. To change the object store's location. 3. ATS must be configured to use the local implementations.arjunacore.ats. therefore the distributed transaction recovery property must be commented out or removed from the ATS properties file. For TIBCO BusinessWorks to work correctly.arjuna. TIBCO BusinessWorks uses the local transaction recovery.arjuna.2\etc\arjunajts-properties. It is recommended that you change the location where the ATS ObjectStore is created.ats.arjuna.jta.arjuna. Open the ATS properties file (<ATS_HOME>\ats-3.jta.internal.jts.recoveryExtension5" value="com.ats.arjuna.jta. The following configuration changes must be performed in the ATS properties file: 1.ats.arjunacore.ats. one for local transaction recovery and one for distributed transaction recovery.XARecoveryModul e"/>).TransactionManager Imple).XARecove ryModule"/>) and distributed transaction recovery (<property name="com.recovery. set the value for the following property in the ATS properties file to your directory’s location: TIBCO BusinessWorks Process Design Guide .Transact ionManagerImple"/> <property name="com. When using TIBCO BusinessWorks. this will be the working directory or the directory where the TIBCO BusinessWorks process engine is started. local transaction recovery is used.XATransaction 175 | Arjuna Transaction Service For the Arjuna Transaction Service (ATS).ats.internal.internal.recovery.ats.ats.ats.jta.transaction.arjunacore. TIBCO BusinessWorks only supports the local implementations.jta.jtaUTImplementation" value="com.jta.jtaTMImplementation" value="com.recovery.arjuna.transaction.transaction. one that is local (com.arjuna.xml) and make sure that the properties com.ats.arjuna.internal.jta. both the ATS environment and the TIBCO BusinessWorks environment must be modified.jta.jtaUTImplementation are set to the following values: <property name="com.recovery.arjuna.ats.recoveryExtension6" value="com.internal. ATS provides two recovery modules for XA resources.arjuna.jta.arjuna. the ATS ObjectStore is created in the current working directory of the application.arjuna.transaction. By default the ATS properties file may be configured to enable both the local transaction recovery (<property name="com.arjuna.arjunacore.jta. By default.jts. In TIBCO BusinessWorks.ats.Transaction ManagerImple) and one that is based on the distributed JTA implementation (com.jtaTMImplementation and com.internal.

ats_log_file.tra and bwengine.objectStoreDir" value="your directory location" /> The following configuration changes must be made to TIBCO BusinessWorks to interact with ATS: 1. Java Open Transaction Manager (JOTM) Transaction recovery is not supported by Java Open Transaction Manager (JOTM).176 | Chapter 11 Transactions <property name="com.com.3\etc <ATS_HOME>\ats-3.2\lib\log4j. Comment out the line containing: log4j. To send ATS log messages to a separate file. This section details transaction recovery in the supported transaction managers. tibco_bw_log. By default.ats.arjuna. See Logging for Third-Party Components on page 190 for more information about the TIBCO BusinessWorks log4j file. Refer to the JOTM documentation for more information.properties). To accomplish this.3\lib\ext 2. Transaction Recovery XA Transactions can be recovered in the event of a failure. The classpath for TIBCO Designer and TIBCO BusinessWorks must be modified to include the ATS property file and jar files. tibco_bw_log. the log4j property file is configured to send ATS log messages to the TIBCO BusinessWorks log file (BWLogFileAppender). TIBCO BusinessWorks Process Design Guide . Remove the comment from the line containing #log4j. The logging details for ATS is specified in the TIBCO BusinessWorks log4j property file (<BW_HOME>\5.arjuna=WARN.arjuna.logger. the following directories must be included in classpath properties in the designer.tra files: <ATS_HOME>\ats-3.logger. you must modify the TIBCO BusinessWorks log4j property file.3\lib <ATS_HOME>\ats-3.com.arjuna=WARN.objectstore.

and transaction recovery only occurs when TIBCO BusinessWorks is restarted. See the ATS documentation for more information about starting the Arjuna Transaction Recovery Manager in a separate Java VM. Therefore. the recovery manager requires references to the TIBCO BusinessWorks . and then start another recovery • TIBCO BusinessWorks Process Design Guide . Therefore. In this configuration however.jar <TPCL_HOME>jdbc\TIutil.jar files. When running the recovery manager in a separate Java VM.jar <TPCL_HOME>jdbc\TIbase. verify the following: • The classpath for the Arjuna Transaction Recovery Manager must contain the location of the TIBCO BusinessWorks . the transaction recovery manager is started when TIBCO BusinessWorks is started. do not start one recovery manager in the same Java VM as TIBCO BusinessWorks.bat: <BW_HOME>lib\palettes\plugins.jar (when using an Oracle database) • The ATS property file for the recovery manager must refer to the same ATS ObjectStore that is configured for TIBCO BusinessWorks (see Configuring Third-Party Transaction Managers on page 174 for a description of configuring the ATS object store).jar <TPCL_HOME>jdbc\TIsqlserver. The following libraries must be included in <ARJUNATS_HOME>\bin\setup-env.jar <J2EE_LIB>\jms. Running the Arjuna Transaction Recovery Manager in a separate Java VM allows transaction recovery to occur independently.jar <TRA_HOME>lib\TIBCOxml.jar <TPCL_HOME>jdbc\TIoracle. and no additional configuration is necessary. regardless of the status of TIBCO BusinessWorks. the ATS ObjectStore may contain the serialized TIBCO BusinessWorks Java classes.jar files to de-serialize the classes.jar <BW_HOME>lib\engine. when starting the recovery manager in a separate Java VM. Do not allow more than one Arjuna Transaction Recovery Manager to refer to the same ATS ObjectStore. After a failure. both the Arjuna Transaction Manager and the Arjuna Transaction Recovery Manager are started in the same Java VM as TIBCO BusinessWorks.XATransaction 177 | Arjuna Transaction Service By default. the transaction recovery manager is disabled if TIBCO BusinessWorks is stopped or if the Java VM crashes.jar <TPCL_HOME>jdbc\TIdb2.jar <ORACLE_LIB>\ojdbc14.jar <TRA_HOME>lib\TIBCOrt.jar <TRA_HOME>lib\TIBCrypt.jar <TRA_HOME>lib\TIBCOjms. That is.jar <TPCL_HOME>jdbc\TIsybase.

ats.xa. • Recovery may not be possible if the ATS ObjectStore is modified or destroyed.ats.recovery. Check that the database user which the recovery manager's connection is using is the same as the one the business logic is using. Refer to the Arjuna Transaction Service documentation for more information about transaction recovery. Also.logging. When using the Oracle database. TIBCO BusinessWorks Process Design Guide .jta.XAException: [tibcosoftwareinc][Oracle JDBC Driver][Oracle]ORA-00942: table or view does not exist.jta.internal. XAException.transaction.arjuna.xarecovery1] XARecoveryModule.arjuna. See the ATS documentation for more information.929 [Thread-5] WARN com. check that this user has the correct permissions on relevant data dictionary tables and views for the XA system.178 | Chapter 11 Transactions manager in a different Java VM when both recovery managers are pointing to the same ATS ObjectStore.XAER_RMERR" This may be caused either by a missing table or by a lack of permissions.[com. the following exception is logged by the ATS recovery manager after invoking the method "getConnection" of the XAConnectionRecovery object: "2004-08-24 17:20:56.loggerI18N .xaRecovery got XA exception javax.

Nesting XA transactions in JTA transactions is allowed. JTA TIBCO BusinessWorks Process Design Guide . JTA Nesting JDBC transactions in a JTA transaction is allowed. XA Nesting XA transactions in XA transactions is allowed. Table 17 describes the effect of creating a transaction group in another transaction group. Nesting XA transactions in JDBC transactions is allowed. Nesting JTA transactions in JDBC transactions is allowed. That is. but each transaction is independent. Nesting JTA transactions in JTA transactions is not allowed. but each transaction commits or rolls back separately. Nesting JTA transactions in XA transactions is allowed.Nested Transactions 179 | Nested Transactions It is possible to place a transaction group in another transaction group. XA Nesting JDBC transactions in an XA transaction is allowed. but each transaction is independent. thus "nesting" transactions. but each transaction is independent. but each transaction is independent. Table 17 Effects of nesting transaction groups Transaction type JDBC JDBC Nesting JDBC transactions in other JDBC transactions is allowed. but each transaction is independent. but each transaction commits or rolls back separately. but each transaction commits or rolls back separately. An exception is thrown at the start of the nested transaction. The outcome of the parent transaction does not affect the nested transaction. each transaction commits or rolls back separately.

activities cannot be part of an XA Transaction group. Process starters and Wait For. if the resource is configured to use the Transactional acknowledge mode and the resource is listed in the Include in Transaction field of the transaction group. when the JDBC Connection is configured to use the XA connection type. the acknowledge message for Wait for JMS Topic Message activities cannot be part of the transaction..180 | Chapter 11 Transactions Summary of Transactions The following tables summarize the support of each type of activity in each type of transaction. Table 18 summarizes the JDBC transaction type. Table 18 JDBC transaction type Activity Type JDBC activities JMS activities EJB activities Participate in JDBC Transaction Type? Yes No No Table 19 summarizes the XA transaction type. but their acknowledge message can participate in the transaction. and the JDBC Connection is configured to use the XA connection type. Request/Reply operations (such as JMS Topic Requestor and JMS Queue Requestor) are not permitted in transactions. when a database is used to store checkpoint data. However. when JMS is configured to use an XA connection No a. Yes.. TIBCO BusinessWorks Process Design Guide . Table 19 XA transaction type Activity Type Checkpoint (specified by the Include Checkpoint field of the transaction group) JDBC activities JMS activitiesa EJB activities Participate in XA Transaction Type? Yes. Yes.

Process starters and Wait For. Yes. Request/Reply operations (such as JMS Topic Requestor and JMS Queue Requestor) are not permitted in transactions). when using TIBCO Enterprise Messaging Service. Yes. when database used to store checkpoint data. activities cannot be part of a JTA UserTransaction group. EJB activities Yes Yes Yes IBM Not supported JBoss Not supported JDBC activities Not supported Not supported JMS activitiesa Not supported Not supported a. TIBCO BusinessWorks Process Design Guide . when using BEA JMS server... and the JDBC Connection is configured to use the JNDI connection type. No. Table 20 JTA UserTransaction type Activity Type Checkpoint (specified by the Include Checkpoint field of the transaction group) Participate in JTA Transaction Type With the Following Application Server? BEA Yes. when the JDBC Connection is configured to use the JNDI connection type.Summary of Transactions 181 | Table 20 summarizes the JTA UserTransaction type.

182 | Chapter 11 Transactions TIBCO BusinessWorks Process Design Guide .

Topics • • Detecting Duplicate Process Instances.| 183 Chapter 12 Process Instance Execution This chapter details aspects of process execution that you can control with configuration fields in the process definition. page 184 Sequencing Process Instances. page 187 TIBCO BusinessWorks Process Design Guide .

b. For example. If no process instance has stored the given duplicateKey value. 4. or if all process engines run on the same machine.184 | Chapter 12 Process Instance Execution Detecting Duplicate Process Instances Duplicate messages should be detected and discarded to avoid processing the same event more than once. This value should be some unique key contained in the event data that starts the process. Activities in the process instance are executed until the first Checkpoint activity is reached. TIBCO BusinessWorks Process Design Guide . you can use a file system for process engine storage. If another process instance has already stored the given duplicateKey value. the process engine terminates the process and throws a DuplicateException. only one process engine is running at a particular time). You must specify a value for the duplicateKey element in the Checkpoint activity input schema. Therefore. no other Checkpoint activities in the process instance can be used to store a different duplicateKey value. The Checkpoint activity has a value specified for the duplicateKey input element. Duplicate detection can only be done across multiple engines on different machines if a database is used to store process engine data. If you are running fault tolerant process engines (that is. Using the algorithm described above. the process engine stores the value and completes the Checkpoint activity. the orderID value is unique for all new orders. 2. The following describes the procedure for duplicate detection by the process engine: 1. 3. An incoming message is received and a process instance is created. See TIBCO Administrator User’s Guide for more information on specifying process engine storage. process engines can guarantee that no newly created or recovered process instances will execute if they have the same duplicateKey value. The process engine checks the current list of duplicateKey values for a matching value. Once a process engine stores a duplicateKey value and performs the Checkpoint for a process instance. a. you should take care in choosing the value of duplicateKey and ensure that it will be unique across all process instances. Duplicate detection is performed when a process instance executes its first Checkpoint activity.

an order is received. and then either an email is sent to the inventory manager if the inventory is not sufficient. or the order is processed. It is a better choice to put the Checkpoint activity between the process starter and the QueryInventory activities. consider the following process definition. you can either place the Checkpoint before the QueryInventory activity (because it is a database query and no actual change occurs) or after the activity but before either the Send Mail or ProcessOrder activities. You should try to pick a value that is unique for every message. inventory is checked. In the example in the previous section.Detecting Duplicate Process Instances 185 | When to Perform Checkpoints When detecting duplicate messages. In this process definition. In this example. orderID is unique for each incoming order. For example. so that would be a good choice for the value of the duplicateKey. you may select the JMSMessageID header property for JMS messages. it is important to place the Checkpoint activity before any activities that you do not want to execute more than once. Specifying the Duplicate Key Duplicate detection is only as efficient as the duplicateKey that is specified. For example. TIBCO BusinessWorks Process Design Guide . The following illustrates the example process definition with the Checkpoint activity properly placed.

In this example. The following illustrates an error transition added to the example process. TIBCO BusinessWorks Process Design Guide . If this is the case. You can place an error transition from the Checkpoint activity to a series of activities to handle the duplicate message. the checkpoint performed for the transaction may be the first checkpoint in the process definition. Transactions and Duplicate Detection Transaction groups using certain transaction types can allow Checkpoint activities to be performed as part of the transaction. you can specify the duplicateKey as part of the transaction group configuration. If no error transition is specified. The duplicateKey is specified in the Checkpoint Duplicate Detection Key field of the transaction group. then the transition is taken to the end of the process definition. the Checkpoint activity fails with the DuplicateException.186 | Chapter 12 Process Instance Execution The following illustrates specifying orderID from the example above as the duplicateKey value in the Checkpoint activity. when a duplicate message is detected. the duplicate message is confirmed so that it is no longer redelivered. the process instance terminates and duplicate messages are effectively ignored. Handling Duplicate Messages When a duplicate is detected. In this case.

See Appendix B. Process instances with sequencing keys that evaluate to the same value are executed in the order they were started.enabled — specifies whether duplicate detection is performed. Using these settings.pollPeriod.Sequencing Process Instances 187 | Process Engine Properties for Duplicate Detection The following process engine properties control duplicate key detection. 0 indicates to store duplicateKey values indefinitely.engine.timeout. TIBCO BusinessWorks allows you to specify a sequencing key on process starters that determines which process instances to execute sequentially. Process instances with different sequencing key values can be executed concurrently.minutes • • — specifies the number of minutes to wait before polling for expired duplicateKey values.dupKey. if you purchase a pre-built project from a third party). bw. false indicates duplicateKeys when specified are ignored. bw. Process instances can have sequencing keys that evaluate to different values. on page 237 for more information about setting process engine properties. true (the default) indicates the process engine will check for identical duplicateKey values.minutes — specifies how long (in minutes) to keep stored duplicateKey values. TIBCO BusinessWorks Process Design Guide . TIBCO BusinessWorks also allows you to control process execution administratively by setting properties in the deployment configuration of the project. you can specify that all process instances should be executed sequentially in the order they were created. Custom Engine Properties. TIBCO Administrator allows you to control the maximum number of process instances in memory as well as the maximum number of concurrently executing process instances.dupKey.dupKey.engine. The default is 30 minutes. but only process instances with the same value for the sequencing key are executed sequentially.engine. Sequencing Process Instances Process instances can be executed in the order they were created. Any positive integer greater than 0 indicates the number of minutes to keep stored duplicateKeys. This method is not as flexible as using the Sequencing Key field on a process starter. Using the administrator settings is only recommended when you cannot change the process definitions in the project before deployment (for example. -1 indicates the duplicateKey values are deleted when the job completes. • bw.

188 | Chapter 12 Process Instance Execution This chapter details examples of using the Sequencing Key field on the Misc tab of process starters to control the order of process execution. see TIBCO Administrator User’s Guide. Figure 37 illustrates the example process definition. The process is a monitoring application that examines data in a database and performs the appropriate action. specify a constant in the Sequencing Key field of the Misc tab of the AcceptOrder HTTP Receiver process starter. To accomplish this. if the number of rows returned by a query is greater than 5000. The orders are placed using a web client and the TIBCO BusinessWorks process definition uses an HTTP Receiver process starter to accept the incoming orders. the process archives the data to another database and removes all rows from the table. you wish to sequentially execute all orders that are accepted by this process definition . For example. For example. the results of the query are processed and stored in a separate table. place "OrderEntry" in the Sequencing Key field. Example 1: Processing Orders As They Are Received In this example. all new orders are executed in the order they are received. Figure 36 Example order-entry system In this example. an order-entry system must process incoming orders in the order in which they are received. Figure 36 illustrates the example process definition. Because you placed a constant in the field. Example 2: Periodic Processing In this example. Therefore. For more information on using TIBCO Administrator to set deployment configuration parameters. If the number of rows is less than 5000. the value of the XPath expression is identical for each incoming order. TIBCO BusinessWorks Process Design Guide . the Timer process starter is used to start a process every five minutes.

Example 3: Handling Client Messages In this example. To configure sequential processing in this scenario. This ensures that all messages from a specific client are processed in the order they are received. Therefore. no updates are occurring to the table. Messages from different clients are permitted to be processed concurrently. so process instances created at the end of each day can execute concurrently with the first process instance created the next day. but the data in the table changes much more frequently. you can use the expression pfx:ActivityOutput/JMSProperties/pfx:JMSXUserID in the Sequencing Key field of the Misc tab of the JMS Topic Subscriber process starter. a JMS application sends messages to TIBCO BusinessWorks for processing. but all messages received from the same client must be processed in the order they are received. you must execute each process instance sequentially before executing the next process instance. Figure 38 Example of handling incoming messages In this example. System backups occur at midnight each night. process instances are created every five minutes. you can use the XPath expression pfx:TimerOutputSchema/Day_Of_Month in the Sequencing Key field of the Misc tab of the Timer process starter. You must ensure that the data returned by the query is processed before the next query executes. Each JMS client authenticates to the JMS server with a different user ID. TIBCO BusinessWorks Process Design Guide . At the end of the day. and there are no changes to the table during this time.Sequencing Process Instances 189 | Figure 37 Example of periodic processing In this example. This ensures that process instances created each day are completed sequentially in the order they are created.

apache. The properties defined in bw/<relNum>/lib/log4j. For example. There can be only one log4j. For more information about log4j.properties file per Java VM.190 | Chapter 12 Process Instance Execution Logging for Third-Party Components TIBCO BusinessWorks can use a variety of third-party components.tra file to point to the location of your own log4j. TIBCO BusinessWorks Process Design Guide .properties file to allow you to configure logging services for third-party components.properties file. if you wish to configure logging for your environment. You can alter the properties in this file. you must include all of the required properties from the file supplied with TIBCO BusinessWorks in your file. If you wish to use properties from a different log4j. TIBCO BusinessWorks provides the bw/<relNum>/lib/log4j. Many third-party components can use the standard log4j logging services.properties file. The supplied log4j. This allows you to return to the original configuration if your changes result in errors. you can either add the properties to bw/<relNum>/lib/log4j. see http://logging.org/log4j/docs/.properties or you can alter the bwengine.properties file has comments describing property usage.properties are required by the components used by TIBCO BusinessWorks. It is a good idea to create a backup copy of the log4j. Do not remove any required properties from this file.properties file. If you use your own log4j.properties file before altering it. the Apache Tomcat server is used to accept incoming HTTP or SOAP requests or the Arjuna Transaction Service can be used as a transaction manager.

| 191 Chapter 13 Inter-Process Communication Executing process instances can communicate and can pass data between each other. page 195 TIBCO BusinessWorks Process Design Guide . The General Activities palette contains the Wait and Notify activities and the Receive Notification process starter for implementing inter-process communication. Topics • • • • • Overview of Inter-Process Communication. page 194 Database Storage for Wait/Notify/Receive Notification Information. page 195 Examples of Inter-Process Communication. page 192 Data for Inter-Process Communication. This chapter describes inter-process communication and provides examples of its use. page 193 Coordinating Inter-Process Communication.

The Notify activity executes immediately and transitions to the next activity. if you do not wish data to be sent between processes. the Receive Notification process starter creates a new process instance when another process executes the corresponding Notify activity. When a Notify activity executes its information is stored until a matching Receive Notification or Wait activity accepts the information. Define the data that must be passed between the processes by creating a Notify Configuration shared configuration resource. TIBCO BusinessWorks provides the Wait and Notify activities and the Receive Notification process starter to handle inter-process communication. Create process definitions that use the Receive Notification. 3. TIBCO BusinessWorks Process Design Guide . These activities are located in the General Activities palette. The key is supplied to the Notify activity. The Notify activity cannot be used to determine when a corresponding Receive Notification or Wait has received the information. The data sent between the activities is defined by a Notify Configuration shared configuration resource. However.192 | Chapter 13 Inter-Process Communication Overview of Inter-Process Communication TIBCO BusinessWorks allows two executing process instances to communicate. See TIBCO BusinessWorks Palette Reference for more information about the configuration requirements for each of these activities. Wait. The schema supplied to the Notify Configuration resource can be empty. Receive Notification. Determine the key that correlates processes with Notify activities with the corresponding processes with Receive Notification process starters or Wait activities. 2. These activities are similar to semaphores in programming. A string-based key is used to coordinate between Wait/Notify/Receive Notification activities to determine when a Notify activity corresponds to a Wait or Receive Notification. In general. You may need process instances to communicate if you wish to synchronize process execution or if your processes must execute in a specific order. and Notify activities. A process containing a Wait activity waits for another process to execute a corresponding Notify activity. or Wait activities if they are to be used to communicate with each other. The Notify activity only sends information to the Receive Notification process starter or Wait activity that specifies the same Notify Configuration resource. using inter-process communication consists of these steps: 1. and any Wait activity that matches that key is executed when the Notify occurs. the Notify Configuration resources must be the same for the Notify. Alternatively.

the same Notify Configuration resource must be specified by corresponding Notify and Receive Notification or Wait activities. The Wait activity and Receive Notification process starter have output that matches the Notify Configuration specified on their Configuration tab. TIBCO BusinessWorks Process Design Guide . If your process engines are on different machines. See Examples of Inter-Process Communication on page 195 for more specific examples of when inter-process communication is useful. However. Wait/Notify information is stored in a database so that process engines on different machines can share information. Data for Inter-Process Communication The Notify Configuration shared configuration resource defines the data that the Notify activity passes to the corresponding Wait activity or Receive Notification process starter. the Notify Configuration schema used by the Notify/Receive Notification/Wait activities can be empty. This allows you to use the data passed by the process with the Notify activity in subsequent activities after the Receive Notification or Wait activities. The Notify activity then passes its data to its corresponding Wait or Receive Notification. The following sections describe these steps in more details.Data for Inter-Process Communication 193 | 4. This allows you to map process variables to the Notify activity’s input. The same Notify Configuration resource is used to configure the Notify activity as well as the Wait activity and the Receive Notification process starter. See Editor on page 50 for more information on specifying schemas. The schema in the Notify activity’s configuration appears in the Notify activity’s input schema. The schema for the data is defined in the same way as any other schema is defined. If you wish only to signal the waiting process to continue but not exchange data. a database must be used to store process instance information. Only activities with the same Notify Configuration resource can communicate with each other.

194

| Chapter 13

Inter-Process Communication

Coordinating Inter-Process Communication
When configuring Receive Notification, Wait, and Notify activities, you must specify a key to coordinate which activities correspond to each other. You can also specify a timeout for how long to keep the information about Wait and Notify activities before it is removed from storage. The following sections describe configuring the key and timeouts for inter-process communication.

Specifying the Key
To configure Receive Notification, Wait, and Notify activities, you must specify a key that correlates Notify activities with Receive Notification or Wait activities. The key is a string that corresponding activities specify to determine when a Receive Notification or Wait activity should accept data from a Notify activity. The key is similar to event keys used in activities that wait for incoming events (described in Event on page 49). The key is a string, but you can use any XPath expression that evaluates to a string when the process instance executes. XPath expressions can be used to specify the key for Wait and Notify activities. The Receive Notification process starter can specify a global variable or a fixed string for its key. Each Notify activity corresponds to exactly one Receive Notification or Wait activity. That is, as a Notify activity executes, the first Receive Notification or Wait activity that matches the Notify’s key can then execute. You can execute many Notify activities with the same key. You can create one-to-one correspondence between Wait and Notify activities so that exactly one process’ Notify activity corresponds to one other process’ Receive Notification or Wait activity. Or, you can create many-to-one relationships so that many Notify activities’ keys can correspond to the Receive Notification or Wait in one process. A Notify, however, always only corresponds to only one Receive Notification or Wait activity. Therefore, once a Notify executes, the corresponding Receive Notification or Wait activity continues processing. See Examples of Inter-Process Communication on page 195 for examples of specifying keys for Wait/Receive Notification/Notify activities.

Timeouts for Notify and Wait
Notify and Wait activities have associated timeouts. Timeouts specify how long information for the Notify and Wait is kept before it is removed from storage.

TIBCO BusinessWorks Process Design Guide

Database Storage for Wait/Notify/Receive Notification Information 195

|

The Notify activity executes immediately and transitions to the next activity in the process definition. However, the timeout value for the Notify activity specifies how long the notification information should be kept. If no corresponding Wait activity executes before the specified timeout, the information is removed. Once notification information is removed from storage, it cannot be accepted by the corresponding Wait activity. The Wait activity causes process execution to pause until a corresponding Notify activity with a matching key executes. The Notify activity can execute before the corresponding Wait activity and its information is then waiting in storage. If the Notify has not executed, the process instance containing the Wait suspends until the Notify occurs or the Wait activity’s specified timeout is reached. The Receive Notification process starter does not have a timeout because it creates a process instance only when a corresponding Notify activity executes.

Database Storage for Wait/Notify/Receive Notification Information
If your process engines are located on different machines, a database is required to store process instance state for inter-process communication. When process engines reside on different machines, they must share information about pending Wait/Receive Notification/Notify activities. A database allows process engines to share process instance state information across machines in a domain. Your deployment configuration must specify a database for process engine storage if you expect process instances on different machines to have corresponding Wait/Receive Notification/Notify activities. See TIBCO Administrator User’s Guide for more information on specifying a database for process engine storage when configuring your deployment.

Examples of Inter-Process Communication
The following sections describe situations where inter-process communication may be necessary.

TIBCO BusinessWorks Process Design Guide

196

| Chapter 13

Inter-Process Communication

Enforcing Order for Process Execution
If you wish process instances to execute in a certain order, you can use Wait and Notify activities to accomplish this. This requires using some portion of the incoming event to determine the order. For example, an application may assign a priority number to incoming orders. This may be important when accepting requests for a limited resource, for example, airplane seats or available space in a university class. The orders must be processed in order of priority to ensure that orders with the highest priority number have access to the resource first. Figure 39 illustrates an example process definition that orders incoming events. Figure 39 Ordering incoming events

In this process definition, new requests are submitted through a web interface. A new process is started for each request, and a priority number (an ordered sequence) is given with each request. The order with priority number 1 is submitted, and processed immediately. When the first order is completed, a Notify is sent with its key set to 1. All other orders transition to the Wait activity. These orders are suspended until a Notify activity is executed whose key is equal to their priority number minus one (that is, the order with the next highest priority number). Using this technique, orders are processed in the order of their priority, regardless of when the order is submitted. All orders create a process instance and then immediately suspend until the notification is sent from the order with the next highest priority.

Multiple Types of Incoming Events Resume a Running Process
Some processes require a "Wait for ..." event (for example, Wait for Adapter Message) to continue processing. This occurs when the process requires an external application to send an additional request. For example, a new order arrives, and because the total is over $100,000, it requires approval before processing. You may notify a group of approval managers by email, then any of the approval managers can respond by email or through a web interface for approval. Figure 40 illustrates this set of process definitions.

TIBCO BusinessWorks Process Design Guide

Examples of Inter-Process Communication 197

|

Figure 40 Multiple event sources to continue a process
Orders can be approved by mail or by web. Whichever Notify occurs first is accepted by the Wait

Incoming Order process handles orders less than $100,000 immediately. Orders greater than $100,000 require approval by a person.

The Wait/Notify activities use the OrderID as the key to determine the order that corresponds to the notification. In this case, it is possible for more Notify activities to execute than Wait activities. You must configure the Notify activities to have an appropriate timeout so that the notify information is removed if it is not used by the associated Wait activity.

Scalability With Incoming Events
You may distribute incoming events across multiple process engines. This allows for greater scalability because the load of incoming events is distributed. However, if you have a "Wait for ..." activity, such as Wait for Rendezvous Message that uses reliable delivery, in your process definition, the incoming event is received by all process instances across the multiple process engines. This can potentially affect the performance because of greater network traffic, depending upon how many process instances are running.

TIBCO BusinessWorks Process Design Guide

198

| Chapter 13

Inter-Process Communication

Ideally, you should create some mechanism so that incoming events are handled outside of the process definition and then routed to only the correct process definition. The Wait and Notify activities can accomplish this. You would replace your "Wait for ..." activity with a Wait activity. Then, create a new process definition that contains a process starter to handle the incoming event. Use the Notify activity to send the data from the incoming event to the correct process instance with the corresponding Wait activity.

Specific Protocol Requirements
Some business processes use protocols with specific requirements that make inter-process communication necessary. For example, you may have a process that starts when a TIBCO Rendezvous Certified Message (RVCM) arrives. Your process may also require a Wait for Rendezvous Message listening on the same subject as the process starter. This specific configuration is difficult to implement because incoming messages create new processes and also are sent to the waiting activities in the process. In the example above, the business requirements necessitate working around the requirements of the RVCM protocol. To accomplish this, you may be able to change your business requirements, or you can use the Wait and Notify activities to create two process definitions. The first process definition accepts all new messages and determines, based on message content, whether the message should start a new process or be passed to an activity in the process waiting for the message. The process executes a Notify activity for the new message, but the key of the Notify is different depending upon whether a new process must start or if the message is to be sent to an executing process. The second process definition starts with a Receive Notification process starter and has a Wait activity in place of the Wait for Rendezvous Message activity. This configuration allows the first process to receive all incoming messages, parse them to determine the appropriate action, and then pass each message to the appropriate process.

TIBCO BusinessWorks Process Design Guide

| 199
Chapter 14

Testing Process Definitions

This chapter describes the testing mode available for stepping through your process definitions and examining process data.

Topics
• • • • • • • Overview of Testing, page 200 Breakpoints, page 201 The Test Panel, page 202 Process Instances During Testing, page 203 Stepping Through a Process, page 205 Colors in Test Mode, page 206 Test Mode Buttons and Menus, page 207

TIBCO BusinessWorks Process Design Guide

testing usually involves setting breakpoints in the process model to stop the running process instances at desired points. but might be difficult depending upon the volume of the workload of the system. Testing a deployed project is possible. The engine starts process instances based on the process definitions stored in your project. This is not possible in a production environment. 4. You can select one of the running process instances to display in the design panel. changes to your process definitions are not reflected in the running process instances. The current state of the process data is displayed on the Process Data tab of each activity. and the currently executing activity is highlighted as the process instance runs. See Breakpoints on page 201 for more information. Select the process definition you wish to test in the project panel. In general. 2. See Process Instances During Testing on page 203 for more information about process instances in the test panel. Entering the testing environment starts a TIBCO BusinessWorks engine. Examine the data of the process by selecting any of the activities in the process. 3. TIBCO BusinessWorks Process Design Guide . you can supply input data to the process before executing it. Set breakpoints in the process definition at points where you wish to stop a running process and examine its state. testing should be done during the design and development phase of a project. Also. Return to design mode before changing process definitions. See Stepping Through a Process on page 205 for more information. 5. If the process begins with a Start activity and the Start activity has a schema defined. so you may want to use a development system for testing purposes. Testing a process definition typically involves these steps: 1. The project panel becomes the test panel. and so on) in the test panel to either continue through the process instance or to stop the current process instance. Click the Tester tab on the left of the project panel. Once in testing mode. 6.200 | Chapter 14 Testing Process Definitions Overview of Testing TIBCO BusinessWorks provides a testing environment for stepping through your process models and determining the sources of errors. Step to Next Activity. Use the toolbar buttons (Pause Testing. From the test panel you can start process instances or load more process definitions.

A breakpoint before the activity appears to the top left of the activity. Figure 42 illustrates a process diagram that has breakpoints set before and after two activities. You can set breakpoints before or after an activity executes. a red hexagon (a stop sign) appears next to the task’s icon to indicate the task has a breakpoint. A breakpoint after the activity appears to the top right of the activity. just like conditions for items in an activity’s input. You can also set or clear breakpoints on individual activities by right-clicking on the activity and choosing Set/Clear BreakPoint Before/After from the popup menu. Figure 41 illustrates an example of the Set Breakpoint dialog. To set a breakpoint. Using the popup menu on the activity only sets the specified breakpoint. You can clear all set breakpoints by clicking the Clear All button. Breakpoints persist after you close your project — the breakpoints you set should appear in the process definition once the project is reopened. You must use the Set Breakpoint dialog if you wish to specify a condition for the breakpoint. When a breakpoint is set on an activity. Figure 41 Set BreakPoints dialog You can choose to select all of the activities by clicking the Select All button. The only exceptions to this are that you cannot set a breakpoint before the starting activity or after the End activity. Conditions are specified in XPath. The dialog allows you to select where to place a breakpoint relative to any of the activities in the current process definition. click the Set Breakpoint button and the Set Breakpoint dialog appears.Breakpoints 201 | Breakpoints Breakpoints allow you to suspend a running process instance at a specified point so that you can examine the process data. You can also specify that each breakpoint should only occur based on a given condition. TIBCO BusinessWorks Process Design Guide .

Figure 43 Process instance stopped at a breakpoint The Test Panel You can begin testing a process definition by selecting it in the project panel. The test panel displays process instances created during testing. then clicking the Tester tab to the left of the project panel. Figure 43 illustrates the example process definition when the process instance is stopped at the breakpoint before the ReadFile activity. The project panel then becomes the test panel. the breakpoint icon becomes a stop sign inside a yellow triangle to indicate where the process instance has stopped.202 | Chapter 14 Testing Process Definitions Figure 42 Setting a breakpoint When a process instance is stopped at a breakpoint. Figure 44 illustrates the test panel. Figure 44 The test panel TIBCO BusinessWorks Process Design Guide .

See Process Instances During Testing on page 203 for more information about process instances in the test panel. This button is not available for processes that do not require input data on the Start activity.Process Instances During Testing 203 | The Start Testing Viewed Process button allows you to start process instances for one or more process defintions. You can also select other process definitions to load as well. See Test Mode Buttons and Menus on page 207 for a complete description of the buttons in the test panel. You can select the process definitions you wish to load into the test engine in this dialog. TIBCO BusinessWorks Process Design Guide . See Setting Custom Engine Properties for the Testing Environment on page 238 for more information about specifying custom properties in a test engine. Loading Processes to Test Once the Start Testing Viewed Process button is clicked. If the loaded process begins with a Start activity that requires input. Processing continues until the End activity is reached. The test panel has several toolbar buttons for manipulating process instances. The Test Engine Database field specifies the JDBC Connection resource to the database you wish to use. Process Instances During Testing The Start Testing Viewed Process button allows you to create a process instance for the currently viewed process definition and all of its dependent subprocesses. You can also specify a database to use for storage of process engine information. the Select Processes to Load dialog appears. you can supply input to the process starter by clicking on the Supply Input Data to Starter button on the TIBCO Designer toolbar. This is useful if you wish to specify a property file containing custom engine properties. You can select process instances in the test panel and display the process definition. one process instance is created to execute the process definition. The Advanced button on this dialog allows you to specify any arguments to use when starting the test engine. Creating Process Instances If the loaded process begins with a Start activity.

A new process instance for that process definition is created. You can view any running. its description is (running) in the test panel. (completed job). You can select any process instance in the test panel and view it in the design panel. its process definition is displayed in the design panel and its description changes from (running). Figure 45 Multiple process instances in the test panel TIBCO BusinessWorks Process Design Guide . Adapter Subscriber). or (failed) to (viewed job). This menu contains the item Create a Job that performs the same function as the button on the test panel toolbar. its description is changed to (completed job) in the test panel.204 | Chapter 14 Testing Process Definitions If the loaded process begins with a process starter (for example. Each incoming event causes a process instance to be created. Working With Process Instances Each process instance is independent in the test panel. its description is changed to (failed). Figure 45 illustrates process instances and their labels in the test panel. You can start/stop/step through each process instance individually. or failed job. When a process instance is running. If a process instance fails to complete. and each process instance is listed in the test panel. completed. then click the Create a Job button. Select a process definition in the test panel. You can also select and right-click on a process definition name in the test panel to bring up a popup menu. Once a process instance completes its processing (that is. When a job is selected in the test panel. You can create new process instances of any loaded process using the Create a Job button in the test panel. the process engine waits for an incoming event before creating a process instance. its End activity is reached).

Stepping through the process allows you to examine the executing process instance at your own pace. if you are currently in a subprocess and you choose the Step Out of a Subprocess menu item or toolbar icon. Once the breakpoint halts processing.Stepping Through a Process 205 | You can stop the execution of a process instance by selecting it and clicking the Stop the Current Job button in the test panel. Stepping Through a Process When you set a breakpoint in a process definition. For example. You must exit test mode and re-enter test mode for changes to take effect. TIBCO BusinessWorks Process Design Guide . or you can choose another activity later in the process definition and execute from the current point to that later activity. all transitions that evaluate to true are taken. step into or out of a subprocess. execution continues until the next breakpoint occurs or processing of the subprocess completes. no matter which menu item or toolbar icon you choose. breakpoints are still honored. When you choose to step through a process. you can step through the process using the toolbar icons or menu items. processing halts at that breakpoint. and you must choose Step Out of Subprocess again to continue processing. You can step to the next activity. activities are executed as you pass them. See Test Mode Buttons and Menus on page 207 for more information about the toolbar icons and menu items that allow you to step through a process. You can delete any completed or failed process instances from the test panel by selecting the process instances and clicking the Delete a Completed Job button . but changes will not take effect during the current testing session. If there are multiple paths in a process definition. If there is a breakpoint before the subprocess completes. The currently highlighted activity is executed after you choose your next step. but only one path is chosen to be highlighted as the next activity when you choose Step to Next Activity. the process executes all activities up to the activity with the breakpoint. When stepping through a process definition. You can browse or change any process definition or any activity’s configuration while testing.

Therefore the transition is not taken. This could be either because the activity has a breakpoint set or because the Step to Next Activity or Run To This Resource menu item was used. The transition has been evaluated. and its condition evaluates to false. Therefor the transition has been taken to the next activity. The process definition is paused at this activity. Red transition arrow Red activity Bright yellow activity TIBCO BusinessWorks Process Design Guide . The activity encountered an error while processing. This can occur if you have multiple paths in your process definition and the focus is not on the current path. Table 21 Colors in test mode Color/Element Black transition arrow Green transition arrow Description The transition has not yet been evaluated. The transition has been evaluated. but it is the next activity to execute when the process instance continues.206 | Chapter 14 Testing Process Definitions Colors in Test Mode When you test a process definition. and its condition evaluates to true. Table 21 describes the colors of each element in a process definition and their significance. the elements of the process change colors depending upon what is occurring in the executing process instance. Any Call Process activity that calls a process in which an error occurs is also red. The activity has not yet executed. but the focus is not on the activity. Yellow activity The activity is currently executing.

Allows you to specify data for the process starter’s input schema. This brings up a dialog for creating an input schema. Table 22 describes these buttons and menu items. Breakpoints stop the process instance and allow you to examine process data before the process continues. Information icon displayed when a process engine has been started for testing process definitions. You can use this dialog to save the input data you supply to disk. This icon is enabled only for process definitions that begin with a Start activity that requires an input schema. Go To Started Process This item is available only on the View>Test menu. Add Input Data TIBCO BusinessWorks Process Design Guide . Table 22 Toolbar icons for testing Button/ Icon View > Test Options Menu Item Set Breakpoints Description Brings up the Set Breakpoint dialog that allows you to specify which activities should have breakpoints. There is also a View > Test Options menu that performs the same actions as the toolbar buttons. there is no toolbar icon.Test Mode Buttons and Menus 207 | Test Mode Buttons and Menus There are buttons and icons on the TIBCO Designer toolbar used when testing process definitions. Displays the process definition with which you began this testing session.

Table 23 describes these buttons and menu items. The moving ball shows the current execution path. The Tools > Tester menu has menu items that perform the equivalent actions as these buttons. Resume Resumes any process instances that are paused or stopped at a breakpoint. You can also set the speed of the moving ball. There is no toolbar icon. The process definitions are loaded into a process engine. Table 23 Test panel icons Button/ Icon Tools > Tester Menu Item Start Description Allows you to load the viewed process and select any other proceses you wish to to load. Once in testing mode.208 | Chapter 14 Testing Process Definitions Table 22 Toolbar icons for testing Button/ Icon View > Test Options Menu Item Moving Ball Options Description This item is available only on the View>Test menu. Brings up a dialog that allows you to set whether the moving ball is displayed. Return to design mode by using the Stop Testing icon if you want to add/remove/change process definitions. your process definition cannot be changed. The test panel also has several buttons for manipulating the process instances during testing. TIBCO BusinessWorks Process Design Guide . All dependend subprocesses for any loaded processes are also loaded.

this icon allows you to display the process definition of the called process and step through it. When a process instance is paused on an activity. This icon is only available when you are in a subprocess. This icon is only available when Call Process is the next activity to be processed. You must click the Start icon to start another engine if you wish to resume testing. click this icon to step ahead in the process definition and execute the next activity. this button may not stop the process immediately because TIBCO BusinessWorks might be waiting for the current operation to be completed. or a timeout has been reached. Once a Call Process activity is reached. Step Out After stepping into a subprocess. Note: In some situations. Step Over Step Into TIBCO BusinessWorks Process Design Guide . For example. Resume the process instance with the Resume icon. failed. the process engine stops only after the FTP command has completed. this toolbar icon can be used to return to the process that called the subprocess. All process instances are removed from the test panel. Pause Temporarily suspends the process instance. if the current activity is FTP Put and you are attempting to place a very large file on the remote server.Test Mode Buttons and Menus 209 | Table 23 Test panel icons Button/ Icon Tools > Tester Menu Item Stop Description Kills the current engine and exits testing mode.

Stop Current Job Stops the currently executing process instance. These are the popup menu items for activities that are used in testing: Set Breakpoint Before. The Set/Clear Breakpoint Before/After menu items sets or clears the specified breakpoint on the selected activity. You can only delete completed jobs. There are also menu items on the popup menus for each activity in a process definition. Clear Breakpoint After. This icon and menu item allow you to return focus to the process definition for the currently running process instance. Clear Breakpoint Before. Creates a new process instance for the selected process definition. TIBCO BusinessWorks Process Design Guide . Set Breakpoint After. but you do not want to continue running the process. You can access these menu items by right clicking on the activity. but does not exit test mode. you can change focus to display or edit other resources in your project. Deletes the selected jobs marked as (completed job) from the test panel. This is useful if you wish to examine the data of the process instance. This menu has the item Create a Job that performs the same function as the button in the test panel. You can also select and right click a process definition name in the test panel to bring up a popup menu.210 | Chapter 14 Testing Process Definitions Table 23 Test panel icons Button/ Icon Tools > Tester Menu Item Show Current Job Location Description When a process instance is paused at a breakpoint or any other point. Focus returns to the highlighted activity in a process where the process instance is paused. and Run To This Resource.

Test Mode Buttons and Menus 211

|

The Run To This Resource menu item executes the running process instance up to the selected activity. For example, if a process instance is halted on a breakpoint, selecting an activity later in the process definition and choosing the Run To This Resource menu item resumes processing of the process instance and executes all activities between the breakpoint and the selected activity. The process instance pauses when it reaches the activity where you selected the Run To This Resource menu item.

TIBCO BusinessWorks Process Design Guide

212

| Chapter 14

Testing Process Definitions

TIBCO BusinessWorks Process Design Guide

| 213
Appendix A

Working with a Revision Control System

This appendix gives detailed instructions for working with each supported revision control system (RCS). For background information, see the documentation for the revision control system.

Topics
• • • • • • Overview, page 214 File Sharing, page 216 Microsoft Visual SourceSafe, page 218 Perforce Fast Software Configuration Management System, page 221 XML Canon, page 224 Tips and Tricks for Using Version Control Systems, page 234

TIBCO BusinessWorks Process Design Guide

214

| Appendix A

Working with a Revision Control System

Overview
TIBCO Designer allows multiple developers to work on the same project. Developers can use file sharing/locking or a revision control system to ensure that the same resource is not changed by two developers at the same time. If you wish to use file sharing/locking or a revision control system, you must use a multi-file project. Different users can then add resources to the project and lock the parts of the project they are working on. TIBCO Designer creates a file that can be shared and locked for each top-level resource, such as an adapter configuration or a process definition. It does not create a file for each resource. As a result, for example, you can lock an adapter configuration but cannot lock individual adapter services. TIBCO Designer also creates folders for folders you create in your project. You can lock each folder as needed. The following revision control options are available: • • • File Sharing — Allows you to place the project in a central location, then lock and unlock resources as needed. See File Sharing on page 216. Microsoft Visual SourceSafe — Allows multiple users to take advantage of the Visual SourceSafe features. See Microsoft Visual SourceSafe on page 218. Perforce — Allows multiple users to take advantage of the Perforce software revision control system. See Perforce Fast Software Configuration Management System on page 221. XML Canon — Allows multiple users to take advantage TIBCO XML Canon. See XML Canon on page 224.

You interact with the revision control system directly from TIBCO Designer. TIBCO Designer also allows you to check who owns the lock for each locked resource. Designer may not always have all of the information necessary to distinguish some situations correctly. For example, TIBCO Designer sometimes is unable to distinguish a deleted file from the RCS that should be deleted in your personal copy of the project from a file you added to your copy of the project and want to add to the RCS. In such cases, use the RCS client directly to fix these situations.

TIBCO BusinessWorks Process Design Guide

Overview 215

|

Icons Used by RCS Projects
To illustrate the state of the resource in a project under revision control, TIBCO Designer uses icons on top of each resource in the project panel. A lock icon indicates that the resource was checked into the revision control system. Other users may be making changes. You need to check out the resource to safely make changes. A yellow square icon indicates that the RCS does not know about this resource or its state. If the resource is new, you have to add it to the RCS. If it has been checked in before, it has to be checked in again. A red square indicates, on systems that support that functionality, that another user has locked the resource. Note that is functionality is not supported for all RC systems. If no special icon is displayed, the resource has been checked out and is in the same state as the corresponding RCS resource.

Deleting RCS Projects
You delete a project that uses a revision control system as follows: 1. In the Startup panel, click the Delete project button (just as for other projects). 2. In the Delete project.
Project

dialog that appears, supply the information about the

— For projects that use File Sharing, use either the None or File Sharing Revision Control System and any user name, supply the project location. — For Visual SourceSafe and Perforce you must make sure that the project listed in the Project Directory field corresponds to the project checked into RCS. 3. Click OK. The project is deleted. For Visual SourceSafe and Perforce, it is deleted in both the local and the check-in location.

TIBCO BusinessWorks Process Design Guide

216

| Appendix A

Working with a Revision Control System

File Sharing
This section discusses using File Sharing as a Revision Control System in the following sections: • • • • Preparing for File Sharing on Microsoft Windows on page 216 Preparing for File Sharing on UNIX on page 216 Using File Sharing on page 216 Deleting RCS Projects on page 215

Preparing for File Sharing on Microsoft Windows
The project is located on a shared drive accessible by all TIBCO developers. Make sure all TIBCO developers have read and write access to that drive.

Preparing for File Sharing on UNIX
The project must be located on a mounted drive accessible by all TIBCO developers. You then go through these steps: 1. Create a Unix group for the TIBCO developers (for instance "tibdev"). 2. Create a Unix account for each developer. Each account must have its Primary Group ID set to the group "tibdev". 3. For each account, the umask must be set to 002 to ensure the entire group has write permission on resources (folder and file) in Designer projects. Set the umask in the .login or .profile file, as follows:
$ umask 002

Using File Sharing
Allowing multiple users to use file sharing for a project involves these tasks: Task A Create the Project 1. Open TIBCO Designer and open the project (which could be a new empty project). 2. Choose Project > Save > Multi-File Project.

TIBCO BusinessWorks Process Design Guide

File Sharing 217

|

3. In the dialog that appears: d. Supply the root directory for the project (which will become the project name). This directory should be on a drive that can be accessed by all developers that work on the project. e. Choose File Sharing from the pop-up. f. Supply your username. This username will be seen by other users as the owner if you lock files in the project.

Task B User A Acquires Resource and Makes Changes The creator of the project or another user can now acquire the lock for the project and, for example, add two folders. Here are the steps: 1. User A selects the project root folder. 2. User A chooses Multi-User > Acquire Resource. That command is also available from the resource’s right-button menu or from the Project menu. 3. User A drags two Folder resources into the design panel and names each for the user who will work with it. 4. User A selects the folder for the second user (User B) and chooses Release Resource from the right-button menu. The folder now appears locked in the TIBCO Designer project panel.
Lock Acquired by User A Lock Released by User A

5. User A opens the UserA folder and adds two resources to it, then selects each resource and chooses Add Resource to RCS from the right-button menu. User A can make changes to the UserA folder (but not to the UserB folder). 6. User A saves the project. Task C User B Opens Project, Acquires Resource, and Makes Changes A second user can open the same project and make changes to all folders not currently locked by another user. For this example: 1. User B opens the project (all project elements are locked). 2. User B selects the User B folder and chooses Acquire Resource from the right-button menu. The lock for this folder was released by User A.
TIBCO BusinessWorks Process Design Guide

User B cannot acquire the lock for the project root folder or for User A Folder because both are locked by User A. Visual SourceSafe Setup To set up your system to work in conjunction with the TIBCO Designer Visual SourceSafe component. follow these steps: 1. 2. TIBCO BusinessWorks Process Design Guide .ini file in the VSS database is located.htm file included with your client explains how to do this on the command line: set ssdir=\\server\share\vss Where \\server\share\vss is the folder where the Srcsafe.218 | Appendix A Working with a Revision Control System 3. The ReadMess. set the ssdir environment variable to the location of the Visual SourceSafe database. To make the Visual SourceSafe database available. and save the project when she is done. Microsoft Visual SourceSafe This section first discusses prerequisites and looks at a usage scenario. Only the Client Programs component is necessary on the machine where TIBCO Designer runs. User B can now make changes to User B folder as desired. Install a Microsoft Visual SourceSafe 6.0 Client on each machine from which you wish to use TIBCO Designer in conjunction with a Visual SourceSafe database. then includes reference documentation to the Version Control dialog in the following sections: • • Visual SourceSafe Setup on page 218 Using Microsoft Visual SourceSafe on page 219 Microsoft Visual SourceSafe is not supported under UNIX.

Include the root directory and other directories. User A opens TIBCO Designer and chooses New Empty Project. In the dialog that appears. which is the command-line executable for VSS that is used by TIBCO Designer. specify the following information: — — — Project Directory—Location Multi-User System—Visual of the project on the local drive.EXE. VSS Project Name—Name of the project in the VSS database. Ask your VSS administrator. User A follows these steps: 1.Microsoft Visual SourceSafe 219 | You can also set this variable permanently using the control panel. VSS Command—Click Browse to point to the SS. your SourceSafe client cannot find the database where the shared project is located. Note that you must use SS. Password—Password for the current user.EXE executable on your machine. If you do not set this variable. Using Microsoft Visual SourceSafe Step 1: User A Starts TIBCO Designer and Creates a VSS Project To create a VSS project. The user must have been granted access to VSS during the VSS client installation. SourceSafe User Name—Name of the current user. 2. as in the example below. as specified during the VSS client installation. Ask your VSS administrator. — — — Figure 46 Save Project Options for Microsoft VSS TIBCO BusinessWorks Process Design Guide .

After User A has supplied a label for this version. 1. 4. 2. Using the TIBCO Designer GUI. User A adds resources to the project and configures them. they may be checked out when you check out the top-level resource. After all changes have been made. User B selects a resource to be checked out in the project tree. each resource must first be added to the RCS using the Add Resource to RCS menu. User B opens the project from TIBCO Designer. While you can add and checkout recursively. you must add. check-in and synchronization is always all or nothing TIBCO BusinessWorks Process Design Guide . If you make additional changes. User B can now make changes to the checked-out resource. User B can choose Multi-User > Check In Changes. using the Visual SouceSafe as the Revision Control system and providing a username and password. the check-in console. Whether this happens depends on the directory structure TIBCO Designer creates. User A saves the project. 2. is displayed. you check in the resource. which shows the check-in information. then chooses Acquire-Check Out Resource from the right-button menu of the resource. User B chooses Multi-User > Project > Synchronize Project to make sure all resources are loaded. 3.220 | Appendix A Working with a Revision Control System Step 2: User A Makes Changes to Project and Checks In the Project User A can now make changes to the project and check them in as follows: 1. each resource can be checked out by each user that has access to VSS. If a resource has never been added to RCS. then chooses Multi-User > Add Resource to RCS. Step 3: User B Checks Out Resources and Makes Changes After User A has checked the whole project into VSS for the first time. If User B adds new resource. All resources are now locked and can be checked out by other users as needed. If you check out a resource that contains other resources.

Setup a password for your Perforce account. — The Perforce server must be installed and running.Perforce Fast Software Configuration Management System 221 | Perforce Fast Software Configuration Management System Perforce has comprehensive software configuration management capabilities built around a scalable client/server architecture. TIBCO Designer does not include or install this software. Assigning user name and passwords may be done by the Perforce administrator at your site. • • The Perforce server port must be defined. To do this in Microsoft Windows. and modify the files you wish to work with under Perforce. and requires minimal administration. Every Perforce port has a unique password. delete. You can define a new client in the Perforce clientSpecs >New menu. • Install the Perforce software. create. You may need to define a password for all the Perforce ports you access normally. TIBCO BusinessWorks Process Design Guide . Be sure that you have the appropriate permissions to access. Perforce is supported on a large number of operating systems. Requiring only TCP/IP. Prerequisites Before attempting to use Perforce you must ensure the following procedures have been taken. developers can access the Perforce Server through a variety of Perforce clients (Windows GUI. store. Web. — The Perforce client must be installed on your machine. Only the client is necessary on the machine where TIBCO Designer runs. Perforce can be deployed quickly and easily. even for large or distributed sites. or Command-Line). select User > Set Password for UserName. • • Select the client you use to use or define a new client with any name.

Use this option if you ONLY intend to use TIBCO Rendezvous for English and Western European data. If you set your default client in the Perforce native UI you don't need to fill in the user/server type fields when you access Perforce from Designer TIBCO BusinessWorks Process Design Guide . as specified during the Perforce client installation. This is the same as Owner entered in Perforce Client Specification. Encoding—This field is used to determine the wire encoding that TIBCO Rendezvous should use for sending and receiving data in this project. Use this option to test the validity of the information you are using to access Perforce. Browse to point to the P4. ISO8859-1—Default value. UTF-8— Select this option if you want to use TIBCO Rendezvous activities for processing non-Western European data. — — — — — — User Name—Name Password—Password for the current user. location where the project is placed by Perforce when you synchronize. of the current user. Perforce Client—This is the same as Client entered in Perforce Client Specification. This is a project-wide preference. — Multi-User System—Perforce— This selection also enables the Test Configuration option.222 | Appendix A Working with a Revision Control System Using Perforce Step 1: User A Starts TIBCO Designer to Create a Perforce Project To create a Perforce project. User A opens TIBCO Designer and chooses New Empty Project. User A specifies the following information: — — Project Directory—Location of the project on the local drive. 2. In the dialog that appears. Timeout (seconds)—Amount of time available to connect with the Perforce server before a timeout occurs. See TIBCO Adapter Concepts for a discussion of how TIBCO adapters support Unicode.EXE executable on Perforce Command—Click your machine. User A follows these steps: 1. such as Japanese. Server—The port on which you access the Perforce server. that is.

the check-in console. After User A has supplied a label for this version. 2. Step 3: User B Checks Out Resources and Makes Changes After User A has checked the whole project into Perforce for the first time. you check in the resource. which shows the check-in information. you must add.Perforce Fast Software Configuration Management System 223 | Figure 47 Save Project Options for Perforce Version Control System Step 2: User A Makes Changes to Project and Checks In the Project User A can now make changes to the project and check them in as follows: 1. is displayed. User A saves the project. If a resource has never been added to RCS. then chooses Multi-User > Add Resource to RCS. each resource can be checked out by each user that has access to Perforce. Using the TIBCO Designer GUI. All resources are now locked and can be checked out by other users as needed. If you make additional changes. TIBCO BusinessWorks Process Design Guide . User A adds resources to the project and configures them.

each resource must first be added to the RCS using the Add Resource to RCS menu. XML Canon XML Canon/Developer (XCD) is a comprehensive development platform that allows organizations to store their XML assets (e. User B selects a resource to be checked out in the project tree. and stylesheets) in a central repository that facilitates adaptability.g. instance documents. XML Canon also provides version control. using the Perforce as the Revision Control system and providing a username and password. User B chooses Multi-User > Project > Synchronize Project to make sure all resources are loaded. User B opens the project from TIBCO Designer. collaboration. they may be checked out when you check out the top-level resource. User B can choose Multi-User > Check In Changes. protecting the development process from duplicate or conflicting efforts. then chooses Acquire-Check Out Resource from the right-button menu of the resource. and management. 3. XML Canon is an entire persistence system that has some RCS capability but not a multi-file project per se. After all changes have been made. If you check out a resource that contains other resources.224 | Appendix A Working with a Revision Control System 1. repurposement. Whether this happens depends on the directory structure TIBCO Designer creates. You can add or check in resources recursively. DTDs. adjuncts. XML schemas. and other required information. TIBCO BusinessWorks Process Design Guide . 4. XML Canon uses permissons to control access to the stored files. 2. If User B adds new resource. User B can now make changes to the checked-out resource.

SchemaDOC™—generate a graphical inventory and detailed description of an XML Schema’s or DTD’s components in a user-friendly HTML format. beginning with the initial association of the TIBCO Designer project with an XML Canon category. • • • • • • Custom Property Association—apply custom metadata to documents or individual components. The remainder of this section describes the process for specifying XML Canon as the repository for a project. see the XML Canon Developer documentation available as online help with the product and also via the TIBCO documentation library. For more information on XML Canon. such as your XML Schemas. the typical steps for interacting with XML Canon. an XML Canon user name and password with the permissions required to work in the XML Canon category in which the shared project is stored. XML Document Differencing—track changes between revisions. you must have: • • the address of the XML Canon server and the port number on which it is running. Document/Component Relationship Tracking—track the relationship between documents and their components and determine where schemas or individual components (XML Schema elements or types or WSDL message components. TIBCO BusinessWorks Process Design Guide . are provided for the XML-based files in your project. Prerequisites To use XML Canon as the version control system for TIBCO Designer. Document and Component-Level Searching—query for document and components through a wide array of filters. Namespace Management—browse through a listing of target namespaces and see how a given namespace is used in schema and instance documents. Checking In and Acquiring Resources This section provides the typical steps involved in interacting with the XML Canon repository. WSDL files and process definitions. and some tips and tricks that will facilitate the effective use of XML Canon. for example) are used in the project.XML Canon 225 | Features The following features. accessible via XML Canon's web interface.

as depicted in Figure 49. TIBCO BusinessWorks Process Design Guide . Password—password associated with the user name. As a result. it is essential that you specify the proxy server before you click Browse. Upon successful authentication. Figure 48 XML Canon tab If you do not know the location of an empty category. To specify XML Canon as the version control system for a given project. • XML Canon category—the URL (http://hostName:portNumber/categoryName) of an empty XML Canon category. Make sure the proxy server supports required additional functionality.When you open a new empty project. which will serve as your top-level project folder. Not all proxy servers support the WebDAV extensions to HTTP that XML Canon uses. Enter the URL for the XML Canon server and click Connect. Figure 48 depicts the XML Canon tab filled in with the required information. click Browse. the Save Project dialog appears automatically by default. If you click the Browse button for the XML Canon category field. you will be presented with all of the top-level categories. • • User name—an XML Canon user name. Select the XML Canon tab. select Project > Save As to display the Save Project window. You will be prompted to enter your XML Canon user name and password. the proxy server you specified is taken into account. Each project should be associated with a unique XML Canon category. The Browse for Project Folder will appear. which requires you to specify these fields: • Proxy server—You may access XML Canon via a proxy server that does not require authentication.226 | Appendix A Working with a Revision Control System Step 1: Specifying XML Canon as the version control system for a given project This step is performed once for a given project.

The specified XML Canon category will now be used to store the project. New categories can be created using the new folder icon.XML Canon 227 | Figure 49 Browse for an XML Canon category Double-click a category (or use the Open button) to view its child categories. See Step 2: Check in the project to learn how to make the existing resources in the project accessible to all XML Canon users with the permissions to work in the category. listing the folders and files that have been added. The XML Canon Check In dialog is shown in TIBCO BusinessWorks Process Design Guide . click OK. Some XML Canon users may not have the ability to create a new category. modified. If you are unable to create a new category. Step 2: Check in the project The folders and resources existing in the project prior to Step 1 can be checked into XML Canon by way of the Check In Changes option of the Multi-User menu. and password have been specified on the XML Canon tab. see your XML Canon administrator. user name. When a URL. When you have selected the category in which to store the project. The XML Canon Check In dialog appears. or deleted since the project was last checked-in. click Select Folder. moved.

Checks in all of the changes. Checks in the changes associated with the selected files or folders. Reverts the selected folders or resources to their status prior to the last acquire-check out. TIBCO BusinessWorks Process Design Guide . Check-in options are controlled with the following buttons: Button Close Undo Check in selected Check in all Description Closes the window without checking in any files.228 | Appendix A Working with a Revision Control System Figure 50 XML Canon Check In Dialog Global variable settings will appear in the dialog as "defaultVars".

• The "stage" that the document is currently in does not allow a transition to itself (for example.. This can happen for two reasons. a revision label. and a stage.. To set all properties. and the document may not be saved unless those properties are specified. If the XML Canon Administrator has configured your server to use custom properties. then click "Properties. Items for which the user has already specified custom properties are shown in bold in the dialog. or Double-click an item. you may also specify those custom properties. TIBCO BusinessWorks Process Design Guide . See your XML Canon administrator. • Checked-in items become marked by a lock icon in the project panel. By default you may specify a comment. or The administrator has specified "custom properties" that are required.". Figure 51 depicts a project checked into XML Canon. your XML Canon user profile may not have the appropriate permission settings. indicating that the files are not acquired and cannot be edited.XML Canon 229 | Button Properties Description XML Canon augments standard WebDAV functionality by allowing you to specify additional properties when a document is saved. a "production" document cannot be modified without taking it out of "production"). it may not be possible to save changes to XML Canon unless you have specified extended properties. Depending on how the server is configured. If you are unable to check in changes. you: • • Select a file in the "Check In" dialog. Figure 51 A project checked into XML Canon.

2. Supply a user name and password. the message shown in Figure 52 will appear. Upon opening a project shared through XML Canon.230 | Appendix A Working with a Revision Control System Step 3: Acquiring folders or resources and making changes Once a project has been associated with XML Canon (see Step 1) and checked-in for the first time (see Step 2).) If you attempt to acquire a resource that is under the control of another user. Synchronize often to ensure that your project tree reflects any resources you have added outside of TIBCO Designer (through a WebDAV folder or the XML Canon interface. it cannot be modified by other users. TIBCO BusinessWorks Process Design Guide . but cannot make changes to it. Use the global variables display to acquire global variables. Select the XML Canon tab from the Open Project dialog. you should synchronize the project (Multi-User>Synchronize Project). When a resource is acquired. To open a project stored on XML Canon 1. indicating that you may edit the file. Select Acquire-Check out Resource from the right button menu or the Multi-User menu. Global variables are acquired through the Acquire-Check out Global Variable Group option of the right-button menu or the Acquire-Check out Global Variable Group icon appearing at the bottom of the global variable display. its resources can be acquired (checked out) by other users with access to the XML Canon server and with permission to work in the category associated with the project. Specify (or browse for) the XML Canon category in which the project is stored 3. the project will be opened. To acquire a resource 1. for example) as well as any changes made by other users. Select the resource in the project tree 2. Folders and resources marked by a lock icon are read-only until acquired. its lock icon will disappear. Once a resource is acquired by a user. (Other users can view the resource. Upon successful authentication.

Table 24 Revision control system information Field Analyzed state Description This indicates if the resource was analyzed for document and component level relationships. DTD. Select the modified folder or resource in the project panel and select the Release-Revert Resource option. The information available is described in Table 24. TIBCO BusinessWorks Process Design Guide . Viewing Revision Control Information The revision control system (RCS) information for a particular resource can be viewed by selecting the View RCS Info for Resource option from the right-button menu or the Multi-User menu. available via the right-button menu and the Multi-User menu. following the same procedure outlined in Step 2. Reverting Changes There are two options for returning a folder or resource to its status prior to your acquisition: • • Select the change(s) in the Check In Changes Dialog and click Undo Changes. This applies to XML Schema.XML Canon 231 | Figure 52 Acquire failed Step 4: Checking in (or reverting) the changes made to an acquired resource Changes made to acquired resources can be checked into XML Canon. and WSDL resources only.

for example. A revision label added when checking the resource into XML Canon. Last modified Last modified by Last modified by id Lock token Locked by Mime type Resource type Revision name Revision number Root namespace Stage id Stage name TIBCO BusinessWorks Process Design Guide . in XML Schema. The date the resource was created. The time and date of the last modification. Globally unique identifier for the resource being acquired (locked on the server). The XML Canon stage of the resource. The default namespace of the resource. The number of times the resource has been checked into XML Canon. Namespace that the document governs. The XML Canon internal id for the resource. The name of the user making the last modification. The size of the resource in bytes. The XML Canon internal stage id for the resource. The WebDAV resource type. The Multipurpose Internet Mail Extension. the value of the 'targetNamespace' attribute. The name of the resource. The resource type.232 | Appendix A Working with a Revision Control System Table 24 Revision control system information Field Comment Creation date Display name Document flavor Document id Document size Governing namespace Description Displays any comments added when checking the resource into XML Canon. The user who has acquired the resource. The XML Canon internal id of the user making the last modification.

When checking in changes. Any conflicts discovered during the synchronization process will be listed along with instructions for resolving the conflict. DTDs and WSDL files. Deleting XML Canon Projects XML Canon-based projects cannot be deleted in TIBCO Designer. You can apply custom metadata to the resources through the DAV tab of the user’s XML Canon home page. custom properties can be specified for individual components as well. Because XML Canon automatically treats all of the project’s resources as part of the Revision Control System.) If you check in a single change (using the Check in selected button) with a dependency on another change. A folder must be acquired if you want to: • • • • TIBCO BusinessWorks Process Design Guide . You cannot check in any changes until synchronization conflicts are resolved. the Add Resource to RCS option of the right-button menu Multi-User menus is not applicable when working with XML Canon. keep in mind that some changes are dependent upon other changes. To delete a project. (For example. • • Synchronize (Multi-User > Synchronize Project) often to ensure your project reflects the changes made by other users. Tips and Tricks The following tips will help you use XML Canon effectively as a version control system. its resources and sub-folders are not checked-out. When you acquire a folder. the other change will also be checked in.XML Canon 233 | Table 24 Revision control system information Field Supported lock Description The WebDAV locks allowed on the resource. For XML Schemas. a new child folder cannot be checked in until its parent folder is checked in. Acquisitions are not recursive. use a WebDAV client.

and sometimes you can add resources to folders even if someone else has checked out that folder. When several users work in the same folder.234 | Appendix A Working with a Revision Control System a. Sometimes a check-out is recursive (optional or forced). delete the folder Tips and Tricks for Using Version Control Systems The following techniques will help you use your version control system (File Sharing or Visual SourceSafe) effectively: • Check in and synchronize on a regular basis. Do not lock folders unless you have to. for example. and rename resources in that folder. TIBCO BusinessWorks Process Design Guide . edit the folder’s description d. only the folder owner can add. Do not keep the AESchemas folder locked. Structure your project so each user owns a folder and works in it. Do not keep the root folder locked. Even though the capability of adding to a locked folder is there. If you do. See Table 25 and Table 26 below. other users cannot add resources in it (not even their own folder). The information displayed by TIBCO Designer may not be completely accurate if there are a large number of differences between the project in TIBCO Designer and the project in VSS. Structure your project so that each user owns a folder in the AESchemas area. If you do. it can still cause problems. rename the folder (or one of its resources or sub-folders) b. other users cannot add resources in it (not even their own folder inside AESchemas). • • • • • Access Rights on Resources The following two tables illustrate the access rights on unlocked resources when the parent folder is or is not locked. move the folder c. In the table: • Locked means either checked out by someone else or not checked out. delete. if two people attempt to add a resource with the same name.

copy. Move. and linking to another location. The following table illustrates the access rights on locked resources. and link refer to moving. copy. and linking to another location. In the table: • • Locked means either checked out by someone else or not checked out. copying. Table 25 Actions on resources that are not locked Action on Resource Folder is Locked Folder is not Locked Add N Y Delete N Y Modify Y Y Rename N Y Move N Y Copy Y Y Link Y Y Note that when the folder is locked. you are able to modify the resource but not rename it. Table 26 Actions on locked resources Action on Resource Folder is Locked Folder is not Locked Add N Y Delete N N Modify N N Rename N N Move N N Copy Y Y Link Y Y TIBCO BusinessWorks Process Design Guide . and link refer to moving.Tips and Tricks for Using Version Control Systems 235 | • Move. copying.

236 | Appendix A Working with a Revision Control System TIBCO BusinessWorks Process Design Guide .

page 238 Setting Custom Engine Properties in Deployed Projects. page 238 Setting Custom Engine Properties for the Testing Environment. Topics • • • • Overview of Custom Engine Properties. page 240 Available Custom Engine Properties.| 237 Appendix B Custom Engine Properties TIBCO BusinessWorks process engines can be configured using custom properties in configuration files. This appendix describes the custom properties that can be altered. page 241 TIBCO BusinessWorks Process Design Guide .

or a colon (:).error = false Some properties can be set for specific process definitions or activities. However. For example. Setting Custom Engine Properties for the Testing Environment TIBCO Designer runs a process engine when you test process definitions using the Tester tab. you can specify custom properties in the engine’s configuration files to configure the process engine to suit your needs. \ . you must create a properties file and specify its location. custom properties are available for enabling/disabling and setting the level of tracing for the engine. This prevents any trace messages for the role named error from being written to the log file or console. you must escape these characters in the property value by using a \ (for example. equal sign. Trace. Properties are set by specifying their name and value in the configuration files. the following line sets the property Trace. Trace.error to false.* is the property to control tracing for all roles. or \:). an equal sign (=). Custom properties are also available for configuring the maximum and minimum number of connections for the HTTP server that handles incoming HTTP requests for TIBCO BusinessWorks.Role. You can place comments in the configuration files by placing a hash (#) as the first character in a comment line.238 | Appendix B Custom Engine Properties Overview of Custom Engine Properties The TIBCO BusinessWorks process engine is responsible for running instances of your process definitions.Role. The following sections describe how to set custom engine properties and list the custom properties that you can set. For example. \=. Perform the following procedure to set custom engine properties for the testing environment. Properties that have variable portions can use the wildcard character (*) to indicate the property should be set to the specified value for all potential names. For example.Role. and the property name can be variable. The default configuration settings of the engine are sufficient for most users. TIBCO BusinessWorks Process Design Guide . or colon. Property names and values can be separated by either a space ( ). To set custom properties for the process engine that TIBCO Designer runs. If a property value contains a space.

tra. 2.tra file to point to a properties file. 4. TIBCO BusinessWorks Process Design Guide . Add properties to your file. Click the Start Testing Viewed Process button to start the test engine (see Process Instances During Testing on page 203 for more information about the process engine during testing). perform the following: 1. 3. this file is usually located at c:\tibco\designer\<release_number>\bin\designer. In the Test Engine User Args field. Create your properties file and place it in the desired location. Create a properties file containing the custom properties you wish to set in the process engine that runs in the testing environment. This file is located in the bin subdirectory of the TIBCO Designer installation directory. 3.cfg. on MS Windows machines.Args -p c:\\tibco\\properties. where <release_number> is the release number of the currently installed TIBCO Designer. click the Advanced button. 5. enter the -p argument. On the Select Processes to Load dialog. java.property. you can alter the designer.tra file to specify the location of your properties file.Setting Custom Engine Properties for the Testing Environment 239 | 1. 2. 6. followed by the location of your properties.cfg The line above illustrates a properties file placed in the c:\tibco directory of a MS Windows machine. To alter the designer. Notice the backslashes in the file path are escaped because backslash is a reserved character in properties files. Add the following line to designer.tra file. -p c:/tibco/properties.User. For example. For example.tra to inform TIBCO Designer of the location of the properties file you created in step #1. Edit the designer. Start TIBCO Designer and open the project you wish to test. For example.testEngine.cfg If you always use the same properties file.cfg file. create a file named properties.

xml where <release_number> is the release number of the currently installed TIBCO Designer.* property in deployment configurations.xml file. it is available in Enterprise Archive Files that are created by TIBCO Designer and will be displayed in the Advanced tab of the deployment configuration in TIBCO Administrator. You can alter the value of any property on the Advanced tab of the deployment configuration and that value will be used in the deployed project.xml file: <property> <name>Trace All Roles</name> <option>Trace. this file would by default be located in c:\tibco\bw\<release_number>\lib\com\tibco\deployment\bwengine.</description> </property> Once the property is defined in the bwengine. For example. The bwengine.240 | Appendix B Custom Engine Properties Setting Custom Engine Properties in Deployed Projects TIBCO Administrator is responsible for deploying process engines in a production environment.Role. Each property is contained in a <property> element with the following structure: <property> <name>Name to display in TIBCO Administrator</name> <option>name of property</option> <default>default value</default> <description>short description of property</description> </property> For example.*</option> <default>false</default> <description>Controls tracing of all roles. TIBCO BusinessWorks provides a file for specifying any custom properties you wish to set in deployed engines.Role. See TIBCO Administrator User’s Guide for more information about creating and managing deployment configurations. to include the Trace. TIBCO BusinessWorks Process Design Guide . on MS Windows machines.xml file has a <properties> element that defines all of the properties you would like to have available in deployed process engine. Be sure to re-save EAR files in TIBCO Designer and re-load them into any deployment configurations created in TIBCO Administrator after changing the bwengine. you would add the following to the bwengine.xml file. The bwengine.xml file is located in the lib\com\tibco\deployment subdirectory of the TIBCO BusinessWorks installation directory.

false indicates duplicateKeys when specified are ignored.engine.* property to true.engine.timeout.dupKey.engine.dupKey. Most properties are boolean and can be set to a value of true or false to enable or disable them. TIBCO BusinessWorks Process Design Guide . See Detecting Duplicate Process Instances on page 184 for more information about duplicate detection. true (the default) indicates the process engine will check for identical duplicateKey values. Engine Properties This section describes properties that control the behavior of the process engine. memory saving mode is disabled. See Detecting Duplicate Process Instances on page 184 for more information about duplicate detection.minutes Specifies the number of minutes to wait before polling for expired duplicateKey values. You can enable memory saving mode for all process instances by setting the EnableMemorySavingMode. bw. its syntax is explained in the property description. By default.dupKey. 0 indicates to store duplicateKey values indefinately. The default is 30 minutes.enabled This property controls whether duplicate detection is performed. bw. bw. When a property has a non-boolean value. See Detecting Duplicate Process Instances on page 184 for more information about duplicate detection.<processName> Memory saving mode can reduce the memory used by actively running process instances as well as potentially improve the performance of checkpoints.<processName> property to true. -1 indicates the duplicateKey values are deleted when the job completes.minutes This property specifies how long (in minutes) to keep stored duplicateKeys.Available Custom Engine Properties 241 | Available Custom Engine Properties The following sections describe the custom properties that you can set. EnableMemorySavingMode. Any positive integer greater than 0 indicates the number of minutes to keep stored duplicateKeys. but you can enable garbage collection on specific process instances by setting the EnableMemorySavingMode.pollPeriod.

ShutdownOnStartupError By default.242 | Appendix B Custom Engine Properties See Memory Usage of Process Variables on page 100 for more information. Engine.StandAlone Under some situations. The default value of this parameter is 20. The default value is sufficient for most situations. the restarted process instances continue to be processed and may eventually be lost depending upon the type of error at startup. checkpointed process instances are restarted when the engine restarts. you may benefit from setting this property to a higher value. it is difficult to determine the correct value for this property. but setting it to true shuts the engine down if errors are encountered when the engine starts. this may cause less concurrency for executing process instances (and therefore inefficient use of CPU). but if your process definitions contain a large number of activities and especially if they contain a large number of activities in iteration loops. and if the engine encounters errors during startup. By default. You can specify that the process engine should shutdown if any errors are encountered during startup so that checkpointed jobs are not lost in the event of an error. However. The properties in this section should be set only on deployed engines.StepCount This property controls the max number of execution steps (unless inside a transaction) for a job before an engine thread switch occurs. Engine. Frequent thread switching can cause engine performance degradation. the value of the property is false. a unique constraint violation is thrown when using a database as the data manager for process engines. process engines have a TIBCO Hawk microagent as well. See the description of the Checkpoint activity in TIBCO BusinessWorks Palette Reference for more information. Engine. These properties are not intended to be used with process engines started by TIBCO Designer for testing process definitions. Set this property to false if you encounter this situation.ShutdownOnStartupError controls this behavior. TIBCO Hawk Properties TIBCO Administrator is the preferred monitoring and management tool for TIBCO BusinessWorks. The custom engine property named Engine. TIBCO BusinessWorks Process Design Guide . but when a process instance keeps the tread too long. Therefore.

See the TIBCO Rendezvous documentation for more information about the syntax of the daemon parameter of TIBCO Rendezvous transports. Hawk.Enabled Controls whether or not TIBCO Hawk can be used to monitor and manage the process engine. TIBCO BusinessWorks Process Design Guide . Hawk. By default this is set to tcp:host:7474. Also.Available Custom Engine Properties 243 | See Appendix C.Service Specifies the service parameter for the TIBCO Rendezvous transport of your TIBCO Hawk configuration. TIBCO Hawk MicroAgent Methods. local false Hawk. on page 255 for more information about using TIBCO Hawk to monitor and manage TIBCO BusinessWorks. See the TIBCO Rendezvous documentation for more information about the syntax of the service parameter of TIBCO Rendezvous transports.Daemon Specifies the daemon parameter for the TIBCO Rendezvous transport of your TIBCO Hawk configuration. TIBCO Hawk cannot be used when this value is used. By default this is set to "". allows the Engine Command activity to be used. The following table describes the valid values for this property: Value true Description Enables both TIBCO Hawk and Engine Command activity usage. Hawk. By default this is set to 7474.Network Specifies the network parameter for the TIBCO Rendezvous transport of your TIBCO Hawk configuration. See the TIBCO Rendezvous documentation for more information about the syntax of the network parameter of TIBCO Rendezvous transports. Disabled both TIBCO Hawk and Engine Command activity usage. Enables only Engine Command activity.

Warn.Term Trace. by activities.Term TIBCO BusinessWorks Process Design Guide . Tracing is controlled either by roles. The actions that can be enabled or disabled are: • • Collection of activity statistics for the GetActivity microagent method Calls to OnProcessActivity and OnProcessStatusChanged microagent methods Setting the engine property Instrumentation. or Debug) are sent to the console.Role. Debug).*.Term controls whether or not messages for the specified user-defined role are sent to the console. Setting the property Instrumentation.244 | Appendix B Custom Engine Properties Instrumentation.<systemRoleName>.Term or Trace. or published as TIBCO Rendezvous messages. Warn.<systemRoleName>.Role.Role. Specifying Location of Trace Messages The following properties control where trace messages are sent. These actions can be enabled or disabled on a per-process definition basis at any time by setting this property.<userRoleName>. Trace Properties Trace properties control which trace messages are sent and where they are sent to. Messages can be sent to the log file. Setting this property to false disables the actions. or you can configure tracing for user-defined roles. use Trace. Info. or by process definitions. Info. The Write to Log activity allows you to specify a user-defined role for the message to write. controls whether or not messages for the specified system role (Error. The instrumentation properties can be set at runtime by calling the TIBCO Hawk setInstrumentProperties method. Trace. you can configure system role tracing (Error.<processName> to true enables those actions for a specified process definition.* to true enables those actions for all process definitions.<processName> Some of the TIBCO Hawk instrumentation methods require runtime actions that impose performance and memory overhead.<userRoleName>. The property value specified in a call to setInsrumentProperties takes effect immediately. For roles. Trace. to the console.Term to control console output for all user-defined roles.

Role. You can specify a different transport for published trace messages with the following properties: • • • • Trace. Specifying Rolling Log Files for UserRole You can specify that entries for the role named UserRole are sent to a set of rolling log files. Once the maximum number of log files is reached. Trace. • Trace.Role.Service Trace.Role.UserRole.File — Filename for the log files. the messages are sent on TIBCO BusinessWorks default transport. — Maximum size of a log file before entries are directed to the next log file in the sequence.Log Trace. Info.Dir — Location for the set of rolling log files.<systemRoleName>.Publish controls whether or not messages for the specified system role (Error.Role.Log controls whether or not messages for the specified user-defined role are sent to the log file.<systemRoleName>.Network Trace. or Debug) are published as a TIBCO Rendezvous message.Publish Trace.UserRole. entries are then directed back to the first log file again.Log or Trace.Publish.Daemon See the TIBCO Rendezvous documentation for the correct syntax for specifying transport parameters. By default.UserRole. and the maximum size of each log file.Subject Trace. use Trace.Role. log file name.<systemRoleName>. To accomplish this.Role.Log. A number is appended to each new log file created up to the specified maximum number of log files.<systemRoleName>.Role. you specify the location of the log files. The following engine properties allow you to configure rolling log files: • • Trace.Log.<userRoleName>.Log.Available Custom Engine Properties 245 | Trace. Entries will be written to the first log file until it reaches its maximum size.<userRoleName>. Warn. Trace.Role. Info.Publish.<systemRoleName>. Warn.MaxSize TIBCO BusinessWorks Process Design Guide .Log controls whether or not messages for the specified system role (Error. the number of log files.Log to control log output for all user-defined roles.<systemRoleName>. and then entries are then directed to the second log file until it reaches its maximum size. and so on.<systemRoleName>.*.<systemRoleName>.Publish.Publish. Trace. or Debug) are sent to the log file.

Specify Trace. Warn.Task.<userRoleName> enables or disables the specified user-defined role.Role.* to enable or disable all user-defined roles.<systemRoleName>.* Controls whether or not trace messages for all activities are output. TIBCO Rendezvous Advisory Messages TIBCO Rendezvous advisory messages can be written to the TIBCO BusinessWorks log file.Log.Role.Task. Info.* Enables or disables the specified role.* to control trace messages for all process starters. Trace.<activityName> Controls whether or not trace messages for a given activity in a process definition are output. Trace.* enables or disables the specified system role (Error.Maximum — Maximum number of log files to create.<processStarterName> Controls whether or not trace messages for a given process starter are output. Specifying a wildcard for the process definition name indicates you would like to control trace messages for all activities with a given name. There are three types of advisory messages: Error.246 | Appendix B Custom Engine Properties • Trace.UserRole. Tracing by Resource The following properties enable or disable tracing for activities and process starters.Role. and Info. The following properties control whether TIBCO Rendezvous advisory messages are sent to the log file: TIBCO BusinessWorks Process Design Guide .<systemRoleName>. Trace. Error advisories are logged by default.<userRoleName> or Trace.Role.JC. Specifying a wildcard for the activity name indicates you would like to control trace messages for all activities in the specified process definition. Warn.JC. or Debug). Trace. Entries are directed back to the first log file when the maximum number of log files have been created. Tracing by Role The following properties enable or disable all tracing for user-defined and system roles.<processDefinition>. specify Trace. Trace. Trace.

The default maximum number of threads is 75. The default minimum number of threads is 10.Available Custom Engine Properties 247 | • • • Trace. The default value of this property is 10. you may wish to alter the configuration of the HTTP server that receives incoming HTTP requests for TIBCO BusinessWorks.Advisory. This section lists the properties for configuring the HTTP server. belonging to the thread pool associated with the activity. Send HTTP Request or SOAP Request Reply) is associated with a unique thread pool.RV. The HTTP server will not create more than the number of threads specified by this parameter. The number of threads in the pool determines the maximum number of concurrent requests a request/response activity can execute.http.RV. Each request is executed in a separate thread.client.Error Trace.Warn Trace.plugin.maxProcessors This property specifies the maximum number of threads available for incoming HTTP requests. TIBCO BusinessWorks Process Design Guide . therefore be careful to set the value of this property to a reasonable number for your system.server.http. The thread pool is created when the engine starts.ResponseThreadPool Each Request/Response activity that uses the HTTP protocol (for example.minProcessors This property specifies the minimum number of threads available for incoming HTTP requests.http.Info Setting these properties to true enables the associated advisory messages.Advisory. setting the properties to false disables the advisory messages. bw.plugin. If you set the value too high. it may result in extra resources allocated that are never used.Advisory.server.RV. HTTP Properties In some situations. The HTTP server creates the number of threads specified by this parameter when it starts up.plugin. bw. The value of this property controls the size of the thread pool. bw.

248 | Appendix B Custom Engine Properties bw.usePersistentConnectionManager property is set to true.usePersistentConnectionManager This property specifies that a pool of HTTP connections to each HTTP server should be created so that connections can be reused by Send HTTP Request activities.client.plugin.client. bw.plugin. The default value of this property is false.client.plugin.http.http.client. bw.usePersistentConnectionManager property is set to true. See the description of the Send HTTP Request activity in TIBCO BusinessWorks Palette Reference for more information.client.plugin. The default value for this property is 200. Refer to your HTTP server documentation for more information about support for persistent connections.http. The number of connections for each host is limited by the bw. See the description of the Send HTTP Request activity in TIBCO BusinessWorks Palette Reference for more information.http. This property specifies the maximum number of persistent connections to create for all HTTP servers.plugin. a pool of connections is created for each HTTP server that Send HTTP Request activities connect to. The default value for this property is 20. TIBCO BusinessWorks Process Design Guide . See the description of the Send HTTP Request activity in TIBCO BusinessWorks Palette Reference for more information.http.client. The total number of connections in the pool is limited by the bw.plugin.maxTotalConnections property.maxTotalConnections The value of this property is ignored unless the bw. This property specifies the maximum number of persistent connections to each remote HTTP server.maxConnectionsPerHost property.maxConnectionsPerHost The value of this property is ignored unless the bw.client.plugin.http.http. Not all HTTP servers support persistent connections. When this property is set to true.

http.deferClientAuthentication Defers client authentication and outputs the client’s security context when the client connects to the server using HTTPS. The default timeout for database connections is 5 minutes. The default value for this property is false. Most JDBC drivers should support connection timeouts.engine.usePersistentConnectionManager property is set to true. This parameter specifies the time (in minutes) to allow database connections to remain idle before closing them.server. See the description of the Send HTTP Request activity in TIBCO BusinessWorks Palette Reference for more information. The value of this property overrides any value set for connection timeouts in the Configuration tab of the JDBC Connection resource.plugin. The value of this parameter can be either a host name or IP address. Checking for stale connections adds significant processing overhead.http.server.JDBC. connections in the database connection pool close after a period of time when they are idle.client. If the JDBC driver does not support connection timeouts.dbConnection.http.checkForStaleConnections The value of this property is ignored unless the bw. TIBCO BusinessWorks Process Design Guide . JDBC Properties This section describes custom engine properties that can be set for resources in the JDBC palette. a connection can become stale. but you can set this property to the amount of time you would like to keep database connections open. When this property is set to true. but it does improve reliability. Only JDBC drivers that support connection timeouts can use this property. bw. a persistent connection is checked to determine if it is stale before it is used by a Send HTTP Request activity.idleTimeout Normally.SetLoginTimeout Time (in seconds) to wait for a successful database connection. bw. When using persistent connections.plugin. bw.plugin.Connection.plugin.defaultHost Specifies the name of the default host to use when the machine has multiple domains or IP addresses.client. Config.Available Custom Engine Properties 249 | bw.https. the value of this field is ignored.

jms. The number of retries within that three-minute limit depends upon the value of the polling interval.receiverRetryCount When a mail sender is in the process of sending a message. if the polling interval is set to 30 seconds. For example. bw. TIBCO BusinessWorks Process Design Guide .recoverOnStartupError When a process engine attempts to startup and the JMS server that JMS activities connect to is not up. The Receive Mail process starter attempts to receive the message during subsequent polls of the mail server. bw. By default. the JMS process starters cannot connect to the JMS server. there will be up to six retries.mail. Setting this property to true allows the process engine to start and the JMS process starters will wait until the JMS sever is up before starting. if the polling interval is every 10 seconds.plugin. For example. If the polling interval is set to 4 minutes. there will be only one retry. but indicate later that the message is unavailable. the process starter will attempt to receive the message for three minutes. the mail server may expose the message to the Receive Mail process starter. Mail Properties This section describes custom engine properties that can be set for the resources in the Mail palette. and the retry count is set to 12.250 | Appendix B Custom Engine Properties JMS Properties This section describes custom engine properties that can be set for resources in the JMS palette.plugin. This property allows you to specify the number of times the Receive Mail process starter will attempt to receive the same message. The amount of time allotted for retries will be the value of this property multiplied by the polling interval. This typically occurs when sending large messages. then the Receive Mail process starter will attempt to receive the message for two minutes.

Functionality changes are usually introduced to improve the product or to correct erroneous behavior. the activity used URL encoding for the Query specified in the QueryString element. there are properties that allow you to revert to the behavior of previous releases.stripLineFeedInPut to true to obtain the behavior of previous releases. The properties in this section are intended to allow backward compatibility of legacy projects until the project can be corrected to accommodate the new behavior. the activity does attempt to encode the value supplied in this element. However.plugin. These properties are not intended for long-term use. This section lists properties that are included for backwards compatibility with projects created in previous versions.urlEncodeQueryString As of release 5. Prior to release 5. but setting it to true reverts to the behavior of previous releases. This caused files to be unusable when a file was taken from a MS Windows machine and put onto a VMS machine. the FTP Put activity stripped the \n when \r\n was used for a new line in a file. and if you rely on this behavior in existing projects. relying on the behavior of previous releases is not recommended for new projects.javaCode. This change may cause backward compatibility issues if you rely on the activity to perform the URL-encoding of the QueryString. functional behavior of TIBCO BusinessWorks changes. the QueryString input element of the Send HTTP Request activity is not automatically URL encoded. It is now the user's responsibility to properly URL-encode the query specified in the QueryString.explicitNull To indicate a null reference. Other activities pass an explicit null for null references.plugin. the Java Code activity omits the value in its output.0.2.stripLineFeedInPut Prior to release 5.2. bw. you can set the bw. If you rely on the behavior of previous releases. While properties in this section can be used to revert to behavior of previous releases.plugin. bw. TIBCO BusinessWorks Process Design Guide .http.plugin. other activities did not behave in this way.0. Therefore. bw.ftp. This causes a String value used as a null place holder when another activity attempts to read the null in its input. Therefore. This property is set to false by default.client. The FTP Put activity no longer strips the \n.ftp. use of these properties is not recommended for most circumstances.Available Custom Engine Properties 251 | Properties for Backwards Compatibility From time to time.2.

the XPath function create-dateTime() returned a value that included a time zone.explicitNull to true to cause the Java Code activity to behave in the same way as other activities.252 | Appendix B Custom Engine Properties To preserve backward compatibility. These migrated projects cannot be executed until the errors are resolved (by using the Mapper Check and Repair button on the Input tab).x).tibco. the Java Code activity still behaves the same. In release 5. the Timer process starter used the Java convention (0-11) for month numbers in its output.0.InputOptional In releases prior to 5. you can set this property to true to maintain compatibility with previous releases. If you rely on the behavior of previous releases.plugin.xpath.1. TIBCO BusinessWorks Process Design Guide . com. However.x).soap.no_xsi_type SOAP activities were enhanced in release 2.5 to emit xsi:type attributes.2 and 5.timer.plugin. In Release 5. the function was changed to omit the time zone. there will be validation errors for any unspecified input elements for stored procedure parameters.xml. the JDBC Call Procedure activity created input elements that were optional for stored procedure parameters. an explicit null is set for a null reference.2.0.0. When migrating a project from a previous release. Setting this property to false (the default value) omits the time zone from the function output (the same behavior as 5.javaCode. maintaining the behavior of the previous releases. the expected convention for month numbers is 1-12. This property controls whether the time zone is included in the output of the create-dateTime() function. the month is returned as a number between 1 and 12. com.has. Optional parameters have never been supported by this activity (see the Known Issues list under the JDBC Palette heading in TIBCO BusinessWorks Release Notes). you can do so by setting this property to true. you must set this property to true.3.timezone In Release 2.CallProcedure. If you wish to migrate a project without fixing this problem.plugin. Setting this property to true causes the time zone to be included in the function output (the same behavior as 2.tibco.x.2.create-dateTime.1. you can set the bw. bw.JDBC. When this property is set to true.useJavaMonth In previous releases.1. This property is set to false by default. Config. however. If you wish to maintain backward compatibility and not emit these attributes.

you can set this property to false. If you wish to retain the functionality of previous releases. set the value of this property to true.0. CA". if a value returned from a database table was null. but it is valid.Available Custom Engine Properties 253 | Config. the File Reader activity’s output includes the BOM at the beginning of the data read from the file. The element is now placed into the output schema and has "xsi:nil = true" to indicate the element is null. there was no way to have a field span multiple lines or include leading and trailing spaces. The BOM is now stripped when it is encountered. Now fields can be surrounded in double quotes.tibco. This can result in mappings (optional to optional) that do not copy the xsi:nil attributes at runtime to the output elements. delimiter-separated data was not treated in a standard way.property.property. java. the output element corresponding to that table value was not placed into the output schema for a JDBC Call Procedure activity.ae.makeNillable Certain TIBCO ActiveEnterprise-based schema elements do not display as nillable in the Input mapping tab. To maintain the behavior of previous releases. java. when using the activities in the Parse palette.OutputUseNil Prior to release 5.schema. There was no mechanism to escape the specified delimiter character.CallProcedure.DiscardUTF8BOM When a file is saved on a Windows platform using UTF-8 encoding.2. You may need to set this property to true if your process definition is expecting a file that contains the BOM. Prior to release 2. if you chose a comma as the delimiter. For example.1. ignore.under. TIBCO BusinessWorks Process Design Guide . this property controls whether elements that are nil are contained in the output.quotes Prior to Release 2.JDBC. if the output element was optional.com. This BOM is not necessary for UTF-8.0. To disable this functionality. See the description of the Data Format shared configuration resource in TIBCO BusinessWorks Palette Reference for more information about the new semantics for parsing input text. In most cases. you will not need to set this property. and subsequently validation errors.6. Windows adds a Byte Order Mark (BOM) to the beginning of the file. Set the property to false to achieve the behavior of previous releases.4. there was no way to have a field contain a comma as in "Fresno. Also.delimiters. You should surround elements that can be nil with an if statement to determine whether to output the element.

then the property can be set to false. set to copy-nil”.2. If it is preferable to have empty elements emitted in this case. Typically. TIBCO BusinessWorks Process Design Guide . the Mapper Check and repair button can be used to update the mappings to copy xsi:nil attributes. This is generally a better way to map this structure and ensures if the element in the source data has the xsi:nil attribute. Clicking OK changes the mappings to add the copy-of for the nil attribute (“Optional and nillable to optional and nillable”).1 and subsequent releases. In Release 5.254 | Appendix B Custom Engine Properties Setting this property to true causes mappings that meet the criteria to show warnings. Selecting the input mapping with an error and clicking the Mapper Check and repair button will display yellow warnings: “The input and this element are both nillable. Any new mapping done by drag-and-drop with the property set to true will have the “Optional and nillable” style mapping. it will be copied to the target element. instead of the “optional to optional” style. which may cause new warnings to appear in existing projects. the default setting for this property is true.

page 256 TIBCO Hawk Microagent Methods.| 255 Appendix C TIBCO Hawk MicroAgent Methods TIBCO Administrator is the preferred monitoring and management application for TIBCO BusinessWorks. However. Topics • • Enabling TIBCO Hawk. the process engine is instrumented with a TIBCO Hawk microagent that can be used to perform most administrative functions. This appendix describes the microagent methods available for the TIBCO BusinessWorks process engine. page 256 TIBCO BusinessWorks Process Design Guide .

Enabled property to true. set the Hawk. To enable instrumentation for all processes. certain instrumentation is disabled by default. None TIBCO BusinessWorks Process Design Guide .Network.<processName> property. Custom Engine Properties. you must also set the Hawk.256 | Appendix C TIBCO Hawk MicroAgent Methods Enabling TIBCO Hawk Before using the TIBCO Hawk with TIBCO BusinessWorks. you must enable the TIBCO Hawk microagent in the process engine. GetExecInfo Description: Method Arguments: Retrieves the process engine execution information. You should only enable instrumentation for brief periods while testing performance. Hawk.Service.* property. on page 237 for more information about setting properties for process engines. If you are using non-default transport parameters for TIBCO Hawk. See Appendix B. You can enable instrumentation for a specific process definition with the Instrumentation. To do this. therefore TIBCO Hawk is not recommended for use in the testing environment. This can only be set for deployed process engines. Because of the performance implications. Some microagent methods require memory and processor overhead for gathering statistics or for getting information on the current state of the process. Enabling instrumentation can lead to significant performance degradation. use the Instrumentation. and Hawk. TIBCO Hawk Microagent Methods This section describes the TIBCO Hawk microagent methods for the TIBCO BusinessWorks process engine. Process engines in the test environment are not normally monitored and administered.Daemon properties to the values for the transport you are using.

Name of the process starter for the process. Can be one of the following: • • • • Uptime Threads Version ACTIVE SUSPENDED STANDBY STOPPING Elapsed time (in milliseconds) since the process engine was started. Number of worker threads used by the process engine. Version of the process engine. Number of process instances created for this process definition. None The following table describes the output of this microagent method: Column Name Name Starter Created Suspended Swapped Description Name of the process definition. Number of times process instances have been suspended. GetProcessDefinitions Description: Method Arguments: Output: Retrieves information about executing process definitions. TIBCO BusinessWorks Process Design Guide .TIBCO Hawk Microagent Methods 257 | Output: The following table describes the output of this microagent method: Column Name Staus Description Engine status. Number of times process instances have been swapped to disk.

Average execution time (in milliseconds) for all successfully completed process instances. Execution time (in milliseconds) of the most recently completed process instance. MaxElapsed MinExecution MaxExecution MostRecentExecutionTime MostRecentElapsedTime TIBCO BusinessWorks Process Design Guide . Number of process instances that have been successfully completed. Total execution time (in milliseconds) for all successfully completed process instances. Number of times process instances have executed a checkpoint. Elapsed clock time (in milliseconds) of the process instance that has completed in the longest amount of elapsed time. Total elapsed time (in milliseconds) for all successfully completed process instances. Elapsed clock time (in milliseconds) of the process instance that has completed in the shortest amount of elapsed time.258 | Appendix C TIBCO Hawk MicroAgent Methods Column Name Queued Aborted Completed Checkpointed TotalExecution AverageExecution TotalElapsed AverageElapsed MinElapsed Description Number of times process instances have been queued for execution. Average elapsed clock time (in milliseconds) for all successfully completed process instances. Execution time (in milliseconds) of the process instance that has completed in the shortest amount of execution time. Number of times process instances have been aborted. Execution time (in milliseconds) of the process instance that has completed in the longest amount of execution time. Elapsed clock time (in milliseconds) of the most recently completed process instance.

com. For example. Number of process instances that have completed since the last reset of the statistics. Name of the process definition used by the process instance. for the type of the activity.CallProcessActivity. Method Arguments: Output: The following table describes the output of this microagent method: Column Name Name Type Description Name of the activity as specified in TIBCO Designer. The following table describes the arguments of this microagent method: Argument Name Id Name Description ID for the process instance. information for process instances that match the specified arguments is returned. GetProcesses Description: Retrieves information about active process instances.TIBCO Hawk Microagent Methods 259 | Column Name TimeSinceLastUpdate CountSinceReset Description Time (in milliseconds) since the statistics have been updated. If arguments are specified. Method Arguments: TIBCO BusinessWorks Process Design Guide . GetStaticActivityInfo Description: Retrieves design time activity information for all activities in a given process definition.core.pe. The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description Name of the process definition.tibco. A Java class name.

260 | Appendix C TIBCO Hawk MicroAgent Methods Argument Name EarliestStartTime Description Earliest time (in milliseconds) at which the process instance started. TIBCO BusinessWorks Process Design Guide . Name of the process starter that started this process instance. Elapsed clock time (in milliseconds) since the process instance started. All process instances started after the specified time will be retrieved. Minimum time (in milliseconds) in elapsed clock time since the process instance started. Name of the main process definition. Custom ID for the process instance. Name of the currently executing activity in the process instance. MinimumDuration MainProcessName Output: The following table describes the output of this microagent method: Column Name Id Name TrackingId CustomId Status StartTime Duration MainProcessName CurrentActivityName StarterName SubProcessName Description ID for the process instance. All process instances that have elapsed times greater than the specified minimum duration will be retrieved. Name of the process definition used by the process instance. Tracking ID for the process instance. Status of the process. Name of the process definition for the sub-process. Time when the process instance started. Name of the main process definition.

. DEAD. Call Process.TIBCO Hawk Microagent Methods 261 | GetActivities Description: Retrieves information about the activities that have been executed for a given process definition since the engine was started. Name of the class that implements the activity. This can be either OK. A single activity name represents all executions of that activity. Number of times the activity has been executed. activities. Status code returned by most recent execution of this activity. Total number of executions of the activity that have returned an error. This includes waiting time for Sleep. activities. Name of the activity.. This does not include waiting time for Sleep. Call Process. or ERROR.. Total clock time (in milliseconds) used by all executions of this activity. and Wait For. The min/max fields can be reset with the ResetActivityStats method. ExecutionTime ErrorCount LastReturnCode TIBCO BusinessWorks Process Design Guide .. The ExecutionTime computation for the Call Process Activity includes the sum of the execution times for all activities in the called process. not just the execution time for the call process activity itself. Output: The following table describes the output of this microagent method: Column Name ProcessDefName Name ActivityClass ExecutionCount ElapsedTime Description Name of the process definition. and Wait For. Total clock time (in milliseconds) used by all executions of this activity. Method Arguments: The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description Name of the process definition. The activity information is cumulative.

Time (in milliseconds) since the statistics have been updated. MaxElapsedTime MinExecutionTime MaxExecutionTime MostRecentElapsedTime MostRecentExecutionTime TimeSinceLastUpdate CalledProcessDefs ExecutionCountSinceReset GetProcessStarters Description: Retrieves information about either active or inactive process starters. Elapsed clock time (in milliseconds) of the activity execution that has completed in the longest amount of elapsed time. A single process starter name represents all executions of that process starter. false if tracing is disabled. A comma-separated list of names of process definitions called by this activity. TIBCO BusinessWorks Process Design Guide . Execution time (in milliseconds) of the most recently completed activity execution. Number of activity executions that have completed since the last reset of the statistics.262 | Appendix C TIBCO Hawk MicroAgent Methods Column Name Tracing MinElapsedTime Description True if tracing is enabled for this activity. Elapsed clock time (in milliseconds) of the most recently completed activity execution. The information is cumulative. Elapsed clock time (in milliseconds) of the activity execution that has completed in the shortest amount of elapsed time. Execution time (in milliseconds) of the activity execution that has completed in the longest amount of execution time. Execution time (in milliseconds) of the activity execution that has completed in the shortest amount of execution time.

Number of process instances that have completed. Output: The following table describes the output of this microagent method: Column Name ProcessDef Name Status Created CreationRate Running Completed StartTime Duration CheckpointedStart Tracing Description Name of the process definition. or READY. Status of the process starter. Elapsed clock time since the process starter was started. Number of process instances created by this process starter. Time (in milliseconds) at which the process starter was started. Number of process instances per hour created by this process starter. false if tracing is disabled. True if tracing is enabled for this process starter. Specify Inactive to retrieve information about process starters with the INACTIVE status. True if the process was restarted from a checkpoint. Number of process instances currently executing. ACTIVE.TIBCO Hawk Microagent Methods 263 | Method Arguments: The following table describes the arguments of this microagent method: Argument Name ActiveOrInactive Description Specify Active to retrieve information about process starters with the ACTIVE or READY status. The status can be INACTIVE. TIBCO BusinessWorks Process Design Guide . Name of the process starter.

TIBCO BusinessWorks Process Design Guide . Exception message. Process stack at exception. TrackingId ProcessDef State SuspendAll Description: Suspends all process starters and/or processes. Exception class name. If the activity is in a called sub-process.264 | Appendix C TIBCO Hawk MicroAgent Methods GetProcessesExceptions Description: Method Arguments: Retrieves error information reported by the specified process. Name of the process definition. or if 0 is specified. then the calling activity’s process stack plus a '>' separator character will be pre-pended to the normal information to produce the process stack of the activity issuing the exception. The following table describes the arguments of this microagent method: Argument Name Id Description ID for the process instance. If not specified. exceptions for all process instances are returned. Exception stack trace. with the most recent exception first. Tracking ID for the process instance. Output: The following table describes the output of this microagent method: Column Name Seq Id Message StackTrace ExceptionClass ProcessStack Description Sequence number of the exception. ID for the process instance. This displays the [ProcessName/GroupName/ActivityName] of the activity issuing the exception. State of the process.

TIBCO BusinessWorks Process Design Guide . Output: None KillAllProcesses Description: Kills all process instances. All process instances are stopped immediately and are permanently removed from the engine. Output: None ResumeAll Description: Method Arguments: Resumes all process starters and/or processes. AllProcessStartersAndProcesses — suspends all processes and process starters. Can be one of the following: • • • ProcessDefinition AllProcessStarters — suspends all process starters.TIBCO Hawk Microagent Methods 265 | Method Arguments: The following table describes the arguments of this microagent method: Argument Name Action Description Specifies what to suspend. The following table describes the arguments of this microagent method: Argument Name Action Description Specifies what to resume. The name of the process definition. The name of the process definition. — resumes AllProcessStartersAndProcesses all processes and process starters. Can be one of the following: • • • ProcessDefinition AllProcessStarters — resumes all process starters. AllProcesses — resumes all processes. AllProcesses — suspends all processes.

266 | Appendix C TIBCO Hawk MicroAgent Methods Method Arguments: The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description The name of the process definition. Output: None SuspendProcess Description: Method Arguments: Suspends the specified process instance. Only process instances for the specified process definition are killed. You can retrieve the process ID for a process instance by using the GetProcesses method. The following table describes the arguments of this microagent method: Argument Name ProcessNameOrId Description The name or process ID of the process instance you wish to resume. If unspecified. The following table describes the arguments of this microagent method: Argument Name ProcessNameOrId Description The name or process ID of the process instance you wish to suspend. ResumeProcess Description: Method Arguments: Resumes the specified process instance. Output: The following table describes the output of this microagent method: Column Name Status Description Status of the process instance after executing this operation. You can retrieve the process ID for a process instance by using the GetProcesses method. TIBCO BusinessWorks Process Design Guide . this action applies to all process definition.

You can retrieve the process ID for a process instance by using the GetProcesses method. The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description Name of the process definition whose process starter you wish to suspend. TIBCO BusinessWorks Process Design Guide .TIBCO Hawk Microagent Methods 267 | Output: The following table describes the output of this microagent method: Column Name Status Description Status of the process instance after executing this operation. The process instance is stopped immediately and permanently removed from the engine. KillProcess Description: Kills the specified process instance. Method Arguments: Output: None SuspendProcessStarter Description: Method Arguments: Suspends the specified process starter. The following table describes the arguments of this microagent method: Argument Name ProcessNameOrId Description The name or process ID of the process instance you wish to kill. Output: The following table describes the output of this microagent method: Column Name Status Description Status of the process starter after executing this operation.

268

| Appendix C

TIBCO Hawk MicroAgent Methods

ResumeProcessStarter
Description: Method Arguments:

Resumes the specified process starter. The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description Name of the process definition whose process starter you wish to resume.

Output:

The following table describes the output of this microagent method: Column Name Status Description Status of the process starter after executing this operation.

ListTraceProperties
Description: Method Arguments: Output:

Returns the names and current values for all engine trace properties. None The following table describes the output of this microagent method: Column Name Property Description Lists the tracing properties and their values in the form:
<TracingPropertyName>=<CurrentValue>

SetTraceProperty
Description:

Sets the specified engine tracing property to the specified value. While you can set properties with this method, ConfigureActivityTracing, ConfigureProcessStarterTracing, and ConfigureUserDefinedTracing are simpler to use for setting trace properties. See Trace Properties on page 244 for more information about tracing properties.

TIBCO BusinessWorks Process Design Guide

TIBCO Hawk Microagent Methods 269

|

Method Arguments:

The following table describes the arguments of this microagent method: Argument Name Name Value Description Name of the tracing property you wish to set.
true

if you wish to enable the property. false if you wish to disable the property.

Output:

None

ListInstrumentProperties
Description: Method Arguments: Output:

Retrieves the current settings for all Instrumentation properties. None

The following table describes the output of this microagent method: Column Name Property Description Lists the Instrumentation properties that are currently set in the form:
<ProcessDefinitionName>=<CurrentValue>

SetInstrumentProperty
Description:

Sets the Instrumentation property for the specified process definition to a given value. The OnProcessActivity and OnProcessStateChanged methods will be called for the specified processes definition names. For example, use property name "*" and value "true" to enable those asynchronous methods for all process definitions. The property name does not need to begin with "Instrumentation.", but if it does, the leading "Instrumentation." will be ignored. See Enabling TIBCO Hawk on page 256 for more information about the Instrumentation property.

TIBCO BusinessWorks Process Design Guide

270

| Appendix C

TIBCO Hawk MicroAgent Methods

Method Arguments:

The following table describes the arguments of this microagent method: Argument Name Name Description Name of the process definition for which you wish to alter the Instrumentation property. Specify * for this argument if you wish to enable or disable instrumentation for all process definitions.
true

Value

if you wish to enable instrumentation for the given process definition. false if you wish to disable instrumentation for the given process definition.

Output:

None

ListAllRoles
Description:

Returns a list of all roles, along with the current state (enabled or disabled) of each role. None

Method Arguments: Output:

The following table describes the output of this microagent method: Column Name Role Enabled Description Name of the role. True if the role is enabled, false if the role is disabled.

ListUserDefinedRoles
Description:

Returns a list of user-defined roles, along with the current state (enabled or disabled) of each role. None

Method Arguments:

TIBCO BusinessWorks Process Design Guide

TIBCO Hawk Microagent Methods 271

|

Output:

The following table describes the output of this microagent method: Column Name Role Enabled Description Name of the role. True if the role is enabled, false if the role is disabled.

GetProcessCount
Description: Method Arguments: Output:

Returns the total number of running process instances. None

The following table describes the output of this microagent method: Column Name TotalRunningProcesses Description Total number of currently executing process instances.

GetMemoryUsage
Description: Method Arguments: Output:

Retrieves information about the process engine’s memory usage. None

The following table describes the output of this microagent method: Column Name TotalBytes FreeBytes UsedBytes PercentUsed Description Total number of bytes allocated to the process engine. Total number of bytes that are not currently in use. Total number of bytes that are currently in use. Percentage of total bytes that are in use.

TIBCO BusinessWorks Process Design Guide

272

| Appendix C

TIBCO Hawk MicroAgent Methods

stopApplicationInstance
Description:

Shuts down the process engine immediately. All checkpoint files are preserved and the engine's operating system process exits. None None

Method Arguments: Output:

DelayedStopApplicationInstance
Description:

Instructs all process starters to stop further job creation but stay active. The engine shuts down after all process instances have completed or the specified maximum delay has been reached. After shutdown, any remaining checkpoint files are preserved and the engine's operating system process exits. The following table describes the arguments of this microagent method: Argument Name MaxDelay WaitForCheckpoints Description Specifies the amount of time (in seconds) to wait before shutting down the process engine. When true is specified, the engine waits for any checkpointed process instances to complete before shutting down.

Method Arguments:

Output:

None

GetStatus
Description: Method Arguments: Output:

Retrieves basic status information about the engine. None The following table describes the output of this microagent method: Column Name InstanceID Description Name of this instance of the process engine.

TIBCO BusinessWorks Process Design Guide

TIBCO Hawk Microagent Methods 273

|

Column Name AdapterName Uptime NewErrors TotalErrors ProcessID Host

Description Name of the application. Number of seconds since this process engine was started. Total number of errors encountered since the last time this method was called. Total number of errors encountered since the process engine was started. Operating system process ID of the process engine. Name of the host machine on which the process engine is running.

OnProcessStatusChanged
Description:

This method is called when a process is suspended or resumed, and it is only called when instrumentation on. None

Method Arguments: Output:

The following table describes the output of this microagent method: Column Name ProcessId When Active TrackingID ProcessDef Description ID of the process instance. Date and time when the status of the process instance changed. Status of the process instance. True when the process instance is active, false when it is inactive. Tracking ID for the process instance. Process definition name.

TIBCO BusinessWorks Process Design Guide

Application Name — TIBCO Hawk display name of the process engine.AMI. Name of the activity. STOPPING. The following are the properties that can be returned: • • Application Instance — is the name of the project that is running in the process engine. he following table describes the arguments of this microagent method: Argument Name Name Description Name of the property to return. ID of the execution track in which the activity was executed. Can be UNINITIALIZED. and it is only called when instrumentation is on. Method Arguments: Output: getHostInformation Description: Returns the value of the specified property on the host machine on which the process engine is running. Application State — state of the process engine. Process definition name. None The following table describes the output of this microagent method: Column Name ProcessId ProcessDef ActivityName TrackID Description ID of the process instance.DisplayName. Leave this argument blank to return all properties.274 | Appendix C TIBCO Hawk MicroAgent Methods OnProcessActivity Description: This method is called when a process executes an activity. INITIALIZING. RUNNING. This is set by the engine property Hawk. or STOPPED Method Arguments: • TIBCO BusinessWorks Process Design Guide .

If false. EnableAllUserRoles Output: None ConfigureActivityTracing Description: Enables or disables tracing for specified activity. The class name is the Java implementation class' name. tracing is enabled for all user-defined roles. tracing is enabled for all activities. tracing will be disabled for all process starters. Value of the property. ConfigureAllTracing Description: Method Arguments: Controls tracing for all activities and process starters.TIBCO Hawk Microagent Methods 275 | Output: The following table describes the output of this microagent method: Column Name Name Value Description Name of the property returned. tracing is enabled for all process starters. tracing will be disabled for all activities. If true. Specifying * signifies all process definitions. If true. If false. Method Arguments: TIBCO BusinessWorks Process Design Guide . Activities can be specified by process definition and activity name or by class name. The following table describes the arguments of this microagent method: Argument Name EnableAllActivities EnableAllStarters Description If true. If ActivityClass is specified. tracing will be disabled for all user-defined roles. If false. The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description Name of the process definition for which you wish to configure tracing. this argument is optional.

Specifying * signifies all activities. Method Arguments: StarterClass Enable Output: None TIBCO BusinessWorks Process Design Guide . false if you wish to disable tracing. This argument is optional if you specify the ProcessDefinition and Activity arguments.276 | Appendix C TIBCO Hawk MicroAgent Methods Argument Name Activity Description Name of the activity for which you wish to configure tracing. The class name is the Java implementation class' name. The following table describes the arguments of this microagent method: Argument Name ProcessStarter Description Name of the process starter for which you wish to configure tracing. Java implementation class name of the activity for which you wish to configure tracing. If StarterClass is specified. Specify true if you wish to enable tracing. this argument is optional. false if you wish to disable tracing. Specify true if you wish to enable tracing. Java implementation class name of the process starter for which you wish to configure tracing. This argument is optional if you specify the ProcessStarter argument. If ActivityClass is specified. Process starters can be specified by name or class name. ActivityClass Enable Output: None ConfigureProcessStarterTracing Description: Enables or disables tracing for specified process starter. this argument is optional. Specifying * signifies all process starters.

None Method Arguments: TIBCO BusinessWorks Process Design Guide . If tracing is enabled for all activities and/or process starters by specifying a tracing parameter individually for each one.TIBCO Hawk Microagent Methods 277 | ConfigureUserDefinedTracing Description: Method Arguments: Enables or disables tracing for the specified user-defined role. Specify true if you wish to enable tracing. false if you wish to disable tracing. Enable Output: None ConfigureRole Description: Method Arguments: Enables or disables tracing for the specified role. The following table describes the arguments of this microagent method: Argument Name Role Enable Description Name of the role for which you wish to configure tracing. false if you wish to disable tracing. Specifying * signifies all roles. this method will return false. True is returned when tracing is enabled using a wildcard (*). The following table describes the arguments of this microagent method: Argument Name Role Description Name of the user-defined role for which you wish to configure tracing. Output: None IsAllTracingEnabled Description: Reports whether tracing is enabled or disabled for all activities and process starters. Specifying * signifies all user-defined roles. Specify true if you wish to enable tracing.

The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Activity Description Name of the process definition for which you wish to determine tracing status.278 | Appendix C TIBCO Hawk MicroAgent Methods Output: The following table describes the output of this microagent method: Column Name ActivityTracingEnabled Description true when tracing is enabled for all activities. false when tracing is disabled for all process starters. Method Arguments: Output: The following table describes the arguments of this microagent method: Column Name Enabled Description true false if tracing is enabled for the specified activity. ProcessStarterTracingEnabled true when tracing is enabled for all process starters. TIBCO BusinessWorks Process Design Guide . this method returns false because tracing is not enabled for the activity specifically. IsActivityTracingEnabled Description: Reports whether tracing is enabled or disabled for the specified activity. If tracing is enabled for all process starters by way of a wildcard (*). IsProcessStarterTracingEnabled Description: Reports whether tracing is enabled or disabled for the specified process starter. this method returns false because tracing is not enabled for the process starter specifically. false when tracing is disabled for all activities. if tracing is disabled. Name of the activity for which you wish to determine tracing status. If tracing is enabled for all activities by way of a wildcard (*).

TIBCO BusinessWorks Process Design Guide . false if tracing is disabled. If tracing is enabled for all roles by way of a wildcard (*). Output: The following table describes the arguments of this microagent method: Column Name Enabled Description true if tracing is enabled for the specified process starter. ResetActivityStats Description: Resets the min and max time calculations for each activity in the specified process definition. This method is for internal use only and should not be invoked. The following table describes the arguments of this microagent method: Argument Name Role Description Name of the role for which you wish to determine tracing status. if tracing is disabled. this method returns false because tracing is not enabled for the role specifically.TIBCO Hawk Microagent Methods 279 | Method Arguments: The following table describes the arguments of this microagent method: Argument Name ProcessStarter Description Name of the process starter for which you wish to determine tracing status. Method Arguments: Output: The following table describes the arguments of this microagent method: Column Name Enabled Description true false if tracing is enabled for the specified role. IsRoleEnabled Description: Reports whether tracing is enabled or disabled for the specified role.

OnProcessRemoved Description: This method is called whenever a process instance is removed. and it is only called if instrumentation is on. TIBCO BusinessWorks Process Design Guide . OnProcessAdded Description: This method is called whenever a process instance is added. maximum. None Method Arguments: Output: The following table describes the arguments of this microagent method: Column Name ProcessId Description Process ID of the process instance that was added. and it is only called if instrumentation is on.280 | Appendix C TIBCO Hawk MicroAgent Methods Method Arguments: The following table describes the arguments of this microagent method: Argument Name ProcessDefinition Description Name of the process definition. The following table describes the argument of this microagent method: Argument Name ProcessDefinition Description Name of the process definition whose statistics you wish to reset. and average time statistics gathered for process instances. See GetProcessDefinitions on page 257 for more information about process instance statistics. Output: None ResetProcessDefinitionStats Description: Resets the minimum. Method Arguments: Output: None.

_onUnsolicitedMsg Description: Subscribing to this method returns any unsolicited notifications that are sent from the managed application corresponding to this microagent. Invoking this method returns the last such message that was received (if any). None Method Arguments: TIBCO BusinessWorks Process Design Guide .TIBCO Hawk Microagent Methods 281 | Method Arguments: Output: None The following table describes the arguments of this microagent method: Column Name ProcessId Description Process ID of the process instance that was added.

282 | Appendix C TIBCO Hawk MicroAgent Methods TIBCO BusinessWorks Process Design Guide .

adapter resources adding 26 addressing schema elements 148 groups 72 process definitions 40 transitions 67 creating custom palettes 17 creating projects 21 current selection 11 custom palettes 17 customer support xix D data sent across process instances 192. 200 breakpoints 201 icons 207 B breakpoints 201 icon when set 202 business processes 32 E edit custom palette 17 End activity 62 process error schemas 164 enforcing order of execution 196 enterprise computing 32 error handling 159 error propagation 162 no-action groups 79 overview 160 process error schemas 164 repeat on error until true group 86 errors 108 errors in mappings 108 evaluation context 149 TIBCO BusinessWorks Process Design Guide C Call Process activity 39 category mode 15 changing current selection 11 clearing breakpoints 201 colors used when testing process definitions 206 conditions 68 constants in XPath 114 creating . 44 creating groups 72 End 62 Input tab icons 108 Start 60 stepping through when testing 205 ungrouping 73 adding adapter resources.| 283 Index Symbols $_error process variable 160 A activities 36. 193 database storage inter-process communication 195 debugging 199.

284 | Index examples inter-process communication 195 K key incoming event 49 used for inter-process communication 192. 72 creating 72 error propagation 163 loops 80 accumulate output 81 index variable 81 no action 79 ungroupping 73 L loops 80 accumulate output 81 index variable 81 iterate 82 repeat on error until true 86 repeat until true 84 M H handling errors 159 hints 108 main window 8 mapping addressing schema elements 148 Input tab icons 108 XPath operators and functions 153 mappings 108 multiple events resuming a running process instance 196 I icons test mode 207 incoming events key 49 scalability 197 timeout 49 index variable 81 Input tab icons 108 inter-process communication 191 database storage 195 examples 195 overview 192 timeout 194 iterate loop 82 TIBCO BusinessWorks Process Design Guide N no action groups 79 Notify activity 192 Notify Configuration shared configuration 193 O opening projects 25 . 194 G Generate Error activity error propagation 162 process error schemas 164 groups 38.

Index 285 | P palette mode 15 palettes 11 closing 17 custom 17 preferences 15 process definitions 35 breakpoints 201 breakpoints for testing 201 conditions 68 creating 40 creating transitions 67 debugging 199. 200 grouping activities 72 handling errors 159 index variable in loops 81 new 36 process error schemas 164 process starters 58 propagating errors 162 scalability and incoming events 197 stepping through to test 205 subprocesses 39 test window 202 testing 200 ungroupping activities 73 process engines in operation 35 process instances communicating 192 enforcing order of execution 196 multiple events resumnig 196 when testing 203 process modeling 32 process starters 58 process variables $_error 160 processes 34 project templates 21 projects 9 adding adapter resources 26 opening 25 saving 23 propagation of errors 162 R Receive Notification activity 192 repeat on error until true loop 86 repeat until true loop 84 resources 10 unknown 11 S saving project as template 24 saving projects 23 scalability incoming events 197 schema elements 106 addressing 148 schemas process error schemas 164 search predicates in XPath expressions 150 semaphores 192 setting a breakpoint 202 setting breakpoints 201 setting which palettes display 17 shared configuration 38 specifying constants in XPath expressions 114 Start activity 60 subprocesses 39 starting process instances 58 starting TIBCO Designer 3 startup options 3 subprocesses 39 Call Process activity 39 error propagation 164 illustrated 40 support. contacting xix T technical support xix templates TIBCO BusinessWorks Process Design Guide .

66 conditions 68 creating 67 specifying constants 114 XSLT statements 108 U ungrouping 73 unknown resource 11 W Wait activity 192 waiting for incoming events 49 X XPath 147 basics 148 conditions 68 editor 151 evaluation context 149 example 153 operators and functions 153 search predicates 150 TIBCO BusinessWorks Process Design Guide .286 | Index project 21 project templates 24 test mode 199 testing process definitions 199. 200 breakpoint locations 201 colors in test mode 206 menus and toolbar icons 207 overview 200 process instances 203 stepping through activities 205 test window 202 TIBCO Designer roadmap 7 timeout incoming events 49 inter-process communication 194 transitions 37.

Sign up to vote on this title
UsefulNot useful