TIBCO Business Works - Palette Reference - Nov 2002

TIBCO BusinessWorks™
Palette Reference
Software Release 2.0.0
November 2002
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.
Technologies described herein are covered by existing patents and pending patent applications.
TIBCO technology is protected under US patent number 6,003,011.
TIB, TIBCO, Information Bus, The Power of Now, TIBCO Rendezvous, TIBCO AlertServer, TIBCO
Adapter SDK, TIBCO AdapterAdministrator, TIBCO Repository, and TIBCO Hawk 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 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-2002 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
TIBCO BusinessWorks Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
Other Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Chapter 1 Deployment Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Deployment Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Installed Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
CPU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Disk. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Process Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Recovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Recovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Any Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
TIBCO BusinessWorks Palette Reference

iv
|
Component failure event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Suspend Process Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Log Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Chapter 2 Process Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Process Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 3 ActiveEnterprise Adapter Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Adapter Request-Response Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
RV Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Adapter Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
RV Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Invoke an Adapter Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
RV Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Publish to Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
RV Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Respond to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

|v
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Wait for Adapter Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
RV Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Wait for Adapter Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
RV Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Chapter 4 BusinessConnect Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Overview of TIBCO BusinessConnect Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Receive Misc Msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Receive Request/Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Receive Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Send Misc Msg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Send Request/Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Send Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

vi
|
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Chapter 5 FTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

FTP Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
FTP Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Chapter 6 File Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Create File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
File Poller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Read File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Remove File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Wait for File Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Write File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Chapter 7 General Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Call Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

| vii
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Checkpoints and Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Called Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Recovering After a Crash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
External Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Long-Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Generate Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Java Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Passing Java Objects Between Java Code Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Output Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Null . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Receive Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

viii
|
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Write To Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Chapter 8 HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

HTTP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Send HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Input Headers/Output Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Send HTTP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Wait for HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Chapter 9 JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

JDBC Call Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
JDBC Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
JDBC Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

| ix
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Query Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
SQL Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Chapter 10 JMS Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

JMS Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
JMS Queue Receiver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
JMS Queue Requestor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Input Data/Output Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
JMS Queue Sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
JMS Topic Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
JMS Topic Requestor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Input Data/Output Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
JMS Topic Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

x
|
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Reply To JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Wait for JMS Queue Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Wait for JMS Topic Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Chapter 11 Mail Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Receive Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Send Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Chapter 12 Manual Work Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Overview of Manual Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Working With Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Working With Tasks Assigned to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Acquiring Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Working with Tasks in the Acquired List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Working with the Completed List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Administering Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Interaction With TIBCO InConcert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

| xi
Assign Work. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Download Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Get Work Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Modify Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Wait for Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Chapter 13 Parse Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Parse Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Parsing a Large Number of Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Render Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Chapter 14 Rendezvous Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Publish Rendezvous Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Input Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Rendezvous Subscriber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Output Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

xii
|
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Reply to Rendezvous Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Output Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Send Rendezvous Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Input/Ouput Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Wait for Rendezvous Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Output Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Chapter 15 SOAP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Retrieve Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Using Retrieve Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Retrieving a WSIL File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
SOAP Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Input Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Output Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Service Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
SOAP Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
SOAP Send Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
SOAP Send Reply. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

| xiii
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Chapter 16 XML Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Parse XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Parsing Date and Datetime Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Render XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Rendering Date and Datetime Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Transform XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Example of Transforming XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Chapter 17 Shared Configuration Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

BusinessConnect Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Field Offsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
FTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
HTTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Java Custom Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Example Java Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
JMS Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

xiv
|
JMS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Notify Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Proxy Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Rendezvous Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Trusted CA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Trusted Certificate & CAs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Schema Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Workflow Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
Output View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Workflow Server Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
WSDL File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Using WSIL and UDDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
XML Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
XSLT File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Editing an XSLT File Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Appendix A Specifying Data Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

| xv
Figures
Figure 1 An Adapter Request-Response Server activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Figure 2 An Adapter Subscriber activity receiving a message and starting a process. . . . . . . . . . . . . . . . . 37
Figure 3 An Invoke an Adapter Request-Response Service activity sending a request . . . . . . . . . . . . . . . 39
Figure 4 A Publish to Adapter activity sending a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 5 A Respond to Adapter Request sending a response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Figure 6 A Publish to Adapter activity sending a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Figure 7 A Wait for Adapter Request activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Figure 8 TIBCO BusinessWorks communicating with TIBCO BusinessConnect . . . . . . . . . . . . . . . . . . . . . 58
Figure 9 Using the Generate Error activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Figure 10 Passing objects between Java Code activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Figure 11 The query designer wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Figure 12 An example business process with manual work. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Figure 13 Task lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Figure 14 Task detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Figure 15 Process definition using the Retrieve Resources activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Figure 16 A process definition using the Transform XML activity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Figure 17 Input for the example Transform XML activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Figure 18 Input for the example Parse XML activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Figure 19 Parsing a text string into a data schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Figure 20 Fixed-width text strings and field offsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Figure 21 The WSIL and UDDI Registry Browser dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

xvi
|

| xvii
Tables
Table 1 Properties for JMS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Table 2 Shared configuration resources for manual work activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Table 3 Description of activities in the Manual Work palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Table 4 Task list columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Table 5 Datatypes allows for Java custom functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Table 6 Datatypes for schema items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

xviii
|

| xix
Preface
TIBCO BusinessWorks is a standards-based, easy-to-deploy solution for

companies looking to integrate their enterprise computing environment and
automate their business processes. This manual describes how to create process
definitions using TIBCO BusinessWorks.
Topics
• Related Documentation, page xx

• How to Contact TIBCO Customer Support, page xxi

xx
| Preface
Related Documentation
You may find the following documentation resources useful.
TIBCO BusinessWorks Documentation

In addition to this manual, 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, and the other manuals in the
documentation set assume you are familiar with the information in this
manual.
• TIBCO BusinessWorks Quick Start This manual steps you through a very
simple example of designing, deploying, and monitoring a TIBCO
BusinessWorks process.
• TIBCO BusinessWorks Business Process Design Guide This manual describes
how to create, edit, and test business processes using TIBCO BusinessWorks.
• 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 Release Notes Read the release notes for a list of new
and changed features. This document also contains lists of known issues and
closes issues for this release.
Other Documentation
TIBCO BusinessWorks is bundled with other products. You will therefore find the
documentation for those products useful:
• TIBCO Designer documentation. TIBCO Designer is an easy to use graphical
user interface for design-time configuration of TIBCO applications. TIBCO
Designer includes online help for each palette.
• TIBCO Administrator documentation. TIBCO Administrator is the
monitoring and managing interface for new-generation TIBCO products such
as TIBCO BusinessWorks.
• TIBCO Adapter product documentation

How to Contact TIBCO Customer Support xxi
|
How to Contact TIBCO Customer Support
For comments or problems with this manual or the software it addresses, please
contact TIBCO Product Support at:
http://support.tibco.com
Entry to this site requires a username and password. If you do not have a
username, you can request one. You must have a valid maintenance or support
contract to use this site.

xxii
| Preface

|1
Chapter 1 Deployment Palette
The Deployment palette contains resources for deploying your project to its
intended environment. See TIBCO BusinessWorks Concepts for more information
on deployment concepts and see TIBCO BusinessWorks Process Design Guide for
more information on how to deploy a project.
This chapter describes the resources available in the Deployment palette.
Topics
• Deployment Configuration, page 2

• Machine, page 3
• Process Engine, page 9
• Adapter, page 17
• Any Failure, page 20
• Component failure event, page 21
• Restart, page 25
• Alert, page 26
• Email, page 28
• Custom, page 29

2
| Deployment Palette
Deployment Configuration
The deployment configuration is a description of what adapters and process

engines to run, which machines they should be run on, and what action to take in
case a running adapter or process engine fails. The deployment configuration also
stores any monitoring conditions you wish to place on a machine.
You can have only one deployment configuration per project, but the
configuration can describe any number of machines and components to run.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the deployment
within TIBCO Designer and the TIBCO Administrator
GUI.
Description Short description of the deployment.
Variables button Allows you to view and change the global variables
defined for this project.

Machine 3
|
Machine
Once you create a deployment configuration, you can drag and drop machine
resources into the deployment. You can have as many machines as there are in
your TIBCO administration domain. You can only configure one copy of each
machine.
Initially, only the Machine field is shown. Once you select a machine from the
drop-down list and click the Apply button, the other fields on the dialog are
shown.
Configuration
The configuration tab has the following fields. None of these fields are editable.
Field Description
Machine A selection list of the available machines in the
administration domain. You can configure each
machine once.
Note: Once a machine is configured, you can change
the configuration, but you can add a machine to the
deployment only once.
Machine Name Once a machine is selected, this field displays the

name of the machine.
Description Short description of the machine.
IP Address IP address of the machine.
Operating System Operating system installed on the machine.
OS Version Version of the operating system installed on the

machine.

4
Installed Components
The installed components tab describes the components installed on the machine.
Field Description
Installed Component Name of the installed component. This list contains all
of the TIBCO adapter products and TIBCO
BusinessWorks products installed on the machine.
Version Version of the installed component.

Monitor 5
|
Monitor
The Monitor resource allows you to create conditions for monitoring the
machine’s CPU, disk, and process usage. You access the Monitor resource by
clicking on a Machine resource in the deployment configuration, then click on the
"Monitor" tab above the palette panel. You can then drag and drop monitors into
the machine resource.
Once you drag and drop a monitor into a machine, you must choose what type of
monitor it is: CPU, Disk, or Process. Each type of monitor has its own tab for
specifying the condition to monitor. For example, in a CPU monitor, you can
specify a condition of the machine’s CPU usage is over 80%.
You can create more than one monitor of each type. Each monitor you create will
monitor for the specified condition, and the actions placed within the monitor are
taken when the condition is reached. You can double click on a Monitor resource
in the design panel to open it, and then you can place any of the following actions
to take into the monitor:
• Alert — send an alert to the administration server.
• Email — send an email to a user or list of users.
• Custom — execute an operating system command or script.
Example
You may have the following rules in your organization:
• If the CPU usage goes above 80%, send an email to the operations supervisor
and an alert to the administration server.
• If the CPU usage goes above 98%, reboot the machine.
• If the disk usage goes above 85%, execute a script that writes a form for
ordering more disks and send an email to the operations supervisor.
• If there are more than 75 processes on the machine, execute commands to kill
some of the running processes.
To implement those rules, follow this procedure:
1. Select the machine on which to implement the rules within a deployment
configuration in the project panel.
2. Click on the Monitor tab and drag a Monitor resource from the palette panel
to the design panel.
3. In the Monitoring Type field, select CPU.

6
4. Click the Apply button.

5. Click the CPU tab.
6. In the Processor field, type the number of the processor that you wish to apply
the rule to. Processors are numbered starting at zero. Use the default value of
zero if your machine has only one processor.
7. In the CPU Usage field, use the drop down list to select the greater than sign
(>), then type the number 80 in the percentage field.
8. Double click on the Monitor resource in the design panel. The action resources
should appear in the palette panel.
9. Drag and drop the Email resource into the design panel.
10. Specify the fields of the Email resource. See Email on page 28 for more
information on the Email resource.
11. Drag and drop the Alert resource into the design panel.
12. Specify the fields of the Alert resource. See Alert on page 26 for more
information on the Email resource.
13. Click on the machine within the deployment configuration in the project
panel, and drag and drop another monitor.
14. Repeat steps 3 to 10 for the other three conditions you wish to monitor.
Configuration
Field Description
Monitoring Type The type of the monitor. The monitor can be one of the
following types, each type corresponds to an aspect of
the machine you wish to monitor:
• CPU
• Disk
• Process
Name The name to appear as the label for the monitor.
Description Short description of the monitor.

Monitor 7
|
CPU
The CPU tab is available for monitors of type CPU and has the following fields.
Field Description
Processor The numeric identifier of the processor on the
machine you wish to monitor. For machines with
multiple CPUs, the first processor is zero, and
subsequent processors are numbered sequentially.
CPU Usage The condition you wish to monitor. You can specify
either equal to, not equal to, greater than, greater than
or equal to, less than, or less than or equal to as the
condition. You then must specify a percentage value
for the CPU usage.
For example, you can specify greater than 95%, which
means the actions specified for the monitor will be
taken when the CPU usage is greater than 95%.
Disk
The Disk tab is available for monitors of type Disk and has the following fields.
Field Description
Logical Disk The numeric identifier of the disk on the machine you
wish to monitor. For machines with multiple disks,
the first disk is zero, and subsequent disks are
numbered sequentially.
Disk Usage The condition you wish to monitor. You can specify
condition. You then must specify a percentage value
for the disk usage.
For example, you can specify greater than 95%, which
taken when the disk usage is greater than 95%.

8
Process
The Process tab is available for monitors of type Process and has the following
fields.
Field Description
Process Count The condition you wish to monitor. You can specify
condition. You then must specify the limiting number
for the total number of processes executing on the
machine.
Note that this number does not refer to TIBCO
BusinessWorks processes but to machine processes.
For example, you can specify greater than 128, which
taken when the number of processes executing on the
machine is greater than 128.

Process Engine 9
|
Process Engine
Within a machine resource in a deployment configuration, you can place one or

more process engines. The Process Engine resource allows you to configure your
process engine.
Process engines create process instances that execute process definitions created
with TIBCO Designer. See TIBCO BusinessWorks Process Design Guide for more
information about process engines and process instances.
Configuration
The Configuration tab has the following fields.
Field Description
Name The name of the process engine. Give a unique name to each
process engine in your deployment configuration.
Description Short description of the process engine.
Run as NT Specifies that the process engine should be run as a

Service Windows Service. You can then manage the engine as you
would any other service, and you can specify that it starts
automatically when the machine reboots.
Start on reboot Specifies that the process engine should be started

whenever the machine restarts.
TIBCO User ID under which the process engine should run on the
Username machine.
This user must have been defined in the TIBCO
Administrator user management module and have
appropriate privileges. See TIBCO BusinessWorks
Administrator’s Guide for more information.
TIBCO Password for the specified user ID.

Password
Note: If no username and password are assigned, no one
can start this process engine.
Fault Tolerant Specifies that this process engine is to participate in a fault

tolerant group. See TIBCO BusinessWorks Process Design
Guide for more information about configuring fault-tolerant
process engines.

10
Field Description
Is Master Specifies whether the process engine is the master or a
(Secondary if secondary engine in the fault-tolerant group. There can be
Unchecked) only one master process engine in a fault-tolerant group.
Master Engine When the FT Configuration field specifies this is a

Reference secondary engine, this field specifies the master engine for
the group.
Copy Values When the FT Configuration field specifies this is a

from Master secondary engine, this field specifies that field values for all
Configuration tabs should be copied from the master engine for this
fault-tolerant group. You can change the configuration of
the secondary engine after this field is enabled.
View Command Allows you to view the command that will be used to start
Button the process engine. This command is view-only and not
available for editing.
Process Definitions
The Process Definitions tab contains a list of the process definitions that this
engine will load. By default, the "Select All" checkbox is checked, and all process
definitions are loaded.
To load a specific process model or set of models, uncheck the "Select All"
checkbox and use the Browse Resources button at the top of the tab. When
specific process definitions are loaded, the engine can then only create process
instances of the specified process definitions.
Only process models with process starters can be loaded. All subprocesses called
by the loaded process are automatically loaded. See TIBCO BusinessWorks Process
Design Guide for more information about process starters and subprocesses.
You can also modify or delete any loaded process models with the Modify and
Delete buttons.
The process definitions tab is a table of process models. The table has the
following column.
Column Description
Enabled Enables the process definition upon startup.
Process Definitions The name of the process definition to load.

Process Engine 11
|
Column Description
Process Starter The name of the process starter for the process
definition.
Max Jobs The number of process instances for this process

starter that can be in memory concurrently. When the
threshold is reached, the data for new or paused
process instances is paged out and will not consume
memory resources.
This limits the amount of memory resources
consumed, but not the number of seemingly active
processes.
If you wish to specify that there should be an
unlimited number of process instances in memory,
specify 0 in this field. This can increase performance
slightly because the check for the maximum number
of process instances is not performed when a new
process instances is created.
See TIBCO BusinessWorks Process Design Guide for
more information about controlling process instance
execution.
Activation Limit Specifies that process instances should remain in

memory until they are completed. Normally, process
sentences are paged out if they are waiting for
incoming events. Checking this option keeps the
process instance active and in memory until it reaches
its End activity.
more information about controlling process instance
execution.

12
Recovery
The Recovery tab has the following fields.
Field Description
Reset Failure Count Specifies how many failures occur before the failure
count is reset to zero.
You can specify actions to perform on the first, second,
subsequent (any after the second), or any (all) failures.
Setting this field allows you to reset the failure count
to zero after a specified number of failures. For
example, after the fifth failure, you may wish to return
to the actions performed for the first failure.
See Any Failure on page 20 and Component failure
event on page 21 for more information about
specifying actions to perform upon failure.
Reset Failure Interval Specifies the time (in seconds or minutes) to elapse
before the failure count is reset to zero.
For example, you may wish to set the failure count to
zero each day, so that the first failure of the day causes
one set of actions to be performed, and any
subsequent failures result in a different set of actions.
Advanced
The Advanced tab has the following fields.
Field Description
Thread Count This specifies the number of active threads to use for
executing process instances. The number of threads
effectively limits the number of process instances
that can be executing concurrently.
Set this to a value that is appropriate for your
operating system and your physical machine
configuration.
Default is 8.
Verbose Trace on Specifies that detailed tracing messages should be

Startup given when the engine starts.

Process Engine 13
|
Field Description
Max Log Files Specifies the maximum number of log files to use.
When log files reach the size specified in the Max
Log File Size field, the engine switches to the next
log file. When the maximum number of log files
have been written, the engine begins writing to the
first log file again.
Max Log File Size (KB) Specifies the maximum size (in Kilobytes) a log file
can reach before the engine switches to the next log
file.
Use Database for When checked, this field specifies that process
Storage (File if engine information (for example, checkpoint data
Unchecked) and other configuration information) should be
stored in a database. If this field is unchecked, the
process engine stores the information in files.
Checking this field allows the information to be
shared among all process engines that specify the
same JDBC Connection. There are several
advantages to using a database for process engine
storage. See TIBCO BusinessWorks Process Design
Guide for more information about specifying process
engine storage.
Select a JDBC Specifies a JDBC Connection shared configuration

Configuration resource to use for writing process engine
information to a database. This field is only
available when the Use Database for Storage field is
checked.
Java
The Java tab has the following fields.
Field Description
Extra ClassPath The items you supply here are prepended to your
CLASSPATH environment variable. You may specify
a Java code editor, or the jar file from a JNDI provider
if you wish to use TIBCO BusinessWorks to receive
and process JMS messages.

14
Field Description
Initial JVM Size Initial size for the JVM used for the process engine.
Default is 32 MB.
Maximum JVM Size Maximum size for the JVM used for the process
engine. Default is 128 MB.
Thread Stack Size Size for the thread stack. Default is 128 KB.
Custom
The Custom tab allows you to specify custom properties for the process engine.
These properties are used in specific circumstances, and only under the direction
of TIBCO Support. Do not attempt to add or modify custom properties unless
specifically told to do so by TIBCO Support.

Process Engine 15
|
Fault Tolerance
The Fault Tolerance tab allows you to specify the fault-tolerance characteristics of
the process engine.
Field Description
Member Weight of Specifies the setting for the member weight of this
Master/Secondary as a: process engine. The possible values are:
• Peer — specifies a constant weight for all
engines. If all engines are specified as peers, a
random secondary is selected in the event of a
failure. Also, when a peer takes over during
failover, the peer becomes the master until it
experiences a failure.
• Primary — only available for the master engine.
Specifies the weight of the master.
• Secondary — specifies this secondary engine as
a lower weight than the engines specified as
"peer". Secondary engines resume operation
during a failover until the master engine is once
again available. Once the master engine is
available, the secondary engine shuts down and
the master engine starts up.
• Custom — signifies that you want to specify a
custom value in the Member Weight field. The
Member Weight field is only available when the
Advanced field is checked.
Advanced Checking the checkbox in this field enables the

Advanced fault tolerant configuration options
(listed below). In most circumstances, these
advanced options should not be changed from the
default.
Heartbeat Interval (ms) The master engine of a fault-tolerant group

broadcasts heartbeat messages to inform the other
group members that it is still active. The heartbeat
interval determines the time (in milliseconds)
between heartbeat messages.

16
Field Description
Activation Interval (ms) Secondary process engines track heartbeat
messages from the master engine. This field
specifies the amount of time since the last heartbeat
from the master that before the secondary restarts
the process starters and process instances.
Activation Delay (ms) When a master engine resumes operation, the

secondary engine shuts down and returns to
standby mode. For some situations, it may be
necessary to ensure that the secondary engine has
completely shut down before the master engine
resumes operation.
This field allows you to specify a delay before the
master engine restarts.
Member Weight The weight of the member. The engine with the
highest weight is the master engine. You can only
edit this field if you specify Custom in the first field
on this tab.

Adapter 17
|
Adapter
You can use the Adapter resource inside the Machine resource to specify that one
or more adapters should run on that machine, and configure the adapter
instance(s).
Adapter instances are operating system processes that execute pre-configured
adapter services. See your adapter documentation for more information about
configuring adapter services and runtime adapter instances.
Configuration
Field Description
Name The name of the adapter instance.
Description Short description of the adapter instance.
Adapter Type The type of adapter instance to create. This is a

drop-down list of the available adapter components
installed on the machine.
Adapter The adapter configuration to load when starting the

Configuration adapter instance. This is a drop-down list of the
adapter configurations in your project created for the
specified adapter.
See your adapter documentation for more information
about creating adapter configurations.
Start on reboot Specifies that the adapter should be started whenever

the machine restarts.
Run as NT Service Specifies that the adapter should be run as a Windows

Service. You can then manage the adapter as you
would any other service, and you can specify that it
starts automatically when the machine reboots.

18
Field Description
User ID User ID under which the process engine should run
on the machine.
This user must have been defined by way of the
TIBCO Administrator user management module have
appropriate privileges. See TIBCO BusinessWorks
Administrator’s Guide for more information about
creating and managing users.
Password Password for the specified user ID.

NOTE: If no user name and password are defined for
this adapter, noone can start the adapter from TIBCO
Administrator.
View Command Allows you to view the command that will be used to
start the process engine. This command is view-only
and not available for editing.
Recovery
The recovery tab has the following fields.
Field Description
Reset Failure Count Specifies how many failures occur before the failure
count is reset to zero.
You can specify actions to perform on the first, second,
subsequent (any after the second), or any (all) failures.
Setting this field allows you to reset the failure count
to zero after a specified number of failures. For
example, after the fifth failure, you may wish to return
to the actions performed for the first failure.
See Any Failure on page 20 and Component failure
event on page 21 for more information about
specifying actions to perform upon failure.

Adapter 19
|
Field Description
Reset Failure Interval Specifies the time (in seconds or minutes) to elapse
before the failure count is reset to zero.
For example, you may wish to set the failure count to
zero each day, so that the first failure of the day causes
one set of actions to be performed, and any
subsequent failures have a different set of actions.
Custom
The custom tab allows you to specify custom properties for the adapter. See the
adapter manual for more information about properties you can add on the
custom tab.

20
Any Failure
Within a process engine or adapter resource in a deployment configuration, there

is an Any Failure resource. This resource specifies the action to take when the
process engine or adapter instance fails. The specified actions are performed for
every failure of the process engine or adapter instance.
You specify the actions to take by dragging and dropping one of the following
actions into the Any Failure resource. The Any Failure resource is like a folder,
because it can hold multiple actions.
• Restart — Restart the process engine or adapter instance.
• Alert — Send an alert to the administration server.
• Email — Send an email to a specified user.
• Custom — Perform an operating system command.
The Restart action is specified by default within the Any Failure resource. You can
delete that action, if you do not wish to restart the process engine or adapter
automatically after every failure.
Configuration
Field Description
Name The name to appear as the label for the failure
resource.
Description Short description of the failure resource.

Component failure event 21
|
Component failure event

is a Component failure event resource. This resource specifies the action to take
when the process engine or adapter instance fails.
Dragging and dropping the Component failure event resource into the process
engine or adapter instance resource causes the configuration tab to display one
field, the Failure Type field. You must then select one of the following failure
types for this resource:
• First Failure
• Second Failure
• Subsequent Failure
Once the failure type is selected, you can specify the description of the
Component failure event resource and drag and drop recovery actions to perform
in the event of a failure. The specified actions are performed when the failure type
occurs. That is, the first time the process engine or adapter instance fails, the
actions specified in the First Failure resource are performed. The second time the
process engine or adapter fails, the actions specified in the Second Failure
resource are performed. Any time after the second failure, the actions in the
Subsequent Failure resource are performed.
The first, second, and subsequent failures are determined by the options set on
the Recovery tab of the Process Engine or Adapter resources. The options on this
tab specify when the recovery count is reset to zero. You can reset the recovery
count after a certain number of failures or after a certain amount of time. See
Process Engine on page 9 or Adapter on page 17 for more information about
resetting the failure count.
Only actual failures are counted by the failure count. Manually stopping and
restarting the process is not considered a failure.
actions into the Component failure event resource. The Component failure event
resource is like a folder, because it can hold multiple actions.
• Restart — Restart the process engine or adapter instance.

22
Configuration
Field Description
Failure Type The type of failure that occurred. This can be one of
the following:
• First Failure
• Second Failure
• Subsequent Failure
You can have only one resource for each type of
failure. Once the failure type is set, the Name and
description fields appear.
Name The name to appear as the label for the Component

failure event resource. This field is fixed, based on the
failure type.
Description Short description of the Component failure event

resource.

Suspend Process Event 23
|
Suspend Process Event
Within a process engine resource in a deployment configuration, there is a

Suspend Process Event resource. This resource specifies the action to take when a
process engine suspends due to a Repeat On Error Until True loop. Process
instances are suspended if the Suspend option is checked on the loop and an
unhandled error continues to occur within the loop. The administrator can specify
what action to take in this event, and also attempt to fix the cause of the problem
before resuming execution of the loop. See TIBCO BusinessWorks Process Design
Guide for more information about Repeat On Error Until True loops and
suspended processes.
actions into the Suspend Process Event resource. The Suspend Process Event
resource is like a folder, because it can hold multiple actions.

24
Log Event

is a Log Event resource. When a line is written to the log of the process engine or
adapter, this resource can check the contents of the line for a specific string and
perform an action if the string is present in the log entry.
You can have more than one Log Event resource within each process engine or
adapter, and each Log Event resource can specify actions to perform when
different strings are found in the log entries. This allows administrators to have
automatic actions take when log entries with a certain content are written. For
example, send an alert when a log entry containing the text "Error" occurs.
actions into the Log Event resource. The Log Event resource is like a folder,
because it can hold multiple actions.
If you are using an Alert as the log event, you can use the variable ${nextLine}
in the Alert’s message field. In this case, ${nextLine} is replaced by the text of a
new line as it is added to the log.
For example, assume you specify a Log Event and use an alert which uses
Log:${nextLine} in the message. If logfile has the following text appended to it:
"Error 1351 - message expired"
then the following LogEvent message will appear in the TIBCO Administrator
GUI:
"Log Error 1351 - message expired"
If you use ${nextLine}, each log event is considered a separate event and is sent
even if Once is selected as the Performance Policy.

Restart 25
|
Restart
The Restart resource specifies that the process engine or adapter instance should
be restarted in the event of a failure.
You can drag and drop this resource into the Any Failure resource or one of the
Component failure event resources within a Process Engine or Adapter in a
deployment configuration. When the specified failure occurs, the machine is
restarted.
Configuration
Field Description
Name The name of the resource. This name is fixed as
"Restart".
Description Short description of the restart resource.

26
Alert
The Alert resource specifies that an alert should be sent to the administration
server.
You can drag and drop this resource into the following resources:
• Any Failure
• Component failure event
• Suspend Process Event
• Log Event
• Monitor
When the condition of the resource occurs (for example, a process instance is
suspended or a Monitor condition is met), the alert is sent and is displayed in the
TIBCO Administrator interface.
Configuration
Field Description
"Alert".
Description Short description of the alert resource.
Perform Policy Frequency of the alert. If you choose Once, the action
is performed only once even if the condition for the
event is met multiple times. If you choose Always,
multiple alerts are sent.
Choosing Always is useful for situations where the
alert does not become visible because the refresh rate
of TIBCO Administrator is 30 seconds.

Alert 27
|
Field Description
Level The alert level of the alert to send. This level appears
in the TIBCO Administrator interface. The level can be
one of the following:
• High
• Medium
• Low
Message The alert message to send to the administration server.

28
Email
The Email resource specifies that an email should be sent to the specified user(s).
• Any Failure
• Log Event
• Monitor
Configuration
Field Description
"Email".
Description Short description of the email resource.
Perform Policy Frequency of the email. If you choose Once, one email
is sent even if the condition for the event is met
multiple times. If you choose Always, multiple emails
are sent.
To A comma-separated list of email addresses to which

you would like to send the message.
Cc A comma-separated list of email addresses to which

you would like to send copies of the message.
Subject The subject of the email message.
Message The text of the email message.
SMTP Server The mail server to use to send the message. You may
specify the host name or the host IP address.

Custom 29
|
Custom
The Custom resource specifies that an operating system command or script

should be executed.
• Any Failure
• Log Event
• Monitor
Configuration
Field Description
"Custom".
Description Short description of the custom resource.
Perform Policy Frequency of the custom action. If you choose Once,

the action is performed only once even if the condition
for the event is met multiple times. If you choose
Always, the command is executed multiple times.
Command The command or script to execute.
Arguments The argument list for the command.

30

| 31
Chapter 2 Process Palette
The Process palette allows you to create process definitions.
Topics
• Process Definition, page 32

32
| Process Palette
Process Definition
The Process Definition resource allows you to define business

processes. Drag and drop the Process Definition resource into the
design panel to create a new process definition.
Select a process definition in the project tree panel to edit a process definition.
When editing process definitions, the palette panel changes to a list of activity
palettes that you can use within a process definition. The activity palettes are
described in subsequent chapters of this manual.
See TIBCO BusinessWorks Process Design Guide for more information about
creating and editing process definitions.
Configuration
Field Description
Name The name to appear as the label for the process.
Description Short description of the process.
Custom Icon File You can chose your own custom icon for the process,
if you desire. Use the Browse button to locate an
image file (GIF, JPEG, and so on) to use as the icon for
this process.

| 33
Chapter 3 ActiveEnterprise Adapter Palette
The ActiveEnterprise Adapter palette contains activities for communicating with

configured TIBCO ActiveEnterprise adapters. This chapter assumes you are
familiar with the concepts and features of TIBCO ActiveEnterprise adapter
products. For more information about configuring adapters, see the
documentation for your adapter product.
You can use these activities to communicate with adapters that are supported by
TIBCO BusinessWorks. See your adapter documentation for information on
whether BusinessWorks is supported.
Topics
• Adapter Request-Response Server, page 34

• Adapter Subscriber, page 36
• Invoke an Adapter Request-Response Service, page 39
• Publish to Adapter, page 42
• Respond to Adapter Request, page 45
• Wait for Adapter Message, page 47
• Wait for Adapter Request, page 52

34
| ActiveEnterprise Adapter Palette
Adapter Request-Response Server
Starts a process based on the receipt of a request from an adapter.

The adapter sends a request by way of a pre-configured
request-response invocation service, and the process that is
started acts as the implementation of the request. The process
sends any required responses back to the adapter’s service.
Adapter request-response invocation services are configured during adapter
configuration, and the activity uses the information in the adapter configuration
to fill in most of the fields of this activity. See your adapter documentation for
more information about creating adapter configurations and creating adapter
services.
Figure 1 illustrates an Adapter Request-Response Server activity starting a
business process to handle an incoming request from an adapter request-response
invocation service. At a later point in the business process, the Respond to
Adapter Request activity is used to perform the response.
Figure 1 An Adapter Request-Response Server activity
Application
Adapter
Request-
Response
Invocation
Service
Request
Business Process
Adapter
Request-
Response
Server

Adapter Request-Response Server 35
|
Configuration
Field Description
Name The name to appear as the label for the activity in the
process definition.
Description Short description of the activity.
Adapter Service The pre-configured adapter request-response

invocation service. You must specify the adapter
service when configuring the adapter.
Use the Browse button to locate the appropriate
service for this activity.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
The advanced tab has the following fields.
Field Description
Client The publisher for the specified Adapter Service.
Session The session for the specified Adapter Service.
Subject The subject for the specified Adapter Service.
Operation Class The class for the specified Adapter Service.
Operations The operation for the specified Adapter Service. You

can select from a list of available operations, if the
operation class has more than one operation.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.

36
Output
The output for the activity is the following.
Output Item Datatype Description

ProcessStarterOutput Object The root class for the output of the
Adapter Request-Response Server
activity. This class contains all
output items for the activity.
body Object The class specified for the client

service of the specified adapter
configuration.
Adapter Subscriber
Starts a process based on the receipt of a message from the

publication service of the specified adapter.
Publication services are configured during adapter configuration,
and the activity uses the information in the adapter configuration
to fill in most of the fields of this activity. See your adapter
documentation for more information about creating adapter configurations and
creating adapter publication services.
Figure 2 illustrates an adapter publishing service publishing a message and the
Adapter Subscriber process starter starting a business process.

Adapter Subscriber 37
|
Figure 2 An Adapter Subscriber activity receiving a message and starting a process
Application
Adapter
Publishing
Service
Publish
Business Process
Adapter
Subscriber
Configuration
Field Description
Name The name to appear as the label for the activity in
the process definition.
Adapter Service The pre-configured adapter publishing service. You

must specify the adapter service when configuring
the adapter.
Advanced

38
Field Description
Publisher The publisher for the specified Adapter Service.
Schema The class for the specified Adapter Service.
RV Session
Output

Adapter Subscriber activity. This
class contains all output items for
the activity.
body Object The class specified for the

publication service of the specified
adapter configuration.

Invoke an Adapter Request-Response Service 39
|
Invoke an Adapter Request-Response Service
The Invoke an Adapter Request-Response Service activity is

used to communicate with an adapter’s request-response
service. This service invokes an operation with input and output
by way of the adapter. Request-response services are configured
during adapter configuration, and the activity uses the
information in the adapter configuration to fill in most of the
fields of this activity. See your adapter documentation for more information about
creating adapter configurations and creating adapter request-response services.
Figure 3 illustrates an Invoke an Adapter Request-Response Service activity
sending a request to an adapter request-response service.
Figure 3 An Invoke an Adapter Request-Response Service activity sending a request
Application
Adapter
Request-
Response
Service
Request
Business Process
Invoke an Adapter
Request-Response
Service
Configuration
Field Description

40
Field Description

Advanced
Field Description
Server The server for the specified Adapter Service.
Operation Class The operation class for the specified Adapter

Service.
Pre-register Listener When using TIBCO Rendezvous Certified

Messaging (RVCM), this field specifies the
cmname(s) of the RVCM subscriber(s). This allows
the publisher to pre-register with any expected
listeners. If multiple cmnames are specified,
separate each cmname with a comma.
See the TIBCO Rendezvous documentation for more
information about RVCM.


Invoke an Adapter Request-Response Service 41
|
RV Session
Input
mapping and transforming input data.
The input for the activity is the following.
Input Item Datatype Description

aeRequestInputType Object The root class for the input of the
Invoke an Adapter
Request-Response Service activity.
This class contains all input items
for the activity.
subject string The subject to send the request on.

The default subject is displayed on
the advanced tab, but you can
override the default by supplying a
subject here.
requestTimeout integer The time to wait for the

synchronous request-reply
operation to complete. An error is
returned if the operation does not
complete within this time limit.
body Object The input parameters for the

specified operation. The input
parameters are defined by the
operation class for the specified
Adapter Service for this activity.

42
Output

aerequestOutputType Object The root class for the output of the
Invoke an Adapter
Request-Response Service activity.
This class contains all output items
for the activity.
body Object The reply schema for the specified

operation. The reply schema is
defined by the operation class for
the specified Adapter Service for
this activity.
Publish to Adapter
The Publish to Adapter activity publishes a message that can be

received by an adapter’s subscription service. Subscription
services are configured during adapter configuration, and the
activity uses the information in the adapter configuration to fill in
most of the fields of this activity. See your adapter documentation for more
information about creating adapter configurations and creating adapter
subscription services.
Figure 4 illustrates a Publish to Adapter activity sending a message to a
pre-configured adapter subscription service.

Publish to Adapter 43
|
Figure 4 A Publish to Adapter activity sending a message
Application
Adapter
Subscription
Service
Publish
Business Process
Publish to
Adapter
Configuration
Field Description
process definition.
Adapter Service The pre-configured adapter subscription service.

You must specify the adapter service when
configuring the adapter.

44
Advanced
Field Description
Subscriber The subscriber for the specified Adapter Service.
Pre-register Listener When using TIBCO Rendezvous Certified

Messaging (RVCM), this field specifies the
cmname(s) of the RVCM subscriber(s). This allows
the publisher to pre-register with any expected
listeners. If multiple cmnames are specified,
separate each cmname with a comma.
RV Session
Input

Respond to Adapter Request 45
|

aePubInputType Object The root class for the input of the
Publish to Adapter activity. This
class contains all input items for the
activity.
subject string The subject to send the request on.

The default subject is displayed on
the advanced tab, but you can
override the default by supplying a
subject here.
replySubject string The subject that replies to this

message should be sent to.
body Object The schema definition for the

specified adapter service. This can
be overridden by specifying a
different schema on the Advanced
tab.
Output
This activity produces no output.
Respond to Adapter Request
The Respond to Adapter Request activity is used to send a

response to an adapter for a previously received request. For
example, you may have a Wait for Adapter Request activity
within a process definition. The incoming adapter request may
require a response from your process. The Respond to Adapter
Request is used to send that response.
Figure 5 illustrates a Respond to Adapter Request activity sending a response to a
previously received request from an adapter.

46
Figure 5 A Respond to Adapter Request sending a response
Application
Adapter
Request-
Response
Invocation
Service
Reply
Business Process
Respond to Adapter
Request
Configuration
Field Description
process definition.
Reply For Drop-down list of activities that this activity can send
a response for.
Input

Wait for Adapter Message 47
|

aerequestOutputType Object The root class for the input of the
Respond to Adapter Request
activity. This class contains all input
items for the activity.
body Object The schema definition for the

response. This is taken from the
adapter service of the activity this is
a response for.
Output
Wait for Adapter Message
Waits for the receipt of a message from the publication service of the
specified adapter.
Publication services are configured during adapter configuration,
and the activity uses the information in the adapter configuration to
fill in most of the fields of this activity. See your adapter
documentation for more information about creating adapter configurations and
creating adapter publication services.
Figure 6 illustrates an adapter publishing service publishing a message and the
Wait for Adapter Message activity receiving the message within a business
process.

48
Figure 6 A Publish to Adapter activity sending a message
Application
Adapter
Publishing
Service
Publish
Business Process
Wait for
Adapter
Message
Configuration
Field Description
Adapter Service The pre-configured adapter publishing service. You

must specify the adapter service when configuring
the adapter.

|
Advanced
Field Description
Publisher The publisher for the specified Adapter Service.
RV Session

50
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming
message. This expression should evaluate to a string
and it is compared to the "key" field of the activity’s
input. If the Candidate Event Key and the activity’s
key match, then the process accepts the incoming
message.
For example, you may have a Publish to Adapter
activity that sends a message with a particular ID.
You are expecting a reply message that contains that
same ID so that you can determine the message is a
response to your sent message. You would specify
the field of the incoming message that contains your
ID in the Candidate Event Key. You would then use
the message ID of the message you sent earlier in the
process as the "key" field in the input.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
Event Timeout (msec) A message may arrive before this activity is

executed. This field specifies the amount of time (in
milliseconds) a message will wait if it is received
before this activity is reached. If the event timeout
expires, an error is logged and the event is
discarded.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For Adapter Message activity proceeds.

|
Input

input Object The root class for the input of the
Wait for Adapter Message activity.
for the activity.
key string The value that is compared to the

Candidate Event Key field of the
Event tab to determine if this
message applies to this process. See
Event on page 50 for an example of
using the Candidate Event Key
field with the key input item.
timeout integer The time (in milliseconds) to wait

for the incoming message. An error
is returned if the message is not
received within this time limit.
Output

Adapter Subscriber activity. This
the activity.
body Object The class specified for the

publication service of the specified
adapter configuration.

52
Wait for Adapter Request
Waits for the receipt of a request from an adapter request-response

invocation service. The adapter sends a request by way of a
pre-configured service, and the process definition acts as the
implementation of the request. The process sends any required
responses back to the adapter’s service by placing the Respond to
Adapter Request activity at a later point in the process definition.
Adapter request-response invocation services are configured during adapter
configuration, and the activity uses the information in the adapter configuration
to fill in most of the fields of this activity. See your adapter documentation for
more information about creating adapter configurations and creating adapter
services.
Figure 7 illustrates a Wait for Adapter Request activity waiting for a request from
an adapter request-response invocation service. At a later point in the business
process, a Respond to Adapter Request activity sends the response.
Figure 7 A Wait for Adapter Request activity
Application
Adapter
Request-
Response
Invocation
Service
Request
Business Process
Wait for
Adapter
Request

Wait for Adapter Request 53
|
Configuration
Field Description

Advanced
Field Description
Client The server for the specified Adapter Service.
Operation Class The operation class for the specified Adapter

Service.

RV Session

54
Event
Field Description
message.
For example, you may have a Invoke an Adapter
Request-Response activity that sends a request with
a particular ID. You are expecting a response
message that contains that same ID so that you can
determine the message is a response to your sent
message. You would specify the field of the
incoming reply that contains your ID in the
Candidate Event Key. You would then use the
message ID of the request you sent earlier in the
process as the "key" field in the input.
expressions.

expires, an error is logged and the event is discarded
the Input tab, the Wait For Adapter Request activity proceeds.

Wait for Adapter Request 55
|
Input

Wait for Adapter Request activity.
for the activity.


Output

Wait for Adapter Request activity.
for the activity.
body Object The class specified for the client

service of the specified adapter
configuration.

56

| 57
Chapter 4 BusinessConnect Palette
The BusinessConnect palette contains activities for creating a private process that
interacts with a TIBCO BusinessConnect server. This chapter assumes that you are
familiar with the concepts and features of TIBCO BusinessConnect. See the
TIBCO BusinessConnect documentation for more information.
Topics
• Overview of TIBCO BusinessConnect Activities, page 58

• Receive Misc Msg, page 59
• Receive Request/Notification, page 60
• Receive Response, page 62
• Send Misc Msg, page 63
• Send Request/Notification, page 64
• Send Response, page 65

58
| BusinessConnect Palette
Overview of TIBCO BusinessConnect Activities
Using TIBCO BusinessWorks, you can create process definitions that serve as
private processes for a TIBCO BusinessConnect installation. TIBCO
BusinessWorks can either send requests by way of a TIBCO BusinessConnect
server, or receive replies from a TIBCO BusinessConnect server. Figure 8
illustrates TIBCO BusinessWorks operating in conjunction with TIBCO
BusinessConnect.
Figure 8 TIBCO BusinessWorks communicating with TIBCO BusinessConnect
Company A
Private Process
Outbound Request
TIBCO BusinessWorks
Send Request- TIBCO

Response/ BusinessConnect
Notification
Internet
Company B
Private Process
Inbound Request
TIBCO BusinessWorks
Receive Request/
Notification
TIBCO
Legend BusinessConnect
Request Send Response
Reply
In Figure 8, Company A implements a private process in TIBCO BusinessWorks

and uses the Send Request/Notification activity to invoke a pre-configured
operation on a TIBCO BusinessConnect server. TIBCO BusinessConnect sends the
request to the correct partner and it’s received by a TIBCO BusinessConnect
server at Company B. TIBCO BusinessWorks has a process definition with the

Receive Misc Msg 59
|
Receive Request/Notification process starter. This process definition receives the

incoming request, processes it, and sends a response back to the TIBCO
BusinessConnect server using the Send Response activity. TIBCO
BusinessConnect then routes the reply back to the original requestor.
It is not necessary for TIBCO BusinessWorks to be used to implement the private
process at both Company A and Company B. A different application can be used
to send the request or receive the request. It is however, necessary for TIBCO
BusinessConnect to be used at any site where TIBCO BusinessWorks is used to
send or receive TIBCO BusinessConnect messages.
See the TIBCO BusinessConnect documentation for more information about using
TIBCO BusinessConnect to implement integrated business-to-business
communication.
Receive Misc Msg
Any message that is not an inbound or outbound request is a

miscellaneous message. Each protocol supported by TIBCO
BusinessConnect has different types of miscellaneous messages.
For example, the tibXML protocol has Error and Response
Acknowledgement messages. The Receive Misc Msg process starter is used to
start a process when a miscellaneous message is received from TIBCO
BusinessConnect.
Not all TIBCO BusinessConnect protocols have miscellaneous messages. This
process starter requires a BusinessConnect Connection shared configuration
resource that is configured for a specific protocol. If there are no miscellaneous
messages for the specified protocol, the Receive Misc Msg process starter cannot
be used for that protocol.
See Overview of TIBCO BusinessConnect Activities on page 58 for more
information about using TIBCO BusinessWorks activities with TIBCO
BusinessConnect. See the TIBCO BusinessConnect documentation for more
information about using TIBCO BusinessConnect.

60
Configuration
Field Description
Server Details The BusinessConnect Connection shared

configuration resource used to connect to the TIBCO
BusinessConnect server. See BusinessConnect
Connection on page 302 for more information.
Message Name A drop-down list of miscellaneous message types

available for the protocol of the specified
BusinessConnect Connection shared configuration
resource.
Input
This activity requires no input.
Output
The output tab lists output schema information. The schema that displays is
based on the input of the message selected in the Configuration tab for this
process starter.
Receive Request/Notification
The Receive Request/Notification process starter can be used to do

the following:
•Process an incoming synchronous request/reply message
forwarded by the TIBCO BusinessConnect server.
•Process an incoming notify message forwarded by the TIBCO
BusinessConnect server.

Receive Request/Notification 61
|

Configuration
Field Description

Operation Name A drop-down list of pre-configured operations that

are available for the protocol associated with the
server configuration.
Input
Output
based on the input of the operation selected in the Configuration tab for this
activity.

62
Receive Response
The Receive Response activity is used to receive a response to a

previously sent request from the Send Request/Notification
activity.
See Overview of TIBCO BusinessConnect Activities on page 58 for
more information about using TIBCO BusinessWorks activities with TIBCO
Configuration
Field Description


Input
The input tab lists input schema information. The schema that displays is based
on the input of the operation selected in the Configuration tab for this activity.
Output
based on the output of the operation selected in the Configuration tab for this
activity.

Send Misc Msg 63
|
Send Misc Msg
Any message that is not an inbound or outbound request is a

miscellaneous message. Each protocol supported by TIBCO
BusinessConnect has different types of miscellaneous messages. For
example, the tibXML protocol has Error and Response Acknowledgement
messages. The Send Misc Msg activity is used to send a miscellaneous message to
TIBCO BusinessConnect.
Not all TIBCO BusinessConnect protocols have miscellaneous messages. This
activity requires a BusinessConnect Connection shared configuration resource
that is configured for a specific protocol. If there are no miscellaneous messages
for the specified protocol, the Send Misc Msg activity cannot be used for that
protocol.
Configuration
Field Description

Message Name A drop-down list of miscellaneous message types

available for the protocol of the specified
BusinessConnect Connection shared configuration
resource.

64
Input
on the input of the miscellaneous message selected in the Configuration tab for
this activity.
Output
based on the input of the message selected in the Configuration tab for this
activity.
Send Request/Notification
The Send Request/Notification activity can be used to do the

following:
•Send an outgoing asynchronous request/reply message to the
TIBCO BusinessConnect server.
•Send an outgoing notify message to the TIBCO BusinessConnect
server.
You can receive the response to the request in a different process instance by using
the Receive Response process starter.
Configuration
Field Description

Send Response 65
|
Field Description

Wait for Response Specifies that the activity should wait for a response
from the TIBCO BusinessConnect server.
Response Wait Time Specifies the amount of time to wait for a response
from the TIBCO BusinessConnect server. This field
only appears when the Wait for Response field is
checked.
Input
Output
The output tab lists output schema information. This is used only for a
synchronous request/reply operation. The schema that displays is based on the
output of the operation selected in the Configuration tab for this activity.
Send Response
The Send Response activity sends an outgoing asynchronous notify

message to the local TIBCO BusinessConnect server.
See Overview of TIBCO BusinessConnect Activities on page 58 for
more information about using TIBCO BusinessWorks activities with
TIBCO BusinessConnect. See the TIBCO BusinessConnect documentation for
more information about using TIBCO BusinessConnect.

66
Configuration
Field Description
Request Name A drop-down list of Receive Request/Notification

operations and custom requests. If you choose a
non-custom request, the Server Details and
Operation Name fields are filled automatically.
If you choose <Custom Request>, you must set the
values for the Server Details and Operation Name
fields.


Input
Output

| 67
Chapter 5 FTP Palette
The FTP palette is used to issue FTP commands.
Topics
• FTP Get, page 68

• FTP Put, page 71

68
| FTP Palette
FTP Get
The FTP Get activity issues an FTP get command to the specified server.
The file content is retrieved into a process variable, but you can write the
file to the local disk as well by checking the Write Data to Local File field
on the Configuration tab.
The following sections describe the fields on the tabs of the FTP Get activity.
Configuration
Field Description
process definition.
FTP Shared Path to the shared configuration resource containing

Connection the user information such as host name, user name,
and password. See FTP Connection on page 308 for
more information about FTP resources.
Write Data to Local Specifies that you would like to write contents of the
File file retrieved from the FTP server to a file on the local
disk.
Binary Specifies whether the FTP command should be sent

using binary data or text data (checked signifies
binary).
Timeout (msec) Time to wait (in milliseconds) for the FTP command
to complete. An error is returned if the command
does not finish before the specified time.
The default timeout is 120000 (two minutes). The
maximum time you can specify for the timeout is
3600000 (1 hour).

FTP Get 69
|
Field Description
Firewall Indicates whether the FTP server resides inside or
outside of a firewall relative to the location of the
TIBCO BusinessWorks process engine. If checked, the
FTP server resides outside a firewall, and therefore
the Proxy fields must be specified.
Proxy Host IP address of the proxy server to access external FTP

servers.
Proxy Port Port number of the proxy server used to access

external FTP servers.
If no value is specified, the default value 8080 is used.
Input

FTP_INPUT Object The root class for the input of the
FTP Get activity. This class contains
all input items for the activity.
RemoteFilename string The path and name of the file to

retrieve on the remote server.
Wildcards are not permitted within
this field.
LocalFileName string This input item is available only if

the Write Data to Local File field on
the Configuration tab is enabled.
This input item specifies the name
and path of the local file where the
contents of the retrieved file should
be written.
Host string The name of the FTP server. This

overrides the value specified on the
FTP Connection.

70
| FTP Palette

Port integer Port number for incoming FTP
requests on the FTP server. This
overrides the value specified on the
FTP Connection.
UserName string Username to use to log into the FTP

server. This overrides the value
specified on the FTP Connection.
Password string Password to use to log into the FTP

server. This overrides the value
specified on the FTP Connection.
Encoding string When the retrieved file is not

binary, this specifies the character
encoding of the retrieved file. This
also specifies the encoding to use
when writing the retrieved file to a
file on the local disk, if that
configuration option is specified.
Output

FTP_GET_OUTPUT Object The root class for the output of the
FTP Get activity. This class contains
all output items for the activity.
Success boolean True or false depending upon

whether the FTP get command
was successfully executed by the
FTP server.
Errormsg string Any error messages returned from

the FTP server.

FTP Put 71
|

BinaryData binary The binary data of the file returned
from the remote FTP server, if
Binary field is checked on the
Configuration tab.
You can use the value of this item
later in the process definition, if
desired.
ASCIIData string The ASCII data of the file returned

from the remote FTP server, if
Binary field is not checked on the
Configuration tab.
You can use the value of this item
later in the process definition, if
desired.
FTP Put
The FTP Put activity issues an FTP put command to the specified server.
The content of the file to put onto the remote server can be either read
from a file on the local disk or it can be supplied in a process variable
and mapped to the BinaryData or ASCIIData input items for this
activity.
The following sections describe the fields on the tabs of the FTP Put activity.
Configuration
Field Description
process definition.

72
| FTP Palette
Field Description
FTP Shared Path to the shared configuration resource containing
Connection the user information such as host name, user name,
and password. See FTP Connection on page 308 for
more information about FTP resources.
Binary Specifies whether the FTP command should be sent

using binary data or text data (checked signifies
binary).
Timeout (msec) Time to wait (in milliseconds) for the FTP command
to complete. An error is returned if the command
does not finish before the specified time.
The default timeout is 120000 (two minutes). The
maximum time you can specify for the timeout is
3600000 (1 hour).
Append Specifies whether to append data to an existing file. If

the specified file exists on the FTP server, append the
data to the file when this field is checked. If this file is
not checked, the file is overwritten if it exists on the
FTP server.
Get Data from Disk Specifies that you will supply the path and name of a
file on the local disk to use in the FTP Put command.
If no local file is specified, you can supply the file’s
data to the ASCIIData or BinaryData input items.
Firewall Indicates whether the FTP server resides inside or

outside of a firewall relative to the location of the
TIBCO BusinessWorks workflow engine. If checked,
the FTP server resides outside a firewall, and
therefore the Proxy fields must be specified.
Proxy Host IP address of the proxy server to access external FTP

servers.
Proxy Port Port number of the proxy server used to access

external FTP servers.
If no value is specified, the default value 8080 is used.

FTP Put 73
|
Input

FTP_INPUT Object The root class for the input of the
FTP Put activity. This class contains
all input items for the activity.
RemoteFilename string The path and name of the file to

place onto the remote server.
this field.
LocalFilename string The path and name of the local file

to use in the FTP Put command.
This item is only available if the Get
Data from Disk field is enabled.
BinaryData binary The binary contents of the file to be

transferred to the FTP server, if
Binary field is checked on the
Configuration tab.
You must map one or more process
variables to this input item. The
most common way to get the data
for the remote file is to read a local
file using the Read File activity, but
you can map other data to this
input item as well.

74
| FTP Palette

ASCIIData string The ASCII contents of the file to be
transferred to the FTP server, if
Binary field is not checked on the
Configuration tab.
You must map one or more process
variables to this input item. The
most common way to get the data
for the remote file is to read a local
file using the Read File activity, but
you can map other data to this
input item as well.
Output

FTP_PUT_OUTPUT Object The root class for the output of the
FTP Put activity. This class contains
Success boolean True or false depending upon

whether the FTP put command
was successfully executed by the
FTP server.
Errormsg string Any error messages returned from

the FTP server.

| 75
Chapter 6 File Palette
The file palette is used to read, write, delete, or create files. This palette also has a
process starter that allows you to poll for files and start a process based on the
presence of a file.
Topics
• Create File, page 76

• File Poller, page 77
• Read File, page 80
• Remove File, page 82
• Wait for File Change, page 84
• Write File, page 89

76
| File Palette
Create File
The Create File activity creates a new file with the specified file name
and contents. The following sections describe the fields on the tabs of
the Create File activity.
Configuration
Field Description
process definition.
Overwrite Overwrite existing file with the same name, if one

exists.
Input

CreateActivityInputClass Object The root class for the input of the
Create File activity. This class
contains all input items for the
activity.
fileName string The path and name of the file to

create.

File Poller 77
|
Output

CreateActivityOutputClass Object The root class for the output of the
File Poller activity. This class
contains all output items for the
activity.
fileInfo Object Object containing the fileName,

location, type, readProtected,
writeProtected, and size data.
fullName string The name of the file, including the

path information.
fileName string The name of the file without the

path information.
location string The path to the file.
type string Whether the created file is a file or

a directory.
readProtected boolean Whether the file is protected from

reading.
writeProtected boolean Whether the file is protected from

writing.
size integer Size of the file (in bytes).
File Poller
The File Poller process starter polls for files or directories with the given
name and starts a process when a change (creation, modification,
deletion) is detected.

78
| File Palette
Configuration
Field Description
process definition.
File Name The path and name of the file or directory to monitor.
Use the Browse button to locate an existing file.
You can also use wildcards to monitor a directory for
files that match the given specification. For example,
"C:\files\*.log" would match any change to a file
in the "files" directory whose extension is ".log".
Polling Interval (sec) Polling interval (in seconds) to check for the specified
file.
Include Existing Files Check for the file among the files that existed before
the process engine started running.
When this field is checked, if an existing file matches
the specification in the File Name field when a
process engine starts, then a new process instance is
created.
If this field is not checked, any existing files that
match the specification in the File Name field are
ignored until there is some change in the file.
Exclude File Content Do not load the data from the file into this activity’s
output. If this checkbox is selected, the contents of the
file are not available to subsequent activities in the
process definition.
Content as The type of content in the file. Can be either text or

binary.
Encoding The character encoding for the file.

File Poller 79
|
Output

EventSourceOutputClass Object The root class for the output of the
File Poller activity. This class
activity.
action string The event that occurred to trigger

the File Poller activity. The action is
either the create, remove, or
modify.
timeOccured integer The time that the File Poller activity

detected the change in the file.
The time is expressed as the
amount of time, in milliseconds
since midnight, January 1, 1970,
UTC.


path information.

path information.
type string The file type.

reading.

writing.
size integer Size of the file.

80
| File Palette

fileContent Object Object containing the textContent
and binaryContent data.
textContent string Contents of the file (text files), if the

Exclude File Contents field was not
checked on the Configuration tab.
binaryContent binary Contents of the file (binary files), if

the Exclude File Contents field was
not checked on the Configuration
tab.
encoding string The character encoding for the file.
Read File
The Read File activity is used to read a file and place its contents into
the process’ available data.
Configuration
Field Description
process definition.
process definition.

Read File 81
|
Field Description
Read as The type of content in the file. Can be either text or
binary.
Input

ReadActivityInputClass Object The root class for the input of the
Read File activity. This class
activity.

read.
Output

ReadActivityOutputClass Object The root class for the output of the
Read File activity. This class
activity.


path information.

path information.

82
| File Palette


reading.

writing.


Exclude File Content field was not

the Exclude File Content field was
tab.
Remove File
The Remove File activity removes the specified file.

Remove File 83
|
Configuration
Field Description
process definition.
Input

RemoveActivityInputClass Object The root class for the input of the
Remove File activity. This class
activity.

remove.
Output

RemoveActivityOutput Object The root class for the output of the
Class Remove File activity. This class
activity.


path information.

84
| File Palette

path information.

reading.

writing.
Wait for File Change
The Wait for File Change activity waits for a file change (creation,
modification, or deletion) to occur during process execution. When this
activity is encountered, the process instance is suspended and waits for
the specified file to change before resuming.
Configuration
Field Description
process definition.

Wait for File Change 85
|
Field Description
File Name The path and name of the file to poll for. You can use
the Browse button to locate an existing file.
You can also use wildcards to monitor a directory for
files that match the given specification. For example,
"C:\files\*.log" would match any change to a file
in the "files" directory whose extension is ".log".
Polling Interval (sec) Polling interval (in seconds) to check for changes in
the specified file.
Include Existing Files Check for the file among the files that existed before
the process engine started running.
When this field is checked, if an existing file matches
the specification in the File Name field when a
process engine starts, then the Wait for File Change
activity accepts that file as changed and proceeds to
the next activity.
If this field is not checked, any existing files that
match the specification in the File Name field are
ignored until there is some change in the file.
process definition.
Content as The type of content in the file. Can be either text or

binary.
Encoding The character encoding for the file.

86
| File Palette
Event
Field Description
Candidate Event Key Expression built from the data of the incoming file
change event. This expression should evaluate to a
string and it is compared to the "key" field of the
activity’s input. If the Candidate Event Key and the
activity’s key match, then the process accepts the
incoming file change event.
For example, you may have created a file earlier in
the process and you may want to wait for an
external application to modify the file. When the
external application modifies the file, it appends the
word "Changed" to the filename to signify the file is
ready for processing.
You should specify the $fileInfo/fileName for the
Candidate Event Key field, and you should specify
concat("$CreateFile/fileName", "Changed")
for the "key" field on the Input tab.
$CreateFile/filename is the name of the file
created earlier in the process. This expression is
specified in XPath, and only data from the incoming
event is available for use in this XPath expression.
more information about XPath expressions.
Event Timeout (msec) A file change may occur before this activity is
milliseconds) to wait if the file change occurs before
this activity is reached within the process instance. If
the event timeout expires, an error is logged and the
event is discarded
the Input tab, the Wait For File Change activity proceeds.

Wait for File Change 87
|
Input

Wait for File Change activity. This
activity.


for the incoming file change event.
An error is returned if the event is
not received within this time limit.
Output

EventSourceOutputClass Object The root class for the output of the
Wait for File Change activity. This
the activity.
action string The change in the file that

occurred. The action is either the
create, remove, or modify.

88
| File Palette

timeOccured integer The time that the Wait for File
Change activity detected the
change in the file.
The time is expressed as the
amount of time, in milliseconds
since midnight, January 1, 1970,
UTC.


path information.

path information.

reading.

writing.


Exclude File Contents field was not

the Exclude File Contents field was
tab.

Write File 89
|
Write File
The Write File activity writes the desired contents to the specified file.
Configuration
Field Description
process definition.
Append Appends contents to an existing file. If unchecked, the

file is overwritten.
Write as How the content of the file is to be written. The file

content can be either text or binary.
Input

WriteActivityInputClass Object The root class for the input of the
Write File activity. This class
activity.
fileName string The path and name of the file.

this field.
textContent string Contents of the file (text files).

90
| File Palette

binaryContent binary Contents of the file (binary files).
addLineSeparator boolean Specifies whether to add a carriage

return after each input line.
Output

WriteActivityOutputClass Object The root class for the output of the
Write File activity. This class
activity.


path information.

path information.

reading.

writing.

| 91
Chapter 7 General Activities Palette
The General Activities palette contains several general-purpose activities and

process starters. For example, the Timer process starter is used to start a process at
a specific time. The Java Code activity is used to add custom code to your process
definition. This chapter describes the activities contained in the General Activities
palette.
Topics
• Call Process, page 92

• Checkpoint, page 93
• Confirm, page 95
• External Command, page 96
• Generate Error, page 99
• Java Code, page 102
• Label, page 106
• Mapper, page 107
• Notify, page 108
• Null, page 110
• Receive Notification, page 110
• Sleep, page 112
• Timer, page 113
• Wait, page 114
• Write To Log, page 117

92
| General Activities Palette
Call Process
The Call Process activity calls and executes an existing process

definition. The input to the called process is defined in the Start
activity of the called process. The output of the called process is
defined in the End activity of the called process. See the description of
the Start and End activities in TIBCO BusinessWorks Process Design
Guide for more information about specifying the input and output of a process.
You should only call processes that have Start activities. It is possible to call
processes that have process starters, but this could cause behavior that you may
not have intended in your process definition.
Configuration
Field Description
process definition.
Process Name The process definition you would like to call. You can
browse the available process definitions.
Spawn Specifies whether to spawn a new machine process

for executing the called process. If this option is
checked, the parent process cannot access the called
process’ output. The called process is executed in a
separate process instance.
Input

Checkpoint 93
|

input The input to the called process is
defined by the Output Schema tab
in the called process’ Start activity.
See TIBCO BusinessWorks Process
Design Guide for more information.
Output

output The output of the called process is
defined by the Output Schema tab
in the called process’ End activity.
See TIBCO BusinessWorks Process
Design Guide for more information.
Checkpoint
The Checkpoint activity performs a checkpoint in a running process

instance. A checkpoint saves the current process data and state so that it
can be recovered at a later time in the event of a failure. If a process
engine fails, all process instances can be recovered and resume
execution at the location of their last checkpoint in the process definition.
Only the most recent state is saved by a checkpoint. If you have multiple
checkpoints in a process, only the state from the last checkpoint is available for
recovering the process.
This activity has a name and description specified on the Configuration tab, but
there is no input or output for the activity.

94
Checkpoints and Transactions

Checkpoints cannot be taken within or in parallel to a transaction. So, place the
checkpoint activity outside of any transaction group. Also, make sure that if you
have multiple paths within your process definition, the checkpoint activity does
not occur in parallel with a path that has a transaction group. Instead, any
checkpoint activities should be placed at points that are guaranteed to be reached
before or after the transaction group is reached.
creating groups for transactions.
Called Processes
Checkpoints save the state of the entire process instance. By default when a
process calls another process, the subprocess is executed in the same process
instance as the calling process. If the called process spawns a new machine
process, however, the called process is a new process instance.
When a checkpoint occurs in a called process, the checkpoint saves the state of the
current process instance. If no called processes spawn new process instances, then
a checkpoint in any called process saves the state of the process instance,
including state from the parent process(es) of the current process. In the case of a
called process that spawns a new process instance, only the spawned process
instance is saved.
Recovering After a Crash

If a process engine crashes, all process instances are recovered up to the point of
their last checkpoint. You must be careful with certain types of process starters or
incoming events when placing your checkpoint within a process definition.
For example, if your process starter is waiting for an incoming HTTP request, and
you take a checkpoint after the process starts, but before you’ve responded to the
request, you will not be able to respond to the request once the process instance is
restarted. The socket for the HTTP request is closed when the process engine
crashes, therefore the HTTP Response activity in the restarted process will return
an error. In this case, you should place the respond activity before the checkpoint
so that any response is sent before a checkpoint is taken.
There are several examples of situations where an incoming event must be
handled before the checkpoint is taken. The following lists some of these
circumstances:
• A confirmable TIBCO Rendezvous or Adapter message is received.
• An email message is received, then deleted from the email server.

Confirm 95
|
• An HTTP request is received.

You should exercise care in placing checkpoints within your process definitions.
Make certain that the process has all of the data it needs to continue at the time of
the checkpoint so that in the event of a failure, a restarted process does not
attempt to access resources that no longer exist.
Confirm
The Confirm activity confirms any confirmable messages received by

the process instance. For example, if a process is started because of the
receipt of a RVCM message, the Confirm activity can send a
confirmation message to the publisher of the RVCM message.
Configuration
Field Description
process definition.
Confirm Event The message you wish to confirm. This is a

drop-down list of any process starter or signal-in
activity in the current process definition.
You will only be able to confirm messages from
confirmable message sources. For example, RVCM,
RVDQ, or JMS messages. You should select only the
event that sent the confirmable message.
If you select an event from the list that doesn’t
correspond to a confirmable message (for example, a
Wait for File Change event) or if you try to confirm
the same message more than once, the activity does
nothing.

96
External Command
The External Command activity allows you to execute an

Operating System command. This activity waits for the command
to complete before transitioning to the next activity. Optionally, the
command’s output and any errors can be included in this activity’s
output schema, written to a file, or both.
Long-Running Commands
If you wish to execute long-running commands (such as daemons), it may not be
practical to execute the command directly. Because the specified command must
terminate before control is passed to the next activity, the process instance must
run until the external command completes. To avoid this problem, you may wish
to create a script that runs the desired commands in the background.
The syntax of executing commands as background processes differs by operating
system. For example, on UNIX, to run a command in the background, you
append the ampersand character (&) to the command. On Microsoft Windows,
you use the START command within a batch file to run a command in a different
process.
After creating a script to run commands in the background, specify the script as
the command to run in the External Command activity. The script runs the
desired command and returns the process ID of the process it started. The return
code of the script is stored in the returnCode item of the External Command
activity’s output.
If you wish to start a long-running command in the background and then later
terminate the background process, you should store the process ID returned by
the script in a file or database table. Another process instance can then read the
process ID and kill the process with the appropriate operating system command
when necessary.
Configuration
Field Description

External Command 97
|
Field Description
Command to Execute The command line to execute. You can also specify
any input and command-line arguments to the
command in this field.
You can specify a global variable for this
configuration field. This allows you to easily specify
different commands on different operating systems.
For example, you may specify
%%EXTERNAL_COMMAND%% as the value for this field.
On MS Windows, the value of the global variable
may be the following:
cmd /c dir
On UNIX, the global variable may be the following:

ls
If the external command is not defined in the PATH

environment variable (on UNIX or Windows), you
must specify the full path for the executable
command.
Make Output Available When checked, this field specifies that the output
as Activity Output sent to standard output and standard error by the
command should be available in the output schema
of this activity.
For commands the produce a large amount of
output, it is recommended to uncheck this field and
write the output to a file. This saves memory and
allows you to use other activities (for example Read
File and Parse Data) to handle the output file more
efficiently.
Output Filename Name and location of the file in which to store any
output or errors produced by the command. If this
field is blank, no output file is created.
Input

98

cmd_input Object The root class for the input of the
Command Line activity. This class
contains all input items for the activity.
command string The command to execute (with any

input or command-line arguments).
Specifying this input item overrides the
command specified on the
Configuration tab.
input string An input string to supply to the

command’s standard input. This
schema item accomplishes the same
goal as entering the command from a
command prompt and then typing in
input without specifying a carriage
return.
For example, on UNIX, typing "sed"
into a command prompt allows you to
enter more text as input into the sed
command.
Use &crlf; within the string for this
item to specify a carriage return (that is,
&crlf; simulates pressing the Enter
key).
Output

cmd_output Object The root class for the output of the
Command Line activity. This class
activity.
returnCode integer The return code returned by the

command.

Generate Error 99
|

output string Any output produced by the command
and sent to stdout. This output item is
only available if the "Make Output
Available as Activity Output" field is
error string Any errors returned by the command.

This output item is only available if the
"Make Output Available as Activity
Output" field is checked on the
Configuration tab.
Generate Error
This activity generates an error and causes an immediate transition to

any error transitions, or if there are no error transitions, stops the
process instance. This activity is useful within a group or within a
called process. If you would like to catch and raise your own error
conditions, you can use this activity to do so.
For example, if you have a process that calls a subprocess to check the credit of a
customer, you can use the Generate Error activity to raise an error if there is an
error condition, such as the customer does not exist, or the customer has no credit
available. Within the called subprocess, you would transition to the Generate
Error activity after detecting the error condition and the called process would
terminate. Processing would continue with an error in the calling process. You
could have an error transition on the Call Process activity to handle the error.
Figure 9 illustrates the example described above.

100
Figure 9 Using the Generate Error activity
... ...
CreditCheck Subprocess
handling errors in process definitions.
Configuration
Field Description
process definition.

Generate Error 101
|
Field Description
Select Error Schema The process error schema to send to the parent
process. - Default - specifies that the error should be
propagated only in the $_error process variable.
Process error schemas are defined on the Error
Schemas tab of the End activity for the process. The
schema specified in this field is added to the Input
schema for this activity. Data you map to the error
schema is propagated to the parent process.
more information about specifying process error
schemas.
Input

ActivityInput Object The root class for the input of the
Generate Error activity. This class
activity.
message string The text of the error message to

generate.
data Object The schema specified in the Select

Error Schema field of the
Configuration tab is contained in
this input item. Map data from the
list of process variables to this input
item to propagate the data to the
parent process.
Output

102
Java Code
You can add custom code to your process definition with the Java Code
activity. This activity allows you to write a standard Java class that can
manipulate any of the process data or perform any action you choose.
When you specify input and output parameters for the Java Code
activity, get/set method code is automatically generated for the activity. You can
use that code in your Java class, and it is displayed when you click the Show
Source button on the Code tab.
The Java Code activity automatically creates an invoke() method in which you
should put the code you wish to execute. This method is called when the engine
processes the Java Code activity.
Configuration
Field Description
process definition.
Input Parameters The input parameters for the Java Code activity. These
parameters will appear on the Input tab after they are
specified. Each input parameter has three fields:
• Field Name — Name of the parameter.
• Type — Datatype of the parameter. Specify one of
the supplied Java primitive types, or specify
"Object Reference" if you are accepting a Java
object from another Java Code activity as input.
See Passing Java Objects Between Java Code
Activities on page 104 for more information about
passing Java objects between Java Code activities.
• Required — Whether the parameter is required,
optional, or repeating.

Java Code 103
|
Field Description
Output Parameters The output parameters for the Java Code activity.
These parameters will appear on the Output tab after
they are specified. Each output parameter has three
fields:
• Field Name — Name of the parameter.
• Type — Datatype of the parameter. Specify one of
the supplied Java primitive types, or specify
"Object Reference" if you are accepting a Java
object from another Java Code activity as input.
See Passing Java Objects Between Java Code
Activities on page 104 for more information about
passing Java objects between Java Code activities.
• Required — Whether the parameter is required,
optional, or repeating.
Code
The code tab has the following fields/buttons.
Field/Button Description
Code Body The source code of the Java class. Specify the code you
wish to execute in the automatically generated
invoke() method. The get/set methods for the input
and output parameters are automatically generated
and displayed when you click the Show Source
button.
When the Java code is run by the engine, the
automatically generated get/set methods are called,
then the invoke() method within the Java class is
called.
Compile Status The errors encountered during compilation.
Editor Use Edit>Preferences>Other to specify the Java

editor you wish to use to edit source code.
If you do not specify an editor, a simple popup
editing window is used.

104
Field/Button Description
Compile Button Compiles the current source code. JDK 1.3 and 1.3.1
are supported for this release.
After compilation, the source and compiled java code
are placed into the lib/palettes/javaCode
directory within the TIBCO BusinessWorks
installation directory.
View Errors Button Displays the errors encountered when the code was
compiled.
Show Source Button Displays the source code in the editor specified with
the TIBCO Designer preferences. If no editor is
specified, a simple popup editing window is used.
Classpath Button Displays the current CLASSPATH environment

variable. You can add to the classpath by editing the
values in the popup editing window.
Passing Java Objects Between Java Code Activities

You may create instances of Java objects within your Java code. You can pass these
Java objects by way of an output parameter to another Java Code activity later in
the process definition. The Java Code activity receiving a Java object accepts the
object into an input parameter and you must map the output object from the first
Java Code object to the input object of the receiving Java Code object.
Any objects passed by input and output parameters between Java Code activities
must be serializable.
Figure 10 illustrates two Java code activities. The CreateObject activity creates a
Java object and passes a reference to the object in its output parameter named
out_object. The UseObject activity defines an input parameter named
in_object of type ObjectReference and maps the CreateObject activity’s
output object reference to its input parameter of type ObjectReference.
The UseObejct activity can invoke methods on the input object as it would for any
other object. For example, if you wish to call a method named m1 that returns an
integer, you would use the following code within the UseObject activity:
int(in_object.m1());

Java Code 105
|
Figure 10 Passing objects between Java Code activities
Input

InputParameters Object The root class for the input of the
Java Code activity. This class
activity.
parameters varies The Input tab will have a list of

whatever input parameters are
specified on the Configuration tab.

106
Output

OutputParameters Object The root class for the output of the
Java Code activity. This class
activity.
parameters varies The Output tab will have a list of

whatever output parameters are
specified on the Configuration tab.
Label
The Label allows you to create a generic label so that you can provide
documentation and comments within your process definition. The Label
is not actually an activity, because you cannot draw transitions to or from
it, and it does not perform any action. You use the label to create a
descriptive tag that you can place anywhere within a process definition.
Configuration
Field Description
Description Descriptive text that you would like to add to the
label. You can add comments here about the process
diagram. Use this field to provide documentation for
the process.
Label Color Allows you to pick a color for the text of the label. Use
the Color button to bring up the Choose a Label Color
dialog.

Mapper 107
|
Field Description
Label Font Allows you to pick a font for the text of the label. Use
the Choose Font button to bring up the Font Panel
dialog.
Mapper
The Mapper activity adds a new process variable to the process

definition. This variable can be a simple datatype, a TIBCO
ActiveEnterprise schema, an XML schema, or a complex structure. You
can map data values from the current list of process variables to the
elements of the variable added with the Mapper activity.
Output Schema
The Output Schema tab defines the structure of the process variable to add to the
process definition.
You can use a simple datatype, or you can define a group of data elements on this
tab. You can also reference XML schema or ActiveEnterprise classes stored in the
project. Once defined, the data specified on the Output Schema tab becomes the
output schema of the Mapper activity. This data then becomes available to other
activities within the process definition.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Output Schema tab.
Input
The input for the activity is defined by the specified data elements on the Output
Schema tab.

108
Output
The output for the activity is defined by the specified data elements on the Output
Schema tab.
Notify
The Notify activity allows a process instance to send data to a

corresponding process instance containing a Wait activity or Receive
Notification process starter. The Notify Configuration resource specified
on the Configuration tab and the key specified on the Input tab create the
relationship between the Notify activity and the corresponding Wait or Receive
Notification. The data specified in the Notify’s input is sent to the Wait or Receive
Notification that specifies the same Notify Configuration resource and has the
same value for the key.
The Wait, Receive Notification, and Notify activities allow running process
instances to communicate. See TIBCO BusinessWorks Process Design Guide for more
information on inter-process communication.
Configuration
Field Description
process definition.
Shared Configuration The Notify Configuration shared configuration

resource that defines a data schema for this activity.
See Notify Configuration on page 321 for more
information.
The Notify Configuration resource is required, but the
schema can be empty if you do not wish to pass data
between processes.

Notify 109
|
Input

input Object The root class for the input of the Notify
key string The key that coordinates a Notify

activity with the corresponding Wait or
Receive Notification. For example, in an
order handling process, the order ID
might be the key that Wait and Notify
use to determine which Wait activity
corresponds to the Notify activity.
The key can be an XPath expression, but
it must evaluate to a string.
See TIBCO BusinessWorks Process Design
Guide for more information and
examples of choosing the key for Wait,
Notify, and Receive Notification.
timeout integer The timeout (number of milliseconds)

to keep the information for this Notify
activity. The activity executes
immediately and transitions to the next
activity, but the Notify information is
kept by the engine until a
corresponding Receive Notification or
Wait occurs. If the corresponding
activity does not occur before this
timeout is reached, the Notify
information is removed.
schema Object The schema specified by the Notify

Configuration on the Configuration tab.
This schema is used to pass data from
the process instance into the process
instance containing a corresponding
Receive Notification or Wait.

110
Output
Null
The Null activity is an activity with no action performed. This activity

has a name and a description specified on the Configuration tab, but
there is no input or output for the activity.
This activity is useful if you wish to join multiple process flows (that is,
when you have multiple transitions out of an activity and each transition takes a
different path in the process definition).
Receive Notification
The Receive Notification process starter starts a process when another

process executes a Notify activity with a matching key and Notify
Configuration resource. The key specified in the Key field of the
Configuration tab creates a relationship between the Receive Notification process
starter and the corresponding Notify activity.
The same Notify Configuration shared configuration resource must be specified
by corresponding Receive Notification and Notify so that data can be passed from
the process containing the Notify activity to the process started with Receive
Notification. The schema in the Notify Configuration resource can be empty, if
you do not wish to pass data between processes.

Receive Notification 111
|
Configuration
Field Description
process definition.

information.
between processes.
Key The key that coordinates a Receive Notification

process starter with the corresponding Notify. For
example, in an order handling process, the order ID
might be the key that Receive Notification uses to
determine which Notify activity corresponds to this
process starter.
The key must be a fixed string. You may use global
variables, but XPath expressions cannot be used.
more information and examples of choosing the key
for Wait, Notify, and Receive Notification.
Output

the process instance containing the
Notify into this process instance.

112
Sleep
The Sleep activity suspends the process on the current transition for the
given amount of time. If you have multiple control flows in your
process, only the current execution branch of the process is suspended.
Configuration
Field Description
process definition.
Input

SleepInputSchema Object The root class for the input of the
Sleep activity. This class contains all
input items for the activity.
IntervalInMillisec integer The amount of time, in

milliseconds, to suspend the
current branch of the process.

Timer 113
|
Timer
The Timer process starter starts a process at a specific time. You can also
specify that processes are to be started periodically.
Configuration
Field Description
process definition.
Start Time The day and time to start the process. If the process is
to be run periodically, then the start time indicates the
first time to run the process.
Run once Indicates this process should be run only once at the
day and time indicated by the Start Time field. If
unchecked, the Time Interval and Runs Every fields
appear to allow you to specify the frequency of the
process.
Time Interval Integer indicating the number of units specified in the

Interval Unit field. For example, if this field is
specified as "1" and the Interval Unit field is specified
as "Hour", that signifies to start a new process every
hour starting with the time specified in the Start Time
field.
If this field is specified as "2" and the Interval Unit
field is specified as Month, that signifies to start a
process every other month, starting with the time
specified in the Start Time field.
Interval Unit Unit of time to use in conjunction with the Time

Interval field to determine how often to start a new
process. The units can be: Second, Minute, Hour, Day,
Week, Month, Year.

114
Output

TimerOutputSchema Object The root class for the output of the
Timer activity. This class contains
Time The time the process instance

started. The time is represented by
several items in the output schema
indicating the hour, minute,
second, and so on each item uses
the appropriate datatype.
Wait
The Wait activity suspends execution of the process instance and waits for
a Notify activity with a matching key to be executed in another process
instance. The key specified in the Notify Configuration specified on the
Configuration tab and the Key field of the Input tab creates a relationship
between the Wait activity and the corresponding Notify activity.
The same Notify Configuration shared configuration resource must be specified
by corresponding Wait and Notify so that data can be passed from the process
instance containing the Notify activity to this process instance. The schema in the
Notify Configuration resource can be empty, if you do not wish to pass data
between processes.

Wait 115
|
Configuration
Field Description
process definition.

information.
between processes.
Input

input Object The root class for the input of the Notify

116

key string The key that coordinates a Wait activity
with the corresponding Notify. For
example, in an order handling process,
the order ID might be the key that Wait
and Notify use to determine which Wait
activity corresponds to the Notify
activity.
The key can be an XPath expression, but
it must evaluate to a string.
See TIBCO BusinessWorks Process Design
Guide for more information and
examples of choosing the key for Wait,
Notify, and Receive.
timeout integer The timeout (number of milliseconds)

for this Wait activity. If a Notify activity
that has a matching key is not executed
within this specified number of
seconds, the Wait times out and
transitions to the next activity.
Output

the process instance containing the
Notify into this process instance.

Write To Log 117
|
Write To Log
This activity writes a message to the log. The logs are stored within the
TIBCO BusinessWorks installation directory under the logs
subdirectory. There is one log file for each process engine. A process
definition with the Write To Log activity will write a message to the log
of the process engine that is running the process instance corresponding to the
process definition.
Configuration
Field Description
process definition.
Role The user-defined role name for this log entry.

Roles can be used to filter the log entries when
displaying them. For example, if you set the role as
"Debug", you can choose to view or not view all log
entries that have the role set to "Debug".
Suppress Job Info If checked, no additional information is added to the

log entry.
If unchecked, each log message has the Job number,
process definition name, and activity name
prepended to the message text.
Input

118

Write To Log activity. This class
activity.
message string The message that you would like to

appear in the log.
Logs are stored in the TIBCO
BusinessWorks installation
directory under the logs
subdirectory.
Output

| 119
Chapter 8 HTTP Palette
The HTTP palette allows you to send and receive HTTP requests.
Topics
• HTTP Receiver, page 120

• Send HTTP Request, page 123
• Send HTTP Response, page 129
• Wait for HTTP Request, page 133

120
| HTTP Palette
HTTP Receiver
Starts a process based on the receipt of a HTTP request.
Configuration
Field Description
process definition.
HTTP Connection The HTTP Connection shared resource that describes

the port number on which this process starter listens
for incoming HTTP requests.
See HTTP Connection on page 309 for more
information about specifying shared resources.
Parse Post Method Specifies that the attributes of the request should be
Data parsed into a schema tree for the Output tab.
Attributes The attributes of the HTTP request. For each attribute,

you must provide a field name, datatype for the field,
and whether the field is required, optional, or
repeating.
HTTP Authentication Specifies that the client sending the HTTP request
must be authenticated. The user name and password
specified in the incoming request must exist in the
domain (users are created and managed within the
domain using TIBCO Administrator).

HTTP Receiver 121
|
Headers
The headers tab describes the data structure for the headers of the HTTP request.
You can use the default structure, or you can alter the structure, if the incoming
request has a specific data structure for the header of the request. This tab uses the
same mechanism described Appendix A, Specifying Data Schema, on page 341 in
to specify the data structure for the headers. See that section for more information
about creating a customized data structure.
Header structure is defined by the HTTP protocol. See the HTTP Protocol
specification for more information about the fields and content of the header of a
HTTP request. You can obtain this specification at www.w3.org.
The default header fields are the following.

Headers Object The root class for the header
structure.
Content-Type string This field indicates the media type

of the entity body sent to the
receiver. Media types are described
in the HTTP specification. An
example of the media type it
"text/html;
charset=ISO-8850-4".
Content-Length string This field indicates the size of the

entity body (in decimal number of
OCTETs) sent to the receiver.
Connection string This field allows the requestor to

specify options desired for this
connection. An example option is
"close", which specifies that the
requestor would like the
connection to be closed when the
request is complete.
Set-Cookie string See the HTTP specification for

more information about this field.

122
| HTTP Palette

Pragma string This field is used to include
implementation-specific directives
that might apply to the receiver. See
the HTTP specification for more
information about using this field.
Location string This field is used to redirect the

receiver to a location other than the
Request-URI for completion of the
request or for identification of a
new resource.
Output

HTTP Receiver activity. This class
activity.
Method string Whether the request is a GET or

POST method.
RequestURI string The address portion of the request.

This is the portion before the
question mark (?).
HTTPVersion string Version field of the HTTP request.
PostData string The data portion for a POST

request.
Command string Command portion of the HTTP

request.
QueryString string The query string portion of the

request. This is the portion after the
question mark (?).
Header string The header of the HTTP request.

Send HTTP Request 123
|

Headers object The fields of the header specified
on the Headers tab. See the
description of the Headers tab for
more information about these
items.
parameters object Parameters for the incoming

request. These parameters are
configured in the Attributes field
These parameters are available as a
schema tree if the Parse Post
Method Data checkbox is check.
Send HTTP Request
The Send HTTP Request activity sends a HTTP request to a web

server.
Configuration
Field Description
process definition.
Host The host machine name or IP address to send the

request to. For example, www.tibco.com.
Port The port on the host machine to send the request to.
The default port is 80.

124
| HTTP Palette
Field Description
Use Proxy Setting Specifies that a proxy server is to be used to gain
access outside of a firewall. The Proxy Configuration
shared configuration resource specifies the
configuration of the proxy server.

repeating.
These attributes are sent by way of the query string in
the request. For example,
?attr1=value1&attr2=val2.
Authentication Specifies that the request must first supply a valid

username and password to authenticate with the
HTTP server.
This activity supports only basic authentication.
User Name (HTTP User name to log onto the HTTP server.
Authentication)
Password Password to log onto the HTTP server.
Use Secure Socket Specifies to use the HTTPS (secure socket layer, or
(HTTPS) SSL) for the request. This protocol authenticates the
server to the client, and optionally, the server can
require that the client authenticate itself to the server.
SSL requests require that the client have the
appropriate digital certificate. See the documentation
from your certificate provider for more information
about configuring SSL.
Enabling this field allows you to specify the Trusted
Certificate Location, Client Identity, and Client
Identity Password fields.
For more information about creating keystores for
private keys and trusted certificate chains, see
http://java.sun.com/j2se/1.3/docs/tooldocs/win32
/keytool.html.

|
Field Description
Trusted Certificate Only available when HTTPS is enabled.
Location
This field specifies the Trusted CA shared
configuration resource. This certificate should contain
the list of certificate authorities the client will accept
for sever certificates. The server’s certificate is
checked against this list, and if the certificate is not
from a listed certificate authority, the connection is
refused.
Client Identity Only available when HTTPS is enabled.

(Keystore)
This field specifies the location of the client’s digital
certificate.
Client Identity Only available when HTTPS is enabled.

Password
This field specifies the client’s password for its private
key.
Key Store Type Only available when HTTPS is enabled.

The file type for the trusted certificate. This file type
can be Java Key Store (JKS) or PKCS12.
Verify Host Name Only available when HTTPS is enabled.

This field specifies that the host name of the HTTP
server should be checked against the host name listed
in the server’s digital certificate. This provides
additional verification that the host name you believe
you are connecting to is in fact the desired host.
If the host name specified in the Endpoint URL field
on the Configuration tab is not an exact match to the
host name specified in the server’s digital certificate,
the connection is refused.
Note: If you specify an equivalent hostname (for
example, an IP address) in the Endpoint URL field,
but the name is not an exact match of the hostname in
the host’s digital certificate, the connection is refused.

126
| HTTP Palette
Input Headers/Output Headers

The Input Headers and Output Headers tabs describe the data structure for the
headers of the HTTP request and the HTTP reply message. You can use the
default structure, or you can alter the structure, if the outgoing request or the
reply to the request has a specific data structure for the header. This tab uses the

structure.

"text/html;




|


new resource.
Input

RequestActivityInput Object The root class for the input of the
Send HTTP Request activity. This
activity.
Host string The HTTP host you wish to connect

to. Specifying a value for this input
item overrides any value specified
Port integer The port number that the HTTP

server uses for incoming requests.
Specifying a value for this input
CertificateInfo Object The digital certificate you wish to

send to the HTTP server to verify
the requestor’s identity. Specifying
a value for this input item overrides
any value specified on the
Configuration tab.

128
| HTTP Palette

POST method.

question mark (?).

request.

request.

question mark (?).
Timeout integer The amount of time (in

milliseconds) to wait for a response
from the HTTP server.
Headers Object The header fields to send for the

request. This object is specified on
the Input Headers tab, and you can
use this input item to supply values
for the header when sending the
request.
parameters Object Parameters for the incoming


Send HTTP Response 129
|
Output

RequestActivityOutput Object The root class for the output of the
Send HTTP Request activity. This
the activity.
binaryContent binary The binary content of the response

to the request from the HTTP
server.
asciiContent string The ascii content of the response to

the request from the HTTP server.
Headers Object The header fields of the reply. The

structure of this output item is
specified on the Output Headers
tab.
Send HTTP Response
Sends a response to a previously received HTTP request. This

activity is used in conjunction with the HTTP Receiver process
starter or the Wait for HTTP Request activity.
The default status line returned by this activity is "200 OK".

130
| HTTP Palette
Configuration
Field Description
process definition.
Reply For The Wait for HTTP Request activity or HTTP Receiver
process starter that received the request. This is a
selection list of available activities that can receive
HTTP requests.
Close Connection Specifies that the HTTP connection should be closed

after sending the response.
Headers
The headers tab describes the data structure for the headers of the HTTP
response. You can use the default structure, or you can alter the structure, if the
outgoing response has a specific data structure for the header of the request. This
tab uses the same mechanism described Appendix A, Specifying Data Schema, on
page 341 in to specify the data structure for the headers. See that section for more
information about creating a customized data structure.

structure.

Send HTTP Response 131
|

StatusLine string This field is the first line of a
response message. This consists of
the protocol version, a numeric
status code, and the text phrase
explaining the status code. See the
HTTP specification for more
information about status codes in
HTTP responses.

"text/html; charset=ISO-8850-4".
By default this item is set to
"text/html". If you are using this
activity and the Retrieve Resources
activity to retrieve a WSDL file, you
should set the type to "text/xml"
when specifying values on the
Input tab.

Content-Encoding string This is the character encoding of

the response message. See the
HTTP specification for more
information about specifying the
content encoding.



132
| HTTP Palette


new resource.
Input

ResponseActivityInput Object The root class for the input of the
Send HTTP Response activity. This
activity.
Header string The header of the HTTP response.

The default status line for the
response is "200 OK".
binaryContent binary The binary content of the response

to the request.
asciiContent string The ascii content of the response to

the request.
charset string The character encoding to use for

this response.

Wait for HTTP Request 133
|

items.
Output
Wait for HTTP Request
Waits for an incoming HTTP request within a process definition. The

process instance suspends until the incoming HTTP request is
received.
Configuration
Field Description
process definition.
HTTP Connection The HTTP Connection shared resource that describes

the port number on which this process waits for
incoming HTTP requests.
See HTTP Connection on page 309 for more
information about specifying shared resources.
Parse Post Method Specifies that the attributes of the request should be
Data parsed into a schema tree for the Input tab.

134
| HTTP Palette
Field Description
repeating.
Authentication Specifies that the client sending the HTTP request

must be authenticated. The user name and password
specified in the incoming request must exist in the
domain (users are created and managed within the
domain using TIBCO Administrator).
Headers
The headers tab describes the data structure for the headers of the HTTP request.
You can use the default structure, or you can alter the structure, if the incoming
request has a specific data structure for the header of the request. This tab uses the

structure.

"text/html;


|




new resource.

136
| HTTP Palette
Event
Field Description
incoming message.
For example, you may have sent an HTTP request
earlier in the process, and you may be waiting for a
response from the HTTP server. You may specify a
requestID as an attribute of the HTTP request and
responseTo attribute on the Wait for HTTP request
activity. The HTTP server presumably will set the
responseTo attribute of its response to the same
value as the requestID attribute of the request. You
would then specify the responseTo attribute as the
Candidate Event Key and the requestID attribute
of the HTTP request as the "key" in the Input tab.
expressions.

the Input tab, the Wait For HTTP Request activity proceeds.

|
Input

Wait for HTTP Request activity.
for the activity.

Event on page 136 for an example
of using the Candidate Event Key

Output

Wait for HTTP Request activity.
for the activity.

POST method.

question mark (?).

138
| HTTP Palette

request.

request.

question mark (?).

items.
parameters object Parameters for the incoming

These parameters are available as a
schema tree if the Parse Post
Method Data checkbox is checked.

| 139
Chapter 9 JDBC Palette
The JDBC palette contains activities for querying, updating, or calling stored
procedures within a database.
Topics
• JDBC Call Procedure, page 140

• JDBC Query, page 143
• JDBC Update, page 148
• Query Designer, page 151
• SQL Direct, page 156

140
| JDBC Palette
JDBC Call Procedure
The JDBC Call Procedure activity calls a database procedure using the
specified JDBC connection.
If this activity is not part of a transaction group, it is committed after it
completes. If this activity is part of a transaction group, it is committed
or rolled back with the other JDBC activities within the group at the end of the
transaction. See TIBCO BusinessWorks Process Design Guide for more information
about creating groups for transactions.
If you wish to override the default behavior of transaction groups for certain
JDBC activities within a transaction group, you can check the Override
transaction behavior field. This specifies that the activity is outside of the
transaction and is committed when it completes, even if it is within a transaction
group.
The Refresh button on this activity allows you to synchronize the activity with
the contents of the database. This is useful if you make a change to the database
while you are editing a process definition containing this activity in TIBCO
BusinessWorks.
Configuration
Field Description
process definition.
Shared Configuration Path to the shared configuration resource containing

the JDBC connection information. See JDBC
Connection on page 315 for more information about
JDBC resources.

JDBC Call Procedure 141
|
Field Description
Procedure Name Name of the database procedure to call. You can use
the Select Procedure button to query the database for
available procedures once the JDBC Connection field
is specified.
Note: The input parameters and output parameters
for the procedure are displayed when you use the
Select Procedure button. TIBCO Designer retrieves
the signature of each stored procedure from the
database once. If you change the stored procedure
while editing your project, you must click the Refresh
button to retrieve the changes from the database.
Catalog/Package The catalog or package in which the procedure

resides. This name is used to resolve naming conflicts
if more than one catalog or package in the database
has the selected procedure with the same name.
This field is only applicable to databases that have
more than one catalog/package. See your database
documentation for more information about
catalogs/packages.
Schema The schema in which the procedure resides. This

name is used to resolve naming conflicts if more than
one schema in the database has the selected
procedure with the same name.
Timeout (sec) Time to wait for the procedure call to complete. If the
call does not complete within the given time limit, an
error is returned.
Override transaction Overrides the default behavior of a transaction group.

behavior If this activity is within a transaction group, the
activity is normally committed or rolled back with the
other JDBC activities within the transaction.
If this checkbox is checked, this activity is not part of
the transaction group and is committed when it
completes. Checking this option uses a separate
database connection to perform the activity and
commit the SQL statement.
Maximum Rows The maximum number of rows to retrieve.

142
| JDBC Palette
Input
The input for this activity is dependent upon the input parameters of the database
procedure.

inputs Object The root class for the input of the
JDBC Call Procedure activity. This
activity.
inputSet Object The input parameters of the

database procedure. The datatype
contained within this object varies
depending upon the parameters
specified for the database
procedure.
Output
The output for the activity is dependent upon the output parameters of the
database procedure.

resultSet Object The root class for the output of the
JDBC Call Procedure activity. This
the activity.
outputSet Object The output of the database

procedure. The datatype contained
within this object varies depending
upon what the database procedure
returns.

JDBC Query 143
|

unknownResultSets Object The output of the database
procedure may return other result
sets. These result sets are returned
in this output item as an XML
string. Create a Schema Definition
shared configuration resource to
describe these result sets, then use
the Parse XML activity to parse the
XML based on the schema. You can
then use the parsed output in
subsequent activities.
See the release notes for a more
detailed description of this
procedure.
JDBC Query
The JDBC Query activity performs the specified SQL SELECT

statement.
completes. If this activity is part of a transaction group, it is committed
or rolled back with the other JDBC activities within the group at the end of the
transaction. See TIBCO BusinessWorks Process Design Guide for more information
about creating groups for transactions.
group.
The Refresh button on this activity allows you to synchronize the activity with
the contents of the database. This is useful if you make a change to the database
while you are editing a process definition containing this activity in TIBCO
BusinessWorks. The Refresh button also is useful if you enable the Manual
Refresh field on the Configuration tab.

144
| JDBC Palette
Configuration
Field Description
process definition.

JDBC resources.
SQL Statement The SQL SELECT statement to perform in the

database. There is a wizard available to build the
query for the desired database. See Query Designer
on page 151 for more information about using the
Query Designer wizard.
Timeout (sec) Time (in seconds) to wait for the query to complete. If
the query does not complete within the given time
limit, an error is returned.


JDBC Query 145
|
Field Description
Prepared parameters If you wish to replace static names within the SQL
and their datatypes statement with process variables, you must edit the
SQL Statement field and replace the variable items
with a question mark (?). For example, if you wish to
specify a variable for the first column returned, you
would specify the following SQL statement:
SELECT DEMO.ITEM.ITEM_ID FROM DEMO.ITEM
WHERE DEMO.ITEM.ITEM_ID = ?
The ? replaces the value in the WHERE clause, and

you can then provide input to the SQL statement from
process data on the input tab.
When you add question marks to SQL statements, a
list of prepared parameters appears (one parameter
for each question mark). You must supply the
datatype of each parameter to the SQL statement, and
this datatype is used in the input schema for the
statement.
At runtime, any parameters you place within the SQL
statement are replaced with the mapped values for
those parameters on the Input tab.
Note: Editing the SQL statement disables the Design
tab of the Query Designer wizard. Make sure you
have designed the query you need before editing it
and inserting question marks for process variables. If
your question marks are in the WHERE clause, you
can put those conditions into the Design tab in the
Where fields of each column. This will allow you to
keep the design tab available and still have process
variables in your query.

146
| JDBC Palette
Field Description
Use Nil Specifies whether NULLs are represented as optional
schema elements or whether each item that can
contain a NULL has sub-items.
For example, in the following schema, the NAME
column can contain NULLs. If Use Nil is unchecked,
the NAME element appears with a ? indicating it is
optional (and if the column is NULL, the schema item
is not included for that row). If Use Nil is checked, the
NAME element is not optional, and it has two
sub-items, @nil and Text. The @nil item indicates
whether the column value for the row is NULL, the
Text item contains the column value when the
column is not NULL.
Use Nil Checked Use Nil Unhecked

JDBC Query 147
|
Field Description
Manual Refresh TIBCO BusinessWorks refreshes the schema from the
database when any operation may cause the input or
output schema for this activity to change. For
example, editing the SQL Statement may cause the
output schema to change. However, not all changes
actually cause a change in the input or output
schemas, so you may wish to prevent automatic
schema refreshing to improve performance.
Checking this field causes TIBCO BusinessWorks to
stop automatically querying the database for changes
in input and output schema when configuring the
activity. If you want to refresh the schema from the
database, you must use the Refresh button on this
activity.
This field is useful if you make several changes to a
query’s WHERE clause, but make no changes to the
list of columns to return. For large databases, each
change would require a refresh from the database,
and this can dramatically slow performance. WIth
manual schema refreshing, the schema is only
refreshed when you click the Refresh button.
Input

jdbcQueryActivityInput Object The root class for the input of the
JDBC Query activity. This class
activity.
Prepared_Param_* varies The list of prepared parameters

supplied in the SQL statement.
Prepared parameters allow you to
substitute process data for items
within the SQL statement. See the
description of the Prepared
parameters field on the
Configuration tab.

148
| JDBC Palette
Output

resultSet Object The root class for the output of the
JDBC Query activity. This class
activity.
Record Object The result of the database query.

The result object depends upon the
columns returned by the query.
JDBC Update
The JDBC Update activity performs the specified SQL INSERT,

UPDATE, or DELETE statement.
completes. If this activity is part of a transaction group, it is
committed or rolled back with the other JDBC activities within the group at the
end of a transaction. See TIBCO BusinessWorks Process Design Guide for more
information about creating groups for transactions.
Transaction behavior field. This specifies that the activity is outside of the
group.
Configuration
The Configuration tab has the following fields:
Field Description
Name The name to appear as the label for this field
in the process definition.

JDBC Update 149
|
Field Description
Shared Configuration Path to the shared configuration resource

containing the JDBC connection information.
See JDBC Connection on page 315 for more
information.
SQL Statement The SQL INSERT, UPDATE, or DELETE

statement to perform.
Timeout (sec) The time to wait for the statement to

complete.
Override Transaction Behavior Overrides the default behavior of a

transaction group. If this activity is within a
transaction group, the activity is normally
committed or rolled back with the other
JDBC activities within the transaction.
If this checkbox is checked, this activity is not
part of the transaction group and is
committed when it completes. Checking this
option uses a separate database connection to
perform the activity and commit the SQL
statement.

150
| JDBC Palette
Field Description
Prepared Parameters and If you wish to replace static names within the
Their Datatypes SQL statement with process variables, you
must edit the SQL statement field and replace
the variable items with a question mark (?).
For example, you might specify the following
statement:
UPDATE emp SET ename = ?, phone = ?
WHERE id = ?
When you add question marks to SQL

statements, a list of prepared parameters
appears (one parameter for each question
mark). You must supply the datatype of each
parameter to the SQL statement, and this
datatype is used in the input schema.
At runtime, any parameters you place within
the SQL statement are replaced with the
mapped values for those parameters.
For INSERT and DELETE statements, all
prepared parameters will appear as required
items in the Input tab. For UPDATE
statements, all prepared parameters will
appear as optional in the Input tab, but you
must supply a value for at least one column
in the statement or a runtime error occurs.
Input
The input for the activity is the following:

jdbcUpdateActivityInput Object The root class for the input of the
JDBC Update activity. This class
activity.

Query Designer 151
|

Prepared_Param_* varies The list of the prepared
parameters supplied in the SQL
statement. Prepared parameters
allow you to substitute process
data for items within the SQL
statement. See the description of
the Prepared Parameters field on
the Configuration tab.
Output
The output for the activity is the following:

jdbcUpdateActivityOutput Object The root class for the output of the
JDBC Update activity. This class
activity.
noOfUpdates integer The number of updates

performed by the statement
specified on the Configuration
tab.
Query Designer
The Query Designer is a GUI tool for building SQL queries, testing syntax, and
previewing results before running the process. You can use the Query Designer in
one of the following ways:
• to automatically generate SQL queries
• to manually edit and check the syntax of existing queries

152
| JDBC Palette
In the JDBC Query activity, you must first specify a JDBC Connection shared
configuration resource to connect to a database. Once the database connection is
specified in the JDBC Query activity, you can click on the Build Using Wizard
button to create a query using the Query Designer wizard. Figure 11 illustrates the
query designer.
Figure 11 The query designer wizard
The Query Designer window has the following elements:

• a Database Schema panel, where schema information for the specified
database and user is displayed in a tree structure.
• a Table Diagram panel, where you can drag and drop tables from the Schema
panel to build a SQL query.
• a SQL panel, where you can design, refine, view, and test the query. This panel
has three tabs for designing, editing, and testing your queries.
You can use the Design tab of the Query Designer to automatically generate
queries. You can then click on the SQL tab of the Query Designer to manually edit
the query, if you wish. To manually edit the query, click the Customize checkbox
on the SQL tab. On the SQL tab, you can drag and drop columns into the
statement.

Query Designer 153
|
After you customize a query on the SQL tab, you cannot go back to the design tab
without loosing your changes. You should first create a query using the Design
tab that is close to the query you want, then click the Customize checkbox on the
SQL tab to further customize it as needed.
To use the Query Designer to generate a query, perform this procedure:

1. Drag tables to include in the query from the Database Schema panel to the
Table Diagram panel. Any joins defined between primary keys in the database
are displayed.
For example:
This example demonstrates building a query that retrieves names of

customers that also have placed orders. After dragging the CUSTOMER and
SALES_ORDER tables from the Database Schema panel to the Table Diagram
panel, a join is automatically displayed between the CUSTOMER_ID column
in each table. You can also manually add joins by dragging the cursor from
one join column to the other.
Clicking the SQL tab in the SQL panel shows the automatically generated
syntax:
SELECT *
FROM DEMO.CUSTOMER, DEMO.SALES_ORDER
WHERE (DEMO.CUSTOMER.CUSTOMER_ID = DEMO.SALES_ORDER.CUSTOMER_ID)

154
| JDBC Palette
By default, all table columns are included in the query. To constrain query
syntax, click the Design tab in the SQL panel. You can drag individual
columns from the Table Diagram panel to the Add Column area of this tab to
refine the query. The Add Column entry is a placeholder only, and does not
affect the output. It is meant to be the area where you can drag columns from
the tables to add to the query.
The following example shows the results of dragging the CUSTOMER_ID,
NAME, TOTAL, and SALESPERSON_ID columns to the SQL tab:
Clicking the SQL tab to view the modified syntax shows the query now selects
only from the set of columns:
SELECT DEMO.CUSTOMER.CUSTOMER_ID, DEMO.CUSTOMER.NAME,
DEMO.CUSTOMER.SALESPERSON_ID, DEMO.SALES_ORDER.TOTAL
WHERE (DEMO.CUSTOMER.CUSTOMER_ID = DEMO.SALES_ORDER.CUSTOMER_ID)
2. To group sales by customer and show sales totals, perform the following:
— For the TOTAL column, click in the Total field and select Sum from the list.
The other columns are automatically updated to select the Group By value
required for this function.
— For the CUSTOMER_ID column, click the Show checkbox to deselect it.
This column is necessary for the query, but can be hidden in the output.
Clicking the SQL tab to view the syntax shows the SUM function and GROUP BY
clause has been added to the SQL:
SELECT DEMO.CUSTOMER.NAME, DEMO.CUSTOMER.SALESPERSON_ID,
SUM(DEMO.SALES_ORDER.TOTAL)
WHERE (DEMO.CUSTOMER.CUSTOMER_ID =
GROUP BY DEMO.CUSTOMER.CUSTOMER_ID, DEMO.CUSTOMER.NAME,
DEMO.CUSTOMER.SALESPERSON_ID
Other criteria can be applied using the Sort, Criteria, and Or fields.
3. To check the SQL syntax, click the Check Syntax button.
A dialog displays either a success message, or a database error code and
message.

Query Designer 155
|
4. After checking the syntax, click the Execute button on the Test tab to preview
the query results:
A representative number of rows, specified by the Max Rows value, is

returned.
5. When the query returns the desired result set, click OK.
The SQL syntax is automatically entered in the SQL Statement field of the
Database task.
The following usage restrictions apply to the Query Designer:

• You can build, modify, and test SQL queries only, not update statements or
stored procedures.
• Only queries that are automatically generated can be manipulated and
regenerated using the Design tab features. Query syntax that was manually
typed in the SQL Statement field can be modified by typing or dropping
column names on the SQL tab. The syntax checking and preview results
features can also be used.
• After manually editing an automatically generated query on the SQL tab,
your changes will be lost if you uncheck the Customize box on the SQL tab
and return to the Design tab.
• If you wish to select columns with the same name from different tables, you
must specify column aliases for the columns that have the same name. In SQL,
you may select columns with the same name from different tables in the same
SQL statement, however, TIBCO BusinessWorks requires that all names
within an input or output schema be unique. Therefore, you must specify
column aliases to ensure that all items within the output schema for a query
are unique.

156
| JDBC Palette
SQL Direct
The SQL Direct activity executes a SQL statement that you provide. This
activity allows you to build a SQL statement dynamically (using other
activities), then pass the SQL statement into this activity’s input. This
activity also allows you to execute SQL statements that are not supported by other
activities in the JDBC palette. For example, DDL commands (for example, CREATE
TABLE) are not available by using any other activity.
If this activity is not part of a transaction group, it is committed after it completes.

If this activity is part of a transaction group, it is committed or rolled back with
the other JDBC activities within the group at the end of the transaction. See TIBCO
BusinessWorks Process Design Guide for more information about creating groups
for transactions.
group.
Configuration
Field Description
process definition.

JDBC resources.
Timeout (sec) Time (in seconds) to wait for the query to complete. If
the query does not complete within the given time
limit, an error is returned.

SQL Direct 157
|
Field Description
Input

jdbcGeneralActivityInput Object The root class for the input of the
SQL Direct activity. This class
activity.
statement string The SQL statement you wish to

execute. You can use any process
variables to build the statement
dynamically, if desired.
Output

jdbcGeneralActivityOutput Object The root class for the output of the
SQL Direct activity. This class
activity

158
| JDBC Palette

noOfUpdates integer The number of updates performed
by the statement.
There could be more than one
statement performed (for example,
if a stored procedure is executed).
Because of this, this item is a list of
integers. Each item in the list
corresponds to the number of
updates performed by each
statement. The first integer in the
list is the number of updates
performed by the first statement
executed by this activity. The
second integer is the number of
updates performed by the second
statement, and so on.
unknownResultSet Object The result of the database

statement. The result object
depends upon what is returned by
the statement.
The result set is a list of zero or
more rows with zero or more
columns. Each column contains a
name and a value element. You can
use XPath expressions to retrieve
the desired row and column from
the result set.
There could be multiple result sets
returned by the statements
executed by this activity. Because of
this, this output item is a repeatable
list of result sets. The first item in
the list of result sets corresponds to
the result set returned by the first
statement executed by this activity.
The second item in the list of result
sets corresponds to the result set
returned by the second statement
executed by this activity, and so on.

| 159
Chapter 10 JMS Palette
Java Message Service (JMS) is a specification for how messages are sent and
received between applications in a Java environment.
The JMS palette is used to send and receive JMS messages within a process
definition. Both the JMS point-to-point (queues) and publish/subscribe (topics)
models are supported.
Refer to the documentation of your JMS provider or the JMS specification for
more information about JMS and its message models.
Topics
• JMS Properties, page 160

• JMS Queue Receiver, page 163
• JMS Queue Requestor, page 167
• JMS Queue Sender, page 173
• JMS Topic Publisher, page 177
• JMS Topic Requestor, page 181
• JMS Topic Subscriber, page 187
• Reply To JMS Message, page 191
• Wait for JMS Queue Message, page 195
• Wait for JMS Topic Message, page 200

160
| JMS Palette
JMS Properties
Table 1 table describes message headers and message properties used in JMS
messages. MessageHeader properties are set by the JMS application sending the
message and are available to view once the message is received.
MessageProperties can be set on outgoing messages using the Input tab of the
activity that sends the message.
Table 1 Properties for JMS Messages

Property Datatype Description
MessageHeaders
JMSDestination string Destination to where a message is

sent.
JMSReplyTo string The JMS application where the

reply message should be sent.
JMSDeliveryMode string The delivery mode of the message.

Can be one of the following:
• PERSISTENT — signifies the
messages are stored and
forwarded.
• NON_PERSISTENT —
messages are not stored and
may be lost due to failures in
transmission.
JMSMessageID string The unique ID of the message.
JMSTimestamp long The time a message was handed off

to a JMS provider to be sent. The
time is expressed as the amount of
time, in milliseconds, since
midnight, January 1, 1970, UTC.

JMS Properties 161
|

JMSExpiration long The expiration time of the message.
The time is expressed as the amount
of time, in milliseconds since
midnight, January 1, 1970, UTC. If
set to 0, the message does not
expire.
For outgoing messages, this is set
by specifying the "Time to live" field
on the activity’s configuration tab.
JMSRedelivered boolean Typically this item is set when the

JMS provider has delivered the
message at least once before.
JMSPriority integer The priority of the message.

Priority is a value from 0-9. Higher
numbers signify a higher priority
(that is, 9 is a higher priority than
8).
For outgoing messages, the default
priority is 4. This is set on the
activity’s Advanced tab.
JMSCorrelationID string This ID is used to link a response

message with its related request
message. This is usually the
message ID of a request message
when this field is found within a
reply message.
JMSType string The JMS provider-supplied string

to describe the type of the message.
Some JMS providers use this
property to define messages in the
provider’s repository. See your JMS
provider documentation for more
information about the use of this
field.

162
| JMS Palette

MessageProperties
JMSXUserID string The ID of the user sending the

message.
This property is optionally set on
incoming messages by the JMS
application. This property is not set
on outgoing messages.
JMSXAppID string The ID of the application sending

the message.
JMSXProducerTIXID string The transaction identifier of the

transaction within which this
message was produced.
JMSXConsumerTXID string The transaction identifier of the

transaction within which this
message was consumed.

JMS Queue Receiver 163
|

JSMXRcvTimestamp integer The time JMS delivered the
message to the consumer. The time
is expressed as the amount of time,
in milliseconds since midnight,
January 1, 1970, UTC.
JMSXDeliveryCount integer The number of delivery attempts

for this message.
JMSXGroupID string The identity of the message group

this message is a part of.
You can set this property on
outgoing messages to group
messages into a numbered
sequence.
JMSXGroupSeq integer The sequence number of this

message within its group.
You can set this property on
outgoing messages to group
messages into a numbered
sequence.
JMS Queue Receiver
Starts a process based on the receipt of a message for the specified

JMS queue.

164
| JMS Palette
Configuration
Field Description
process definition.
Queue Name of the queue of the incoming message.

The syntax of the queue name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about queue
names.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.

JMS Queue Receiver 165
|
Field Description
Output XML Schema XML Schema that describes the data of the incoming
message. This field allows you to specify an XML
schema to use for validating the body of the message.
The incoming message body is parsed into an XML
schema based on the schema definition specified in
this field.
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Acknowledge Mode The acknowledge mode for incoming messages. Can

be one of the following:
• Auto — the message is automatically
acknowledged when it is received.
• Client — the message will be acknowledged at a
later point by using the Confirm activity.
• Dups OK — the message is acknowledged
automatically when it is received. JMS provides
this mode for lazy acknowledgement, but
BusinessWorks acknowledges messages upon
receipt.
Max Sessions When the Acknowledge Mode field is set to "Client",

this field appears for specifying the maximum
number of JMS sessions to create for incoming
messages.
When a JMS queue message is received, the session is
blocked until the message is acknowledged. Because
the acknowledgement can come at a later time with
the Confirm activity, this field allows you to specify a
maximum number of new sessions to create to handle
incoming messages.
Once the maximum number of sessions is reached, no
new incoming messages can be processed. Once an
incoming message is confirmed, the total number of
active sessions is decreased and another incoming
message can be processed.

166
| JMS Palette
Advanced
Field Description
Message selector A string to determine whether a message should be
received. The syntax of the message selector is
determined by the JMS provider, but it is usually a
subset of SQL92 (where message properties are used
instead of table column names).
See your JMS provider documentation for more
information and syntax for a message selector string.
JMS Application Any application-specific message properties that will

Properties be part of the message. This is specified by the JMS
Application Properties shared configuration object.
Once specified, these properties appear on the Output
tab as "OtherProperties".
Data
The Data tab defines the schema to use for incoming messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the incoming message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Output tab.
of using the Data tab.
Output

ActivityOutput Object The root class for the output of the
JMS Queue Receiver activity. This
the activity.

JMS Queue Requestor 167
|

JMSHeaders Object The message header fields for the
message. See JMS Properties on
page 160 for more information
about message header fields.
Only properties applicable to this
type of message are displayed.
JMSProperties Object The message properties for the

about message properties.
OtherProperties Object If the JMS Application Properties

field is specified on the Advanced
tab, the OtherProperties group lists
the application-specific properties
in the selected JMS Application
Properties shared configuration
object.
Body depends The body of the message.

upon the
message
type
JMS Queue Requestor
The JMS Queue Requestor activity is used to send a request to a JMS

queue name and receive a response back from the JMS client.

168
| JMS Palette
Configuration
Field Description
process definition.
Queue Name of the queue of the outgoing message.

names.
connection.
following:
sequentially.

|
Field Description
Input XML Schema XML schema that describes the data of the outgoing
request.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
The body of the outgoing request is represented as an
XML schema in the Input tab.
Input Schema root Element within the XML schema to use when parsing
entire XML schema specified in the Input XML
Schema field.
response.
The body of the incoming response is represented as
an XML schema in the Output tab.
Schema field.

170
| JMS Palette
Advanced
Field Description
Delivery mode The delivery mode of the message. Can be one of the
following:
• PERSISTENT — signifies the messages are stored
and forwarded.
• NON_PERSISTENT — messages are not stored
and may be lost due to failures in transmission.
Time to live (secs) Corresponds to JMSExpiration property that specifies

how long the message can remain active (in seconds).
If set to 0, the message does not expire.
This field is set in seconds, but the JMSExpiration
property is displayed in milliseconds.
Priority Priority of the message. You may set the priority to a

value from 0-9. The default value is 4.

Input Data/Output Data

The Input Data/Output Data tabs define the schema to use for messages of type
"Map" or "Stream". Map messages are name/value pairs, and the schema allows
you to define the structure of the outgoing request and the incoming reply. The
schema defined on the Input Data tab becomes the body of the message on the
Input tab. The schema defined on the Output Data tab becomes the body of the
message on the Output tab.

|
Input

JMS Queue Requestor activity. This
activity.
destinationQueue string The queue to which to send the

request. This input item overrides
the Queue field on the
Configuration tab.
replyToQueue string The queue to which replies should

be sent for this request.
requestTimeout integer Corresponds to JMSExpiration

property that specifies how long
the message can remain active (in
seconds).
If set to 0, the message does not
expire.
This item is set in seconds, but the
JMSExpiration property is
displayed in milliseconds.
This item overrides the timeout set
on the Advanced tab.

reply message.

172
| JMS Palette


object.

upon
message
type
Output

JMS Queue Requestor activity. This
the activity.


JMS Queue Sender 173
|


object.

upon
message
type
JMS Queue Sender
The JMS Queue Sender activity sends a message to the specified

JMS queue.
Configuration
Field Description
process definition.

174
| JMS Palette
Field Description
Queue Name of the queue of the outgoing message.
names.
connection.
following:
sequentially.
• Text — the message is a java.lang.String
message.
The body of the outgoing message is represented as
an XML schema in the Input tab.
Schema field.

JMS Queue Sender 175
|
Advanced
Field Description
Reply-to destination The name of the queue to which replies should be
sent. This field is optional, and replies are sent to the
queue specified on the Configuration tab by default.
following:
and forwarded.



Data
The Data tab defines the schema to use for outgoing messages whose message
allows you to define the structure of the outgoing message. Once defined, the
displayed on the Input tab.

176
| JMS Palette
Input

JMS Queue Sender activity. This
activity.
destinationQueue string The queue to which to send the

the Queue field on the
Configuration tab.
replyToQueue string The queue to which replies should

be sent for this request. This input
item overrides the reply to
destination specified on the
Advanced tab.

reply message.


object.

JMS Topic Publisher 177
|

upon
message
type
Output

OutputClass Object The root class for the output of the
JMS Queue Sender activity. This
the activity.
MessageID string The unique identifier of the

message.
JMS Topic Publisher
The JMS Topic Publisher sends a message to the specified JMS topic.
Configuration
Field Description
process definition.

178
| JMS Palette
Field Description
Topic Name of the topic of the outgoing message.
The syntax of the topic name is specific to the JMS
documentation for more information about topic
names.
connection.
following:
sequentially.
message.
The body of the outgoing message is represented as
an XML schema in the Input tab.
Schema field.

JMS Topic Publisher 179
|
Advanced
Field Description
Reply-to destination The name of the topic to which replies should be sent.
This field is optional, and replies are sent to the topic
specified on the Configuration tab by default.
following:
and forwarded.



Data
The Data tab defines the schema to use for outgoing messages whose message

180
| JMS Palette
Input

JMS Topic Publisher activity. This
activity.
destinationTopic string The topic to which to send the

the Topic field on the
Configuration tab.
replyToTopic string The topic to which replies should

be sent for this request. This input
item overrides the Reply-to
destination on the Advanced tab.

reply message.


object.

JMS Topic Requestor 181
|

upon
message
type
Output

OutputClass Object The root class for the output of the
JMS Topic Publisher activity. This
the activity.
MessageID string The unique identifier of the

message.
JMS Topic Requestor
The JMS Topic Requestor activity is used to communicate with a JMS

application’s request-response service. This service invokes an
operation with input and output. The request is sent to a JMS topic and
the JMS application returns the response to the request.
Configuration
Field Description
process definition.

182
| JMS Palette
Field Description
names.
connection.
following:
sequentially.
request.
The body of the outgoing request is represented as an
XML schema in the Input tab.
Schema field.

|
Field Description
response.
The body of the incoming response is represented as
an XML schema in the Output tab.
Schema field.
Advanced
Field Description
following:
and forwarded.



184
| JMS Palette
Field Description
Input Data/Output Data

The Input Data/Output Data tabs define the schema to use for messages of type
"Map" or "Stream". Map messages are name/value pairs, and the schema allows
you to define the structure of the outgoing request and the incoming reply. The
schema defined on the Input Data tab becomes the body of the message on the
Input tab. The schema defined on the Output Data tab becomes the body of the
message on the Output tab.
Input

JMS Topic Requestor activity. This
activity.
destinationTopic string The topic to which to send the

the Topic field on the
Configuration tab.
replyToTopic string The topic to which replies should

be sent for this request.

|

requestTimeout integer Corresponds to JMSExpiration
property that specifies how long
the message can remain active (in
seconds).
If set to 0, the message does not
expire.
This item is set in seconds, but the
JMSExpiration property is
displayed in milliseconds.
This item overrides the timeout set
on the Advanced tab.

reply message.


object.

upon
message
type

186
| JMS Palette
Output

JMS Topic Requestor activity. This
the activity.



object.

upon
message
type

JMS Topic Subscriber 187
|
JMS Topic Subscriber
Starts a process based on the receipt of a message for the specified JMS
topic.
Configuration
Field Description
process definition.
Topic Name of the topic of the incoming message.

names.
connection.
Durable subscription Specifies a durable subscription.

You must specify a name in the Subscription name
field that is registered with the JMS application as the
durable subscription name.
Subscription name The subscription name registered with the JMS

application for durable subscriptions. Not specified
for non-durable subscriptions.

188
| JMS Palette
Field Description
following:
sequentially.
this field.
Schema field.

JMS Topic Subscriber 189
|
Field Description
Suppress local Specifies that this process starter should not receive
messages messages on the specified topic name when the
message was sent by the JMS application on the same
connection as the process engine.
If your process definition publishes and subscribes to
messages with the same topic name, this option is
useful if you wish to specify whether to receive
messages sent by yourself (that is, the same JMS
application that published the message).
Checking this field prevents the process from
receiving messages sent by the same connection.
Unchecking this option specifies messages sent by the
same connection should be received.
Acknowledge Mode The acknowledge mode for incoming messages. Can

be one of the following:
• Auto — the message is automatically
acknowledged when it is received.
• Client — the message will be acknowledged at a
later point by using the Confirm activity.
• Dups OK — the message is acknowledged
automatically when it is received. JMS provides
this mode for lazy acknowledgement, but
BusinessWorks acknowledges messages upon
receipt.
Max Sessions (Read When the Acknowledge Mode field is set to "Client",
Only) this read-only field appears to notify you that only
one session can receive incoming topic messages until
the message is confirmed.
When a JMS topic message is received, the session is
blocked until the message is acknowledged. Because
all sessions subscribed to JMS topics receive the same
messages, only one session can be actively listening
for new messages until each message is confirmed.

190
| JMS Palette
Advanced
Field Description

Data
Output

JMS Topic Subscriber activity. This
the activity.

Reply To JMS Message 191
|



object.

upon the
message
type
Reply To JMS Message
The Reply To JMS Message activity sends a reply to a previously

received JMS queue or topic message. The list of possible activities
that can receive JMS messages is given on the Configuration tab. The
activity that you select determines which message the reply message
is in response to.

192
| JMS Palette
Configuration
Field Description
process definition.
Reply To A drop-down list of activities that can receive JMS

queue or topic messages. The activity you select
determines which message this activity replies to. The
reply-to queue or topic name from the message in the
selected activity is used to send the reply message.
following:
sequentially.
Input XML Schema XML Schema that describes the data of the outgoing
reply. This field allows you to specify an XML schema
to use for validating the body of the message.
this field.

Reply To JMS Message 193
|
Field Description
Schema field.
Advanced
Field Description
Reply-to destination The name of the queue or topic to reply to. This
should be automatically handled by the JMSReplyTo
property of the incoming message from the activity
selected in the Reply To field on the Configuration
tab. If you wish the reply to go to a different queue or
topic, specify the name here.
following:
and forwarded.




194
| JMS Palette
Data
The Data tab defines the schema to use for outgoing replies whose message type
is "Map" or "Stream". Map messages are name/value pairs, and the schema
Input

Reply To JMS Message activity.
for the activity.

reply message.
By default, this is set to the
message ID of the message in the
Reply To field of the configuration
tab. You can override this value, if
desired with a different message
ID.


Wait for JMS Queue Message 195
|

object.

upon
message
type
Output
The activity has no output.
Wait for JMS Queue Message
The Wait for JMS Queue Message waits for the receipt of a
message for the specified JMS queue.
Configuration
Field Description
process definition.

196
| JMS Palette
Field Description
Queue Name of the queue of the incoming message.
names.
connection.
following:
sequentially.
this field.
Schema field.

|
Advanced
Field Description

Data

198
| JMS Palette
Event
Field Description
incoming message.
For example, you may have JMS Queue Sender
activity earlier in the process diagram and you are
expecting a message in response to the sent
message. You would place the JMSCorrelationID
from the header of the incoming message into the
Candidate Event Key field. You would then place
the JMSMessageID from the header of the outgoing
message earlier in the process in the "key" field on
the input tab.
expressions.

the Input tab, the Wait For JMS Queue Message activity proceeds.

|
Input



Output



200
| JMS Palette


object.

upon the
message
type
Wait for JMS Topic Message
The Wait for JMS Topic Message waits for the receipt of a message
for the specified JMS topic.
Configuration
Field Description
process definition.

Wait for JMS Topic Message 201
|
Field Description
names.
connection.
Subscription name The subscription name registered with the JMS

application for durable subscriptions. Not specified
for non-durable subscriptions.
following:
sequentially.
this field.

202
| JMS Palette
Field Description
Schema field.
Durable subscription Specifies a durable subscription.

You must specify a name in the Subscription name
field that is registered with the JMS application as the
durable subscription name.
Suppress local Specifies that this process starter should not receive
messages messages on the specified topic name when the
message was sent by the JMS application on the same
connection as the process engine.
If your process definition publishes and subscribes to
messages with the same topic name, this option is
useful if you wish to specify whether to receive
messages sent by yourself (that is, the same JMS
application that published the message).
Checking this field prevents the process from
receiving messages sent by the same connection.
Unchecking this option specifies messages sent by the
same connection should be received.
Advanced
Field Description

|
Field Description
Data

204
| JMS Palette
Event
Field Description
incoming message.
For example, you may have JMS Topic Publisher
activity earlier in the process diagram and you are
expecting a message in response to the sent
message. You would place the JMSCorrelationID
from the header of the incoming message into the
Candidate Event Key field. You would then place
the JMSMessageID from the header of the outgoing
message earlier in the process in the "key" field on
the input tab.
expressions.

the Input tab, the Wait For JMS Topic Message activity proceeds.

|
Input



Output



206
| JMS Palette

JMSProperties object The message properties for the

object.

upon the
message
type

| 207
Chapter 11 Mail Palette
The Mail palette is used to receive incoming email or send outgoing email.
Topics
• Receive Mail, page 208

• Send Mail, page 209

208
| Mail Palette
Receive Mail
The Receive Mail process starter polls a POP3 mail server for new
mail. When new mail is detected and retrieved, the Receive Mail
process starter starts a new process for the process definition it
resides in and passes the mail data to the next activity in the process
flow.
Configuration
Field Description
process definition.
Host Host name or IP address for the mail server.
User Name User name to use when logging into the POP3 server.
Password Password to use when logging into the POP3 server.
Polling Interval (sec) Polling interval (in seconds) to check for new mail.
The interval can be specified in milliseconds, seconds,
minutes, hours, and days.
Delete Mail If checked, mail will be deleted from the POP3 server
once the process starter has retrieved it.
Output

outputClass Object The root class for the output of the
Receive Mail process starter. This
the activity.

Send Mail 209
|

from string The email address of the sender of
the email.
to string The recipient list of the email.
cc string The cc (carbon copy) list of the

email.
bcc string The bcc (blind carbon copy) list of

the email.
subject string The subject of the email.
sentdate string The date the email was sent.
bodyText string The text of the email message.
attachmentNames string A list of names for each attachment

to the message. These names are
typically the file names of the
attachments.
attachmentData binary A list of attachments to the

message.
Send Mail
The Send Mail activity sends an email by way of a SMTP server.

210
| Mail Palette
Configuration
Field Description
process definition.
Host Host name for the SMTP server.
Input

mailActivityInput Object The root class for the input of the
Send Mail activity. This class
activity.
from string The email address of the sender.
to string The recipient list for the email.
cc string The cc (carbon copy) list for the

email.
bcc string The bcc (blind carbon copy) list for

the email.
subject string The subject of the email.
sentdate string The date stamp for the email.
bodyText string The text of the email message.

Send Mail 211
|

attachmentNames string A list of names for each attachment
to the message. These names are
typically the file names of the
attachments.
attachmentData binary A list of attachments to the

message.
Output

212
| Mail Palette

| 213
Chapter 12 Manual Work Palette
The Manual Work palette is useful for automated business processes that have a
few steps that require user interaction. The Manual Work palette works with
TIBCO InConcert to provide some workflow capability in automated business
processes.
Topics
• Overview of Manual Work, page 214

• Working With Documents, page 217
• Working With Tasks Assigned to a Role, page 218
• Interaction With TIBCO InConcert, page 223
• Assign Work, page 224
• Get Work Status, page 232
• Modify Work, page 236
• Wait for Completion, page 241

214
| Manual Work Palette
Overview of Manual Work
The Manual Work palette includes activities that you can add to your business
processes when the process requires user interaction for completion. For example,
your enterprise may provide international monetary transfers. Some of the steps
in this process can be automated, but a final approval or rejection may be required
by an approval clerk. The clerk views the transfer request in a web interface, and
then either approves or rejects the request.
Figure 12 illustrates an example business process that requires manual work. A
request for funds transfer is received, and the country of origin is checked. If the
transfer is local and under $100,000, the transfer is automatically approved. If the
transfer is international or over $100,000, the request is assigned to a pool of users
for approval. One user accepts the request, and approves or rejects it. If no one
accepts the request, the manual approval times out, and then the status of the
request is checked. If no errors were returned, then the work is still in the users’
queue, so the process waits for the completion of the manual work. If errors were
reported in the manual work, the work is marked as not approved and the
process completes.
Figure 12 An example business process with manual work

Overview of Manual Work 215
|
The Manual Work palette allows you to assign a task to a pool of users, check the
status of the task, change the status of the task, download documents associated
with a task, or wait for the completion of a task. TIBCO Administrator allows you
to create roles and assign users to roles. These roles are the pools of users to which
you can assign manual work tasks.
The Manual Work palette works with TIBCO InConcert to provide workflow
capabilities. Users and roles (groups of users) are defined in TIBCO
Administrator and then exported to TIBCO InConcert. An activity that assigns
work creates a TIBCO InConcert job. The job can be viewed and modified using
TIBCO BusinessWorks Manual Work Organizer web interface described in
Working With Tasks Assigned to a Role on page 218. This task can also be viewed
or modified using the TIBCO InConcert tools and APIs.
Table 2 describes the two shared configuration resources used when configuring
activities in the Manual Work palette.
Table 2 Shared configuration resources for manual work activities
Shared Configuration Resource Description

Workflow Schema The data associated with a manual work
task. This is the data a user needs to
complete the task. The user can change
any of the data associated with a task.
A Workflow Schema can be used to
provide "extended details" for a particular
manual work task. The schema specified
for extended details provides a
mechanism to pass information when a
task is delegated or routed to another
user. See Working with Tasks in the
Acquired List on page 221 for more
information about delegation and
routing. See the description of the
Advanced tab of Assign Work on
page 224 for more information about how
extended details are used.
Workflow Server Connection The connection to the TIBCO InConcert

workflow server. This server is used to
track and manage manual tasks.

216
Table 3 describes the general purpose of each of the activities in the Manual Work
palette.
Table 3 Description of activities in the Manual Work palette
Activity Description
Assign Work This activity creates a new task (with associated data)
and assigns it to the specified role. A user then
acquires the task, views the data supplied by the
activity, and completes the work.
The process definition can either wait for the user to
complete the work or it can continue processing and
later query for the status of the task.
Download Document Workflow schemas can contain elements to hold

documents. An example of a document is a loan
application that must be attached to a credit request.
The document may be any type, for example,
Microsoft Word, PDF, and so on.
Documents can be uploaded or downloaded to a
manual work task by way of the web interface
TIBCO BusinessWorks provides for managing
manual work tasks. This activity allows you to
download a document from an existing manual work
task into a process variable.
See Working With Documents on page 217 and
Download Document on page 229 for more
information about working with documents.
Get Work Status Retrieves the current status of a task that was
previously created with the Assign Work activity.
Normally you use this activity to determine if the
task has been completed or if there are any errors.
You can use the status to determine where to
conditionally transition to in the process definition. If
the status is Complete, you may want to transition to
the next step of the business process. You may want
to put the Get Work Status in a loop to check the
status periodically and transition out of the loop
when the status is marked as complete or an error is
returned.

Working With Documents 217
|
Table 3 Description of activities in the Manual Work palette
Activity Description
Modify Work This activity changes the status of an existing task
created with the Assign Work activity. You can
change the status to one of the following:
• Update — signifies the task has been updated
• Complete — signifies the task is complete
• Reassign — reassigns the task to a role
You would normally use the Modify Work task to
change the status of a task that has not been acquired
by any user or if errors have been returned.
Wait for Completion Waits for the specified period for the status of a task
to be set to Complete. This is useful if the timeout for
the Assign Work activity has passed and you wish to
wait for an additional amount of time.
If the original Assign Work has timed out, you may
wish to use the Modify Work activity to reassign the
task to a different role, and then use the Wait for
Completion activity to wait again for the task to be
complete.
Working With Documents
Documents can be associated with tasks created by the Assign Work activity. For
example, you may wish to attach a Microsoft Word document containing a loan
application to a credit approval task. These documents are managed by the
workflow server, and they can be of any type.
If you wish to associate documents with a task, the schema for the task must
contain one or more elements of type Document. This is a special datatype
available only for workflow schemas. Document is a complex datatype containing
two elements:
• name — a string element containing the name of the document (be sure to use
the proper file name extension so that the files can be easily opened using the
browser-based Manual Work Organizer).

218
• content — a binary element containing the document’s contents.

The workflow schema should contain one element of type Document for each
document you wish to associate with a particular manual work task.
The Assign Work activity creates a new manual work task with an associated
workflow schema. The schema contains the data a user needs to complete the
task. The web interface that TIBCO BusinessWorks provides displays all data
within the schema and allows users to upload or download documents in schema
elements of type Document.
You can upload a document to a task when the task is created with the Assign
Work activity by mapping data to the Document schema items in the Input tab of
the Assign Work activity. If you wish to retrieve a document from a task that has
already been created, you can use the Download Document activity to retrieve the
document from the task.
Working With Tasks Assigned to a Role
TIBCO BusinessWorks provides a simple web interface for viewing manual work
tasks assigned to users. This interface is named the TIBCO BusinessWorks
Manual Work Organizer. When you log into the web interface, you can see any
task that you have acquired. Logging in requires that you specify a valid
username, password, and TIBCO InConcert server name.
To log into the Manual Work Organizer, you must be a valid user created using
TIBCO Administrator. See the TIBCO Administrator documentation for more
information about creating users. When logging in, you can specify a proxy
TIBCO InConcert ICJava server name. This ICJava server allows you to log into
TIBCO InConcert servers that are not part of your network subnet. See the TIBCO
InConcert documentation for more information about configuring ICJava servers.
You can log in to the Manual Work Organizing by invoking the following URL:
http://<machine>:8080/administrator/servlet/bwmanualwork
where <machine> is the name of the machine where the TIBCO Administrator
server is installed.
Once you log in, each user is presented with lists of tasks:
• Acquired — the list of tasks the user is currently working on. This list is
shown by default when a user logs in.

Working With Tasks Assigned to a Role 219
|
• Ready — the tasks available to the role that the user belongs to. This is the list
of tasks that need to be acquired by one of the users in the role.
• Completed (last 7 days) — the tasks the user has completed. Only tasks
marked completed within the last seven days are displayed.
• Manage — a list created by a custom search of the existing manual work tasks.
This list is only visible to system administrators, and it is used to perform
administrative actions.
Table 4 describes the columns of the task lists.
Table 4 Task list columns
Column Description Show in List

Work Type The name of the task (the name of the Acquired
Assign Work activity in the process Ready
definition). This name is a link to the Completed
task’s details. Manage
Work Name The name of the TIBCO InConcert job Acquired

associated with this task. Ready
Completed
This name is assigned in the Work Name
Manage
input item for the Assign Work activity
that creates the job. You would normally
assign a descriptive name to the job so
that users can easily determine which
tasks they should acquire.
Status The current status of the task. The status Acquired

can be Ready, Complete, or Acquired. Ready
Completed
Manage
Priority The priority of the task. The priority can Acquired

be Low, Normal, or Urgent Ready
Manage
Due Date The due date for this task. Acquired

Ready
Manage
Ready Date The time the task was placed in the Ready
Ready list.
Completed Date The time the task was completed. Completed

220
Table 4 Task list columns
Column Description Show in List

Acquired Date The time the task was acquired. Acquired
Completed
Manage
You can sort the task lists based on any column in the list by clicking on the
column heading. You can also navigate to the previous, next, first, or last page in
the list. Figure 13 illustrates the task lists.
Figure 13 Task lists
You can select any task within a task list to view the detail of the task. You can
view the header, detail, or documents attached to a task. The Details tab allows
you to edit the task details. Figure 14 illustrates the task detail.
Figure 14 Task detail

Working With Tasks Assigned to a Role 221
|
Acquiring Tasks
When a task is assigned to a role, it is placed into the Ready list for each user in
the role. Users can view the Ready list, and select tasks to acquire. When a user
acquires a task, that task is removed from the Ready list and placed in the user’s
Acquired list. Once a user acquires a task, other users cannot view or modify the
task unless the user routes, delegates, transfers, or releases the task.
Working with Tasks in the Acquired List

A user’s Acquired list contains tasks the user can modify. The user can update the
task properties (data associated with the task) or upload or download documents
to attach to the task. The user can also perform the following commands:
Command Description
Complete Change the status of the task to Complete and move the
task to the Completed list.
A user performs this command after the user has
completed work on the task. For example, a user may
need to view the data in the task and then change the
Approved property to either true or false.
Release Releases the task from the user’s Acquired list and puts
the task back into the Ready list of the role.
Route Routes the task to another of role. The task then

appears in the Ready list of the users in the other role.
Delegate Delegates the task to another role, this is similar to

routing, except the user retains control of the task.
The task remains in the user’s Acquired list, but it is
also placed in the Ready list of the role the task was
delegated to. Once a user in the role completes the task,
the original user can review the task and then marks it
as complete.
Update (Save) Saves any changes made to properties of the task, but
does not change the status of the task.

222
Working with the Completed List

Once the Complete command is performed on a task, the task is moved to the
Completed task list. The user can view tasks completed within the last seven
days.
Administering Tasks
Users belonging to the admin role can perform administrative activities on tasks.
When an administrator logs into the task web interface, the administrator can
select the Manage list and query for tasks.
The user icdba is the predefined administrator in TIBCO InConcert. If you wish
to use this user to create users and roles and administer manual work tasks, you
must first create this user in TIBCO Administrator and grant the user the
necessary permissions.
To perform a query, the administrator must supply a role and a status to query for
tasks. The administrator can then supply a string to search for in the Work Type
field, and all tasks that contain the supplied string are returned. The
administrator can also supply date ranges in the Due Date, Completed Date,
Ready Date, or Acquired Date fields to search for tasks based on those criteria.
Once tasks are returned by a search, the administrator can perform the following
actions on each task or a selected range of tasks.
Command Description
Release (only for Releases the task from a user’s Acquired list and puts
acquired tasks) the task back into the Ready list of the role.
Transfer Reassigns the task to another user. The task is removed

from the user’s Acquired list then appears in the
specified user’s Acquired list.
Reassign Reassigns the task to another role. The task is then

placed in the Ready list for all users assigned to that
role.
Delete (only for Deletes the task from the completed list.
completed tasks)

Interaction With TIBCO InConcert 223
|
Interaction With TIBCO InConcert
The Assign Work activity creates a TIBCO InConcert job that runs on a TIBCO
InConcert server. You do not need to know a great deal about TIBCO InConcert to
perform simple workflow functions. However, TIBCO InConcert must be
installed and configured before you can use the Manual Work palette.
The Assign Work activity creates TIBCO InConcert jobs that can be viewed or
manipulated using the standard TIBCO InConcert facilities (that is, either the
ICWeb API, or any other TIBCO InConcert API). TIBCO BusinessWorks provides
an easy-to-use web interface for viewing, modifying, and completing manual
tasks. You can create your own ICWeb interface, if you prefer.

224
Assign Work
The Assign Work activity creates a manual work task and assigns it to
the specified role. Users can view tasks assigned to their role by
logging into the Manual Work web interface provided with TIBCO
BusinessWorks.
An Assign Work activity creates a standard TIBCO InConcert task. If you wish to
do more sophisticated task processing, all TIBCO InConcert tools and APIs can be
used to handle tasks created with the Assign Work activity.
Configuration
Field Description
process definition.
Work Details The Workflow Schema shared configuration resource

that defines the data to supply to the user. See
Workflow Schema on page 327 for more information.
Server Details The Workflow Server Connection shared

configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Assign To The name of the role to assign this task to. These users
and roles are created using TIBCO Administrator and
then exported to TIBCO InConcert.
Priority Assigns a priority to the task. The priority can be

Normal, Low, or Urgent. This priority is displayed in
the manual work web interface.
Wait for Completion Specifies that this activity should wait for status of the
task to be Complete before continuing on to the next
activity.

Assign Work 225
|
Field Description
Wait till The amount of time to wait for the status of the task to
change. This field is only valid when the Wait for
Response field is checked.
Advanced
Field Description
Extended Details The Workflow Schema shared configuration resource
that defines the data for use when a task is routed or
delegated to another user.
The Work Details field specifies the schema to use that
contains the global data for the task. Data in the Work
Details schema can be edited by all users that the task
is routed or delegated to. The Extended Details
schema is used to supply data that is passed on to the
next user the task is routed or delegated to.
Data in the Extended Details schema is manipulated
during the Route or Delegate operation. If you are
using the web interface supplied by TIBCO
BusinessWorks, extended details are not used, and
therefore you do not need to supply a schema for this
field.
If you are using TIBCO InConcert to create your own
interface for managing manual tasks, you can use this
schema to supply data that is passed onto the next
user. For example, you may create a schema to
contain notes to pass on to the next user. These notes
will only be available to the next user the task is
delegated or routed to, and if the task is routed or
delegated again, the user can supply new notes.
Input

226

AssignWorkInput object The root class for the input of the
Assign Work activity. This class
activity.
Header object This item contains information

about the manual work task’s
configuration.
WorkName string The name of the TIBCO InConcert

job. It is useful to assign a
descriptive name to the job so that
users can easily spot which jobs
they should acquire.
DueDate date The date when the task must be

completed.
AssignTo string The role the task should be

assigned to. This input item
overrides any value specified in the
Assign To field on the
Configuration tab.
Priority string The priority for the task. Can be

either "Low", "Normal", or
"Urgent". This input item overrides
any value specified in the Priority
field on the Configuration tab.
WaitTillSec integer The amount of time to wait for the

task to be marked as Complete.
This input item overrides any value
specified in the Wait Till field on
Details object The data schema (specified by the

Work Details field on the
Configuration tab) for input to the
task.

Assign Work 227
|

ExtendedDetails object The data schema (specified by the
Extended Details field on the
Advanced tab) to use for additional
data when delegating or routing
the task.
Output

AssignWorkOutput object The root class for the output of the
Assign Work activity. This class
activity.

configuration.
WorkName string The name of the task.
WorkStatus string The current status of the task.
WorkId string The system-assigned ID for the

task.

completed.
ReadyDate date The date the task was placed into

the user role’s Ready list.
AcquiredDate date If the task was acquired before this

activity completes, this contains the
date the task was acquired by a
user.
CompletedDate date If the task was marked as complete

before this activity completes, this
contains the date the task was
completed.

228

AssignedTo string The role the task was assigned to.
AcquiredBy string If the task was acquired before this

activity completes, this is the name
of the user that acquired the
activity.

"Urgent".
TrackingInfo Object An object containing any

information about the routing or
delegation for the task. Each time
the task is routed or delegated, the
From object contains information
about the user that performed the
delegation or routing. The To object
contains a list describing each user
the task has been delegated or
routed to.
From Object Contains information about the

user that last performed a routing
or delegation operation on the task.
This object contains strings with the
following information:
• AssignedBy — the user that last
performed the routing or
delegation.
• Action — the action performed,
either route or delegate.
• Action Date — the date the
action was performed.
• WorkID — the ID assigned to
this task.
• Note — any notes passed on
from the user performing the
routing or delegation.

Download Document 229
|

To Object Contains a list detailing
information about each user that
the task has been routed or
delegated to. This object contains
strings with the following
information:
• AssignedTo — the user the task
has been assigned to.
this task.
Details object The data schema for the task.
ExtendedDetails object The data schema for additional

the task.
Download Document
The Download Document activity downloads any documents

that have been uploaded to the specified manual task created
with the Assign Work activity. See Working With Documents on
page 217 for more information about working with a task’s documents.

230
Configuration
Field Description
process definition.
Use WorkId Specifies that you wish to use the system-generated

work ID to identify the task from which to download
a document. If this field is specified, the Download
From field is disabled and the work ID is supplied on
the activity’s Input tab.
Download From The Assign Work activity from which you wish to
download documents.

associated with the task. See Workflow Schema on
page 327 for more information.

Download All Specifies that all documents attached to this activity

Document(s) should be downloaded.
Download Specific If you do not download all documents, you can

download a specific document by selecting the
property containing the document in this field.
Input

Download Document 231
|

DownloadDocumentInput object The root class for the input of the
Download Document activity. This
activity.

configuration.

task. You can obtain this from the
output of the Assign Work task.
Output

DownloadDocumentOutput object The root class for the output of the
Download Document activity.
This class contains all output
Details object The Workflow Schema for the

manual task you selected in the
Configuration tab. This output
item contains only the schema
elements of type Document.
schema element of type object The name of the Workflow

Document Schema element that contains the
document.
If all documents for a manual
work task are downloaded, each
schema element containing a
document is listed in the output.
name string The name of the downloaded

document.

232

content binary The content of the downloaded
document.
Get Work Status
The Get Work Status activity is used to retrieve the current status of
the specified manual task from the TIBCO InConcert server.
Configuration
Field Description
process definition.

work ID to identify the task whose status you would
like to retrieve. If this field is specified, the Status of
field is disabled and the work ID is supplied on the
activity’s Input tab.
Status of The name of the Assign Work activity whose status

you wish to retrieve.



Get Work Status 233
|
Field Description
Extended Details The extended details (assigned on the Advanced tab
of the Assign Work activity) associated with this task.
Input

DownloadDocumentInput object The root class for the input of the
Get Work Status activity. This class
activity.

configuration.

Output

GetWorkStatusOutput object The root class for the output of the
Get Work Status activity. This class
activity.

configuration.

234


task.

completed.


user.

completed.

activity.

"Urgent".

routed to.

Get Work Status 235
|

delegation.
this task.

information:
this task.

236

ExtendedDetails object The data schema for additional
the task.
Modify Work
The Modify Work activity is used to change the status of a manual task
created by the Assign Work activity. This activity changes the status to
one of the following: Complete, Reassign, or Update.
Configuration
Field Description
process definition.

work ID to identify the task that you would like to
modify. If this field is specified, the Modify field is
disabled and the work ID is supplied on the activity’s
Input tab.
Modify The name of the Assign Work activity whose status

you wish to change.



Modify Work 237
|
Field Description
Action The action to perform on the activity to change its

status. The action can be one of the following:
• Update
• Complete
• Reassign
Assign To This field is only applicable if the Action field is set to

"Reassign". This field specifies the name of the role to
assign the manual work to.
Input

ModifyWorkInput object The root class for the input of the Modify
Work activity. This class contains all
input items for the activity.
Header object This item contains information about the

manual work task’s configuration.
The information contained in the header
is dependent upon the Configuration
fields of this activity and the action you
wish to perform on the manual work
task.
WorkId string The system-assigned ID for the task. You

can obtain this from the output of the
Assign Work task.
CompleteRoutedAnd boolean Specifies whether all routed and

DelegatedWork delegated tasks should also be marked as
complete.

238

ReAssignTo string The name of the role to reassign this
manual task to. This input item overrides
the value specified on the Configuration
tab.

completed.
Priority string The priority for the task. Can be either

"Low", "Normal", or "Urgent".
Output

ModifyWork object The root class for the output of the
Modify Work activity. This class
activity.

configuration.

task.

completed.


user.

Modify Work 239
|

completed.

activity.

"Urgent".

routed to.

240

delegation.
this task.

information:
this task.

Wait for Completion 241
|

Extended Details object The data schema for additional
the task.
Wait for Completion
The Wait for Completion activity is used to wait for an existing

manual task (created with the Assign Work activity) to complete.
The Assign Work activity specifies a time out, if the activity is
specified to be performed asynchronously. When that timeout expires, the Wait
for Completion activity can be used to wait additional time for the completion of
the manual task.
Configuration
Field Description
process definition.

work ID to identify the task that you would like to
wait for completion. If this field is specified, the Wait
for field is disabled and the work ID is supplied on
the activity’s Input tab.
Wait For The name of the Assign Work activity that you wish
to wait for completion.


242
Field Description

Wait Till The amount of time to wait for the status of the task to
change.
Input

WaitForCompletionInput object The root class for the input of the
Wait for Completion activity. This
activity.

configuration.

WaitTillSec integer The amount of time to wait for the

task to be marked as Complete.
This input item overrides any value
specified in the Wait Till field on

|
Output

WaitForCompletion object The root class for the output of the
Wait For Completion activity. This
the activity.

configuration.

task.

completed.


user.

completed.

activity.

244

"Urgent".

routed to.

delegation.
this task.

|

information:
this task.
Extended Details object The data schema for additional

the task.

246

| 247
Chapter 13 Parse Palette
The Parse palette provides activities for parsing and rendering formatted text.
This is useful if you wish to transform formatted lines of text into a data schema.
The text lines can be formatted by either delimiters separating each field or offsets
can be specified to determine where each field begins and ends. This is also useful
if you wish to transform a data schema into a formatted text string.
Topics
• Parse Data, page 248

• Render Data, page 253

248
| Parse Palette
Parse Data
The Parse Data activity takes a text string or input from a file and
processes it, turning it into a schema tree based on the specified Data
Format shared configuration.
You can use any mechanism to obtain or create a text string for processing. For
example, you can use the Read File activity to obtain text from a file, or you can
retrieve a text field from an adapter message. You can also specify a text file to
read using this activity.
Only files with ASCII or Unicode encoding can be read by this activity. If you
wish to read files that use another encoding, use the Read File activity to retrieve
the file contents into a process variable. Then use the process variable as input to
this activity.
You might use this activity in a number of situations. For example, you may have
a file that consists of multiple lines of comma-separated values (as in data
obtained from a spreadsheet). You may also want to insert that data into a
database table. To do this, read and parse the file into a data schema with the
Parse Data activity. Then use a JDBC Update activity to insert the data schema
into a database table.
Configuration
Field Description
process definition.
Data Format The Data Format shared configuration to use when

parsing the text input. See Data Format on page 304
for more information.
Input Type Specifies the type of input for this activity.

Input can either be a text string or a file. If the input is
a text string, supply the string to the textString
input item. If the input is a file, supply the file name
and location to the fileName input item.

Parse Data 249
|
Field Description
Encoding The encoding of the input file. This field is only
available when "File" is chosen in the Input Type field.
Only ASCII or Unicode encoded files can be read by
this activity. Use the Read File activity to read data
from files using other encodings.
Skip Blank Lines Skips any empty records when parsing the text input.
When this field is unchecked, parsing stops at the first
blank line encountered in the input.
Skip First Record Skips the first record of the file. This option is for
(Header) eliminating the header record, if desired.
Manually Specify Allows you to specify the record in the input where
Start Record you wish to start parsing.
This is useful if you have a large number of records
and you wish to read the input in parts (to minimize
memory usage). Checking this checkbox causes the
startRecord input item to appear. See Parsing a
Large Number of Records on page 251 for more
information on how to read the input stream in parts.
Input

Input object The root class for the input of the
Parse Data activity. This class
activity.
textString string The text string to parse. This input

item is only available when "String"
is specified in the Input Type field

250
| Parse Palette

fileName string The location and name of the file to
read. The file’s contents is used as
the input text string for this activity.
This input item is only available
when "File" is specified in the Input
Type field on the Configuration tab.
startRecord number The line number of the input

stream where you wish to begin
parsing. All lines before the
specified line are ignored. This
input item is only available if the
Manually Specify Start Record field
on the Configuration tab is
checked.
The input stream begins with line
number 0 (zero).
This is useful if you wish to read
the input stream in parts to
minimize memory usage. See
Parsing a Large Number of Records
on page 251 for more information.
noOfRecords number The number of records to read from

the input stream. Specify "-1" if you
wish to read all records in the input
stream.
This is useful if you wish to read
the input stream in parts to
minimize memory usage. See
on page 251 for more information.

Parse Data 251
|
Output

Output object The root class for the output of the
Parse Data activity. This class
activity.
Rows Object This output item contains the list of

parsed lines from the input. This is
useful to determine the number of
records parsed by this activity.
The schema specified by the Data
Format resource is contained
within this output item.
schema Object The schema containing the data

from the parsed input text. This
output item contains zero or more
parsed records.
done boolean true if no more records are

available for parsing. false if there
are more records available.
This output item is useful for
checking if there are no more
records in the input stream when
you are reading the input in parts
to preserve memory. See Parsing a
Large Number of Records on

The input for this activity is placed in a process variable and takes up memory as
it is being processed. If you are reading a large number of records from a file, the
process may consume significant machine resources. To avoid using too much
memory, you may wish to read the input in parts, parsing and processing a small
set of records before moving on to the next set.

252
| Parse Palette
To process a large number of records, follow this procedure:

1. Create a Parse Data activity.
2. Specify the fields on the Configuration tab. Check the checkbox for the
Manually Specify Start Record field.
3. Select the Parse Data activity and click the group icon on the toolbar to create
a group containing the Parse Data activity. See TIBCO BusinessWorks Process
Design Guide for more information about working with groups.
4. Specify "Repeat Until True Loop" as the Group action, and specify an index
name (for example, "i").
5. The loop should exit when the done output item for the Parse Data activity is
set to true. For example, the condition for the loop could be set to the
following: string($ParseData/Output/done) = string(true())
6. Set the noOfRecords input item for the Parse Data activity to the number of
records you wish to process for each execution of the loop.
7. If you do not check the Manually Specify Start Record field on the
Configuration tab of the Parse Data activity, the loop processes the specified
noOfRecords with each iteration until there are no more input records to
parse.
You can optionally check the Manually Specify Start Record field to specify
the startRecord on the Input tab. If you do this, you must create an XPath
expression to properly specify the starting record to read with each iteration of
the loop. For example, the count of records in the input starts at zero, so the
startRecord input item could be set to the current value of the loop index
minus one. For example, $i - 1.
The procedure above is a general guideline for creating a loop group for parsing a
large set of input records in parts. You may want to modify the procedure to
include additional processing of the records, or you may want to change the
XPath expressions to suit your business process.

Render Data 253
|
Render Data
The Render Data activity takes an instance of a data schema and

renders it as a text string. The schema processed is based on a
specified Data Format shared configuration.
You may wish to use this activity in a number of situations. For example, you may
retrieve a result set from a database table. You may then wish to format this result
set as a formatted text string (with line breaks between each row in the result set),
and then write that text string out to a file. You would use the Render Data
activity to render the data schema as a formatted text string. Then you would use
the Write File activity to write the string to a file.
Configuration
Field Description
process definition.
Data Format The Data Format shared configuration to use when

rendering the text output. See Data Format on
Input

Input object The root class for the input of the
Render Data activity. This class
activity.

254
| Parse Palette

schema object The data schema (specified by the
Data Format Configuration field) to
render as a text string.
Output

Output object The root class for the output of the
Render Data activity. This class
activity.
textString string The output text string as a result of

rendering the specified data
schema. Line breaks separate
records of the data schema.

| 255
Chapter 14 Rendezvous Palette
The Rendezvous palette allows you to send and receive TIBCO Rendezvous
messages. For more information about TIBCO Rendezvous, see the TIBCO
Rendezvous documentation.
Topics
• Publish Rendezvous Message, page 256

• Rendezvous Subscriber, page 258
• Reply to Rendezvous Request, page 260
• Send Rendezvous Request, page 262
• Wait for Rendezvous Message, page 265

256
| Rendezvous Palette
Publish Rendezvous Message
The Publish Rendezvous Message activity publishes a TIBCO

Rendezvous message on the given subject with the given message
content.
Configuration
Field Description
process definition.
Subject The subject on which to publish the TIBCO

Rendezvous message. You can override this value by
specifying a subject on the Input tab.
Transport The TIBCO Rendezvous transport parameters. These

are specified as a Rendezvous Transport shared
configuration resource. See Rendezvous Transport on
page 322 for more information about shared
configuration resources.
Pre-register Listener When using TIBCO Rendezvous Certified Messaging

(RVCM), this field specifies the cmname(s) of the
RVCM subscriber(s). This allows the publisher to
pre-register with any expected listeners. If multiple
cmnames are specified, separate each cmname with a
comma.

Publish Rendezvous Message 257
|
Field Description
Input Schema Specifies whether the input schema is shared
(available as a stored schema in the repository), or
custom. The input schema becomes the body of the
TIBCO Rendezvous message to send.
If the input schema is shared, you must locate the
stored schema using the Input Reference field. If the
input schema is custom, you must specify the fields of
the input schema using the Input Schema tab.
Input Reference The location of the shared schema to use as the input
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
XML Encoding If checked, this field sends the TIBCO Rendezvous

message as a single field named "xml". The datatype
of the field is RVXml.
Input Schema
The Input Schema tab allows you to define a custom schema for the TIBCO
Rendezvous message.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Output Schema tab becomes the body of the TIBCO Rendezvous message.
Input

pubInputType Object The root class for the input of the

258

subject string The subject of the TIBCO
Rendezvous message.
body object The body of the TIBCO

Rendezvous message.
Output
Rendezvous Subscriber
The Rendezvous Subscriber process starter creates a process when a

TIBCO Rendezvous message on the given subject is received.
Configuration
Field Description
process definition.
Subject The subject on which to listen for the TIBCO

Rendezvous message.


Rendezvous Subscriber 259
|
Field Description
XML Encoding If checked, this field receives the TIBCO Rendezvous
Output Schema Specifies whether the output schema is shared

custom. The output schema becomes the body of the
TIBCO Rendezvous message that is expected to be
received.
If the output schema is shared, you must locate the
stored schema using the Schema Reference field. If the
output schema is custom, you must specify the fields
of the output schema using the Output Schema tab.
Schema Reference The location of the shared schema to use as the output
Output Schema
The Output Schema tab allows you to define a custom schema for the TIBCO
Rendezvous message.
Input

260
Output

rveventSourceOutputClass Object The root class for the output of the
Rendezvous Subscriber activity.
for the activity.
replySubject string The reply subject of the TIBCO

Rendezvous message.

Rendezvous message.
Reply to Rendezvous Request
The Reply to Rendezvous Request activity is used to send a reply

to a received TIBCO Rendezvous message.
Configuration
Field Description
process definition.
Reply For The TIBCO Rendezvous activity or process starter

that received the request. This is a selection list of
available activities that can receive TIBCO
Rendezvous messages.

Reply to Rendezvous Request 261
|
Field Description
Reply Subject The reply subject of the received TIBCO Rendezvous
message. You can override this value by specifying a
subject on the Input tab.

custom. The input schema becomes the body of the
TIBCO Rendezvous reply that is send.
stored schema using the Input Reference field. If the
input schema is custom, you must specify the fields of
the input schema using the Output Schema tab.
Input Reference The location of the shared schema to use as the input
Output Schema
Rendezvous message.
Input

ReplyInputType Object The root class for the input of the
Reply to Rendezvous Request

262

Rendezvous message.

Rendezvous message.
Output
Send Rendezvous Request
The Send Rendezvous Request activity publishes a TIBCO

Rendezvous message on the given subject with the given message
content, and it expects a reply to the message on the given reply
subject and with the given reply message content. This activity
waits for a reply on the reply subject and outputs the content of the
reply.
Configuration
Field Description
process definition.
Subject The subject on which to publish the TIBCO

Rendezvous message. You can override this value by
specifying a subject on the Input tab.

Send Rendezvous Request 263
|
Field Description
Request Timeout The amount of time to wait (in milliseconds) for a

(msec) reply to the TIBCO Rendezvous message. If no reply
is received within the given time limit, an error is
returned.
Pre-register Listener When using TIBCO Rendezvous Certified Messaging

(RVCM), this field specifies the cmname(s) of the
RVCM subscriber(s). This allows the sender to
pre-register with any expected listeners. If multiple
cmnames are specified, separate each cmname with a
comma.

custom. The input schema becomes the body of
TIBCO Rendezvous request to send.
stored schema using the Input Ref field. If the input
schema is custom, you must specify the fields of the
input schema using the Input Schema tab.
Input Ref The location of the shared schema to use as the input

reply to the TIBCO Rendezvous request.
stored schema using the Output Ref field. If the

264
Field Description
Output Ref The location of the shared schema to use as the output
XML Encoding If checked, this field sends the TIBCO Rendezvous

Input/Ouput Schema
The Input Schema and Output Schema tabs allow you to define custom schemas
for the outgoing TIBCO Rendezvous request and the incoming TIBCO
Rendezvous response.
on the Data tab becomes the body of the TIBCO Rendezvous messages.
Input

RequestInputType Object The root class for the input of the

Rendezvous message.

Rendezvous message.

Rendezvous message.

Wait for Rendezvous Message 265
|
Output

RequestOutputType Object The root class for the output of the
Send Rendezvous Request activity.
for the activity.

Rendezvous message.

Rendezvous message.

Rendezvous message.
Wait for Rendezvous Message
The Wait for Rendezvous Message waits to receive a TIBCO

Rendezvous message with the given subject.
Configuration
Field Description
process definition.
Subject The subject on which to listen for the TIBCO

Rendezvous message.

266
Field Description

TIBCO Rendezvous message that is expected to be
received.
stored schema using the Schema Reference field. If the
Schema Reference The location of the shared schema to use as the output
Encode as XML If checked, this field receives the TIBCO Rendezvous

Output Schema
Rendezvous message.

Wait for Rendezvous Message 267
|
Event
Field Description
message.
For example, you may have a Publish Rendezvous
Message activity that sends a message with a
particular ID. You are expecting a reply message
that contains that same ID so that you can determine
the message is a response to your sent message. You
would specify the field of the incoming message
that contains your ID in the Candidate Event Key.
You would then use the message ID of the message
you sent earlier in the process as the "key" field in
the input.
expressions.

the Input tab, the Wait For Rendezvous Message activity proceeds.

268
Input

Wait for Rendezvous Message


Output

rveventSourceOutputClass Object The root class for the output of the
Rendezvous Subscriber activity.
for the activity.

Rendezvous message.

Rendezvous message. The
attributes of this object are specified

| 269
Chapter 15 SOAP Palette
Simple Object Access Protocol (SOAP) is a lightweight protocol for the exchange
of information between web services. The SOAP palette allows you do the
following:
• create process definitions that implement web services
• send a SOAP request to a web service and receive a reply from that service
• generate a WSDL file containing a concrete service description of any process
containing a SOAP Event Source process starter.
See the SOAP specification available at www.w3.org/TR/SOAP for more
information about SOAP.
Topics
• Retrieve Resources, page 270

• SOAP Event Source, page 273
• SOAP Request Reply, page 277
• SOAP Send Fault, page 283
• SOAP Send Reply, page 286

270
| SOAP Palette
Retrieve Resources
The Retrieve Resources activity generates a WSDL file containing

a concrete service description of any process definition that has a
SOAP Event Source process starter. This allows clients to access
the WSDL for a web service that is implemented by a TIBCO
BusinessWorks process definition. The client can then use the WSDL file to invoke
the web service.
Using Retrieve Resources

This activity is normally used in conjunction with an HTTP Receiver process
starter and an Send HTTP Response activity. The HTTP Receiver process starter
can receive an HTTP request and pass it along to the Retrieve Resources activity.
Retrieve Resources then creates a WSDL file dynamically. This file contains the
concrete service definition of the specified BusinessWorks process definition. The
process definition must have a Soap Event Source process starter in order for the
WSDL file to be generated.
You can then pass the output of the Retrieve Resources activity to the HTTP
Response activity to send the response back to the requestor.
Figure 15 illustrates a process definition using the Retrieve Resources activity.
Figure 15 Process definition using the Retrieve Resources activity
To use the Retrieve Resources activity, the HTTP request must have the following
form:
http://<host>:<port>/bw/services/<path>/<resource name>?wsdl
where host and port are the host name of the machine that is listening for the HTTP
request (the machine where this process instance is running) and port should be
the same port specified by the HTTP Receiver process starter. path is the location
of the resource or path in the project tree. resource name is the name of the process
definition.
For example, the following is an HTTP request that retrieves the WSDL file for the
process named GetPurchaseOrder stored within the folder Purchasing:
http://purch:8877/bw/services/Purchasing/GetPurchaseOrder?wsdl

Retrieve Resources 271
|
When sending the HTTP Response, set the Headers/Content-Type item on the
Input tab to "text/xml".
If you wish to test a process definition containing this activity, you must load the
process definition containing this activity along with the process definition
containing the SOAP Event Source process starter into the test window. For more
information about loading multiple process definitions when testing, see TIBCO
BusinessWorks Process Design Guide.
See the descriptions of the Input and Output tabs for this activity for more
information about binding the HTTP request to this activity’s input and binding
this activity’s output to an HTTP response.
Retrieving a WSIL File

You can retrieve a Web Services Inspection Language (WSIL) file containing a list
of all configured web services. Any process definitions with SOAP Event Source
process starters within the project will be contained in the WSIL file.
The same process definition that accepts incoming HTTP requests and returns
WSDL resources (described in the previous section) can be used to return the
WSIL file. If you issue an HTTP request in the following form, a WSIL file
containing a list of all web services is returned:
http://<host>:<port>/bw/inspection/inspection.wsil
Configuration
Field Description
process definition.
Input

272
| SOAP Palette

inputClass Object The root class for the input of the
Retrieve Resources activity. This
activity.
resourcePath string The process name (and its location

in the project tree) for which you
wish to generate the WSDL file.
Only processes with SOAP Event
Source process starters can be used
with this activity.
This item can override the path and
resource specified by the incoming
HTTP request.
filter string This signifies what type of

information the activity should
return. This should be "wsdl"
because that is the only type of
information that this activity can
return.
Normally, this is obtained from the
query string for the HTTP Receiver
activity (see the example HTTP
request above). However, if you
wish clients to not specify the query
string on the HTTP request, you
can specify "wsdl" in this input
item to override the query sting of
the incoming HTTP request.
hostname string The hostname to specify for the

concrete service endpoint in the
dynamically generated WSDL file.
This value becomes part of the
service’s address in the generated
file.

SOAP Event Source 273
|

port string The port number to specify for the
concrete service endpoint in the
dynamically generated WSDL file.
This value becomes part of the
service’s address in the generated
file.
Output

outputClass Object The root class for the output of the
Retrieve Resources activity. This
the activity.
resourceData string The generated WSDL file that can

be used by a client to invoke the
specified process as a web service.
You can pass this data back to the
HTTP requestor by using an HTTP
Send Response activity and
binding this value to the
binaryContent or asciiContent of
the response.
SOAP Event Source
The SOAP Event Source process starter creates a process instance

for incoming SOAP requests. SOAP is a standard protocol for
invoking web services. This allows you to create process
definitions that implement web services.

274
| SOAP Palette
At runtime, a client can retrieve the WSDL file for a process containing this
process starter using an HTTP request (see the description of the Retrieve
Resources activity for more information). Once the WSDL is retrieved, the client
can perform a SOAP request to invoke the web service.
When using the SOAP Event Source activity to create a web service, the web
service uses "literal" encoding and is of type "document". See the SOAP
specification for more information about the types of web services and the
encoding used in a web service.
Configuration
Field Description
process definition.
WSDL File The stored WSDL file that contains the abstract
service description. This is specified or imported as a
shared configuration resource. See WSDL File on
page 329 for more information about abstract and
concrete service descriptions.
The stored service description can be either abstract
or concrete, but because the process definition is the
implementation of the web service, any concrete
endpoint binding is ignored.
The best practice is to generate an abstract service
description using the WSDL File shared configuration
resource. Then use that abstract service description
for this activity’s service.
However, you may wish to use an existing WSDL file
as a template for your service. If there is an existing
concrete service description, you can also use that for
this activity, but the concrete endpoint information
will be replaced by BusinessWorks’ endpoint binding
when the Retrieve Resources activity is used to
generate the WSDL File.

SOAP Event Source 275
|
Field Description
Service The name of the web service that this process
definition represents.
You can use the Select button to bring up the Select a
Resource dialog. This dialog allows you to select the
available operations and the service from the
specified WSDL file. The Operation and Endpoint
URL fields will then be populated by the choices
made in this dialog.
Operation The operation that this process definition implements.

This field is automatically populated when an
operation is selected using the Select a Resource
dialog (see the Service field for more information).
Transport The HTTP Connection where incoming SOAP

requests are received. See HTTP Connection on
The HTTP Connection can specify that the Secure
Sockets (HTTPS) protocol is used.
Authentication When checked, this field specifies that incoming

SOAP requests must supply a valid username and
password.
The user name and password specified in the
incoming request must exist in the domain (users are
created and managed within the domain using
TIBCO Administrator).
Output

inputMessage Object The root class for the output of the
SOAP Event Source. This class
activity.

276
| SOAP Palette

schema The output schema specified in the
WSDL file.
headers Object The header data supplied by the

SOAP request. The structure of this
input item is defined by the schema
on the Input Headers tab.
headers Object Any headers supplied by the

incoming SOAP request and
specified on the Input Headers tab.
The headers are stored in an object
named Header.<schema-name>
where <schema-name> is the name of
the schema specified on the Input
Headers tab.
The Header.<schema-name> object
also contains an item named
@mustUnderstand. This boolean
value is set to true in the incoming
request if the client specifies that
the server must understand the
header.
Input Headers
The Input Headers tab allows you to define a custom schema used for any
headers supplied by the incoming SOAP request. The specified input header is
also specified in the concrete bindings in the WSDL file created by this process
starter.
When an incoming request supplies a header, the SOAP Event Source process
starter places the information contained in the header into the output process
variables for the SOAP Event Source. The header information is then available to
subsequent activities in the process definition.
You can define your own datatype on this tab, and you can reference XML
elements stored in the project. Once defined, the data specified on the Input
Headers tab becomes part of the Output schema for this activity.
of how to specify custom schemas.

SOAP Request Reply 277
|
Output Headers
The Output Headers tab allows you to define a custom schema used for any
headers supplied for the reply to the SOAP request. Once defined, the data
specified on the Output Headers tab becomes part of the Input schema for the
SOAP Send Reply activity that is used to send the reply for the incoming SOAP
request.
You can define your own datatype on this tab, and you can reference XML
elements stored in the project.
of how to specify custom schemas.
Service Description
This tab displays the WSDL file that can be used to call the web service
implemented by this activity. This information is presented for display purposes
only, and this file cannot be edited. You can copy this WSDL file and send it to
anyone who wishes to invoke the web service for this process.
Normally, an application would use a web request to retrieve the WSDL file of a
web service (see the description of the Retrieve Resources activity for more
information about sending a WSDL file as a response to a web request). This tab
allows you to see the WSDL file that contains the concrete service description for
this process.
SOAP Request Reply
The SOAP Request Reply activity performs a request on the

specified web service and expects a reply from the web service.
You can invoke both document and RPC web services with this
activity.

278
| SOAP Palette
Configuration
Field Description
process definition.
WSDL File The WSDL file that describes the web service. This is
imported as a shared configuration resource. See
WSDL File on page 329 for more information about
SOAP resources.
Service The name of the web service. The service specified

must be a concrete service that has a binding to an
actual network endpoint.
You can use the Select button to bring up the Select a
Resource dialog. This dialog allows you to select the
available services and operations from the specified
WSDL file. The Service, Operation, and Endpoint
URL fields will then be populated by the choices
made in this dialog.
Operation The operation that this process definition implements.

This field is automatically populated when an
operation is selected using the Select a Resource
dialog (see the Service field for more information).
Endpoint URL The URL of the web service that you are sending a
request to. This field is automatically populated with
the choice made when selecting the service.
You can specify URLs that use the HTTPS (secure
sockets) protocol. If you specify HTTPS as the
protocol, the Server Certificate, Client Keystore,
Keystore Password, and Keystore Type fields appear.
For more information about creating keystores for
private keys and trusted certificate chains, see
http://java.sun.com/j2se/1.3/docs/tooldocs/win32
/keytool.html.

|
Field Description
Action The soapAction header for the operation. See the
SOAP specification for more information about
soapAction.
Timeout (secs) The time to wait (in seconds) for the operation to
complete.
Use HTTP Proxy When checked, this field specifies that an HTTP proxy
server is used to connect to the SOAP server. Enabling
this field causes the Proxy field to appear.
Proxy Appears when the Use HTTP Proxy field is enabled.

This field specifies the Proxy Configuration shared
configuration resource that describes the HTTP proxy
server. See Proxy Configuration on page 321 for more
information.
Use Basic When checked, this field specifies that you wish to
Authentication supply a username and password to the SOAP server.
The Username and Password fields appear when this
field is enabled.
Username Appears when the Use Basic Authentication field is

enabled. This field specifies the username to send to
the SOAP server for authentication.
Password Appears when the Use Basic Authentication field is

enabled. This field specifies the password to send to
the SOAP server for authentication.
Trusted Certificates Only available when HTTPS is the specified protocol

in the Endpoint URL field.
This field specifies the Trusted CA shared
configuration resource. This certificate should contain
the list of certificate authorities the client will accept
for sever certificates. The server’s certificate is
checked against this list, and if the certificate is not
from a listed certificate authority, the connection is
refused.

280
| SOAP Palette
Field Description
Client Keystore Only available when HTTPS is the specified protocol
This field specifies the location of the client’s digital
certificate and private key.
Keystore Password Only available when HTTPS is the specified protocol

This field specifies the client’s password for its private
key.
Key Store Type Only available when HTTPS is the specified protocol
The file type for the trusted certificate. This file type
can be Java Key Store (JKS) or PKCS12.
Verify Host Name Only available when HTTPS is the specified protocol
This field specifies that the host name of the HTTP
server should be checked against the host name listed
in the server’s digital certificate. This provides
additional verification that the host name you believe
you are connecting to is in fact the desired host.
If the host name specified in the Endpoint URL field
on the Configuration tab is not an exact match to the
host name specified in the server’s digital certificate,
the connection is refused.
Note: If you specify an equivalent hostname (for
example, an IP address) in the Endpoint URL field,
but the name is not an exact match of the hostname in
the host’s digital certificate, the connection is refused.
Input

|

inputMessage or Object The root class for the input of the
<operationName> SOAP Request Reply activity. This
activity.
If this is a document request, the
input is named inputMessage. If
the request is an RPC, the input is
the name of the operation.
schema The input schema specified in the

WSDL file. Each of the schema
elements are available in this dialog
for mapping.
_configData object Specifies the values to use to

override the Endpoint URL or
Action fields on the Configuration
tab, if desired.
endpointURL string Specifies the Endpoint URL of the

WSDL file to use for the SOAP
request. Specifying a value in this
input item overrides any value
specified in the Endpoint URL field
soapAction string Specifies he soapAction header for

the operation. See the SOAP
specification for more information
about soapAction.
Specifying a value in this input
in the Action field on the
Configuration tab.

282
| SOAP Palette

headers Object Any input headers defined in the
WSDL file. The headers are stored
in an object named
Header.<schema-name> where
<schema-name> is the element name
of the input header schema.
@mustUnderstand. Set this boolean
value to true if you wish to specify
that the SOAP server must
understand the header.
Output

outputMessage or Object The root class for the output of the
SOAP Request Reply activity. This
<operationName>Response
the activity.
If this is a document request, the
output is named outputMessage. If
the request is an RPC, the output is
the name of the operation with
"Response" appended.
schema The output schema specified in the

WSDL file. Each of the schema
elements are displayed in this
dialog.

SOAP Send Fault 283
|

headers Object Any output headers defined in the
WSDL file. The headers are stored
in an object named
<schema-name> is the element name
of the output header schema.
value is set to true if the server
specifies that the SOAP client must
understand the header.
Error Output
This tab lists the possible output in the event of an error. Errors are described by
fault schemas defined in the WSDL file (see WSDL File on page 329 for
information on creating fault schemas in generated WSDL files). The errors are
presented as a choice element that can contain any of the defined SOAP fault
schemas in the WSDL file for the specified operation, or the element can contain
the defaultFault schema.
If a fault is returned by the SOAP server, you can use an error transition out of the
SOAP Request Reply activity to go to a set of activities to be performed in the
event of an error. The activities after the error transition can access a process
variable named $_error_<activity-name> where <activity-name> is the name of the
SOAP Request Reply activity. This process variable contains the fault schema
returned by the SOAP server.
Handling of SOAP faults is similar to handling errors from other activities. See
TIBCO BusinessWorks Process Design Guide for more information on error
handling.
SOAP Send Fault
The SOAP Send Fault activity sends a predefined fault schema to

the client if an error occurs during processing of a SOAP request.

284
| SOAP Palette
This activity is used when the SOAP Event Source process starter is handles
incoming SOAP requests. The WSDL file for the request can have one or more
defined fault schemas for any operation (for generated WSDL files, see WSDL File
on page 329 for a description of creating fault schemas). The SOAP Send Fault
activity can use the fault schema to send application-specific data about the fault
back to the client that made the SOAP request.
This activity cannot be used if the SOAP request is one way.
The fault schema must be a valid XSD schema. You can map data to the schema
on the Input tab, and this data is returned to the client along with the required
fault information.
SOAP faults are required to send the fault code and the fault string. These values
are required input items on the Input tab. See the SOAP specification at
www.w3.org/TR/SOAP for more information about the syntax of SOAP fault
codes.
Configuration
Field Description
process definition.
Reply To The SOAP Event Source process starter.
Fault Details The name of the fault schema to send. This field
provides a drop-down list of the fault schemas
defined in the WSDL file specified for the SOAP
Event Source process starter.
You must select one of the fault schemas to return to
the client, and that schema becomes part of the input
schema for this activity’s Input tab.
The option <Default> is always available and can be
used to send the default fault schema.

SOAP Send Fault 285
|
Input

FaultMessage Object The root class for the input of the
SOAP Send Fault activity. This class
activity.
faultcode string The SOAP specification defines a

specific syntax for faultcodes
returned by a SOAP fault. See the
SOAP specification for more
information on how to specify a
faultcode.
faultstring string The faultstring is a message to pass

back to the client describing the
fault.
faultfactor string The faultactor element is intended

to provide information about who
caused the fault to happen within
the message path. It is similar to the
SOAP actor attribute but instead of
indicating the destination of the
header entry, it indicates the source
of the fault.
The value of the faultactor attribute
is a URI identifying the source of
the fault. You may use the
faultactor element to indicate
explicitly that this TIBCO
BusinessWorks process generated
the fault.

286
| SOAP Palette

detail Object The fault schema specified by the
Fault Details field on the
Configuration tab. This schema is
used to pass application-specific
data back to the client in the event
of a fault.
Output
SOAP Send Reply
The SOAP Send Reply activity sends a reply to an application that

sent a SOAP request. This activity is primarily used within process
definitions that implement web services. When a SOAP Event
Source is used as the process starter, the SOAP Send Reply activity is
used to send the reply to the request that starts the process instance.
This activity cannot be used if the SOAP request is one way.
Configuration
Field Description
process definition.
Reply To The SOAP Event Source process starter that received

the request.

SOAP Send Reply 287
|
Input

outputMessage Object The root class for the input of the
SOAP Send Reply activity. This
activity.
schema The output schema of the operation

for the selected SOAP request. Each
of the schema elements are
available in this dialog for
mapping.
headers Object Any headers specified on the

Output Headers tab of the SOAP
Event Source process starter that is
specified on the Configuration tab
of this activity. The headers are
stored in an object named
<schema-name> is the name of the
schema specified on the Output
Headers tab.
value is set to true if you wish to
specify that the client must
understand the header of the reply.
Output

288
| SOAP Palette

| 289
Chapter 16 XML Palette
The XML palette provides activities for parsing XML strings into schemas and
rendering schemas into XML strings.
Topics
• Parse XML, page 290

• Render XML, page 292
• Transform XML, page 294

290
| XML Palette
Parse XML
The Parse XML activity takes a binary XML file or an XML string and
processes it, turning it into an XML schema tree based on the XSD or
DTD specified.
The preferred way to parse XML files is to use a Read File activity set to
binary mode to read the XML file. Then pass the binary file contents to the Parse
XML activity.
Parsing Date and Datetime Strings

In XML documents parsed by the XML Parser activity, datetime values are read in
according to the ISO-8601 standard, as described in the XML Schema
specification. For example, the value:
2002-02-10T14:55:31.112-08:00
is 55 minutes, 31 seconds, and 112 milliseconds after 2PM on February 10th, 2002
in a timezone that is 8 hours, 0 minutes behind UTC.
If no timezone field is present, the value is interpreted in the timezone of the
machine that is performing the parsing. This can lead to complications if you are
processing XML from different timezones, so you are encouraged to always use
timezones.
Configuration
Field Description
process definition.
Schema The XSD or DTD file to use when parsing the XML
string. This schema file is specified as a shared
configuration resource that can be used by many
activities. See Schema Definition on page 326 for more
information about XML resources.
Element Element within the XSD or DTD file to use when

parsing the XML string.

Parse XML 291
|
Field Description
Input Style Can be binary, text, or dynamic.
In binary mode (the default and preferred choice), the
binary content is read. The encoding used for parsing
the content is either the default encoding specified in
the XML or you can specify encoding using the
"forceEncoding" input item.
In text mode, an XML string is passes as an input
item.
In dynamic mode, a choice is offered for input. You
can either supply binary or text input. You can use a
choice statement and set substitution in the mapping
to supply the correct type of input at run time.
Input

xmlString string The XML string to parse.
xmlBinary object Available when the Input Style

configuration field is set to binary.
This input item contains a required
bytes item for which you specify
the input XML bytes.
This input item also contains an
optional forceEncoding item. This
is a string that specifies the
encoding to use when parsing the
XML. You can specify any encoding
supported by Java on the system
where TIBCO BusinessWorks is
running. If this item is left blank,
the encoding specified in the XML
is used.

292
| XML Palette

xmlBinary|xmlString choice Available when the Input Style
configuration field is set to
dynamic.
This allows you to specify a choice
statement and set substitution and
supply the correct input type at
runtime.
Output

XML Schema Object The parsed XML schema is the
output of this activity. The contents
of the schema are determined by
the specified XSD or DTD file.
Render XML
The Render XML activity takes an instance of an XML schema

element and renders it as a stream of bytes containing XML or an
XML string. The schema is processed based on the XSD file specified.
Rendering Date and Datetime Strings

WhenTIBCO BusinessWorks generates datetime strings, it always uses UTC time.
For example, the time 55 minutes, 31 seconds, and 112 milliseconds after 2PM on
February 10th, 2002 would be represented as the following by the Render XML
activity:
2002-02-10T14:55:31.112Z

Render XML 293
|
Configuration
Field Description
process definition.
Schema The XSD or DTD file to use when rendering the XML
schema. This schema file is specified as a shared
configuration resource that can be used by many
activities. See Schema Definition on page 326 for more
information about XML resources.
Element Element within the XSD or DTD file to use when

rendering the XML schema.
Text-only Output Specifies that the output should be text when this
checkbox is checked. If this field is unchecked, the
output is a stream of bytes.
When this field is unchecked (binary output), an
optional byteEncoding input item is available.
Input

XML Schema string The XML schema to render. The
contents of the schema are
determined by the specified XSD or
DTD file.

294
| XML Palette

byteEncoding string This is a string that specifies the
encoding to use when rendering
the XML. You can specify any
encoding supported by Java on the
system where TIBCO
BusinessWorks is running. If this
item is left blank, the encoding
specified in the XML is used.
Output

xmlString string Available when the Text-only
Output configuration field is
checked. This item contains the
rendered XML string.
xmlBytes bytes Available when the Text-only

Output configuration field is
unchecked. This item contains a
stream of bytes representing the
rendered XML.
Transform XML
The Transform XML activity allows you to transform an input XML

document into the output specified by the given XSLT File shared
configuration resource.
Normally, transformation of data occurs by mapping process variables to an
activity’s input and applying XPath expressions to perform any transformation. If
you have an XSLT file that you are using for transformations, or if you are
supplied with an XSLT file from an outside source, this activity allows you to use
the XSLT file instead of manually creating the mappings.

Transform XML 295
|
For more information about creating and editing XSLT files, see the XSLT
specification at http://www.w3.org/TR/xslt. For more information about
creating an XSLT File shared configuration resource see XSLT File on page 336.
See Example of Transforming XML on page 297 for an example of using the
Transform XML activity.
Configuration
Field Description
Stylesheet Resource The XSLT File shared configuration resource to use

when transforming the XML.
See XSLT File on page 336 for more information.
Input

input Object The root class for the input of the for
Transform XML activity. This class
contains all input items for the activity.
xmlInput binary The XML to transform. This input item

is binary, so if you are handling an
XML string, you must use the
string-to-base64() XPath function
to convert the input XML string into a
binary value.

296
| XML Palette

stylesheet binary The XSLT stylesheet. The stylesheet
supplied in this input item overrides
the stylesheet supplied on the
Configuration tab.
This input item is binary, so if you are
handling the stylesheet as a string, you
must use the string-to-base64()
XPath function to convert the stylesheet
into a binary value.
parameter Object This object contains the input

parameter for the style sheet. If you
have more than one input parameter,
use the Modify Statement button to
create a List statement. You can specify
a list containing the desired number of
input parameters.
Each input parameter is specified as
name/value pairs. The name is a string
that corresponds to the name of the
parameter specified in the XSLT
stylesheet parameter list.
name string The name of the stylesheet input

parameter.
value string The value to supply for the specified

stylesheet input parameter.
Output

output Object The root class for the output of the for
Transform XML activity. This class
activity.

Transform XML 297
|

xmlOutput binary A binary value containing the output
schema specified by the XSLT file.
Example of Transforming XML

The following is an example of using the Transform XML activity to change an
input XML document into the desired output schema. In this example, books are
cataloged and processed. The user specifies an XML file containing a book’s
information into a web interface, and the web input form supplies a new catalog
number and the date it was entered into the catalog. The process definition
accepts the incoming web request, transforms the XML and adds the catalog
number and date, parses the output XML into a schema, then enters the data into
a database. Figure 16 illustrates the process definition for this example.
Figure 16 A process definition using the Transform XML activity
The Transform XML activity uses an XSLT file that accepts two input parameters,
catalogNumber and catalogDate. These input parameters are added as elements
to the Book schema. The following is the source of the XSLT File shared
configuration resource for the example Transform XML activity:
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="1.0"
xmlns:pfx="http://www.books.org">
<xsl:param name="catalogNumber"> </xsl:param>
<xsl:param name="catalogDate"> </xsl:param>
<xsl:template match="/*">
<pfx:BookStore>
<xsl:for-each select="Book">
<xsl:call-template name="handle-book">
<xsl:with-param name="inDate" select="$catalogDate"/>
</xsl:call-template>
</xsl:for-each>
</pfx:BookStore>
</xsl:template>
<xsl:template name ="handle-book">
<xsl:param name="inDate"> </xsl:param>
<pfx:Book>
<pfx:Title><xsl:value-of select="Title"/></pfx:Title>
<pfx:Author><xsl:value-of select="Author"/></pfx:Author>
<pfx:Date><xsl:value-of select="$inDate"/></pfx:Date>
<pfx:ISBN><xsl:value-of
select="$catalogNumber"/></pfx:ISBN>

298
| XML Palette
<pfx:Publisher><xsl:value-of
select=""TIBCO Software Inc./></pfx:Publisher>
</pfx:Book>
</xsl:template>
</xsl:stylesheet>
When you configure the Transform XML activity, you specify the incoming XML
to transform as well as any input parameters to the schema. Figure 17 illustrates
the input for the example Transform XML activity.
Figure 17 Input for the example Transform XML activity
The process variable containing the XML for the book is a string. The function
string-to-base64($ProcessBook/parameters/book) converts the incoming
XML string into the binary value required for input to the Transform XML
activity.
Also, the stylesheet has two input parameters. By default, only one input
parameter is supplied for input into the Transform XML activity. To supply more
than one value, use the Modify Statement button to create a list statement. In this
case, the list has two items, one for each of the input parameters of the stylesheet.
Each parameter is specified as a name/value pair. Notice that the name of each
parameter corresponds to the name specified for that parameter in the XSLT file.
The output of the Transform XML activity is a binary stream containing the
parsed XML. In our example process definition, we must insert the transformed
data into a database table. To map the transformed data into the database
UPDATE statement, the data must first be represented as a schema. To do this, we
use the Parse XML activity to parse the binary output of Transform XML into an
XML schema. Figure 18 illustrates the mapping of the Transform XML output into
the input of the Parse XML activity.

Transform XML 299
|
Figure 18 Input for the example Parse XML activity
The Parse XML activity requires a string for input. The function
base64-to-string($TransformXML/xmlOutput) converts the binary output of
the Transform XML activity into the string required by the Parse XML activity.

300
| XML Palette

| 301
Chapter 17 Shared Configuration Palette
The Shared Configuration palette holds resources that can be shared among
activities. These resources include database connections, WSDL files, schema
definitions, and connections to other servers. This chapter describes the shared
configuration resources available in TIBCO BusinessWorks and the activities that
make use of each resource.
Topics
• BusinessConnect Connection, page 302

• Data Format, page 304
• FTP Connection, page 308
• HTTP Connection, page 309
• Java Custom Function, page 311
• JDBC Connection, page 315
• JMS Application Properties, page 318
• JMS Connection, page 318
• Notify Configuration, page 321
• Proxy Configuration, page 321
• Rendezvous Transport, page 322
• Trusted CA, page 325
• Schema Definition, page 326
• Workflow Schema, page 327
• Workflow Server Connection, page 328
• WSDL File, page 329
• XML Document, page 336
• XSLT File, page 336

302
| Shared Configuration Palette
BusinessConnect Connection
The BusinessConnnect Connection resource contains the

information needed to connect to a TIBCO BusinessConnect server.
This shared resource is used when specifying activities in the
BusinessConnect palette. See Chapter 4, BusinessConnect Palette,
on page 57 for more information about using activities to communicate with a
TIBCO BusinessConnect server. See the TIBCO BusinessConnect documentation
for more information about using TIBCO BusinessConnect.
To create a shared configuration for TIBCO BusinessConnect, drag and drop a
BusinessConnect Connection resource into the design panel. Complete the fields
beneath the Show Advanced checkbox on the Configuration tab. This locates the
repository for TIBCO BusinessConnect. Then you can use the Load Repository
List, Load Installation List, and Load Protocol List buttons to locate the correct
BusinessConnect configuration.
Configuration
Field Description
Name The name to appear as the label for the shared
configuration item.
Description Short description of the shared resource.
Repository Name Drop-down list of available repository server names.

Use the Load Repository List button to obtain a list of
repositories.
Installation Name Drop-down list of pre-configured installation names.

Use the Load Installation List button to obtain a list
of TIBCO BusinessConnect installations.
Protocol Name Drop-down list of BusinessConnect protocols. Use the

Load Protocol List button to obtain a list of TIBCO
BusinessConnect protocols.
Show Advanced Displays the advanced fields for locating local and
remote repositories.
User Name The user name for the repository. This is optional.

BusinessConnect Connection 303
|
Field Description
Password The password for the repository. This is optional.
Directory Directory containing the local repositories.
Query remote Checkbox to enable remote repository queries.
Subject The discovery subject for the remote repository.
Timeout (msec) Timeout (in milliseconds) to wait for the list of remote
repositories to load. The default is 5000 milliseconds
(5 seconds).
Service TIBCO Rendezvous service name or port number for

the repository discovery.
Daemon TIBCO Rendezvous daemon for the repository

discovery.
Network TIBCO Rendezvous network for the repository

discovery.
Advanced
Advanced tab lists connection details used by the TIBCO BusinessWorks to
interact with the TIBCO BusinessConnect server. These fields are automatically
populated based on the Repository Name, Installation Name, and Protocol Name
selection in the Configuration tab.
Normally, users should not change these values. Doing so may cause problems in
the BusinessConnect activities. Use caution if it is necessary to alter the values of
the fields on the Advanced tab.
Field Description
Installation Name Installation name of the BusinessConnect server.
Subject Prefix Subject prefix used for interaction between TIBCO

BusinessWorks and the TIBCO BusinessConnect
server.
Service TIBCO Rendezvous service name or port number for

interaction between TIBCO BusinessWorks and the

304
Field Description
Daemon TIBCO Rendezvous daemon for interaction between
TIBCO BusinessWorks and the TIBCO
Network TIBCO Rendezvous network for interaction between

TIBCO BusinessWorks and the TIBCO
CM Name TIBCO Rendezvous certified messaging name for

Ledger File Name TIBCO Rendezvous certified ledger file name for
Dispatcher Count TIBCO Rendezvous dispatcher count. The default is 4.
Anticipated CM Comma separated list of certified messaging sessions

Name(s) to pre-register at TIBCO BusinessWorks.
You can replace these values with custom values, however, be careful, or your
configuration setup may fail.
Data Format
The Data Format resource contains the specification for parsing or

rendering a text string using the Parse Data and Render Data activities.
This shared configuration resource specifies the type of formatting for
the text (delimited columns or fixed-width columns), the column
separator for delimited columns, the line separator, and the fill character and field
offsets for fixed-width columns. You must also specify the data schema to use for
parsing or rendering the text.
When parsing text, each column of an input line is transformed into the
corresponding item in the specified data schema. The first column of the text line
is turned into the first item in the data schema, the second column is transformed
into the second item, and so on. Each line is treated as a record, and multiple lines
result in a repeating data schema containing the lines of the input text string.

Data Format 305
|
Figure 19 illustrates how an input text string is parsed into a specified data
schema.
Figure 19 Parsing a text string into a data schema
57643, Smith, Chris, Accounting

57644, Jones, Pat, Marketing
57645, Walker, Terry, Development
Text String Data Format
When rendering text, each record in the input data schema is transformed into a
line of output text. The first item of the data schema is transformed into the first
column of the text line, the second item is transformed into the second column,
and so on. Each record in a repeating data schema is transformed into a separate
line in the output text string. Rendering a data schema into a text string is exactly
the opposite process of parsing a text string into a data schema. Rendering is the
reverse of the process illustrated in Figure 19.
Configuration
Field Description
Name The name to appear as the label for the resource.

306
Field Description
Format Type The type of formatting for the text. The text can be
either "Delimiter separated" or "Fixed format".
In delimiter-separated text, each column is separated
by a delimiter character, specified in the Column
Separator field. Each line is separated by the character
specified in the Line Separator field.
In Fixed format text, each column occupies a fixed
position on the line. For fixed format text, you must
specify the Fill Character, the line length, and the
column offsets. See Field Offsets on page 307 for more
information.
Column Separator The separator character between columns when

"Delimiter separated" is specified in the Format Type
field.
When parsing text, each column becomes an element
in the output data schema. When rendering text, each
element in the input data schema is separated by the
column separator in the output text string.
Line Separator The character(s) that determine the end of each line.
When parsing text, each line is treated as a new record
in the output data schema. When rendering text, each
data record is separated by the line separator
character in the output text string.
Fill Character When processing fixed format columns, this is the

character that is used to fill the empty space within a
column and between columns. This is only available
when "Fixed format" is specified in the Format Type
field.
For example, you have a column that holds an integer
and the specified width is 10. One row has the value
"588" for that column. Because the width of 588 is
three and the column width is 10, the remaining 7
characters are filled with the specified fill character.

Data Format 307
|
Data Format
The Data Format tab allows you to define a custom schema for the text.
on the Data Format tab is used to parse a text string into the specified schema or
render the specified schema as a text string.
See Appendix A, Specifying Data Schema, on page 341 for a description of how to
define a schema.
Field Offsets
When processing fixed format text, you must specify the line length and the
column offsets. This allows a Parse Data or Render Data activity to determine
where columns and lines begin and end. The Field Offsets tab allows you to
specify the format of fixed-width text.
The line length is the total length of each input line, including the line separator
character(s). Include the appropriate number of characters for the selected line
separator on the Configuration tab to the total length of each line.
The column offset is the starting and ending character position on each line for the
column. Each line starts at 0 (zero). For each column of the line, you must specify
the name of the data item associated with this column (this is the same name you
specified for the corresponding element in the data schema), the starting offset for
the column, and the ending offset for the column.
It is a good idea to have each column offset begin where the last column offset
ended. Many fixed format data files are used by databases (for example, ISAM
files) or are generated by automated processes. These types of files have rigid file
record formats and may not have additional padding space between columns.
When you define each column offset to begin where the last column offset ends,
the data can be read more quickly by TIBCO BusinessWorks because the bytes of
the input records can be read in sequentially.
Consider the following text file. The first two lines of the file indicate offset
numbers (each 0 indicates another 10 characters), and the fill character between
columns is spaces:
0 12 30 45
0123456789012345678901234567890123456789012345678901234567
57643 Smith Chris Account
57644 Jones Pat Marketing
57645 Walker Terry Develpment

308
Figure 20 illustrates the Field Offset tab for the file above. Notice that the line
length is specified as 60, even thought the offsets end at character number 58. The
line separator is specified as "Carriage Return/Line Feed (windows)", so this adds
two additional characters for a total line length of 60.
Figure 20 Fixed-width text strings and field offsets
FTP Connection
The FTP Connection resource describes a connection to an FTP

server. FTP connections are used when specifying an FTP Put or FTP
Get activity from the FTP palette.
Configuration
Field Description
Host Host name or IP address of the FTP server.
Port Port number of the FTP server. For connections inside

of a firewall, the default when no value is specified in
this field is 21.

HTTP Connection 309
|
Field Description
User Name User name to use when logging into the FTP server.
Password Password to use when logging into the FTP server.
HTTP Connection
The HTTP Connection resource describes a port number where

incoming HTTP requests are received. This resource is used when
TIBCO BusinessWorks expects to receive an HTTP request on a
specific port where a process engine is running. For example, the
process starters HTTP Receiver and SOAP Event Source and the signal-in activity
Wait for HTTP Request receive HTTP requests.
The HTTP Connection resource can specify that the HTTPS (secure sockets layer
or SSL) protocol can be used by clients. If this is enabled, the server accepting the
HTTPS connections must have the appropriate digital certificates and be
configured to use SSL. For more information about SSL, consult the
documentation from your certificate authority.
Configuration
Field Description
Port Port number on which to listen for incoming HTTP

requests.

310
Field Description
Use Secure Socket Specifies whether incoming requests can use the
(HTTPS) HTTPS (secure socket layer or SSL) protocol. This
protocol authenticates the server to the client, and
optionally authenticates the client to the server.
Enabling this field allows you to specify the Trusted
Certificate Location, Server Key Store, Key Password,
and Client Authentication Request fields.
Server Key Store Only available when HTTPS is enabled.

This field specifies the location of the server’s digital
certificate.
Key Password Only available when HTTPS is enabled.

This field specifies the server’s password for its
private key.
Client Authentication Only available when HTTPS is enabled.

Required
This field specifies that the client initiating the HTTPS
connection must authenticate itself (that is, present its
digital certificate) to the server. The server also checks
the client’s certificate against the list of trusted
certificate authorities provided in the Trusted
Certificate Location field.
Trusted Certificate Only available when HTTPS is enabled.

Location
When the client is required to present its certificate to
the server (the Client Authentication Required field is
enabled), this field specifies the file containing the list
of certificate authorities the server will accept for
client certificates.

Java Custom Function 311
|
Java Custom Function
The Java Custom Function resource allows you to create custom

functions to use when mapping data in an activity’s input tab.
These functions are also displayed when using the XPath Editor
to build an XPath expression.
To create a custom function, you must write the function as a method of a Java
class and compile the code into a Java class file. You then load that class file into
the repository using this resource.
When the class is loaded using this resource, TIBCO BusinessWorks inspects the
contents of the class and only the class methods that meet the following
restrictions are made available in XPath:
• Only methods declared as public and static are loaded.
• The input parameters and return values must be of one of the types described
in Table 5.
• The return value of the function cannot be void.
• The method cannot be a constructor.
• The method cannot explicitly throw an exception. Runtime exceptions are
allowed, however.
• Method names cannot be overloaded within a class or any imported classes
within a single Java Custom Function resource. You can load methods of the
same name into separate classes in separate Java Custom Function resources
and use the Prefix field to differentiate between the methods.
• If you make references to any imported class files, these classes must be
available somewhere in CLASSPATH configured for TIBCO BusinessWorks.
The easiest way to make the imported classes available is to place them in the
TIBCO/bw/2.0/lib directory.
• Inner classes are not supported.
Table 5 Datatypes allows for Java custom functions
Datatypes Allowed for Input Parameters and Return

Type of Data
Types
Strings and String char
Characters
Boolean Boolean boolean

312
Table 5 Datatypes allows for Java custom functions
Datatypes Allowed for Input Parameters and Return

Type of Data Types
Numbers int Integer
float Float
double Double
short Short
long Long
Static variables are not supported within Java custom functions. Do not write
custom functions that use static variables.
If there are different classes that have methods with the same names, the Prefix
field allows you to specify a prefix for qualifying which method you wish to use
in an XPath function. See the description of the Prefix field below for more
information.
building XPath expressions and using the XPath editor.
Configuration
Field Description

The method signature plus the description
supplied in this field appear as the documentation
of the function within the XPath editor. You can
use simple HTML markup to format the text of this
field, if you desire.

|
Field Description
Prefix A folder with the name you specify in this field
appears within the Functions tab in the XPath
editor. You can drag and drop methods from the
loaded class into your XPath expression, just as
you would with any standard XPath function.
This is also the name to use to prefix the function
names in this class, if multiple classes are loaded
and function names are not unique among the
classes.
For example, if you have class1.method1 and
class2.method1, you will need to specify "class1"
in the Prefix field when you load class1 into a Java
Custom Resource. You would specify "class2" in
the prefix field when loading class2. When using
method1 in XPath expressions, you must qualify
which method1 you are using by specifying
class1:method1 or class2:method1 in the XPath
expression.
The value of this field must be unique across all
loaded Java Custom Function resources, and the
value must be a valid XPath identifier. Also, you
cannot use global variables (that is, %variable%) in
this field.
Class File The location of the class file you wish to load. Use
the Browse button to locate the class file.
Note: This field is used to locate the file initially,
but the file is actually loaded and stored in the
repository. Once the file is loaded, it can be
removed from its original location in the file
system. If you wish to change the file stored in the
repository, you can use this field to reload a
changed file or load a new file for this resource.

314
Example Java Function

The following is Java code that implements custom Java functions. The example
illustrates which methods of the class meet the restrictions and will therefore be
available as custom functions in XPath. The example also illustrates methods
which do not meet the restrictions, and therefore are not available as custom
functions.
package com.tibco;
public class Sample

{
protected int mInternalValue;
/**
* The following method will not be available because it is
* a constructor.
*/
public Sample(int value)
{
mInternalValue = value;
}
/**
* This method is used to concat two strings together. It
* must be declared as public static to be made available in
* TIBCO BusinessWorks.
*/
public static String stringConcat(String s1, String s2)
{
return s1 + s2;
}
/**
* This method is used to add two ints together. Note, that
* it takes both an int type and an Integer object.
*/
public static int intAdd(int lhs, Integer rhs)
{
return lhs + rhs.intValue();
}
/**
* The following method will not be available because it
* throws an exception.
*/
public static int badAdd(int lhs, int rhs)
throws Exception
{
long result = lhs + rhs;
if (result > Integer.MAX_VALUE) {
throw new ArithmeticException();
}
return new Long(result).intValue();
}

JDBC Connection 315
|
/**
* The following method will not be availabe because it
* returns nothing: its void.
*/
public static void returnsNothing(String s)
{
System.out.println(s);
}
/**
* The following method will not be available because it
* is not static.
*/
public int add(int rhs)
{
return mInternalValue + rhs;
}
/**
* The following method will not be available becauses it
* is not public.
*/
protected static int protectedAdd(int lhs, int rhs)
{
return lhs + rhs;
}
}
JDBC Connection
The JDBC Connection resource describes a JDBC connection. JDBC

connections are used when specifying activities from the JDBC
palette.
Configuration
Field Description

316
Field Description
JDBC Driver The name of the JDBC driver class. You can select
from a list of supported drivers.
If you select a supported driver, the Database URL
field is populated with a template for the URL of
the driver.
The following drivers are included in the TIBCO
BusinessWorks installation:
• tibcosoftwareinc.jdbc.oracle.
OracleDriver
• tibcosoftwareinc.jdbc.sqlserver.
SQLServerDriver
The following driver is supported, but you must

obtain, install, and configure the driver from the
appropriate vendor:
• oracle.JDBC.driver.OracleDriver
The following drivers are JDBC 2.0-compliant and

should work correctly, but they are not officially
supported with BusinessWorks. You must obtain,
install, and configure the driver from the
appropriate vendor:
• sun.jdbc.odbc.JdbcOdbcDriver
• weblogic.jdbc.mssqlserver4.Driver
Database URL The URL to use to connect to the database. A

template of the URL is supplied for the selected
JDBC driver. You must supply the portions of the
URL that are within angle brackets (<>). For
example, if you select the
tibcosoftwareinc.jdbc.oracle.OracleDriver,
the following appears in the Database URL field:
jdbc:tibcosoftwareinc:oracle://
<host>:<port#>:<db_instancename>
You must supply the host, port number, and

database instance name in the URL.

JDBC Connection 317
|
Field Description
Maximum Connections The maximum number of database connections to
allocate. The default maximum is 10. The
minimum value that can be specified is 1.
TIBCO BusinessWorks creates a pool of JDBC
connections for every JDBC Connection shared
resource. The maximum size of this pool is
specified by this parameter.
Activities that use this JDBC Connection resource
are given a connection from the pool. Once the
maximum number of connections is reached,
activities requesting a connection cannot proceed.
Once a connection is freed by an activity, the
connection is returned to the pool. Connections
that are left open will eventually timeout and be
closed. These connections can be reopened at a
later time, until the maximum number of
connections specified in this field is reached.
If an activity detects a connection in the pool is
invalid (for example, the database is restarted), the
activity attempts to reestablish the connection.
All activities that are part of the same transaction
will use the same connection in the connection
pool. The first activity within a transaction can
attempt to reestablish an invalid connection. If a
connection becomes invalid during a transaction,
the transaction is rolled back and must be retried,
if necessary.
User Name User name to use when connecting to the database.
Password Password to use when connecting to the database.
The Test Connection button allows you to test that the specified fields result in a
valid connection to a database.

318
JMS Application Properties
The JMS Application Properties resource describes any JMS

message properties that a JMS application expects. These properties
can then be added to a JMS message on the Advanced tab of a JMS
activity. These properties will appear as "OtherProperties" on the
Input or Output tab of the activity.
Configuration
Field Description
Data
The Data tab allows you to define a custom schema for the JMS application
properties.
on the Data tab appears as "OtherProperties" on the Input or Output tab of the
JMS activity where this shared configuration resource is used.
define a schema.
JMS Connection
The JMS Connection resource describes a JMS connection. This

resource is used when specifying activities on the JMS palette.

JMS Connection 319
|
Configuration
Field Description
User Name User name to use when logging into the JMS server.
If the JMS provider does not require authentication,
this field can be empty.
Not all JMS servers require user names and
passwords. Refer to your JMS provider
documentation and consult your system
administrator to determine if your JMS server
requires a user name and password.
Password Password to use when logging into the JMS server.

If the JMS provider does not require authentication,
Client ID Client ID for the connection. Typically JMS providers

have a provider-specific format for client IDs. See
your JMS provider’s documentation for more
information about client IDs.
JNDI Context Factory This is the initial context factory class for accessing
JNDI.
See your JNDI provider documentation for the name
of the InitialContextFactory class. For example,
TIBCO Enterprise for JMS provides the following
class:
com.tibco.tibjms.naming.TibjmsInitialContex
tFactory
TIBCO BusinessWorks attempts to find the class.

However, you may need to add the Java file supplied
by your JNDI service provider to the CLASSPATH
environment variable to use JNDI.

320
Field Description
JNDI Context URL This is the URL to the JNDI service provider.
See your JNDI provider documentation for the syntax
of the URL. An example of a JNDI URL is the
following: tibjmsnaming://localhost:1099
JNDI User Name User name to use when logging into the JNDI server.
If the JNDI provider does not require authentication,
JNDI Password Password to use when logging into the JNDI server.
If the JNDI provider does not require authentication,
Advanced
Field Description
Queue Connection The QueueConnectionFactory object stored in JNDI.
Factory This object is used to create a queue connection with a
JMS application.
See your JNDI provider documentation for more
information about creating and storing
QueueConnectionFactory objects.
Topic Connection The TopicConnectionFactory object stored in JNDI.

Factory This object is used to create a topic connection with a
JMS application.
See your JNDI provider documentation for more
information about creating and storing
TopicConnectionFactory objects.
JNDI Properties Any additional properties to supply for the

connection. You specify a name, datatype, and value
for each property.
These properties are typically vendor-specific. See
your JNDI provider documentation for more
information about the available properties.

Notify Configuration 321
|
Notify Configuration
The Notify Configuration resource specifies a schema to use for

passing data between executing process instances. Corresponding
Receive Notification, Notify, and Wait activities use the same
Notify Configuration resource to define the data for inter-process communication.
The schema can be empty, if you do not wish to pass data between processes. See
TIBCO BusinessWorks Process Design Guide for more information about
inter-process communication.
Configuration
Field Description
Data
The Data tab allows you to define a custom schema. The schema can be empty, if
you do not wish to pass data between processes.
on the Data tab appears on the Input or Output tab of the Receive Notification,
Wait, or Notify activity where this shared configuration resource is used.
define a schema.
Proxy Configuration
The Proxy Configuration resource is used to specify a proxy HTTP

server when HTTP requests are sent outside of a firewall.

322
Configuration
Field Description
Proxy Host Host name of the proxy server.
Proxy Port Port number of the proxy host.
User ID User ID to use to log into the proxy server.
Password Password to use to log into the proxy server.
Rendezvous Transport
The Rendezvous Transport resource describes a TIBCO Rendezvous

transport. These resources are used when specifying activities from
the Rendezvous palette. See the TIBCO Rendezvous documentation
for more information about specifying these fields.
Configuration
Field Description

Rendezvous Transport 323
|
Field Description
Daemon In the case of TIBCO Rendezvous daemon running on
the same machine as TIBCO BusinessWorks process
engine, this is not specified. If Rendezvous is running
on a different machine, then the Daemon field is
specified as the remote host name followed by the
socket number.
For example:
tcp:acct_host:6555
Network This field contains the host name, IP address, network

name, or interface name.
For example:
;224.34.103.4
Service This is the TIBCO Rendezvous service name in one of

the following formats:
<service name>
or
<port number>
Advanced
Field Description
RV Type The type of TIBCO Rendezvous connection to use.
This can be reliable (standard RV transport), certified
(RVCM), or Distributed Queue (RVCMQ).
The fields of the advanced tab correspond to the value
selected for this field.
Certified Transport
CM Name The name of the delivery-tracking session. This name

is in the same format as TIBCO Rendezvous subject
names.

324
Field Description
Ledger File The name and location of the persistent ledger file
that tracks certified messages. If not specified, the
certified message ledger is kept in process memory
only.
Sync Ledger File Specifies whether to keep the ledger file synchronous
with the current messages.
Relay Agent Name of the relay agent to use. Relay agents are
useful when clients are disconnected from the
network from time to time. The relay agents store
inbound certified messages and labeled messages
(and other messages related to certified delivery
features) on behalf of their disconnected client
programs. When a client is connected, it receives
inbound messages immediately.
Require Old Message Check this box if you wish to require the retention of
messages for which delivery has not been confirmed.
These messages will be resent.
Message Timeout The time limit (in seconds) for certified message
(sec) delivery.
Distributed Queue Transport
CMQ Name The name of the distributed queue. This name is in

the same format as TIBCO Rendezvous subject names
Worker Weight The weight of the worker (this pertains to the worker
processing queue requests, not to BusinessWorks
process engines). Relative worker weights assist the
scheduler in assigning tasks. When the scheduler
receives a task, it assigns the task to the available
worker with the greatest worker weight.
Worker Tasks Sets the task capacity for the worker (this pertains to
the worker processing queue requests, not to
BusinessWorks process engines). Task capacity is the
maximum number of tasks that a worker can accept.
When the number of accepted tasks reaches this
maximum, the worker cannot accept additional tasks
until it completes one or more of them.

Trusted CA 325
|
Field Description
Schedule Weight Weight represents the ability of this member to fulfill
the role of scheduler, relative to other members with
the same name. Cooperating distributed queue
transports use relative scheduler weight values to
elect one transport as the scheduler; members with
higher scheduler weight take precedence. Acceptable
values range from 1 to 65535.
Schedule Heartbeat The scheduler sends heartbeat messages at this

interval (in seconds). All members with the same
name must specify the same value for this parameter.
The value must be strictly positive.
Schedule Activation When the heartbeat signal from the scheduler has
been silent for this interval (in seconds), the member
with the greatest scheduler weight takes its place as
the new scheduler. All members with the same name
must specify the same value for this parameter. The
value must be positive
Trusted CA
The Trusted CA resource is used to contain a list of digital certificates of

trusted certificate authorities. When an activity must check that a digital
certificate presented by a server is from one of its trusted certificate
authorities, this list resource is used to specify that list.
Use the Import button to locate and load digital certificate and certificate
authorities into this resource. The list of trusted certificates and certificate
authorities will be listed on the Trusted Certificate & CAs tab.
For more information about creating keystores for private keys and trusted
certificate chains, see
http://java.sun.com/j2se/1.3/docs/tooldocs/win32/keytool.html.

326
Configuration
Field Description
Trusted Certificate & CAs

This tab lists all loaded trusted certificate and certificate authorities.
Schema Definition
The Schema Definition resource describes an XML schema file (for

example, a DTD or an XSD). XML schemas can be used in many
places, but primarily they are used when specifying activities on
the XML palette, or when creating WSDL files (see WSDL File on page 329).
Configuration
Field Description
Schema Contents The contents of the XML schema. You can type in the
contents of the file, or you can import an existing file
by using the Browse button.

Workflow Schema 327
|
Workflow Schema
The Workflow Schema resource defines a schema that can be

used by activities in the Manual Work Palette. This resource
defines data for use in a manual task. See Chapter 12, Manual
Work Palette, on page 213 for more information about working
with manual tasks.
Configuration
Field Description
Parent Schema A reference to another Workflow Schema that this

schema inherits its data from.
Editor
The Editor tab allows you to define a custom schema for the manual task.
The schema defined by this resource is similar to a TIBCO InConcert class.
However, the definition of the schema is stored in the TIBCO BusinessWorks
project, and no TIBCO InConcert class is created. Only Document, String, Integer,
and Date/Time datatypes can be used in the Workflow schema.
Document is a special datatype for use with Manual Work activities. This schema
item is used to upload/download documents from the Workflow Server for a
particular manual work task. This is a complex datatype that contains two
elements: name (string) and content (binary).
You define a schema in the same way you define schema for other types of
activities in TIBCO BusinessWorks. The only exception is that the schema is
restricted as described above. See Appendix A, Specifying Data Schema, on
page 341 for a complete description of using the Editor tab.

328
Output View
This tab displays the output of an activity that uses this Workflow Schema
resource. The displayed output schema contains all attributes defined in this
resource and all attributes inherited from the schema in the Extends From field on
Workflow Server Connection
The Workflow Server Connection resource defines a connection to a

TIBCO InConcert server that can be used by activities in the
Manual Work palette. See Chapter 12, Manual Work Palette, on
page 213 for more information about working with manual tasks.
Configuration
Field Description
Server Name of the TIBCO InConcert server to connect to.

You can use the drop-down list of available servers
next to this field to find a server.
User The TIBCO InConcert client user ID to use when

connecting to the sever.
Password The password for the specified user.
Use Java Server Specifies that the IcJava server is to be used.
Host The host name of the IcJava server.
Port The port number of the IcJava server.
The Test Connection button can be used to verify the connection using the
specified configuration.

WSDL File 329
|
WSDL File
The WSDL File resource describes a Web Service Definition Language

(WSDL) file. You can generate a WSDL file or you can import an
existing WSDL file. WSDL files are used when specifying activities on
the SOAP palette.
WSDL provides an XML-based format for describing web services as collections
of communication endpoints capable of exchanging messages. Service
descriptions within a WSDL file can be abstract or concrete. Abstract service
descriptions provide the names of operations and the data being exchanged.
Concrete service descriptions provide actual bindings to specific network
endpoints. Concrete service descriptions can be used to make requests to actual
implementations of web services.
The WSDL File resource allows you to store WSDL files that can have abstract or
concrete service definitions, or a mixture of both types of services. You would
store concrete service definitions when you wish to use TIBCO BusinessWorks to
send SOAP requests to external web services.
You can also use this resource to generate abstract service definitions. The abstract
service definition is used by the SOAP Event Source activity to create a concrete
service endpoint. A client can then invoke a web service implemented by a
BusinessWorks process. The client can retrieve the concrete WSDL service
description from BusinessWorks and then invoke the web service. BusinessWorks
accepts the incoming SOAP request, and implements the request with a process
definition. The process can then return a reply to the request by way of the SOAP
Send Reply activity.
See Chapter 15, SOAP Palette, on page 269 for more information about using the
SOAP activities within a process definition.
Configuration
Field Description

330
Field Description
Mode One of the following:
• Import File — Import a WSDL file stored on disk.
• Import URL — Import a WSDL file using a URL.
• Generate — Create a new WSDL file using XML
schemas stored in the project. This is used to
create abstract service descriptions based on
existing, stored schema files.
Import File
Location The location of the WSDL file to import. Click the

Import button once the file has been located to import
the file into the repository. The WSDL code appears
on the Source tab once it has been imported.
You can import WSDL files that contain abstract,
concrete, or a mixture of both types of service
descriptions.
Import URL
Location The URL of the WSDL file to import. Click the Load
WSDL button once the URL has been located to
import the WSDL code into the repository. The WSDL
code appears on the Source tab once it has been
imported.
You can import WSDL files that contain abstract,
concrete, or a mixture of both types of service
descriptions.
The Check URL button allows you to check whether
the specified URL is active.
You can also use UDDI search services to locate Web
Service WSDL files or retrieve WSIL files from web
service providers. See Using WSIL and UDDI on
Generated File Fields
Operation Name The name of the web services operation. This is the
name used within a SOAP request to perform the
operation within the web service.

WSDL File 331
|
Field Description
Input Schema The input schema of the operation. You can browse
and select a schema definition shared resource for this
field.
Input Element The input element. This is automatically populated

based on the specified input schema.
Output Schema The output schema of the operation. You can browse
and select a schema definition shared resource for this
field.
Output Element The output element. This is automatically populated

based on the specified output schema.
Faults Specifies schemas that can be sent in the case of an

error. You add or remove fault schemas, and then
assign a name and XML Schema shared configuration
resource for each fault schema. You must also specify
the element with the XML schema to return in case of
an error.
When this WSDL file is used by a SOAP Event Source
process starter, the process definition can use the
SOAP Send Fault activity to send a fault to the client
in the case of an error. See Chapter 15, SOAP Palette,
on page 269 for more information about using SOAP
activities in process definitions.
Generate WSDL Click the Generate WSDL button once the

button specification of the WSDL file is complete. The file
will be generated from the given specification. It is
stored in the repository and it appears on the Source
tab, once the Generate button has been clicked.
If you change the schema used to create a generated
WSDL file, you must edit the WSDL File shared
resource and click this button again.
Note: The generated WSDL file contains an abstract
service description. This abstract service can then be
used by the SOAP Event Source activity to create a
concrete service description.

332
Source
The source tab displays the source of the WSDL file. The source appears after the
Import or Generate buttons are clicked on the Configuration tab. If the source file
or generated file specification changes after the file has been placed in the
repository, click the Import or Generate button again to re-import or regenerate
the file.
Using WSIL and UDDI

Web Service Inspection Language (WSIL) and Universal Description Discovery
and Integration (UDDI) are mechanisms for locating web services. You can use
either WSIL or UDDI to locate web services when Import URL is selected in the
Mode field of this resource.
The Universal Description Discovery and Integration (UDDI) project defines the
protocol for searching for web services. There are several organizations that
provide databases of web services that can be browsed using UDDI. WSIL is an
XML-based format used to describe the available web services for a particular
site.
When Import URL is selected for the Mode field of this resource, you can click the
UDDI button to bring up the WSIL and UDDI Registry Browser dialog. This
dialog allows you to enter a URL of a WSIL or UDDI service (or choose from a
drop-down list of services), then provide criteria for searching for the desired web
service.
Figure 21 illustrates the WSIL and UDDI Registry Browser dialog.

WSDL File 333
|
Figure 21 The WSIL and UDDI Registry Browser dialog
The following are the fields of the UDDI Search dialog.
Field Description
URL The URL of the UDDI search service or the
address to use to retrieve a WSIL file.
When UDDI is selected, there are several
UDDI services provided in a drop-down list,
or you can enter the desired URL by typing it
into this field.
When WSIL is selected, you can enter the
URL of the web service provider, if the
provider supplies WSIL files.

334
Field Description
Search Type The type of search. The types of searches
available depend upon whether UDDI or
WSIL is selected in the URL field.
There are several types of searches defined by
UDDI. This field provides a drop-down list of
available search types for the selected UDDI
service. Each search type may be performed
differently. Help is provided in blue text at
the bottom of the dialog for the selected
search type. See Search Type on page 335 for
more information about different types of
UDDI searches.
Search Term The text to search for. This field has a

different syntax for each search type. The
help text in blue at the bottom of the dialog
provides more information about entering
search terms for the specified search type.
Max Rows The maximum number of services to return.
Case Sensitive Specifies that the search should be

case-sensitive when checked. In a
case-sensitive search, the search term’s
capitalization is considered when searching.
Order Asc Specifies that the returned services should be

listed in ascending alphabetical order when
checked. If unchecked, the returned services
are sorted in descending alphabetical order.
Exact Match Specifies that the directory should be

searched for an exact match of the specified
search term. This is useful if you wish to
search the directory for a short word or
phrase when the directory contains services
that use longer forms of the search term.
For example, you may enter "Math" in the
search term, and you only want to retrieve
services named "Math", not any services with
longer names (for example a service named
"Math Web Service" would not be returned).

WSDL File 335
|
Field Description
Timeout (msec) Specifies the amount of time (in milliseconds)
to wait before cancelling the search. Some
search directories can take significant time
when searching. This field allows you to
timeout the search if it is not performed
promptly.
Search Type
Some UDDI search types provide a list of web services. Other search types
provide a directory of service types that you can select and explore for specific
web services. The search type determines the kind of search that is performed.
When a specific type is specified in the Search Type field, help for how to perform
that search type appears in blue at the bottom of the dialog. Also, either the Get
Services or the Explore button is enabled depending upon the type of search
selected.
When a search retrieves a list of web services:

1. Enter your search criteria.
2. Click the Get Services button to retrieve the list of services.
3. The list of services matching your search criteria appears below the search
criteria fields.
When a search retrieves a directory of services:

1. Enter your search criteria.
2. Click the Explore button. The directory of service types appears in a list to the
right of the search criteria.
3. Select the desired item in the list of service types.
4. Click the Get Services button to retrieve the services contained in the
directory.

336
XML Document
The XML Document resource describes an XML document.
Configuration
Field Description
Document contents The contents of the XML file. You can type in the
contents of the file, or you can import an existing file
by using the Browse button.
XSLT File
The XSLT File resource allows you to load an XSLT file to use to
transform XML schemas using the Transform XML activity. See
Transform XML on page 294 for more information about using this
shared configuration resource within a Transform XML activity.
A transformation expressed in XSLT is called a stylesheet. A stylesheet contains a
set of template rules. Each template rule has two parts: a pattern that is matched
against nodes in the source document and a template that can be instantiated to
form part of the result document.
A transformation expressed in XSLT describes rules for transforming a source
document into a result document. The transformation is achieved by associating
patterns with templates. A pattern is matched against elements in the source
document. A template is instantiated to create all or part of the result document.

XSLT File 337
|
The structure of the result document can be completely different from the
structure of the source document. In constructing the result document, elements
from the source document can be filtered and reordered, and arbitrary structure
can be added.
The XSLT File resource allows you to add and edit XSLT source, view or modify
templates and their parameters, and view or modify stylesheets and their
parameters. This section describes how to use the XSLT File resource to store and
modify XSLT source. It is beyond the scope of this document to completely
describe XSLT. See http://www.w3.org/TR/xslt for the XSLT specification.
Editing an XSLT File Resource

The XSLT File resource behaves differently from other shared configuration
resources. When editing this resource, the design panel contains three tabs.
Selecting one of the tabs in the design panel changes the items available in the
configuration panel.
The following describes the tabs of the design panel for this resource:
Design Panel Tab Description

Source Allows you to paste and edit XSLT source code in the
design panel.
Templates Allows you to add, view, and change templates in the

XSLT. Changes made to the templates are reflected in
the XSLT source on the Source tab.
Stylesheet Allows you to add or modify global parameters for the

XSLT stylesheet.
Different tabs appear in the configuration panel appear based on which tab is
selected in the design panel. The following describes the configuration panel tabs
and when they are enabled:
Available
when This
Configuration
Panel Tab Description Design Panel
Tab Is
Selected
Configuration Allows you to specify a name and Source,
short description of the XSLT File Templates,
resource. Stylesheet

338
Available
when This
Configuration Description Design Panel
Panel Tab
Tab Is
Selected
Parameters Allows you to modify the parameters Templates,
of the item selected in the design Stylesheet
panel.
For example, when the Templates tab
is selected, this tab allows you to
modify the parameters of the template
selected in the design panel. When the
Stylesheet tab is selected, this tab
allows you to modify global
parameters for the stylesheet.
Parameters are edited in the same way
that schemas are edited. XSLT
parameters are limited to datatypes
available in XSLT: string, decimal,
boolean, a reference to an XML
element, or "any" type (any available
XSLT type). See Appendix A,
Specifying Data Schema, on page 341
for more information about editing
schemas.
Input You can use this tab to view and Templates

change the transformations that occur
in the selected template.
Transformations are XPath
expressions and constants that specify
how input to the template is
transformed into the output schema
for the template.

XSLT File 339
|
There are also four buttons that appear on the toolbar when editing the XSLT File
shared configuration resource. The following describes these toolbar buttons:
Available
when This
Toolbar Button Description Design Panel
Tab Is
Selected
Load Stylesheet. Allows you to Source,
browse your file system for a Templates,
stylesheet file to load into this Stylesheet
resource.
Save Stylesheet. Saves the stylesheet Source,

for this resource to a file. Templates,
Stylesheet
Add Template. Adds a new template Source,

to your stylesheet. This brings up a Templates
dialog to specify the name of the
template and the schema for the
output of the template.
Remove Template. Removes the Templates

selected template from the stylesheet.

340

| 341
Appendix A Specifying Data Schema
Many activities within TIBCO BusinessWorks allow you to specify a custom data
schema for input or output of the activity. This appendix describes the mechanism
for specifying a custom data schema for an activity’s input or output.
Topics
• Schema, page 342

342
| Specifying Data Schema
Schema
The Schema tab is used to specify a data schema for input or output of an activity.
This is useful when the data does not have a well-known structure. The Schema
tab is usually named for the type of schema you are creating. For example, the tab
may be named "Input Schema" or "Output Schema".
For example, an email message has a well-known data structure, and therefore
does not need a special datatype for its input. A JMS message, however, can have
application-specific properties of any datatype. The Schema tab allows you to
define the schema for any activities that require a specialized input or output
schema.
You can use a simple datatype, or you can define a group of data elements on this
tab. You can also reference XML schema or ActiveEnterprise classes stored in the
project. Once defined, the schema appears on the Input tab, the Output tab, or
both tabs of the activity. The data within the schema then becomes available to
other activities within the process definition.
The following illustrates the Schema tab. In this example, the Schema tab is
labeled "Output Schema" indicating this is the activity’s output.
To define a schema on this tab, use the icons above the schema tree to add, delete,
or move data items. Then use the fields of the dialog to specify the datatype of
each item.
Field Description
Name The name of the data item.

Schema 343
|
Field Description
Cardinality The qualification for the data item. 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.
• Optional — the data item is optional.
• Repeating, Zero or More — The data item is a list
that has zero or more elements.
• Repeating, One or More — The data item is a list
that has one or more items.
Type The type of data. Can be any of the following:

• XML Element Reference — must locate the stored
XML schema definition.
• XML Type Reference — must locate the stored
XML schema definition.
• AE Class Reference — must locate the stored
ActiveEnterprise class definition.
• Any of the datatypes described in Table 6.
Schema Name Stored XML schema that contains the element or type
you wish to reference.
Element Name Element within a stored XML schema you wish to

reference.
Type Name Type within a stored XML schema you wish to

reference.
AE Class Name Stored ActiveEnterprise class you wish to reference.
Table 6 describes the datatypes available for data.
Table 6 Datatypes for schema items
Icon Description
Complex element. Container for other datatypes. This is a
branch in the schema tree.
String or character value.

344
Icon Description
Integer value. 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. You can specify the size of the

schema item as float, double, or unlimited.
Boolean value.
Date or Time. This can be any of the following datatypes:

• Time
• Date
• Date & Time
• Duration
• Day
• Month
• Year
• Year & Month
• Month & Day

Schema 345
|
Icon Description
Base 64 or hexidecimal value.
Any Type. Represents a schema item with the TIBCO

ActiveEnterprise datatype any. This node can be specified as
any other datatype or a reference to an XML Type or AE
Class.
Any Element. Represents a schema item that can be a

reference to any XML Element. You can use the Set
Substitution button to supply a reference to the XML
Element for this item.
Choice. Specifies that the schema element can be one of a

specified set of datatypes.

346

| 347
Index
A Read File 80
Receive Mail 208
ActiveEnterprise Adapter palette 33 Receive Misc Msg 59
activities Receive Notification 110
Adapter Request-Response Server 34 Receive Request/Notification 60
Adapter Subscriber 36 Receive Response 62
Assign Work 224 Remove File 82
Call Process 92 Render 253
Checkpoint 93 Render XML 292
Confirm 95 Rendezvous Subscriber 258
Create File 76 Reply to JMS Message 191
Download Document 229 Reply to Rendezvous Request 260
External Command 96 Respond to Adapter Request 45
File Poller 77 Retrieve Resources 273
FTP Get 68 Send HTTP Request 123
FTP Put 71 Send HTTP Response 129
Generate Error 99 Send Mail 209
Get Work Status 232 Send Misc Msg 63
HTTP Receiver 120 Send Rendezvous Request 262
Invoke an Adapter Request-Response Service 39 Send Request/Notification 64
Java Code 102 Send Response 65
JDBC Call Procedure 140 Sleep 112
JDBC Query 143 SOAP Event Source 273
JDBC Update 148 SOAP Request Reply 277
JMS Queue Receiver 163 SOAP Send Fault 283
JMS Queue Requestor 167 SOAP Send Reply 286
JMS Queue Sender 173 SQL direct 156
JMS Topic Publisher 177 Timer 113
JMS Topic Requestor 181 Transform XML 294
JMS Topic Subscriber 187 Wait 114
Label 106 Wait for Adapter Message 47
Map Data 107 Wait for Adapter Request 52
Modify Work 236 Wait for Completion 241
Notify 108 Wait for File Change 84
Null 110 Wait for HTTP Request 133
Parse 248 Wait for JMS Queue Message 195
Parse XML 290 Wait for JMS Topic Message 200
Publish Rendezvous Message 256 Wait for Rendezvous Message 265
Publish to Adapter 42 Write File 89

348
|
Write To Log 117 deployment configuration
Adapter Request-Response Server activity 34 adapters 17
Adapter resource 17 process engines 9
Adapter Subscriber activity 36 resource 2
adapters Deployment Configuration palette 2
Adapter resource 17 Disk resource 7
Alert resource 26 documentation
Any Failure resource 20 labeling process definitions 106
executing a command on failures 29 documents
recovery from failures 18, 21 in manual tasks 217
restarting after failure 25 domain configuration
Alert resource 26 adapters 17
alerts Alert resource 26
sending to console 26 Download Document activity 229
Any Failure resource 20 dynamic SQL 156
Assign Work activity 224
E
B
Email resource 28
BusinessConnect Connection resource 302 executing a command in the event of a failure 29
BusinessConnect palette 57 External Command activity 96
C F
Call Process activity 92 failures 20
Checkpoint activity 93 executing a command 29
Component failure event 21 recovery specification 21
Confirm activity 95 sending email 28
confirming a message 95 File palette 75
conventions used in this manual xxi File Poller activity 77
CPU resource 7 FTP Connection shared configuration 308
Create File activity 76 FTP Get activity 68
creating schemas 342 FTP palette 67
Custom resource 29 FTP Put activity 71
customer support xxi
G
D
General Activities palette 91
Data Format resource 304 Generate Error activity 99

| 349
Get Work Status activity 232 JMS Topic Subscriber activity 187
H L
handling failures 20 Label activity 106
HTTP Connection shared configuration 309 Log Event resource 24
HTTP palette 119
HTTP Receiver activity 120
M
I Machine resource 3
machines
interaction with TIBCO InConcert 223 Any Failure resource 20
inter-process communication monitoring 5
Notify 108 CPU 7
Notify Configuration 321 disks 7
Wait 114 processes 8
Invoke an Adapter Request-Response Service Mail palette 207
activity 39 Manual Work palette 213
how to work with tasks 218
overview 214
TIBCO InConcert 223
J working with documents 217
Map Data activity 107
Java Code activity 102 mapping
Java Custom Function shared configuration 311 with XSLT 336
JDBC Call Procedure activity 140 messages
JDBC Connection shared configuration 315 confirming 95
JDBC palette 139 Modify Work activity 236
working with the Query Designer 151 Monitor resource 5
JDBC Query activity 143 monitoring
Query Designer 151 CPU 7
JDBC Update activity 148 disks 7
JMS Application Properties shared configuration 318 example 5
JMS Connection shared configuration 318 restarting machines 25
JMS palette 159 sending email 28
JMS properties 160
JMS Queue Receiver activity 163
JMS Queue Requestor activity 167
JMS Queue Sender activity 173 N
JMS Topic Publisher activity 177
JMS Topic Requestor activity 181 Notify activity 108

350
|
Notify Configuration shared configuration 321 Proxy Configuration shared configuration 321
Null activity 110 Publish Rendezvous Message activity 256
Publish to Adapter activity 42
O
Q
overview
Manual Work palette 214 Query Designer 151
TIBCO BusinessConnect palette 58
R
P
Read File activity 80
palettes Receive Mail activity 208
ActiveEnterprise Adapter 33 Receive Misc Msg activity 59
BusinessConnect 57 Receive Notification activity 110
Deployment Configuration 2 Receive Request/Notification activity 60
File 75 Receive Response activity 62
FTP 67 Recovery resource 21
General Activities 91 Remove File activity 82
HTTP 119 Render activity 253
JDBC 139 Render XML activity 292
JMS 159 Rendezvous palette 255
Mail 207 Rendezvous Subscriber activity 258
Manual Work 213 Rendezvous transport shared configuration 322
Parse 247 Reply To JMS Message activity 191
Process 31 Reply to Rendezvous Request activity 260
Rendezvous 255 resources
Shared Configuration 301 Adapter 17
SOAP 269 Alert 26
XML 289 Any Failure 20
Parse activity 248 Component failure event 21
Parse palette 247 CPU 7
Parse XML activity 290 Custom 29
Process Engine resource 9 Deployment Configuration 2
process engines Disk 7
Any Failure resource 20 Email 28
executing commands on failure 29 Log Event 24
recovery from failure 21 Machine 3
recovery from failures 12 Monitor 5
restarting after failure 25 Process 8
Process palette 31 Process Engine 9
Process resource 8 Recovery 21

| 351
Restart 25 specifying data schema 341
Suspend Process Event 23 SQL Direct activity 156
Respond to Adapter Request activity 45 SQL queries 151
Restart resource 25 storing mapping definitions 336
Retrieve Resources activity 273 support, contacting xxi
Suspend Process Event resource 23
S
T
Schema Definition shared configuration 326
Send HTTP Request activity 123 technical support xxi
Send HTTP Response activity 129 TIBCO BusinessConnect
Send Mail activity 209 overview of working with 58
Send Misc Msg activity 63 TIBCO InConcert 223
Send Rendezvous Request activity 262 Timer activity 113
Send Request/Notification activity 64 Transform XML activity 294
Send Response activity 65 Trusted CA shared configuration 325
sending
alerts to the console 26
email 28
shared configuration 301 U
Data Format 304
FTP Connection 308 UDDI 332
HTTP Connection 309
JDBC Connection 315
JMS Application Properties 318 W
JMS Connection 318
Notify Configuration 321 Wait activity 114
Proxy Configuration 321 Wait for Adapter Message activity 47
Rendezvous transport 322 Wait for Adapter Request activity 52
Schema Definition 326 Wait for Completion activity 241
Trusted CA 325 Wait for File Change activity 84
Workflow Schema 327 Wait for HTTP Request activity 133
Workflow Server Connection 328 Wait for JMS Queue Message activity 195
WSDL File 329 Wait for JMS Topic Message activity 200
XML document 336 Wait for Rendezvous Message activity 265
XSLT File 336 web services
Sleep activity 112 locating 332
SOAP Event Source activity 273 Workflow Schema shared configuration 327
SOAP palette 269 Workflow Server Connection shared
SOAP Request Reply activity 277 configuration 328
SOAP Send Fault activity 283 working with
SOAP Send Reply activity 286 documents in manual tasks 217

352
|
tasks assigned to the user pool 218
Write File activity 89
Write To Log activity 117
writing SQL queries 151
WSDL File shared configuration 329
WSIL 332
X
XML Document shared configuration 336
XML palette 289
XSLT File shared configuration 336

TIBCO Business Works - Palette Reference - Nov 2002

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TIBCO Business Works - Palette Reference - Nov 2002

Uploaded by

Copyright:

Available Formats

TIBCO BusinessWorks™

Chapter 1 Deployment Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

TIBCO BusinessWorks Palette Reference

Chapter 2 Process Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 3 ActiveEnterprise Adapter Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

TIBCO BusinessWorks Palette Reference

Chapter 4 BusinessConnect Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

TIBCO BusinessWorks Palette Reference

Chapter 5 FTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Chapter 6 File Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Chapter 7 General Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks Palette Reference

Chapter 8 HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Chapter 9 JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

TIBCO BusinessWorks Palette Reference

Chapter 10 JMS Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

TIBCO BusinessWorks Palette Reference

Chapter 11 Mail Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Chapter 12 Manual Work Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

TIBCO BusinessWorks Palette Reference

Chapter 13 Parse Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Chapter 14 Rendezvous Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

TIBCO BusinessWorks Palette Reference

Chapter 15 SOAP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

TIBCO BusinessWorks Palette Reference

Chapter 16 XML Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Chapter 17 Shared Configuration Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

TIBCO BusinessWorks Palette Reference

Appendix A Specifying Data Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

TIBCO BusinessWorks Palette Reference

Figure 1 An Adapter Request-Response Server activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks Palette Reference

Table 1 Properties for JMS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks is a standards-based, easy-to-deploy solution for

• Related Documentation, page xx

TIBCO BusinessWorks Palette Reference

You may find the following documentation resources useful.

TIBCO BusinessWorks Documentation

TIBCO BusinessWorks Palette Reference

How to Contact TIBCO Customer Support

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks Palette Reference

Chapter 1 Deployment Palette

• Deployment Configuration, page 2

TIBCO BusinessWorks Palette Reference

The deployment configuration is a description of what adapters and process

Description Short description of the deployment.

TIBCO BusinessWorks Palette Reference

Machine Name Once a machine is selected, this field displays the

Description Short description of the machine.

IP Address IP address of the machine.

Operating System Operating system installed on the machine.

OS Version Version of the operating system installed on the

TIBCO BusinessWorks Palette Reference

Version Version of the installed component.

TIBCO BusinessWorks Palette Reference

TIBCO BusinessWorks Palette Reference

4. Click the Apply button.

Name The name to appear as the label for the monitor.

Description Short description of the monitor.