TIBCO ActiveMatrix BusinessWorks Palette Reference

TIBCO ActiveMatrix BusinessWorks Palette Reference
TIBCO ActiveMatrix
BusinessWorks™
Palette Reference
Software Release 5.7.2
September 2009
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED
OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR
ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARE
LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED
IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS
AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN
AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and
treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO
Software Inc.
TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix
BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Enterprise Message Service, TIBCO
InConcert, TIBCO Policy Manager, and TIBCO Hawk are either registered trademarks or trademarks of TIBCO
Software Inc. in the United States and/or other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A
SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE
INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE
IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN
THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 1999-2009 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix
TIBCO ActiveMatrix BusinessWorks Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxi
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
Chapter 1 Process Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Process Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Partners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2
2
3
3
Chapter 2 ActiveEnterprise Adapter Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Common Features Across ActiveEnterprise Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Support for Message Filter Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Internationalization Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Refresh Adapter Service Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configure SSL Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Adapter Request-Response Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
22
22
22
23
Adapter Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
25
26
26
27
TIBCO ActiveMatrix BusinessWorks Palette Reference
iv
| Contents
Invoke an Adapter Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
29
30
30
32
33
Publish to Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
34
36
36
38
39
Respond to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
40
41
41
42
Send Exception to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
43
43
44
44
45
Wait for Adapter Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
46
47
47
48
49
49
50
Wait for Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
51
52
52
53
54
54
Chapter 3 File Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Copy File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58
58
58
59
59
Create File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents v
|
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61
62
63
File Poller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64
64
65
67
67
List Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
69
69
69
70
71
Read File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
72
72
73
74
Remove File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
75
75
75
75
76
Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
77
77
77
78
79
Wait for File Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
80
80
82
83
83
Write File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
85
85
85
86
87
Chapter 4 FTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
FTP Change Default Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
TIBCO ActiveMatrix BusinessWorks Palette Reference
vi
| Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
90
91
92
FTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure SSL Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Connection Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Available Commands Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
93
93
95
96
97
FTP Delete File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
FTP DIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
101
101
102
103
103
FTP Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
104
104
106
107
108
FTP Get Default Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
110
110
111
111
112
FTP Make Remote Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
113
113
113
115
115
FTP Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
116
116
118
119
120
FTP Quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
121
121
121
123
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents vii
|
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
FTP Remove Remote Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
124
124
124
126
126
FTP Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
127
127
127
129
129
FTP Sys Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
130
130
130
131
132
Chapter 5 General Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
135
135
135
135
Call Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dynamically Determining the Process to Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
136
136
137
138
139
Catch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
140
140
141
141
Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Checkpoints and Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Called Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Recovering After a Crash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
142
142
142
143
143
143
Confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Custom Activity
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Engine Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
TIBCO ActiveMatrix BusinessWorks Palette Reference
viii
| Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
148
149
149
150
External Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Long-Running Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
163
163
163
165
167
168
Generate Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
169
170
170
171
Get Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Inspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
173
173
174
174
JNDI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Configuration Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IBM WebSphere and JNDI Context Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
175
175
176
176
177
Job Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initial Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
178
178
178
178
Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Lock Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
183
183
183
183
Notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
184
184
184
185
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents ix
|
Notify Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Null . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
On Event Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
On Notification Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
On Shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
On Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Receive Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
194
194
195
196
Rethrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
197
197
197
197
Set Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
198
198
198
199
Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Initial Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
200
200
201
201
Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
204
204
205
206
Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
207
207
207
208
Write To Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
TIBCO ActiveMatrix BusinessWorks Palette Reference
x
| Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Custom Properties for the Write To Log Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
209
210
210
210
Chapter 6 HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
HTTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure SSL Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Custom Properties for the HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
214
215
216
217
220
HTTP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Special Characters in HTTP Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
222
222
225
226
226
227
228
Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Send HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sending Data in the HTTP Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure SSL Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Headers/Output Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Persistent Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
234
234
236
237
239
240
242
246
248
251
Send HTTP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
252
252
253
254
257
Wait for HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
258
258
260
261
262
263
265
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents xi
|
Chapter 7 Java Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Show Class Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Common Features of Java Code and Java Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Accessing TIBCO ActiveMatrix BusinessWorks Global Variables and Java System Properties . . . . . . . . 270
Sending Messages to The TIBCO ActiveMatrix BusinessWorks log4j File . . . . . . . . . . . . . . . . . . . . . . . . 271
Java Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compiling Java Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Passing Java Objects Between Java Code Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
272
272
273
275
276
277
277
277
Java Custom Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Example Java Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Java Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JavaProcessStarter Abstract Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Compiling Java Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
284
284
285
286
288
289
290
290
291
Java Global Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Java Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Caching the Java Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
295
295
297
299
300
301
301
Java Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Schema Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Java To XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
305
305
306
307
TIBCO ActiveMatrix BusinessWorks Palette Reference
xii
| Contents
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
XML To Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
309
309
310
310
311
Chapter 8 JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
JDBC Call Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
314
314
316
317
318
320
JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection Pooling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Connection Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
321
321
325
326
327
JDBC Get Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using The JDBC Connection in Java. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
328
328
329
329
331
331
JDBC Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fetch Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Prepared Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fetching Subsets of the Result Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
333
333
334
334
336
338
339
340
341
JDBC Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Prepared Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
343
343
344
345
346
347
348
Query Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents xiii
|
SQL Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
355
355
356
356
357
360
Time Zone Construction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Time Zone Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Chapter 9 JMS Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Enabling JMS in TIBCO ActiveMatrix BusinessWorks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Get JMS Queue Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
369
369
372
372
373
373
374
JMS Application Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
JMS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Connection Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SSL Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
376
376
380
381
382
JMS Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
JMS Queue Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Load-Balancing of Incoming Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
389
389
392
393
394
395
395
JMS Queue Requestor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor/Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
396
396
398
399
399
401
401
JMS Queue Sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
TIBCO ActiveMatrix BusinessWorks Palette Reference
xiv
| Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
403
405
406
406
408
408
JMS Topic Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
409
409
410
412
412
414
414
JMS Topic Requestor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor/Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
415
415
417
418
418
420
421
JMS Topic Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
422
422
426
427
427
427
Reply To JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
429
429
431
432
432
434
434
Wait for JMS Queue Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
435
435
438
439
440
440
440
441
Wait for JMS Topic Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents xv
|
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Message Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
445
446
447
448
448
449
Chapter 10 Mail Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
Receive Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Connection Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
451
451
452
453
454
455
455
Send Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
459
459
460
461
461
465
466
Chapter 11 Manual Work Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Overview of Manual Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Working With Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
Working With Tasks Assigned to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exporting Users to TIBCO InConcert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using a TIBCO InConcert Proxy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logging In and Viewing the Task Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Acquiring Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working with Tasks in the Acquired List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working with the Completed List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administering Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
473
473
474
475
477
478
478
479
Interaction With TIBCO InConcert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Assign Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
481
481
482
482
484
486
Download Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
TIBCO ActiveMatrix BusinessWorks Palette Reference
xvi
| Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
487
488
488
489
Get Work Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
490
490
490
491
493
Workflow Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
494
494
494
495
Workflow Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Test Connection Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reload Servers Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
496
496
496
497
497
Modify Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
498
498
499
500
502
Wait for Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
503
503
504
504
507
Chapter 12 Parse Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delimiter Separated Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field Offsets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
510
511
513
514
514
Parse Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parsing a Large Number of Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
516
516
518
519
520
520
Render Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents xvii
|
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
522
522
523
523
Chapter 13 Policy Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Security Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Confidentiality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
526
526
527
529
531
532
Security Policy Association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Inbound. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Outbound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
533
533
534
535
Chapter 14 Rendezvous Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 537
RawRVMsg2 Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
The RawRVMsg2 Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Adding the RawRVMsg2 Schema to Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
Datatype Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
TIBRVMSG_XML, TIBRVMSG_IPADDR32, and TIBRVMSG_IPPORT16 Datatypes . . . . . . . . . . . . . . . . 542
Raw TIBCO Rendezvous Message Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Using the RawRVMsg2 Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Field Names In Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
Internationalization Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
Publish Rendezvous Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
548
548
549
549
550
550
Rendezvous Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
551
551
553
554
554
Rendezvous Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure SSL Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
555
555
556
557
TIBCO ActiveMatrix BusinessWorks Palette Reference
xviii Contents
|
Reply to Rendezvous Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
560
560
560
560
561
Send Rendezvous Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input/Output Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
562
562
564
564
565
566
Wait for Rendezvous Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
567
567
569
570
570
570
571
Chapter 15 RMI Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
RMI Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Using RMI to Call a Remote Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Acting as a RMI Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
RMI Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
576
576
576
577
RMI Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
578
578
579
579
579
Chapter 16 Service Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Context Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
Get Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Invoke Partner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents xix
|
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Partner Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Receive Partner Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
592
592
593
593
593
Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced SOAP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Partner Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WSDL Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
595
596
602
612
613
614
Set Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
615
615
615
616
Chapter 17 SOAP Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
SOAP Specification Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Retrieve Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Retrieve Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Built-in Resource Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
620
620
622
622
624
624
625
SOAP Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WSDL File and SOAP Event Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messages With Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WSDL Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
627
627
627
629
632
633
638
639
639
SOAP Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Reload Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
TIBCO ActiveMatrix BusinessWorks Palette Reference
xx
| Contents
Test Transport Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configure SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Messages With Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
646
646
652
653
654
655
659
661
SOAP Send Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
662
662
663
664
664
SOAP Send Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
665
665
665
666
666
SOAP Messages Over the JMS Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
What's in the JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
WSDL Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
MimeParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
671
671
671
672
672
672
Chapter 18 TCP/IP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Overview of the TCP/IP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Using the TCP/IP Palette Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Read TCP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
675
675
676
677
TCP Close Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
678
678
678
678
TCP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
TIBCO ActiveMatrix BusinessWorks Palette Reference
Contents xxi
|
TCP Open Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
681
681
681
682
TCP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Misc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
683
683
683
684
Wait for TCP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
685
685
685
686
686
Write TCP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
687
687
688
688
Chapter 19 Transaction Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
JTA UserTransaction Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
Test Connection Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
Transaction State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
693
693
693
694
694
XA TransactionManager Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
Chapter 20 WSDL Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing WSDL Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Copying WSDL Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
698
698
699
701
702
Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Message Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
706
706
707
708
PortType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxii
| Contents
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Editing PortType Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Editing Operation Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
710
710
712
712
Chapter 21 XML Activities Palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
Parse XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parsing Date and Datetime Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
714
714
714
715
716
717
717
Render XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rendering Date and Datetime Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
718
718
718
719
719
719
720
721
Transform XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Example of Transforming XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
722
722
723
724
725
725
XSLT File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728
Appendix A Specifying Data Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737
TIBCO ActiveMatrix BusinessWorks Palette Reference
| xxiii
Figures
Figure 1
An Adapter Request-Response Server activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Figure 2
An Adapter Subscriber activity receiving a message and starting a process. . . . . . . . . . . . . . . . . . 25
Figure 3
An Invoke an Adapter Request-Response Service activity sending a request . . . . . . . . . . . . . . . . 29
Figure 4
A Publish to Adapter activity sending a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 5
A Respond to Adapter Request sending a response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Figure 6
A Send Exception to Adapter Request sending an exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 7
A Publish to Adapter activity sending a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Figure 8
A Wait for Adapter Request activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Figure 9
Using the Generate Error activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Figure 10
Persistent HTTP connection pool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Figure 11
Selecting a class with the Choose a Class dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Figure 12
Selecting a method in a class from the Choose a Class and Method dialog . . . . . . . . . . . . . . . . . 269
Figure 13
Compile All Code dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Figure 14
Passing objects between Java Code activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Figure 15
Compile All Code dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Figure 16
Sharing a cached class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Figure 17
Different Java Method activities in the same process do not share the class . . . . . . . . . . . . . . . . 300
Figure 18
The Query Designer wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Figure 19
An example business process with manual work. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Figure 20
Task lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Figure 21
Task detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
Figure 22
Parsing a text string into a data schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Figure 23
Fixed-width text strings and field offsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
Figure 24
Using the ipPort and ipAddr datatypes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Figure 25
Selecting a type from the RawRVMsg2 schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Figure 26
Schema for RawRVMsg2.xsd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
Figure 27
Using the RMI Lookup activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Figure 28
Using the RMI Server process starter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxiv Figures
|
Figure 29
Process definition using the Retrieve Resources activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Figure 30
Specifying a UDDI registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Figure 31
Companies returned by the Explore button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Figure 32
List of returned services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
Figure 33
A process definition using the Transform XML activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 725
Figure 34
Input for the example Transform XML activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
TIBCO ActiveMatrix BusinessWorks Palette Reference
| xxv
Tables
Table 1
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxi
Table 2
The Transport tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Table 3
Datatypes allows for Java custom functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Table 4
Time zone names for the ServerTimeZone input item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Table 5
Properties for JMS Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Table 6
Shared configuration resources for manual work activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Table 7
Description of activities in the Manual Work palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Table 8
Task list columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Table 9
TIBCO Rendezvous to TIBCO ActiveMatrix BusinessWorks datatype conversion . . . . . . . . . . . 541
Table 10
TIBCO ActiveMatrix BusinessWorks to TIBCO Rendezvous datatype conversion . . . . . . . . . . . 541
Table 11
SOAP Fault schema relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Table 12
JMS headers for SOAP messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 668
Table 13
WSDL toolbar buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699
Table 14
UDDI search types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
Table 15
Content types for schema elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
Table 16
Icons for schema datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxvi Tables
|
TIBCO ActiveMatrix BusinessWorks Palette Reference
| xxvii
Preface
TIBCO ActiveMatrix 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 ActiveMatrix BusinessWorks.
Topics
•
Changes from the Previous Release of this Guide, page xxviii
•
Related Documentation, page xxix
•
Typographical Conventions, page xxxi
•
How to Contact TIBCO Customer Support, page xxxiii
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxviii Changes from the Previous Release of this Guide
|
Changes from the Previous Release of this Guide
This section itemizes the major changes from the previous release of this guide.
Mime Parser Activity
This activity is responsible for parsing the MTOM messages into a SOAP message
that contains the binary attachments as an inline data of the SOAP message. For
details, refer to MimeParser, page 671 in Chapter 17, SOAP Palette.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Preface xxix
|
Related Documentation
This section lists documentation resources you may find useful.
TIBCO ActiveMatrix BusinessWorks Documentation
The following documents form the TIBCO ActiveMatrix BusinessWorks
documentation set:
•
TIBCO ActiveMatrix BusinessWorks Concepts Read this manual before reading
any other manual in the documentation set. This manual describes
terminology and concepts of TIBCO ActiveMatrix BusinessWorks, and the
other manuals in the documentation set assume you are familiar with the
information in this manual.
•
TIBCO ActiveMatrix BusinessWorks Getting Started This manual steps you
through a very simple example of designing, deploying, and monitoring a
ActiveMatrix BusinessWorks process.
•
ActiveMatrix BusinessWorks Process Design Guide This manual describes how
to create, edit, and test business processes using TIBCO ActiveMatrix
BusinessWorks.
•
ActiveMatrix BusinessWorks Palette Reference This manual describes each of
the palettes available in TIBCO ActiveMatrix BusinessWorks.
•
TIBCO ActiveMatrix BusinessWorks Administration This manual describes how
to use TIBCO Administrator to deploy, manage, and monitor TIBCO
ActiveMatrix BusinessWorks processes.
•
TIBCO ActiveMatrix BusinessWorks Installation Read this manual for
information on installing one or more components of ActiveMatrix
BusinessWorks and setting up a ActiveMatrix BusinessWorks domain.
•
TIBCO ActiveMatrix BusinessWorks Error Codes This manual describes errors
returned by TIBCO ActiveMatrix BusinessWorks.
•
TIBCO ActiveMatrix BusinessWorks Release Notes Read the release notes for a
list of new and changed features. This document also contains lists of known
issues and closed issues for this release.
Other TIBCO Product Documentation
TIBCO ActiveMatrix BusinessWorks is used with other products. You may find it
useful to read the documentation for the following TIBCO products:
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxx
| Related Documentation
•
TIBCO Designer™ software: 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™ software: TIBCO Administrator is the monitoring
and managing interface for new-generation TIBCO products such as TIBCO
ActiveMatrix BusinessWorks.
•
TIBCO Adapter software:
•
Third-Party Documentation
TIBCO ActiveMatrix BusinessWorks Palette Reference
Preface xxxi
|
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention
Use
TIBCO_HOME
Many TIBCO products must be installed within the same home directory. This
directory is referenced in documentation as TIBCO_HOME. The value of
TIBCO_HOME depends on the operating system. For example, on Windows
systems, the default value is C:\tibco.
ENV_HOME
BW_HOME
Other TIBCO products are installed into an installation environment.
Incompatible products and multiple instances of the same product are installed
into different installation environments. The directory into which such products
are installed is referenced in documentation as ENV_HOME. The value of
ENV_HOME depends on the operating system. For example, on Windows
systems the default value is C:\tibco.
TIBCO ActiveMatrix BusinessWorks installs into a directory within
TIBCO_HOME. This directory is referenced in documentation as BW_HOME. The
value of BW_HOME depends on the operating system. For example on Windows
systems, the default value is C:\tibco\bw\5.7.
code font
Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example:
Use MyCommand to start the foo process.
bold code
font
Bold code font is used in the following ways:
•
In procedures, to indicate what a user types. For example: Type admin.
•
In large code samples, to indicate the parts of the sample that are of
particular interest.
•
In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxxii Typographical Conventions
|
Table 1 General Typographical Conventions (Cont’d)
Convention
Use
italic font
Italic font is used in the following ways:
Key
combinations
•
To indicate a document title. For example: See TIBCO ActiveMatrix
BusinessWorks Concepts.
•
To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
•
To indicate a variable in a command or code syntax that you must replace.
For example: MyCommand pathname
Key name separated by a plus sign indicate keys pressed simultaneously. For
example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Preface xxxiii
|
How to Contact TIBCO Customer Support
For comments or problems with this manual or the software it addresses, please
contact TIBCO Support as follows.
•
For an overview of TIBCO Support, and information about getting started
with TIBCO Support, visit this site:
http://www.tibco.com/services/support
•
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user
name, you can request one.
TIBCO ActiveMatrix BusinessWorks Palette Reference
xxxiv How to Contact TIBCO Customer Support
|
TIBCO ActiveMatrix BusinessWorks Palette Reference
|1
Chapter 1
Process Palette
The Process palette allows you to create process definitions.
Topics
•
Process Definition, page 2
TIBCO ActiveMatrix BusinessWorks Palette Reference
2
| Chapter 1
Process Palette
Process Definition
Resource
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 in a process definition. The activity palettes are
described in subsequent chapters of this manual.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about creating and editing process definitions.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the process.
Description
Short description of the process.
Custom Icon File
You can choose your own custom icon for the process,
if desired. Use the Browse button to locate an image
file (GIF, JPEG, and so on) to use as the icon for this
process.
Namespace Registry
Clicking the Edit button in this field allows you to
view, add, change or delete the namespaces used in
the input partners defined for this process definition.
You can also view and edit schema and WSDL
imports
TIBCO ActiveMatrix BusinessWorks Palette Reference
Process Definition 3
|
Field
Description
Target Namespace
Target namespace of the process definition. This field
is mandatory when partners are specified in the
process definition.
This field is generated automatically whenever you
create a process definition. While creating new
processes, it is recommended that the
targetNamespace value generated automatically be
retained. Typically, this value is
http://xmlns.example.com/<rand_num>, where
<rand_num> is replaced by a random number.
If you wish to specify partners in processes that were
created in older versions, then you must provide the
targetNamespace manually.
Ensure that the value specified for targetNamespace
is unique across the project.
Process Variables
The Process Variables tab allows you to specify user-defined process variables for
the process definition. See the Processes chapter of TIBCO ActiveMatrix
BusinessWorks Process Design Guide for a complete description of user-defined
process variables.
You can assign a value to the process variables with the Assign activity. See
Assign on page 135 for more information about assigning a value to a
user-defined process variable.
This tab contains two panels:
•
The left panel allows you to add, delete, and rename process variables.
•
The right panel allows you to define data schemas for the process variable
selected in the left panel. See Appendix A, Specifying Data Schema, on
page 729 for more information about specifying data schema.
Partners
The Partners tab allows you to define partners for the process definition. The
partner can be either be located inside the same project or it can be an external
service that can be invoked over the Internet by way of SOAP protocol.
TIBCO ActiveMatrix BusinessWorks Palette Reference
4
| Chapter 1
Process Palette
The Partners tab has the following fields.
Field
Description
Partners
The Partners tab allows you to specify binding
information for partner definitions. The port type and
port type namespace fields in the table are
non-editable. To modify the value of the Port Type for
a Partner, select the Browse button at the right corner
of the field Port Type below the Partners table.
Partner Name - specifies the name used by the
process to reference a partner. Click the Browse
button on the right side to add a new Partner.
Port Type - This is a non-editable field displaying the
Port Type selected.
PortType Namespace - This is a non-editable field
displaying the PortType Namespace corresponding to
the Port Type selected.
Partner Link - specifies the partner link configuration
for the partner. This field can optionally be specified
by double-clicking on the field and browsing the list
of available partner link resources in the project.
Port Type
TIBCO ActiveMatrix BusinessWorks Palette Reference
Allows you to select an interface (port type) from the
list of available partner interfaces in the project. To
add or modify the Port Type, click the Browse
Resources button at the right end of the field and
select the Port Type you wish to add to the Partners
tab.
|5
Chapter 2
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 ActiveMatrix BusinessWorks. See your adapter documentation for
information on whether TIBCO ActiveMatrix BusinessWorks is supported.
Topics
•
Common Features Across ActiveEnterprise Activities, page 6
•
Adapter Request-Response Server, page 21
•
Adapter Subscriber, page 25
•
Invoke an Adapter Request-Response Service, page 29
•
Publish to Adapter, page 34
•
Respond to Adapter Request, page 40
•
Send Exception to Adapter Request, page 43
•
Wait for Adapter Message, page 46
•
Wait for Adapter Request, page 51
TIBCO ActiveMatrix BusinessWorks Palette Reference
6
| Chapter 2
ActiveEnterprise Adapter Palette
Common Features Across ActiveEnterprise Activities
The activities in the ActiveEnterprise Adapter palette reference Adapter
Configuration resources in your project. This section describes common features
across all activities in this palette.
Support for Message Filter Resources
An Adapter Configuration resource can use a Message Filter resource. Message
filters are used to provide custom, user-written code to transform the messages
sent or received from an adapter, call out to TIBCO Adapter SDK functions, or
perform other tasks. See TIBCO Designer Palette Reference for more information
about Message Filter resources.
The activities in the ActiveEnterprise Adapter palette support the use of Message
Filter resources. When using TIBCO Designer, the message filter is specified for
the Adapter Configuration, and the ActiveEnterprise Adapter activities
automatically make use of the class specified in the Message Filter resource.
When you deploy your project, however, you must ensure that the BusinessWorks
process engine has access to any classes specified in a Message Filter resource. For
example, if you have a Publish to Adapter activity in your process definition, the
process engine must have access to the class used when executing the
transformOutbound() message filter call. If you deploy your TIBCO Adapter
and BusinessWorks process engine on the same machine, no additional
configuration steps are required. If the components are installed on different
machines, you must place your message filter class on the machine where your
process engine is deployed and make certain the location of the message filter
class is in the CLASSPATH for the process engine (this is set in the bwengine.tra
file).
See TIBCO ActiveMatrix BusinessWorks Administration for more information about
deploying process engines.
Internationalization Support
TIBCO ActiveMatrix BusinessWorks and TIBCO Adapter products can send text
messages that are encoded using either the Latin-1 or UTF-8 character encoding.
Both the sender and receiver of the message must use the same encoding. The
character encoding sent by resources configured in TIBCO Designer is set at the
project level during design time. For deployed projects, TIBCO Administrator
allows you to set the message encoding.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Common Features Across ActiveEnterprise Activities 7
|
At design time, the message encoding property can be set when creating a new
project. In the Save Project dialog, choose either ISO8859-1 or UTF-8 in the TIBCO
Messaging Encoding option list. See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about saving projects. After the messaging
encoding is chosen, it will take effect at design time, such as in debug mode, or if
the project is running in a standalone mode before deployment.
After the project is deployed, the messaging encoding is determined by the
encoding property of the TIBCO Administrator domain. This property is set when
the domain is created. ISO8859-1 and UTF-8 are the two supported character
encoding options. The messaging encoding set for the domain overrides any
encoding set for a project.
Refresh Adapter Service Button
All activities in the ActiveEnterprise Adapter palette can use preconfigured
adapter services. These adapter service configurations can change after an
adapter service is specified in the configuration of an ActiveEnterprise Adapter
palette activity. Therefore, the configured adapter service may become
inconsistent with your process definition.
The Refresh Adapter Service button is available on most activities in the
ActiveEnterprise Adapter palette. This button allows you to synchronize your
activities with the adapter service specified in the activity. Any changes that have
occurred to the adapter service are reflected in the activity after the refresh
completes.
For example, an adapter service may change the schema it uses for incoming or
outgoing messages. When this schema change occurs, any activity using that
adapter service may no longer have the correct input and output schemas.
Clicking the Refresh Adapter Service button changes the activity to use the
current configuration of the adapter service. This invalidate input mappings, and
you may need to use the Mapper Check and Repair button on the Input tab to
correct the activity input schemas.
The Refresh Adapter Service button is only enabled when you use all settings
from the Adapter Service. That is, if you change the Transport Type on the
Transport tab to anything other than Adapter Service Default, the Refresh
Adapter Service button becomes disabled.
If you wish to keep your ActiveEnterprise Adapter activities synchronized with
an adapter service, do not change the Transport Type.
If you wish to use a different transport configuration for the activity, you should
check the Custom AESchema field on the Configuration tab and specify the
adapter service schema in the Custom AESchema Reference field, and then
modify the settings on the Transport tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
8
| Chapter 2
ActiveEnterprise Adapter Palette
Transport Tab
Transports specify the underlying communication characteristics for messages
sent and received by adapter services. Normally, the activities of the
ActiveEnterprise Adapter palette use the same transport configuration as the
adapter service with which they are communicating. However, in some
situations, you may wish to override the transport configuration of the adapter
service and use different transport parameters.
The Transport tab is available in activities in the ActiveEnterprise Adapter palette.
This tab allows you to override the transport configuration of the adapter service.
The Transport tab has different fields depending upon which transport is selected
in the Transport Type field. Table 2 describes the fields of the transport tab.
Table 2 The Transport tab
Field
Global
Var?
Transport Type
No
Description
The transport on which the incoming request
will be received. This is normally the transport
used by the adapter service, but you can
override this by specifying different transport
parameters. The possible values for this field
are:
•
Adapter Service Default
•
Tibrv Reliable
•
Tibrv Certified
•
Tibrv Certified Message Queue
•
JMS Topic
•
JMS Queue
The sub-sections of this table describe the fields
that appear when each of these options is
selected as the transport type.
Tibrv Reliable Transport
See the TIBCO Rendezvous documentation for more information about these
fields.
Subject
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
The subject of the incoming request.
Common Features Across ActiveEnterprise Activities 9
|
Table 2 The Transport tab
Field
Global
Var?
Service
Yes
The service parameter of the transport of the
incoming request.
Network
Yes
The network parameter of the transport of the
incoming request.
Daemon
Yes
The daemon parameter of the transport of the
incoming request.
SSL
No
Specifies that SSL should be used when
connecting to the TIBCO Rendezvous daemon.
See Configure SSL Button on page 18 for more
information about configuring SSL parameters.
Message Format
Yes
Specifies the message format for the message.
This can be either AE message format or AE
XML format. This field is only available on the
Transport tab of the following activities:
Description
•
Adapter Subscriber
•
Publish to Adapter
•
Wait for Adapter Message
Tibrv Certified Transport
See the TIBCO Rendezvous documentation for more information about these
fields.
Subject
Yes
The subject of the incoming request.
Service
Yes
The service parameter of the transport of the
incoming request.
Network
Yes
The network parameter of the transport of the
incoming request.
Daemon
Yes
The daemon parameter of the transport of the
incoming request.
TIBCO ActiveMatrix BusinessWorks Palette Reference
10
| Chapter 2
ActiveEnterprise Adapter Palette
Table 2 The Transport tab
Field
Global
Var?
SSL
No
Specifies that SSL should be used when
connecting to the TIBCO Rendezvous daemon.
See Configure SSL Button on page 18 for more
information about configuring SSL parameters.
CM Name
Yes
The CM name of the incoming request.
PreRegister
Listeners
Yes
This field is only available on activities that
publish messages (for example, Invoke an
Adapter Request Response Service or Publish
to Adapter).
Description
This field specifies the cmname(s) of the
certified subscriber(s). This allows the
publisher to pre-register with any expected
listeners. If multiple cmnames are specified,
separate each cmname with a comma.
Relay Agent
Yes
Name of the relay agent, if one is used.
Ledger File
Yes
Name and location of the ledger file.
Warning: TIBCO ActiveMatrix BusinessWorks
constructs the default value of this field from
global variables and the Adapter Service
configuration. The value of this field must
result in a valid path on the filesystem where
the process is run. You may need to modify the
default value in this field or modify the global
variables used in this field to make sure the
field results in a valid filesystem path.
Sync Ledger
Yes
When checked, this specifies the ledger file
should be kept synchronous (asynchronous
ledger updates are performed, if this field is
unchecked).
Default Time Limit
Yes
The default message time limit for certified
messages specified in milliseconds.
Require Old
Messages
Yes
Specifies that unconfirmed messages should be
kept in the ledger file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Common Features Across ActiveEnterprise Activities 11
|
Table 2 The Transport tab
Field
Global
Var?
Message Format
Yes
Description
Specifies the message format for the message.
This can be either AERV or XML. This field is
only available on the Transport tab of the
following activities:
•
Adapter Subscriber
•
Publish to Adapter
•
Wait for Adapter Message
Tibrv Certified Message Queue Transport
See the TIBCO Rendezvous documentation for more information about these
fields.
Subject
Yes
The subject of the incoming request.
Service
Yes
The service parameter of the transport of the
incoming request.
Network
Yes
The network parameter of the transport of the
incoming request.
Daemon
Yes
The daemon parameter of the transport of the
incoming request.
SSL
No
Specifies that SSL should be used when
connecting to the TIBCO Rendezvous daemon.
See Configure SSL Button on page 18 for more
information about configuring SSL parameters.
CMQ Name
Yes
The CMQ name of the incoming request.
Complete Time
Yes
The amount of time (in seconds) the scheduler
waits for a worker process to complete. If the
worker process does not complete in the
specified period, the scheduler reassigns the
message to another worker.
Scheduler Weight
Yes
The scheduler weight for the process engine.
Scheduler
Heartbeat
Yes
The scheduler heartbeat interval (in
milliseconds).
TIBCO ActiveMatrix BusinessWorks Palette Reference
12
| Chapter 2
ActiveEnterprise Adapter Palette
Table 2 The Transport tab
Field
Global
Var?
Description
Scheduler
Activation
Yes
The scheduler activation interval (in
milliseconds).
Worker Weight
Yes
The worker weight for the process engine.
Worker Tasks
Yes
The maximum number of incoming adapter
requests this process engine can accept.
Message Format
Yes
Specifies the message format for the message.
This can be either AERV or XML. This field is
only available on the Transport tab of the
following activities:
•
Adapter Subscriber
•
Wait for Adapter Message
JMS Topic Transport
See the TIBCO Enterprise Message Service documentation for more
information about these fields.
Topic
Yes
The topic name of the incoming request.
Auto Confirm
No
Specifies whether the incoming request should
be automatically confirmed. This field is only
available for activities that receive messages
(for example, Adapter Subscriber).
TIBCO ActiveMatrix BusinessWorks Palette Reference
Common Features Across ActiveEnterprise Activities 13
|
Table 2 The Transport tab
Field
Global
Var?
Transactional
No
Description
This field is only available for activities that
receive messages (for example, Adapter
Subscriber).
Check this field when a transaction that can
process JMS messages is included in the
process definition and you want the incoming
message to be a part of the transaction. Any
reply or exception message associated with the
incoming message is also part of the
transaction.
The message is acknowledged when the
transaction commits. Checking this field
disables the Auto Confirm field.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
creating transactions.
Override
Transaction
No
This field is only available for activities that
publish messages (such as Publish to Adapter
or Invoke an Adapter Request-Response
Service).
By default, ActiveEnterprise Adapter activities
that are included in the appropriate transaction
group are included in the transaction. Check
this field if you wish to exclude the activity
from the transaction.
TIBCO ActiveMatrix BusinessWorks Palette Reference
14
| Chapter 2
ActiveEnterprise Adapter Palette
Table 2 The Transport tab
Field
Global
Var?
Durable
No
Description
Specifies whether the client making the request
is a durable subscriber. The durable
subscription name is a concatenation of the
process definition name and the name of the
activity.
This field is only available on the Transport tab
of the following activities:
•
Adapter Subscriber
•
Adapter Request-Response Server
•
Wait for Adapter Message
•
Wait for Adapter Request
Durable Name
No
When the Durable field is checked, you can
specify the name of the durable subscription
that is registered with the JMS server in this
field. This field is only available when the
Durable field is checked.
Delivery Mode
No
This field is only available on the Transport tab
of the Publish to Adapter or Invoke an Adapter
Request-Response Service activities.
This field specifies the delivery mode of the
published message. This can be either
persistent or non-persistent.
Time To Live
Yes
This field is only available on the Transport tab
of the Publish to Adapter or Invoke an Adapter
Request-Response Service activities.
This field specifies the expiration time (in
milliseconds) for the message. Specifying zero
signifies the message should never expire.
JNDI Lookups
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Specifies that references to the JMS objects
(ConnectionFactory, Topic, and so on) should
be obtained from a JNDI server.
Common Features Across ActiveEnterprise Activities 15
|
Table 2 The Transport tab
Field
Global
Var?
SSL
No
Specifies that SSL should be used when
connecting to the JMS server. See Configure
SSL Button on page 18 for more information
about configuring SSL parameters.
Topic Connection
Factory Name
Yes
Specifies the Topic ConnectionFactory object.
Connection User
Name
Yes
User name to use when connecting to the JMS
server.
Password
Yes
Password to use when connecting to the JMS
server.
Provider URL
Yes
URL for the JMS server.
JMS Application
Properties
No
Any application-specific message properties
that will be part of the message. This is
specified by the JMS Application Properties
shared configuration resource.
Description
Once specified, these properties appear on the
Input or Output tab as "OtherProperties".
Transacted Session
Yes
Specifies if the AE Event Source is a part of a
transaction. When checked, this field disables
Transactional and Auto Confirm. The fields
Precreate Transactions and XA Transaction
Manager will not visible.
Precreate
Transactions
Yes
When checked, this field specifies that the
transaction is created before a message arrives
at the JMS receiver. This field is available when
Transactional field is checked.
XA Transaction
Manager
Yes
Specifies the XA Transaction Manager
Configuration used to create the XA
transaction. This field is available when
Precreate Transactions field is checked.
TIBCO ActiveMatrix BusinessWorks Palette Reference
16
| Chapter 2
ActiveEnterprise Adapter Palette
Table 2 The Transport tab
Field
Global
Var?
Description
JMS Queue Transport
See the TIBCO Enterprise Message Service documentation for more
information about these fields.
Queue
Yes
The queue name of the incoming request.
Delivery Mode
No
This field is only available on the Transport tab
of the Publish to Adapter or Invoke an Adapter
Request-Response Service activities.
This field specifies the delivery mode of the
published message. This can be either
persistent or non-persistent.
Time To Live
Yes
This field is only available on the Transport tab
of the Publish to Adapter or Invoke an Adapter
Request-Response Service activities.
This field specifies the expiration time (in
milliseconds) for the message. Specifying zero
signifies the message should never expire.
Transactional
No
This field is only available for activities that
receive messages (for example, Adapter
Subscriber).
Check this field when a transaction that can
process JMS messages is included in the
process definition and you want the incoming
message to be a part of the transaction. Any
reply or exception message associated with the
incoming message is also part of the
transaction.
The message is acknowledged when the
transaction commits. Checking this field
disables the Auto Confirm field.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
creating transactions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Common Features Across ActiveEnterprise Activities 17
|
Table 2 The Transport tab
Field
Override
Transaction
Global
Var?
No
Description
This field is only available for activities that
publish messages (such as Publish to Adapter
or Invoke an Adapter Request-Response
Service).
By default, ActiveEnterprise Adapter activities
that are included in the appropriate transaction
group are included in the transaction. Check
this field if you wish to exclude the activity
from the transaction.
JNDI Lookups
No
Specifies that references to the JMS objects
(ConnectionFactory, Queue, and so on) should
be obtained from a JNDI server.
SSL
No
Specifies that SSL should be used when
connecting to the JMS server. See Configure
SSL Button on page 18 for more information
about configuring SSL parameters.
Queue Connection
Factory Name
Yes
Specifies the Queue ConnectionFactory object.
Connection User
Name
Yes
User name to use when connecting to the JMS
server.
Password
Yes
Password to use when connecting to the JMS
server.
Provider URL
Yes
URL for the JMS server.
JMS Application
Properties
No
Any application-specific message properties
that will be part of the message. This is
specified by the JMS Application Properties
shared configuration resource.
Once specified, these properties appear on the
Input or Output tab as "OtherProperties".
TIBCO ActiveMatrix BusinessWorks Palette Reference
18
| Chapter 2
ActiveEnterprise Adapter Palette
Table 2 The Transport tab
Field
Global
Var?
Transacted Session
No
Specifies if the AE Event Source is a part of a
transaction. When checked, this field disables
the Precreate Transactions at the receiver and
the fields Precreate Transactions and XA
Transaction Manager Reference are not visible.
Precreate
Transactions
Yes
When checked, this field specifies that the
transaction is created before a message arrives
at the JMS receiver. This field is available when
Transactional field is checked.
XA Transaction
Manager
Reference
Yes
Specifies the XA Transaction Manager
Configuration used to create the XA
transaction. This field is available when
Precreate Transactions field is checked.
Description
Configure SSL Button
The Configure SSL button allows you to configure the SSL parameters when the
transport supports SSL and the SSL field is checked. The following are the fields
of the Configure SSL dialog.
Basic
The Basic tab of the SSL Configuration dialog allows you to specify the simplest
required SSL configuration parameters for the connection. The Basic tab has the
following fields:
Field
Description
Trusted Certificates
Folder
Location of the trusted certificates on this
machine. The trusted certificates are a collection of
certificates from servers to whom you will
establish connections. If the server you wish to
establish a connection to presents a certificate that
does not match one of your trusted certificates,
the connection is refused.
(JMS Transports)
This prevents connections to unauthorized
servers.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Common Features Across ActiveEnterprise Activities 19
|
Field
Description
Daemon Certificate
File containing one or more certificates from
trusted certificate authorities. This file is checked
when connecting to a daemon to ensure that the
connection is to a daemon that is trusted. This
prevents connections to rogue TIBCO
Rendezvous daemons that attempt to
impersonate trusted daemons.
(TIBCO Rendezvous
transports)
You can retrieve a daemon’s certificate using the
administration interface in TIBCO Rendezvous.
See the TIBCO Rendezvous documentation for
more information about obtaining certificates
through the administration interface. Once
retrieved, you can select a folder in your project
and import this certificate into the folder using the
Tools>Trusted Certificates>Import Into PEM
Format menu item.
Identity
This is an Identity resource used to authenticate to
the JMS server or TIBCO Rendezvous daemon.
The Browse button allows you to select from a list
of appropriately configured Identity resources.
For TIBCO Rendezvous transports, only Identity
resources with the Type field set to Identity File or
Username/Password are listed.
See TIBCO Designer Palette Reference for more
information.
Advanced
The Advanced tab of the SSL Configuration dialog allows you to specify more
advanced SSL configuration parameters for the connection. The Advanced tab is
available only for JMS transports.
Field
Description
Trace
Specifies whether SSL tracing should be enabled
during the connection. If checked, the SSL connection
messages are logged and sent to the console.
TIBCO ActiveMatrix BusinessWorks Palette Reference
20
| Chapter 2
ActiveEnterprise Adapter Palette
Field
Description
Debug Trace
Specifies whether SSL debug tracing should be
enabled during the connection. Debug tracing
provides more detailed messages than standard
tracing.
Verify Host Name
Specifies whether to verify that the host you are
connecting to is the expected host. The host name in
the host’s digital certificate is compared against the
value you specify in the Expected Host Name field. If
the host name does not match the expected host
name, the connection is refused.
Expected Host Name
Specifies the name of the host you are expecting to
connect to. This field is only relevant if the Verify
Host Name field is also checked.
If the name of the host in the host’s digital certificate
does not match the value specified in this field, the
connection is refused.
This prevents other hosts from attempting to
impersonate the specified host.
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified
with the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Adapter Request-Response Server 21
|
Adapter Request-Response Server
Process Starter
Starts a process based on the receipt of a request from an adapter.
The adapter sends a request using a preconfigured
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 using
the Respond to Adapter Request activity.
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
RequestResponse
Invocation
Service
Request
Business Process
Adapter
RequestResponse
Server
TIBCO ActiveMatrix BusinessWorks Palette Reference
22
| Chapter 2
ActiveEnterprise Adapter Palette
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Adapter Service
No
The preconfigured adapter request-response
invocation service. You must specify the adapter
service when configuring the adapter.
Description
Use the Browse button to locate the appropriate
service for this activity.
Operation
No
This field contains a drop down list of any
operations defined by the schema used in the
selected Adapter Service. Select the operation
that this process definition implements.
Transport
See Transport Tab on page 8 for more information about the Transport tab.
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Adapter Request-Response Server 23
|
Field
Description
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequenceNumber
string
This element is only available when
Tibrv Certified is the transport. This
element contains the sequence
number in which this message was
received.
certifiedSender
string
This element is only available when
Tibrv Certified is the transport. This
element contains the cmname of the
message sender.
trackingInfo
complex
The AE tracking info of the sender.
This element contains the tracking ID
and appInfo sent by the application.
MessageID
string
This element is only available when
JMS Topic or JMS Queue is the
transport. This is the message ID of
the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
24
| Chapter 2
ActiveEnterprise Adapter Palette
Output Item
Datatype
Description
JMSHeaders
complex
This element is only available when
JMS Topic or JMS Queue is the
transport.
This element contains the message
header fields for the message. See
JMS Properties on page 385 for more
information about message header
fields. Only properties applicable to
this type of message are displayed.
OtherProperties
complex
This element is only available when
JMS Topic or JMS Queue is the
transport and a JMS Application
Properties resource is specified on
the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message
properties. Only properties
applicable to this type of message are
displayed.
body
TIBCO ActiveMatrix BusinessWorks Palette Reference
complex
The class specified for the client
service of the specified adapter
configuration.
Adapter Subscriber 25
|
Adapter Subscriber
Process Starter
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.
Figure 2 An Adapter Subscriber activity receiving a message and starting a process
Application
Adapter
Publishing
Service
Publish
Business Process
Adapter
Subscriber
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
Description
The name to appear as the label for the activity
in the process definition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
26
| Chapter 2
ActiveEnterprise Adapter Palette
Field
Global
Var?
Description
Description
No
Short description of the activity.
Adapter Service
No
The preconfigured adapter publishing service.
You must specify the adapter service when
configuring the adapter.
Use the Browse button to locate the appropriate
service for this activity.
Custom
AESchema
No
Specifies whether you wish to supply an output
class for this activity.
Custom
AESchema
Reference
No
Only appears when the Custom AESchema field
is checked. This field specifies the TIBCO
ActiveEnterprise class to use for the body of the
output message of this activity.
Transport
See Transport Tab on page 8 for more information about the Transport tab.
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Adapter Subscriber 27
|
Field
Description
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequenceNumber
string
This element is only available
when Tibrv Certified is the
transport. This element contains
the sequence number in which this
message was received.
certifiedSender
string
This element is only available
when Tibrv Certified is the
transport. This element contains
the cmname of the message sender.
trackingInfo
complex
The AE tracking info of the sender.
This element contains the tracking
ID and appInfo sent by the
application.
MessageID
string
This element is only available
when JMS Topic or JMS Queue is
the transport. This is the message
ID of the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
28
| Chapter 2
ActiveEnterprise Adapter Palette
Output Item
Datatype
Description
JMSHeaders
complex
This element is only available
when JMS Topic or JMS Queue is
the transport.
This element contains the message
header fields for the message. See
JMS Properties on page 385 for
more information about message
header fields. Only properties
applicable to this type of message
are displayed.
OtherProperties
complex
This element is only available
when JMS Topic or JMS Queue is
the transport and a JMS
Application Properties resource is
specified on the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message
properties. Only properties
applicable to this type of message
are displayed.
body
TIBCO ActiveMatrix BusinessWorks Palette Reference
complex
The class specified for the
publication service of the specified
adapter configuration.
Invoke an Adapter Request-Response Service 29
|
Invoke an Adapter Request-Response Service
Activity
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
RequestResponse
Service
Request
Business Process
Invoke an Adapter
Request-Response
Service
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
Description
The name to appear as the label for the activity in
the process definition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
30
| Chapter 2
ActiveEnterprise Adapter Palette
Field
Global
Var?
Description
Description
No
Short description of the activity.
Adapter
Service
No
The preconfigured 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.
You can choose services configured with the
RVCMQ transport, but the transport is converted to
RVCM when used by this activity. This is because
the RVCMQ transport does not apply to publishing
activities.
Operation
No
This field contains a drop down list of any
operations defined by the schema used in the
selected Adapter Service. Select the operation that
you wish to invoke.
One Way
No
This is a read-only field that displays whether the
selected operation is one-way.
Transport
See Transport Tab on page 8 for more information about the Transport tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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 specifying a subject here.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Invoke an Adapter Request-Response Service 31
|
Input Item
Datatype
Description
requestTimeout
integer
The time to wait (in milliseconds) for the
synchronous request-reply operation to
complete. An error is returned if the
operation does not complete in this time
limit.
replySubject
string
The Subject/Destination that is used to
send the response when using the
RV/JMS transport.
businessKey
string
This string is appended to the AE
tracking info appInfo field. The AE
tracking info for messages published is a
concatenation of bw + <processName> +
<jobID> + <businessKey>.
Note: It is a good idea to have all
publishers in a process use the same
business key. Only the most recent
publisher’s business key is used in the
tracking info for the message.
OtherProperties
complex
This element is only available when JMS
Topic or JMS Queue is the transport and a
JMS Application Properties resource is
specified on the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
body
complex
The input parameters for the specified
operation. The input parameters are
defined by the operation class for the
specified Adapter Service for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
32
| Chapter 2
ActiveEnterprise Adapter Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
replyDestination
string
A reply message can optionally have a
reply destination, presumably so that the
two applications can communicate with
further messages. This element contains
the reply subject (RV) or destination (JMS)
set on the reply message, if one is set. If no
reply subject or destination is set on the
reply message, this element is not
populated.
trackingInfo
string
The AE tracking info.
The id element is set to the same value for
all message publishers in a process
definition. The appInfo element is
obtained from the businessKey element
on the Input tab.
JMSHeaders
complex
This element is only available when JMS
Topic or JMS Queue is the transport.
This element contains the message header
fields for the message. See JMS Properties
on page 385 for more information about
message header fields. Only properties
applicable to this type of message are
displayed.
OtherProperties
complex
This element is only available when JMS
Topic or JMS Queue is the transport and a
JMS Application Properties resource is
specified on the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Invoke an Adapter Request-Response Service 33
|
Output Item
Datatype
Description
body
complex
The reply schema for the specified
operation.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be
serialized.
DeserializationException
The incoming response message cannot
be serialized.
ConfirmationException
The message could not be confirmed.
TimeoutException
A timeout occurred.
operationException
The adapter service returned an
exception encountered while performing
the operation. Any exception class
defined on the operation schema can be
returned.
The potential exceptions are displayed as
a choice element for activities after an
error transition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
34
| Chapter 2
ActiveEnterprise Adapter Palette
Publish to Adapter
Activity
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
preconfigured adapter subscription service.
Figure 4 A Publish to Adapter activity sending a message
Application
Adapter
Subscription
Service
Publish
Business Process
Publish to
Adapter
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
Publish to Adapter 35
|
Field
Global
Var?
Description
Adapter Service
No
The preconfigured adapter subscription service.
You must specify the adapter service when
configuring the adapter.
Use the Browse button to locate the appropriate
service for this activity.
You can choose services configured with the
RVCMQ transport, but the transport is
converted to RVCM when used by this activity.
This is because the RVCMQ transport does not
apply to publishing activities.
RequestReply
No
Specifies that this publish activity is sending a
request message and expecting a response
message. This is similar to using the Invoke an
Adapter Request-Response Service activity,
except this activity uses an adapter Subscription
service instead of a Request-Response service.
When this field is checked, the Request AE
Schema and Reply AE Schema fields appear.
Also, the replyDestination element appears in
the activity output.
Request AE
Schema
No
Only appears when the RequestReply field is
checked. This field specifies the TIBCO
ActiveEnterprise schema to use for the body of
the message in the input of this activity.
Reply AE
Schema
No
Only appears when the RequestReply field is
checked. This field specifies the TIBCO
ActiveEnterprise schema to use as the output
reply message.
Custom
AESchema
No
Specifies whether you wish to supply a class for
this activity’s input.
Custom
AESchema
Reference
No
Only appears when the Custom AESchema field
is checked. This field specifies the TIBCO
ActiveEnterprise schema to use for the body of
the message in the input of this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
36
| Chapter 2
ActiveEnterprise Adapter Palette
Transport
See Transport Tab on page 8 for more information about the Transport tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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 specifying a subject here.
requestTimeout
integer
When publishing in request/reply mode,
this element specifies the timeout (in
milliseconds) to wait for the reply.
preRegisterListener
string
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. Any listeners preregistered on the
Transport tab are also preregistered with
the listeners specified in this element.
See the TIBCO Rendezvous documentation
for more information about RVCM.
replySubject
TIBCO ActiveMatrix BusinessWorks Palette Reference
string
The subject that replies to this message
should be sent to.
Publish to Adapter 37
|
Input Item
Datatype
Description
businessKey
string
This string is appended to the AE tracking
info appInfo field. The AE tracking info for
messages published is a concatenation of
bw + <processName> + <jobID> +
<businessKey>.
The AE tracking info id is set to the same
value for all message publishers in a
process definition.
Note: It is a good idea to have all publishers
in a process use the same business key.
Only the most recent publisher’s business
key is used in the tracking info for the
message.
OtherProperties
complex
This element is only available when JMS
Topic or JMS Queue is the transport and a
JMS Application Properties resource is
specified on the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
body
complex
The schema definition for the specified
adapter service. This can be overridden by
specifying a different schema in the Custom
AESchema Reference field on the
Configuration tab, or by specifying a
Request AE Schema when RequestReply is
checked on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
38
| Chapter 2
ActiveEnterprise Adapter Palette
Output
This activity only produces output when the RequestReply field on the
Configuration tab is checked. The output for the activity is the following.
Output Item
Datatype
Description
replyDestination
string
A reply message can optionally have a
reply destination, presumably so that the
two applications can communicate with
further messages. This element contains the
reply subject (RV) or destination (JMS) set
on the reply message, if one is set. If no
reply subject or destination is set on the
reply message, this element is not
populated.
trackingInfo
string
The AE tracking info.
The id element is set to the same value for
all message publishers in a process
definition. The appInfo element is obtained
from the businessKey element on the Input
tab.
MessageID
string
This element is only available when JMS
Topic or JMS Queue is the transport. This is
the message ID of the message.
JMSHeaders
complex
This element is only available when JMS
Topic or JMS Queue is the transport.
This element contains the message header
fields for the message. See JMS Properties
on page 385 for more information about
message header fields. Only properties
applicable to this type of message are
displayed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Publish to Adapter 39
|
Output Item
Datatype
Description
OtherProperties
complex
This element is only available when JMS
Topic or JMS Queue is the transport and a
JMS Application Properties resource is
specified on the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
body
complex
The specified reply schema.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be
serialized.
TimeoutException
The specified timeout has been reached
for the request/reply operation.
TIBCO ActiveMatrix BusinessWorks Palette Reference
40
| Chapter 2
ActiveEnterprise Adapter Palette
Respond to Adapter Request
Activity
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 in 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.
Figure 5 A Respond to Adapter Request sending a response
Application
Adapter
RequestResponse
Invocation
Service
Reply
Business Process
Respond to Adapter
Request
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
Respond to Adapter Request 41
|
Field
Global
Var?
Description
Reply For
No
drop down list of activities that this activity can
send a response for.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
businessKey
string
This string is appended to the AE
tracking info appInfo field. The AE
tracking info for messages
published is a concatenation of
bw + <processName> + <jobID> +
<businessKey>.
Note: It is a good idea to have all
publishers in a process use the
same business key. Only the most
recent publisher’s business key is
used in the tracking info for the
message.
body
complex
The schema definition for the
response. The structure of this
element is retrieved from the
adapter service of the activity that
this activity is publishing a
response for.
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
42
| Chapter 2
ActiveEnterprise Adapter Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing reply cannot be serialized.
ReplyException
The reply could not be sent.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Exception to Adapter Request 43
|
Send Exception to Adapter Request
Activity
The Send Exception to Adapter Request activity is used to send an
exception to an adapter for a previously received request. For
example, you may have a Adapter Request-Response Server
process starter in a process definition. An error may occur while
attempting to perform the requested operation. The Send
Exception to Adapter Request activity allows you to return an exception to the
adapter service with information about the exception.
Figure 6 illustrates a Send Exception to Adapter Request activity sending an
exception to a previously received request from an adapter.
Figure 6 A Send Exception to Adapter Request sending an exception
Application
Adapter
RequestResponse
Invocation
Service
Reply
Business Process
Send Exception to
Adapter Request
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
44
| Chapter 2
ActiveEnterprise Adapter Palette
Field
Global
Var?
Description
Send
Exception To
No
drop down list of activities that this activity can
send an exception to.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
businessKey
string
This string is appended to the AE
tracking info appInfo field. The AE
tracking info for messages
published is a concatenation of
bw + <processName> + <jobID> +
<businessKey>.
Note: It is a good idea to have all
publishers in a process use the
same business key. Only the most
recent publisher’s business key is
used in the tracking info for the
message.
body
complex
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
The schema definition for the
exception. The schema used by the
adapter service must define
exception schemas that can be sent.
Send Exception to Adapter Request 45
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing reply cannot be serialized.
ReplyException
The exception could not be sent.
TIBCO ActiveMatrix BusinessWorks Palette Reference
46
| Chapter 2
ActiveEnterprise Adapter Palette
Wait for Adapter Message
Activity
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.
See Scalability With Incoming Events on page 226 in TIBCO ActiveMatrix
BusinessWorks Process Design Guide for information on running the "Wait for..."
activities in a multi-engine mode.
Figure 7 illustrates an adapter publishing service publishing a message and the
Wait for Adapter Message activity receiving the message in a business process.
Figure 7 A Publish to Adapter activity sending a message
Application
Adapter
Publishing
Service
Publish
Business Process
Wait for
Adapter
Message
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Adapter Message 47
|
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Adapter
Service
No
The preconfigured adapter publishing service. You
must specify the adapter service when configuring
the adapter.
Description
Use the Browse button to locate the appropriate
service for this activity.
Custom
AESchema
No
Specifies whether you wish to supply a class for this
activity’s output.
Custom
AESchema
Reference
No
Only appears when the Custom AESchema field is
checked. This field specifies the TIBCO
ActiveEnterprise schema to use for the body of the
message in the output of this activity.
Transport
See Transport Tab on page 8 for more information about the Transport tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
48
| Chapter 2
ActiveEnterprise Adapter Palette
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 ActiveMatrix
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 waits if it is received before
this activity is executed. If the event timeout expires,
an error is logged and the event is discarded.
If no value is specified in this field, the message
waits indefinitely. If zero is specified, the event is
discarded immediately, unless this activity has
already been reached.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Adapter Message 49
|
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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 48 for an example of
using the Candidate Event Key
field with the key input item.
processTimeout
integer
The time (in milliseconds) to wait
for the incoming message. An error
is returned if the message is not
received in this time limit.
Output
The output for the activity is the following.
Output Item
Datatype
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequenceNumber
string
This element is only available
when Tibrv Certified is the
transport. This element contains
the sequence number in which this
message was received.
certifiedSender
string
This element is only available
when Tibrv Certified is the
transport. This element contains
the cmname of the message sender.
TIBCO ActiveMatrix BusinessWorks Palette Reference
50
| Chapter 2
ActiveEnterprise Adapter Palette
Output Item
Datatype
Description
trackingInfo
complex
The AE tracking info of the sender.
This element contains the tracking
ID and appInfo sent by the
application.
body
complex
The class specified for the
publication service of the specified
adapter configuration or in the
Custom AESchema Reference field
on the Configuration tab.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ActivityTimedOutException
The specified processTimeout has been
reached.
TransportException
The transport cannot be created.
DeserializationException
The outgoing reply cannot be serialized.
ConfirmationException
The message could not be confirmed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Adapter Request 51
|
Wait for Adapter Request
Activity
Waits for the receipt of a request from an adapter request-response
invocation service. The adapter sends a request using a
preconfigured 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.
See Scalability With Incoming Events on page 226 in TIBCO ActiveMatrix
BusinessWorks Process Design Guide for information on running the "Wait for..."
activities in a multi-engine mode.
Figure 8 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 8 A Wait for Adapter Request activity
Application
Adapter
RequestResponse
Invocation
Service
Request
Business Process
Wait for
Adapter
Request
TIBCO ActiveMatrix BusinessWorks Palette Reference
52
| Chapter 2
ActiveEnterprise Adapter Palette
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Adapter Service
No
The preconfigured adapter request-response
invocation service. You must specify the adapter
service when configuring the adapter.
Description
Use the Browse button to locate the appropriate
service for this activity.
Operation
No
This field contains a drop down list of any
operations defined by the schema used in the
selected Adapter Service. Select the operation
that this process definition is waiting for.
Transport
See Transport Tab on page 8 for more information about the Transport tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Adapter Request 53
|
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 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.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO ActiveMatrix
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 waits if it is received before
this activity is executed. If the event timeout expires,
an error is logged and the event is discarded.
If no value is specified in this field, the message
waits indefinitely. If zero is specified, the event is
discarded immediately, unless this activity has
already been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
54
| Chapter 2
ActiveEnterprise Adapter Palette
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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 Request activity proceeds.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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 53 for an example of
using the Candidate Event Key
field with the key input item.
processTimeout
integer
The time (in milliseconds) to wait
for the incoming message. An error
is returned if the message is not
received in this time limit.
Output
The output for the activity is the following.
Output Item
Datatype
Description
subject
string
The subject of the message.
certifiedSequenceNumber
string
This element is only available when
Tibrv Certified is the transport. This
element contains the sequence
number in which this message was
received.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Adapter Request 55
|
Output Item
Datatype
Description
certifiedSender
string
This element is only available when
Tibrv Certified is the transport. This
element contains the cmname of the
message sender.
trackingInfo
complex
The AE tracking info of the sender.
This element contains the tracking ID
and appInfo sent by the application.
MessageID
string
This element is only available when
JMS Topic or JMS Queue is the
transport. This is the message ID of
the message.
JMSHeaders
complex
This element is only available when
JMS Topic or JMS Queue is the
transport.
This element contains the message
header fields for the message. See
JMS Properties on page 385 for more
information about message header
fields. Only properties applicable to
this type of message are displayed.
OtherProperties
complex
This element is only available when
JMS Topic or JMS Queue is the
transport and a JMS Application
Properties resource is specified on
the Transport tab.
This element contains the message
properties for the message. See JMS
Properties on page 385 for more
information about message
properties. Only properties
applicable to this type of message are
displayed.
body
complex
The class specified for the client
service of the specified adapter
configuration or the schema specified
in the Custom AESchema Reference
field on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
56
| Chapter 2
ActiveEnterprise Adapter Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 57
Chapter 3
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
•
Copy File, page 58
•
Create File, page 61
•
File Poller, page 64
•
List Files, page 69
•
Read File, page 72
•
Remove File, page 75
•
Rename File, page 77
•
Wait for File Change, page 80
•
Write File, page 85
TIBCO ActiveMatrix BusinessWorks Palette Reference
58
| Chapter 3
File Palette
Copy File
Activity
The Copy File activity allows you to copy files and directories to a new
location.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Overwrite
No
Overwrite existing file or directory with the same
name, if one exists.
Description
The activity raises an exception if the specified
file or directory exists and this field is unchecked.
Create
Destination
Directory
No
Include
Sub-Directories
No
Create any directories in the destination path
that do not already exist.
This activity raises an exception if any of the
directories on the specified destination path do
not exist and this field is unchecked.
When the source to copy is a directory, include
all sub-directories in the source directory.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Copy File 59
|
The input for the activity is the following.
Input Item
Datatype
Description
fromFileName
string
The path and name of the file or directory to
copy.
For directories, you must specify an absolute
path. You may use wildcards when specifying
files within a directory.
For example, to copy a directory, specify
To copy all text files in a
directory, specify c:\myDirectory\*.txt.
c:\myDirectory.
toFileName
string
The destination for the copy operation. This
must be an absolute path; wildcards cannot be
used in this element.
Output
This activity produces no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The source file is not found or the
destination is not found and the Create
Destination Directory field is not checked
on the Configuration tab.
IllegalCopyException
The destination exists and its type is
different than the type of the specified
source. For example, in the activity input,
the fromFileName is a directory and the
toFileName is a file.
FileAlreadyExistsException
The destination you are attempting to copy
to already exists and the Overwrite field is
not checked on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
60
| Chapter 3
File Palette
Exception
Thrown When...
FileIOException
There is an I/O error. For example, the file
or directory already exists and is write
protected.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Create File 61
|
Create File
Activity
The Create File activity creates a new file or directory with the specified
name. When creating a file, you can also provide the file contents.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Overwrite
No
Overwrite existing file with the same name, if one
exists.
Description
The activity raises an exception if the specified file
exists and this field is unchecked.
Is a Directory
No
When checked, the activity creates a directory
instead of a file.
Create
Non-Existing
Directories
No
When checked, the activity creates all directories in
the specified path, if they do not already exist.
If this field is unchecked and there are one or more
directories in the specified path that do not exist, an
exception is raised.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
62
| Chapter 3
File Palette
The input for the activity is the following.
Input Item
Datatype
Description
fileName
string
The path and name of the file to
create.
If the Is a Directory field is checked
on the Configuration tab, this
specifies the name of the directory
to create.
Output
The output for the activity is the following.
Output Item
Datatype
Description
fileInfo
complex
Element containing the fileName,
location, type, readProtected,
writeProtected, and size data.
fullName
string
The name of the file or directory,
including the path information.
fileName
string
The name of the file or directory without
the path information.
location
string
The path to the file or directory.
configuredFileName
string
This element is optional and it is not
populated by this activity.
type
string
The file type.
readProtected
boolean
Whether the file or directory is protected
from reading.
writeProtected
boolean
Whether the file or directory is protected
from writing.
size
integer
Size of the file (in bytes).
lastModified
string
Time stamp indicating when the file was
last modified.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Create File 63
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileAlreadyExistsException
The file or directory you are attempting to
create already exists and the Overwrite
field is not checked on the Configuration
tab.
FileIOException
There is an I/O error. For example, the file
or directory already exists and is write
protected.
TIBCO ActiveMatrix BusinessWorks Palette Reference
64
| Chapter 3
File Palette
File Poller
Process Starter
The File Poller process starter polls for files or directories with the given
name and starts a process when the specified change (creation,
modification, deletion) is detected.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
File Name
Yes
The path and name of the file or directory to
monitor. Use the Browse button to locate an
existing file.
Description
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 with an
extension of .log.
Polling Interval
(sec)
Yes
Polling interval (in seconds) to check for the
specified file.
Include
Existing Files
No
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 a change in the file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
File Poller 65
|
Field
Global
Var?
Description
Exclude File
Content
No
Specifies not to load the data from the file into
this activity’s output. If this check box is selected,
the contents of the file are not available to
subsequent activities in the process definition.
Content as
Yes
The type of content in the file. Can be either text
or binary.
Encoding
Yes
The character encoding for the file (when text is
specified in the Content as field).
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Description
Poll for Create
Events
No
Checking this field starts a new process when a
file or directory matching the specification in the
File Name field is created. If this field is
unchecked, newly created files/directories are
ignored.
Poll for Modify
Events
No
Checking this field starts a new process when a
file or directory matching the specification in the
File Name field is modified. If this field is
unchecked, modifications to files/directories are
ignored.
Poll for Delete
Events
No
Checking this field starts a new process when a
file or directory matching the specification in the
File Name field is deleted. If this field is
unchecked, deletions of files/directories are
ignored.
Include
Sub-Directories
No
When this field is checked, events that occur in
subdirectories of the specified directory are also
monitored. If this field is unchecked, only the
directory is monitored, any subdirectories are
ignored.
TIBCO ActiveMatrix BusinessWorks Palette Reference
66
| Chapter 3
File Palette
Field
Global
Var?
Description
Mode
No
Specifies the type of polling to perform. Specify
one of the following:
Sort By
No
•
only-directories — only tracks the specified
changes for directories.
•
only-files — only tracks the specified changes
for files.
•
files-and-directories — tracks the specified
changes for both files and directories.
Specifies the order in which files should be
processed, if more than one file is detected. You
can sort by file name, modification date, or
specify no sorting is to be performed.
Files are processed as the polling interval occurs.
Therefore, the Sort By field applies to all files that
have changed since the last polling interval. The
Sort By field can be very useful if you wish to
process files in a specific order when the process
engine starts and the Include Existing Files field
is checked (then all existing files are processed in
the specified order).
Note: The File Poller starts process instances
based on the specified Sort By order, but the
process instances may not complete in the same
order. If you wish to guarantee that processes
start and complete in a given order, you must
specify Max Jobs = 1 and enable the Activatation
Limit field when you deploy your project. See
TIBCO ActiveMatrix BusinessWorks Administration
for more information about deploying projects.
Sort Order
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Specifies whether the order specified in the Sort
By field is ascending or descending. This field is
only applicable if File Name or Date Modified is
selected in the Sort By field.
File Poller 67
|
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
action
string
The event that occurred to trigger the File
Poller activity. The possible values are:
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.
fileInfo
complex
Element containing the fileName,
location, type, readProtected,
writeProtected, and size data.
fullName
string
The name of the file, including the path
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
68
| Chapter 3
File Palette
Output Item
Datatype
Description
fileName
string
The name of the file without the path
information.
location
string
The path to the file.
configuredFileName
string
The name of the file or directory this
activity is configured to operate on.
type
string
The file type.
readProtected
boolean
Whether the file is read-protected.
writeProtected
boolean
Whether the file is write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified.
fileContent
complex
Element containing the textContent and
binaryContent data.
textContent
string
Contents of the file (text files), if the
Exclude File Contents field is not checked
on the Configuration tab.
binaryContent
binary
Contents of the file (binary files), if the
Exclude File Contents field is not checked
on the Configuration tab.
encoding
string
The character encoding for the file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
List Files 69
|
List Files
Activity
The List Files activity returns information about files or directories, or a
listing of all the files in the specified directory.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Mode
No
The type of listing you would like to retrieve. The
following are the choices for this field:
Description
•
directories-only
•
files-only
•
files-and-directories
Input
The input for the activity is the following.
Input Item
Datatype
Description
fileName
string
The path and name of the directory with files or
subdirectories to list.
If you supply a file or directory name, information
about that file or directory is returned.
You can use wildcards to list files or directories
that match the given specification. For example,
C:\files\*.log lists any file in the files
directory that have a .log extension.
C:\files\mylogs\*.* lists all files in the
directory mylogs.
TIBCO ActiveMatrix BusinessWorks Palette Reference
70
| Chapter 3
File Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
fileInfo
complex
Element containing the fileName, location,
type, readProtected, writeProtected, and
size data.
This is a repeating element. Each item in
the element is a file or directory contained
in the specified directory that matches the
given criteria.
fullName
string
The name of the file, including the path
information.
fileName
string
The name of the file without the path
information.
configuredFileName
string
The name of the file or directory this
activity is configured to operate on.
location
string
The path to the file.
type
string
The file type.
readProtected
boolean
Whether the file is read-protected.
writeProtected
boolean
Whether the file is write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified. You can compare values in
this element using the
compare-dateTime() XPath function. For
example,
compare-dateTime($List-Files/
ListFilesActivityOutput/files/
fileInfo[fileName="myFile.txt"]/
lastModified,
current-dateTime())
TIBCO ActiveMatrix BusinessWorks Palette Reference
List Files 71
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The specified path is not found.
TIBCO ActiveMatrix BusinessWorks Palette Reference
72
| Chapter 3
File Palette
Read File
Activity
The Read File activity is used to read a file and place its contents into
the activity’s output.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Exclude File
Content
No
Specifies not to load the data from the file into this
activity’s output. If this field is checked, the
contents of the file are not available to subsequent
activities in the process definition.
Read as
Yes
The type of content in the file. Can be either text
or binary.
Description
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
fileName
string
The path and name of the file to read.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Read File 73
|
Input Item
Datatype
Description
encoding
string
The character encoding for text files. This
element is only available when the Read as field
on the Configuration tab is set to text. Encoding
names supported by Java can be specified in this
element. If this element is not specified, the
default encoding of the Java Virtual Machine
used by the process engine is used.
Output
The output for the activity is the following.
Output Item
Datatype
Description
fileInfo
complex
Element 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.
configuredFileName
string
This element is optional and it is not
populated by this activity.
type
string
The file type.
readProtected
boolean
Whether the file is read-protected.
writeProtected
boolean
Whether the file is write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified.
fileContent
complex
Element containing the textContent and
binaryContent data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
74
| Chapter 3
File Palette
Output Item
Datatype
Description
textContent
string
Contents of the file (text files), if the
Exclude File Content field is not checked
on the Configuration tab.
binaryContent
binary
Contents of the file (binary files), if the
Exclude File Content field is not checked
on the Configuration tab.
encoding
string
The character encoding for the file.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The file does not exist.
UnsupportedEncodingException
The text file’s encoding is not valid and
the content of the file is read into process
data.
FileIOException
An I/O exception occurred when trying
to read the file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Remove File 75
|
Remove File
Activity
The Remove File activity removes the specified file. This activity can
also remove empty directories. If a directory that is not empty is
specified, an exception is thrown.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Description
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
fileName
string
The path and name of the file or
empty directory to remove.
Output
The output for the activity is the following.
Output Item
Datatype
Description
fileInfo
complex
Element containing the fileName, location,
type, readProtected, writeProtected, and
size data.
fullName
string
The name of the file (or empty directory),
including the path information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
76
| Chapter 3
File Palette
Output Item
Datatype
Description
fileName
string
The name of the file or empty directory
without the path information.
location
string
The path to the file or empty directory.
configuredFileName
string
This element is not populated by this
activity.
type
string
The file type.
readProtected
boolean
Whether the file (or empty directory) is
read-protected.
writeProtected
boolean
Whether the file (or empty directory) is
write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The file does not exist.
FileIOException
An I/O exception occurred when trying
to remove the file or empty directory.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rename File 77
|
Rename File
Activity
The Rename File activity is used to rename or move files. This activity
can also rename directories, but you cannot use this activity to move a
directory to a new location.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Overwrite
Yes
Overwrite existing file with the same name, if
one exists when renaming or moving.
Description
The activity raises an exception if the specified
file or directory exists and this field is
unchecked.
Create
Destination
Directory
Yes
Creates all directories in the specified
destination path where the file is moved to, if the
directories do not already exist.
If this field is unchecked and one or more
directories in the specified path do not exist, an
exception is raised.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
78
| Chapter 3
File Palette
The input for the activity is the following.
Input Item
Datatype
Description
fromFileName
string
The path and name of the file to
rename or move, or the path and
name of the directory to rename.
The value in this element must be
an absolute path.
toFileName
string
The new name and location of the
file or directory. Files can be moved
to a new location, but directories
must remain in the same location.
The value in this element must be
an absolute path.
Output
The output for the activity is the following.
Output Item
Datatype
Description
fileInfo
complex
Element containing the fileName, location,
type, readProtected, writeProtected, and
size data.
fullName
string
The name of the file (or directory),
including the path information.
fileName
string
The name of the file or directory without
the path information.
location
string
The path to the file or directory.
configuredFileName
string
This element is not populated by this
activity.
type
string
The file type.
readProtected
boolean
Whether the file (or directory) is
read-protected.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rename File 79
|
Output Item
Datatype
Description
writeProtected
boolean
Whether the file (or directory) is
write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The file does not exist.
IllegalRenameException
The destination file exists and its type is
different than the type of the source file.
FileAlreadyExistsException
The file already exists.
FileIOException
An I/O exception occurred when trying
to rename the file or directory.
This exception is also thrown if an
attempt is made to move a directory.
TIBCO ActiveMatrix BusinessWorks Palette Reference
80
| Chapter 3
File Palette
Wait for File Change
Activity
The Wait for File Change activity waits for a file creation, modification,
or deletion event to occur during process execution. When this activity
is executed, the process instance suspends and waits for the specified
change to occur before resuming.
See Scalability With Incoming Events on page 226 in TIBCO
ActiveMatrix BusinessWorks Process Design Guide for information on running the
"Wait for..." activities in a multi-engine mode.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
File Name
Yes
The path and name of the file to poll for. You can
use the Browse button to locate an existing file.
Description
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 with an extension of .log.
Polling Interval
(sec)
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
Polling interval (in seconds) to check for
changes in the specified file.
Wait for File Change 81
|
Field
Global
Var?
Description
Include Existing
Files
Yes
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.
Exclude File
Content
Yes
Specifies not to load the data from the file into
this activity’s output. If this field is checked, the
contents of the file are not available to
subsequent activities in the process definition.
Content as
Yes
The type of content in the file. Can be either text
or binary.
Encoding
Yes
The character encoding for the file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
82
| Chapter 3
File Palette
Event
The Event tab has the following fields.
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.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide
for more information about XPath expressions.
Event Timeout
(msec)
A file change may occur before this activity is executed.
This field specifies the amount of time (in milliseconds) to
wait if the file change occurs before this activity is executed
in the process instance. If the event timeout expires, an error
is logged and the event is discarded.
If no value is specified in this field, the message waits
indefinitely. If zero is specified, the event is discarded
immediately, unless this activity has already been executed.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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 File Change activity proceeds.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for File Change 83
|
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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 82 for an example of using the
Candidate Event Key field with the key
input item.
processTimeout
integer
The time (in milliseconds) to wait for the
incoming file change event. An error is
returned if the event is not received in this
time limit.
Output
The output for the activity is the following.
Output Item
Datatype
Description
action
string
The change in the file that occurred. The
action is either the create, remove, or
modify.
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.
fileInfo
complex
Element containing the fileName,
location, type, readProtected,
writeProtected, and size data.
fullName
string
The name of the file, including the path
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
84
| Chapter 3
File Palette
Output Item
Datatype
Description
fileName
string
The name of the file without the path
information.
location
string
The path to the file.
configuredFileName
string
This element is not populated by this
activity.
type
string
The file type.
readProtected
boolean
Whether the file is read-protected.
writeProtected
boolean
Whether the file is write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified.
fileContent
complex
Element 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Write File 85
|
Write File
Activity
The Write File activity writes content to the specified file.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Append
Yes
Appends contents to an existing file. If
unchecked, the file is overwritten.
Write as
Yes
Specifies the type of file content to write: text or
binary.
Create
Non-Existing
Directories
Yes
When checked, the activity creates all directories
in the specified path, if they do not already exist.
Compress
No
Description
If this field is unchecked and there are one or
more directories in the specified path that do not
exist, an exception is raised.
Specifies whether to compress the output file
using GZip format. Specify None for no
compression or GZip for a compressed output
file.
When you specify GZip for this field, you must
rename the file to use the .gz suffix and use
gunzip to uncompress the file.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
86
| Chapter 3
File Palette
The input for the activity is the following.
Input Item
Datatype
Description
fileName
string
The path and name of the file.
Wildcards are not permitted in this
field.
textContent
string
Contents of the file (text files).
binaryContent
binary
Contents of the file (binary files).
addLineSeparator
boolean
Specifies whether to add a carriage
return after each input line.
encoding
string
The character encoding for text
files. This element is only available
when the Write as field on the
Configuration tab is set to text.
Encoding names supported by Java
can be specified in this element. If
this element is not specified, the
default encoding of the Java Virtual
Machine used by the process
engine is used.
Output
The output for the activity is the following.
Output Item
Datatype
Description
fileInfo
complex
Element 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Write File 87
|
Output Item
Datatype
Description
configuredFileName
string
This element is not populated by this
activity.
type
string
The file type.
readProtected
boolean
Whether the file is read-protected.
writeProtected
boolean
Whether the file is write-protected.
size
integer
Size of the file in bytes.
lastModified
string
Time stamp indicating when the file was
last modified.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The file does not exist.
UnsupportedEncodingException
The encoding is not valid.
FileIOException
An I/O exception occurred when trying
to write to the file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
88
| Chapter 3
File Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 89
Chapter 4
FTP Palette
The FTP palette is used to issue FTP commands.
Topics
•
FTP Connection, page 93
•
FTP Delete File, page 98
•
FTP DIR, page 101
•
FTP Get, page 104
•
FTP Get Default Directory, page 110
•
FTP Make Remote Directory, page 113
•
FTP Put, page 116
•
FTP Quote, page 121
•
FTP Remove Remote Directory, page 124
•
FTP Rename File, page 127
•
FTP Sys Type, page 130
TIBCO ActiveMatrix BusinessWorks Palette Reference
90
| Chapter 4
FTP Palette
FTP Change Default Directory
Activity
The FTP Change Default Directory activity changes the current
default directory on the remote machine to the specified directory
path.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Change Default Directory 91
|
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This overrides
the value specified in the FTP Connection
resource.
Port
integer
Port number for incoming FTP requests on
the FTP server. This overrides the value
specified in the FTP Connection resource.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP
Connection resource.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP
Connection resource.
NewDefaultDir
string
Path to the new default directory on the FTP
server.
Timeout
integer
The amount of time to wait for the FTP server
to respond. This timeout is used when the
FTP server places the FTP connection used by
this activity into a waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection on
page 93 for more information.
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
92
| Chapter 4
FTP Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Connection 93
|
FTP Connection
Shared Configuration
The FTP Connection shared configuration resource describes a
connection to an FTP server. FTP connections are used when
configuring activities in the FTP palette.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the shared resource.
SSL
Specifies to use the HTTPS (secure socket layer or
SSL) protocol for the FTP connection. This protocol
authenticates the FTP client to the server.
Enabling this field allows you to specify SSL
parameters with the Configure SSL button (described
in Configure SSL Button on page 95).
Host
Host name or IP address of the FTP server.
Port
Port number of the FTP server. For connections inside
of a firewall, 21 is the default when no value is
specified in this field.
User Name
User name to use when logging into the FTP server.
Password
Password to use when logging into the FTP server.
Mode
Specifies whether to use Active or Passive mode to
connect to the FTP server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
94
| Chapter 4
FTP Palette
Field
Description
Connection Timeout
(msec)
The timeout specified in this field (in milliseconds)
applies to the following situations:
•
Making the control socket connection to the FTP
Server
•
Making the data socket connection to the FTP
server (passive mode)
•
Waiting for the data socket connection from the
FTP server (active mode)
•
Reading a reply from control socket after sending
a FTP control command.
•
Reading data from data socket.
If the specified time is reached when attempting any
of these operations, the activity using this FTP
connection terminates without error and takes any
matching success transitions to the next activity in the
process definition.
Remote Filename
Encoding
A drop down list of values for specifying the
character encoding of file names supplied to FTP
commands using this connection.
The encoding specified in this field is used when
sending path and file names supplied to FTP
commands that use this FTP Connection resource. Set
this field when the FTP server has a different system
encoding than the machine where the process engine
is running.
Firewall
Specifies whether the FTP host resides outside of a
firewall. If this field is checked, you must supply the
Proxy Host and Proxy Port fields with the name and
the port of the proxy server used to access sites
outside of a firewall. You can optionally specify the
User Name and Password for the proxy server, if
necessary.
Proxy Host
Used when the remote FTP server is outside of a
firewall. Specifies the host name or IP address of the
firewall server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Connection 95
|
Field
Description
Proxy Port
Used when the remote FTP server is outside of a
firewall. Specifies the port number of the firewall
server.
Proxy User Name
Used when the remote FTP server is outside of a
firewall. Specifies the user name to use to connect to
the proxy server, if necessary.
Proxy Password
Used when the remote FTP server is outside of a
firewall. Specifies the password to use for the
specified user name when connecting to the proxy
server, if necessary.
Configure SSL Button
The Configure SSL button allows you to specify the SSL parameters for the HTTP
connection. The following are the fields in the SSL Configuration for HTTPS
Connections dialog:
Field
Description
Trusted Certificates
Folder
Specifies a folder in the project containing one or more
certificates from trusted certificate authorities. This
folder is checked when a client connects to ensure that
the server’s certificate is from a trusted certificate
authority. This prevents connections from rogue
servers.
Identity
An Identity resource that contains the HTTP server’s
digital certificate and private key.
See TIBCO Designer Palette Reference for more
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
96
| Chapter 4
FTP Palette
Field
Description
Verify Host Name
Specifies to check that the host name of the FTP server
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 Host 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 Host field, but the name
is not an exact match of the hostname in the host’s
digital certificate, the connection is refused.
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified with
the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
Test Connection Button
When the Test Connection button is clicked, BusinessWorks attempts to connect
to the specified remote FTP server on the specified port using the specified
username and password. You can use this button to determine if the specified
connection configuration is correct.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Connection 97
|
Available Commands Button
The Available Commands button displays a dialog with details about which FTP
commands are available on the specified remote server. FTP servers on different
operating systems and from different vendors support slightly different
commands. You can use this button to determine which commands are available
on the remote FTP server before attempting to execute them with the FTP Quote
activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
98
| Chapter 4
FTP Palette
FTP Delete File
Activity
The FTP Delete File activity issues an FTP delete or mdelete
command to remove one or more files from the remote server.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the
activity in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as
host name, user name, and password. See
FTP Connection on page 93 for more
information.
Quit (post-command)
No
When checked, this field specifies that the
FTP connection should be closed after
completing this command.
Description
If this field is not checked, the FTP
connection remains open so that all FTP
activities that specify the same FTP session
(that is, the same host, port, username, and
password) share the FTP session until the
connection is closed.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Delete File 99
|
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This overrides
the value specified in the FTP Connection
resource.
Port
integer
Port number for incoming FTP requests on
the FTP server. This overrides the value
specified in the FTP Connection resource.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP
Connection resource.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP
Connection resource.
RemoteDirectory
string
Path to the directory containing the file(s) to
be deleted. This element is concatenated
with the RemoteFilename element to
provide the complete path to the file(s) to be
deleted.
This element is optional.
RemoteFilename
string
The path and name of the file to delete on
the remote server. Wildcards (? for any one
character, * for one or more characters) are
permitted in this field.
You can specify an absolute or relative path
for the remote file name. Relative paths are
relative to the path specified in the
RemoteDirectory element or the user’s
home directory, if RemoteDirectory is null.
TIBCO ActiveMatrix BusinessWorks Palette Reference
100
| Chapter 4
FTP Palette
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP
server to respond. This timeout is used
when the FTP server places the FTP
connection used by this activity into a
waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection
on page 93 for more information.
Output
This activity produces no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP DIR 101
|
FTP DIR
Activity
The FTP DIR activity provides a listing of files in the specified directory of
the FTP server.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
NLST
Yes
Specifies to use the NLST command instead of
the DIR command.
The DIR command produces verbose output
including file size, modification time, and
permissions. NLST produces only a list of
filenames.
TIBCO ActiveMatrix BusinessWorks Palette Reference
102
| Chapter 4
FTP Palette
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This overrides the
value specified in the FTP Connection
resource.
Port
integer
Port number for incoming FTP requests on the
FTP server. This overrides the value specified
in the FTP Connection resource.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP
Connection resource.
Password
string
Password for logging into the FTP server. This
overrides the value specified in the FTP
Connection resource.
DirParameters
string
Command parameters to pass to the DIR or
NLST command.
Directory
string
Path to the directory for which you wish to list
the files.
This parameter is optional, and if null, the
current remote directory is listed.
Timeout
integer
The amount of time to wait for the FTP server
to respond. This timeout is used when the FTP
server places the FTP connection used by this
activity into a waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection on
page 93 for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP DIR 103
|
Output
The output for the activity is the following.
Output Item
Datatype
Description
ItemCount
integer
The number of entries returned
from the remote directory listing.
DirectoryItems
string
A repeating element containing the
list of items returned.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
104
| Chapter 4
FTP Palette
FTP Get
Activity
The FTP Get activity issues an FTP get or mget command to the
specified server. Tthe content of the remote files can be placed in the
activity’s output or written directly to local storage. If you choose to
place the contents of a remote file into the activity’s output, you can only
retrieve one remote file (FTP get command) and the file’s content will be stored in
memory as part of the activity’s output. If you choose to write the contents of the
retrieved files to local storage, you can retrieve one or more files (FTP get or mget
commands).
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Get 105
|
Field
Global
Var?
Description
Use Process Data
Yes
Specifies to write contents of the file retrieved
from the FTP server to the process data. The
activity’s output includes an element that
contains the remote file’s contents, and the data
can be used by subsequent activities in the
process definition.
Warning: Do not use this option if you are
retrieving multiple files. You can only write the
contents of one file to this activity’s output. An
error is returned if you specify wildcards in the
RemoteFilename input element when this field
is checked.
Binary
Yes
Specifies whether to retrieve the file content in
binary or ASCII mode (checked signifies
binary).
When ASCII mode is used, differences in line
endings between the FTP server and the
machine executing the FTP command are
automatically handled. Also, ASCII mode
implies text data, and that data can be encoded
in a character encoding other than ASCII (such
as UTF-8 or Latin-1).
Overwrite
Existing File
Yes
When this field is checked, and the Use Process
Data field is unchecked, any existing local files
are overwritten if the FTP command returns
files with the same names.
If this field is unchecked, any attempt to write a
file to disk with the same name as an existing
file results in an exception.
Maintain 2.0
Compatibility
No
This field is present only for activities migrated
from TIBCO BusinessWorks 2.0. If checked, this
field ensures the output schema retains the
elements available in TIBCO BusinessWorks 2.0.
TIBCO ActiveMatrix BusinessWorks Palette Reference
106
| Chapter 4
FTP Palette
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
RemoteFilename
string
The path and name of the file to retrieve from
the remote server. Wildcards (? for any one
character, * for one or more characters) are
permitted in this field.
You can specify an absolute or relative path
for the remote file name. Relative paths are
relative to the path specified in the
RemoteDirectory element or the current
directory, if RemoteDirectory is null.
Note: Do not specify wildcards for this
element if the Use Process Data Configuration
field is checked.
LocalFileName
string
This input item is available only if the Use
Process Data field on the Configuration tab is
unchecked and only one remote file is
retrieved.
This input item specifies the name and path of
the local file where the contents of the
retrieved file should be written.
If more than one remote file is retrieved, the
local files are named to match the remote file
names.
Host
string
The name of the FTP server. This overrides the
value specified in the FTP Connection
resource.
Port
integer
Port number for incoming FTP requests on the
FTP server. This overrides the value specified
in the FTP Connection resource.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP
Connection resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Get 107
|
Input Item
Datatype
Description
Password
string
Password for logging into the FTP server. This
overrides the value specified in the FTP
Connection resource.
Encoding
string
When the retrieved file is not binary and the
Use Process Data field on the Configuration
tab is checked, this specifies the character
encoding of the retrieved file.
If this is not specified, it is assumed that the
encoding of the file is the same encoding of
the machine where the FTP command is
executed. If the encoding of the local machine
and the FTP server are different, specify the
encoding used by the FTP server in this
element and the activity converts the retrieved
file into the local machine’s encoding.
Timeout
integer
The amount of time to wait for the FTP server
to respond. This timeout is used when the FTP
server places the FTP connection used by this
activity into a waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection on
page 93 for more information.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Data
string
When Use Process Data is checked and only
one file is retrieved, this element contains the
data retrieved from the remote file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
108
| Chapter 4
FTP Palette
Output Item
Datatype
Description
FilesTransferred
complex
When one or more remote files are retrieved
and written to local storage, this element
contains a list of the remote filenames that
were retrieved. This element contains two
elements, Name and NumOfBytes.
If an error occurred while retrieving files, the
activity output is not available, but the Error
Output tab lists the successfully transferred
files and the files that failed to be transferred.
Name
integer
The name of the remote file retrieved.
NumOfBytes
integer
The number of bytes contained in the
associated file name.
Success
boolean
Only available when Maintain 2.0
compatibility is checked on the Configuration
tab.
True or false depending upon whether the
FTP get command was successfully executed
by the FTP server.
Errormsg
string
Only available when Maintain 2.0
compatibility is checked on the Configuration
tab.
Any error messages returned from the FTP
server.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
GetFilesException
An error occurred during the FTP get
operation.
ConnectionErrorException
An error occurred when connecting to the
FTP server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Get 109
|
Exception
Thrown When...
CommandExecutionException
An error occurred when executing the
FTP command.
ConnectionTimeoutException
The connection to the FTP server has
timed out before the command has
completed its execution.
TIBCO ActiveMatrix BusinessWorks Palette Reference
110
| Chapter 4
FTP Palette
FTP Get Default Directory
Activity
The FTP Get Default Directory activity retrieves the name of the
current remote directory. The default remote directory is operating
system-dependent and determined by the remote FTP server. On
UNIX systems, the default remote directory is usually the home
directory of the user account that is used to establish an FTP
connection.
The current remote directory may be different from the default directory, because
you can use the FTP Change Default Directory or FTP Quote activities to issue an
FTP command to change to a different directory. This activity returns the
currently set remote directory.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing this
command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Get Default Directory 111
|
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This overrides the
value specified in the FTP Connection resource.
Port
integer
Port number for incoming FTP requests on the FTP
server. This overrides the value specified in the
FTP Connection resource.
UserName
string
Username for logging into the FTP server. This
overrides the value specified in the FTP
Connection resource.
Password
string
Password for logging into the FTP server. This
overrides the value specified in the FTP
Connection resource.
Timeout
integer
The amount of time to wait for the FTP server to
respond. This timeout is used when the FTP server
places the FTP connection used by this activity into
a waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection on
page 93 for more information.
Output
The output for the activity is the following.
Output Item
Datatype
Description
CurrentDirectory
string
The currently set directory on the
remote FTP server. By default, this
directory is set by the FTP server,
but you can use the FTP Quote
activity to issue an FTP command
to change to another directory.
TIBCO ActiveMatrix BusinessWorks Palette Reference
112
| Chapter 4
FTP Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Make Remote Directory 113
|
FTP Make Remote Directory
Activity
The FTP Make Remote Directory activity creates the specified
directory on the remote FTP server.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing this
command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
114
| Chapter 4
FTP Palette
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This
overrides the value specified in the FTP
Connection resource.
Port
integer
Port number for incoming FTP requests
on the FTP server. This overrides the
value specified in the FTP Connection
resource.
UserName
string
Username for logging into the FTP
server. This overrides the value
specified in the FTP Connection
resource.
Password
string
Password for logging into the FTP
server. This overrides the value
specified in the FTP Connection
resource.
RemoteSITECommand
string
Optional, system-specific command to
execute before the directory is created.
ParentRemoteDirectory
string
Path to the remote directory to create.
This element is concatenated with the
RemoteDirName element to provide
the complete path to the directory to
create.
This element is optional.
RemoteDirName
TIBCO ActiveMatrix BusinessWorks Palette Reference
string
Name of the remote directory to create.
You can optionally include the
complete path of the directory to
create.
FTP Make Remote Directory 115
|
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP
server to respond. This timeout is used
when the FTP server places the FTP
connection used by this activity into a
waiting state.
This overrides the value specified in
the FTP Connection resource. See FTP
Connection on page 93 for more
information.
Output
This activity produces no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
116
| Chapter 4
FTP Palette
FTP Put
Activity
The FTP Put activity issues an FTP put or mput command to the
specified server. You can use process data as the content of the file to
send to the remote server or you can send files in local disk storage. If
you choose to use process data, you can place only one file on the
remote server (FTP put command). If you use locally stored files, you can place
one or more files on the remote server (FTP mput command).
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Put 117
|
Field
Global
Var?
Description
Binary
Yes
Specifies whether to send the file content in
binary or ASCII mode (checked signifies
binary).
When ASCII mode is used, differences in line
endings between the FTP server and the
machine executing the FTP command are
automatically handled. Also, ASCII mode
implies text data, and that data can be encoded
in a character encoding other than ASCII (such
as UTF-8 or Latin-1).
Timeout (msec)
Yes
The amount of time to wait (in milliseconds) for
the FTP server to respond. This timeout is used
when the FTP server places the FTP connection
used by this activity into a waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection on
page 93 for more information.
Overwrite
Existing File
Yes
When this field is checked, any existing files on
the FTP server are overwritten if the FTP
command sends files with the same names.
If this field is unchecked, any attempt to send a
file to the remote server with the same name as
an existing file results in an exception.
Append
Yes
This field is only available when the Overwrite
Existing File field is unchecked.
This field 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 field is not checked, the
file is overwritten if it exists on the FTP server.
Use Process Data
Yes
Specifies to use process data as the content of the
file to place on the remote server. If this field is
checked, you can only place one file on the
remote server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
118
| Chapter 4
FTP Palette
Field
Global
Var?
Description
Maintain 2.0
Compatibility
No
This field is present only for activities migrated
from TIBCO BusinessWorks 2.0. If checked, this
field ensures the output schema retains the
elements available in TIBCO BusinessWorks 2.0.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
RemoteFilename
string
The path and name of the file to place
onto the remote server. Wildcards are not
permitted in 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 Use Process Data
field is unchecked.
Data
binary or
string
(depends
upon if the
Binary
Configuration
field is
checked)
The contents of the file to be transferred
to the FTP server, if the Use Process Data
field is checked on the Configuration tab.
Host
string
The name of the FTP server. This
overrides the value specified in the FTP
Connection resource.
Port
integer
Port number for incoming FTP requests
on the FTP server. This overrides the
value specified in the FTP Connection
resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
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.
FTP Put 119
|
Input Item
Datatype
Description
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the
FTP Connection resource.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the
FTP Connection resource.
Encoding
string
When the file to send is not binary and
the Use Process Data field on the
Configuration tab is checked, this
specifies the character encoding of the file
to send to the FTP server.
If this is not specified, it is assumed that
the encoding of the file is the same
encoding of the machine where the FTP
command is executed. If the encoding of
the local machine and the FTP server are
different, specify the encoding used by
the FTP server in this element and the
activity converts the file into the specified
encoding.
Output
The output for the activity is the following.
Output Item
Datatype
Description
FilesTransferred
string
A repeating string element containing a list of
names of files that were transferred.
If an error occurred while transferring files, the
activity output is not available. However, the
Error Output tab lists the successfully
transferred files and the files that failed to be
transferred.
TIBCO ActiveMatrix BusinessWorks Palette Reference
120
| Chapter 4
FTP Palette
Output Item
Datatype
Description
Success
boolean
Only available when Maintain 2.0
compatibility is checked on the Configuration
tab.
True or false depending upon whether the FTP
put command was successfully executed by
the FTP server.
Errormsg
string
Only available when Maintain 2.0
compatibility is checked on the Configuration
tab.
Any error messages returned from the FTP
server.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
PutFilesException
An error occurred during the FTP put
operation.
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
ConnectionTimeoutException
The connection to the FTP server has
timed out before the command has
completed it execution.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Quote 121
|
FTP Quote
Activity
The FTP Quote activity sends an arbitrary FTP command to the FTP
server. You can determine which FTP commands are supported by
using the Available Commands button on the FTP Connection shared
configuration resource. FTP commands vary by operating system and
by FTP version and configuration, so you should determine which commands are
available on the remote server before using this activity.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
Has Socket Data
No
If checked, indicates that data will be sent back
by the FTP server as a result of executing the
command.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
122
| Chapter 4
FTP Palette
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This
overrides the value specified in the FTP
Connection resource.
Port
integer
Port number for incoming FTP requests
on the FTP server. This overrides the
value specified in the FTP Connection
resource.
UserName
string
Username for logging into the FTP
server. This overrides the value
specified in the FTP Connection
resource.
Password
string
Password for logging into the FTP
server. This overrides the value
specified in the FTP Connection
resource.
RemoteSiteCommand
string
Optional, system-specific command to
be executed before the specified
command is executed.
ValidReturnCode
string
Optional list of valid return codes for
validating the reply. Codes are
three-digit numbers. To specify multiple
codes, separate each code with a comma
or a space.
If the remote server returns a code not
specified in this list, this activity raises
an exception.
RemoteCommand
TIBCO ActiveMatrix BusinessWorks Palette Reference
string
Command to be executed on the remote
FTP server.
FTP Quote 123
|
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP
server to respond. This timeout is used
when the FTP server places the FTP
connection used by this activity into a
waiting state.
This overrides the value specified in the
FTP Connection resource. See FTP
Connection on page 93 for more
information.
Output
The output for the activity is the following.
Output Item
Datatype
Description
CommandItems
string
Each element in this repeating
element is a returned value from
the command executed on the
remote server.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
124
| Chapter 4
FTP Palette
FTP Remove Remote Directory
Activity
The FTP Remove Remote Directory activity deletes the specified
directory from the remote FTP server.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Remove Remote Directory 125
|
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This
overrides the value specified in the FTP
Connection resource.
Port
integer
Port number for incoming FTP requests
on the FTP server. This overrides the
value specified in the FTP Connection
resource.
UserName
string
Username for logging into the FTP
server. This overrides the value
specified in the FTP Connection
resource.
Password
string
Password for logging into the FTP
server. This overrides the value
specified in the FTP Connection
resource.
ParentRemoteDirectory
string
Path to the remote directory you wish
to remove. This element is
concatenated with the RemoteDirName
element to provide the complete path
to the directory to remove.
This element is optional.
RemoteDirName
string
Name of the remote directory to
remove. You can optionally include the
complete path of the directory to
remove.
Timeout
integer
The amount of time to wait for the FTP
server to respond. This timeout is used
when the FTP server places the FTP
connection used by this activity into a
waiting state.
This overrides the value specified in the
FTP Connection resource. See FTP
Connection on page 93 for more
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
126
| Chapter 4
FTP Palette
Output
This activity produces no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Rename File 127
|
FTP Rename File
Activity
The FTP Rename File activity renames the specified file on the
remote FTP server.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
128
| Chapter 4
FTP Palette
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This
overrides the value specified in the FTP
Connection resource.
Port
integer
Port number for incoming FTP requests
on the FTP server. This overrides the
value specified in the FTP Connection
resource.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the
FTP Connection resource.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the
FTP Connection resource.
OldRemoteDirectory
string
Path to the remote file you wish to
rename. This element is concatenated
with the OldRemoteFileName element to
provide the complete path to the file to
rename.
This element is optional.
OldRemoteFilename
string
Name of the remote file you wish to
rename. You can optionally include the
complete path of the file to rename.
NewRemoteDirectory
string
New path for the file to rename. This
element is concatenated with the
NewRemoteFileName element to provide
the complete path to the file to rename.
This element is optional.
NewRemoteFilename
TIBCO ActiveMatrix BusinessWorks Palette Reference
string
New name for the remote file. You can
optionally include the complete path of
the file.
FTP Rename File 129
|
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP
server to respond. This timeout is used
when the FTP server places the FTP
connection used by this activity into a
waiting state.
This overrides the value specified in the
FTP Connection resource. See FTP
Connection on page 93 for more
information.
Output
This activity produces no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
130
| Chapter 4
FTP Palette
FTP Sys Type
Activity
The FTP Sys Type activity retrieves the FTP server’s operating system
type.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
FTP Connection
No
Path to the shared configuration resource
containing the user information such as host
name, user name, and password. See FTP
Connection on page 93 for more information.
Quit
(post-command)
No
When checked, this field specifies that the FTP
connection should be closed after completing
this command.
Description
If this field is not checked, the FTP connection
remains open so that all FTP activities that
specify the same FTP session (that is, the same
host, port, username, and password) share the
FTP session until the connection is closed.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
FTP Sys Type 131
|
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The name of the FTP server. This overrides the
value specified in the FTP Connection resource.
Port
integer
Port number for incoming FTP requests on the FTP
server. This overrides the value specified in the FTP
Connection resource.
UserName
string
Username for logging into the FTP server. This
overrides the value specified in the FTP Connection
resource.
Password
string
Password for logging into the FTP server. This
overrides the value specified in the FTP Connection
resource.
Timeout
integer
The amount of time to wait for the FTP server to
respond. This timeout is used when the FTP server
places the FTP connection used by this activity into
a waiting state.
This overrides the value specified in the FTP
Connection resource. See FTP Connection on
page 93 for more information.
Output
The output for the activity is the following.
Output Item
Datatype
Description
SystemType
string
The FTP server type. This element can be one
of the following:
•
UNIX
•
UUNIX
•
Windows_NT
•
MVS_OS390
•
UNKNOWN
TIBCO ActiveMatrix BusinessWorks Palette Reference
132
| Chapter 4
FTP Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ConnectionErrorException
An error occurred when connecting to the
FTP server.
CommandExecutionException
An error occurred when executing the
FTP command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 133
Chapter 5
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. This chapter describes the activities contained in the General
Activities palette.
Topics
•
Assign, page 135
•
Call Process, page 136
•
Catch, page 140
•
Checkpoint, page 142
•
Confirm, page 145
•
Engine Command, page 148
•
External Command, page 163
•
Generate Error, page 169
•
Get Shared Variable, page 172
•
Inspector, page 173
•
Job Shared Variable, page 178
•
Label, page 180
•
Lock Object, page 182
•
Mapper, page 183
•
Notify, page 184
•
Notify Configuration, page 186
•
Null, page 187
•
On Event Timeout, page 188
•
On Notification Timeout, page 190
TIBCO ActiveMatrix BusinessWorks Palette Reference
134
| Chapter 5
General Activities Palette
•
On Shutdown, page 192
•
On Startup, page 193
•
Receive Notification, page 194
•
Rethrow, page 197
•
Set Shared Variable, page 198
•
Shared Variable, page 200
•
Sleep, page 203
•
Timer, page 204
•
Wait, page 207
•
Write To Log, page 209
TIBCO ActiveMatrix BusinessWorks Palette Reference
Assign 135
|
Assign
Activity
The Assign activity allows you to assign a value to a user-defined
process variable. See Process Definition on page 2 for more information
about creating user-defined process variables.
When the Assign activity is executed, the entire schema for the selected
process variable is replaced with the specified values. Elements that do not have a
value specified in the Input tab are set to null. Therefore, be certain to set all
necessary values when using the Assign activity to set a process variable.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Process Variable to Set
A drop down list of the available user-defined process
variables for the process definition. You can select any
user-defined process variable to modify.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
<schema>
Description
The specified data schema for the
user-defined process variable
selected on the Configuration tab.
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
136
| Chapter 5
General Activities Palette
Call Process
Activity
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 ActiveMatrix 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. Do not call processes that
begin with a process starter such as HTTP Receiver or Receive Mail. Providing the
name of a process with a process starter results in an exception at run time.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Process Name
The process definition you would like to call. You can
browse the available process definitions.
Process Name
Dynamic Override
An XPath formula specifying the name of the process
to call. Use this field to dynamically determine which
process to call when the process instance is running.
See Dynamically Determining the Process to Call on
page 137 for more information about this field.
Spawn
TIBCO ActiveMatrix BusinessWorks Palette Reference
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.
Call Process 137
|
Field
Description
Custom Id
This field is only available when the Spawn field is
checked.
This field can contain an XPath expression that
specifies a custom ID for the spawned process
instance. This ID is displayed in the View Service
dialog of TIBCO Administrator, and it is also
available in the $_processContext process variable
in the spawned process instance.
Custom Icon File
File to use for the Call Process activity in the process
definition. This allows you to customize the look of
your process definition with your own images.
Dynamically Determining the Process to Call
You can use the Process Name Dynamic Override field on the Configuration tab
to specify an XPath expression that determines which process to call. This is
useful for calling a different process depending upon the value of the XPath
expression. For example, you have an incoming HTTP request that contains an
attribute named orderAmount. For all incoming orders over $10,000, you wish to
call a process that includes activities in the Manual Work palette to obtain the
proper approvals. For orders under $10,000, you wish to call a process that
handles the order automatically. You can create the following expression that
resolves to the proper process name for each type of order:
if($IncomingOrder/orderAmount > 10000) then
’/MyProject/manualApproval.process’
else ’/MyProject/processOrder.process’
Use the full path and name of the process file as stored in the project directory.
TIBCO ActiveMatrix BusinessWorks Palette Reference
138
| Chapter 5
General Activities Palette
When you use the Process Name Dynamic Override field, you must also specify a
process to call in the Process field. The input, output, and error definitions of the
specified process must be the same as any process that the expression in the
Process Name Dynamic Override field can evaluate to.
It may be helpful to create process definitions that act as programmatic interfaces
when using the Process Name Dynamic Override field.
In the example above, you may create a process named orderProcessOrApprove.
The only purpose of this process is for specifying the input, output, and error
schemas. Place this process in the Process field of the Call Process tab. Then,
create the manualApproval and processOrder process definitions as copies of the
orderProcessOrApprove process. The Call Process activity then has the correct
input, output, and error schemas for all processes that can be called.
If you use the Process Name Dynamic Override field, make sure you include all
potentially callable subprocesses when you create your Process Archive for
deployment. TIBCO Designer cannot determine which subprocesses are
potentially callable at design time, and therefore they cannot be automatically
included in a process archive. See TIBCO Designer User’s Guide for more
information about creating process archives.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
input
varies
The input to the called process is defined by the
Output Editor tab in the called process’ Start
activity. See TIBCO ActiveMatrix BusinessWorks
Process Design Guide for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Call Process 139
|
Output
The output for the activity is the following.
Output Item
Datatype
Description
output
varies
The output of the called process is defined by
the Input Editor tab in the called process’ End
activity. See TIBCO ActiveMatrix BusinessWorks
Process Design Guide for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
140
| Chapter 5
General Activities Palette
Catch
Activity
The Catch activity receives control of execution when an unhandled
exception occurs. You can select a specific exception type to catch or you
can specify that this activity should catch all unhandled exceptions. You
can have more than one Catch activity in each exception scope, but each
Catch activity must have a unique exception type.
The Catch activity allows you to transition to activities you wish to perform to
handle the exception. Transitions are permitted between Catch tracks within an
exception scope, but you can not transition back to the main execution track from
the Catch track.
If you wish to propagate the caught exception to the next highest scope, use the
Rethrow activity.
See the description error handling in TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about using the Catch activity.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Catch All
Checking this box indicates you wish processing to
resume with this activity when any exception is
encountered that is not already handled by an error
transition or another Catch activity.
You can have only one Catch activity within an
exception scope that has this field checked.
Exception to Catch
Specifies the exception type to catch. The list of
available exceptions that can be raised in the current
scope is automatically placed in the drop-down list in
this field. This field is not available when the Catch
All field is checked.
Each Catch activity within an exception scope must
specify a different value for this field.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Catch 141
|
Input
This activity has no Input.
Output
The output for the activity is the following.
Output Item
Datatype
Description
<exceptionName>
varies
Contains the schema for the thrown
exception. The contents of this element vary
depending upon the exception that is
encountered.
TIBCO ActiveMatrix BusinessWorks Palette Reference
142
| Chapter 5
General Activities Palette
Checkpoint
Activity
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. If a
process instance fails due to an unhandled exception or manual termination, it
can optionally be recovered at a later time, if the process engine is configured to
save checkpoint data for failed processes. See TIBCO ActiveMatrix BusinessWorks
Administration for more information about recovering failed process instances.
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.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
duplicateKey
String
A key value that is used to compare to other
process instances to determine whether
another process instance with the same
duplicateKey value already exists.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information on
detecting duplicate process instances.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Checkpoint 143
|
Checkpoints and Transactions
A Checkpoint activity cannot be placed in or in parallel to a transaction. You can,
however, specify that an implicit checkpoint should be taken as part of a
transaction by checking the Include Checkpoint field on a transaction group.
For explicit Checkpoints, place the checkpoint activity outside of any transaction
group. Also, make sure that if you have multiple paths in 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.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about creating groups for transactions and including an implicit checkpoint in a
transaction.
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 can be 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 in a process definition.
For example, if the process starter is waiting for an incoming HTTP request, and a
checkpoint is taken after the process starts but before the response to the request
is sent, the process cannot respond to the request when the process instance is
restarted. The socket for the HTTP request is closed when the process engine
crashes, therefore the Send HTTP Response activity in the restarted process
returns an error. In this case, place the response activity before the checkpoint so
that any response is sent before a checkpoint is taken.
There are other examples of situations where an incoming event must be handled
before the checkpoint is taken. The following lists some of these circumstances:
TIBCO ActiveMatrix BusinessWorks Palette Reference
144
| Chapter 5
General Activities Palette
•
An email message is received, then deleted from the email server.
•
An HTTP request is received.
You should exercise care in placing checkpoints in your process definitions. Make
certain that the process has all of the data required 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.
By default, checkpointed process instances are restarted when the engine restarts.
If the engine encounters errors during startup, the restarted process instances
continue to be processed and may eventually be lost depending upon the type of
error at startup. You can specify to shut down the process engine if any errors are
encountered during startup so that checkpointed jobs are not lost in the event of
an error. The custom engine property named Engine.ShutdownOnStartupError
controls this behavior. By default, the value of the property is false. Setting the
property to true shuts the engine down if errors are encountered when the
engine starts.
See TIBCO ActiveMatrix BusinessWorks Administration for more information about
setting custom engine properties.
Checkpoints and the Confirm Activity
In the case of confirmable messages (for example, a confirmable TIBCO
Rendezvous or Adapter message is received), you must consider the
consequences of performing a checkpoint before or after a Confirm activity.
If the checkpoint is taken before the Confirm activity, then a crash occurs after a
checkpoint but before a confirm, the original message is resent. In this case, the
restarted process can no longer send the confirmation. However, a new process is
started to handle the resent message, and you can implement your process to
handle the restarted and new processes appropriately.
If the checkpoint is taken after a Confirm activity, there is potential for a crash to
occur after the Confirm but before the checkpoint. In this case, the message is
confirmed and therefore not redelivered. The process instance is not restarted,
because the crash occurred before the checkpoint.
You must consider the type of processing your process definition performs to
determine when a checkpoint is appropriate if your process definition receives
confirmable messages.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Confirm 145
|
Confirm
Activity
The Confirm activity confirms any confirmable messages received by
the process instance. For example, if a process is started because of the
receipt of an RVCM message, the Confirm activity can send a
confirmation message to the publisher of the RVCM message.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Confirm Event
The message you wish to confirm. This is a drop
down list of any process starter or activity that
expects an incoming event in the current process
definition.
You can only confirm messages from confirmable
message sources, for example, RVCM, RVDQ, or JMS
messages. E-mail is also confirmable when received
by the Receive Mail process starter (the e-mail
message is deleted from the server when it is
confirmed). Select only the event that sent the
confirmable message.
If you select an event from the list that does not
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, no message is
confirmed.
See Checkpoints and the Confirm Activity on page 144 for more information
about using the Checkpoint and Confirm activities in a process definition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
146
| Chapter 5
General Activities Palette
Custom Activity
Resource
The Custom Activity resource allows you to create an activity that
references a process definition. This is useful if you wish to develop
processes for others to use, but you also wish to hide the
implementation details of the process from users. The Custom
Activity behaves like any other TIBCO ActiveMatrix BusinessWorks activity.
You can also package and distribute custom activities within custom palettes. See
TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about creating and packaging custom activities.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the custom
activity. This name also becomes the default name of
the activity when it is dragged and dropped into a
process definition.
Description
Short description of the activity.
Select Process
The process definition that contains the
implementation of the custom activity. You can only
specify process definitions that start with the Start
activity. You cannot specify process definitions that
use any other process starter.
Any resources referenced by the selected process are
automatically included in the custom activity.
Dynamically called subprocesses are not known at
design time, and therefore are not referenced by the
process definition. Therefore, dynamically called
subprocesses cannot be used by a process definition
within a custom activity.
Global variables referenced by the resources in the
custom activity are added to the $_globalVariables
process variable of the process that uses the custom
activity. You should document any required global
variables so that users of the custom activity can
specify appropriate values for the variables.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Custom Activity 147
|
Field
Description
Custom Icon File
The icon you wish to display for the custom activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
148
| Chapter 5
General Activities Palette
Engine Command
Activity
The Engine Command activity allows you to retrieve statistics and
information about process definitions, process instances, and
activities in the currently running process engine. This activity also
lets you perform engine maintenance, such as suspending and
resuming process instances and shutting down the engine.
This activity uses TIBCO Hawk to perform the desired command. A direct call is
made to the TIBCO Hawk AMI method (no message is sent).
Before using this activity, the Hawk.Enabled property must be set to either true
or local. Also, some commands require memory and processor overhead for
gathering statistics or for getting information on the current state of the process.
Because of the performance implications, certain instrumentation is disabled by
default. You can enable instrumentation for a specific process or for all processes
with the Instrumentation property.
See TIBCO ActiveMatrix BusinessWorks Administration for more information about
setting custom engine properties.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Command to
Execute
No
The command to execute. See Commands on
page 150 for more information about the
commands and their input and output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
Engine Command 149
|
Field
Global
Var?
Description
Process Definition
Name
No
Certain commands accept a process definition
name. This field allows you to specify the
process definition name that applies to the
selected command. This field only appears
when the one of the following commands is
selected in the Command to Execute field:
•
GetActivityStats
•
GetProcessInstanceInfo
•
ResumeProcessStarter
•
SuspendProcessStarter
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
<commandInput>
varies
The input for this activity varies depending
upon the command selected in the Command
to Execute field on the Configuration tab. See
Commands on page 150 for more information
about the input for each command.
Output
The output for the activity is the following.
Output Item
Datatype
Description
<commandOutput>
varies
The output for this activity varies depending
upon the command selected in the Command
to Execute field on the Configuration tab. See
Commands on page 150 for more information
about the output for each command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
150
| Chapter 5
General Activities Palette
Commands
The following are the commands that can be executed by this activity and the
corresponding input and output for each command.
GetActivityStats
Retrieves information about the activities that have been executed for a given
process definition since the engine was started. The activity information is
cumulative. A single activity name represents all executions of that activity.
The ExecutionTime computation for the Call Process Activity includes the sum of
the execution times for all activities in the called process, not just the execution
time for the call process activity itself.
Input Item
Datatype
Description
ProcessDefinitionName
String
Name of the process definition.
Specifying a value for this element
overrides the process definition
specified on the Configuration tab.
Output Item
Datatype
Description
ProcessDefinitionName
String
Name of the process definition.
ActivityName
String
Name of the activity.
ActivityClass
String
Name of the class that implements
the activity.
ExecutionCount
integer
Number of times the activity has
been executed.
ElapsedTime
integer
Total clock time (in milliseconds)
used by all executions of this
activity. This includes waiting time
for Sleep, Call Process, and Wait
For... activities.
ExecutionTime
integer
Total clock time (in milliseconds)
used by all executions of this
activity. This does not include
waiting time for Sleep, Call Process,
and Wait For... activities.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Engine Command 151
|
Output Item
Datatype
Description
ErrorCount
integer
Total number of executions of the
activity that have returned an error.
LastReturnCode
String
Status code returned by most recent
execution of this activity. This can be
either OK, DEAD, or ERROR.
TracingEnabled
boolean
True if tracing is enabled for this
activity, false if tracing is disabled.
MinElapsedTime
integer
Elapsed clock time (in milliseconds)
of the activity execution that has
completed in the shortest amount of
elapsed time.
MaxElapsedTime
integer
Elapsed clock time (in milliseconds)
of the activity execution that has
completed in the longest amount of
elapsed time.
MinExecutionTime
integer
Execution time (in milliseconds) of
the activity execution that has
completed in the shortest amount of
execution time.
MaxExecutionTime
integer
Execution time (in milliseconds) of
the activity execution that has
completed in the longest amount of
execution time.
MostRecentElapsedTime
integer
Elapsed clock time (in milliseconds)
of the most recently completed
activity execution.
MostRecentExecutionTime
integer
Execution time (in milliseconds) of
the most recently completed activity
execution.
TimeSinceLastUpdate
integer
Time (in milliseconds) since the
statistics have been updated.
ExecutionCountSinceReset
integer
A comma-separated list of names of
process definitions called by this
activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
152
| Chapter 5
General Activities Palette
Output Item
Datatype
Description
CalledProcessDefs
String
Number of activity executions that
have completed since the last reset
of the statistics.
GetProcessDefinitionStats
Retrieves information about process definitions. I
Output Item
Datatype
Description
ProcessDefinitionName
String
Name of the process definition.
ProcessStarterName
String
Name of the process starter for
the process.
NumberCreated
integer
Number of process instances
created for this process
definition.
NumberSuspended
integer
Number of times process
instances have been suspended.
NumberSwappedToDisk
integer
Number of times process
instances have been swapped to
disk.
NumberQueued
integer
Number of times process
instances have been queued for
execution.
NumberAborted
integer
Number of times process
instances have been aborted.
NumberCompleted
integer
Number of process instances that
have been successfully
completed.
NumberCheckpointed
integer
Number of times process
instances have executed a
checkpoint.
TotalExecutionTime
integer
Total execution time (in
milliseconds) for all successfully
completed process instances.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Engine Command 153
|
Output Item
Datatype
Description
AverageExecutionTime
integer
Average execution time (in
milliseconds) for all successfully
completed process instances.
TotalElapsedTime
integer
Total elapsed time (in
milliseconds) for all successfully
completed process instances.
AverageElapsedTime
integer
Average elapsed clock time (in
milliseconds) for all successfully
completed process instances.
MinElapsedTime
integer
Elapsed clock time (in
milliseconds) of the process
instance that has completed in
the shortest amount of elapsed
time.
MaxElapsedTime
integer
Elapsed clock time (in
milliseconds) of the process
instance that has completed in
the longest amount of elapsed
time.
MinExecutionTime
integer
Execution time (in milliseconds)
of the process instance that has
completed in the shortest
amount of execution time.
MaxExecutionTime
integer
Execution time (in milliseconds)
of the process instance that has
completed in the longest amount
of execution time.
MostRecentExecutionTime
integer
Execution time (in milliseconds)
of the most recently completed
process instance.
MostRecentElapsedTime
integer
Elapsed clock time (in
milliseconds) of the most
recently completed process
instance.
TIBCO ActiveMatrix BusinessWorks Palette Reference
154
| Chapter 5
General Activities Palette
Output Item
Datatype
Description
TimeSinceLastUpdate
integer
Time (in milliseconds) since the
statistics have been updated.
NumberCompletedSinceReset
integer
Number of process instances that
have completed since the last
reset of the statistics.
GetProcessInstanceExceptions
Retrieves error information reported by the specified process.
Input Item
Datatype
Description
ProcessId
integer
ID for the process instance. If not specified,
or if 0 is specified, exceptions for all process
instances are returned.
Output Item
Datatype
Description
ExceptionSequenceNumber
integer
Sequence number of the exception,
with the most recent exception
first.
ProcessId
integer
ID for the process instance.
ExceptionMessage
String
Exception message.
StackTrace
String
Exception stack trace.
ExceptionClass
String
Exception class name.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Engine Command 155
|
Output Item
Datatype
Description
ProcessStack
String
Process stack at exception. This
displays the
[ProcessName/GroupName/Acti
vityName] of the activity issuing
the exception. If the activity is in a
called sub-process, then the calling
activity’s process stack plus a '>'
separator character will be
pre-pended to the normal
information to produce the
process stack of the activity
issuing the exception.
TrackingID
integer
Tracking ID for the process
instance.
ProcessDefinitionName
String
Name of the process definition.
State
String
State of the process.
TIBCO ActiveMatrix BusinessWorks Palette Reference
156
| Chapter 5
General Activities Palette
GetProcessInstanceInfo
The values of the input elements for this command specify for which process
instances you wish to retrieve information. If you specify more than one input
element, the values are treated as an AND condition. For example, If you specify
the process definition name and the minimum duration, information for process
instances for the specified process definition that meet the minimum duration
time will be returned.
Input Item
Datatype
Description
ProcessId
integer
ID for the process instance.
ProcessDefinitionName
String
Name of the process definition used by
the process instance. Specifying a value
for this element overrides the process
definition specified on the
Configuration tab.
MinimumDuration
integer
Minimum time (in milliseconds) in
elapsed clock time since the process
instance started. All process instances
with greater elapsed times will be
retrieved.
Output Item
Datatype
Description
ProcessId
integer
ID for the process instance.
ProcessInstanceName
String
Name of the process definition used
by the process instance.
TrackingId
String
Tracking ID for the process instance.
CustomId
String
Custom ID for the process instance.
Status
String
Status of the process.
StartTime
integer
Time (in milliseconds) when the
process instance started.
ElapsedTimeSinceStarted
integer
Elapsed clock time (in milliseconds)
since the process instance started.
MainProcessName
String
Name of the main process definition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Engine Command 157
|
Output Item
Datatype
Description
CurrentActivityName
String
Name of the currently executing
activity in the process instance.
ProcessStarterName
String
Name of the process starter that
started this process instance.
SubProcessName
String
Name of the process definition for
the sub-process.
GetProcessStarterStats
Retrieves information about either active or inactive process starters. The
information is cumulative. A single process starter name represents all executions
of that process starter.
Output Item
Datatype
Description
ProcessDefinitionName
String
Name of the process definition.
ProcessStarterName
String
Name of the process starter.
Status
String
Status of the process starter. The
status can be INACTIVE, ACTIVE,
or READY.
TotalNumberCreated
integer
Number of process instances created
by this process starter.
NumberCreatedPerHour
integer
Number of process instances per
hour created by this process starter.
NumberRunning
integer
Number of process instances
currently executing.
NumberCompleted
integer
Number of process instances that
have completed.
StartTime
String
Time (in milliseconds) at which the
process starter was started.
ElapsedTimeSinceStarted
integer
Elapsed clock time since the process
starter was started.
TIBCO ActiveMatrix BusinessWorks Palette Reference
158
| Chapter 5
General Activities Palette
Output Item
Datatype
Description
RestartedFromCheckpoint
boolean
True if the process was restarted
from a checkpoint.
TracingEnabled
boolean
True if tracing is enabled for this
process starter, false if tracing is
disabled.
GetRecoverableProcesses
Retrieves the process instances that can be recovered. See TIBCO ActiveMatrix
BusinessWorks Administration for more information about recoverable process
instances. Use the returned process ID in the RestartRecoverableProcess or
RemoveRecoverableProces commands.
Output Item
Datatype
Description
ProcessId
integer
Process ID of the process instance
that can be restarted.
Status
string
Status of the process instance. Can be
one of the following:
•
faulted — this status occurs
when the process instance is
terminated due to an unhandled
exception.
•
interrupted — this status occurs
when the process instance is
terminated due to engine failure
(and the instance did not
automatically restart when the
engine restarted) or a manual
termination.
TrackingId
string
Tracking ID for the process instance.
CustomId
string
Custom ID for the process instance.
ProcessDefinitionName
string
Process definition name for this
process instance.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Engine Command 159
|
Output Item
Datatype
Description
RestartActivityName
string
Name of the last executed
Checkpoint activity in the process
instance. This is the point at which
the process instance will begin
executing when it is restarted.
KillProcessInstance
Kills the specified process instance. The process instance is stopped immediately
and permanently removed from the engine.
Input Item
Datatype
Description
ProcessId
integer
Process ID of the process instance you wish to
kill.
ListAllRoles
Returns a list of all roles, along with the current state (enabled or disabled) of each
role.
Output Item
Datatype
Description
Role
string
Name of the role.
Enabled
boolean
True if the role is enabled, false if the role is
disabled.
ListUserRoles
Returns a list of all user roles, along with the current state (enabled or disabled) of
each role.
Output Item
Datatype
Description
Role
string
Name of the role.
Enabled
boolean
True if the role is enabled, false if the role is
disabled.
TIBCO ActiveMatrix BusinessWorks Palette Reference
160
| Chapter 5
General Activities Palette
RemoveRecoverableProcess
Removes the specified recoverable process instance from the list of potential
recoverable processes. After executing this command, the checkpoint data of the
specified process instance is removed and the process instance will no longer be
able to be recovered. Obtain the process ID of the recoverable process with
GetRecoverableProcesses the command.
Input Item
Datatype
Description
ProcessId
integer
The name or process ID of the process instance
you wish to remove.
RestartRecoverableProcess
Restarts the specified recoverable process instance. Obtain the process ID of the
recoverable process with GetRecoverableProcesses the command.
Input Item
Datatype
Description
ProcessId
integer
The name or process ID of the process instance
you wish to restart.
ResumeProcessInstance
Resumes the specified process instance.
Input Item
Datatype
Description
ProcessId
integer
The name or process ID of the process instance
you wish to resume. You can retrieve the process
ID for a process instance by using the
GetProcessInstanceInfo command.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Engine Command 161
|
ResumeProcessStarter
Resumes the specified process starter.
Input Item
Datatype
Description
ProcessDefinitionName
string
The name of the process definition
whose process starter you wish to
resume. Specifying a value for this
element overrides the process
definition specified on the
Configuration tab.
StartStatsCollector
Enables collection of statistics for each executed activity. See TIBCO ActiveMatrix
BusinessWorks Administrationfor more information about collecting activity
statistics.
Output Item
Datatype
Description
FileName
string
Name of the file containing the collected data.
StopStatsCollector
Disables collection of statistics for each executed activity. See TIBCO ActiveMatrix
BusinessWorks Administrationfor more information about collecting activity
statistics.
TIBCO ActiveMatrix BusinessWorks Palette Reference
162
| Chapter 5
General Activities Palette
Shutdown
Shuts down the process engine. If no input is provided, this command shuts
down the engine immediately. You can optionally specify an amount of time to
delay the shut down of the engine or you can specify that the engine should wait
for any checkpointed process instances to complete before shutting down.
Input Item
Datatype
Description
MaxDelayInSeconds
integer
Specifies the amount of time (in seconds)
to wait before shutting down the process
engine.
WaitForCheckpoints
boolean
When true is specified, the engine waits
for any checkpointed process instances to
complete before shutting down.
SuspendProcessInstance
Suspends the specified process instance.
Input Item
Datatype
Description
ProcessId
integer
The name or process ID of the process
instance to suspend. You can retrieve the
process ID for a process instance by using
the GetProcessInstanceInfo command.
SuspendProcessStarter
Suspends the specified process starter.
Input Item
Datatype
Description
ProcessDefinitionName
string
The name of the process definition
whose process starter you wish to
suspend. Specifying a value for this
element overrides the process
definition specified on the
Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
External Command 163
|
External Command
Activity
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
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 in 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
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity
in the process definition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
164
| Chapter 5
General Activities Palette
Field
Global
Var?
Description
Description
No
Short description of the activity.
Command to
Execute
Yes
The command line to execute. You can also
specify any input and command-line
arguments to the command in this field. You
cannot specify more than one command by
piping output from one command to another
(for example, ls | more is not allowed).
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 have the
following value:
ls
If the command to execute is not located in one
of the directories specified in the PATH
environment variable (on UNIX or Windows),
you can specify the full path for the executable
command or you can use the environment
input element to specify the environment for
the command.
Make Output
Available as
Activity Output
Yes
When checked, this field specifies that the
output sent to standard output and standard
error by the command should be available in
the output schema of this activity.
For commands that 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,
such as Read File and Parse Data, to handle the
output file more efficiently.
TIBCO ActiveMatrix BusinessWorks Palette Reference
External Command 165
|
Field
Global
Var?
Description
Remove
Parameter Quotes
Yes
When checked, this field specifies that the
quotes surrounding the parameters should be
removed. The quotes will be removed even if
the parameter contains space(s).
By default, the checkbox is not selected.
Output Filename
Yes
Name and location of the file for storing any
output or errors produced by the command. If
this field is blank, no output file is created.
Output Line
Splitting
Yes
Controls whether the command output and
errors are split into multiple strings. This field
can have the following values:
•
None — The activity produces a single
string containing the command’s output or
errors. Line end characters are included in
this string.
•
At Operating System Line End — The
activity produces a repeating string
element with one string element per
output line. The lines are split by default
on the carriage return/line feed character,
depending on the operating system. The
line end characters are not included in the
output.
•
At Specified Token — The lines are split
wherever the specified token occurs. The
token is specified as an activity input
element, and the token is not included in
the output.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
166
| Chapter 5
General Activities Palette
The input for the activity is the following.
Input Item
Datatype
Description
command
string
The command to execute, including 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; in the string for this item to
specify a carriage return (that is, &crlf;
simulates pressing the Enter key).
environment
string
The environment variable settings used for
running the command. This element is
specified as a comma-separated list of
<name>=<value> pairs where <name> is the
name of the environment variable and
<value> is the value of the environment
variable.
If no value is specified for this element, the
command is run with the environment
variable settings that are specified in the
login scripts for the user account used to
execute the TIBCO ActiveMatrix
BusinessWorks process engine.
If a value is specified, the value of this
element replaces any environment settings
for the user account used to run the TIBCO
ActiveMatrix BusinessWorks process engine.
That is, the user environment is ignored and
this element’s value is used instead.
TIBCO ActiveMatrix BusinessWorks Palette Reference
External Command 167
|
Input Item
Datatype
Description
workingDirectory
string
The working directory for the command
process.
If workingDirectory is not specified, the
command process inherits its working
directory from the process engine.
token
string
Command output can be split into multiple
strings based on the token specified in this
element. This field is only available when At
Specified Token is chosen in the Line Split
field on the Configuration tab.
The following escape sequences are
supported in this element:
•
\r
— newline carriage return character
•
\n
— newline character
•
\t
— tab character
•
\\
— backslash character
For example, \r\n signifies to split at a
carriage return/linefeed, \\ signifies to split
when a backslash is encountered.
Output
The output for the activity is the following.
Output Item
Datatype
Description
returnCode
integer
The numeric return code returned by
the command.
Typically, a value of 0 in this element
signifies the command executed
successfully. A non-zero value usually
indicates termination of the command
due to an error.
TIBCO ActiveMatrix BusinessWorks Palette Reference
168
| Chapter 5
General Activities Palette
Output Item
Datatype
Description
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
checked on the Configuration tab.
This element can be repeating if the
Line Split configuration setting causes
the command’s output to be split into
several lines.
error
string
Any errors produced by the command
and sent to stderr. This element is
only available if the "Make Output
Available as Activity Output" field is
checked on the Configuration tab.
This element can be repeating if the
Line Split configuration setting causes
the command’s errors to be split into
several lines.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
InvalidInputException
There is an error in the activity’s
configuration or input mapping that is
preventing the command from being
executed.
CommandExecutionError
The command could not be executed.
FileIOError
There was an error when attempting to
write the output to a file.
Make sure the user that is running the
TIBCO ActiveMatrix BusinessWorks
engine has permission to write to the
output file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Generate Error 169
|
Generate Error
Activity
This activity generates an error and causes an immediate transition to
any error transitions. If there are no error transitions, the process
instance halts execution. This activity is useful in a group or in 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, for a process that calls a subprocess to check the credit of a customer,
you can use the Generate Error activity to raise an error for any error conditions,
such as the customer does not exist, or the customer has no credit available. In the
called subprocess, create a transition to the Generate Error activity after detecting
the error condition and the called process terminates. Processing continues with
an error in the calling process. An error transition on the Call Process activity can
handle the error.
Figure 9 illustrates the example described above.
Figure 9 Using the Generate Error activity
...
...
CreditCheck Subprocess
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about handling errors in process definitions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
170
| Chapter 5
General Activities Palette
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
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 mapped to the error
schema is propagated to the parent process.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about specifying process
error schemas.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
message
string
The text of the error message to generate.
messageCode
string
The error code of the error. This is used as an
identifier for the error so that applications can
test for the error.
data
complex
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Generate Error 171
|
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
172
| Chapter 5
General Activities Palette
Get Shared Variable
Activity
The Get Shared Variable activity retrieves the current value of a Shared
Variable or Job Shared Variable resource. If you are using this activity to
retrieve the value of a Shared Variable resource, you may want to use a
critical section group to ensure that no other process instances are
altering the value of the shared variable at the same time.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about shared variables and critical section groups.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Variable
Configuration
No
The Shared Variable or Job Shared Variable whose
value you would like to retrieve.
Description
Output
The output for the activity is the following.
Output Item
Datatype
Description
<schema>
varies
The value of the shared variable
specified in the Variable Configuration
field of the Configuration tab is the
output for this activity. The schema for
the output is determined by the
schema specified for the shared
variable.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Inspector 173
|
Inspector
Activity
The Inspector activity is used to write the output of any or all activities
and process variables to a file and/or stdout. This is particularly useful
when debugging process definitions and you wish to see the entire
schema instead of mapping specific elements to the Write File activity.
You can use the inspector activity to write the output of any activity or process
variable in the current process. Activities and process variables in a subprocess
are not available to the Inspector activity (but the output of a Call Process activity
can be written using the Inspector activity). If you wish to obtain the output from
one or more activities or process variables in a subprocess, place the Inspector
activity in the process definition of the subprocess.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Stdout
Specifies whether the output of this activity should be
sent to stdout. When checked, the output is sent to
stdout, when unchecked, the output is not sent to
stdout.
Activity
The output of the process variable you wish to
output. This is a drop down list of the available items
to output.
You can select All to output all available output. You
can also select global variables, process context, error
variables, or user-defined process variables to output.
Only activities that have output and are executed
prior to the Inspector activity are shown in the drop
down list.
TIBCO ActiveMatrix BusinessWorks Palette Reference
174
| Chapter 5
General Activities Palette
Field
Description
Append to File
When checked, specifies that the output should be
appended to the file specified in this activity’s input.
If unchecked, any file that exists with the specified
name is overwritten.
Suppress Job Headers
When checked, this suppresses the output of header
information, such as the process instance ID and the
timestamp. If unchecked, header information for the
current process instance is written before the output
of the activity or process variable.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
fileName
string
The absolute path to the file you wish to write.
This file will contain the output of the specified
activity or process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
output
string
The output of the process variable or activity
specified on the Configuration tab in string form.
This can be used if you wish to use this output in
subsequent activities, in addition to writing the
output to a file or stdout. For example, you can
use this output as the body of a TIBCO
Rendezvous message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JNDI Configuration 175
|
JNDI Configuration
Shared Configuration
The JNDI Configuration shared configuration resource provides a
way to specify JNDI connection information that can be shared by
other resources. This resource can be specified in any resource that
permits JNDI connections. For example, JDBC Connection and
JMS Connection can use JNDI connections.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
JNDI
Context
Factory
No
The initial context factory class for accessing JNDI.
(javax.naming.Context.INITIAL_CONTEXT_
FACTORY). You can choose from the drop down list of
supported classes.
See IBM WebSphere and JNDI Context Caching on
page 177 for more information when using IBM
WebSphere.
Note: TIBCO ActiveMatrix BusinessWorks attempts to
find the class. However, you may need to add the JAR
file supplied by your JNDI service provider to the
CLASSPATH environment variable to use JNDI.
JNDI
Context
URL
Yes
The URL to the JNDI service provider
(javax.naming.Context.PROVIDER_URL). An
example URL is provided when one of the supported
JNDI context factory classes is selected.
See your JNDI provider documentation for the syntax
of the URL.
JNDI User
Name
Yes
User name for logging into the JNDI server
(javax.naming.Context.SECURITY_
PRINCIPAL). If the JNDI provider does not require
access control, this field can be empty.
TIBCO ActiveMatrix BusinessWorks Palette Reference
176
| Chapter 5
General Activities Palette
Field
Global
Var?
Description
JNDI
Password
Yes
Password for logging into the JNDI server
(javax.naming.Context.SECURITY_
CREDENTIALS). If the JNDI provider does not require
access control, this field can be empty.
Test Configuration Button
The Test Configuration button allows you to test that the specified configuration
fields result in a valid connection to a JNDI server.
Advanced
The Advanced tab has the following fields.
Field
Validate
JNDI
Security
Context
Global
Var?
No
Description
Some application servers store the security context on
the thread used to establish the JNDI connection (at the
time of this release, only the WebLogic application
server does this). In that case, the first activity to use this
resource establishes the security context, then
subsequent activities use the same security context,
unless this field is checked. Checking this field ensures
that each activity that uses this resource examines the
security context to determine if the activity uses the
same security context as the security context established
on the thread. If they are different, the activity’s
configured security context is used.
Checking this field causes additional overhead for
activities that use this resource. Therefore, only check
this field when necessary.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JNDI Configuration 177
|
Field
Global
Var?
Description
Optional
JNDI
Properties
No
The table in this field contains optional properties to
pass to the JNDI server. Use the +, X, and arrow keys to
add, delete, and move properties in the list. Each
property requires the property name, the datatype for
the property, and the value for the property. See the
documentation for your JNDI provider for more
information about properties that can be passed to the
JNDI server.
IBM WebSphere and JNDI Context Caching
The IBM WebSphere application server provides a mechanism for caching the
JNDI context object to improve the performance of JNDI lookup operations.
TIBCO ActiveMatrix BusinessWorks also caches the JNDI context object when
resources such as EJB activities, JMS activities, JDBC activities, or JTA
UserTransactions use JNDI. BusinessWorks performs best when using its own
caching mechanism. Therefore, you must disable the IBM WebSphere caching
mechanism when using IBM WebSphere with BusinessWorks. See the IBM
WebSphere documentation for a complete description of its caching features.
You can disable the IBM WebSphere JNDI context caching feature by performing
the following procedure:
1. Configure a JNDI Configuration resource.
2. On the Advanced tab, click the + button next to the table in the Optional JNDI
Properties field to add a property.
3. In the Name field of the property, enter
com.ibm.websphere.naming.jndicache.cacheobject.
4. Leave the Type field as the default value of string.
5. In the Value field, enter none.
6. Click Apply to accept the changes.
7. Use the JNDI Configuration resource in an EJB Connection, JMS Connection,
or JTA UserTransaction shared configuration resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
178
| Chapter 5
General Activities Palette
Job Shared Variable
Shared Configuration
A Job Shared Variable shared configuration resource allows you to
store data for use by each process instance. A copy of the variable
is created for each new process instance. This resource is useful for
passing data to and from sub-processes without creating an input
or output schema for the called process.
You can use the Get Shared Variable and Set Shared Variable activities to access
the data instead of mapping data to a called processes input or output schemas.
New process instances receive a copy of the variable, so data cannot be shared
across process instances. Therefore, if a called process has the Spawn
configuration field checked, a new process instance is created and the process
instance receives a new copy of the job shared variable.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about shared variables.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Schema
The Schema tab allows you to define a custom schema to hold the data of the
variable. You can define your own datatype on this tab, and you can reference
XML schema stored in the project. See Appendix A, Specifying Data Schema, on
page 729 for a description of how to define a schema.
Initial Value
The Initial Value tab allows you to specify an initial value for the variable. You can
choose one of the following:
TIBCO ActiveMatrix BusinessWorks Palette Reference
Job Shared Variable 179
|
•
None — specifies that no initial value is set for the shared variable. You must
use the Set Shared Variable activity to set a value before you can read the
value of the variable with the Get Shared Variable activity.
•
Select Value — causes the Select Value field to appear. This field allows you to
choose a stored XML Instance resource containing data that matches the
schema specified on the Schema tab.
•
Build Value — causes the Build Value field to appear. The Edit button brings
up a smaller version of the XML Instance configuration. In this dialog you can
construct an XML document that contains the initial value of the shared
variable.
See TIBCO Designer Palette Reference for more information on creating XML
Instance resources.
TIBCO ActiveMatrix BusinessWorks Palette Reference
180
| Chapter 5
General Activities Palette
Label
Graphic Tool
The Label resource allows you to create a generic label so that you can
provide documentation and comments in your process definition. The
Label is not 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 in a process definition.
Labels can also be resized to cover an area. You can apply a border to the area by
selecting a value in the Border Type and Border Thickness fields. You can also
apply a background color to the area by selecting a color in the Background color
field. This allows you to annotate your process definition and provide colors and
borders to visually group related activities in your process definition.
The text of the label remains in the top left of the label area, but you can edit the
text either in the design panel or by editing the Description field.
Configuration
The Configuration tab has the following fields.
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 and border of
the label. Use the Chose Color button to bring up a
dialog to select a color.
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.
Background Color
Allows you to pick a background color for the area
the label covers. Use the Chose Color button to bring
up a dialog to select a color.
Border Type
Allows you to select the type of border (either a
dashed line or a solid line) for the label.
Border Thickness
Allows you to specify the thickness of the border line.
0 indicates no border.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Label 181
|
Field
Description
Gradient Background
Color
Specifies whether the background color changes from
lighter to darker. When this checkbox is uncheked, the
background is a solid color.
The following illustrates the difference between a
gradient and solid background color. The top label
uses a gradient background color and the bottom
label uses a solid background color.
By default, the background color is gradient.
TIBCO ActiveMatrix BusinessWorks Palette Reference
182
| Chapter 5
General Activities Palette
Lock Object
Shared Configuration
Lock Object shared configuration resources are used by Critical Section
groups to ensure that only one process instance executes the activities in a
critical section group at a time.
The Lock Object resource can be used to synchronize process instances
from more than one process definition in the same process engine, or it can be
used to synchronize process instances across multiple process engines.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about Critical Section groups and Lock Object resources.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Multi-Engine
Yes
When checked, this field specifies the resource will
be used to synchronize process instances across
more than one process engine. If you are using this
resource to synchronize shared variable access,
make sure that the Lock Object and Shared
Variable resources have the same setting for this
field.
When synchronization is performed across process
engines, a database transaction is performed to
ensure proper execution order. Therefore, you
must configure your process engine to use a
database for storage, if you wish to synchronize
Critical Section groups across process engines. See
TIBCO ActiveMatrix BusinessWorks Administration
for more information about specifying a database
for storing process engine information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Mapper 183
|
Mapper
Activity
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.
Input Editor
The Input Editor 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 Input Editor tab becomes the
input and output schema of the Mapper activity. This data then becomes available
to other activities in the process definition.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is defined by the specified data elements on the Input
Editor tab.
Output
The output for the activity is defined by the specified data elements on the Input
Editor tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
184
| Chapter 5
General Activities Palette
Notify
Activity
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 ActiveMatrix BusinessWorks Process Design
Guide for more information on inter-process communication.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Shared Configuration
The Notify Configuration shared configuration
resource that defines a data schema for this activity.
See Notify Configuration on page 186 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.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Notify 185
|
The input for the activity is the following.
Input Item
Datatype
Description
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 ActiveMatrix 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
complex
The schema specified by the Shared
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.
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
186
| Chapter 5
General Activities Palette
Notify Configuration
Shared 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 ActiveMatrix BusinessWorks Process Design Guide for
more information about inter-process communication.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the shared resource.
Local Only
When checked, this field specifies that the notification
will be performed in memory only. When unchecked,
a database is used to perform the notification.
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.
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 Data tab appears on the Input or Output tab of the Receive Notification,
Wait, or Notify activity where this shared configuration resource is used.
See Appendix A, Specifying Data Schema, on page 729 for a description of how to
define a schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Null 187
|
Null
Activity
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, you can create a transition from the
activity at the end of each path to a Null activity to resume a single flow of
execution in the process.
TIBCO ActiveMatrix BusinessWorks Palette Reference
188
| Chapter 5
General Activities Palette
On Event Timeout
Process Starter
The On Event Timeout process starter specifies a process to execute
when a Wait For ... activity discards an incoming event due to a
timeout. A Wait For ... activity’s event timeout is specified by the
Event Timeout field on the Event tab of the activity.
The default behavior for an event timeout is to confirm and then discard the
event. You can override the default behavior by creating a process definition
using the On Event Timeout process starter.
You can specify an On Event Timeout process definition for a specific event source
(that is, a specific Wait For... activity). You can specify one or more On Event
Timeout process definitions for specific event sources, but you should not create
more than one process definition for the same event source. Once a Wait For...
activity experiences a timeout, that timeout can only apply to one On Event
Timeout process definition.
You can also specify that an On Event Timeout process definition applies to any
event source that experiences a timeout. If there is no On Event Timeout specified
for a particular event source, the process engine calls the On Event Timeout
process definition whose Any Event Source field is checked.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the process starter.
Any Event Source
Specifies that this process starter should execute
when any event source experiences an event timeout,
and there is no On Event Timeout process definition
specified for the event source.
TIBCO ActiveMatrix BusinessWorks Palette Reference
On Event Timeout 189
|
Field
Description
Event Source
Only appears when the Any Event Source field is
unchecked. This field allows you to specify for which
event source this process should execute when there
there is an event timeout.
Only one On Event Timeout process definition can
correspond to any event timeout. That is, you cannot
create multiple process definitions and use the same
Wait For ... activity the Event Source field.
Output
The output for the activity is the following.
Output Item
Datatype
Description
originatingProcess
string
The name of the process definition
containing the activity that had the
event timeout.
originatingActivity
string
The name of the activity that had an
event timeout.
<event>
complex
The schema of the discarded event. If
the Any Event Source field is checked
on the Configuration tab, this appears
as an element of type any. If a specific
activity is supplied in the Event Source
field, the output schema of that activity
is provided.
TIBCO ActiveMatrix BusinessWorks Palette Reference
190
| Chapter 5
General Activities Palette
On Notification Timeout
Process Starter
The On Notification Timeout process starter specifies a process to
execute when a timeout is reached for storing notification data for a
Notify activity. See Notify on page 184 for more information about
the Notify activity and how to specify a timeout for storing
notification information.
You can specify an On Notify Timeout process definition for a specific Notify
Configuration. The process definition with the On Notification Timeout process
starter executes when a Notify activity with a matching Notify Configuration
experiences a timeout. You can specify one or more On Notify Timeout process
definitions for specific Notify Configurations, but you should not create more
than one process definition for the same Notify Configuration. Once a Notify
activity experiences a timeout of its stored notification information, that timeout
can only apply to one On Notification Timeout process definition.
You can also specify that an On Notification Timeout process definition applies to
any Notify activity that experiences a timeout. If there is no On Notification
Timeout specified for the Notify Configuration of the Notify activity, the process
engine calls the On Notification Timeout process definition that has the Any
Notify Config field checked.
Notify timeouts cause the notify information to be marked for removal, but the
information is removed at regular intervals. The default interval for checking
Notify timeouts is 60 seconds, and therefore, the OnNotificationTimeout process
starter only starts processes after each interval. If you wish to reduce the interval,
you can do so by altering the Engine.WaitNotify.SweepInterval custom
engine property to the desired number of seconds. However, as you decrease the
number of seconds in the interval you will incur further engine overhead.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the process starter.
TIBCO ActiveMatrix BusinessWorks Palette Reference
On Notification Timeout 191
|
Field
Description
Any Notify Config
Specifies that this process starter should execute
when any Notify activity experiences a timeout, and
there is no On Notify Timeout process definition
specified for the Notify Configuration for the activity.
When this field is checked, the Notify Configuration
field becomes disabled. Uncheck this field when you
wish to specify a process definition for a specific
Notify Configuration.
Notify Configuration
Only appears when the Any Notify Config field is
unchecked. This field allows you to specify the Notify
Configuration that this process applies to. Only
timeouts for Notify activities with a matching Notify
Configuration will start a process instance.
Only one On Notification Timeout process definition
can correspond to any Notify Configuration. That is,
you cannot create multiple process definitions and
use the same Notify Configuration.
Output
The output for the activity is the following.
Output Item
Datatype
Description
notificationData
Object
This element contains the schema
specified in the Notify Configuration of
the Notify activity that has timed out.
TIBCO ActiveMatrix BusinessWorks Palette Reference
192
| Chapter 5
General Activities Palette
On Shutdown
Process Starter
The On Shutdown process starter specifies a process to execute when
the process engine shuts down, after all process instances are
executed.
The On Shutdown process starter can be useful for specifying any
post-processing that must be done before shutting down the engine. For example,
your application may back up a database table then purge the data. Also, you
may wish to send email to administrators notifying them that the process engine
is shutting down.
Typically, you create one process definition that uses the On Shutdown process
starter and place all post-processing activities into that process definition.
However, you can have more than one process definition that uses the On
Shutdown process starter. All process definitions with the On Shutdown process
starter execute in no specific order when the process engine shuts down.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the process starter.
TIBCO ActiveMatrix BusinessWorks Palette Reference
On Startup 193
|
On Startup
Process Starter
The On Startup process starter specifies a process to execute when the
process engine starts, before any incoming events are processed. In the
event that the process engine is restarting and attempting to recover
checkpointed process instances, the On Startup process definition must
complete its execution before any recovered process instances execute.
The On Startup process starter can be useful to specify any pre-processing that
must be done before regular processing starts. For example, your application may
check that the required database tables exist and create them necessary. Also, you
may wish to send email to administrators notifying them that the process engine
is starting.
Typically, you create one process definition that uses the On Startup process
starter and place all pre-processing activities into that process definition.
However, you can have more than one process definition that uses the On Startup
process starter. All process definitions with the On Startup process starter execute
in no specific order when the process engine starts.
All On Startup process definitions must complete successfully before normal
processing can begin.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the process starter.
TIBCO ActiveMatrix BusinessWorks Palette Reference
194
| Chapter 5
General Activities Palette
Receive Notification
Activity
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 activities 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.
The Wait, Receive Notification, and Notify activities allow running process
instances to communicate. See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information on inter-process communication.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Shared Configuration
The Notify Configuration shared configuration
resource that defines a data schema for this activity.
See Notify Configuration on page 186 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Receive Notification 195
|
Field
Description
Key
The key that coordinates a Receive Notification
process starter with the corresponding Notify activity.
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.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information and examples of choosing
the key for Wait, Notify, and Receive Notification.
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
TIBCO ActiveMatrix BusinessWorks Palette Reference
196
| Chapter 5
General Activities Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
schema
complex
The schema specified by the Shared
Configuration field on the Configuration tab.
This schema is used to pass data from the
process instance containing the Notify activity
into this process instance.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rethrow 197
|
Rethrow
Activity
The Rethrow activity throws the exception caught by the Catch activity
again. Use this activity when you wish to propagate the exception to the
next level. See the description of error handling in TIBCO ActiveMatrix
BusinessWorks Process Design Guide for more information about using the
Rethrow activity.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Input
This activity has no Input.
Output
This activity has no Output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
198
| Chapter 5
General Activities Palette
Set Shared Variable
Activity
The Set Shared Variable activity allows you to change the value of a
shared variable. If you are using this activity to set the value of a
Shared Variable resource, you may want to use a critical section group
to ensure that no other process instances are altering the value of the
shared variable at the same time.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about shared variables and critical section groups.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Variable
Configuration
No
The Shared Variable or Job Shared Variable
whose value you would like to change.
Output New
Value
No
When checked, the new value of the shared
variable is placed into this activity’s output.
The value is then available to subsequent
activities in the process definition.
Description
If not checked, this activity has no output.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Set Shared Variable 199
|
The input for the activity is the following.
Input Item
Datatype
Description
<schema>
varies
The schema of the shared variable
specified in the Variable
Configuration field on the
Configuration tab is the input
schema for this activity.
Output
The output for the activity is the following.
Output Item
Datatype
Description
<schema>
varies
When the Output New Value field on
the Configuration tab is unchecked,
this activity has no output. When the
field is checked, the new value of the
shared variable is output. The schema
for the output is determined by the
schema specified for the shared
variable.
or no output
TIBCO ActiveMatrix BusinessWorks Palette Reference
200
| Chapter 5
General Activities Palette
Shared Variable
Shared Configuration
A Shared Variable resource allows you to share data across process
instances. All process instances can read and update the data stored
in a shared variable.
This resource is useful if you wish to marshal data across process
instances or if you wish to make a common set of information available to all
process instances. For example, you may have a set of approval codes for
incoming orders that change daily for security purposes. You can create a shared
variable to hold the approval codes and create one process definition for setting
the codes. You can then retrieve the shared variable in all processes that require
the current approval codes.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about shared variables.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Persistent
Yes
The current value of the shared variable is stored in
memory for fast access by process instances.
However, if a process engine crashes, the current
state of the shared variable may be lost. To preserve
the current state of a Shared Variable resource, you
can check this field to store the current value of the
shared variable in the process engine’s storage
location.
The current state of the shared variable is only
updated in the process engine’s persistent storage
when the value of the variable changes.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Shared Variable 201
|
Field
Global
Var?
Description
Multi-Engine
Yes
Checking this field specifies that you wish to make
the value of a Shared Variable resource available to
process instances across multiple process engines.
If you choose this option, a database must be used to
store process engine data. Also, only engines that are
in the same deployment and use the same database
to store process information can share variables. See
TIBCO ActiveMatrix BusinessWorks Administration for
more information on specifying a database for
process engine storage during deployment. See
TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information on specifying a database
for process engine storage during testing.
Because multiple process engines access the shared
variable when this field is checked, the current value
of the variable is not stored in memory. Both
retrieving the current value of the variable and
assigning a new value to the variable requires I/O to
the process engine’s database storage.
If this field is not checked, each process engine
operates on its own set of shared variable resources.
Process instances on one engine cannot retrieve the
value of the shared variable set by a different process
engine, when this field is unchecked.
Schema
The Schema tab allows you to define a custom schema to hold the data of the
shared variable. You can define your own datatype on this tab, and you can
reference an XML schema stored in the project. See Appendix A, Specifying Data
Schema, on page 729 for a description of how to define a schema.
Initial Value
The Initial Value tab allows you to specify an initial value for the shared variable.
You can choose one of the following:
TIBCO ActiveMatrix BusinessWorks Palette Reference
202
| Chapter 5
General Activities Palette
•
None — specifies that no initial value is set for the shared variable. You must
use the Set Shared Variable activity to set a value before you can read the
value of the variable with the Get Shared Variable activity.
•
Select Value — causes the Select Value field to appear. This field allows you to
choose a stored XML Instance resource containing data that matches the
schema specified on the Schema tab.
•
Build Value — causes the Build Value field to appear. The Edit button brings
up a smaller version of the XML Instance configuration. In this dialog you can
construct an XML document that contains the initial value of the shared
variable.
See TIBCO Designer Palette Reference for more information on creating XML
Instance resources.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Sleep 203
|
Sleep
Activity
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
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
IntervalInMillisec
integer
The amount of time, in
milliseconds, to suspend the
current branch of the process.
TIBCO ActiveMatrix BusinessWorks Palette Reference
204
| Chapter 5
General Activities Palette
Timer
Process Starter
The Timer process starter starts a process at a specific time. You can also
specify that processes are to be started periodically.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Start Time
Yes
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.
Description
The local machine’s time zone is used to
determine when the process should start. If the
project is run on machines in different time zones,
the time zone of the machine where the project
was saved is used. Use a global variable in this
field to supply start times relative to the time zone
where the project is deployed.
If you supply a global variable for this field, the
format of the specified time must be the following:
yyyy MMM dd HH:mm:ss z
For example, "2004 Apr 28 20:35:11 EST". The
z at the end of the date format is the name of the
time zone. See Time Zone Names on page 362 for
a list of time zone names.
Run once
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
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 Interval Unit
fields appear to allow you to specify the frequency
of the process.
Timer 205
|
Field
Global
Var?
Description
Time Interval
Yes
Integer indicating the number of units specified in
the Interval Unit field. For example, if a value of 1
is specified and the Interval Unit field is specified
as Hour, a new process is started every hour
beginning at the time specified in the Start Time
field.
If a value of 2 is specified and the Interval Unit
field is specified as Month, a process is started
every other month, beginning at the time specified
in the Start Time field.
If the value specified is less than one second (1000
milliseconds), the timer ignores the specified
interval and is triggered once every second.
Note: If you use a global variable for this field, the
global variable specifies the time interval in
milliseconds and the Interval Unit field is not
displayed.
Interval Unit
No
Unit of time to use with the Time Interval field to
determine how often to start a new process. The
units can be: Millisecond, Second, Minute, Hour,
Day, Week, Month, Year.
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
206
| Chapter 5
General Activities Palette
Field
Description
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
TimerOutputSchema
TIBCO ActiveMatrix BusinessWorks Palette Reference
Datatype
Description
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 207
|
Wait
Activity
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 resource 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 activities 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.
The Wait, Receive Notification, and Notify activities allow running process
instances to communicate. See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information on inter-process communication.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Shared Configuration
The Notify Configuration shared configuration
resource that defines a data schema for this activity.
See Notify Configuration on page 186 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.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
208
| Chapter 5
General Activities Palette
The input for the activity is the following.
Input Item
Datatype
Description
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 ActiveMatrix 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 in this specified
number of seconds, the Wait times out and
transitions to the next activity.
If no value or if zero is specified in this field, this
activity waits indefinitely.
Output
The output for the activity is the following.
Output Item
Datatype
Description
schema
complex
The schema specified by the Shared
Configuration on the Configuration tab. This
schema is used to pass data from the process
instance containing the Notify into this process
instance.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Write To Log 209
|
Write To Log
Activity
This activity writes a message to the log. There is one log file for each
process engine.
Depending upon whether you are using a process engine in testing mode
or a deployed process engine, the logs are stored in different locations.
During test mode, the logs are stored in the TIBCO ActiveMatrix BusinessWorks
working directory under the logs subdirectory. See TIBCO Designer User’s Guide
for more information about specifying the working directory. For deployed
process engines, the log location is specified by custom engine properties. See
TIBCO ActiveMatrix BusinessWorks Administration for more information about
custom engine properties.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
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.
You can enable or disable system or user-defined roles
using custom engine properties at deployment time.
See Custom Properties for the Write To Log Activity
on page 210 for more information.
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
210
| Chapter 5
General Activities Palette
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
message
string
The message that you would like to appear in the
log.
Logs are stored in the TIBCO ActiveMatrix
BusinessWorks installation directory under the logs
subdirectory.
Note: When the message contains non-ASCII data,
the default encoding of the Java Virtual Machine
used by the TIBCO ActiveMatrix BusinessWorks
process engine is used to encode the text when
writing to the log file.
msgCode
string
The error code of the message. This is used as an
identifier for the message so that applications can
scan the log for the message.
Output
This activity produces no output.
Custom Properties for the Write To Log Activity
In some situations, you may wish to specify which messages are sent to the log
file. You can use custom engine properties to specify which roles are enabled or
disabled for log messages. You may configure the following properties:
•
Trace.<roleName>.Log
•
Trace.<roleName>.* — Setting this property to false disables all messages for
the specified role. The specified role can be one of the following system roles:
WARN, TRACE, DEBUG, or INFO.
•
Trace.Role.<roleName>
— Setting this property to false disables writting
messages for the specified role name to the log.
— Setting this property to false disables all messages
for the specified user-defined role. Setting Trace.Role.* to false disables all
messages to all user-defined roles.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Write To Log 211
|
•
Trace.Role.* — Setting this property to false disables all messages for all
user-defined roles.
You can also specify the character encoding of the log file by using the
property.
log.file.encoding
See TIBCO ActiveMatrix BusinessWorks Administration for more information about
setting custom engine properties.
TIBCO ActiveMatrix BusinessWorks Palette Reference
212
| Chapter 5
General Activities Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 213
Chapter 6
HTTP Palette
The HTTP palette allows you to send and receive HTTP requests.
Topics
•
HTTP Connection, page 214
•
HTTP Receiver, page 222
•
Proxy Configuration, page 233
•
Send HTTP Request, page 234
•
Send HTTP Response, page 252
•
Wait for HTTP Request, page 258
TIBCO ActiveMatrix BusinessWorks Palette Reference
214
| Chapter 6
HTTP Palette
HTTP Connection
Shared Configuration
The HTTP Connection resource describes the characteristics of the
connection used to receive incoming HTTP requests. This resource is
used when TIBCO ActiveMatrix 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.
There can be at most one process with an HTTP Receiver or Wait for HTTP
Request that uses the same HTTP Connection resource. This restriction allows the
HTTP server listening for incoming requests to dispatch the request to the correct
process.
There can be more than one SOAP Event Source that uses the same HTTP
Connection.
Also, SOAP Event Source and HTTP activities can use the same HTTP Connection
resource and the HTTP server correctly dispatches the incoming request to the
correct process.
Two types of servers are available for the HTTP Connection resource: Tomcat and
HTTPComponent.
Tomcat has a synchronous request response paradigm and can be used in
scenarios where high throughput is important. To achieve a good throughput
with Tomcat, the maxprocessor value should be almost equal to the number of
concurrent requests the server can handle. Note that increasing the maxprocessor
count also increases the memory footprint.
HTTPComponent is a light-weight and scalable server based on NIO which can
be useful in scenarios where handling thousands of requests in a resource efficient
manner is more important than the throughput. HTTPComponent server gives a
consistent throughput for any number of concurrent requests with little or no
increase in its worker thread (maxprocessor thread).
You can choose the server type at runtime by setting the global property
bw.plugin.http.server.serverType in the file bwengine.tra. Using this
property, you can use the HTTPComponent server at run-time for older projects
without having to modify the server type at design-time. The value set for this
property in the bwengine.tra file overrides the value that is set in design-time.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Connection 215
|
The HTTP Connection resource can specify that the HTTPS (secure sockets layer
or SSL) protocol must be used by clients. If this is enabled, you can configure the
SSL parameters for the HTTP server using the Configure SSL Button. See
Configure SSL Button on page 216 for more information.
If you have multiple HTTP Connection resources specified by multiple HTTP
Receiver process starters, the HTTP servers require that all of the connections
must be valid to initialize all HTTP Receivers. Therefore, make certain that all
HTTP Connection resources have valid configurations before testing or deploying
the project.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Host
Yes
Specifies the name of the host that accepts the
incoming requests. For machines that have only one
network card, the default value localhost specifies
the current machine. For machines that have more
than one network card, this field specifies the host
name of the card that will be used to accept
incoming HTTP requests.
If there is more than one network card on the
machine, and you specify localhost in this field,
all network cards on the machine will listen for
incoming HTTP requests on the specified port.
Note: Only one HTTP server can be started on each
port. Therefore, if you have a machine with
multiple network cards, make certain that all HTTP
Connection resources that use the same host name
specify different port numbers.
Port
Yes
Port number on which to listen for incoming HTTP
requests.
TIBCO ActiveMatrix BusinessWorks Palette Reference
216
| Chapter 6
HTTP Palette
Field
Global
Var?
Description
SSL
No
Specifies whether incoming requests must use the
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 SSL
parameters with the Configure SSL button (see
Configure SSL Button on page 216).
Server Type
No
Specifies the server type to be used. The drop-down
lists the available options: Tomcat and
HTTPComponent.
Configure SSL Button
The Configure SSL button allows you to specify the SSL parameters for the HTTP
connection. The following are the fields in the SSL Configuration for HTTPS
Connections dialog:
The HTTPComponent server type does not support Entrust based SSL.
Field
Description
Requires Client
Authentication
Checking this field requires clients to present their
digital certificate before connecting to the HTTP server.
When this field is checked, the Trusted Certificates
Folder becomes enabled so that you can specify a
location containing the list of trusted certificate
authorities.
Trusted Certificates
Folder
This field is only applicable when the Requires Client
Authentication field is checked.
This field specifies a folder in the project containing
one or more certificates from trusted certificate
authorities. This folder is checked when a client
connects to ensure that the client is trusted. This
prevents connections from rogue clients.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Connection 217
|
Field
Description
Identity
This is an Identity resource that contains the HTTP
server’s digital certificate and private key.
See TIBCO Designer Palette Reference for more
information.
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified with
the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
Advanced
The Advanced tab has the following fields
Field
Global
Var?
Description
Enable DNS
Lookups
No
Checking this field enables a Domain Name System
(DNS) lookup for HTTP clients so that the IP
address is resolved to a DNS name. This can
adversely affect throughput. Uncheck this field by
default and check this field only when required.
Connection Properties
maxPostSize
Yes
This property is available when the Server Type
Tomcat is selected.
Specifies the maximum size in bytes of the POST
that the container FORM URL parameter parsing
can handle.
By default, the value of this field is set to 2M or
2097152 bytes. Setting the value less than or equal to
zero disables the limit for maxPostSize.
TIBCO ActiveMatrix BusinessWorks Palette Reference
218
| Chapter 6
HTTP Palette
Field
Global
Var?
Description
maxSavePost
Size
Yes
This property is available when the Server Type
Tomcat is selected.
Specifies the maximum size in bytes of the POST
that the container can save/buffer during FORM or
CLIENT-CERT authentication.
During FORM authentication, the request message
is saved while the user is redirected to the login
page. It is retained until the user authentication
succeeds or the session associated with the
authentication request expires.
During CLIENT-CERT authentication, the request
message is buffered for the entire duration of the
SSL handshake. Once the request is processed, the
buffer is emptied.
However, in both the cases the buffering happens
before the user is authenticated.
By default, the value of this field is set to 4K or 4096
bytes. Setting the value to -1 disables the limit for
this field.
URI Encoding
Yes
Specifies the character encoding used to decode the
URI bytes.
If you do not set any value for uriEncoding, the
default encoding set in HTTP Receiver is used.
Specifying this property automatically sets the
Tomcat property useBodyEncodingForURI to false.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Connection 219
|
Field
Global
Var?
Description
acceptCount
Yes
This property is available when the Server Type
Tomcat is selected.
Specifies the maximum number of incoming
connection requests that can be accepted when all
HTTP processors are in use.
The default value for acceptCount is 100. Incoming
requests received after the acceptCount limit is
reached are rejected.
If the value is not set in TIBCO Designer, you can
set the value for either design-time or run-time.
compressable
MimeType
Yes
•
Specify the value in a .config file. Provide the
file name and location while starting TIBCO
Designer to set the value of acceptCount in
design-time.
•
Specify the value in bwengine.tra to set the
value in run-time.
Specifies the list of MIME types for which HTTP
compression may be used. The default value for this
comma separated list is text/html, text/xml,
text/plain.
compression
Yes
Specifies if the output of the HTTP Connection is
compressed using HTTP/1.1 GZIP compression.
The acceptable values for this field are off:
on:
By default, the compression is disabled.
Allows compression for text data.
force: Forces compression in all cases.
Note that if the content length is not known and
compression is enabled, the output will still be
compressed.
any numerical integer value: Any numerical value
equivalent to "on", and specifies the minimum
amount of data before the output can be
compressed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
220
| Chapter 6
HTTP Palette
Field
Global
Var?
Description
connectionTi
meOut
Yes
Specifies the number of milliseconds that the
Connector waits for the request URI line to be
presented after the connection is accepted.
The default value is 60000 i.e., 60 seconds.
Custom Properties for the HTTP Palette
In some situations, you may wish to alter the configuration of the HTTP server
that receives incoming HTTP requests for TIBCO ActiveMatrix BusinessWorks.
You can configure the following custom properties:
•
bw.plugin.http.server.minProcessors
•
bw.plugin.http.server.maxProcessors
•
bw.plugin.http.server.maxSpareProcessors
•
bw.plugin.http.server.acceptCount — the maximum queue size for
incoming requests. Incoming requests that are not handled by available
threads are placed on the queue until they can be processed. If the queue is
full, new incoming requests are refused with an error. The default value of this
property is 100.
•
bw.plugin.http.server.allowIPAddresses — a comma-separated list of
regular expression patterns that is compared with the remote client’s IP
address before accepting or rejecting requests from the client. The remote IP
address of the client must match for the request to be accepted.
•
bw.plugin.http.server.restrictIPAddresses
— the minimum number of
theads available for incoming HTTP requests. The HTTP server creates the
number of threads specified by this paramter when it starts up. The default
value of this property is 10.
— the maximum number of
threads available for incoming HTTP requests. The HTTP server will not
create more than the number of threads specified by this parameter. The
default value of this property is 75.
- the maximum number of
unused request processing threads that can exist until the thread pool starts
stopping the unnecessary threads. The default maximum number of spare
threads is 50.
— a comma-separated list
of regular expression patterns that is compared with the remote client’s IP
address before accepting or rejecting requests from the client. The remote IP
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Connection 221
|
address of the client must not match for any request from this client to be
accepted.
If the same IP address is allowed and restricted, the restriction overrides the
allowance and the IP address will be restricted.
•
bw.plugin.http.server.serverType — the type of server to be used for the
HTTP connection resource. Two server types are available: Tomcat and HTTP
Component. The default value of this property is Tomcat.
•
— the maximum
number of web server threads available to handle HTTP requests for the
HTTPComponents server type. The default value of this property is 50.
bw.plugin.http.server.httpcomponents.workerThread
If you have a large number of incoming requests, you may wish to change the
values of these properties to handle more incoming requests concurrently.
See TIBCO ActiveMatrix BusinessWorks Administration for more information about
setting custom engine properties.
When a client sends a request that cannot be processed because no threads are
available, TIBCO ActiveMatrix BusinessWorks returns a ConnectionRefused
exception to the client.
The HTTP Receiver uses the minProcessors/maxProcessors properties to control
the flow of incoming HTTP requests. If you set the Flow Limit deployment
property for a process definition with the HTTP Receiver process starter,
maxProcessors is set to <flowLimitValue> - 1 and minProcessors is set to
<maxProcessorValue>/2. Therefore, the Flow Limit value will never be reached
because the maxProcessors property will prevent new requests from being
accepted before the Flow Limit value is reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
222
| Chapter 6
HTTP Palette
HTTP Receiver
Process Starter
Starts a process based on the receipt of a HTTP request.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
HTTP
Connection
No
The HTTP Connection shared resource that
describes the connection characteristics this
process starter uses listens for incoming HTTP
requests.
Description
See HTTP Connection on page 214 for more
information about specifying shared resources.
Output Style
No
Type of output. Can be either String or Binary.
Parse Post
Method Data
No
Specifies to parse the message body of the HTTP
request into a schema for the activity’s output.
When this checkbox is checked, the parameters
specified in the Parameters field are used to
validate the incoming request and parse it into
the output schema.
Note: In the case of an incoming GET request,
there is no message body, so this field has no
effect on incoming GET requests.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Receiver 223
|
Field
Global
Var?
Description
Parameters
No
The parameters of the incoming HTTP request.
Specifying parameters in this table allows the
incoming request to be parsed and represented
as a schema in this activity’s output. For each
parameter, you must provide a name, datatype,
and whether the field is required, optional, or
repeating.
Use the + and x buttons to the right of the
parameter table to add and remove parameters.
Use the up and down arrows to move
parameters to new positions in the table.
Note: Specifying parameters in this field parses
the query string of the request into the output
schema, regardless of whether the Parse Post
Method Data field is checked. Checking the
Parse Post Method Data field and specifying
parameters here is required to parse the message
body along with the query string of the request.
HTTP
Authentication
No
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 in the domain using TIBCO
Administrator.
Expose Security
Context
No
Places the information from the user’s security
context (either authentication or SSL certificate
information) into the Context/SecurityContext
output element.
This is a fairly expensive operation and SSL
certificates can consume memory resources, so
check this option only if you require information
from the user’s security context for later use in
your process definition.
TIBCO ActiveMatrix BusinessWorks Palette Reference
224
| Chapter 6
HTTP Palette
Field
Global
Var?
Description
Default
Encoding
Yes
Specifies the encoding to use if no charset is
specified in the Content-Type header of the
message. This encoding is used for the message
body and URL.
However, when URIEncoding is specified in the
HTTP Connection shared resource, the Default
Encoding parameter specified here applies to the
contentType alone and not to the URIEncoding
property.
Upgrade
Configuration
No
This field is available only when projects created
in BusinessWorks 5.2.x or earlier versions are
migrated to a higher version.
Selecting the checkbox upgrades the schema in
the input/output tab for the activity. You can
revert back to the old schema by clearing the
checkbox.
However, if you create new processes in the
older projects, the activities will always show
the new schema in their input/output tabs. In
this case, it is not possible to revert to the old
schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Receiver 225
|
Advanced
The Advanced tab contains the following fields:
Field
Global
Var?
Write to File
No
Description
Checking this field specifies to write incoming
requests that exceed the specified threshold size to
a file instead of storing the request in memory. This
allows you to accept large incoming requests
without consuming a great deal of memory. When
this field is checked, the Directory and Threshold
Size fields appear.
Note: This option is not intended to be used with
the Parse Post Method Data option on the
Configuration tab. When Write to File is specified,
the PostData output element becomes a choice
element containing either the output FileName or
the PostData depending upon whether the data
exceeds the size specified in the Threshold Size
field. It is recommended to use either the Write to
File option or the Parse Post Method data option,
but not both at the same time.
Leaving this field unchecked specifies to keep
incoming requests in memory.
Note: Once written, the files created by using this
option are not deleted automatically. You must
manage the storage used by these files and delete
them when they are no longer used.
Directory
Yes
Create Non-Existing Directories
Threshold
Size (bytes)
Yes
The maximum size (in bytes) of an incoming
request that can be kept in memory. Requests larger
than the specified size are written to a file in the
specified directory. The file’s name is output so that
subsequent activities in the process definition can
access the file and read its contents.
Specifying zero (0) in this field causes all incoming
requests to be saved to a file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
226
| Chapter 6
HTTP Palette
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Special Characters in HTTP Requests
Depending upon the content type of the data for the request, the request can
contain URL-encoded data and the server is expected to decode the data. For
example, an incoming request may have the following message body:
name=John%20Smith&address=500%201%2F2%20Main%20Street
If the message body is not parsed (Parse Post Method Data is unchecked on the
Configuration tab), the body of the message remains URL-encoded in the
PostData output element. If the message body is parsed, the data is decoded
before being placed into the PostData output element, and that element would
appear as follows:
name=John Smith&address=500 1/2 Main Street
The order of the parameters may not be the same in the PostData output element
as the order in the original HTTP request sent by the client when the message
body is parsed.
Because the PostData output element can contain different data and be a different
length depending upon whether the message body is parsed, it is recommended
that you obtain data from the parameters output element when the message body
is parsed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Receiver 227
|
See http://www.rfc-editor.org/rfc/rfc1738.txt for more information about the
URL specification.
Output Headers
The Output 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 mechanism described in Appendix A, Specifying Data Schema, on
page 729 to specify the data structure for the headers. See that appendix 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.
Header
Datatype
Description
Accept
string
This field specifies media types that are
acceptable for response messages for the
incoming request. For example,
text/*,text/html. Media types are
described in the HTTP specification.
If no Accept header field is present, then it is
assumed that the client accepts all media
types.
Accept-Charset
string
This field specifies the character sets that are
acceptable for response messages for the
incoming request. For example,
iso-8859-5, unicode-1-1. Character sets
are described in the HTTP specification.
If no Accept-Charset header is present, then
it is assumed that the client accepts any
character set.
Accept-Encoding
string
This field specifies the content-coding values
that are acceptable for response messages.
For example, compress, gzip. See the HTTP
specification for more information about this
header field.
TIBCO ActiveMatrix BusinessWorks Palette Reference
228
| Chapter 6
HTTP Palette
Header
Datatype
Description
Content-Type
string
This field indicates the media type of the
entity body sent to the receiver. For example,
text/html; charset=ISO-8850-4. Media
types are described in the HTTP
specification.
Content-Length
string
This field indicates the size of the entity body
(in decimal number of OCTETs) sent to the
receiver.
This field takes into account the encoding of
the message body. See Special Characters in
HTTP Requests on page 226 for more
information on when the message body is
URL encoded.
Connection
string
This field allows the requestor to specify
options desired for this connection. For
example, the option close specifies that the
requestor would like the connection to be
closed when the request is complete.
Cookie
string
See the HTTP specification for more
information about this field.
If you want to receive more than one cookie,
set the Cardinality for this field to Repeating
(*).
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.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Method
string
The method specified in the request. For
example, GET or POST.
TIBCO ActiveMatrix BusinessWorks Palette Reference
HTTP Receiver 229
|
Output Item
Datatype
Description
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 or
BinaryContent
or FileName
string
The message body of the HTTP request. The
content of this element depends upon whether
the message body is parsed. Parsing behavior
is controlled by the Parse Post Method Data
field on the Configuration tab.
See Special Characters in HTTP Requests on
page 226 for more information.
If the Write to File field is checked on the
Advanced tab, this field can also contain the
file name of the file containing the message, if
the incoming message exceeds the specified
threshold size.
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.
Protocol
string
Can be either HTTP or HTTPS depending
upon the protocol used by the request.
Port
string
Port number on which the request was
received. This is the port number configured in
the HTTP Connection resource.
mimeEnvelope
Element
complex
This element contains the message
attachments. This element contains a repeating
element named mimePart that contains each
mime attachment.
TIBCO ActiveMatrix BusinessWorks Palette Reference
230
| Chapter 6
HTTP Palette
Output Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for
each mimePart. Mime headers can contain the
following information:
•
content-disposition — To suggest a
filename for an attachment, use
"*;filename=<filename>" in this element.
Note: HTTP servers may alter or choose to
ignore the suggested name.
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See http://www.faqs.org/rfcs/rfc2045.html
for more information about MIME headers and
their syntax.
Note: When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is expected to be in either
the textContent input element or the file name
storing the attachment is expected to be in the
fileName input element. When the content
type is anything other than "text/*", the
attachment content is expected to be in either
the binaryContent input element or the file
name storing the attachment is expected to be
in the fileName input element.
binaryContent |
textContent |
fileName
choice
TIBCO ActiveMatrix BusinessWorks Palette Reference
This element contains the mime attachment.
The element can be one of the following:
•
binaryContent — content of the attachment
when the attachment is binary data.
•
textContent — content of the attachment
when the attachment is text data.
•
fileName — the file name of the attachment
when the attachment is stored in the file
system.
HTTP Receiver 231
|
Output Item
Datatype
Description
Headers
complex
The fields of the header specified on the
Output Headers tab. See the description of the
Output Headers tab for more information
about these items.
parameters
complex
Parameters for the incoming request. These
parameters are configured in the Parameters
field on the Configuration tab.
When the Parse Post Method Data field on the
Configuration tab is checked, the parameters
include the parameters in the query string and
message body of the incoming HTTP request.
When the Parse Post Method Data field is
unchecked, the parameters only include the
query string of the incoming request.
Context
complex
Contains information about the client’s
environment. See the description of the
following elements contained in the Context
element for more information.
RemoteAddress
String
The IP address of the client that submitted the
HTTP request.
Context
complex
This element holds the optional
SecurityContext element and the
RemoteAddress and RemoteHost elements
described below.
SecurityContext
complex
This output element is only available when the
Expose Security Context field is checked on the
Configuration tab. This element contains
information about the requestor’s
authentication or certificate information,
depending upon the security scheme used. See
the description of the following elements
contained in the SecurityContext element for
more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
232
| Chapter 6
HTTP Palette
Output Item
Datatype
Description
Username
PasswordToken
complex
The username and password of the HTTP
client that made the request. The elements in
this element are populated only when the
client uses HTTP authentication.
CertificateToken
complex
This element contains the SSL certificate and
certain useful information taken from the
certificate, such as the CipherSuite, the
certificate issuer, and so on.
If the client has more than one certificate in a
certificate chain, all certificates are contained in
the repeating Certificate element.
RemoteAddress
String
IP address of the remote host that sent the
HTTP request.
RemoteHost
String
Host name of the remote host that sent the
HTTP request. This element is only available
when the Enable DNS Lookups field is
checked on the Advanced tab of the HTTP
Connection used by this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Proxy Configuration 233
|
Proxy Configuration
Shared Configuration
The Proxy Configuration resource is used to specify a proxy HTTP
server when HTTP requests are sent outside of a firewall.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Proxy Host
Yes
Host name or IP address of the proxy server.
Proxy Port
Yes
Port number of the proxy host.
Identity
No
This is an Identity resource that contains the
username and password for connecting to the proxy
server.
See TIBCO Designer Palette Reference for more
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
234
| Chapter 6
HTTP Palette
Send HTTP Request
Activity
The Send HTTP Request activity sends a HTTP request to a web
server.
This activity can send a request to a server that complies with
either the HTTP 1.0 or 1.1 specification. You do not need to specify
the HTTP version of the server you are sending the request to. TIBCO
ActiveMatrix BusinessWorks automatically sends the request using the correct
version based on the version supported by the HTTP server.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
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.
Use Proxy Setting
Specifies to use a proxy server to gain access outside
of a firewall. The Proxy Configuration shared
configuration resource specifies the configuration of
the proxy server. See Proxy Configuration on
page 233 for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 235
|
Field
Description
Accept Redirects
Checking this field indicates that the request should
be automatically redirected when the HTTP server
sends the redirection status code (302) in response to
this request and the remote host redirects the request
to the same host and port. If the remote host redirects
the request to a different host or a different port on the
same host, the request is not automatically redirected.
The maximum number of redirections is 100.
When this field is unchecked, the request is not
redirected.
Parameters
The parameters of the HTTP request. For each
parameter, you must provide a name, datatype (must
be type string), and whether the parameter is
required, optional, or repeating.
These parameters are specified in the parameters
element on the Input tab.
See Sending Data in the HTTP Request on page 236
for more information about this field.
HTTP Authentication
Specifies that the request must first supply a valid
username and password to authenticate with the
HTTP server.
Identity
This is an Identity resource that contains the client’s
username and password. This identity is used to
perform only basic authentication.
See TIBCO Designer Palette Reference for more
information.
SSL
When the Use SSL? checkbox is checked, this specifies
to use the HTTPS (secure socket layer, or 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.
The Configure SSL button becomes enabled when this
field is checked. See Configure SSL Button on
page 237 for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
236
| Chapter 6
HTTP Palette
Field
Description
Upgrade
Configuration
This field is visible only when projects created in
BusinessWorks 5.2.x or earlier versions are migrated
to a higher version.
Selecting the checkbox upgrades the schema in the
input/output tab for the activity. You can revert back
to the old schema by clearing the checkbox.
However, if you create new processes in the older
projects, the activities will always show the new
schema in their input/output tabs. In this case, it is
not possible to revert to the old schema.
Sending Data in the HTTP Request
There are several HTTP methods that can be used in an HTTP request. Each
method sends data in the request in a different manner. For example, the GET
method uses the query string of the request URI to pass parameter/value pairs.
Other methods use the HTTP message body to send data in the request.
The Send HTTP Request activity has three input elements for sending data in a
request:
•
PostData — corresponds to the body of the HTTP message. All methods
except the GET method accept data in this element.
•
QueryString — corresponds to the query string of the request URI. You can
use this input element to dynamically construct the query string using an
XPath expression when you do not know the names or number of input
parameters for the request until the activity executes.
•
Parameters — corresponds to parameters defined in the Parameters field on
the Configuration tab. This is useful if you have a fixed set of parameters that
you send with the request. For requests that use the GET method, these
parameters are passed as the query string of the request URI. For requests that
use the POST method, these parameters are usually sent as the body of the
HTTP message, but they can also be included in the query string.
For some methods, these input elements are mutually exclusive. For example, for
POST requests, you can specify parameters on the Configuration tab and in the
parameters input element or you can specify a PostData input element. However,
you should not specify both input elements. In the case of a POST request, the
PostData input element is ignored when parameters are specified on the
Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 237
|
For GET requests, you can specify parameters on the Configuration tab and in the
parameters input element or you can specify a QueryString input element.
Typically, if you know the list of parameters for the request, you should configure
the parameters on the Configuration tab. If the list of parameters is not known
until the activity executes, you should use the QueryString element. However,
when all parameters on the Configuration tab are specified as Optional, you can
use the QueryString input element instead of the parameters input element (but if
any elements in the parameters element contain an expression, the QueryString
element is ignored).
Special Characters in HTTP Requests
Depending upon the content type of the data for the request, the request can
contain URL-encoded data and the server is expected to decode the data. If this is
the case and you wish to send special characters such as +, /, or = in your HTTP
request, your data string must be URL-encoded if you send the data using the
PostData or QueryString input elements. If you send the data using the
parameters specified on the Configuration tab, encoding is done automatically.
For example, you wish to specify the following PostData:
name=John Smith&address=500 1/2 Main Street
Your PostData input element should result in the following string:
name=John%20Smith&address=500%201%2F2%20Main%20Street
See http://www.rfc-editor.org/rfc/rfc1738.txt for more information about the
URL specification.
Configure SSL Button
The Configure SSL button allows you to specify the SSL parameters for the HTTP
request. The following are the fields in the SSL Configuration for HTTPS Client
Requests dialog:
Field
Description
Trusted Certificates
Folder
Folder in the project containing one or more certificates
from trusted certificate authorities. This folder is
checked when a client connects to the HTTP server to
ensure that the server is trusted. This prevents
connections to rogue servers.
TIBCO ActiveMatrix BusinessWorks Palette Reference
238
| Chapter 6
HTTP Palette
Field
Description
Identity
This is an Identity resource that contains the client’s
digital certificate and private key.
See TIBCO Designer Palette Reference for more
information.
Verify Host Name
This field specifies to check the host name of the HTTP
server 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 Host 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 Host field, but the name
is not an exact match of the hostname in the host’s
digital certificate, the connection is refused.
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified with
the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 239
|
Advanced
The Advanced tab contains the following fields:
Field
Global
Var?
Write to File
No
Description
Checking this field specifies to write incoming
requests that exceed the specified threshold size to
a file instead of storing the request in memory. This
allows you to accept large incoming requests
without consuming a great deal of memory. When
this field is checked, the Directory and Threshold
Size fields appear.
Note: This option is not intended to be used with
the Parse Post Method Data option on the
Configuration tab. When Write to File is specified,
the PostData output element becomes a choice
element containing either the output FileName or
the PostData depending upon whether the data
exceeds the size specified in the Threshold Size
field. It is recommended to use either the Write to
File option or the Parse Post Method data option,
but not both at the same time.
Leaving this field unchecked specifies to keep
incoming requests in memory.
Note: Once written, the files created by using this
option are not deleted automatically. You must
manage the storage used by these files and delete
them when they are no longer used.
Directory
Yes
Create Non-Existing Directories
Threshold
Size (bytes)
Yes
The maximum size (in bytes) of an incoming
request that can be kept in memory. Requests larger
than the specified size are written to a file in the
specified directory. The file’s name is output so that
subsequent activities in the process definition can
access the file and read its contents.
Specifying zero (0) in this field causes all incoming
requests to be saved to a file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
240
| Chapter 6
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
same mechanism described Appendix A, Specifying Data Schema, on page 729 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.
Header
Datatype
Description
Accept (input
header)
string
This field specifies media types that are
acceptable for response messages for the
request. For example, text/*,text/html.
Media types are described in the HTTP
specification.
If no Accept header field is specified, then
the server assumes that all media types are
acceptable.
Accept-Charset
(input header)
string
This field specifies the character sets that are
acceptable for response messages for the
request. For example, iso-8859-5,
unicode-1-1. Character sets are described in
the HTTP specification.
If no Accept-Charset header is specified, then
the server assumes that any character set is
acceptable.
Accept-Encoding
(input header)
string
TIBCO ActiveMatrix BusinessWorks Palette Reference
This field specifies the content-coding values
that are acceptable for response messages.
For example, compress, gzip. See the HTTP
specification for more information about this
header field.
Send HTTP Request 241
|
Header
Datatype
Description
Content-Type
(input/output
header)
string
This field indicates the media type of the
entity body for the outgoing message and the
incoming response. Media types are
described in the HTTP specification. An
example of the media type is text/html;
charset=ISO-8850-4.
Content-Length
(output header)
string
This field indicates the size of the entity body
(in decimal number of OCTETs) of the
response message.
Content-Encoding
(output header)
string
This field is used as a modifier to the
content-type. When present, its value
indicates what additional content encodings
have been applied to the entity-body, and
thus what decoding mechanisms must be
applied in order to obtain the media-type
referenced by the Content-Type header field.
Content-Encoding is primarily used to allow
a document to be compressed without losing
the identity of its underlying media type. See
the HTTP specification for more information
about this field.
Date (output
header)
string
The date and time when the response
message was sent.
Server (output
header)
string
The server sending the original response
message.
Location (output
header)
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.
Connection
string
This field allows the requestor to specify
options desired for this connection. For
example, the option close specifies that the
requestor would like the connection to be
closed when the request is complete.
TIBCO ActiveMatrix BusinessWorks Palette Reference
242
| Chapter 6
HTTP Palette
Header
Datatype
Description
Set-Cookie
(output header)
string
See the HTTP specification for more
information about this field.
If you want to receive more than one cookie,
set the Cardinality for this field to Repeating
(*).
Cookie (input
header)
string
A name/value pair (also known as a cookie)
containing information that the HTTP server
may be expecting.
You can set the Cardinality field for this
element to Repeating (*) to specify more than
one cookie. You can also specify multiple
name/value pairs in a single non-repeating
element by separating each pair with a
comma (for example, "name1=value1,
name2=value2").
If you set the custom engine property
bw.plugin.http.protocol.single-cooki
e-header to true, multiple name/value pairs
are sent as a single header element. See
TIBCO ActiveMatrix BusinessWorks
Administration for more information about
custom engine properties.
Pragma
(input/output
header)
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.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 243
|
The input for the activity is the following.
Input Item
Datatype
Description
Host
string
The HTTP host you wish to connect to.
Specifying a value for this input item overrides
any value specified on the Configuration tab.
Port
integer
The port number that the HTTP server uses for
incoming requests. Specifying a value for this
input item overrides any value specified on the
Configuration tab.
Method
string
The HTTP method to use for the request. All
HTTP 1.1 methods are supported, but the
CONNECT method is unnecessary because
TIBCO ActiveMatrix BusinessWorks
automatically uses the correct method when
connecting by way of a proxy server.
If no method is specified in this element, the
GET method is used by default.
RequestURI
string
The address portion of the request. This is the
portion of the URI before the question mark (?).
PostData
string
The message body of the HTTP request. Do not
specify this element when the method of the
request is GET.
See Sending Data in the HTTP Request on
page 236 for more information about this input
element.
QueryString
string
The query string portion of the request. This is
the portion after the question mark (?).
See Sending Data in the HTTP Request on
page 236 for more information about this input
element.
Timeout
integer
The amount of time (in milliseconds) to wait for
a response from the HTTP server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
244
| Chapter 6
HTTP Palette
Input Item
Datatype
Description
Headers
complex
The header fields to send for the request. This
element 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
complex
Parameters for the incoming request. These
parameters are configured in the Parameters
field on the Configuration tab. This element is
only available when there are items specified in
the Parameters field.
See Sending Data in the HTTP Request on
page 236 for more information about this input
element.
mimeEnvelope
Element
complex
This element contains the message attachments.
This element contains a repeating element
named mimePart that contains each mime
attachment.
Note: Only HTTP POST messages can send
attachments.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 245
|
Input Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for each
mimePart. Mime headers can contain the
following information:
•
content-disposition — To suggest a filename
for an attachment, use
"*;filename=<filename>" in this element.
Note: HTTP servers may alter or choose to
ignore the suggested name.
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See http://www.faqs.org/rfcs/rfc2045.html for
more information about MIME headers and
their syntax.
Note: When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is expected to be in either
the textContent input element or the file name
storing the attachment is expected to be in the
fileName input element. When the content type
is anything other than "text/*", the attachment
content is expected to be in either the
binaryContent input element or the file name
storing the attachment is expected to be in the
fileName input element.
binaryContent
| textContent
| fileName
choice
This element contains the mime attachment. The
element can be one of the following:
•
binaryContent — content of the attachment
when the attachment is binary data.
•
textConetnt — content of the attachment
when the attachment is text data.
•
fileName — the file name of the attachment
when the attachment is stored in the file
system.
TIBCO ActiveMatrix BusinessWorks Palette Reference
246
| Chapter 6
HTTP Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
Header
string
The header of the HTTP request.
statusLine
complex
This field is the first line of the 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.
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
complex
The header fields of the reply. The
structure of this output item is specified
on the Output Headers tab.
mimeEnvelope
Element
complex
This element contains the message
attachments. This element contains a
repeating element named mimePart
that contains each mime attachment.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 247
|
Output Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header
for each mimePart. Mime headers can
contain the following information:
•
content-disposition — To suggest a
filename for an attachment, use
"*;filename=<filename>" in this
element. Note: HTTP servers may
alter or choose to ignore the
suggested name.
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See
http://www.faqs.org/rfcs/rfc2045.ht
ml for more information about MIME
headers and their syntax.
Note: When the content type is
specified as "text/*" (for example,
"text/xml"), the attachment content is
expected to be in either the textContent
input element or the file name storing
the attachment is expected to be in the
fileName input element. When the
content type is anything other than
"text/*", the attachment content is
expected to be in either the
binaryContent input element or the file
name storing the attachment is
expected to be in the fileName input
element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
248
| Chapter 6
HTTP Palette
Output Item
Datatype
Description
binaryContent |
textContent | fileName
choice
This element contains the mime
attachment. The element can be one of
the following:
•
binaryContent — content of the
attachment when the attachment is
binary data.
•
textConetnt — content of the
attachment when the attachment is
text data.
•
fileName — the file name of the
attachment when the attachment is
stored in the file system.
Persistent Connections
A Send HTTP Request activity requires a connection to an HTTP server. The
activity exclusively uses the connection until the HTTP server sends the response
message. If you have many process instances connecting to an HTTP server, each
Send HTTP Request opens a connection, holds the connection, and then closes the
connection once the activity completes. Opening and closing a large number of
connections can cause significant overhead for the HTTP server. Persistent
connections allow you to create a pool of connections that can be reused by Send
HTTP Request activities so that each activity does not need to open an close the
connection.
Persistent connections cannot be used with HTTPS connections. Each HTTPS
connection is opened and held until the activity completes execution.
Not all HTTP servers support the use of persistent connections. See the
documentation for the HTTP server you are connecting to determine if it supports
persistent connections.
Figure 10 illustrates the persistent connection pool. Persistent connections are
created for each HTTP server that Send HTTP Request activities in process
instances communicate with. Each process instance holds a persistent connection
until the HTTP server sends the response message. The connection is then
released by the process instance and returned to the pool.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 249
|
You can specify the maximum number of connections to create in the persistent
connection pool, and you can also specify the maximum number of persistent
connections for each HTTP server. Connections for each HTTP server are created
in the pool until the maximum is reached.
When a Send HTTP Request activity requires a connection, the pool is searched
for a connection that corresponds to the HTTP server. If a corresponding unused
connection is found, it is used. If the maximum number of connections for that
particular server have been reached, the request must wait for a connection to be
released before using it. If no connection is found to a corresponding HTTP
server, a new connection is created if the maximum pool size has not been
reached. If no corresponding connection is found and the maximum pool size has
been reached, the activity must wait for a connection to be freed before
proceeding.
Figure 10 Persistent HTTP connection pool
Persistent
Connection Pool
Connections
for HTTP
Server A
Process Instance
Process Instance
Process Instance
Process Instance
HTTP Server A
Connections
for HTTP
Server B
Process Instance
Process Instance
Process Instance
Process Instance
HTTP Server B
Persistent connections are managed by custom engine properties. See TIBCO
ActiveMatrix BusinessWorks Administration for more information about setting
custom engine properties. The following sections describe the engine properties
that control persistent connections.
TIBCO ActiveMatrix BusinessWorks Palette Reference
250
| Chapter 6
HTTP Palette
bw.plugin.http.client.usePersistentConnectionManager
This property specifies that a pool of HTTP connections to each HTTP server
should be created so that connections can be reused by Send HTTP Request
activities. Not all HTTP servers support persistent connections. Refer to your
HTTP server documentation for more information about support for persistent
connections.
When this property is set to true, a pool of connections is created for each HTTP
server that Send HTTP Request activities connect to. The total number of
connections in the pool is limited by the
bw.plugin.http.client.maxTotalConnections property. The number of
connections for each host is limited by the
bw.plugin.http.client.maxConnectionsPerHost property.
The default value of this property is false.
bw.plugin.http.client.maxConnectionsPerHost
The value of this property is ignored unless the
property is set to
true. This property specifies the maximum number of persistent connections to
each remote HTTP server.
bw.plugin.http.client.usePersistentConnectionManager
The default value for this property is 20.
bw.plugin.http.client.maxTotalConnections
The value of this property is ignored unless the
property is set to
true. This property specifies the maximum number of persistent connections to
create for all HTTP servers.
bw.plugin.http.client.usePersistentConnectionManager
The default value for this property is 200.
bw.plugin.http.client.checkForStaleConnections
The value of this property is ignored unless the
property is set to
true. When using persistent connections, a connection can become stale. When
this property is set to true, a persistent connection is checked to determine if it is
stale before it is used by a Send HTTP Request activity. Checking for stale
connections adds significant processing overhead, but it does improve reliability.
bw.plugin.http.client.usePersistentConnectionManager
The default value for this property is false.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Request 251
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
HttpClientException
The HTTP server replied with a message
that has the 4XX status code.
HttpServerException
The HTTP server replied with a message
that has the 5XX status code.
HttpCommunicationException
An HTTP exception occurred when
trying to execute the specified method, or
when trying to read the response.
ActivityTimedOutException
A timeout has been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
252
| Chapter 6
HTTP Palette
Send HTTP Response
Activity
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".
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
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.
Flush Response
Allows you to specify if the response is to be flushed
after each Send HTTP Response activity.
By default, this property is not checked.
This field is useful when there are a large number of
Send HTTP Response activities in a job. In such cases,
the Close Connection field is checked in the last
activity to indicate the response is complete.
However, checking the Flush Response field
overrides this behavior and causes the response to be
flushed after each Send HTTP Response activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Response 253
|
Field
Description
Close Connection
Specifies that this activity contains the last part of an
HTTP response. This field is used when you have
more than one Send HTTP Response activity in a
process definition, each activity sending a portion of
the response to the client. All Send HTTP Response
activities in a process definition should have this field
unchecked, except the last Send HTTP Response
activity. This field should be checked in the last Send
HTTP Response activity to indicate the response is
complete.
If the entire response is sent by only one Send HTTP
Response activity in the process definition, this field
should be checked.
Input Headers
The Input 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 729 to specify the data structure for the headers. See that appendix 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.
Header
Datatype
Description
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
254
| Chapter 6
HTTP Palette
Header
Datatype
Description
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 is 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.
Set-Cookie
string
See the HTTP specification for more
information about this field.
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.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
binaryContent
binary
The binary content of the response to the
request.
asciiContent
string
The ASCII content of the response to the
request.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send HTTP Response 255
|
Input Item
Datatype
Description
Headers
complex
The fields of the header specified on the Input
Headers tab. See the description of the Input
Headers tab for more information about these
items.
Note: Only the first Send HTTP Response
activity in a process definition can set the
Headers element. If your process definition
contains multiple Send HTTP Response
activities, the headers are set by the first activity
and this element is ignored for all subsequent
activities.
mimeEnvelope
Element
complex
This element contains the message attachments.
This element contains a repeating element
named mimePart that contains each mime
attachment.
TIBCO ActiveMatrix BusinessWorks Palette Reference
256
| Chapter 6
HTTP Palette
Input Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for each
mimePart. Mime headers can contain the
following information:
•
content-disposition — To suggest a filename
for an attachment, use
"*;filename=<filename>" in this element.
Note: HTTP servers may alter or choose to
ignore the suggested name.
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See http://www.faqs.org/rfcs/rfc2045.html for
more information about MIME headers and
their syntax.
Note: When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is expected to be in either
the textContent input element or the file name
storing the attachment is expected to be in the
fileName input element. When the content type
is anything other than "text/*", the attachment
content is expected to be in either the
binaryContent input element or the file name
storing the attachment is expected to be in the
fileName input element.
binaryContent
| textContent |
fileName
choice
TIBCO ActiveMatrix BusinessWorks Palette Reference
This element contains the mime attachment.
The element can be one of the following:
•
binaryContent — content of the attachment
when the attachment is binary data.
•
textContent — content of the attachment
when the attachment is text data.
•
fileName — the file name of the attachment
when the attachment is stored in the file
system.
Send HTTP Response 257
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
HttpCommunicationException
An HTTP exception occurred when
trying to send the response.
TIBCO ActiveMatrix BusinessWorks Palette Reference
258
| Chapter 6
HTTP Palette
Wait for HTTP Request
Activity
Waits for an incoming HTTP request in a process definition. The
process instance suspends until the incoming HTTP request is
received.
See Scalability With Incoming Events on page 226 in TIBCO
ActiveMatrix BusinessWorks Process Design Guide for information on
running the "Wait for..." activities in a multi-engine mode.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
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 214 for more information
about specifying shared resources.
Parse Post
Method Data
Specifies that the message body of the HTTP request
should be parsed into a schema for the activity’s output.
When this checkbox is checked, the parameters specified
in the Parameters field are used to validate the incoming
request and parse it into the output schema.
Note: In the case of an incoming GET request, there is no
message body, so this field has no effect on incoming GET
requests.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for HTTP Request 259
|
Field
Description
Parameters
The parameters of the incoming HTTP request. Specifying
parameters in this table allows the incoming request to be
parsed and represented as a schema in this activity’s
output. For each parameter, you must provide a name,
datatype, and whether the field is required, optional, or
repeating.
Use the + and x buttons to the right of the parameter table
to add and remove parameters. Use the up and down
arrows to move parameters to new positions in the table.
Note: Specifying parameters in this field parses the query
string of the request into the output schema, regardless of
whether the Parse Post Method Data field is checked.
Checking the Parse Post Method Data field and specifying
parameters here is required to parse the message body
along with the query string of the request.
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 in the domain using TIBCO
Administrator.
TIBCO ActiveMatrix BusinessWorks Palette Reference
260
| Chapter 6
HTTP Palette
Event
The Event tab has the following fields.
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 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.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO ActiveMatrix
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 waits if it is received before
this activity is executed. If the event timeout expires,
an error is logged and the event is discarded.
If no value is specified in this field, the message
waits indefinitely. If zero is specified, the event is
discarded immediately, unless this activity has
already been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for HTTP Request 261
|
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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 HTTP Request activity proceeds.
Output Headers
The Output 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 729 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.
Header
Datatype
Description
Accept
string
This field specifies media types that are
acceptable for response messages for the
incoming request. For example,
text/*,text/html. Media types are
described in the HTTP specification.
If no Accept header field is present, then it is
assumed that the client accepts all media
types.
Accept-Charset
string
This field specifies the character sets that are
acceptable for response messages for the
incoming request. For example,
iso-8859-5, unicode-1-1. Character sets
are described in the HTTP specification.
If no Accept-Charset header is present, then
it is assumed that the client accepts any
character set.
TIBCO ActiveMatrix BusinessWorks Palette Reference
262
| Chapter 6
HTTP Palette
Header
Datatype
Description
Accept-Encoding
string
This field specifies the content-coding values
that are acceptable for response messages.
For example, compress, gzip. See the
HTTP specification for more information
about this header field.
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 is 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.
This field takes into account the encoding of
the message body, see Special Characters in
HTTP Requests on page 226 for more
information on when the message body is
URL encoded.
Connection
string
This field allows the requestor to specify
options desired for this connection. For
example, the option close specifies that the
requestor would like the connection to be
closed when the request is complete.
Cookie
string
See the HTTP specification for more
information about this field.
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.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for HTTP Request 263
|
The input for the activity is the following.
Input Item
Datatype
Description
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 260 for an example
of using the Candidate Event Key
field with the key input item.
processTimeout
integer
The time (in milliseconds) to wait
for the incoming message. An error
is returned if the message is not
received in this time limit.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Method
string
The HTTP method to use for the request. All
HTTP 1.1 methods are supported.
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 or
BinaryContent
string
The message body of the HTTP request. The
content of this element depends upon whether
the message body is parsed. Parsing behavior is
controlled by the Parse Post Method Data field
on the Configuration tab).
See Special Characters in HTTP Requests on
page 226 for more information.
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
264
| Chapter 6
HTTP Palette
Output Item
Datatype
Description
Protocol
string
Can be either HTTP or HTTPS depending upon
the protocol used by the request.
Port
string
Port number on which the request was
received. This is the port number configured in
the HTTP Connection resource.
mimeEnvelope
Element
complex
This element contains the message
attachments. This element contains a repeating
element named mimePart that contains each
mime attachment.
mimeHeaders
complex
This element contains the mime header for
each mimePart. Mime headers can contain the
following information:
•
content-disposition — To suggest a
filename for an attachment, use
"*;filename=<filename>" in this element.
Note: HTTP servers may alter or choose to
ignore the suggested name.
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See http://www.faqs.org/rfcs/rfc2045.html
for more information about MIME headers and
their syntax.
Note: When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is expected to be in either
the textContent input element or the file name
storing the attachment is expected to be in the
fileName input element. When the content type
is anything other than "text/*", the attachment
content is expected to be in either the
binaryContent input element or the file name
storing the attachment is expected to be in the
fileName input element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for HTTP Request 265
|
Output Item
Datatype
Description
binaryContent
| textContent |
fileName
choice
This element contains the mime attachment.
The element can be one of the following:
•
binaryContent — content of the attachment
when the attachment is binary data.
•
textConetnt — content of the attachment
when the attachment is text data.
•
fileName — the file name of the attachment
when the attachment is stored in the file
system.
Headers
complex
The fields of the header specified on the
Headers tab. See the description of the Headers
tab for more information about these items.
parameters
complex
Parameters for the incoming request. These
parameters are configured in the Parameters
field on the Configuration tab.
When the Parse Post Method Data field on the
Configuration tab is checked, the parameters
include the parameters in the query string and
message body of the incoming HTTP request.
When the Parse Post Method Data field is
unchecked, the parameters only include the
query string of the incoming request.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ActivityTimedOutException
A timeout has been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
266
| Chapter 6
HTTP Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 267
Chapter 7
Java Palette
The Java palette has activities and shared configuration resources for executing
Java code as well as converting between Java objects and XML documents.
Topics
•
Show Class Browser, page 268
•
Common Features of Java Code and Java Method, page 270
•
Java Code, page 272
•
Java Custom Function, page 279
•
Java Event Source, page 284
•
Java Global Instance, page 292
•
Java Method, page 295
•
Java Schema, page 303
•
Java To XML, page 305
•
XML To Java, page 309
TIBCO ActiveMatrix BusinessWorks Palette Reference
268
| Chapter 7
Java Palette
Show Class Browser
Button
The Choose a Class or Choose a Class and Method dialog appears when you click
the Show Class Browser button. This dialog allows you to pick a Java class (and
method of that class for the Java Method activity) from a list of archives available
in the TIBCO ActiveMatrix BusinessWorks classpath. The Show Class Browser
button is used in the following resources:
•
EJB Home
•
Java Method
•
Java Schema
•
Java To XML
•
XML To Java
Figure 11 illustrates selecting a class in the Choose a Class dialog. First you select
the archive, then you select the class. Packages that contain classes are displayed
as folders and the contained classes are nested below the package folder.
Figure 11 Selecting a class with the Choose a Class dialog
The Java Method and EJB Home activities allow you to select a class and a
method in that class to execute. The Show Class Browser button brings up the
Choose a Class and Method dialog. Figure 12 illustrates this dialog.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Show Class Browser 269
|
Figure 12 Selecting a method in a class from the Choose a Class and Method dialog
TIBCO ActiveMatrix BusinessWorks Palette Reference
270
| Chapter 7
Java Palette
Common Features of Java Code and Java Method
The Java Code and Java Method activities both execute Java. Therefore, there are
some features that both activities share. This section describes some of the
common features between the two activities.
Accessing TIBCO ActiveMatrix BusinessWorks Global Variables and Java
System Properties
You can use the com.tibco.pe.plugin.PluginProperties.getProperty()
method to retrieve any Java system property or global variables defined in your
project.
Global variables are contained in Java System properties that are prefixed with
tibco.clientVar. For example, if you define a global variable named myVar, you
can access the value of the global variable with the following Java code:
String var1 =
com.tibco.pe.plugin.PluginProperties.getProperty(
"tibco.clientVar.myVar");
You must specify the full path for global variables contained in variable groups to
access the variable’s value. Use the slash character (/) to separate each element in
the path. For example, if you have a global variable named item1 contained in a
group named myGroup, you can access the value of the global variable with the
following Java code:
String var1 =
com.tibco.pe.plugin.PluginProperties.getProperty(
"tibco.clientVar.myGroup/item1");
Any Java System property can also be accessed with the
PluginsProperties.getProperty() method. Supply a string containing the
property name as the input parameter to the method to obtain the property’s
value.
The com.tibco.pe.plugin.PluginProperties class is contained in the
lib/engine.jar file within the TIBCO ActiveMatrix BusinessWorks installation
directory. This directory is in the TIBCO ActiveMatrix BusinessWorks classpath,
and therefore Java Code activities can compile code referencing this class. If you
compile your code outside of TIBCO ActiveMatrix BusinessWorks, you must
ensure your development environment has access to theengine.jar file.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Common Features of Java Code and Java Method 271
|
Sending Messages to The TIBCO ActiveMatrix BusinessWorks log4j File
The standard log4j logging service is available for components of TIBCO
ActiveMatrix BusinessWorks. See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about using the BusinessWorks log4j
properties file.
Code in the Java Code or Java Method activities can send messages to the log4j
file by using the bw.logger class. For example, the following code obtains the
bw.logger class and uses the class to send a message to the log file.
org.apache.log4j.Logger logger =
org.apache.log4j.Logger.getLogger("bw.logger");
logger.warn("This is a warning message from the either a
Java Code or Java Method activity");
If you use your own logger class, you can configure the BusinessWorks log4j
properties file to include your logger. This involves adding log4j.logger and
log4j.appender properties to the properties file. See the log4j documentation for
more information about log4j properties. Once the properties for your custom
logger class are added to the BusinessWorks log4j file, you can obtain your logger
class and write messages to the log file in your Java Code and Java Method
activities.
TIBCO ActiveMatrix BusinessWorks Palette Reference
272
| Chapter 7
Java Palette
Java Code
Activity
You can add custom code to your process definition with the Java Code
activity. This activity allows you to write standard Java code that can
manipulate any of the process data or perform any action you choose.
The Java Code activity automatically creates an invoke() method in which you
place the code you wish to execute. This method is called when the engine
processes the Java Code activity.
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 the get/set
methods in your Java code, and you can display the code for the get/set methods
when you select the Full Class radio button on the Code tab.
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 provided.
See Common Features of Java Code and Java Method on page 270 for more
information about features available in the Java Code activity.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in the
process definition.
Description
No
Short description of the activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
Java Code 273
|
Field
Global
Var?
Description
Input
Parameters
No
The input parameters for the Java Code activity.
These parameters appear on the Input tab after they
are specified. Each input parameter has three fields:
Output
Parameters
No
•
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 276 for more information about
passing Java objects between Java Code activities.
•
Occurrence — Whether the parameter is required,
optional, or repeating.
The output parameters for the Java Code activity.
These parameters 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 passing a Java object
to another Java Code activity as output. See
Passing Java Objects Between Java Code
Activities on page 276 for more information about
passing Java objects between Java Code activities.
•
Occurrence — Whether the parameter is required,
optional, or repeating.
Code
You can choose to display the full Java class or display only the invoke() method
body of the class. Choose the appropriate option at the top of the Code tab for the
code you wish to display.
TIBCO ActiveMatrix BusinessWorks Palette Reference
274
| Chapter 7
Java Palette
The code tab has the following fields/buttons.
Field/Button
Description
Java Code
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
choose the Full Class option above the code window.
When the Java code is run by the engine, the
automatically generated get/set methods are called,
then the invoke() method in the Java class is called.
Compile Button
Compiles the current source code. When the code in the
activity needs compilation (for example, the input or
output parameters change or the code changes), a yellow
warning icon appears on this button.
The code will either compile successfully or the View
Errors dialog will appear to display any errors in the
code.
After compilation, the source and compiled java code
are placed into the lib/palettes/javaCode directory
in the TIBCO ActiveMatrix BusinessWorks installation
directory.
View Errors Button
Displays the errors encountered when the code was
compiled.
Edit Class 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.
Use Edit>Preferences>Other to specify the Java editor
you wish to use to edit source code.
Note: On MS Windows platforms, a temporary file is
created to hold the Java code when you edit your code
with this button. This file is located in either C:\temp or
C:\tmp or your working directory. If your working
directory contains a space (for example C:\Documents
and Settings\...), there may be problems opening the
temporary file. Make certain either the C:\temp or
C:\tmp directory exists to avoid this issue.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Code 275
|
Compiling Java Code
You can compile each Java Code activity individually with the Compile button on
the Code tab, or you can compile all Java Code activities in your project at once
with the Tools > Java Code > Compile All Code menu item.
When you use the Compile All Code menu item, the Compile All Code dialog
appears. Figure 13 illustrates this dialog.
Figure 13 Compile All Code dialog
All process definitions containing Java Code activities that do not compile
successfully are listed in the Activities area. Each Java Code activity is listed
under the process definition in which it is located. You can select any Java Code
activity in the Activities area to display the compilation errors for that activity.
The dialog has the following buttons:
•
Start/Cancel Compile — Click Start Compile to begin compiling all Java Code
activities in your project. When the code is compiling, this button is renamed
Cancel Compile to allow you to cancel the compile all operation.
•
Go To Resource —You can select any process definition or Java Code activity,
then click the Go To Resource button to display that resource in the design and
configuration panels.
•
Close — Closes the Compile All Code dialog.
TIBCO ActiveMatrix BusinessWorks Palette Reference
276
| Chapter 7
Java Palette
Passing Java Objects Between Java Code Activities
You may create instances of Java objects in your Java code or by using the Java
Method or XML To Java activities. You can pass these Java objects using an output
parameter to another 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 Java object to the input object of the receiving Java Code
object.
Any Java objects passed by input and output parameters between activities must
be serializable.
Figure 14 illustrates two Java code activities. The CreateObject activity creates a
Java object and passes a reference to the object in the 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.
Figure 14 Passing objects between Java Code activities
The UseObject 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 getInteger() that
returns an integer, you would use the following code in the UseObject activity:
MyClass myObject = (MyClass) in_object;
int var = 0;
if (myObject != null) {
var = myObject.getInteger();
}
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Code 277
|
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
parameters
varies
The Input tab lists all input parameters specified
on the Configuration tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
parameters
varies
The Output tab lists all output parameters
specified on the Configuration tab.
Error Output
The Error Output tab lists the exceptions that can be thrown by the Java Code
activity. Because the activity can return any Java exception, all potential
exceptions cannot be listed here. However, the error schema for all errors is the
same. The following describes the schema for exceptions returned by the Java
Code activity.
Error Schema Element
Datatype
Description
msg
string
The TIBCO ActiveMatrix
BusinessWorks error message. See
TIBCO ActiveMatrix BusinessWorks
Error Codes for more information.
msgCode
string
The TIBCO ActiveMatrix
BusinessWorks error code. See TIBCO
ActiveMatrix BusinessWorks Error
Codes for more information.
methodName
string
The name of the Java method that
raised the exception.
TIBCO ActiveMatrix BusinessWorks Palette Reference
278
| Chapter 7
Java Palette
Error Schema Element
Datatype
Description
exceptionClassName
string
The Java exception class name. The
value of this element is obtained by
calling the
<exception>.getClass().getName()
method.
exceptionMessage
TIBCO ActiveMatrix BusinessWorks Palette Reference
string
The Java exception message. The
value of this element is obtained by
calling the <exception>.getMessage()
method.
Java Custom Function 279
|
Java Custom Function
Shared Configuration
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 project using this resource.
When the class is loaded using this resource, TIBCO ActiveMatrix 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 3.
•
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 in a class or any imported classes in 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 in the classpath configured for TIBCO ActiveMatrix 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.
TIBCO ActiveMatrix BusinessWorks provides detailed online help for each XPath
function. To provide online help for Java Custom Functions, create a
two-dimensional array named HELP_STRINGS in your class. The element
containing a string matching the function name is used as the help for that
function. See Example Java Function on page 282 for an example of creating the
HELP_STRINGS array.
TIBCO ActiveMatrix BusinessWorks Palette Reference
280
| Chapter 7
Java Palette
Table 3 Datatypes allows for Java custom functions
Type of Data
Datatypes Allowed for Input Parameters and Return
Types
Strings and
Characters
String
char
Boolean
Boolean
boolean
Numbers
int
Integer
float
Float
double
Double
short
Short
long
Long
Static variables are not supported in 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.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about building XPath expressions and using the XPath editor.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the shared resource.
The method signature plus the description supplied in this
field appear as the documentation of the function in the
XPath editor. You can use simple HTML markup to format
the text of this field, if you desire.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Custom Function 281
|
Field
Description
Suggested Prefix
A folder with the name you specify in this field appears in
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.
Use this name as a prefix for 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
Suggested Prefix field when you load class1 into a Java
Custom Resource. You would specify class2 in the
Suggested 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 Location
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.
Class Data
The size of the class in bytes. Use the Load button after a
class is selected in the Class Location field to load the class
and determine its size.
TIBCO ActiveMatrix BusinessWorks Palette Reference
282
| Chapter 7
Java Palette
Example Java Function
The following Java code implements custom Java functions. The example
illustrates which methods of the class meet the restrictions and are therefore
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 ActiveMatrix 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();
}
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Custom Function 283
|
/**
* 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;
}
/**
* The following is a two-dimensional array that provides the
* online help for functions in this class. Declare an array
* named HELP_STRINGS.
*/
public static final String[][] HELP_STRINGS ={
{"stringConcat", "Joins two strings.",
"Example", "stringConcat(\"test/testDict\",
$input/key)"},
{"intAdd", "Adds two integers.",
"Example", "intAdd(5, $input/myInt)"},
}
TIBCO ActiveMatrix BusinessWorks Palette Reference
284
| Chapter 7
Java Palette
Java Event Source
Process Starter
The Java Event Source allows you to create a custom process
starter written in Java. For example, you may wish to start a
TIBCO ActiveMatrix BusinessWorks process when an application
inserts a row into a database table. Your custom process starter
would observe the database for insert events, then call the onEvent() method
with the desired data as input when an insert occurs. The Java Event Source
process starter creates a process when the onEvent() method is invoked and the
object passed to the method is passed to the process definition.
This process starter uses an abstract class to define the interface. You can either
write and compile your custom Java code in your own code editor and upload the
class to TIBCO ActiveMatrix BusinessWorks, or you can use the Code tab to add
your implementation code to the appropriate methods. See JavaProcessStarter
Abstract Class on page 285 for more information about the methods required by
this class.
If you wish to use the Edit Class button on the Code tab, select
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 provided.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in the
process definition.
Description
No
Short description of the activity.
Use
External
Class
No
When this field is checked, the Code tab is disabled,
and you must load the class using the Class Library
and Class fields. When this field is unchecked, you
must add your code to the appropriate methods on
the Code tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
Java Event Source 285
|
Field
Global
Var?
Description
Java
No
This field contains the Class Library, Class, and Init
Method fields that allow you to specify which class
and method to use.
Class
Library
No
Use this field to specify an AliasLibrary resource that
is used to locate the Java class files. See TIBCO
Designer Palette Reference for more information about
AliasLibrary resources.
Class
No
The compiled Java class that implements the
JavaProcessStarter abstract class. Use the Show Class
Browser button to select the class from the specified
Class Library.
Init Method
No
The init() method for the class. This field is
automatically populated when you use the Show
Class Browser button. See JavaProcessStarter
Abstract Class on page 285 for more information
about the init() method.
You can use the drop down list to select a different
method in the selected Java class, if desired.
Note: You can hover the cursor over this field to
display the signature of the selected method.
Init Method
Parameters
No
This table allows you to specify default values for the
input parameters of the init() method. Each input
parameter has three fields:
•
Parameter Name — Name of the parameter.
•
Parameter Type — Datatype of the parameter.
•
Parameter Value — Specify a default value for the
parameter.
JavaProcessStarter Abstract Class
The JavaProcessStarter abstract class defines the interface of your Java Process
Starter with the TIBCO ActiveMatrix BusinessWorks process engine. You must
define an implementation for the following methods:
•
init() — this method is called when the process engine starts up. This
method should initialize any resource connections. You could also specify a
TIBCO ActiveMatrix BusinessWorks Palette Reference
286
| Chapter 7
Java Palette
Java Global Instance on the Advanced tab that initializes resource
connections. Java Global Instances are also loaded and initalized during
process engine start up. You can call this.getJavaGlobalInstance() to
obtain the Java Global Instance resource in your process starter code.
•
onStart() — this method is called by the process engine to activate the
process starter. This method should activate any event notifier or resource
observer code. The notifier or observer code can then call the onEvent()
method to start a process instance.
•
onStop() — this method is called by the process engine to deactivate the
process starter. This method should deactivate any event notifier or resource
observer code.
•
onShutdown() — this method is called by the process engine when the engine
shuts down. This method should release any resources and resource
connections and perform any required clean up operations.
The following methods are already implemented and can be used in your code:
•
onEvent(Object object) — this method is called when a listener or
resource observer catches a new event. The input to this method is a Java
object containing the event data.
•
getGlobalInstance()
•
onError() — this method throws the exception specified in the input
parameter. Use this method to propagate an error to the TIBCO ActiveMatrix
BusinessWorks process instance when a listener or resource observer fails to
generate an event.
— this method returns an object reference to the Java
Global Resource specified on the Advanced tab of the process starter. This is
useful if you wish to place initialization code or other shared information in a
Java Global Resource instead of in the init() method of this class.
Code
This tab is only enabled if the Use External Class field is unchecked. This tab
allows you to add implementation code to the appropriate methods of the
JavaProcessStarter class. You can choose to display the full Java class or display a
particular method by selecting the appropriate value in the Show field at the top
right of the Code tab.
The code tab has the following fields/buttons.
Field/Button
Description
Source Code
The source code of the JavaProcessStarter
implementation class.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Event Source 287
|
Field/Button
Description
Show
Displays the selected method or the entire class. The
following are valid options to select:
Compile Button
•
init
•
onStart
•
onStop
•
onShutdown
•
Entire Class
Compiles the current source code. When the code in the
activity needs compilation (for example, the code
changes), a yellow warning icon appears on this button.
The code will either compile successfully or the View
Errors dialog will appear to display any errors in the
code.
After compilation, the source and compiled java code
are placed into the lib/palettes/javaCode directory
in the TIBCO ActiveMatrix BusinessWorks installation
directory.
View Errors Button
Displays the errors encountered when the code was
compiled.
Edit Class 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.
Use Edit>Preferences>Other to specify the Java editor
you wish to use to edit source code.
Note: On MS Windows platforms, a temporary file is
created to hold the Java code when you edit your code
with this button. This file is located in either C:\temp or
C:\tmp or your working directory. If your working
directory contains a space (for example C:\Documents
and Settings\...), there may be problems opening the
temporary file. Make certain either the C:\temp or
C:\tmp directory exists to avoid this issue.
TIBCO ActiveMatrix BusinessWorks Palette Reference
288
| Chapter 7
Java Palette
Compiling Java Code
You can compile each Java Code activity and Java Process Starter resource
individually with the Compile button on the Code tab, or you can compile all Java
Code and Java Process Starter resources in your project at once with the Tools >
Java Code > Compile All Code menu item.
When you use the Compile All Code menu item, the Compile All Code dialog
appears. Figure 13 illustrates this dialog.
Figure 15 Compile All Code dialog
All process definitions containing Java Code activities and Java Process Staters
that do not compile successfully are listed in the Activities area. Each Java Code
activity or Java Process Starter is listed under the process definition in which it is
located. You can select any Java Code activity or Java Process Starter in the
Activities area to display the compilation errors for that activity.
The dialog has the following buttons:
•
Start/Cancel Compile — Click Start Compile to begin compiling all Java Code
activities and Java Process Starters in your project. When the code is
compiling, this button is renamed Cancel Compile to allow you to cancel the
compile all operation.
•
Go To Resource —You can select any process definition, Java Process Starter,
or Java Code activity, then click the Go To Resource button to display that
resource in the design and configuration panels.
•
Close — Closes the Compile All Code dialog.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Event Source 289
|
Advanced
The Advanced tab has the following fields:.
Field
Java Global
Instance
Global
Var?
No
Description
A Java Global Instance resource. Specify a value
in this field if you wish to reference a Java Global
Instance resource in your JavaProcessStarter
implementation class. You can use the
getGlobalInstance() method to obtain a reference
to the Java Global Instance resource.
See Java Global Instance on page 292 for more
information about Java Global Instance
resources.
Convert Output
Object To XML
No
When this field is unchecked, the object passed to
the onEvent() method is output by this process
starter as a Java object reference. You can use the
Java To XML activity to render the Java object as
an XML tree, if desired.
Check this field if you wish the data of the input
object to the onEvent() method to be converted
to an XML tree in this process starter’s output.
For the output to be returned as an XML tree, the
output object type must be specified. To achieve
this, you must add the getOutputObjectType()
class to your implemenntation class. For
example, the output can be a string:
public Class getOutputObjectType() {
return String.class;
}
Then, the object you pass into the input
parameter of the onEvent() method must be a
String.
TIBCO ActiveMatrix BusinessWorks Palette Reference
290
| Chapter 7
Java Palette
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
javaObject or
varies
The Java object that was passed to the
method. By default, this element is a
Java object reference. If the Convert Output
Object to XML field is checked on the Advanced
tab and the output class is specified in your
implementation class, the output is represented
as an XML tree.
Object
TIBCO ActiveMatrix BusinessWorks Palette Reference
onEvent()
Java Event Source 291
|
Error Output
The Error Output tab lists the exceptions that can be thrown by the Java Event
Source resource. Because the resource can return any Java exception, all potential
exceptions cannot be listed here. However, the error schema for all errors is the
same. The following describes the schema for exceptions returned by the Java
Event Source resource.
Error Schema Element
Datatype
Description
msg
string
The TIBCO ActiveMatrix
BusinessWorks error message. See
TIBCO ActiveMatrix BusinessWorks
Error Codes for more information.
msgCode
string
The TIBCO ActiveMatrix
BusinessWorks error code. See TIBCO
ActiveMatrix BusinessWorks Error
Codes for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
292
| Chapter 7
Java Palette
Java Global Instance
Shared Configuration
The Java Global Instance shared configuration resource allows you to
specify a Java object that can be shared across all process instances in a
Java Virtual Machine (JVM). When the process engine is started, an
instance of the specified Java class is constructed. When the process
engine is shut down, if specified, a cleanup method is invoked on the
object and the object is released before the engine shuts down. Any Java Method
activity can be configured to access the shared Java Global Instance when the
process engine runs. Any Java Code activity can access the shared Java Global
Instance by invoking the static methods of the configured Java class.
If multiple process instances access the shared Java Global Instance, you may
wish to ensure that only one process instance can access the object at a time. You
can accomplish this by either declaring the methods of the configured class as
synchronous or by using a critical section group. See TIBCO ActiveMatrix
BusinessWorks Process Design Guide for more information about using critical
section groups.
Java class files or archives referenced by this resource must be available to the
Java VM in which TIBCO Designer and the TIBCO ActiveMatrix BusinessWorks
process engine are running. This is done either by adding the correct path to the
classpath in the designer.tra and bwengine.tra files (see the comments in the
.tra files for more information about modifying the classpath) or by using an
Alias Library resource. If you add the path to the classpath, the system class
loader loads the class into the Java VM. If you use an Alias Library resource, the
TIBCO ActiveMatrix BusinessWorks application class loader loads the class into
the Java VM. If both techniques are used, the class loaded by the system class
loader takes precedence.
Objects created from classes loaded by different class loaders are not able to
interact. For example, an Alias Library resource points to the location of Java
ClassA and a Java Method activity references ClassA. Java class ClassB is placed
in the classpath and referenced by a Java Code activity. The Java Method activity
can pass the ClassA object to the Java Code activity, but the ClassB object in the
Java Code activity may not be able to interact with the ClassA object. If you wish
objects to interact correctly, ensure that the activities use the same class loader.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Global Instance 293
|
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the shared
configuration resource.
Description
No
Short description of the resource.
Java
No
This field contains the Library, Class, and
Method fields that specify the Java object to
create.
Library
No
Use this field to specify an AliasLibrary
resource that is used to locate the Java class
files. See TIBCO Designer Palette Reference for
more information about AliasLibrary
resources.
Class
No
Use the Show Class Browser button to locate
the class you wish to use.
Method
No
Select a constructor from the drop down list of
constructors available for this class. This will
be used to construct the class when the engine
is started.
Description
This field displays only the default constructor
(that is, the constructor with no parameters) or
constructors that have only parameters of Java
primitive types. You cannot create an object
using a constructor that requires an object,
array, or non-primitive type for a parameter.
TIBCO ActiveMatrix BusinessWorks Palette Reference
294
| Chapter 7
Java Palette
Field
Global
Var?
Description
Parameters Input
No
The input parameters for the constructor
selected in the Method field. Each input
parameter has three fields:
•
Parameter — Name of the parameter.
•
Type — Datatype of the parameter.
•
Value — Supply a value for the parameter
in this field. Note: When string is the
datatype for the parameter, do not use
quotes around the string when entering the
value.
Advanced
The Advanced tab has the following fields:.
Field
Global
Var?
Description
Invoke Cleanup
Method
No
When checked, this specifies that you wish to
invoke a method on the object before the object is
released from memory when the process engine
terminates. This allows you to perform cleanup
activities, such as closing connections, releasing
resources, and so on.
When this field is checked, the Cleanup Method
field appears.
Cleanup Method
No
This field is only available when the Invoke
Cleanup Method field is checked.
This field allows you to specify the name of the
method to invoke before the object in memory is
released. The method selected cannot contain
any parameters, therefore only methods without
parameters are listed in this field. Any values
returned by the selected method are ignored, but
exceptions raised by the selected method are sent
to the log.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Method 295
|
Java Method
Activity
The Java Method activity allows you to invoke a method contained in
a Java class. You can construct an instance of the specified Java class, if
you choose to invoke the constructor for the class.
The Java class file must be located in the classpath for TIBCO Designer and the
TIBCO ActiveMatrix BusinessWorks process engine. Update the designer.tra
and bwengine.tra file to contain the directory where your Java class files are
located.
See Common Features of Java Code and Java Method on page 270 for more
information about features available in the Java Code activity.
Configuration
The Configuration tab has the following fields:
Field
Global
Var?
Name
No
The name to appear as the label for the activity in the
process definition.
Description
No
Short description of the activity.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
296
| Chapter 7
Java Palette
Field
Global
Var?
Description
Java Global
Instance
No
You can execute methods on shared Java objects
created by Java Global Instance resources by specifying
the resource in this field. See Java Global Instance on
page 292 for more information about the shared Java
objects created by Java Global Instance resources.
When a resource is specified in this field, the Library
and the Class fields are automatically populated with
the correct values from the Java Global Instance
resource, and the fields on the Advanced tab become
unavailable. You can select the method to execute in
the drop down list in the Method field.
Note: If the configuration of the Java Global Instance
resource changes, you must select and view any Java
Method activities in your process definitions that
reference the Java Global Instance to automatically
propagate the changes. An exception is raised if you
attempt to test your process definitions before
refreshing the reference to the Java Global Instance.
You may need to manually update the mappings of
any input or output if you select a new method with a
different signature in the Java Global Instance resource.
Java
No
This field contains the Library, Class, and Method
fields that allow you to specify which class and method
to execute.
Library
No
Use this field to specify an AliasLibrary resource that is
used to locate the Java class files. See TIBCO Designer
Palette Reference for more information about
AliasLibrary resources.
Class
No
The declared Java class whose method you wish to
execute. Use the Show Class Browser button to select
the class and method, or use the Java Global Instance
field to specify a shared Java object.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Method 297
|
Field
Global
Var?
Description
Method
No
The method in the selected Java class you wish to
execute. This field is automatically populated when
you use the Show Class Browser button.
You can use the drop down list to select a different
method in the selected Java class, if desired.
Note: You can hover the cursor over this field to
display the signature of the selected method.
Advanced
The Advanced tab has the following fields:.
Field
Global
Var?
Description
Construct
Declared Class
No
This field controls whether the declaring class
must be constructed when the activity is
executed or whether an object reference must be
supplied in the activity’s input schema.
When this field is checked, the declaring class is
constructed using the default constructor when
the activity executes. In this case, the declaring
class is not included in the activity’s input
schema.
When this field is unchecked, you must supply
an object reference for the Java class specified on
the Configuration tab. The object must be created
and contained in the output schema of a
previously executed activity, such as a Java Code
activity, another Java Method activity, a RMI
Server process starter, or an XML To Java activity.
In this case, the declaring class is included in the
activity’s input schema.
This field is not available when a static method is
selected.
TIBCO ActiveMatrix BusinessWorks Palette Reference
298
| Chapter 7
Java Palette
Field
Global
Var?
Description
Cache
Constructed
Class
No
This field is only available when the Construct
Declared Class is checked.
When checked, this specifies that all instances of
this Java Method activity will share the instance
of the constructed declaring class. If the
constructed object is cached, it is kept in memory
until the process engine terminates.
If this field is unchecked, each instance of this
Java Method activity creates its own copy of the
declaring class.
See Caching the Java Class on page 299 for more
information about caching the declared class.
Invoke Cleanup
Method
No
This field is only available when the Cache
Constructed Class field is checked.
When checked, this specifies that you wish to
invoke a method on the cached object before the
object is released from memory when the process
engine terminates. This allows you to perform
cleanup activities, such as closing connections,
updating database tables, and so on.
When this field is checked, the Cleanup Method
field appears.
Cleanup Method
No
This field is only available when the Invoke
Cleanup Method field is checked.
This field allows you to specify the name of the
method to invoke before the cached class in
memory is released. The selected method cannot
contain any parameters, therefore only methods
with no parameters are listed in this field. Any
values returned by the selected method are
ignored, but any exceptions raised are sent to the
log.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Method 299
|
Caching the Java Class
When the Cache Constructed Class checkbox is checked on the Advanced tab, all
instances of the same Java method activity share the same Java object. For
example, each process instance that executes this Java Method activity will share
the same instance of the class.
Also, if this activity is executed multiple times in a loop, each execution of this
activity uses the same cached instance of the object. Figure 16 illustrates multiple
processes and Java Methods in a group all sharing the same Java class.
If you choose to cache the constructed instance of the class, the same Java object is
shared by Java Method activities that invoke methods on the class. Therefore, be
aware of potential concurrency issues, if your class or its methods are not
threadsafe.
Figure 16 Sharing a cached class
payroll Object
However, different instances of a Java Method activity that invoke methods on
the same class do not share the instance of the object. For example, Figure 17
illustrates two Java Method activities in the same process definition, each
executing different methods on the same Java object. However, each of these Java
Method activities operate on their own instances of the inv class, if they both
select the Cache Constructed Class checkbox.
TIBCO ActiveMatrix BusinessWorks Palette Reference
300
| Chapter 7
Java Palette
Figure 17 Different Java Method activities in the same process do not share the class
inv Object
inv Object
In the process definition illustrated in Figure 17, for each process instance that is
created, each time the inv.CheckInventory activity executes, it shares one
instance of the inv object that has been cached. Similarly, each time the
inv.DecreaseInv activity executes, it shares the instance of the inv object that
the activity has cached. However, the inv.CheckInventory and
inv.DecreaseInv activities do not share their cached Java objects with each
other.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
<declaringClass>
Java
Object
An object reference to the Java
Class specified on the
Configuration tab. This element is
not shown when the method you
wish to invoke it static.
Also, this element is only available
when the Construct Declared Class
field on the Advanced tab is
unchecked.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java Method 301
|
Input Item
Datatype
Description
MethodParameters
varies
This element contains a list of input
parameters that are required for the
Java method selected on the
Configuration tab.
This element is not available when
the selected method has no
parameters.
Output
The output for the activity is the following.
Output Item
Datatype
Description
MethodReturnValue
varies
The Output tab will have the return
value specified for the Java method
selected on the Configuration tab.
This element is not available for
methods that return void.
Error Output
The Error Output tab lists the exceptions that can be thrown by the invoked
method. Once a method to invoke is selected, the exceptions that the method can
throw are listed on the Error Output tab. Because a method can return any Java
exception, the potential exceptions cannot be listed here.
While all potential errors cannot be known, the error schema for all errors is the
same. The following describes the schema for exceptions returned by the Java
Method activity.
Error Schema Element
Datatype
Description
<exceptionName>
complex
The fully-qualified name of the
exception, including the Java package
name. This is a container for the other
elements.
<exceptionName>
Java
Object
The Java exception object.
TIBCO ActiveMatrix BusinessWorks Palette Reference
302
| Chapter 7
Java Palette
Error Schema Element
Datatype
Description
exceptionClassName
string
The exception class name. The value of
this element is obtained by calling the
<exception>.getClass().getName()
method.
exceptionMessage
TIBCO ActiveMatrix BusinessWorks Palette Reference
string
The exception message. The value of
this element is obtained by calling the
<exception>.getMessage() method.
Java Schema 303
|
Java Schema
Shared Configuration
The Java Schema shared configuration resource allows you to specify
a Java class that is used to configure a Java To XML or XML To Java
activity.
The Java class is converted to an XML schema using the following rules:
•
Only the public data members of the Java class are mapped to XML elements.
Private and protected members are not included.
•
The Java class member public variable name is mapped to an XML element
with the same name. For example, a Java class member variable declared as
public int ZipCode is mapped to an XML element named ZipCode.
•
Java Bean accessors and modifiers are mapped to appropriate XML element
names. For example, a Java class method public int getBalance() or
public void setBalance(int Balance) are mapped to an XML element
named Balance.
•
Only one XML element is created regardless of how many members of the
Java class share the same name. For example, there may be an attribute named
MySalary and accessors named getMySalary() and setMySalary(). This
translates to one element named MySalary in the resulting XML document.
•
Conversion is case-sensitive. For example, if you have a data member
declared as public int zipCode and an accessor method declared public
void setZipCode(int NewZipCode), there will be two elements in the
resulting XML schema, zipCode (for the data member) and ZipCode (for the
accessor). You must make sure to use the correct element when using the
resulting XML in input mappings of subsequent activities.
•
All Java primitive types are supported. Datatypes that extend
java.util.Collections are also supported (for example, List, ArrayList,
andVectors). Arrays (for example, int[] and string[]) are also supported.
•
The datatype java.util.Map or any types that extend java.util.Map are
not supported. For example, HashMap is not supported.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
304
| Chapter 7
Java Palette
Field
Description
Description
Short description of the shared resource.
Java
This field contains the Library and Class fields that
allow you to specify the Java class for this resource.
Library
Use this field to specify an AliasLibrary resource
that is used to locate the Java class files. See TIBCO
Designer Palette Reference for more information
about AliasLibrary resources.
Class
The Java class that specifies the data of the schema.
This class must implement or be a subtype of a
class that implements the Serializable interface.
You can use the Show Class Browser button to
browse Java classes in the TIBCO ActiveMatrix
BusinessWorks classpath.
Schema Namespace
The namespace to use for the schema when
converting to or from XML.
Schema Text
The Schema Text tab displays the resulting XML schema from the Java class
selected on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java To XML 305
|
Java To XML
Activity
The Java To XML activity allows you to convert a Java object’s data
members into an XML document. See Java Schema on page 303 for the
conversion rules.
If the class does not have a public data member and only has a Java bean modifier
that sets the data, the input schema contains an element for the modifier, but the
resulting XML document has no value set for the corresponding element.
For example, the Java object has a method declared as public int setID(), but
there is no method for getting the ID and the data member ID is not public. In this
case, there will be an element named ID in this activity’s output schema, but that
element has no value because there is no public mechanism for getting the data.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the activity.
Use Java Schema
No
Specifies whether you wish to use a Java Schema
shared configuration resource to configure this
activity or whether you wish to specify a Java
class file.
When unchecked the Java Class field appears.
When checked, the Java Schema: and Class:
fields appear.
Java Schema:
No
Only available when the Use Java Schema field is
checked. This field specifies a Java Schema
shared configuration resource. This resource is
used to specify the schema used to convert the
Java object to the XML schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
306
| Chapter 7
Java Palette
Field
Global
Var?
Description
Java Class:
No
When Use Java Schema is checked, this is the
class in the Java Schema to use.
Use the Show Class Browser button to bring up
the dialog to choose the Java class.
Advanced
The Advanced tab has the following fields:.
Field
Global
Var?
Description
Construct
Declared Class
No
This field controls whether the declaring class
must be constructed when the activity is
executed or whether an object reference must be
supplied in the activity’s input schema.
When this field is checked, the declaring class is
constructed using the default constructor when
the activity executes. In this case, the declaring
class is not included in the activity’s input
schema.
When this field is unchecked, you must supply
an object reference for the Java Class specified on
the Configuration tab. The object must be created
and contained in the output schema of a
previously executed activity, such as a Java Code
activity, Java Method, or an XML To Java activity.
In this case, the declaring class is included in the
activity’s input schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Java To XML 307
|
Field
Global
Var?
Description
Cache
Constructed
Class
No
This field is only available when Construct
Declared Class is checked.
When checked, this specifies that all instances of
this Java To XML activity share the instance of
the constructed declaring class. If the constructed
object is cached, it is kept in memory until the
process engine terminates.
If this field is unchecked, each instance of this
Java To XML activity creates its own copy of the
declaring class.
See Caching the Java Class on page 299 for more
information about caching the declared class.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
<declaringClass>
Java
Object
An object reference to the Java
Class specified on the
Configuration tab. This element is
only available when the Construct
Declared Class field on the
Advanced tab is unchecked.
Output
The output for the activity is the following.
Output Item
Datatype
Description
XML Schema
varies
The XML schema from the
converted Java object is output.
The elements appear in the schema
in alphabetical order.
TIBCO ActiveMatrix BusinessWorks Palette Reference
308
| Chapter 7
Java Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JavaToXMLConversionException
An error occurred when converting the
Java object to XML.
TIBCO ActiveMatrix BusinessWorks Palette Reference
XML To Java 309
|
XML To Java
Activity
The XML to Java activity allows you to create an instance of a Java
object based on data from an XML document. The XML schema for
providing input to the Java object is created from the Java object or
Java Schema specified on the Configuration tab of this activity. The
specified Java class must meet the following requirements:
•
The Java class must have a public default constructor (that is, a constructor
with no arguments).
•
The Java class must be serializable (that is, the class must implement or be a
subclass of a class that implements java.io.Serializable).
See Java Schema on page 303 for a description of the conversion rules.
If the class does not have a public data member and only has a Java bean accessor
that retrieves the data, the input schema contains an element for the accessor, but
the resulting Java object has no value set for the member.
For example, the object has a method declared as public int getID(), but there
is no method for setting the ID and the data member ID is not public. In this case,
there is an element named ID in this activity’s input schema, but mapping a value
to the element does not result in setting the ID member of the output Java object
because there is no public mechanism for setting the data.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the activity.
Use Java Schema
No
Specifies whether you wish to use a Java
Schema shared configuration resource to
configure this activity or whether you wish to
specify a Java class file.
When unchecked the Java Class field appears.
When checked, the Java Schema: and Class:
fields appear.
TIBCO ActiveMatrix BusinessWorks Palette Reference
310
| Chapter 7
Java Palette
Field
Global
Var?
Description
Java Schema:
No
Only available when the Use Java Schema field
is checked. This field specifies a Java Schema
shared configuration resource. This resource is
used to specify the schema used to convert the
XML schema to the Java object.
Java Class:
No
When Use Java Schema is checked, this is the
class in the Java Schema to use.
Use the Show Class Browser button to bring up
the dialog to choose the Java class.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
XML Schema
varies
The XML schema that you wish to convert to a
Java object. The content of this schema
depends upon the Java class or Java Schema
defined on the Configuration tab.
The elements appear in the schema in
alphabetical order.
Output
The output for the activity is the following.
Output Item
Datatype
Description
<declaringClass>
Java
Object
A Java object that is created out of
the XML schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
XML To Java 311
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
XMLToJavaConversionException
An error occurred when converting the
XML schema to a Java object.
TIBCO ActiveMatrix BusinessWorks Palette Reference
312
| Chapter 7
Java Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 313
Chapter 8
JDBC Palette
The JDBC palette contains activities and shared configuration resources for
querying, updating, or calling stored procedures in a database.
Topics
•
JDBC Call Procedure, page 314
•
JDBC Connection, page 321
•
JDBC Get Connection, page 328
•
JDBC Query, page 333
•
JDBC Update, page 343
•
Query Designer, page 350
•
SQL Direct, page 355
TIBCO ActiveMatrix BusinessWorks Palette Reference
314
| Chapter 8
JDBC Palette
JDBC Call Procedure
Activity
The JDBC Call Procedure activity calls a database procedure using the
specified JDBC connection.
If this activity is not part of a transaction group, the SQL statement is
committed after the activity completes. If this activity is part of a
transaction group, the SQL statement is committed or rolled back with the other
JDBC activities in the group at the end of the transaction. See TIBCO ActiveMatrix
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 in a transaction group, you can check the Override Transaction
Behavior field on the Advanced tab. This specifies that the activity is outside of
the transaction and the SQL statement is committed when the activity completes,
even if the activity is in 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
ActiveMatrix BusinessWorks.
When using the jConn or Data Direct 3.3 driver and connecting to a Sybase
database, stored procedures that are supposed to return multiple result sets do
not return any data. To avoid this problem, you can either use the
sun.jdbc.odbc.JdbcOdbcDriver instead or you can add set nocount on to
your stored procedure definition.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
JDBC
Connection
Yes
Path to the shared configuration resource
containing the JDBC connection information.
See JDBC Connection on page 321 for more
information about JDBC resources.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
JDBC Call Procedure 315
|
Field
Global
Var?
Description
Schema
Yes
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.
The Select Schema button allows you to choose
a schema from the database using the specified
JDBC Connection.
Catalog/Package
Yes
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 and package. See
your database documentation for more
information about catalogs and packages.
The Select Catalog/Package button allows you
to choose a catalog or package from the
database using the specified JDBC Connection.
If a schema is specified in the Schema field, only
catalogs or packages in the specified schema are
listed.
Procedure/
Function Name
Yes
Name of the database procedure or
user-defined function to call. You can use the
Select Procedure/Function button to query the
database for available procedures or functions
once the JDBC Connection field is specified.
The list of available procedures and functions
will be limited by the values supplied in the
Schema and Catalog/Package fields.
Note: The input parameters and output
parameters are displayed when you use the
Select Procedure/Function button. TIBCO
Designer retrieves the signature of each stored
procedure/function from the database once. If
you change the signature while editing your
project, you must click the Refresh button to
retrieve the changes from the database.
TIBCO ActiveMatrix BusinessWorks Palette Reference
316
| Chapter 8
JDBC Palette
Field
Global
Var?
Description
Timeout (sec)
Yes
Time to wait for the procedure call to complete.
If the call does not complete in the given time
limit, an error is returned.
Maximum Rows
Yes
The maximum number of rows to retrieve. To
retrieve all rows, specify 0.
Parameter Types
No
This field displays the parameters for the
procedure and allows you to override the
parameter type (IN, OUT, INOUT) for each
parameter.
Advanced
The Advanced tab has the following fields.
Field
Override
Transaction
Behavior
Global
Var?
Yes
Description
Overrides the default behavior of a transaction
group. If this activity is in a transaction group,
the activity is normally committed or rolled
back with the other transactional activities.
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.
Interpret Empty
String as Null
No
Specifies how empty strings in the activity’s
input elements should be handled. When the
field is checked, nulls are sent to the database
where empty strings are supplied. When the
field is unchecked, empty strings are treated as
zero-length strings. Whether you use this field
or not, you can still use XPath to set input
elements explicitly to null.
Note: Many databases treat empty strings and
nulls as the same, so this field will not affect
how the database interprets empty strings.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Call Procedure 317
|
Field
Global
Var?
Description
Resultsets Use
Schema
No
Specifies that the design-time must try to fetch
the schema when a resultset is expected from a
stored procedure call.
When selected, designer tries to invoke the
stored procedure with default values and get
the metadata for the resultset.
If the checkbox is not selected, or if designer
does not get any metadata, the results will be
displayed as ’unknown resultsets’.
Input
The input for this activity is dependent upon the input parameters of the database
procedure.
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database server.
See Time Zone Construction on page 361 for
more information about how time zones are
constructed using this field.
You can use the Constants tab in the XPath
Formula Builder to supply a valid time zone
name. The list of time zone names is
generated from
java.util.TimeZone.getAvailableIDs().
See Time Zone Names on page 362 for the list
of valid time zone names.
inputSet
complex
The input parameters of the database
procedure. The datatype contained in this
element varies depending upon the
parameters specified for the database
procedure.
timeout
number
Time (in seconds) to wait for the procedure
call to complete. If the call does not complete
in the given time limit, an error is returned.
TIBCO ActiveMatrix BusinessWorks Palette Reference
318
| Chapter 8
JDBC Palette
Input Item
Datatype
Description
maxRows
number
The maximum number of rows to retrieve. To
retrieve all rows, specify 0.
Output
The output for the activity is dependent upon the output parameters of the
database procedure.
Output Item
Datatype
Description
outputSet
complex
The output of the database procedure.
The datatype contained in this element
varies depending upon what the
database procedure returns.
unknownResultSets
complex
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 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 TIBCO ActiveMatrix BusinessWorks
Release Notes for a more detailed
description of this procedure.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Call Procedure 319
|
Output Item
Datatype
Description
Elapsed Time
long
This field displays the time taken for the
execution of the activity in milliseconds.
This is an optional element that appears
only when the property
java.property.bw.activity.output.
stats.elapsedTime.JDBCCallActivit
is set to true in designer.tra. For
run-time, set the property to true in the
bwengine.tra file. By default, the
property is set to false.
y
If set in the design-time, this property
must be carried forward to the run-time;
else it can cause run-time errors.
Enabling this property causes additional
performance overhead. Hence, it is
recommended that you use this property
only when this information is to be
consumed by some other ActiveMatrix
BusinessWorks activity. Also, it is
recommended that this property be used
only in a non-production environment as
a diagnostic tool and the property be
turned off at run-time.
You can turn off the property and not
calculate the elapsed time at run-time by
setting the property
java.property.bw.activity.output.
in the
file. However, note that
setting this property will turn off the
calculation of elapsed time at run-time
for all the JDBC activities.
stats.elapsedTime.turnoff
bwengine.tra
TIBCO ActiveMatrix BusinessWorks Palette Reference
320
| Chapter 8
JDBC Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JDBCDriverLoadingException
An error occurred when loading the
specified JDBC driver.
JDBCConnectionNotFoundException
An error occurred when attempting to
connect to the specified database.
InvalidTimeZoneException
An invalid timezone was specified.
See Time Zone Names on page 362 for
a list of valid timezones.
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
LoginTimedOutException
A timeout has occurred while
attempting to connect to the database.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Connection 321
|
JDBC Connection
Shared Configuration
The JDBC Connection resource describes a JDBC connection. JDBC
connections are used when specifying activities from the JDBC
palette.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Connection
Type
No
Specifies the kind of JDBC connection you wish to
create. The connection type can be one of the
following:
•
JDBC
•
JNDI
•
XA
The type of connection determines the other
configuration fields that appear.
JDBC Connection Type Configuration Fields
JDBC Driver
Yes
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.
See Database Drivers on page 325 for more
information about database drivers.
TIBCO ActiveMatrix BusinessWorks Palette Reference
322
| Chapter 8
JDBC Palette
Field
Global
Var?
Description
Database URL
Yes
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 in angle brackets (<>). For example,
if you select the
tibcosoftwareinc.jdbc.oracle.OracleDrive
r, 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.
Maximum
Connections
No
The maximum number of database connections to
allocate. The default maximum is 10. The
minimum value that can be specified is 1.
See Connection Pooling on page 326 for more
information about this field.
User Name
Yes
User name to use when connecting to the
database.
Password
Yes
Password to use when connecting to the database.
Login Timeout
Yes
Time (in seconds) to wait for a successful database
connection. Only JDBC drivers that support
connection timeouts can use this configuration
field. If the JDBC driver does not support
connection timeouts, the value of this field is
ignored. Most JDBC drivers support connection
timeouts.
You can also set this timeout with the
Config.JDBC.Connection.SetLoginTimeout
custom engine property. The value of the property
in the configuration file overrides the value of this
field. See TIBCO ActiveMatrix BusinessWorks
Administration for more information about setting
custom engine properties.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Connection 323
|
Field
Global
Var?
Description
JNDI Connection Type Configuration Fields
Use Shared
JNDI
Configuration
No
When this field is checked, the JNDI
Configuration field appears, allowing you to
choose a JNDI Configuration shared configuration
resource.
When this field is unchecked, the JNDI Context
Factory, JNDI Context URL, JNDI User Name, and
JNDI Password fields appear.
JNDI
Configuration
No
This field only appears when the Use Shared JNDI
Configuration field is checked. This field allows
you to choose a JNDI Configuration shared
configuration object that specifies the JNDI
connection information.
JNDI Context
Factory
No
This field only appears when the Use Shared JNDI
Configuration field is unchecked. The initial
context factory class for accessing JNDI.
(javax.naming.Context.INITIAL_CONTEXT_
FACTORY). You can choose from the drop down list
of supported classes, or you can type in a different
InitialContextFactory class name.
When using IBM WebSphere, you should use the
JNDI Configuration resource instead of specifying
the JNDI configuration on this resource. See IBM
WebSphere and JNDI Context Caching on
page 177 for more information.
Note: TIBCO ActiveMatrix 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
324
| Chapter 8
JDBC Palette
Field
Global
Var?
Description
JNDI Context
URL
Yes
This field only appears when the Use Shared JNDI
Configuration field is unchecked. This is the URL
to the JNDI service provider
(javax.naming.Context.PROVIDER_URL). An
example URL is provided when one of the
supported JNDI context factory classes is selected.
See your JNDI provider documentation for the
syntax of the URL.
JNDI User
Name
Yes
This field only appears when the Use Shared JNDI
Configuration field is unchecked. Specify the user
name to use when logging into the JNDI server
(javax.naming.Context.SECURITY_
PRINCIPAL). If the JNDI provider does not require
access control, this field can be empty.
JNDI
Password
Yes
This field only appears when the Use Shared JNDI
Configuration field is unchecked. Specify the
password for logging into the JNDI server
(javax.naming.Context.SECURITY_
CREDENTIALS). If the JNDI provider does not
require access control, this field can be empty.
JNDI
DataSource
Name
Yes
The JNDI name specified for the DataSource.
XA Connection Type Configuration Fields
XA
DataSource
Class
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
The XA DataSource class.
Note: TIBCO ActiveMatrix BusinessWorks
attempts to find the class. However, you may need
to add the location of the class to the CLASSPATH
environment variable.
JDBC Connection 325
|
Field
Global
Var?
Description
Database URL
Yes
The URL to use to connect to the database. A
template of the URL is supplied for the selected
XA DataSource class. You must supply the
portions of the URL that are in angle brackets (<>).
For example, if you select the
tibcosoftwareinc.jdbcx.oracle.OracleData
Source, the following appears in the Database
URL field:
jdbc:tibcosoftwareinc:oracle://<host>:
<port#>;SID=<db_instancename>
You must supply the host, port number, and
database instance name in the URL.
Maximum
Connections
Yes
The maximum number of database connections to
allocate. The default maximum is 10. The
minimum value that can be specified is 1.
See Connection Pooling on page 326 for more
information about this field.
User Name
Yes
User name to use when connecting to the
database.
Password
Yes
Password to use when connecting to the database.
Database Drivers
The following drivers are included in the TIBCO ActiveMatrix BusinessWorks
installation:
•
tibcosoftwareinc.jdbc.oracle.OracleDriver
•
tibcosoftwareinc.jdbc.oracle.OracleDriver (RAC)
•
tibcosoftwareinc.jdbc.sqlserver.SQLServerDriver
•
tibcosoftwareinc.jdbc.sybase.SybaseDriver
•
tibcosoftwareinc.jdbc.db2.DB2Driver
The following drivers are supported, but you must obtain, install, and configure
these from the appropriate vendor:
•
oracle.JDBC.driver.OracleDriver (oci)
•
oracle.JDBC.driver.OracleDriver (thin)
•
com.sybase.jdbc2.jdbc.SybDriver
•
com.timesten.jdbc.TimesTenDriver
TIBCO ActiveMatrix BusinessWorks Palette Reference
326
| Chapter 8
JDBC Palette
•
com.ibm.db2.jcc.DB2Driver
•
com.mysql.jdbc.Driver
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
You can download, install, and use other JDBC drivers, but TIBCO does not
guarantee the drivers will function properly with TIBCO ActiveMatrix
BusinessWorks. To use an unsupported driver, perform the following:
1. Download the JDBC driver and copy the required JAR files to a location in the
classpath of the TIBCO ActiveMatrix BusinessWorks Engine. For example,
you can copy the files to the following location:
TIBCO_HOME/tpcl/<version>/jdbc.
2. In the JDBC Connection resource, choose Select Driver from the drop-down
list in the JDBC Driver field and type in the name of the driver class in the text
box within that field. Then, type in the correct URL in the Database URL field
and specify the other fields in the resource.
See TIBCO ActiveMatrix BusinessWorks Release Notes for more information on the
supported and tested versions of databases and database drivers.
Connection Pooling
TIBCO ActiveMatrix BusinessWorks creates a pool of JDBC connections for every
JDBC Connection shared resource that uses the JDBC connection type. The
maximum size of this pool is specified by the Maximum Connections
configuration field.
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 time out 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 you wish to configure a timeout
value for these connections, you can set the Engine.DBConnection.idleTimeout
property. See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Connection 327
|
If an activity detects a connection in the pool is invalid (for example, the database
is restarted), the activity that uses the JDBC connection resource 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 in a transaction attempts to reestablish an
invalid connection. If a connection becomes invalid during a transaction, the
transaction is rolled back and must be retried, if necessary.
Test Connection Button
The Test Connection button allows you to test that the specified configuration
fields result in a valid connection to a database.
TIBCO ActiveMatrix BusinessWorks Palette Reference
328
| Chapter 8
JDBC Palette
JDBC Get Connection
Activity
The JDBC Get Connection activity retrieves an object reference to a
JavaConnectionAccessor object for the specified JDBC Connection from
the connection pool. This allows you to use the optimized TIBCO
ActiveMatrix BusinessWorks database connection pool instead of
specifying database configuration information in your Java code. This
database connection can then be used within Java activities to access the specified
database.
See Using The JDBC Connection in Java on page 331 for more information on
using the JDBC Get Connection activity.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
JDBC
Connection
Yes
Path to the shared configuration resource
containing the JDBC connection information.
See JDBC Connection on page 321 for more
information about JDBC resources.
Override
Transaction
Behavior
No
Overrides the default behavior of a transaction
group. If the activity that uses this JDBC
connection is in a transaction group, the activity
is normally committed or rolled back with the
other transactional activities.
Description
If this checkbox is checked, the database
connection is in auto commit mode, where each
operation is committed as it is performed. You
can disable the auto commit mode, if desired,
and your code is then responsible for
performing the commit or rollback operation
before releasing the connection.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Get Connection 329
|
Input
This activity has no input.
Output
The output for the activity is dependent upon the output parameters of the
database procedure.
Output Item
Datatype
Description
JavaConnectionAccesor
Java
Object
A Java object reference to a
JavaConnectionAccessor object. This
object can be passed as input to a Java
activity where custom Java code can
use the connection to perform database
operations.
TIBCO ActiveMatrix BusinessWorks Palette Reference
330
| Chapter 8
JDBC Palette
Output Item
Datatype
Description
Elapsed Time
long
This field displays the time taken for
the execution of the activity in
milliseconds.
This is an optional element that
appears only when the property
java.property.bw.activity.outpu
t.stats.elapsedTime.JDBCGetConn
is set to true in
For run-time, set the
property to true in the bwengine.tra
file. By default, the property is set to
false.
ectionActivity
designer.tra.
If set in the design-time, this property
must be carried forward to the
run-time; else it can cause run-time
errors.
Enabling this property causes
additional performance overhead.
Hence, it is recommended that you use
this property only when this
information is to be consumed by some
other ActiveMatrix BusinessWorks
activity. Also, it is recommended that
this property be used only in a
non-production environment as a
diagnostic tool and the property be
turned off at run-time.
You can turn off the property and not
calculate the elapsed time at run-time
by setting the property
java.property.bw.activity.outpu
in
the bwengine.tra file. However, note
that setting this property will turn off
the calculation of elapsed time at
run-time for all the JDBC activities.
t.stats.elapsedTime.turnoff
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Get Connection 331
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JDBCSQLException
A SQL error occurred.
LoginTimedOutException
A timeout has occurred while
attempting to connect to the database.
Using The JDBC Connection in Java
The database connection obtained with the JDBC Get Connection activity has the
following restrictions:
•
Checkpoints should not be taken after a JDBC Get Connection activity
completes.
•
Do not pass the JavaConnectionAccessor object reference to a subprocess that
spawns a new process.
The JDBC Get Connection activity creates a JavaConnectionAccessor object
reference that can be passed to an input parameter of a Java Code or Java Method
activity. See Passing Java Objects Between Java Code Activities on page 276 for
details on how to pass Java object references between activities.
JavaConnectionAccessor has the following methods:
•
java.sql.Connection getDBConnection();
— retrieves a database
connection from the connection pool.
•
void releaseConnection();
— releases a database connection so that it can
return to the connection pool.
•
boolean isTransactional(); — returns true if the activity using the JDBC
connection is in a transaction group and the Override Transaction Behavior on
the Configuration tab of the JDBC Get Connection activity is unchecked.
•
— releases the connection
obtained by way of the getDBConnection() method. Use this method instead
of the standard releaseConnection method because this method detects if
the SQL Exception passed as input is due to a connection problem. If the
connection is no longer usable, it is destroyed and it is not returned to the
connection pool.
void releaseConnection(SQLException ex)
TIBCO ActiveMatrix BusinessWorks Palette Reference
332
| Chapter 8
JDBC Palette
When the connection is part of a transaction, the JavaConnectionAccessor object
prevents you from committing or rolling back the transaction. The transaction
will complete when the transaction group either commits or rolls back. If the
connection is part of an XA transaction group, the enlist and delist operations are
performed by the getDBConnection and releaseConnection methods.
When the connection is not part of a transaction, the database connection is in
auto commit mode, where each operation is committed as it is performed. You
can disable the auto commit mode, if desired, and your code is then responsible
for performing the commit or rollback operation before releasing the connection.
If your Java code does not release the connection, the connection is automatically
released when the process instance terminates. This could have undesirable
consequences.
Your code should check for SQL Exceptions returned when executing JDBC
statements. If you encounter an unexpected SQL Exception, you can use the
releaseConnection(SQLException ex) method to release the connection. This
allows you to check if the connection is no longer valid. If the connection is no
longer valid, your Java code should return an appropriate exception for
subsequent activities so that transactions can be rolled back, if necessary.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Query 333
|
JDBC Query
Activity
The JDBC Query activity performs the specified SQL SELECT
statement.
If this activity is not part of a transaction group, the SQL statement is
committed after the activity completes. If this activity is part of a
transaction group, the SQL statement is committed or rolled back with the other
JDBC activities in the group at the end of the transaction. See TIBCO ActiveMatrix
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 in a transaction group, you can check the Override Transaction
Behavior field on the Advanced tab. This specifies that the activity is outside of
the transaction and the SQL statement is committed when the activity completes,
even if the activity is in a transaction group.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JDBC
Connection
Yes
Path to the shared configuration resource
containing the JDBC connection information. See
JDBC Connection on page 321 for more
information about JDBC resources.
SQL Statement
Yes
The SQL SELECT statement to perform in the
database. You can use a wizard to build the query
for the desired database. See Query Designer on
page 350 for more information about using the
Query Designer wizard.
Timeout (sec)
Yes
Time (in seconds) to wait for the query to
complete. If the query does not complete in the
given time limit, an error is returned.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
334
| Chapter 8
JDBC Palette
Field
Global
Var?
Description
Maximum
Rows
Yes
The maximum number of rows to retrieve. To
retrieve all rows, specify 0.
Prepared
Parameters
No
See Prepared Parameters on page 334 for a
description of this field.
Fetch Button
The Fetch button on this activity allows you to synchronize the activity with the
contents of the database.
When you first configure a JDBC activity, you must click the Fetch button to
retrieve the schema for the output result set before attempting to apply your
changes with the Apply button or by saving your project. If you do not click the
Fetch button before applying your changes, TIBCO ActiveMatrix BusinessWorks
displays an error dialog prompting you to first fetch the output schema.
After you have configured your activity, the Fetch button is useful when you
make a change to the database while editing a process definition containing this
activity in TIBCO ActiveMatrix BusinessWorks. The Fetch button synchronizes
with the database and changes the output schema, if necessary.
Prepared Parameters
If you wish to replace static names in the SQL 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 = ?
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Query 335
|
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.
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.
Keep in mind, ? is not valid SQL syntax, so checking the syntax of a query that
contains question marks will return an invalid character error in the Query
Designer wizard.
When you add or remove question marks in SQL statements, a warning appears
to the right of the Prepared Parameters field ("SQL/ Prepared Parameter Count
Mismatch") to alert you to add or remove corresponding prepared parameters.
Each prepared parameter corresponds to the question mark in the same position
in the SQL statement. That is, the first prepared parameter in the list corresponds
to the first question mark, the second prepared parameter in the list corresponds
to the second question mark, and so on. The warning is for informational
purposes only, you must make sure the parameters in this field correctly
correspond to the SQL statement.
You can optionally specify names for each prepared parameter. By default, the
prepared parameters are named Prepared_Param_1, Prepared_Param_2, and so
on.
You must supply the datatype of each parameter to the SQL statement, and this
datatype is used in the input schema for the statement. You can use the up or
down arrow keys to move a specified datatype to the previous or next parameter.
You can also select a contiguous set of parameters to move them up or down, or
delete them with the delete button.
At run time, any parameters you place in the SQL statement are replaced with the
mapped values for those parameters on the Input tab.
Any mappings or expressions you create on the Input tab are not updated when
you move or delete prepared parameters. You must manually update the Input
tab after changing the prepared parameter field.
TIBCO ActiveMatrix BusinessWorks Palette Reference
336
| Chapter 8
JDBC Palette
Advanced
The Advanced tab has the following fields.
Field
Override
Transaction
Behavior
Global
Var?
Yes
Description
Overrides the default behavior of a transaction
group. If this activity is in a transaction group, the
activity is normally committed or rolled back with
the other transactional activities.
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.
Use Nil
No
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 element is not included for that
row). If Use Nil is checked, the NAME element is not
optional, and it has two sub-elements, @nil and
text(). The @nil element indicates whether the
column value for the row is NULL, the text()
element contains the column value when the
column is not NULL.
Use Nil Unchecked
TIBCO ActiveMatrix BusinessWorks Palette Reference
Use Nil Checked
JDBC Query 337
|
Field
Global
Var?
Description
Interpret
Empty String
as Null
No
Specifies how empty strings in the activity’s input
elements should be handled. When the field is
checked, nulls are sent to the database where
empty strings are supplied. When the field is
unchecked, empty strings are treated as
zero-length strings. Whether you use this field or
not, you can still use XPath to set input elements
explicitly to null.
Note: Many databases treat empty strings and
nulls as the same, so this field will not affect how
the database interprets empty strings.
Process In
Subsets
No
Checking this field specifies that you would like to
process the result set in smaller batches rather than
processing the entire result set at once. When this
field is checked, the subsetSize input element
appears to allow you to specify the size of each
batch of records you wish to process. Also, the
lastSubset output element appears and is set to
true when the last batch of records is being
processed.
When this field is unchecked, the entire result set
is returned.
See Fetching Subsets of the Result Set on page 339
for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
338
| Chapter 8
JDBC Palette
Input
The input for the activity is the following.
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database
server. See Time Zone Construction on
page 361 for more information about how
time zones are constructed using this
field.
You can use the Constants tab in the XPath
Formula Builder to supply a valid time
zone name. The list of time zone names is
generated from
java.util.TimeZone.getAvailableIDs
(). See Time Zone Names on page 362 for
the list of valid time zone names.
Prepared_Param_*
varies
The list of prepared parameters supplied
in the SQL statement. Prepared
parameters allow you to substitute
process data for items in the SQL
statement. See the description of the
Prepared parameters field on the
Configuration tab.
integer
This element is only available when the
Process In Subsets field on the Advanced
tab is checked. When that field is checked,
records are processed in batches and this
element specifies the number of records to
process in each batch.
(name corresponds
to name specified in
the Prepared
Parameters field on
the Configuration
tab)
subsetSize
This allows you to process smaller batches
of rows instead of retrieving one large
result set. This element must be used in
conjunction with a Repeat Until True loop
group for processing the result sets. See
Fetching Subsets of the Result Set on
page 339 for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Query 339
|
Input Item
Datatype
Description
timeout
number
Time (in seconds) to wait for the query to
complete. If the query does not complete
in the given time limit, an error is
returned.
maxRows
number
The maximum number of rows to retrieve.
To retrieve all rows, specify 0.
Fetching Subsets of the Result Set
When the result set of a query is very large, you can retrieve subsets of the result
set and iterate until the entire result set is processed. To retrieve subsets, you must
use a Repeat Until True loop group to iterate until the entire result set is
processed. Use the following procedure as a guideline for creating your Repeat
Until True loop group.
1. Create a JDBC Query activity.
2. Specify the fields on the Configuration tab and create a query that returns
multiple rows.
3. Check the Process In Subsets field on the Advanced tab.
4. Set the subsetSize input item for the JDBC Query activity to the number of
records you wish to process for each execution of the loop. You could specify a
constant, or you could use a global variable to store the value. Using a global
variable has the advantage that you can change the value of the variable at
deployment time. For example, create a global variable named BATCH_SIZE,
then specify the chunkSize input element as
$_globalVariables/pfx:GlobalVariables/BATCH_SIZE.
5. Select the JDBC Query activity and click the group icon on the toolbar to
create a group containing the activity. See TIBCO ActiveMatrix BusinessWorks
Process Design Guide for more information about working with groups.
6. Select Repeat Until True as the Group action, and specify an index name (for
example, i).
7. The loop should exit when the entire result set has been consumed. The
output element lasSubset is a boolean that is set to true when the last subset
of records is being processes. For example, the condition for the loop could be
set to the following:
$JDBCQuery/resultSet/lastSubset = "true"
TIBCO ActiveMatrix BusinessWorks Palette Reference
340
| Chapter 8
JDBC Palette
The procedure above is a general guideline for creating a loop group for
processing a large set of records. 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.
See the examples included in the TIBCO ActiveMatrix BusinessWorks installation
directory for an example of processing subsets of a larger result set.
Output
The output for the activity is the following.
Output
Item
Datatype
Description
resultSet
complex
The root class for the output of the JDBC Query
activity. This class contains all output items for the
activity.
Record
complex
The result of the database query. The contents of
the Record element depends upon the columns
returned by the query.
lastSubset
boolean
This element only appears when the Process In
Subsets field on the Advanced tab is checked. This
field is set to true when the current subset of
records being processed is the last subset of
records. You can use this element to create an
XPath expression to determine when a Repeat
Until True loop that is processing records in
batches should stop processing. For example:
$JDBCQuery/resultSet/lastSubset = "true"
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Query 341
|
Output
Item
Datatype
Description
Elapsed
Time
long
This field displays the time taken for the execution
of the activity in milliseconds.
This is an optional element that appears only when
the property
java.property.bw.activity.output.stats.el
is set to true in
For run-time, set the property to
true in the bwengine.tra file. By default, the
property is set to false.
apsedTime.JDBCQueryActivity
designer.tra.
If set in the design-time, this property must be
carried forward to the run-time; else it can cause
run-time errors.
Enabling this property causes additional
performance overhead. Hence, it is recommended
that you use this property only when this
information is to be consumed by some other
ActiveMatrix BusinessWorks activity. Also, it is
recommended that this property be used only in a
non-production environment as a diagnostic tool
and the property be turned off at run-time.
You can turn off the property and not calculate the
elapsed time at run-time by setting the property
java.property.bw.activity.output.stats.el
apsedTime.turnoff in the bwengine.tra file.
However, note that setting this property will turn
off the calculation of elapsed time at run-time for
all the JDBC activities.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JDBCDriverLoadingException
An error occurred when loading the
specified JDBC driver.
TIBCO ActiveMatrix BusinessWorks Palette Reference
342
| Chapter 8
JDBC Palette
Exception
Thrown When...
InvalidSQLTypeException
A parameter’s datatype does not
match the datatype of the table
column.
JDBCConnectionNotFoundException
An error occurred when attempting to
connect to the specified database.
DuplicatedFieldNameException
A duplicate field name was specified.
InvalidTimeZoneException
An invalid timezone was specified.
See Time Zone Names on page 362 for
a list of valid timezones.
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
LoginTimedOutException
A timeout has occurred while
attempting to connect to the database.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Update 343
|
JDBC Update
Activity
The JDBC Update activity performs the specified SQL INSERT,
UPDATE, or DELETE statement.
If this activity is not part of a transaction group, the SQL statement is
committed after the activity completes. If this activity is part of a
transaction group, the SQL statement is committed or rolled back with the other
JDBC activities in the group at the end of the transaction. See TIBCO ActiveMatrix
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 in a transaction group, you can check the Override Transaction
Behavior field on the Advanced tab. This specifies that the activity is outside of
the transaction and the SQL statement is committed when the activity completes,
even if the activity is in a transaction group.
Configuration
The Configuration tab has the following fields:
Field
Global
Var?
Name
No
The name to appear as the label for this field in
the process definition.
Description
No
Short description of the activity.
JDBC Connection
Yes
Path to the shared configuration resource
containing the JDBC connection information.
See JDBC Connection on page 321 for more
information.
SQL Statement
Yes
The SQL INSERT, UPDATE, or DELETE
statement to perform.
Timeout (sec)
Yes
The time to wait for the statement to complete.
Prepared
Parameters
No
See Prepared Parameters on page 344 for a
description of this field.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
344
| Chapter 8
JDBC Palette
Prepared Parameters
If you wish to replace static names in the 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 = ?
The ? replaces the value, and you can then provide input to the SQL statement
from process data on the input tab.
When you add or remove question marks in SQL statements, a warning appears
to the right of the Prepared Parameters field ("SQL/ Prepared Parameter Count
Mismatch") to alert you to add or remove corresponding prepared parameters.
Each prepared parameter corresponds to the question mark in the same position
in the SQL statement. That is, the first prepared parameter in the list corresponds
to the first question mark, the second prepared parameter in the list corresponds
to the second question mark, and so on. The warning is for informational
purposes only, you must make sure the parameters in this field correctly
correspond to the SQL statement.
You can optionally specify names for each prepared parameter. By default, the
prepared parameters are named Prepared_Param_1, Prepared_Param_2, and so
on.
You must supply the datatype of each parameter to the SQL statement, and this
datatype is used in the input schema for the statement. You can use the up or
down arrow keys to move a specified datatype to the previous or next parameter.
You can also select a contiguous set of parameters to move them up or down, or
delete them with the delete button.
At run time, any parameters you place in the SQL statement are replaced with the
mapped values for those parameters.
Any mappings or expressions you create on the Input tab are not updated when
you move or delete prepared parameters. You must manually update the Input
tab after changing the prepared parameter field.
For INSERT and DELETE statements, all prepared parameters appear as required
items in the Input tab. For UPDATE statements, all prepared parameters 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Update 345
|
Advanced
The Advanced tab has the following fields:
Field
Override
Transaction
Behavior
Global
Var?
Yes
Description
Overrides the default behavior of a transaction
group. If this activity is in a transaction group,
the activity is normally committed or rolled back
with the other transactional activities.
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.
Interpret Empty
String as Null
No
Specifies how empty strings in the activity’s
input elements should be handled. When the
field is checked, nulls are sent to the database
where empty strings are supplied. When the
field is unchecked, empty strings are treated as
zero-length strings. Whether you use this field
or not, you can still use XPath to set input
elements explicitly to null.
Note: Many databases treat empty strings and
nulls as the same, so this field will not affect how
the database interprets empty strings.
TIBCO ActiveMatrix BusinessWorks Palette Reference
346
| Chapter 8
JDBC Palette
Field
Global
Var?
Description
Batch Update
No
Checking this field signifies you wish to perform
multiple statements by supplying an array of
records as input to the activity where each
record matches the prepared parameters for the
statement. The statements are performed in one
batch at the end of the activity’s execution.
This field is only meaningful if there are
prepared parameters in the SQL statement (see
Prepared Parameters on page 344).
If this field is not checked, the expected input is
the list of prepared parameters for the statement
(no array of records).
Some database drivers may not support batch
updates. A JDBCSQLException is thrown if the
database driver does not support batch updates.
Input
The input for the activity is the following:
Input Item
Datatype
Description
Record
repeating
When batch updates are performed, the
list of prepared parameters are
contained in a repeating element. When
only one update is performed, the list of
prepared parameters appears as
individual input elements. See the
description of the Batch Update field on
the Advanced tab for more information
about batch updates.
Prepared_Param_*
varies
The list of the prepared parameters
supplied in the SQL statement. Prepared
parameters allow you to substitute
process data for items in the SQL
statement. See the description of the
Prepared Parameters field on the
Configuration tab.
(name corresponds to
name specified in the
Prepared Parameters
field on the
Configuration tab)
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Update 347
|
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database
server. See Time Zone Construction on
page 361 for more information about
how time zones are constructed using
this field.
You can use the Constants tab in the
XPath Formula Builder to supply a valid
time zone name. The list of time zone
names is generated from
java.util.TimeZone.getAvailableID
s().
See Time Zone Names on page 362
for the list of valid time zone names.
timeout
number
Time (in seconds) to wait for the
statement to complete.
Output
The output for the activity is the following:
Output Item
Datatype
Description
noOfUpdates
integer
The number of updates performed by the
statement specified on the Configuration tab.
This element can also return -2 that indicates, in
the event of a batch update, that the updates
were successful, but it is unknown how many
updates were performed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
348
| Chapter 8
JDBC Palette
Output Item
Datatype
Description
Elapsed Time
long
This field displays the time taken for the
execution of the activity in milliseconds.
This is an optional element that appears only
when the property
java.property.bw.activity.output.stats.
elapsedTime.JDBCUpdateActivity is set to
true in designer.tra. For run-time, set the
property to true in the bwengine.tra file. By
default, the property is set to false.
If set in the design-time, this property must be
carried forward to the run-time; else it can cause
run-time errors.
Enabling this property causes additional
performance overhead. Hence, it is
recommended that you use this property only
when this information is to be consumed by
some other ActiveMatrix BusinessWorks activity.
Also, it is recommended that this property be
used only in a non-production environment as a
diagnostic tool and the property be turned off at
run-time.
You can turn off the property and not calculate
the elapsed time at run-time by setting the
property
java.property.bw.activity.output.stats.
elapsedTime.turnoff in the bwengine.tra file.
However, note that setting this property will
turn off the calculation of elapsed time at
run-time for all the JDBC activities.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JDBCDriverLoadingException
An error occurred when loading the
specified JDBC driver.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JDBC Update 349
|
Exception
Thrown When...
InvalidSQLTypeException
A parameter’s datatype does not
match the datatype of the table
column.
JDBCConnectionNotFoundException
An error occurred when attempting to
connect to the specified database.
InvalidTimeZoneException
An invalid timezone was specified.
See Time Zone Names on page 362 for
a list of valid timezones.
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
LoginTimedOutException
A timeout has occurred while
attempting to connect to the database.
TIBCO ActiveMatrix BusinessWorks Palette Reference
350
| Chapter 8
JDBC Palette
Query Designer
Wizard
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
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 the Build Using Wizard button
to create a query using the Query Designer wizard. Figure 18 illustrates the Query
Designer.
Figure 18 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Query Designer 351
|
•
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.
Prepared parameters in BusinessWorks are inserted into a query by using the
question mark (?) character. This is not valid SQL syntax, but BusinessWorks uses
this syntax for inserting process data into the query at runtime. Because this is not
valid SQL syntax, an error is returned if you attempt to check the syntax of a
query that has prepared parameters.
You should design and test the syntax of your query before inserting prepared
parameters.
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.
After you customize a query on the SQL tab, returning to the design tab without
checking the Customize checkbox eliminates your changes. First, create a query
using the Design, 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
352
| Chapter 8
JDBC Palette
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)
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Query Designer 353
|
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
FROM DEMO.CUSTOMER, DEMO.SALES_ORDER
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
clause has been added to the SQL:
BY
SELECT DEMO.CUSTOMER.NAME, DEMO.CUSTOMER.SALESPERSON_ID,
SUM(DEMO.SALES_ORDER.TOTAL)
FROM DEMO.CUSTOMER, DEMO.SALES_ORDER
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
354
| Chapter 8
JDBC Palette
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 Maximum 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 are 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 ActiveMatrix BusinessWorks requires that all
names in an input or output schema are unique. Therefore, you must specify
column aliases to ensure that all items in the output schema for a query are
unique.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SQL Direct 355
|
SQL Direct
Activity
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 using any other activity.
If this activity is not part of a transaction group, the SQL statement is committed
after the activity completes. If this activity is part of a transaction group, the SQL
statement is committed or rolled back with the other JDBC activities in the group
at the end of the transaction. See TIBCO ActiveMatrix 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 in a transaction group, you can check the Override Transaction
Behavior field on the Advanced tab. This specifies that the activity is outside of
the transaction and the SQL statement is committed when the activity completes,
even if the activity is in a transaction group.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JDBC
Connection
Yes
Path to the shared configuration resource
containing the JDBC connection information. See
JDBC Connection on page 321 for more
information about JDBC resources.
Timeout (sec)
Yes
Time (in seconds) to wait for the statement to
complete. If the statement does not complete in
the given time limit, an error is returned.
Maximum
Rows
Yes
The maximum number of rows to retrieve. To
retrieve all rows, specify 0.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
356
| Chapter 8
JDBC Palette
Advanced
The Advanced tab has the following fields.
Field
Override
Transaction
Behavior
Global
Var?
Yes
Description
Overrides the default behavior of a transaction
group. If this activity is in a transaction group, the
activity is normally committed or rolled back with
the other transactional activities.
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.
Input
The input for the activity is the following.
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database
server. See Time Zone Construction on
page 361 for more information about how
time zones are constructed using this field.
You can use the Constants tab in the XPath
Formula Builder to supply a valid time zone
name. The list of time zone names is
generated from
java.util.TimeZone.getAvailableIDs().
See Time Zone Names on page 362 for the list
of valid time zone names.
statement
string
The SQL statement you wish to execute. You
can use any process variables to build the
statement dynamically, if desired.
timeout
number
Time (in seconds) to wait for the statement to
complete. If the statement does not complete
in the given time limit, an error is returned.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SQL Direct 357
|
Input Item
Datatype
Description
maxRows
number
The maximum number of rows to retrieve. To
retrieve all rows, specify 0.
Output
The output for the activity is the following.
Output Item
Datatype
Description
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
358
| Chapter 8
JDBC Palette
Output Item
Datatype
Description
unknownResultSet
complex
The result of the database statement. The
result element 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SQL Direct 359
|
Output Item
Datatype
Description
Elapsed Time
long
This field displays the time taken for the
execution of the activity in milliseconds.
This is an optional element that appears
only when the property
java.property.bw.activity.output.st
ats.elapsedTime.JDBCGeneralActivity
is set to true in designer.tra. For
run-time, set the property to true in the
bwengine.tra file. By default, the property
is set to false.
If set in the design-time, this property must
be carried forward to the run-time; else it
can cause run-time errors.
Enabling this property causes additional
performance overhead. Hence, it is
recommended that you use this property
only when this information is to be
consumed by some other ActiveMatrix
BusinessWorks activity. Also, it is
recommended that this property be used
only in a non-production environment as a
diagnostic tool and the property be turned
off at run-time.
You can turn off the property and not
calculate the elapsed time at run-time by
setting the property
java.property.bw.activity.output.st
in the
file. However, note that
setting this property will turn off the
calculation of elapsed time at run-time for
all the JDBC activities.
ats.elapsedTime.turnoff
bwengine.tra
TIBCO ActiveMatrix BusinessWorks Palette Reference
360
| Chapter 8
JDBC Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JDBCDriverLoadingException
An error occurred when loading the
specified JDBC driver.
JDBCConnectionNotFoundException
An error occurred when attempting to
connect to the specified database.
InvalidTimeZoneException
An invalid timezone was specified.
See Time Zone Names on page 362 for
a list of valid timezones.
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
LoginTimedOutException
A timeout has occurred while
attempting to connect to the database.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Time Zone Construction 361
|
Time Zone Construction
TIBCO ActiveMatrix BusinessWorks constructs any date and time data returned
from the database with the time zone specified in the ServerTimeZone input
element. Constructed DateTime data is in a UTC-normalized form, and daylight
savings adjustments are also automatically applied.
If an invalid time zone name is specified, an InvalidTimeZoneException is
thrown. If no value is specified in this input item, it is assumed that the database
server is in the same time zone as the local machine.
All activities that retrieve and modify data to be later updated in a database
should specify the same time zone for the database server or potentially incorrect
values will be stored in the database.
Examples
Date in
Database
serverTimeZone
Constructed DateTime
Dec/5/1972
no value
1972-12-05T00:00:00-08:00
Jun/2/2003
no value
2003-06-02T00:00:00-07:00
Dec/5/1972
America/Los_Angeles
1972-12-05T00:00:00-08:00
Jun/2/2003
America/Los_Angeles
2003-06-02T00:00:00-07:00
Dec/5/1972
EST
1972-12-05T00:00:00-05:00
Jun/2/2003
EST
2003-06-02T00:00:00-04:00
TIBCO ActiveMatrix BusinessWorks Palette Reference
362
| Chapter 8
JDBC Palette
Time Zone Names
The ServerTimeZone input item in JDBC activities allows you to specify the name
of the time zone where the database server is located. Table 4 lists the names of
the time zones that you can specify. You can also retrieve these time zone names
on the Constants tab of the XPath Formula Builder.
Table 4 Time zone names for the ServerTimeZone input item
Time Zone Name
Time Zone Name
Time Zone Name
MIT
Africa/Casablanca
Asia/Tehran
Pacific/Apia
Africa/Conakry
MET
Pacific/Niue
Africa/Dakar
Asia/Aqtau
Pacific/Pago_Pago
Africa/Freetown
Asia/Baku
America/Adak
Africa/Lome
Asia/Dubai
HST
Africa/Monrovia
Asia/Muscat
Pacific/Fakaofo
Africa/Nouakchott
Asia/Tbilisi
Pacific/Honolulu
Africa/Ouagadougou
Asia/Yerevan
Pacific/Rarotonga
Africa/Sao_Tome
Europe/Samara
Pacific/Tahiti
Africa/Timbuktu
Indian/Mahe
Pacific/Marquesas
Atlantic/Canary
Indian/Mauritius
AST
Atlantic/Faeroe
Indian/Reunion
America/Anchorage
Atlantic/Reykjavik
NET
Pacific/Gambier
Atlantic/St_Helena
Asia/Kabul
America/Los_Angeles
Europe/Dublin
Asia/Aqtobe
America/Tijuana
Europe/Lisbon
Asia/Ashgabat
America/Vancouver
Europe/London
Asia/Ashkhabad
PST
GMT
Asia/Bishkek
TIBCO ActiveMatrix BusinessWorks Palette Reference
Time Zone Names 363
|
Table 4 Time zone names for the ServerTimeZone input item
Time Zone Name
Time Zone Name
Time Zone Name
Pacific/Pitcairn
UTC
Asia/Dushanbe
America/Dawson_Creek
WET
Asia/Karachi
America/Denver
Africa/Algiers
Asia/Tashkent
America/Edmonton
Africa/Bangui
Asia/Yekaterinburg
America/Mazatlan
Africa/Douala
Indian/Chagos
America/Phoenix
Africa/Kinshasa
Indian/Kerguelen
MST
Africa/Lagos
Indian/Maldives
PNT
Africa/Libreville
PLT
America/Belize
Africa/Luanda
Asia/Calcutta
America/Chicago
Africa/Malabo
IST
America/Costa_Rica
Africa/Ndjamena
Asia/Katmandu
America/El_Salvador
Africa/Niamey
Antarctica/Mawson
America/Guatemala
Africa/Porto-Novo
Asia/Almaty
America/Managua
Africa/Tunis
Asia/Colombo
America/Mexico_City
Africa/Windhoek
Asia/Dacca
America/Regina
ECT
Asia/Dhaka
America/Tegucigalpa
Europe/Amsterdam
Asia/Novosibirsk
America/Winnipeg
Europe/Andorra
Asia/Thimbu
CST
Europe/Belgrade
Asia/Thimphu
Pacific/Easter
Europe/Berlin
BST
Pacific/Galapagos
Europe/Brussels
Asia/Rangoon
America/Bogota
Europe/Budapest
Indian/Cocos
America/Cayman
Europe/Copenhagen
Asia/Bangkok
TIBCO ActiveMatrix BusinessWorks Palette Reference
364
| Chapter 8
JDBC Palette
Table 4 Time zone names for the ServerTimeZone input item
Time Zone Name
Time Zone Name
Time Zone Name
America/Grand_Turk
Europe/Gibraltar
Asia/Jakarta
America/Guayaquil
Europe/Luxembourg
Asia/Krasnoyarsk
America/Havana
Europe/Madrid
Asia/Phnom_Penh
America/Indianapolis
Europe/Malta
Asia/Saigon
America/Jamaica
Europe/Monaco
Asia/Vientiane
America/Lima
Europe/Oslo
Indian/Christmas
America/Montreal
Europe/Paris
VST
America/Nassau
Europe/Prague
Antarctica/Casey
America/New_York
Europe/Rome
Asia/Brunei
America/Panama
Europe/Stockholm
Asia/Hong_Kong
America/Port-au-Prince
Europe/Tirane
Asia/Irkutsk
America/Porto_Acre
Europe/Vaduz
Asia/Kuala_Lumpur
America/Rio_Branco
Europe/Vienna
Asia/Macao
EST
Europe/Warsaw
Asia/Manila
IET
Europe/Zurich
Asia/Shanghai
America/Anguilla
ART
Asia/Singapore
America/Antigua
Africa/Blantyre
Asia/Taipei
America/Aruba
Africa/Bujumbura
Asia/Ujung_Pandang
America/Asuncion
Africa/Cairo
Asia/Ulaanbaatar
America/Barbados
Africa/Gaborone
Asia/Ulan_Bator
America/Caracas
Africa/Harare
Australia/Perth
America/Cuiaba
Africa/Johannesburg
CTT
America/Curacao
Africa/Kigali
Asia/Jayapura
TIBCO ActiveMatrix BusinessWorks Palette Reference
Time Zone Names 365
|
Table 4 Time zone names for the ServerTimeZone input item
Time Zone Name
Time Zone Name
Time Zone Name
America/Dominica
Africa/Lubumbashi
Asia/Pyongyang
America/Grenada
Africa/Lusaka
Asia/Seoul
America/Guadeloupe
Africa/Maputo
Asia/Tokyo
America/Guyana
Africa/Maseru
Asia/Yakutsk
America/Halifax
Africa/Mbabane
JST
America/La_Paz
Africa/Tripoli
Pacific/Palau
America/Manaus
Asia/Amman
ACT
America/Martinique
Asia/Beirut
Australia/Adelaide
America/Montserrat
Asia/Damascus
Australia/Broken_Hill
America/Port_of_Spain
Asia/Jerusalem
Australia/Darwin
America/Puerto_Rico
Asia/Nicosia
AET
America/Santiago
CAT
Antarctica/DumontDUrville
America/Santo_Domingo
EET
Asia/Vladivostok
America/St_Kitts
Europe/Athens
Australia/Brisbane
America/St_Lucia
Europe/Bucharest
Australia/Hobart
America/St_Thomas
Europe/Chisinau
Australia/Sydney
America/St_Vincent
Europe/Helsinki
Pacific/Guam
America/Thule
Europe/Istanbul
Pacific/Port_Moresby
America/Tortola
Europe/Kaliningrad
Pacific/Saipan
Antarctica/Palmer
Europe/Kiev
Pacific/Truk
Atlantic/Bermuda
Europe/Minsk
Australia/Lord_Howe
Atlantic/Stanley
Europe/Riga
Asia/Magadan
PRT
Europe/Simferopol
Pacific/Efate
TIBCO ActiveMatrix BusinessWorks Palette Reference
366
| Chapter 8
JDBC Palette
Table 4 Time zone names for the ServerTimeZone input item
Time Zone Name
Time Zone Name
Time Zone Name
America/St_Johns
Europe/Sofia
Pacific/Guadalcanal
CNT
Europe/Tallinn
Pacific/Kosrae
AGT
Europe/Vilnius
Pacific/Noumea
America/Buenos_Aires
Africa/Addis_Ababa
Pacific/Ponape
America/Cayenne
Africa/Asmera
SST
America/Fortaleza
Africa/Dar_es_Salaam
Pacific/Norfolk
America/Godthab
Africa/Djibouti
Antarctica/McMurdo
America/Miquelon
Africa/Kampala
Asia/Anadyr
America/Montevideo
Africa/Khartoum
Asia/Kamchatka
America/Paramaribo
Africa/Mogadishu
NST
America/Sao_Paulo
Africa/Nairobi
Pacific/Auckland
BET
Asia/Aden
Pacific/Fiji
America/Noronha
Asia/Baghdad
Pacific/Funafuti
Atlantic/South_Georgia
Asia/Bahrain
Pacific/Majuro
America/Scoresbysund
Asia/Kuwait
Pacific/Nauru
Atlantic/Azores
Asia/Qatar
Pacific/Tarawa
Atlantic/Cape_Verde
Asia/Riyadh
Pacific/Wake
Atlantic/Jan_Mayen
EAT
Pacific/Wallis
Africa/Abidjan
Europe/Moscow
Pacific/Chatham
Africa/Accra
Indian/Antananarivo
Pacific/Enderbury
Africa/Banjul
Indian/Comoro
Pacific/Tongatapu
Africa/Bissau
Indian/Mayotte
Pacific/Kiritimati
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 367
Chapter 9
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 in 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.
See TIBCO ActiveMatrix BusinessWorks Release Notes for more information about
specific support for JMS providers.
Topics
•
Enabling JMS in TIBCO ActiveMatrix BusinessWorks, page 368
•
Get JMS Queue Message, page 369
•
JMS Application Properties, page 375
•
JMS Connection, page 376
•
JMS Properties, page 385
•
JMS Queue Receiver, page 389
•
JMS Queue Requestor, page 396
•
JMS Queue Sender, page 403
•
JMS Topic Publisher, page 409
•
JMS Topic Requestor, page 415
•
JMS Topic Subscriber, page 422
•
Reply To JMS Message, page 429
•
Wait for JMS Queue Message, page 435
•
Wait for JMS Topic Message, page 442
TIBCO ActiveMatrix BusinessWorks Palette Reference
368
| Chapter 9
JMS Palette
Enabling JMS in TIBCO ActiveMatrix BusinessWorks
TIBCO ActiveMatrix BusinessWorks acts as a JMS client when sending messages
to or receiving messages from a JMS provider. Because of this, you must place the
appropriate JMS client files supplied by the JMS provider in the proper location.
Typically, this includes placing JAR files into a directory that is included on the
client’s CLASSPATH.
See the documentation for your JMS provider for more information about which
files are needed and the location to place them to enable client access to the JMS
server.
Once you have located the appropriate files, you can place them in the
<TIBCO_HOME>/bw/<version>/lib directory. This directory is in the TIBCO
ActiveMatrix BusinessWorks CLASSPATH, and placing the JMS client files in that
directory allows you to design and test TIBCO ActiveMatrix BusinessWorks
process definitions that include JMS Palette activities.
When deploying your project, the machine where the process engine is deployed
must also have the appropriate JMS client files. You should also place the JMS
client files in the <TIBCO_HOME>/bw/<version>/lib directory of the machines
where your process engines are deployed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Get JMS Queue Message 369
|
Get JMS Queue Message
Activity
The Get JMS Queue Message activity retrieves a message from the
specified queue. This activity allows you to perform a receive
operation on the queue as opposed to waiting for a queue message to
be delivered to the Wait for JMS Queue Message activity or the JMS
Queue Receiver process starter.
You can use the Message Selector field on the Advanced tab to retrieve a specific
queue message from the queue.
The Get JMS Queue Message activity is different from the Wait for JMS Queue
Message activity in the following ways:
•
Unlike the Wait for activity, which starts listening for messages from the time
the BusinessWorks engine starts, this activity starts listening for incoming
messages on the specified queue from the time the activity is triggered.
•
This activity can receive only one message from the specified queue at a time,
when the Message Selector is not used.
•
Once triggered, this activity can either gets a message from the specified
destination queue name before timeout and proceeds or it throws a timeout
error and exits.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JMS
Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a
JMS connection.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
370
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Destination
Queue
Yes
Name of the queue from which to retrieve the
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.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
Message Type
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
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 (use
the Binary datatype when mapping this data),
or a string. Each item can be accessed
sequentially or by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
Get JMS Queue Message 371
|
Field
Global
Var?
Description
Acknowledge
Mode
Yes
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. If
the message is not confirmed before the
process instance ends, the message is
redelivered and a new process instance is
created to handle the new incoming message.
Ensure that your process definition confirms
the message when using this acknowledge
mode.
•
TIBCO EMS Explicit Client Acknowledge —
(only available for TIBCO EMS) the message
will be acknowledged at a later point by using
the Confirm activity. The session is not blocked
and one session handles all incoming
messages for each process instance. If a
message is not confirmed before the process
instance ends, all messages received in the
same session are redelivered.
•
Dups OK — the message is acknowledged
automatically when it is received. JMS
provides this mode for lazy
acknowledgement, but TIBCO ActiveMatrix
BusinessWorks acknowledges messages upon
receipt.
•
Transactional — this mode is used when a
transaction that can process JMS messages is
included in the process definition. The
message is acknowledged when the
transaction commits. See TIBCO ActiveMatrix
BusinessWorks Process Design Guide for more
information about creating transactions that
JMS activities can participate in.
TIBCO ActiveMatrix BusinessWorks Palette Reference
372
| Chapter 9
JMS Palette
Advanced
The Advanced tab has the following fields.
Field
Message
Selector
Global
Var?
Yes
Description
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
Properties
No
Any application-specific message properties that
will be part of the message. This is specified by
the JMS Application Properties shared
configuration resource.
Once specified, these properties appear on the
Output tab as "OtherProperties".
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
destinationQueue
string
The queue to which to send the request. This
input item overrides the Destination Queue
field on the Configuration tab.
timeout
integer
Specifies how long the message can remain
active (in seconds). If set to 0, the message
does not expire.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Get JMS Queue Message 373
|
Input Item
Datatype
Description
selector
string
A string to determine whether a message
should be received. The value of this element
overrides any value specified in the Message
Selector field of the Advanced tab. 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.
Output Editor
The Output Editor tab defines the schema to use for messages of type Map,
Stream, or XML Text. Map messages are name/value pairs, and the schema
allows you to define the structure of the retrieved queue message. The schema
defined on the Output Editor tab becomes the body of the message on the Output
tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message.
See JMS Properties on page 385 for more
information about message header fields.
Only properties applicable to this type of
message are displayed.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
374
| Chapter 9
JMS Palette
Output Item
Datatype
Description
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JMSInvalidInputException
Input to the activity is not valid.
JMSSessionCreateException
The JMS session could not be created.
JMSReceiveException
The JMS receive operation failed.
ActivityTimedOutException
The specified timeout has been reached
and the activity has not completed its
execution.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Application Properties 375
|
JMS Application Properties
Shared Configuration
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 appear in the OtherProperties element on
the Input or Output tab of the activity.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Properties
No
A table listing any application-specific properties.
Use the + and x buttons to the right of the table to
add and delete properties. Use the up and down
arrow buttons to move selected properties to the
desired location in the table.
Specify the name of the property by typing the
name in the PropertyName column.
Specify the datatype of the property by double
clicking the cell of the Type column for the desired
property. This causes a drop down list of valid JMS
datatypes to appear.
Specify whether the property is optional or
required by double clicking on the cell of the
Cardinality column for the desired property. Select
either optional or required in the drop down list
that appears.
TIBCO ActiveMatrix BusinessWorks Palette Reference
376
| Chapter 9
JMS Palette
JMS Connection
Shared Configuration
The JMS Connection resource describes a JMS connection. This
resource is used when specifying activities on the JMS palette.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
User Name
Yes
User name to use when logging into the JMS
server.
If the JMS provider does not require access
control, this field can be empty.
Not all JMS servers require user names and
passwords. Refer to your JMS provider
documentation and consult your system
administrator to determine if your JMS server
requires a user name and password.
Password
Yes
Password to use when logging into the JMS
server.
If the JMS provider does not require access
control, this field can be empty.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Connection 377
|
Field
Global
Var?
Description
Auto-Generate
Client ID
Yes
Checking this field specifies you wish to
automatically generate the client ID if no client ID
is specified or if the specified ID is already in use.
When this field is checked, if a value is specified
in the Client ID field, an attempt is made to use
the specified value. However, if the specified
value is already in use, a new client ID is
generated.
When an automatically generated client ID is
required, the following format is used for the
client ID:
BW-<projectName>-<topic or
queue>-<engineName>-<timestamp>
If this field is not checked, then the value
specified in the Client ID field is used. If no value
is specified in the Client ID field, then no client ID
is set. If the value specified in the Client ID field is
already in use, an exception is thrown.
Client ID
Yes
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. Each connection must use a unique Client
IDs. If you do not specify a value in this field,
TIBCO ActiveMatrix BusinessWorks ensures the
uniqueness of the client ID for each connection.
You cannot use the same JMS Connection
resource for accessing both topics and queues.
You should create separate JMS Connection
resources if you wish to access both topic and
queue destinations.
TIBCO ActiveMatrix BusinessWorks Palette Reference
378
| Chapter 9
JMS Palette
Field
Global
Var?
Description
SSL
No
Specifies whether you wish to use SSL for the
connection to the JMS server. SSL is used when
the Use SSL? checkbox is checked. Click the
Configure SSL button to configure the SSL
connection parameters.
Note: SSL is supported only when using TIBCO
Enterprise Message Service.
See SSL Configuration on page 382 for more
information.
Use JNDI for
Connection
Factory
Yes
Specifies whether JNDI should be used to look up
the ConnectionFactory object. If this field is
unchecked, the Provider URL and Use XA
Connection Factory fields appear. If this field is
checked, JNDI configuration fields appear.
Provider URL
Yes
This field is only available when the Use JNDI for
Connection Factory field is unchecked.
This is the URL to use to connect to the JMS
server.
Use XA
Connection
Factory
No
When checked, this field specifies that an XA
connection factory is to be used. This is useful if
you wish activities that use this connection to
participate in an XA transaction. See TIBCO
ActiveMatrix BusinessWorks Process Design Guide
for more information about transactions.
Use Shared
JNDI
Configuration
No
When this field is checked, the JNDI
Configuration field appears that allows you to
choose a JNDI Configuration shared
configuration resource.
When this field is unchecked, the JNDI Context
Factory, JNDI Context URL, JNDI User Name,
and JNDI Password fields appear.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Connection 379
|
Field
Global
Var?
Description
JNDI
Configuration
No
This field only appears when the Use Shared
JNDI Configuration field is checked.
This field allows you to choose a JNDI
Configuration shared configuration object that
specifies the JNDI connection information. See
JNDI Configuration on page 175 for more
information.
JNDI Context
Factory
Yes
This field only appears when the Use Shared
JNDI Configuration field is unchecked. The initial
context factory class for accessing JNDI.
(javax.naming.Context.INITIAL_CONTEXT_
FACTORY). You can choose from the drop down
list of supported classes, or you can type in a
different InitialContextFactory class name.
When using IBM WebSphere, you should use the
JNDI Configuration resource instead of
specifying the JNDI configuration on this
resource. See IBM WebSphere and JNDI Context
Caching on page 177 for more information.
Note: TIBCO ActiveMatrix 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.
JNDI Context
URL
Yes
This field only appears when the Use Shared
JNDI Configuration field is unchecked. This is the
URL to the JNDI service provider
(javax.naming.Context.PROVIDER_URL). An
example URL is provided when one of the
supported JNDI context factory classes is
selected.
See your JNDI provider documentation for the
syntax of the URL.
TIBCO ActiveMatrix BusinessWorks Palette Reference
380
| Chapter 9
JMS Palette
Field
Global
Var?
Description
JNDI User
Name
Yes
This field only appears when the Use Shared
JNDI Configuration field is unchecked. User
name to use when logging into the JNDI server
(javax.naming.Context.SECURITY_
PRINCIPAL). If the JNDI provider does not require
access control, this field can be empty.
JNDI
Password
Yes
This field only appears when the Use Shared
JNDI Configuration field is unchecked. Password
to use when logging into the JNDI server
(javax.naming.Context.SECURITY_
CREDENTIALS). If the JNDI provider does not
require access control, this field can be empty.
Connection
Factory SSL
Password
Yes
This field is only available when the SSL and the
Use JNDI for Connection Factory fields are
checked and the Use Shared JNDI Configuration
field is unchecked.
The SSL configuration is specified in the
ConnectionFactory object, except for the client
SSL password.
You can specify your client SSL password in this
field, or you can leave this field empty. If your
password is not specified, the private key
password is used.
Test Connection Button
Allows you to test the connection specified in the configuration of this resource.
This button is only enabled if JNDI is not used (that is, the Use JNDI for
Connection Factory field is unchecked) or if the required JNDI fields on the
Configuration and Advanced tab are supplied when JNDI is used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Connection 381
|
Advanced
The Advanced tab has the following fields.
Field
Topic
Connection
Factory
Global
Var?
Yes
Description
This field is only available when the Use JNDI for
Connection Factory field on the Configuration tab
is checked.
The TopicConnectionFactory object stored in
JNDI. 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.
Queue
Connection
Factory
Yes
This field is only available when the Use JNDI for
Connection Factory field on the Configuration tab
is checked.
The QueueConnectionFactory object stored in
JNDI. 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.
JNDI
Properties
No
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
382
| Chapter 9
JMS Palette
SSL Configuration
The SSL Configuration button allows you to configure the SSL connection
parameters. The SSL Configuration dialog specifies the basic and advanced SSL
parameters you can set for the JMS server you are connecting to.
When using JNDI to lookup the JMS Connection factory, the parameters
ssl_identity and ssl_verify_host must be specified in the factories.conf
file of the Enterprise Message Service server.
The following sections describe the SSL Configuration dialog.
Basic
The Basic tab of the SSL Configuration dialog allows you to specify the simplest
required SSL configuration parameters for the connection.
Field
Description
Trusted Certificates
Folder
Location of the trusted certificates on this
machine. The trusted certificates are a collection of
certificates from servers to whom you will
establish connections. If the server you wish to
establish a connection presents a certificate that
does not match one of your trusted certificates,
the connection is refused.
This prevents connections to unauthorized
servers.
Trusted certificates must be imported into a folder,
and then you can select the folder in this field.
Identity
The location of the client certificate. This is a
resource contained in the General palette.
You only need to specify the client certificate
when the JMS server requires client
authentication.
See TIBCO Designer Palette Reference for more
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Connection 383
|
Advanced
The Advanced tab of the SSL Configuration dialog allows you to specify more
advanced SSL configuration parameters for the connection.
Field
Description
Trace
Specifies whether SSL tracing should be enabled
during the connection. If checked, the SSL connection
messages are logged and sent to the console.
Debug Trace
Specifies whether SSL debug tracing should be
enabled during the connection. Debug tracing
provides more detailed messages than standard
tracing.
Verify Host Name
Specifies whether you wish to verify that the host
you are connecting to is the expected host. The host
name in the host’s digital certificate is compared
against the value you supply in the Expected Host
Name field. If the host name does not match the
expected host name, the connection is refused.
Note: The default context factories for TIBCO
Enterprise Message Service automatically determine
if host name verification is necessary. If you are using
a custom implementation of the context factories,
your custom implementation must explicitly set the
verify host property to the correct value. For
example:
com.tibco.tibjms.TibjmsSSL.setVerifyHost(fa
lse)
Expected Host Name
Specifies the name of the host you are expecting to
connect to. This field is only relevant if the Verify
Host Name field is also checked.
If the name of the host in the host’s digital certificate
does not match the value specified in this field, the
connection is refused.
This prevents hosts from attempting to impersonate
the host you are expecting to connect to.
TIBCO ActiveMatrix BusinessWorks Palette Reference
384
| Chapter 9
JMS Palette
Field
Description
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified
with the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Properties 385
|
JMS Properties
Table 5 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 5 Properties for JMS Messages
Property
Datatype
Description
JMSDestination
string
Destination 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:
MessageHeaders
•
PERSISTENT — signifies the messages
are stored and forwarded.
•
NON_PERSISTENT — messages are not
stored and may be lost due to failures
in transmission.
•
When using TIBCO Enterprise
Message Service, the
JMSDeliveryMode header can be
RELIABLE_DELIVERY. See the TIBCO
Enterprise Message Service
documentation for more information
about this mode.
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
386
| Chapter 9
JMS Palette
Table 5 Properties for JMS Messages
Property
Datatype
Description
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 JMSExpiration field on the
activity’s Advanced 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 in a
reply message.
See the following topics for more
information about JMSCorrelationID:
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
JMS Queue Requestor on page 396
•
JMS Queue Sender on page 403
•
JMS Topic Publisher on page 409
•
JMS Topic Requestor on page 415
•
Reply To JMS Message on page 429
JMS Properties 387
|
Table 5 Properties for JMS Messages
Property
Datatype
Description
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.
string
The ID of the user sending the message.
MessageProperties
JMSXUserID
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.
This property is optionally set on
incoming messages by the JMS
application. This property is not set on
outgoing messages.
JMSXProducerTIXID
string
The transaction identifier of the
transaction where this message was
produced.
This property is optionally set on
incoming messages by the JMS
application. This property is not set on
outgoing messages.
JMSXConsumerTXID
string
The transaction identifier of the
transaction where this message was
consumed.
This property is optionally set on
incoming messages by the JMS
application. This property is not set on
outgoing messages.
TIBCO ActiveMatrix BusinessWorks Palette Reference
388
| Chapter 9
JMS Palette
Table 5 Properties for JMS Messages
Property
Datatype
Description
JMSXRcvTimestamp
integer
The time the JMS server delivered the
message to the consumer. The time is
expressed as the amount of time, in
milliseconds since midnight, January 1,
1970, UTC.
This property is optionally set on
incoming messages by the JMS server.
This property is not set on outgoing
messages.
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 in
its group.
You can set this property on outgoing
messages to group messages into a
numbered sequence.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Receiver 389
|
JMS Queue Receiver
Process Starter
Starts a process based on the receipt of a message for the specified
JMS queue.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JMS
Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a JMS
connection.
Destination
Queue
Yes
Name of the queue of the incoming message.
Description
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.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
390
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Message Type
No
The type of the message. This can be one of the
following:
Acknowledge
Mode
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
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 (use the
Binary datatype when mapping this data), or a
string. Each item can be accessed sequentially or
by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
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. If the
message is not confirmed before the process
instance ends, the message is redelivered and a
new process instance is created to handle the
new incoming message. Ensure that your
process definition confirms the message when
using this acknowledge mode.
JMS Queue Receiver 391
|
Field
Global
Var?
Description
•
TIBCO EMS Explicit Client Acknowledge —
(only available for TIBCO EMS) the message
will be acknowledged at a later point by using
the Confirm activity. The session is not blocked
and one session handles all incoming messages
for each process instance. If a message is not
confirmed before the process instance ends, all
messages received in the same session are
redelivered.
•
Dups OK — the message is acknowledged
automatically when it is received. JMS provides
this mode for lazy acknowledgement, but
TIBCO ActiveMatrix BusinessWorks
acknowledges messages upon receipt.
•
Transactional — this mode is used when a
transaction that can process JMS messages is
included in the process definition. The message
is acknowledged when the transaction commits.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
creating transactions that JMS activities can
participate in.
•
Local Transactional — this mode is used when a
transaction involves only JMS messages. See
TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
creating transactions that JMS activities can
participate in.
TIBCO ActiveMatrix BusinessWorks Palette Reference
392
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Max Sessions
Yes
When the Acknowledge Mode field is set to Client,
Transactional and Local Transactional, 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.
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
TIBCO ActiveMatrix BusinessWorks Palette Reference
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
JMS Queue Receiver 393
|
Load-Balancing of Incoming Messages
One common application of a JMS queue is to distribute queue messages across
multiple receivers, thus balancing the processing of the messages on the queue. To
achieve this goal, both the JMS server and TIBCO ActiveMatrix BusinessWorks
must be properly configured. The JMS server must allow the queue messages to
be distributed across multiple receivers. For example, in TIBCO Enterprise
Message Service, the exclusive property on the queue controls whether
messages can be delivered across receivers or not. In TIBCO ActiveMatrix
BusinessWorks, the process definition containing the JMS Queue Receiver must
be deployed across multiple process engines. This creates multiple queue
receivers for the same queue.
When balancing incoming messages across TIBCO ActiveMatrix BusinessWorks
engines, you should ensure that one engine does not attempt to accept and
confirm a large number of incoming messages before other engines can receive
the messages. In general, most JMS servers balance the load by distributing
messages in a round-robin fashion to all queue receivers. However, there are
situations that can cause an uneven distribution of messages across queue
receivers. If you set the Acknowledge Mode field to "Auto" on the Configuration
tab of the JMS Queue Receiver, the process starter confirms messages as it receives
them. When process engines are started at different times, this can lead to one
process engine receiving all queue messages and paging them to disk, depending
upon how the engine’s Max Jobs and Activation Limit properties are set when the
engine is deployed.
If you are using TIBCO Enterprise Messaging Service, you can avoid this problem
by setting the acknowledge mode to TIBCO EMS Explicit and then use the Flow
Limit property in the deployment configuration to control the number of process
instances created by the process starter.
If you are not using TIBCO Enterprise Messaging Service, set the Acknowledge
Mode field to "Client". In this mode, a process engine can only receive as many
messages as it has sessions specified in the Max Sessions field. Once a process
engine reaches the maximum number of sessions, another process engine can
begin to accept incoming messages. A process engine cannot receive more
messages until the messages have been acknowledged by using the Confirm
activity. Once the message is acknowledged, the session is released and the
process engine can accept a new message.
If the Sequencing Key field is set to preserve the order of incoming messages, to
confirm the messages sequentially you must either set the Acknowledge mode to
TIBCO EMS Explicit Client Acknowledge mode or set the Acknowledge mode to
Client and Max Sessions to 1. Setting Max Sessions to 1 can limit the system's
throughput, so using TIBCO Enterprise Message Service and TIBCO EMS Explicit
Client Acknowledge is a better choice.
TIBCO ActiveMatrix BusinessWorks Palette Reference
394
| Chapter 9
JMS Palette
Advanced
The Advanced tab has the following fields.
Field
Message
Selector
Global
Var?
Yes
Description
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
Properties
Yes
Any application-specific message properties that
will 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".
Receiver
Timeout
(seconds)
No
Specifies the polling interval to check for new
messages. This default interval is set by the custom
engine property
bw.plugin.jms.receiverTimeout. If no value is
specified for the property, the default polling
interval is one second.
Set a value in this field to specify the polling
interval (in seconds) for this activity. The value in
this field overrides the default polling interval.
Precreate
Transactions
No
When checked, this field specifies that the
transaction is created before a message arrives at
the JMS receiver. This field is available when
Acknowledge Mode is set to Transactional.
XA
Transaction
Manager
Reference
No
Specifies the XA Transaction Manager
Configuration used to create the XA transaction.
This field is available when Precreate Transactions
field is checked. This configuration overrides the
Transaction Manager associated with the group the
Event Source is tied to.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Receiver 395
|
Output Editor
The Output Editor tab defines the schema to use for incoming messages whose
message type is Map, Stream, or XML Text. 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 Output Editor tab becomes the structure used for the
body of the message displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message.
See JMS Properties on page 385 for more
information about message header fields.
Only properties applicable to this type of
message are displayed.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
OtherProperties
complex
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 resource.
Body
depends
upon the
message
type
The body of the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
396
| Chapter 9
JMS Palette
JMS Queue Requestor
Activity
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.
This activity uses temporary destinations to ensure that reply messages are
received only by the process that sent the request.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JMS
Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a JMS
connection.
Destination
Queue
Yes
Name of the queue of the outgoing 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.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Requestor 397
|
Field
Global
Var?
Description
Message
Type
No
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 (use the
Binary datatype when mapping this data), or a
string. Each item can be accessed sequentially or
by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
398
| Chapter 9
JMS Palette
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Delivery mode
Yes
JMSExpiration
(secs)
Yes
Description
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.
•
EMS_RELIABLE_DELIVERY — this mode is
only available when using TIBCO Enterprise
Message Service. See the TIBCO Enterprise
Message Service documentation for more
information about this mode.
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
Yes
Priority of the message. You may set the priority
to a value from 0-9. The default value is 4.
Type
Yes
The value to supply to the JMSType header
property.
JMS
Application
Properties
No
Any application-specific message properties that
will be part of the message. This is specified by
the JMS Application Properties shared
configuration resource.
Once specified, these properties appear on the
Output tab as OtherProperties.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Requestor 399
|
Input Editor/Output Editor
The Input Editor/Output Editor tabs define the schema to use for messages of
type Map, Stream, or XML Text. 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 Editor tab becomes the body of
the message on the Input tab. The schema defined on the Output Editor tab
becomes the body of the message on the Output tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input/Output Editor tabs.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
destinationQueue
string
The queue to which to send the request. This
input item overrides the Destination Queue
field on the Configuration tab.
JMSExpiration
integer
Specifies how long the message can remain
active (in seconds). If set to 0, the message
does not expire.
JMSPriority
string
The priority of the message. This item
overrides the priority set on the 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 in a reply message,
but you can set this element to any value.
JMSType
string
The type of the message. This item overrides
the value specified on the Advanced tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
400
| Chapter 9
JMS Palette
Input Item
Datatype
Description
requestTimeout
integer
The time to wait (in seconds) for the
synchronous request-reply operation to
complete. An error is returned if the
operation does not complete in this time
limit.
replyToDestination
string
The destination to use for replies for this
activity.
Note: If more than one job has the same
replyToDestination (for example, you
specify a constant in this field), then the
correct reply may not be received by each
job. Make certain that you specify an
expression in this field that assigns a
different replyToDestination to each process
instance.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Requestor 401
|
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message.
See JMS Properties on page 385 for more
information about message header fields.
Only properties applicable to this type of
message are displayed.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JMSInvalidInputException
Input to the activity is not valid.
JMSMessageCreateException
The JMS message could not be created.
JMSSessionCreateException
The JMS session could not be created.
TIBCO ActiveMatrix BusinessWorks Palette Reference
402
| Chapter 9
JMS Palette
Exception
Thrown When...
JMSSendException
The JMS send operation failed.
JMSReceiveException
The JMS receive operation failed.
JMSActivityException
This activity fails.
ActivityTimedOutException
This activity has reached the specified
time out and the response has not been
received.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Sender 403
|
JMS Queue Sender
Activity
The JMS Queue Sender activity sends a message to the specified
JMS queue.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
JMS Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a
JMS connection.
Destination
Queue
Yes
Name of the queue of the outgoing message.
Description
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.
Note: If you are using TIBCO Enterprise
Message Service as your JMS provider, you can
use the Browse button next to this field after
specifying a valid connection in the JMS
Connection field. The Browse button displays a
list of configured destinations in the JMS server
that are appropriate for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
404
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Message Type
No
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 (use the Binary datatype when
mapping this data), or a string. Each item
can be accessed sequentially or by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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
•
TIBCO ActiveMatrix BusinessWorks Palette Reference
XML Text — The message is XML text.
JMS Queue Sender 405
|
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Reply-to Queue
Yes
Description
The name of the queue where replies should be
sent. This field is optional, and replies are sent to
the queue specified on the Configuration tab by
default.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
Delivery mode
JMSExpiration
(secs)
Yes
Yes
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.
•
RELIABLE_DELIVERY — this mode is only
available when using TIBCO Enterprise
Message Service. See the TIBCO Enterprise
Message Service documentation for more
information about this mode.
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
Yes
Priority of the message. You may set the priority
to a value from 0-9. The default value is 4.
TIBCO ActiveMatrix BusinessWorks Palette Reference
406
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Type
Yes
The value to supply to the JMSType header
property.
JMS
Application
Properties
No
Any application-specific message properties that
will be part of the message. This is specified by the
JMS Application Properties shared configuration
resource.
Once specified, these properties appear on the
Output tab as OtherProperties.
Override
Transaction
Behavior
Yes
Overrides the default behavior of a transaction
group. If this activity is in a transaction group, the
JMS message is normally committed or rolled
back with the other participants in the transaction.
If this checkbox is checked, the JMS message does
not participate in the transaction.
Input Editor
The Input Editor tab defines the schema to use for outgoing messages whose
message type is Map, Stream, or XML Text. Map messages are name/value pairs,
and the schema allows you to define the structure of the outgoing message. Once
defined, the schema on the Input Editor tab becomes the structure used for the
body of the message displayed on the Input tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
destinationQueue
string
The queue to which to send the request. This
input item overrides the Destination Queue
field on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Queue Sender 407
|
Input Item
Datatype
Description
replyToQueue
string
The queue where replies should be sent for
this request. This input item overrides the
reply-to destination specified on the
Advanced tab.
JMSExpiration
integer
Specifies how long the message can remain
active (in seconds). If set to 0, the message
does not expire.
JMSPriority
string
The priority of the message. This item
overrides the priority set on the Advanced
tab.
JMSDeliveryMode
string
The delivery mode of the message. Can be
one of the following:
•
PERSISTENT — signifies the messages are
stored and forwarded.
•
NON_PERSISTENT
•
When using TIBCO Enterprise Message
Service, the JMSDeliveryMode header
can be RELIABLE_DELIVERY. See the
TIBCO Enterprise Message Service
documentation for more information
about this mode.
— messages are not
stored and may be lost due to failures in
transmission.
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 exists in a reply message.
JMSType
string
The type of the message. This item overrides
the value specified on the Advanced tab.
JMSProperties
complex
The message properties. See JMS Properties
on page 385 for more information about
message properties.
Only properties applicable to this type of
message are displayed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
408
| Chapter 9
JMS Palette
Input Item
Datatype
Description
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
Output
The output for the activity is the following.
Output Item
Datatype
Description
MessageID
string
The unique identifier of the
message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JMSInvalidInputException
Input to the activity is not valid.
JMSMessageCreateException
The JMS message could not be created.
JMSSessionCreateException
The JMS session could not be created.
JMSSendException
The JMS send operation failed.
JMSActivityException
This activity fails.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Publisher 409
|
JMS Topic Publisher
Activity
The JMS Topic Publisher sends a message to the specified JMS topic.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JMS
Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a JMS
connection.
Destination
Topic
Yes
Name of the topic of the outgoing message.
Description
The syntax of the topic name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about topic
names.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
410
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Message
Type
No
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 (use the
Binary datatype to map this data), or a string.
Each item can be accessed sequentially or by its
name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Reply-to Topic
Yes
Description
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.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Publisher 411
|
Field
Global
Var?
Description
Delivery Mode
Yes
The delivery mode of the message. Can be one of
the following:
JMSExpiration
(secs)
Yes
•
PERSISTENT — signifies the messages are
stored and forwarded.
•
NON_PERSISTENT — messages are not
stored and may be lost due to failures in
transmission.
•
EMS_RELIABLE_DELIVERY — this mode is
only available when using TIBCO Enterprise
Message Service. See the TIBCO Enterprise
Message Service documentation for more
information about this mode.
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
Yes
Priority of the message. You may set the priority
to a value from 0-9. The default value is 4.
Type
Yes
The value to supply to the JMSType header
property.
JMS
Application
Properties
No
Any application-specific message properties to
include in the message. This is specified by the
JMS Application Properties shared configuration
resource.
Once specified, these properties appear on the
Output tab as OtherProperties.
Override
Transaction
Behavior
Yes
Overrides the default behavior of a transaction
group. If this activity is in a transaction group, the
JMS message is normally committed or rolled
back with the other participants in the transaction.
If this checkbox is checked, the JMS message does
not participate in the transaction.
TIBCO ActiveMatrix BusinessWorks Palette Reference
412
| Chapter 9
JMS Palette
Input Editor
The Input Editor tab defines the schema to use for outgoing messages whose
message type is Map, Stream, or XML Text. Map messages are name/value pairs,
and the schema allows you to define the structure of the outgoing message. Once
defined, the schema on the Input Editor tab becomes the structure used for the
body of the message displayed on the Input tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
destinationTopic
string
The topic to which to send the request. This
input item overrides the Destination 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.
JMSExpiration
integer
Specifies how long the message can remain
active (in seconds). If set to 0, the message
does not expire.
JMSPriority
string
The priority of the message. This item
overrides the priority set on the Advanced
tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Publisher 413
|
Input Item
Datatype
Description
JMSDeliveryMode
string
The delivery mode of the message. Can be
one of the following:
•
PERSISTENT
•
NON_PERSISTENT
•
When using TIBCO Enterprise Message
Service, the JMSDeliveryMode header
can be RELIABLE_DELIVERY. See the
TIBCO Enterprise Message Service
documentation for more information
about this mode.
— signifies the messages
are stored and forwarded.
— messages are not
stored and may be lost due to failures in
transmission.
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 in a reply message.
JMSType
string
The type of the message. This item overrides
the value specified on the Advanced tab.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
414
| Chapter 9
JMS Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
MessageID
string
The unique identifier of the
message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JMSInvalidInputException
Input to the activity is not valid.
JMSMessageCreateException
The JMS message could not be created.
JMSSessionCreateException
The JMS session could not be created.
JMSSendException
The JMS send operation failed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Requestor 415
|
JMS Topic Requestor
Activity
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.
This activity uses temporary destinations to ensure that reply messages are
received only by the process that sent the request.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
JMS Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a
JMS connection.
Destination
Topic
Yes
Name of the topic of the outgoing message.
The syntax of the topic name is specific to the
JMS provider you are using. See your JMS
provider documentation for more information
about topic names.
Note: If you are using TIBCO Enterprise
Message Service as your JMS provider, you can
use the Browse button next to this field after
specifying a valid connection in the JMS
Connection field. The Browse button displays a
list of configured destinations in the JMS server
that are appropriate for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
416
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Message Type
No
The type of the message. This can be one of the
following:
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
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 (use the Binary datatype to map this
data), or a string. Each item can be accessed
sequentially or by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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 Topic Requestor 417
|
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Delivery Mode
Yes
JMSExpiration
(secs)
Yes
Description
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.
•
EMS_RELIABLE_DELIVERY — this mode is
only available when using TIBCO Enterprise
Message Service. See the TIBCO Enterprise
Message Service documentation for more
information about this mode.
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
Yes
Priority of the message. You may set the priority
to a value from 0-9. The default value is 4.
Type
Yes
The value to supply to the JMSType header
property.
JMS
Application
Properties
No
Any application-specific message properties to
include in the message. This is specified by the
JMS Application Properties shared configuration
resource.
Once specified, these properties appear on the
Output tab as OtherProperties.
TIBCO ActiveMatrix BusinessWorks Palette Reference
418
| Chapter 9
JMS Palette
Input Editor/Output Editor
The Input Editor/Output Editor tabs define the schema to use for messages of
type Map, Stream, or XML Text. 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 Editor tab becomes the body of
the message on the Input tab. The schema defined on the Output Editor tab
becomes the body of the message on the Output tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input/Output Edtior tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
destinationTopic
string
The topic to which to send the request. This
input item overrides the Destination Topic
field on the Configuration tab.
JMSExpiration
integer
Specifies how long the message can remain
active (in seconds). If set to 0, the message
does not expire.
JMSPriority
string
The priority of the message. This item
overrides the priority set on the Advanced
tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Requestor 419
|
Input Item
Datatype
Description
JMSDeliveryMode
string
The delivery mode of the message. Can be
one of the following:
•
PERSISTENT
•
NON_PERSISTENT
•
When using TIBCO Enterprise Message
Service, the JMSDeliveryMode header
can be RELIABLE_DELIVERY. See the
TIBCO Enterprise Message Service
documentation for more information
about this mode.
— signifies the messages
are stored and forwarded.
— messages are not
stored and may be lost due to failures in
transmission.
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 exists in a reply message, but
you can set this element to any value.
JMSType
string
The type of the message. This item overrides
the value specified on the Advanced tab.
requestTimeout
integer
The time to wait (in seconds) for the
synchronous request-reply operation to
complete. An error is returned if the
operation does not complete in this time
limit.
replyToTopic
string
The destination to use for replies for this
activity.
Note: If more than one job has the same
replyToDestination (for example, you
specify a constant in this field), then the
correct reply may not be received by each
job. Make certain that you specify an
expression in this field that assigns a
different replyToDestination to each process
instance.
TIBCO ActiveMatrix BusinessWorks Palette Reference
420
| Chapter 9
JMS Palette
Input Item
Datatype
Description
JMSProperties
complex
The message properties. See JMS Properties
on page 385 for more information about
message properties.
Only properties applicable to this type of
message are displayed.
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message.
See JMS Properties on page 385 for more
information about message header fields.
Only properties applicable to this type of
message are displayed.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Requestor 421
|
Output Item
Datatype
Description
OtherProperties
complex
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 resource.
Body
depends
upon
message
type
The body of the message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JMSInvalidInputException
Input to the activity is not valid.
JMSMessageCreateException
The JMS message could not be created.
JMSSessionCreateException
The JMS session could not be created.
JMSSendException
The JMS send operation failed.
JMSReceiveException
The JMS receive operation failed.
ActivityTimedOutException
This activity has reached the specified
time out and the response has not been
received.
TIBCO ActiveMatrix BusinessWorks Palette Reference
422
| Chapter 9
JMS Palette
JMS Topic Subscriber
Process Starter
Starts a process based on the receipt of a message for the specified JMS
topic.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JMS
Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a JMS
connection.
Destination
Topic
Yes
Name of the topic of the incoming message.
Description
The syntax of the topic name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about topic
names.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Subscriber 423
|
Field
Global
Var?
Message Type
Description
The type of the message. This can be one of the
following:
Durable
Subscription
Yes
Subscription
Name
Yes
•
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 (use the
Binary datatype to map this data), or a string.
Each item can be accessed sequentially or by its
name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
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.
The subscription name registered with the JMS
application for durable subscriptions. This field is
only available when the Durable Subscription field
is checked.
Once a durable subscription is created, it can only
be removed by accessing the administration tool of
the JMS provider. See the documentation of your
JMS provider for more information about managing
durable subscriptions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
424
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Suppress
Local
Messages
Yes
Specifies to not receive messages on the specified
topic name when the message origin is 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 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
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
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. If the
message is not confirmed before the process
instance ends, the message is redelivered and a
new process instance is created to handle the
new incoming message. Ensure that your
process definition confirms the message when
using this acknowledge mode.
•
TIBCO EMS Explicit — this mode behaves
exactly the same as the Client mode, except the
session is not blocked and one session can
handle all incoming messages. This mode is
only available when using TIBCO EMS.
•
TIBCO EMS No Acknowledge — messages
delivered using this mode do not require
acknowledgement. Therefore messages in this
mode will not be redelivered regardless of
whether the delivery was successful. This mode
is only available when using TIBCO EMS.
JMS Topic Subscriber 425
|
Field
Global
Var?
Description
Acknowledge
Mode
Yes
•
Dups OK — the message is acknowledged
automatically when it is received. JMS provides
this mode for lazy acknowledgement, but
TIBCO ActiveMatrix BusinessWorks
acknowledges messages upon receipt.
•
Transactional — this mode is used when a
transaction that can process JMS messages is
included in the process definition. The message
is acknowledged when the transaction commits.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
creating transactions that JMS activities can
participate in.
•
Local Transactional — this mode is used when a
transaction involves only JMS messages. See
TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
creating transactions that JMS activities can
participate in.
Max Sessions
(Read Only)
No
When the Acknowledge Mode field is set to
"Client", "Transactional" or "Local Transactional",
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
actively listen for new messages until each message
is confirmed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
426
| Chapter 9
JMS Palette
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Message Selector
Yes
Description
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
Properties
No
Any application-specific message properties to include in the
message. This is specified by the JMS Application Properties shared
configuration resource.
Once specified, these properties appear on the Output tab as
OtherProperties.
Receiver Timeout
(seconds)
No
Specifies the polling interval to check for new messages. This
default interval is set by the custom engine property
bw.plugin.jms.receiverTimeout. If no value is specified for the
property, the default polling interval is one second.
Set a value in this field to specify the polling interval (in seconds)
for this activity. The value in this field overrides the default polling
interval.
Precreate
Transactions
No
When checked, this field specifies that the transaction is created
before a message arrives at the JMS receiver.
XA Transaction
Manager
Reference
No
Specifies the XA Transaction Manager Configuration used to create
the XA transaction. This field is available when Precreate
Transactions field is checked.
TIBCO ActiveMatrix BusinessWorks Palette Reference
JMS Topic Subscriber 427
|
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value are executed sequentially in the order the
process instances were created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output Editor
The Output Editor tab defines the schema to use for incoming messages whose
message type is Map, Stream, or XML Text. 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 Output Editor tab becomes the structure used for the
body of the message displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See
JMS Properties on page 385 for more
information about message header fields.
TIBCO ActiveMatrix BusinessWorks Palette Reference
428
| Chapter 9
JMS Palette
Output Item
Datatype
Description
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
OtherProperties
complex
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 resource.
Body
depends
upon the
message
type
The body of the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Reply To JMS Message 429
|
Reply To JMS Message
Activity
The Reply To JMS Message activity sends a reply to a previously
received JMS queue or topic message. Activities that can receive JMS
messages are listed on the Configuration tab. The activity that you
select determines which message the reply message is in response to.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Reply To
No
A drop down list of activities that can receive
JMS queue or topic messages. The activity you
select determines the 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.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
430
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Message Type
No
The type of the message. This can be one of the
following:
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
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
(use the Binary datatype to map this data), or
a string. Each item can be accessed
sequentially or by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
Reply To JMS Message 431
|
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Delivery Mode
Yes
JMSExpiration
(secs)
Yes
Description
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.
•
EMS_RELIABLE_DELIVERY — this mode is
only available when using TIBCO Enterprise
Message Service. See the TIBCO Enterprise
Message Service documentation for more
information about this mode.
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
Yes
Priority of the message. You may set the priority
to a value from 0-9. The default value is 4.
Type
Yes
The value to supply to the JMSType header
property.
JMS
Application
Properties
No
Any application-specific message properties that
will be part of the message. This is specified by
the JMS Application Properties shared
configuration resource.
Once specified, these properties appear on the
Output tab as "OtherProperties".
TIBCO ActiveMatrix BusinessWorks Palette Reference
432
| Chapter 9
JMS Palette
Input Editor
The Input Editor tab defines the schema to use for outgoing replies where the
message type is Map, Stream, or XML Text. Map messages are name/value pairs,
and the schema allows you to define the structure of the outgoing message. Once
defined, the schema on the Input Editor tab becomes the structure used for the
body of the message displayed on the Input tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
JMSPriority
string
Priority of the message. You may set the
priority to a value from 0-9. This item
overrides the value specified on the
Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Reply To JMS Message 433
|
Input Item
Datatype
Description
JMSCorrelationID
string
This ID is used to link a response message
with its related request message. This
property is usually set to the message ID of
the message you are replying to, but any
value can be used. For example, you may use
another field in the body of the message
(such as orderID) to correlate request and
reply messages.
The JMSCorrelationID of the reply message
is set in this input element. If this element is
not set, the correlation ID is set as follows:
•
If the JMSCorrelationID input element is
not set, the value of the
JMSCorrelationID property in the
message you are replying to is used.
•
If neither this input element nor the
JMSCorrelationID of the message you are
replying to are set, the message ID of the
message you are replying to is used.
•
If none of the above values are set, the
JMSCorrelationID of the reply message is
set to null.
JMSType
string
The type of the message. This item overrides
the value specified on the Advanced tab.
JMSProperties
complex
The message properties for the message. See
JMS Properties on page 385 for more
information about message properties.
Only properties applicable to this type of
message are displayed.
OtherProperties
complex
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
434
| Chapter 9
JMS Palette
Input Item
Datatype
Description
Body
depends
upon
message
type
The body of the message.
Output
The activity has no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
JMSInvalidInputException
Input to the activity is not valid.
JMSMessageCreateException
The JMS message could not be created.
JMSSessionCreateException
The JMS session could not be created.
JMSSendException
The JMS send operation failed.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for JMS Queue Message 435
|
Wait for JMS Queue Message
Activity
The Wait for JMS Queue Message waits for the receipt of a
message for the specified JMS queue.
See Scalability With Incoming Events on page 226 in TIBCO
ActiveMatrix BusinessWorks Process Design Guide for information
on running the "Wait for..." activities in a multi-engine mode. See Using Wait for
JMS Queue Message Activity in Multi-Engine Design on page 447 for more details
on using the activity in a multi-engine design.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
JMS
Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a
JMS connection.
Destination
Queue
Yes
Name of the queue of the incoming message.
Description
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.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
436
| Chapter 9
JMS Palette
Field
Global
Var?
Message Type
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
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 (use
the Binary datatype to map this data), or a
string. Each item can be accessed sequentially
or by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
Wait for JMS Queue Message 437
|
Field
Global
Var?
Description
Acknowledge
Mode
Yes
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. If
the message is not confirmed before the
process instance ends, the message is
redelivered. Ensure that your process
definition confirms the message when using
this acknowledge mode.
•
TIBCO EMS Explicit Client Acknowledge —
(only available for TIBCO EMS) the message
will be acknowledged at a later point by using
the Confirm activity. The session is not blocked
and one session handles all incoming messages
for each process instance. If a message is not
confirmed before the process instance ends, all
messages received in the same session are
redelivered.
•
Dups OK — the message is acknowledged
automatically when it is received. JMS
provides this mode for lazy acknowledgement,
but TIBCO ActiveMatrix BusinessWorks
acknowledges messages upon receipt.
•
Transactional — this mode is used when a
transaction that can process JMS messages is
included in the process definition. The
message is acknowledged when the
transaction commits. See TIBCO ActiveMatrix
BusinessWorks Process Design Guide for more
information about creating transactions that
JMS activities can participate in.
TIBCO ActiveMatrix BusinessWorks Palette Reference
438
| Chapter 9
JMS Palette
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Message Selector
Yes
Description
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
Properties
No
Any application-specific message properties
that will be part of the message. This is
specified by the JMS Application Properties
shared configuration resource.
Once specified, these properties appear on the
Output tab as "OtherProperties".
Receiver
Timeout
(seconds)
No
Specifies the polling interval to check for new
messages. This default interval is set by the
custom engine property
bw.plugin.jms.receiverTimeout. If no
value is specified for the property, the default
polling interval is one second.
Set a value in this field to specify the polling
interval (in seconds) for this activity. The value
in this field overrides the default polling
interval.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for JMS Queue Message 439
|
Message Event
The Event tab has the following fields.
Field
Description
Candidate Event Key
Expression built from the data of the incoming file
change event. This expression must 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 key match, then the process accepts the
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. Place the JMSCorrelationID from the
header of the incoming message into the Candidate
Event Key field, then place the JMSMessageID from
the header of the sent message in the "key" field on
the input tab.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO ActiveMatrix
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 waits if it is received before
this activity is executed. If the event timeout expires,
an error is logged and the event is discarded.
If no value is specified in this field, the message
waits indefinitely. If zero is specified, the event is
discarded immediately, unless this activity has
already been executed.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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 JMS Queue Message activity proceeds.
TIBCO ActiveMatrix BusinessWorks Palette Reference
440
| Chapter 9
JMS Palette
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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
Message Event on page 439 for an
example of using the Candidate
Event Key field with the key input
item.
processTimeout
integer
The time (in milliseconds) to wait
for the incoming message. An error
is returned if the message is not
received in this time limit.
Output Editor
The Output Editor tab defines the schema to use for incoming messages whose
message type is Map, Stream, or XML Text. 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 Output Editor tab becomes the structure used for the
body of the message displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the
message. See JMS Properties on
page 385 for more information
about message header fields.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for JMS Queue Message 441
|
Output Item
Datatype
Description
JMSProperties
complex
The message properties for the
message. See JMS Properties on
page 385 for more information
about message properties.
OtherProperties
complex
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
resource.
Body
depends
upon the
message
type
The body of the message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ActivityTimedOutException
The activity has reached the event or
process timeout.
TIBCO ActiveMatrix BusinessWorks Palette Reference
442
| Chapter 9
JMS Palette
Wait for JMS Topic Message
Activity
The Wait for JMS Topic Message waits for the receipt of a message
for the specified JMS topic.
See Scalability With Incoming Events on page 226 in TIBCO
ActiveMatrix BusinessWorks Process Design Guide for information on
running the "Wait for..." activities in a multi-engine mode.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
JMS Connection
No
The JMS connection. See JMS Connection on
page 376 for more information about creating a
JMS connection.
Destination Topic
Yes
Name of the topic of the outgoing message.
Description
The syntax of the topic name is specific to the
JMS provider you are using. See your JMS
provider documentation for more information
about topic names.
Note: If you are using TIBCO Enterprise
Message Service as your JMS provider, you can
use the Browse button next to this field after
specifying a valid connection in the JMS
Connection field. The Browse button displays
a list of configured destinations in the JMS
server that are appropriate for this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for JMS Topic Message 443
|
Field
Global
Var?
Description
Message Type
No
The type of the message. This can be one of the
following:
Durable
Subscription
Yes
Subscription
Name
Yes
•
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 (use the Binary datatype to
map this data), or a string. Each item can
be accessed sequentially or by its name.
•
Object — A serializable Java object.
•
Object Ref — An object reference to a 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.
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.
The subscription name registered with the JMS
application for durable subscriptions. This
field is only available when the Durable
subscription field is checked.
Once a durable subscription is created, it can
only be removed by accessing the
administration tool of the JMS provider. See
the documentation of your JMS provider for
more information about managing durable
subscriptions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
444
| Chapter 9
JMS Palette
Field
Global
Var?
Description
Suppress Local
Messages
No
Specifies to not receive messages on the
specified topic name when the message origin
is 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
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
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
The acknowledge mode for incoming
messages. Can be one of the following:
•
Auto — the message is automatically
acknowledged when it is received.
•
TIBCO EMS Explicit Client Acknowledge
— (only available for TIBCO EMS) the
message will be acknowledged at a later
point by using the Confirm activity. The
session is not blocked and one session
handles all incoming messages for each
process instance. If a message is not
confirmed before the process instance
ends, all messages received in the same
session are redelivered.
•
Dups OK — the message is acknowledged
automatically when it is received. JMS
provides this mode for lazy
acknowledgement, but TIBCO
ActiveMatrix BusinessWorks
acknowledges messages upon receipt.
Wait for JMS Topic Message 445
|
Advanced
The Advanced tab has the following fields.
Field
Message
Selector
Global
Var?
Yes
Description
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
Properties
No
Any application-specific message properties to
include in the message. This is specified by the
JMS Application Properties shared configuration
resource.
Once specified, these properties appear on the
Output tab as OtherProperties.
Receiver
Timeout
(seconds)
No
Specifies the polling interval to check for new
messages. This default interval is set by the
custom engine property
bw.plugin.jms.receiverTimeout. If no value
is specified for the property, the default polling
interval is one second.
Set a value in this field to specify the polling
interval (in seconds) for this activity. The value
in this field overrides the default polling
interval.
TIBCO ActiveMatrix BusinessWorks Palette Reference
446
| Chapter 9
JMS Palette
Message Event
The Event tab has the following fields.
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 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.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO ActiveMatrix
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 waits if it is received before
this activity is executed. If the event timeout expires,
an error is logged and the event is discarded.
If no value is specified in this field, the message
waits indefinitely. If zero is specified, the event is
discarded immediately, unless this activity has
already been reached.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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 JMS Topic Message activity proceeds.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for JMS Topic Message 447
|
Using Wait for JMS Queue Message Activity in Multi-Engine Design
All "Wait for ..." activities start listening from the time the bwengine loads and
can be configured to filter static data. These activities cannot filter dynamic data.
The activity pulls all the messages that are in the queue upon startup and
processes them according to the Event key. Any messages that were picked up but
do not match the key are discarded. A Wait for JMS Queue Message Activity
cannot be used with the Candidate Event key as the key is applied after receiving
the message from the queue.
In a multi-engine environment, when new messages arrive on the queue, the
messages are dispatched among all active listeners in a round-robin fashion. Thus
an engine may potentially pick up the message which was intended for some
other engine, and later discard the message because of a mismatch in the Event
key.
It is recommended that you use the Wait for JMS Queue Message activity with the
Message Selector in a multi-engine mode. The Message Selector is applied while
browsing the queue before picking up the messages.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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
Message Event on page 446 for an
example of using the Candidate
Event Key field with the key input
item.
processTimeout
integer
The time (in milliseconds) to wait
for the incoming message. An error
is returned if the message is not
received in this time limit.
TIBCO ActiveMatrix BusinessWorks Palette Reference
448
| Chapter 9
JMS Palette
Output Editor
The Output Editor tab defines the schema to use for incoming messages whose
message type is Map, Stream, or XML Text. 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 Output Editor tab becomes the structure used for the
body of the message displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the
message. See JMS Properties on
page 385 for more information
about message header fields.
JMSProperties
complex
The message properties for the
message. See JMS Properties on
page 385 for more information
about message properties.
OtherProperties
complex
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
resource.
Body
depends
upon the
message
type
The body of the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for JMS Topic Message 449
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ActivityTimedOutException
The activity has reached the event or
process timeout.
TIBCO ActiveMatrix BusinessWorks Palette Reference
450
| Chapter 10
Mail Palette
Chapter 10
Mail Palette
The Mail palette is used to receive incoming email or send outgoing email.
Topics
•
Receive Mail, page 451
•
Send Mail, page 459
TIBCO ActiveMatrix BusinessWorks Palette Reference
Receive Mail 451
|
Receive Mail
Process Starter
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
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the
activity in the process definition.
Description
No
Short description of the activity.
Host
Yes
Host name or IP address for the mail
server.
Description
The default port (110) is used to connect to
POP3 the server. If your server is
configured to use a different port, you can
specify it in this field using the syntax:
<hostName>:<portNumber>
For example,
myMailServer.myCo.com:76
User Name
Yes
User name to use when logging into the
POP3 server.
Password
Yes
Password to use when logging into the
POP3 server.
Polling Interval (sec)
Yes
Polling interval (in seconds) to check for
new mail. The default, if no polling
interval is specified, is 5 seconds.
TIBCO ActiveMatrix BusinessWorks Palette Reference
452
| Chapter 10
Mail Palette
Field
Global
Var?
Description
Delete Mail
Yes
If checked, mail will be deleted from the
POP3 server once the process starter has
retrieved it.
Note: If you choose to delete mail, you
should place a Checkpoint activity
immediately after the Receive Mail process
starter to ensure the message is not lost in
the event of machine failure.
Alternatively, you can choose to leave this
field unchecked, and then later in the
process definition perform a checkpoint
then use the Confirm activity to confirm
the message. The Confirm activity will
delete the message from the mail server.
Upgrade
Configuration
No
This field only appears in Mail palette
resources placed into process definitions
prior to release 5.2.0. In previous releases,
attachments were lists in the input of the
activity. In release 5.2.0 or later, a new
schema is used to handle MIME
attachments.
If you have a Mail palette resource created
prior to release 5.2.0, this field should be
unchecked to maintain backward
compatibility. This field does not appear
for new resources created in release 5.2.0
or later. Unchecking this field disables the
Advanced and Output Headers tab and
changes the output schema.
Test Connection Button
The Test Connection button tests the connection to the specified mail server. You
can use this button to ensure that your Receive Mail activity is properly
configured to receive mail from the specified mail server. This button is only
enabled when the Host, Username, and Password fields on the Configuration tab
are populated.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Receive Mail 453
|
Advanced
The Advanced tab contains the following fields:
Field
Description
Provide Raw
Message
When checked, this field specifies that the whole message is to
be provided in binary form. The output schema changes to
include an element named rawMessage that contains the
message instead of bodyText and mimeEnvelopeElements.
The Receive Mail process starter uses the javax.mail API.
This API assumes that the content type of the message is
multipart/mixed. When the multipart subtype is not mixed
(such as multipart/signed or multipart/alternative) or
when another content type is used (for example
application/*), the javax.mail API may not correctly parse
the message. Checking this field allows you to send the raw
message to a Java Code activity that uses the Java Activation
framework to implement the appropriate handlers to process
the message. For more information on how the Java Activation
framework can be used for this purpose, please consult the
API documentation for javax.activation and javax.mail.
You can also feed the binary message to the
constructor in the form of a
java.io.InputStream to construct a MimeMessage object. In
that case, the default javax.mail API handler is used.
javax.mail.MimeMessage
Write to File
Checking this field specifies that incoming messages whose
body and attachments (or raw message size if the Provide Raw
Message field is checked) exceed the specified threshold size
should be written to a file instead of stored in memory. This
allows you to accept large incoming messages without
consuming a great deal of memory. When this field is checked,
the Directory and Threshold Size fields appear.
Leaving this field unchecked specifies that incoming messages
should be kept in memory.
Note: Once written, the files created by using this option are
not deleted automatically. You must manage the storage used
by these files and delete them when they are no longer used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
454
| Chapter 10
Mail Palette
Field
Description
Directory
The directory to write messages that are above the specified
threshold. The process engine does not attempt to create the
directory if the specified directory does not exist. Therefore,
create the directory before starting the process engine.
Create
Non-Existing
Directories
When checked, all directories in the path specified in the
Directory field are created, if they do not already exist.
Threshold
Message Data
Size
The maximum size (in bytes) of an incoming message that can
be kept in memory. Messages larger than the specified size are
written to a file in the specified directory. The file’s name is
output so that subsequent activities in the process definition
can access the file and read its contents.
If this field is unchecked and there are one or more directories
in the specified path in the Directory field that do not exist, an
exception is raised.
Specifying zero (0) in this field causes all incoming messages
to be saved to a file.
Output Headers
Incoming messages may have custom headers. The Output Headers tab allows
you to define a custom schema for the headers of the incoming mail messages.
You can specify any standard header supported by the javax.mail package. For
example, X-Mailer or X-Priority. Values of headers in the incoming message will
populate the corresponding output headers of the same name that you have
defined.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Output Headers tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Receive Mail 455
|
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
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.
replyTo
string
The reply to list of the email.
subject
string
The subject of the email.
sentdate
string
The date the email was sent.
TIBCO ActiveMatrix BusinessWorks Palette Reference
456
| Chapter 10
Mail Palette
Output Item
Datatype
Description
Fields available when the Upgrade Configuration field is checked
Headers
complex
This element contains the schema you
defined on the Output Headers tab. You
can specify custom headers that can be
included in incoming mail messages.
You can specify any standard header
supported by the javax.mail package.
For example, X-Mailer or X-Priority.
Values of headers in the incoming
message will populate the
corresponding output headers of the
same name that you have defined.
rawMessage
binary
The content of the message in binary
form. This element is only available
when the Provide Raw Message field on
the Advanced tab is checked.
bodyText
string
The text of the email message. The
Provide Raw Message field on the
Advanced tab must be unchecked for
this field to appear.
mimeEnvelopeElement
complex
This element contains the message
attachments. This element contains a
repeating element named mimePart
that contains each mime attachment.
The Provide Raw Message field on the
Advanced tab must be unchecked for
this field to appear.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Receive Mail 457
|
Output Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header
for each mimePart. Mime headers can
contain the following information:
•
content-disposition
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See
http://www.faqs.org/rfcs/rfc2045.htm
l for more information about MIME
headers and their syntax.
Note: When the content type is
specified as "text/*" (for example,
"text/xml"), the attachment content is
expected to be in either the textContent
output element or the file name storing
the attachment is expected to be in the
fileName output element. When the
content type is anything other than
"text/*", the attachment content is
expected to be in either the
binaryContent output element or the
file name storing the attachment is
expected to be in the fileName output
element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
458
| Chapter 10
Mail Palette
Output Item
Datatype
Description
binaryContent |
textContent | fileName
choice
This element contains the mime
attachment. The element can be one of
the following:
•
binaryContent — content of the
attachment when the attachment is
binary data.
•
textConetnt — content of the
attachment when the attachment is
text data.
•
fileName — the file name of the
attachment when the attachment is
stored in the file system (see
Advanced tab for more
information).
Fields available when the Upgrade Configuration field is unchecked
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.
Note: The attachmentNames and
attachmentData elements are
corresponding lists. That is, for each
item in the attachmentName element,
there must be a corresponding item in
the same position in the
attachementData list. For example, if
there are three attachments, both
elements must contain three items and
item in the attachmentNames element
corresponds to the element in the same
position in the attachmentData list.
attachmentData
binary
A list of attachments to the message.
contentType
string
The MIME content type specified in the
message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Mail 459
|
Send Mail
Activity
The Send Mail activity sends an email by way of a SMTP server.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Host
Yes
Host name for the SMTP server.
Description
The default port (25) is used to connect to the SMTP
server. If your server is configured to use a different
port, you can specify it in this field using the
syntax:
<hostName>:<portNumber>
For example, myMailServer.myCo.com:37
Authenticate
No
Specifies whether you wish to supply a user name
and password to authenticate to the mail server.
When checked, the User Name and Password fields
appear.
Note: The mail server must be configured to require
authentication for sending mail. If the mail server is
not configured to require authentication, the user
name and password are ignored.
User Name
Yes
User name to use when authenticating to the mail
server.
Password
Yes
Password to use when authenticating to the mail
server. Passwords entered in this field will be
encrypted when stored in the project.
TIBCO ActiveMatrix BusinessWorks Palette Reference
460
| Chapter 10
Mail Palette
Field
Global
Var?
Description
Upgrade
Configuration
No
This field only appears in Mail palette resources
placed into process definitions prior to release 5.2.0.
In previous releases, attachments were lists in the
input of the activity. In release 5.2.0 or later, a new
schema is used to handle MIME attachments.
If you have a Mail palette resource created prior to
release 5.2.0, this field should be unchecked to
maintain backward compatibility. This field does
not appear for new resources created in release 5.2.0
or later. Unchecking this field disables the Input
Headers tab and changes the input schema.
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
Description
Allow
Non-Standard
Email IDs
No
By default, email IDs specified in the to, from, cc,
bcc, or replyTo input elements must conform to
the RFC 822 standard for email addresses.
Checking this box allows you to specify email IDs
that do not conform to the RFC 822 standard. This
is useful if you wish to send mail to a server that
has extensions for sending email to devices such
as a fax machine.
For more information about email address syntax,
see http://www.faqs.org/rfcs/rfc822.html.
Note: When this field is unchecked, not all of the
RFC 822 syntax rules are enforced. For example,
addresses composed of simple names (with no
"@domain" part) are allowed. For more
information on enforcing RFC 822, see the
description of the strict flag of the parse
method of
javax.mail.internet.InternetAddress at
http://java.sun.com/products/javamail/javadoc
s/javax/mail/internet/InternetAddress.html.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Mail 461
|
Input Headers
You may wish to add custom headers to outgoing mail messages. The Input
Headers tab allows you to define a custom schema for the headers of the outgoing
mail message. You can specify any standard header supported by the javax.mail
package. For example, X-Mailer or X-Priority.
See Appendix A, Specifying Data Schema, on page 729 for a complete description
of using the Input Headers tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
462
| Chapter 10
Mail Palette
The input for the activity is the following.
Input Item
Datatype
Description
username
string
Username to use when authenticating to the
mail server.
Note: The mail server must be configured to
require authentication for sending mail. If
the mail server is not configured to require
authentication, the username and password
elements are ignored.
password
string
Password to use when authenticating to the
mail server.
from
string
The email address of the sender.
to
string
The recipient list for the email. This is a
repeatable element, so that you can send mail
to more than one recipient.
You can also supply a list of recipients in a
single string by using either a comma or a
semicolon (but not both in the same string) to
separate the recipients.
cc
string
The cc (carbon copy) list for the email. This is
a repeatable element, so that you can place
more than one recipient on the CC list.
You can also supply a list of CC recipients in
a single string by using either a comma or a
semicolon (but not both in the same string) to
separate the CC recipients.
bcc
string
The bcc (blind carbon copy) list for the email.
This is a repeatable element, so that you can
place more than one recipient on the BCC
list.
You can also supply a list of BCC recipients
in a single string by using either a comma or
a semicolon (but not both in the same string)
to separate the BCC recipients.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Mail 463
|
Input Item
Datatype
Description
replyTo
string
The reply to list for the email. This is a
repeatable element, so that you can place
more than one recipient on the reply to list.
You can also supply a reply to list in a single
string by using either a comma or a
semicolon (but not both in the same string) to
separate the addresses in the list.
subject
string
The subject of the email.
sentdate
string
The date stamp for the email.
Note: The email server supplies the actual
date stamp for the email, so this input item is
ignored. This item is deprecated and may be
removed in a future release. Do not attempt
to place a value in this input item.
Fields available when the Upgrade Configuration field is checked
bodyElement
complex
This element contains a choice element. You
can either supply the bodyText element or
the fileName element.
The bodyText element is a string containing
the body of the message. The fileName
element is the path and name of a file
containing the body of the message.
Headers
complex
This element contains the schema you
defined on the Input Headers tab. You can
specify custom headers for outgoing mail
messages.
You can specify any standard header
supported by the javax.mail package. For
example, X-Mailer or X-Priority.
If you wish to use attachments, make sure
the Content-Type header is specified as
multipart/* (where * is a valid subtype of
multipart).
TIBCO ActiveMatrix BusinessWorks Palette Reference
464
| Chapter 10
Mail Palette
Input Item
Datatype
Description
mimeEnvelope
Element
complex
This element contains the message
attachments. This element contains a
repeating element named mimePart that
contains each mime attachment.
mimeHeaders
complex
This element contains the mime header for
each mimePart. Mime headers can contain
the following information:
•
content-disposition — To suggest a
filename for an attachment, use
"*;filename=<filename>" in this element.
Note: E-mail servers may alter or choose
to ignore the suggested name.
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
See http://www.faqs.org/rfcs/rfc2045.html
for more information about MIME headers
and their syntax.
Note: When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is expected to be in either
the textContent input element or the file
name storing the attachment is expected to
be in the fileName input element. When the
content type is anything other than "text/*",
the attachment content is expected to be in
either the binaryContent input element or
the file name storing the attachment is
expected to be in the fileName input element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Mail 465
|
Input Item
Datatype
Description
binaryContent |
textContent |
fileName
choice
This element contains the mime attachment.
The element can be one of the following:
•
binaryContent — content of the
attachment when the attachment is
binary data.
•
textConetnt — content of the attachment
when the attachment is text data.
•
fileName — the file name of the
attachment when the attachment is
stored in the file system.
Fields available when the Upgrade Configuration field is unchecked
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.
Note: The attachmentNames and
attachmentData elements are corresponding
lists. That is, for each item in the
attachmentName element, there must be a
corresponding item in the same position in
the attachementData list. For example, if
there are three attachments, both elements
must contain three items and item in the
attachmentNames element corresponds to
the element in the same position in the
attachmentData list.
attachmentData
binary
A list of attachments to the message.
contentType
string
The MIME content type for the message. You
can specify a character encoding in this
element for the encoding of the body of the
message.
Output
This activity produces no output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
466
| Chapter 10
Mail Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
InvalidInputException
Input is not valid.
UnknownHostException
Mail server host name could not be resolved.
The exception contains the mail server host
name.
SendFailedException
The send operation failed for any reason.
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 467
Chapter 11
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 468
•
Working With Documents, page 472
•
Working With Tasks Assigned to a Role, page 473
•
Interaction With TIBCO InConcert, page 480
•
Assign Work, page 481
•
Get Work Status, page 490
•
Workflow Schema, page 494
•
Workflow Server Connection, page 496
•
Modify Work, page 498
•
Wait for Completion, page 503
TIBCO ActiveMatrix BusinessWorks Palette Reference
468
| Chapter 11
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 19 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 19 An example business process with manual work
TIBCO ActiveMatrix BusinessWorks Palette Reference
Overview of Manual Work 469
|
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 ActiveMatrix BusinessWorks Manual Work Organizer web interface
described in Working With Tasks Assigned to a Role on page 473. This task can
also be viewed or modified using the TIBCO InConcert tools and APIs.
Table 6 describes the two shared configuration resources used when configuring
activities in the Manual Work palette.
Table 6 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 478 for more
information about delegation and
routing. See the description of the
Advanced tab of Assign Work on
page 481 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
470
| Chapter 11
Manual Work Palette
Table 7 describes the general purpose of each of the activities in the Manual Work
palette.
Table 7 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 ActiveMatrix 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 472 and
Download Document on page 487 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Overview of Manual Work 471
|
Table 7 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
472
| Chapter 11
Manual Work Palette
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).
•
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 ActiveMatrix BusinessWorks provides
displays all data in 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Working With Tasks Assigned to a Role 473
|
Working With Tasks Assigned to a Role
TIBCO ActiveMatrix BusinessWorks provides a simple web interface for viewing
manual work tasks assigned to users. This interface is named the TIBCO
ActiveMatrix 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.
If the TIBCO ActiveMatrix BusinessWorks Manual Work plugin is available in
TIBCO Administrator and you authorized to use it, you can perform the
following tasks:
•
Exporting Users to TIBCO InConcert
•
Using a TIBCO InConcert Proxy Server
•
Logging In and Viewing the Task Lists
•
Acquiring Tasks
•
Working with Tasks in the Acquired List
•
Working with the Completed List
•
Administering Tasks
Exporting Users to TIBCO InConcert
The TIBCO ActiveMatrix BusinessWorks Manual Work Activities component
allows a pool of privileged users to work on Manual Work activities using the
Manual Work GUI. You define these users in the TIBCO Administrator GUI and
export them to TIBCO InConcert.
To specify authorized users, follow these steps:
1. Predefine the users and roles.
2. In TIBCO Administrator, click the BW Manual Work folder.
3. Select the TIBCO InConcert server name to which you wish to export users by
using the selection box to the left of the server name.
4. Click Export Users to Selected Servers.
5. Select the user(s) you wish to export using the selection box to the left of the
user(s).
6. Click Add.
7. Click OK.
TIBCO ActiveMatrix BusinessWorks Palette Reference
474
| Chapter 11
Manual Work Palette
If you export a single user, that user is then available with an associated
single-user pool to work with Manual Work activities.
If you export a role, the role and all users in it are exported as a pool with those
users in the pool.
If you export a role that includes a role hierarchy, the hierarchy is flattened during
export. For example, if you have a role North America that has two child roles
California and Arizona, all users that are members of one of the three roles will
become available as members of a North America pool. To explicitly create a
California pool for InConcert, export that role.
If you export a user (or role) that is already defined in InConcert, the export of a
user with the same name will not have any effect on the predefined user (or role).
If you delete some users or roles in TIBCO Administrator and then export all
users (or roles), the users or roles that were deleted will be deleted from
InConcert. In that case, the users’ acquired tasks are returned to the pool.
The user icdba is the predefined administrator user in InConcert. If you wish to
log into the TIBCO Manual Work Organizer as that user, you must create the user
explicitly in TIBCO Administrator.
When you export a user to InConcert
•
The original capitalization is used (though the user is displayed in lower case
only in TIBCO Administrator).
•
If you integrate with Corporate LDAP for users, the password exported is the
username.
Using a TIBCO InConcert Proxy Server
If you wish to use a TIBCO InConcert Proxy server, click the Use Proxy link in the
dialog that is displays when you select to export users or roles to InConcert. The
dialog expands as follows:
Follow these steps:
TIBCO ActiveMatrix BusinessWorks Palette Reference
Working With Tasks Assigned to a Role 475
|
1. Supply the username and password and the proxy port and host machine on
which the proxy server is running.
2. Click Refresh. The InConcert Server Name drop down is updated to include
all InConcert servers. You can now choose the server you wish to use and
enter the username and password for that server.
You can also click No
Proxy
at any time to return to the simple display.
Logging In and Viewing the Task Lists
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>:<port>/administrator/servlet/bwmanualwork
where <machine> is the name of the machine where the TIBCO Administrator
server is installed and <port> is the port assigned when TIBCO Administrator was
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.
•
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 in 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
476
| Chapter 11
Manual Work Palette
Table 8 describes the columns of the task lists.
Table 8 Task list columns
Column
Description
Show in List
Work Type
The name of the task (the name of the
Assign Work activity in the process
definition). This name is a link to the
task’s details.
Acquired
Ready
Completed
Manage
Work Name
The name of the TIBCO InConcert job
associated with this task.
Acquired
Ready
Completed
Manage
This name is assigned in the Work Name
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
can be Ready, Complete, or Acquired.
Acquired
Ready
Completed
Manage
Priority
The priority of the task. The priority can
be Low, Normal, or Urgent.
Acquired
Ready
Manage
Due Date
The due date for this task.
Acquired
Ready
Manage
Ready Date
The time the task was placed in the
Ready list.
Ready
Completed Date
The time the task was completed.
Completed
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 20 illustrates the task lists.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Working With Tasks Assigned to a Role 477
|
Figure 20 Task lists
You can select any task in 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 21 illustrates the task detail.
Figure 21 Task detail
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
478
| Chapter 11
Manual Work Palette
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.
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 in the last seven days.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Working With Tasks Assigned to a Role 479
|
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
acquired tasks)
Releases the task from a user’s Acquired list and puts
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
completed tasks)
Deletes the task from the completed list.
TIBCO ActiveMatrix BusinessWorks Palette Reference
480
| Chapter 11
Manual Work Palette
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 ActiveMatrix
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Assign Work 481
|
Assign Work
Activity
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
ActiveMatrix 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
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Work Details
The Workflow Schema shared configuration resource
that defines the data to supply to the user. See
Workflow Schema on page 494 for more information.
Server Details
The Workflow Server Connection shared
configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Connection on page 496 for more information.
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 the status of
the task to be Complete before continuing on to the
next activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
482
| Chapter 11
Manual Work Palette
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
Completion field is checked.
Advanced
The Advanced tab has the following fields.
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
ActiveMatrix 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
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Assign Work 483
|
The input for the activity is the following.
Input Item
Datatype
Description
Header
complex
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
the Configuration tab.
Details
complex
The data schema (specified by the
Work Details field on the
Configuration tab) for input to the
task.
ExtendedDetails
complex
The data schema (specified by the
Extended Details field on the
Advanced tab) to use for additional
data when delegating or routing
the task.
TIBCO ActiveMatrix BusinessWorks Palette Reference
484
| Chapter 11
Manual Work Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
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.
DueDate
date
The date when the task must be
completed.
ReadyDate
date
The date the task was placed into
the user or 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.
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 task.
Priority
string
The priority for the task. Can be
either "Low", "Normal", or
"Urgent".
TIBCO ActiveMatrix BusinessWorks Palette Reference
Assign Work 485
|
Output Item
Datatype
Description
TrackingInfo
complex
An element containing any
information about the routing or
delegation for the task. Each time
the task is routed or delegated, the
From element contains information
about the user that performed the
delegation or routing. The To
element contains a list describing
each user the task has been
delegated or routed to.
From
complex
Contains information about the
user that last performed a routing
or delegation operation on the task.
This element 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
486
| Chapter 11
Manual Work Palette
Output Item
Datatype
Description
To
complex
Contains a list detailing
information about each user that
the task has been routed or
delegated to. This element contains
strings with the following
information:
•
AssignedTo — the user the task
has been assigned to.
•
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.
Details
complex
The data schema for the task.
ExtendedDetails
complex
The data schema for additional
data when delegating or routing
the task.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
CannotEstablishConnection
An error occurred when connecting to the
server.
CommandTimeoutConnection
The timeout specified on the Configuration
tab has been reached.
AssignTaskError
An error occurred while executing this
activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Download Document 487
|
Download Document
Activity
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 472 for more information about working with a task’s documents.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
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.
Work Details
The Workflow Schema shared configuration resource
associated with the task. See Workflow Schema on
page 494 for more information.
Server Details
The Workflow Server Connection shared
configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Connection on page 496 for more information.
Download All
Document(s)
Specifies that all documents attached to this activity
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
488
| Chapter 11
Manual Work Palette
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
configuration.
WorkId
string
The system-assigned ID for the
task. You can obtain this from the
output of the Assign Work task.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Details
complex
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
Document
complex
The name of the Workflow
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.
content
binary
The content of the downloaded
document.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Download Document 489
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
DownloadDocumentError
An error occurred while executing this activity.
A list of the files that failed to download is
contained in the FailDownloadedFiles element
of this exception.
TIBCO ActiveMatrix BusinessWorks Palette Reference
490
| Chapter 11
Manual Work Palette
Get Work Status
Activity
The Get Work Status activity is used to retrieve the current status of
the specified manual task from the TIBCO InConcert server.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Use WorkId
Specifies that you wish to use the system-generated
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.
Work Details
The Workflow Schema shared configuration resource
associated with the task. See Workflow Schema on
page 494 for more information.
Server Details
The Workflow Server Connection shared
configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Connection on page 496 for more information.
Extended Details
The extended details (assigned on the Advanced tab
of the Assign Work activity) associated with this task.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Get Work Status 491
|
The input for the activity is the following.
Input Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
configuration.
WorkId
string
The system-assigned ID for the
task. You can obtain this from the
output of the Assign Work task.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
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.
DueDate
date
The date when the task must be
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
492
| Chapter 11
Manual Work Palette
Output Item
Datatype
Description
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.
Priority
string
The priority for the task. Can be
either "Low", "Normal", or
"Urgent".
TrackingInfo
complex
An element containing any
information about the routing or
delegation for the task. Each time
the task is routed or delegated, the
From element contains information
about the user that performed the
delegation or routing. The To
element contains a list describing
each user the task has been
delegated or routed to.
From
complex
Contains information about the
user that last performed a routing
or delegation operation on the task.
This element contains strings with
the following information:
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
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.
Get Work Status 493
|
Output Item
Datatype
Description
To
complex
Contains a list detailing
information about each user that
the task has been routed or
delegated to. This element contains
strings with the following
information:
•
AssignedTo — the user the task
has been assigned to.
•
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.
Details
complex
The data schema for the task.
ExtendedDetails
complex
The data schema for additional
data when delegating or routing
the task.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
GetWorkStatusError
An error occurred while executing this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
494
| Chapter 11
Manual Work Palette
Workflow Schema
Shared Configuration
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 11, Manual Work Palette, on
page 467 for more information about working with manual tasks.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the shared resource.
Parent Schema
A reference to another Workflow Schema that this
schema inherits its data from.
Input Editor
The Input 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 ActiveMatrix
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 ActiveMatrix BusinessWorks. The only exception is that the
schema is restricted as described above. See Appendix A, Specifying Data
Schema, on page 729 for a complete description of using the Input Editor tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Workflow Schema 495
|
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 Parent Schema field
on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
496
| Chapter 11
Manual Work Palette
Workflow Server Connection
Shared Configuration
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 11, Manual Work Palette, on
page 467 for more information about working with manual tasks.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the shared resource.
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.
Connect Using Java
Server
Specifies that the IcJava server is to be used.
Host
The host name of the IcJava server.
Java Server Name
The name of the IcJava server.
Port
The port number of the IcJava server.
Test Connection Button
The Test Connection button can be used to verify the connection using the
specified configuration.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Workflow Server Connection 497
|
Reload Servers Button
The Reload Servers button refreshes the list of servers in the drop down list of
TIBCO InConcert servers.
Advanced
The Advanced tab has the following fields.
Field
Description
Missed Event Polling
Interval
The polling interval for checking temporal events.
This is specified in minutes and seconds.
Workflow Operation
Timeout Period
Timeout for operations to complete.
TIBCO ActiveMatrix BusinessWorks Palette Reference
498
| Chapter 11
Manual Work Palette
Modify Work
Activity
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
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Use WorkId
Specifies that you wish to use the system-generated
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.
Work Details
The Workflow Schema shared configuration resource
associated with the task. See Workflow Schema on
page 494 for more information.
Server Details
The Workflow Server Connection shared
configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Connection on page 496 for more information.
Extended Details
The extended details (assigned on the Advanced tab
of the Assign Work activity) associated with this task.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Modify Work 499
|
Field
Description
Action
The action to perform on the activity to change its
status. The action can be one of the following:
Assign To
•
Update
•
Complete
•
Reassign
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
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
Header
complex
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
DelegatedWork
boolean
Specifies whether all routed and
delegated tasks should also be marked as
complete.
ReAssignTo
string
The name of the role to reassign this
manual task to. This input item overrides
the value specified on the Configuration
tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
500
| Chapter 11
Manual Work Palette
Input Item
Datatype
Description
DueDate
date
The date when the task must be
completed.
Priority
string
The priority for the task. Can be either
"Low", "Normal", or "Urgent".
Output
The output for the activity is the following.
Output Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
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.
DueDate
date
The date when the task must be
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.
AssignedTo
string
The role the task was assigned to.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Modify Work 501
|
Output Item
Datatype
Description
AcquiredBy
string
If the task was acquired before this
activity completes, this is the name
of the user that acquired the
activity.
Priority
string
The priority for the task. Can be
either "Low", "Normal", or
"Urgent".
TrackingInfo
complex
An element containing any
information about the routing or
delegation for the task. Each time
the task is routed or delegated, the
From element contains information
about the user that performed the
delegation or routing. The To
element contains a list describing
each user the task has been
delegated or routed to.
From
complex
Contains information about the
user that last performed a routing
or delegation operation on the task.
This element 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
502
| Chapter 11
Manual Work Palette
Output Item
Datatype
Description
To
complex
Contains a list detailing
information about each user that
the task has been routed or
delegated to. This element contains
strings with the following
information:
•
AssignedTo — the user the task
has been assigned to.
•
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.
Details
complex
The data schema for the task.
Extended Details
complex
The data schema for additional
data when delegating or routing
the task.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ModifyWorkError
An error occurred while executing this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Completion 503
|
Wait for Completion
Activity
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.
See Scalability With Incoming Events on page 226 in TIBCO ActiveMatrix
BusinessWorks Process Design Guide for information on running the "Wait for..."
activities in a multi-engine mode.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the activity in the
process definition.
Description
Short description of the activity.
Use WorkId
Specifies that you wish to use the system-generated
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.
Work Details
The Workflow Schema shared configuration resource
associated with the task. See Workflow Schema on
page 494 for more information.
Server Details
The Workflow Server Connection shared
configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Connection on page 496 for more information.
Extended Details
The extended details (assigned on the Advanced tab
of the Assign Work activity) associated with this task.
TIBCO ActiveMatrix BusinessWorks Palette Reference
504
| Chapter 11
Manual Work Palette
Field
Description
Wait Till
The amount of time to wait for the status of the task to
change.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
configuration.
WorkId
string
The system-assigned ID for the
task. You can obtain this from the
output of the Assign Work task.
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
the Configuration tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Header
complex
This item contains information
about the manual work task’s
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Completion 505
|
Output Item
Datatype
Description
DueDate
date
The date when the task must be
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.
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.
Priority
string
The priority for the task. Can be
either "Low", "Normal", or
"Urgent".
TrackingInfo
complex
An element containing any
information about the routing or
delegation for the task. Each time
the task is routed or delegated, the
From element contains information
about the user that performed the
delegation or routing. The To
element contains a list describing
each user the task has been
delegated or routed to.
TIBCO ActiveMatrix BusinessWorks Palette Reference
506
| Chapter 11
Manual Work Palette
Output Item
Datatype
Description
From
complex
Contains information about the
user that last performed a routing
or delegation operation on the task.
This element contains strings with
the following information:
To
Details
TIBCO ActiveMatrix BusinessWorks Palette Reference
complex
complex
•
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.
Contains a list detailing
information about each user that
the task has been routed or
delegated to. This element contains
strings with the following
information:
•
AssignedTo — the user the task
has been assigned to.
•
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.
The data schema for the task.
Wait for Completion 507
|
Output Item
Datatype
Description
Extended Details
complex
The data schema for additional
data when delegating or routing
the task.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
WaitForCompletionError
An error occurred while executing this activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
508
| Chapter 11
Manual Work Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 509
Chapter 12
Parse Palette
The Parse palette provides shared configuration resources and activities for
parsing and rendering formatted text. This is useful if you wish to transform
formatted lines of text into a data schema. This is also useful if you wish to
transform a data schema into a formatted text string.
The text lines can be formatted either by delimiters separating each field or offsets
can be specified to determine where each field begins and ends.
Topics
•
Data Format, page 510
•
Parse Data, page 516
•
Render Data, page 522
TIBCO ActiveMatrix BusinessWorks Palette Reference
510
| Chapter 12
Parse Palette
Data Format
Shared Configuration
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.
Figure 22 illustrates how an input text string is parsed into a specified data
schema.
Figure 22 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 22.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Data Format 511
|
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the shared resource.
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 Col Separator
field. Each line is separated by the character specified
in the Line Separator field. See Delimiter Separated
Fields on page 514 for more information.
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 514 for more
information.
Col Separator
This field specifies one or more separator characters
between columns when "Delimiter separated" is
specified in the Format Type field.
When rendering text, each element in the input data
schema is separated by the column separator in the
output text string. If more than one character is
specified in this field, the Render Data activity places
the entire string specified in this field between each
column. For example, if ":;" is specified in this field,
then ":;" appears between each column in the
rendered string.
When parsing text, each column becomes an element
in the output data schema. If more than one character
is specified in this field, the Parse Data activity uses
the rule specified in the Col Separator Parse Rule field
to determine how to parse the data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
512
| Chapter 12
Parse Palette
Field
Description
Col Separator Parse
Rule
Specifies the rule to use for multiple column separator
characters when parsing data. The choices are the
following:
•
Treat all characters as entered as a single column
separator string
The characters entered into the Col Separator field
are treated as a single string that acts as a
separator. For example, if the specified Col
Separator is ":;", then Apple:;Orange:;Pear is
treated as three columns.
•
Treat each character entered as a potential column
separator
Any of the characters will act as a column
separator. For example, if the specified Col
Separator is ":;", then Apple;Orange:Pear is
treated as three columns.
Line Separator
Specifies the character(s) that determine the end of
each line. This field allows you to define a custom line
separator. By default, new line, carriage return and
line feed are defined and can be selected from the
drop down list.
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.
The last line in your input file must be terminated by
the specified line separator.
Note that BusinessWorks does not support specifying
the line separator as part of the data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Data Format 513
|
Field
Description
Fill Character
When processing fixed format columns, this is the
type of character that is used to fill the empty space in
a column and between columns. This is only available
when "Fixed format" is specified in the Format Type
field. This fill character is only used by the Render
Data activity.
You can select one of the following for this field:
•
Space — fills with a space
•
Dash — fills will a dash
•
Others — allows you to specify your own custom
fill character in the Fill With 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.
Fill With
This field is only available when Others is selected in
the Fill Character field. This field specifies the fill
character to use to pad unused characters in
fixed-width columns.
Only one character can be specified. The first
character is the fill character and any other characters
specified in this field are ignored.
Data Format
The Data Format tab allows you to define a custom schema for the text.
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 Data Format tab is used to parse a text string into the specified schema or
render the specified schema as a text string.
Data Format does not support nested schema.You can only specify basic plain
schema with no nesting.
See Appendix A, Specifying Data Schema, on page 729 for a description of how to
define a schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
514
| Chapter 12
Parse Palette
Delimiter Separated Fields
When processing delimiter-separated text, each field in the input line is separated
by the delimiter specified by the Column Separator field. Leading and trailing
spaces are stripped from each field and the specified Line Separator determines
when a new record starts. Figure 22 illustrates an series of input lines containing
comma-separated fields, each record on one line.
In some situations, you may not be able to choose a column separator character
that does not appear in any column data. For example, if you choose a comma as
the column separator, there may be commas in some of the column values. To
process data that contains column separator characters in a column, you can
surround the column with double quotes (" "). Double quotes also allow you to
include leading and trailing spaces as well as line breaks in a field. If you wish to
have a double quote appear in a field, escape the double quote by using two
consecutive double quotes. That is, use "" to represent a double quote in a field.
The following data illustrates input lines with each field separated by commas.
Some fields, however, contain commas, leading or trailing spaces, double quotes,
and line breaks.
57643, Smith, "Chris", Accounting , "Statement: Be prepared!"
57644, Jones, "Pat ",
Marketing
, "Statement: To paraphrase
JFK, ""Ask not what your company can do for you,
ask what you can do for your company."""
57645, Walker, "Terry", Develpment , "Statement: My goal is to be
CEO someday."
Notice that Pat Jones’ statement spans two lines and contains double quotes as
well as a comma. The entire field is surrounded by double quotes, so it is still
treated as part of the same record.
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Data Format 515
|
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 ActiveMatrix 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
Figure 23 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 23 Fixed-width text strings and field offsets
TIBCO ActiveMatrix BusinessWorks Palette Reference
516
| Chapter 12
Parse Palette
Parse Data
Activity
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.
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
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Data Format
No
The Data Format shared configuration to use
when parsing the text input. See Data Format on
page 510 for more information.
Input Type
No
Specifies the type of input for this activity.
Description
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.
Encoding
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
The encoding of the input file. This field is only
available when "File" is chosen in the Input Type
field. Any valid Java encoding name can be used.
Parse Data 517
|
Field
Global
Var?
Description
Skip Blank
Lines
No
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.
Manually
Specify Start
Record
No
Strict
Validation
No
Allows you to specify the record in the input
where 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 520
for more information on how to read the input
stream in parts.
Validates every input line for the specified number
of fields for the "Fixed Format" text.
For example, if the format states that there are
three fields per line and this field is checked, all
lines in the input must contain three fields.
Continue on
Error
No
Continues parsing the next record in the input
after encountering an error, if any.
If an error occurs, the error information is
separated from the output of the successfully
parsed records and is provided in the output
schema of the activity. See Output on page 519 for
more information on how the error information for
the records that failed parsing is provided.
When this field is unchecked, parse data activity
quits parsing if an error is encountered while
parsing the records in the input.
Irrespective of whether this field is checked or not,
the Parse Data activity quits when any data
validation errors occur.
TIBCO ActiveMatrix BusinessWorks Palette Reference
518
| Chapter 12
Parse Palette
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
text
string
The text string to parse. This input
item is only available when "String"
is specified in the Input Type field
on the Configuration tab.
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 1 (one).
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 520 for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Parse Data 519
|
Input Item
Datatype
Description
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
Parsing a Large Number of Records
on page 520 for more information.
SkipHeaderCharacters
integer
The number of characters to skip
when parsing. This allows you to
skip over any file headers or other
unwanted information.
Output
The output for the activity is the following.
Output Item
Datatype
Description
Rows
complex
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 in this
output item.
schema
complex
The schema containing the data
from the parsed input text. This
output item contains zero or more
parsed records.
TIBCO ActiveMatrix BusinessWorks Palette Reference
520
| Chapter 12
Parse Palette
Output Item
Datatype
ErrorRows
Description
This output item is available when
Continue on Error is checked, and
error(s) while parsing the records in
the input.
<<raw input data is put in the error
string>>
This field contains the list of error
lines for the records from the input
that failed parsing.
EOF
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
page 520 for more information.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
FileNotFoundException
The specified input file cannot be located.
BadDataFormatException
The input format is not valid.
Parsing a Large Number of Records
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Parse Data 521
|
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 tool bar to create
a group containing the Parse Data activity. See TIBCO ActiveMatrix
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 EOF 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
522
| Chapter 12
Parse Palette
Render Data
Activity
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
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in the
process definition.
Description
No
Short description of the activity.
Data Format
No
The Data Format shared configuration to use when
rendering the text output. See Data Format on
page 510 for more information.
Description
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
Rows
complex
The element containing the list of
items to render.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Render Data 523
|
Input Item
Datatype
Description
root
complex
The elementcomplex containing
data schema (specified by the Data
Format field on the Configuration
tab) to render as a text string. This
is a repeating element so that you
can render more than one output
record.
Output
The output for the activity is the following.
Output Item
Datatype
Description
text
string
The output text string as a result of
rendering the specified data
schema. Line breaks separate
records of the data schema.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
BadDataFormatException
The output format is not valid.
TIBCO ActiveMatrix BusinessWorks Palette Reference
524
| Chapter 12
Parse Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 525
Chapter 13
Policy Palette
The Policy palette allows you to specify security policies for inbound and
outbound SOAP messages. The security policies follow the Web Services Security:
SOAP Message Security 1.0 (WS-Security 2004) OASIS Standard 200401. You can
find out more about this standard at http://docs.oasis-open.org/wss/2004/01/.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about using the resources in the Policy palette.
Topics
•
Security Policy, page 526
•
Security Policy Association, page 533
TIBCO ActiveMatrix BusinessWorks Palette Reference
526
| Chapter 13
Policy Palette
Security Policy
Shared Configuration
The Security Policy shared configuration resource specifies a
security policy that can be used for inbound or outbound SOAP
messages. The security policy can include any combination of the
following characteristics:
•
Authentication — whether messages must be authenticated. Authentication
can be performed either with usernames and passwords or by way of X.509
compliant certificates.
•
Integrity — whether messages must be validated with a signature to ensure
the message has not been altered since its creation.
•
Confidentiality —whether messages should be encrypted or decrypted.
•
Timeout — whether messages should expire after a certain time.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about using security policies for web services.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Policy Type
No
Specifies the type of communication this policy
applies to. Select one of the following from the list
of choices:
Authentication
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
inbound
•
outbound
•
inbound fault
•
outbound fault
Check this box if you wish to specify that
authentication should be part of this policy.
Checking this box makes the fields on the
Authentication tab available for editing.
Security Policy 527
|
Field
Global
Var?
Description
Integrity
No
Check this box if you wish to specify that
messages should be signed or that signed
messages should be verified. Checking this box
makes the fields on the Integrity tab available for
editing.
Confidentiality
No
Check this box if you wish to specify that
messages should be encrypted and decrypted.
Checking this box makes the fields on the
Confidentiality tab available for editing.
Timeout
No
Check this box if you wish to add or verify
timestamps on messages. Checking this box
makes the fields on the Timeout tab available for
editing.
Custom
Password
Lookup
No
Check the box in this field if you wish to use your
own custom password lookup class. By default,
authentication is performed through TIBCO
Administrator. This field allows you to specify a
class for looking up passwords in your system,
such as a database, file system, or LDAP system.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about custom
password lookup.
Custom
Password
Callback Java
Class
No
This field specifies an AliasLibrary resource
containing your custom password lookup class
and any referenced classes (such as third-party
libraries to access an LDAP server).
Use the Browse button to locate the AliasLibrary
resource storing your class, then use the Show
Class Browser button in the Class field to locate
your class.
Authentication
The Authentication tab specifies the characteristics for authenticating to the SOAP
message server. Inbound messages can be authenticated against a list of trusted
certificates. Outbound messages can specify the identity to use to authenticate to
the external SOAP server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
528
| Chapter 13
Policy Palette
The Authentication tab has the following fields.
Field
Global
Var?
Description
Inbound or Inbound Fault Policy Type Fields
Supported
Security Tokens
Trusted
Certificates Folder
No
No
Specifies the security tokens you wish to allow
in inbound messages. You can select one or
more of the following supported types:
•
X.509 Token
•
UsernamePassword Token
Specifies the folder containing the trusted
certificates for binary security token
authentication.
Outbound or Outbound Fault Policy Type Fields
Security Token
No
Specifies the type of security tokens you wish
to allow in inbound messages. You can select
one of the following supported types:
•
X.509 Token
•
UsernamePassword Token
X.509 Identity
No
When X.509 Token is selected in the Security
Token field, this field specifies the Identity
resource containing the X.509 compliant
identity file. See TIBCO Designer Palette
Reference for more information about Identity
resources.
Username
Password Identity
No
When UsernamePassword Token is selected in
the Security Token field, this specifies the
Identity resource that contains the username
and password. See TIBCO Designer Palette
Reference for more information about Identity
resources.
Password Type
No
Specifies whether you wish to use text or digest
passwords.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Security Policy 529
|
Integrity
The Integrity tab specifies the characteristics of the signatures attached to
messages. Signatures can be used to ensure that messages are not altered after
creation. The integrity of inbound messages can be checked against the trusted
root certificates and the public certificate. Outbound messages can specify the
certificate to use to sign the outgoing message.
The Integrity tab has the following fields.
Field
Global
Var?
Description
Inbound or Inbound Fault Policy Type Fields
Supported Signature
Methods
Supported Security
Tokens
Trusted Certificates
Folder
No
No
No
Algorithm used to check the signatures of
incoming messages. You can select one or
more of the following:
•
SHA1
•
MD5
Specifies the security token to use for the
signature. You can select one or more of the
following:
•
X.509 Token
•
UsernameToken
Specifies the folder containing the trusted
certificates for signature verification.
Note: The certificates in the trusted folder
are only necessary in the case when the
authenticating user is same as the user that
signed the message. In this case, the
message contains the public key, so the
receiver must verify against the trusted
certificate. However, if the authenticating
user is not same as the user that signed the
message, the user must define a subject key
identity that holds the public key.
Subject Key Identity
No
Specifies an Identity resource containing a
keystore that holds an X.509 certificate. The
inbound message must match the subject
key contained in the certificate.
TIBCO ActiveMatrix BusinessWorks Palette Reference
530
| Chapter 13
Policy Palette
Field
Global
Var?
Description
Outbound or Outbound Fault Policy Type Fields
Signature Method
Security Token
No
No
Algorithm used to create signatures for
outgoing messages. You can select one or
more of the following:
•
SHA-1
•
MD-5
Specifies the type of security token to use
for the signature. You can select one or more
of the following:
•
X.509 Token
•
UsernameToken
Username Password
Identity
No
When UsernameToken is selected in the
Security Token field, this specifies the
Identity resource that contains the
username and password. See TIBCO
Designer Palette Reference for more
information about Identity resources.
Password Type
No
Specifies whether you wish to use text or
digest passwords.
X.509 Identity
No
When X.509 Token is selected in the Security
Token field, this field specifies the Identity
resource containing the X.509 compliant
identity file. See TIBCO Designer Palette
Reference for more information about
Identity resources.
Certificate Alias
No
When the Identity resource specified in the
X.509 Identity field is a JKS keystore, specify
the certificate alias in this field to identify
the private/public key pair.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Security Policy 531
|
Confidentiality
The Confidentiality tab specifies the encryption characteristics of messages.
Inbound messages can be decrypted based on algorithms specified in the message
security header and the defined private key. Outbound messages can be
encrypted based on algorithms stored in a public key.
The Confidentiality tab has the following fields.
Field
Global
Var?
Description
Inbound or Inbound Fault Policy Type Fields
Supported
Encryption
Algorithm
Private key
Identifier Type
No
No
Symmetric key algorithm used to decrypt
incoming messages. You can select one or
more of the following:
•
3DES
•
AES-128
•
AES-256
Specifies whether the private key is one of the
following:
•
X.509 Identity
No
X.509 Token
When X.509 Token is selected in the Private
Key Identifier Type field, this field specifies
the Identity resource containing the X.509
compliant private key file to use to decrypt
the message. See TIBCO Designer Palette
Reference for more information about Identity
resources.
Outbound or Outbound Fault Policy Type Fields
Encryption
Algorithm
No
Algorithm used to encrypt outgoing
messages. You can select one of the following:
•
3DES
•
AES-128
•
AES-256
TIBCO ActiveMatrix BusinessWorks Palette Reference
532
| Chapter 13
Policy Palette
Field
Global
Var?
Description
Public Key
No
Identity resource containing the X.509
compliant public key file to use to encrypt the
message. See TIBCO Designer Palette Reference
for more information about Identity
resources.
Timeout
The Timeout tab specifies the characteristics of message timeout. Inbound
messages can be rejected after the specified number of seconds. Outbound
messages can be set to expire after the specified number of seconds.
The Timeout tab has the following fields.
Field
Global
Var?
Description
Inbound or Inbound Fault Policy Type Fields
Reject After
(seconds)
No
The creation time of incoming messages is
compared to the time the message was
received. If the difference in time is greater
than the number of seconds specified in this
field, the message is rejected.
Outbound or Outbound Fault Policy Type Fields
Expire In
(seconds)
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Outgoing and error messages will expire after
the specified number of seconds.
Security Policy Association 533
|
Security Policy Association
Shared Configuration
The Security Policy Association shared configuration resource
associates a Security Policy with a particular Service operation or
SOAP resource in your project. This allows you to specify security
policies for inbound or outbound SOAP messages on a
per-operation or per-activity basis.
When a security policy is attached to a resource that receives SOAP messages (for
example, SOAP Event Source, or the reply message of a SOAP Request Reply
activity), the associated security policy is used for the incoming message. For
example, if authentication is specified in the security policy, then the identity of
the sender of incoming messages is checked against a list of trusted identities.
When a security policy is attached to a resource that sends SOAP messages (for
example, SOAP Request Reply, SOAP Send Fault, or SOAP Send Reply), the
security the associated security policy is used for the outgoing message. For
example, if encryption is specified in the security policy, the outgoing message is
encrypted before it is sent.
Security Policy Association shared configuration resources are not referenced by
resources in process definitions. Therefore, they are not automatically included in
Enterprise Archive files. You must manually add Security Policy Association
resources to the Shared Archive within an Enterprise Archive for the associations
to work properly in a deployed project. See TIBCO ActiveMatrix BusinessWorks
Administration for more information about adding resources to the Shared
Archive.
To run a project with security policy associations successfully, ensure that all the
policy associations in the project are valid. Any invalid associations must be
removed from the project before running the project.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the
resource.
Description
No
Short description of the shared resource.
Description
TIBCO ActiveMatrix BusinessWorks Palette Reference
534
| Chapter 13
Policy Palette
Field
Global
Var?
Description
Apply Policy To
No
The SOAP resources or Service operations to
which you wish to apply a Security Policy. Use
the Select button to choose the desired SOAP
resources or Service operations.
Only the appropriate policy fields are available
based on the selected resource. For example,
when you select a SOAP Event Source, only the
Inbound Message Policy field is available.
Inbound Message
Policy
No
A Security Policy resource that specifies the
security characteristics you wish to apply to
inbound messages.
Outbound
Message Policy
No
A Security Policy resource that specifies the
security characteristics you wish to apply to
outbound messages.
Inbound Fault
Message Policy
No
A Security Policy resource that specifies the
security characteristics you wish to apply to
inbound fault messages.
Outbound Fault
Message Policy
No
A Security Policy resource that specifies the
security characteristics you wish to apply to
outbound fault messages.
Inbound
The Inbound tab has the following fields.
Field
Message Elements
for Signature
Global
Var?
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
Specifies an XPath expression to select the
elements within the SOAP message that are
expected to have a signature. If the incoming
message does not have a signature for the
selected elements, an exception is thrown.
Security Policy Association 535
|
Field
Global
Var?
Description
Message Elements
for Encryption
No
Specifies an XPath expression to select the
elements within the SOAP message that are
expected to be encrypted. If the elements
selected in the incoming message are not
encrypted, an exception is thrown.
Outbound
The Outbound tab has the following fields.
Field
Global
Var?
Description
Message Elements
for Signature
No
Specifies an XPath expression to select the
elements of outgoing messages for which you
wish to include a signature, if a signature is
specified in the selected Security Policy
resource.
Message parts for
Encryption
No
Specifies an XPath expression to select the
elements of outgoing message parts that you
wish to encrypt, if confidentiality is specified in
the selected Security Policy resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
536
| Chapter 13
Policy Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 537
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
•
RawRVMsg2 Schema, page 538
•
Datatype Conversion, page 540
•
Raw TIBCO Rendezvous Message Support, page 544
•
Field Names In Messages, page 546
•
Internationalization Support, page 547
•
Publish Rendezvous Message, page 548
•
Rendezvous Subscriber, page 551
•
Rendezvous Transport, page 555
•
Reply to Rendezvous Request, page 560
•
Send Rendezvous Request, page 562
•
Wait for Rendezvous Message, page 567
TIBCO ActiveMatrix BusinessWorks Palette Reference
538
| Chapter 14
Rendezvous Palette
RawRVMsg2 Schema
TIBCO ActiveMatrix BusinessWorks includes an XSD file that defines a generic
message structure and some additional TIBCO Rendezvous message types. You
can use this schema to send or receive a message with an arbitrary structure (raw
TIBCO Rendezvous messages). This schema also describes the datatypes for fields
that use the TIBRVMSG_XML, TIBRVMSG_IPADDR32, and
TIBRVMSG_IPPORT16 TIBCO Rendezvous datatypes.
If you wish to send or receive raw TIBCO Rendezvous messages, or you wish to
use the TIBRVMSG_XML, TIBRVMSG_IPADR32, or TIBRVMSG_IPPORT16
datatypes in a message, you must include this schema in your project.
The RawRVMsg2 Schema
The following is the RawRVMsg2 schema:
<?xml version="1.0" encoding="UTF-8" ?>
<xsd:schema xmlns:prefix0="http://xmlns.tibco.com/2003/5/bw/plugins/tibrv"
targetNamespace="http://xmlns.tibco.com/2003/5/bw/plugins/tibrv"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xsd:element name="msg">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="field" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="name" type="xsd:string"></xsd:element>
<xsd:element name="id" minOccurs="0" type="xsd:unsignedShort">
</xsd:element>
<xsd:choice>
<xsd:element name="simple" type="xsd:anySimpleType">
</xsd:element>
<xsd:element ref="prefix0:msg"></xsd:element>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:simpleType name="ipPort">
<xsd:restriction base="xsd:unsignedShort"/>
</xsd:simpleType>
<xsd:simpleType name="ipAddr">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
<xsd:simpleType name="tibrvXml">
<xsd:restriction base="xsd:string"/>
</xsd:simpleType>
</xsd:schema>
TIBCO ActiveMatrix BusinessWorks Palette Reference
RawRVMsg2 Schema 539
|
Adding the RawRVMsg2 Schema to Your Project
The RawRVMsg2.xsd file specifies the RawRVMsg2 schema. To add this schema to
your project, perform the following procedure:
1. Locate the bw/5.1/lib/palettes/plugins.jar file in your TIBCO
ActiveMatrix BusinessWorks installation directory.
2. The RawRVMsg2.xsd file is contained in the plugins.jar file. You can extract
this file in a number of ways, depending upon your operating system. For
example, on Windows, you can open up plugins.jar using WinZip and
extract the RawRVMsg2.xsd file. On UNIX, you can use Java’s facilities to
un-jar the file and copy the RawRVMsg2.xsd file.
3. Once you have obtained the RawRVMsg2.xsd file, copy this file into your
TIBCO ActiveMatrix BusinessWorks project directory. You can copy this file
into the root project directory or to a subdirectory in your project.
4. Open your project, and the RawRVMsg2 schema should be located in the
folder where you placed it. If you already have your project open in TIBCO
Designer, you can choose Resources > Refresh from the menu to display the
newly placed file in your project tree.
TIBCO ActiveMatrix BusinessWorks Palette Reference
540
| Chapter 14
Rendezvous Palette
Datatype Conversion
When sending or receiving TIBCO Rendezvous messages, TIBCO ActiveMatrix
BusinessWorks converts the fields of the message to the correct datatypes. Data in
incoming TIBCO Rendezvous messages is converted to TIBCO ActiveMatrix
BusinessWorks datatype (and represented in the activity’s output). Data in an
outgoing message is converted to TIBCO Rendezvous datatypes.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Datatype Conversion 541
|
The following tables describe the corresponding datatypes between TIBCO
ActiveMatrix BusinessWorks and TIBCO Rendezvous, depending upon whether
TIBCO ActiveMatrix BusinessWorks is sending or receiving the message.
Table 9 TIBCO Rendezvous to TIBCO ActiveMatrix BusinessWorks datatype
conversion
TIBCO Rendezvous Datatype
XSD Datatype
TIBRVMSG_BOOL
boolean
TIBRVMSG_I8
byte
TIBRVMSG_I16
short
TIBRVMSG_I32
int
TIBRVMSG_I64
long
TIBRVMSG_U8
unsignedByte
TIBRVMSG_U16
unsignedShort
TIBRVMSG_U32
unsignedInt
TIBRVMSG_U64
unsignedLong
TIBRVMSG_F32
float
TIBRVMSG_F64
double
TIBRVMSG_OPAQUE
hexBinary or base64Binary, depending
upon what is defined in the schema.
TIBRVMSG_DATETIME
date
TIBRVMSG_STRING
string
Table 10 TIBCO ActiveMatrix BusinessWorks to TIBCO Rendezvous datatype
conversion
XSD Datatype
TIBCO Rendezvous Datatype
boolean
TIBRVMSG_BOOL
byte
TIBRVMSG_I8
TIBCO ActiveMatrix BusinessWorks Palette Reference
542
| Chapter 14
Rendezvous Palette
Table 10 TIBCO ActiveMatrix BusinessWorks to TIBCO Rendezvous datatype
conversion
XSD Datatype
TIBCO Rendezvous Datatype
short
TIBRVMSG_I16
int
TIBRVMSG_I32
long
TIBRVMSG_I64
integer
TIBRVMSG_I64
unsignedByte
TIBRVMSG_U8
unsignedShort
TIBRVMSG_U16
unsignedInt
TIBRVMSG_U32
unsignedLong
TIBRVMSG_U64
float
TIBRVMSG_F32
double
TIBRVMSG_F64
hexBinary
TIBRVMSG_OPAQUE
base64Binary
TIBRVMSG_OPAQUE
date
TIBRVMSG_DATETIME
dateTime
TIBRVMSG_DATETIME
time
TIBRVMSG_STRING
string
TIBRVMSG_STRING
TIBRVMSG_XML, TIBRVMSG_IPADDR32, and TIBRVMSG_IPPORT16 Datatypes
If you wish to use the TIBRVMSG_XML, TIBRVMSG_IPADDR32, or
TIBRVMSG_IPPORT16 datatypes, you must first add the RawRVMsg2.xsd file into
your project. See RawRVMsg2 Schema on page 538 for more information about
adding this schema to your project.
Once the RawRVMsg2 schema is in your project, you can reference the ipPort and
ipAddr datatypes contained in that schema. These types correctly convert data of
type TIBRVMSG_XML, TIBRVMSG_IPADDR32, or TIBRVMSG_IPPORT16 when
sending or receiving TIBCO Rendezvous messages.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Datatype Conversion 543
|
For example, you wish to send a message with two fields, ipAddress, ipPort, and
tibrvXml. Figure 24 illustrates an Input Editor tab that defines the message
structure.
Figure 24 Using the ipPort and ipAddr datatypes
In the content field, Element of Type is chosen. In the Type field, XML Type
Reference is chosen to indicate you wish to reference a datatype defined in a
schema resource. Use the Browse button in the Schema field to locate the
RawRVMsg2 schema and select the appropriate type for the field. Figure 25
illustrates selecting the correct type from the RawRvMsg2 schema.
Figure 25 Selecting a type from the RawRVMsg2 schema
TIBCO ActiveMatrix BusinessWorks Palette Reference
544
| Chapter 14
Rendezvous Palette
Raw TIBCO Rendezvous Message Support
In some situations, you may wish to send or receive TIBCO Rendezvous messages
without specifying the exact input or output schema. For example, an application
may send messages with three different structures on the same subject name. You
are interested in receiving all messages, but you only wish to process messages
when the field named "orderType" has a value of "incomingOrder". TIBCO
ActiveMatrix BusinessWorks supplies a generic TIBCO Rendezvous message
schema for handling incoming messages without specifying their structure.
The RawRVMsg2 schema describes a generic message structure. The structure
contains a root element named msg. In the msg element is a repeatable element
named field. Each field contains a name, id, and a choice element. The choice
element contains the data of the field. A field’s data can be either a scalar value or
another message.
Figure 26 illustrates the generic TIBCO Rendezvous message schema used in a
Rendezvous Subscriber process starter.
Figure 26 Schema for RawRVMsg2.xsd
Before using the RawRVMsg2 schema, you must add the schema to your project.
See RawRVMsg2 Schema on page 538 for more information about adding this
schema to your project.
Using the RawRVMsg2 Schema
Once you have the RawRVMsg2 schema in your project, you can reference it in
any Input Editor or Output Editor tab on any activity in the TIBCO Rendezvous
palette. To use the RawRvMsg2 schema, perform the following;
TIBCO ActiveMatrix BusinessWorks Palette Reference
Raw TIBCO Rendezvous Message Support 545
|
1. Create a root element in the Input/Output Editor tab with the Add Child
button.
You can only use the msg element of the RawRVMsg2 schema on the root
element in the schema you create in the Input or Output Editor tab. Do not
attempt to use this schema for any element that is not the root of the schema.
2. Select XML Element Reference in the Content field on the right.
3. Use the Browse Resources button in the Schema field to locate and select the
RawRVMsg2 schema.
Once the schema is selected, it becomes the schema for incoming or outgoing
message bodies.
You can use XPath expressions to extract the desired field from the generic
RawRvMsg2 schema. For example, your process begins with a Rendezvous
Subscriber activity and you wish to perform processing on incoming messages
that have a field named "orderType" with a value of "incomingOrder", you would
use the following XPath expression to determine which messages meet that
criteria:
$Rendezvous-Subscriber/ActivityOutput/body/pfx:field/pfx:name
= "orderType"
and
$Rendezvous-Subscriber/ActivityOutput/body/pfx:field/pfx:simple
= "incomingOrder"
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about XPath.
TIBCO ActiveMatrix BusinessWorks Palette Reference
546
| Chapter 14
Rendezvous Palette
Field Names In Messages
A TIBCO Rendezvous message can contain field names that are not compliant
with XML or ActiveEnterprise naming rules. For example, XML element names
cannot begin with a number, nor can they contain special characters, such as # or
^. When activities in the TIBCO Rendezvous palette send or receive messages,
element names in the input or output schemas for the activity must comply with
XML and ActiveEnterprise naming rules. Any elements in referenced schemas in
the input or output schemas are automatically altered so that they comply with
XML and ActiveEnterprise naming rules. The XML-Compliant Field Names field
allows you to handle incoming or outgoing messages when the field names are
not valid XML or ActiveEnterprise names.
When the XML-Compliant Field Names field is unchecked, any field names in
incoming or outgoing messages that do not comply with XML or
ActiveEnterprise naming rules are altered so that they comply with the rules.
When the field is checked, field names in the message are left unaltered.
When publishing a message, unchecking the XML-Compliant Field names field
ensures that field names in the message sent over the transport to the receiving
application are altered when necessary to comply with XML or ActiveEnterprise
naming rules. Checking the field allows you to send the message with the original
field names intact; no alterations are made to the field names. This is useful in the
case where you reference a schema in the Input Editor that contains invalid XML
or ActiveEnterprise names (such as a TIBCO ActiveEnterprise schema that
contains special characters). The receiving application will receive the message
with the original field names, if the XML-Compliant Field Names field is
unchecked.
When receiving a message, unchecking the XML-Compliant Field Names field
ensures that field names in the incoming message are altered to comply with XML
and ActiveEnterprise naming rules. If the message contains fields that do not
comply to XML and ActiveEnterprise naming rules, the output schema of the
subscriber activity must specify the correct altered name in order to match the
altered name of the field in the incoming message. See the description of the
ae2xsd utility in the TIBCO Runtime Agent Administrator’s Guide for more
information about how to convert a TIBCO ActiveEnterprise schema into a valid
XSD. Using this utility will allow you to see how field names will be altered to
comply with XML and ActiveEnterprise naming rules. Unchecking the field
leaves the field names of the message intact.
Unchecking the XML-Compliant Field Names field involves extra processing of
incoming and outgoing messages. If you are certain that messages contain only
field names that comply with XML naming rules, you can uncheck this field to
improve performance.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Internationalization Support 547
|
Internationalization Support
TIBCO Rendezvous activities use the TIBCO Messaging Encoding as the wire
format encoding when testing processes in TIBCO Designer and when the project
is running as a legacy local-file based project. The default TIBCO Messaging
Encoding value is ISO8859-1, which only supports English and other western
European languages that belong to ISO Latin-1 character set.
You must set the TIBCO Messaging Encoding to UTF-8 if you want to send and
receive characters not in the ASCII and Latin-1 character set. When creating a new
project, you can set the TIBCO Messaging Encoding in the Save Project dialog or
on the Project Settings tab. See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information.
After the project is deployed in a TIBCO Administrator domain, the messaging
encoding set at design time is overridden by the TIBCO Administrator domain's
encoding property. All the TIBCO components working in the same domain must
always use the same encoding for intercommunication. See TIBCO Administrator
Server Configuration Guide for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
548
| Chapter 14
Rendezvous Palette
Publish Rendezvous Message
Activity
The Publish Rendezvous Message activity publishes a TIBCO
Rendezvous message on the given subject with the given message
content.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Subject
Yes
The subject on which to publish the TIBCO
Rendezvous message. You can override this value
by specifying a subject on the Input tab.
Transport
No
The TIBCO Rendezvous transport parameters.
These are specified as a Rendezvous Transport
shared configuration resource. See Rendezvous
Transport on page 555 for more information
about shared configuration resources.
Pre-register
Listener
Yes
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.
Description
See the TIBCO Rendezvous documentation for
more information about RVCM.
XML Format
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
If checked, the body of the TIBCO Rendezvous
message is placed into a single field named "xml".
This field is a byte array containing the body of
the message. The datatype of the field is
TIBRVMSG_XML.
Publish Rendezvous Message 549
|
Field
Global
Var?
Description
XML-Compliant
Field Names
No
Specifies whether the field names of the outgoing
message should be altered so that they comply
with XML and ActiveEnterprise naming rules.
Only field names that do not comply with XML
and ActiveEnterprise naming rules are altered
when this field is unchecked. When checked,
field names are left unaltered.
Input Editor
The Input Editor tab allows you to define a custom schema for the body of the
TIBCO Rendezvous message. See Appendix A, Specifying Data Schema, on
page 729 for a complete description of using the Input Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
subject
string
The subject of the TIBCO Rendezvous
message.
replySubject
string
The subject to send replies for this TIBCO
Rendezvous message. This is useful if you
wish to use the Wait for Rendezvous
Message activity later in the process to
receive replies to the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
550
| Chapter 14
Rendezvous Palette
Input Item
Datatype
Description
preRegisterListener
string
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. Any listeners
preregistered on the Transport tab are also
preregistered with the listeners specified in
this element.
See the TIBCO Rendezvous
documentation for more information about
RVCM.
body
complex
The body of the TIBCO Rendezvous
message.
Output
This activity produces no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The message cannot be serialized.
RVPluginException
An error occurred when sending the message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rendezvous Subscriber 551
|
Rendezvous Subscriber
Process Starter
The Rendezvous Subscriber process starter creates a process when a
TIBCO Rendezvous message on the given subject is received.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Subject
Yes
The subject on which to listen for the TIBCO
Rendezvous message.
Transport
Yes
The TIBCO Rendezvous transport parameters.
These are specified as a Rendezvous Transport
shared configuration resource. See Rendezvous
Transport on page 555 for more information
about shared configuration resources.
XML Format
No
If checked, the body of the incoming TIBCO
Rendezvous message is expected to be a single
field named "xml". This field is a byte array
containing the body of the message.
Description
TIBCO ActiveMatrix BusinessWorks
automatically deserializes the xml field and
represents the message as a schema tree in this
activity’s output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
552
| Chapter 14
Rendezvous Palette
Field
Global
Var?
Description
Needs Output
Validation
No
Specifies that you would like the incoming
message to be validated against the schema
specified on Output Editor tab. An error is
returned if an incoming message does not match
the specified schema.
Validation does affect system performance, and
you may wish to uncheck this field to handle
incoming messages more quickly. If you uncheck
this field, no validation is performed and any
incoming message that does not match the
specified schema is processed.
You should only uncheck this field if you can
guarantee that incoming messages conform to
the expected schema.
Needs Output
Filtration
No
Specifies that only fields that match the name
and datatype of the schema elements specified
on the Output Editor tab should be processed.
Any elements that do not match the specified
schema are ignored and not included in this
activity’s output.
This is useful if you need only a subset of the
fields of an incoming message. Any unnecessary
fields are not included in the activity output. This
can save memory, and consequently improve
performance.
Note: This option is only valid when the XML
Format field is unchecked. Do not check this
checkbox when the XML Format field is also
checked.
XML-Compliant
Field Names
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Specifies whether the field names of the
incoming message should be altered so that they
comply with XML and ActiveEnterprise naming
rules. Only field names that do not comply with
XML and ActiveEnterprise naming rules are
altered when this field is unchecked. When
checked, field names are left unaltered.
Rendezvous Subscriber 553
|
Field
Global
Var?
Description
Raw-RV-Object
Mode
No
Checking this field disables the XML Format,
Needs Output Validation, Needs Output
Filtration, and XML-Compliant Field Names
fields.
Specifies that the body of the RV message should
be output as a Java object reference. A
subsequent Java Code activity in the process
definition can accept the reference as an input
parameter and then construct the RV message
from the object. To use the Java object, the Java
code activity must cast the object reference as a
byte array. For example:
TibrvMsg tibrvMsg = new
TibrvMsg ((byte[])in_var_1);
Where in_var_1 is the input parameter for the
Java Code activity that is mapped to the object
reference of the object containing the RV
message.
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
554
| Chapter 14
Rendezvous Palette
Field
Description
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output Editor
The Output Editor tab allows you to define a custom schema for the body of the
TIBCO Rendezvous message. See Appendix A, Specifying Data Schema, on
page 729 for a complete description of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
sendSubject
string
The subject of the received message.
replySubject
string
The reply subject of the TIBCO
Rendezvous message.
certifiedSender
string
This element is only available when
RVCM transports are used. This
element contains the CM name of the
message sender.
certifiedSequenceNumber
integer
This element is only available when
RVCM transports are used. This
element contains the sequence
number of the message.
body
complex
The body of the TIBCO Rendezvous
message.
If the Raw-RV-Object Mode field is
checked on the Configuration tab,
the body is output as an object
reference.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rendezvous Transport 555
|
Rendezvous Transport
Shared Configuration
The Rendezvous Transport resource describes a TIBCO Rendezvous
transport. This resource is used when specifying activities from the
Rendezvous palette. See the TIBCO Rendezvous documentation for
more information about specifying these fields.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Daemon
Yes
In the case of TIBCO Rendezvous daemon running
on the same machine as TIBCO ActiveMatrix
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:
ssl:acct:5785
Network
Yes
This field contains the host name, IP address,
network name, or interface name.
For example:
;224.34.103.4
Service
Yes
This is the TIBCO Rendezvous service name in one of
the following formats:
<service name>
or
<port number>
TIBCO ActiveMatrix BusinessWorks Palette Reference
556
| Chapter 14
Rendezvous Palette
Field
Global
Var?
Description
SSL
No
The Use SSL checkbox specifies that Secure Sockets
Layer (SSL) should be used when communicating
with the TIBCO Rendezvous daemon. When this
field is checked, the Configure SSL button is enabled.
See Configure SSL Button on page 556 for more
information about configuring SSL parameters.
Configure SSL Button
The Configure SSL button allows you to configure the SSL parameters for
communicating with the TIBCO Rendezvous daemon. See the TIBCO
Rendezvous documentation for more information about how SSL is configured
for TIBCO Rendezvous daemons and clients.
The SSL Configuration for TIBCO RV dialog has the following fields:
Field
Description
Daemon Certificate
File containing one or more certificates from trusted
certificate authorities. This file is checked when
connecting to a daemon to ensure that the connection is
to a daemon that is trusted. This prevents connections to
rogue TIBCO Rendezvous daemons that attempt to
impersonate trusted daemons.
You can retrieve a daemon’s certificate using the
administration interface in TIBCO Rendezvous. See the
TIBCO Rendezvous documentation for more
information about obtaining certificates through the
administration interface. Once retrieved, you can select
a folder in your project and import this certificate into
the folder using the Tools>Trusted Certificates>Import
Into PEM Format menu item.
BusinessWorks supports the use of global variables to
configure certificates at deployment time. You can
declare a global variable and set the absolute path to a
Certificate in PEM format. This eliminates the need to
embed certificates in BusinessWorks projects.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rendezvous Transport 557
|
Field
Description
Identity
This is an Identity resource used to authenticate to the
TIBCO Rendezvous daemon. The Browse button allows
you to select from a list of appropriately configured
Identity resources. Only Identity resources whose Type
field is set to Identity File or Username/Password are
listed.
See TIBCO Designer Palette Reference for more
information.
Advanced
The Advanced tab has the following fields.
Field
Global
Var?
RV Type
No
Description
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
Yes
The name of the delivery-tracking session. This name
is in the same format as TIBCO Rendezvous subject
names.
Ledger File
Yes
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
Yes
Specifies whether to keep the ledger file synchronous
with the current messages.
Relay
Agent
Yes
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
558
| Chapter 14
Rendezvous Palette
Field
Global
Var?
Description
Require
Old
Message
Yes
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
(sec)
Yes
The time limit (in seconds) for certified message
delivery.
Distributed Queue Transport
CMQ
Name
Yes
The name of the distributed queue. This name is in the
same format as TIBCO Rendezvous subject names
Worker
Weight
Yes
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
Yes
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.
Worker
Complete
Time
Yes
The amount of time the scheduler waits for a worker
process to complete. If the worker process does not
complete in the specified period, the scheduler
reassigns the message to another worker.
Scheduler
Weight
Yes
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Rendezvous Transport 559
|
Field
Global
Var?
Description
Scheduler
Heartbeat
Yes
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.
Scheduler
Activation
Yes
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
TIBCO ActiveMatrix BusinessWorks Palette Reference
560
| Chapter 14
Rendezvous Palette
Reply to Rendezvous Request
Activity
The Reply to Rendezvous Request activity is used to send a reply
to a received TIBCO Rendezvous message.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Reply For
No
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 Subject
Yes
The reply subject of the received TIBCO
Rendezvous message. You can override this value
by specifying a subject on the Input tab.
Description
Input Editor
The Input Editor tab allows you to define a custom schema for the body of the
TIBCO Rendezvous message. See Appendix A, Specifying Data Schema, on
page 729 for a complete description of using the Input Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Reply to Rendezvous Request 561
|
The input for the activity is the following.
Input Item
Datatype
Description
replySubject
string
The reply subject of the TIBCO Rendezvous
message.
body
complex
The body of the TIBCO Rendezvous message.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
RVPluginException
An error occurred when sending the reply
message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
562
| Chapter 14
Rendezvous Palette
Send Rendezvous Request
Activity
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.
This activity uses the INBOX mechanism to ensure that reply messages are
received only by the process that sent the request.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Subject
Yes
The subject on which to publish the TIBCO
Rendezvous message. You can override this
value by specifying a subject on the Input tab.
Transport
No
The TIBCO Rendezvous transport parameters.
These are specified as a Rendezvous Transport
shared configuration resource. See Rendezvous
Transport on page 555 for more information
about shared configuration resources.
Request Timeout
(msec)
Yes
The amount of time to wait (in milliseconds) for
a reply to the TIBCO Rendezvous message. If no
reply is received in the given time limit, an error
is returned.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Rendezvous Request 563
|
Field
Global
Var?
Description
Pre-register
Listener
Yes
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.
See the TIBCO Rendezvous documentation for
more information about RVCM.
XML Format
No
If checked, the bodies of the TIBCO Rendezvous
request and reply messages are sent as a single
field named "xml". This field is a byte array
containing the body of the message.
TIBCO ActiveMatrix BusinessWorks
automatically deserializes the reply message
and represents the data of the message as a
schema tree based on the schema specified in the
Output Editor tab.
Needs Output
Validation
No
Specifies that you would like the reply message
to be validated against the schema specified on
Output Editor tab. An error is returned if a reply
message does not match the specified schema.
Validation does affect system performance, and
you may wish to uncheck this field to handle
reply messages more quickly. If you uncheck this
field, no validation is performed and any reply
message that does not match the specified
schema is processed.
You should only uncheck this field if you can
guarantee that reply messages conform to the
expected schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
564
| Chapter 14
Rendezvous Palette
Field
Global
Var?
Description
Needs Output
Filtration
No
Specifies that only fields in the reply message
that match the name and datatype of the schema
elements specified on the Output Editor tab
should be processed. Any elements that do not
match the specified schema are ignored and not
included in this activity’s output.
This is useful if you need only a subset of the
fields of a reply message. Any unnecessary
fields are not included in the activity output.
This can save memory, and consequently
improve performance.
Note: This option is only valid when the XML
Format field is unchecked. Do not check this
checkbox when the XML Format field is also
checked.
XML-Compliant
Field Names
No
Specifies whether the field names of the
outgoing message should be altered so that they
comply with XML and ActiveEnterprise naming
rules. Only field names that do not comply with
XML and ActiveEnterprise naming rules are
altered when this field is unchecked. When
checked, field names are left unaltered.
Input/Output Editor
The Input Editor and Output Editor tabs allow you to define custom schemas for
the body of the outgoing TIBCO Rendezvous request and body of the incoming
TIBCO Rendezvous response. See Appendix A, Specifying Data Schema, on
page 729 for a complete description of using the Input/Output Editor tab.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Send Rendezvous Request 565
|
The input for the activity is the following.
Input Item
Datatype
Description
subject
string
The subject of the TIBCO Rendezvous
message.
body
complex
The body of the TIBCO Rendezvous
message.
replySubject
string
The reply subject for this activity.
Note: The reply messages may not be
received by the correct job if more than
one job has the same reply subject (for
example, if a constant is specified in this
field). Use the Publish Rendezvous
Message and Wait for Rendezvous
message instead if you wish to receive
replies on a single subject.
timeout
number
The amount of time to wait (in
milliseconds) for a reply to the TIBCO
Rendezvous message. If no reply is
received in the given time limit, an error is
returned.
Output
The output for the activity is the following.
Output Item
Datatype
Description
replyMessageReplySubject
string
A reply message can optionally
have a reply subject, presumably so
that the two applications can
communicate with further
messages. This element contains the
reply subject set on the reply
message, if one is set. If no reply
subject is set on the reply message,
this element is not populated.
body
complex
The body of the TIBCO Rendezvous
reply message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
566
| Chapter 14
Rendezvous Palette
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The message cannot be serialized.
RVPluginException
An error occurred when sending the
message.
ActivityTimedOutException
A timeout has been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Rendezvous Message 567
|
Wait for Rendezvous Message
Activity
The Wait for Rendezvous Message activity waits to receive a
TIBCO Rendezvous message with the given subject.
See Scalability With Incoming Events on page 226 in TIBCO
ActiveMatrix BusinessWorks Process Design Guide for information
on running the "Wait for..." activities in a multi-engine mode.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Subject
Yes
The subject on which to listen for the TIBCO
Rendezvous message.
Transport
Yes
The TIBCO Rendezvous transport parameters.
These are specified as a Rendezvous Transport
shared configuration resource. See Rendezvous
Transport on page 555 for more information
about shared configuration resources.
XML Format
No
If checked, the body of the incoming TIBCO
Rendezvous message is expected to be a single
field named "xml". This field is a byte array
containing the body of the message.
Description
TIBCO ActiveMatrix BusinessWorks
automatically deserializes the xml field and
represents the message as a schema tree in this
activity’s output.
TIBCO ActiveMatrix BusinessWorks Palette Reference
568
| Chapter 14
Rendezvous Palette
Field
Global
Var?
Description
Needs Output
Validation
No
Specifies that you would like the incoming
message to be validated against the schema
specified on Output Editor tab. An error is
returned if an incoming message does not match
the specified schema.
Validation does affect system performance, and
you may wish to uncheck this field to handle
incoming messages more quickly. If you uncheck
this field, no validation is performed and any
incoming message that does not match the
specified schema is processed.
You should only uncheck this field if you can
guarantee that incoming messages conform to
the expected schema.
Needs Output
Filtration
No
Specifies that only fields that match the name
and datatype of the schema elements specified
on the Output Editor tab should be processed.
Any elements that do not match the specified
schema are ignored and not included in this
activity’s output.
This is useful if you need only a subset of the
fields of an incoming message. Any unnecessary
fields are not included in the activity output.
This can save memory, and consequently
improve performance.
Note: This option is only valid when the XML
Format field is unchecked. Do not check this
checkbox when the XML Format field is also
checked.
XML-Compliant
Field Names
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Specifies whether the field names of the
incoming message should be altered so that they
comply with XML and ActiveEnterprise naming
rules. Only field names that do not comply with
XML and ActiveEnterprise naming rules are
altered when this field is unchecked. When
checked, field names are left unaltered.
Wait for Rendezvous Message 569
|
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 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.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO ActiveMatrix
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 waits if it is received before
this activity is executed. If the event timeout expires,
an error is logged and the event is discarded.
If no value is specified in this field, the message
waits indefinitely. If zero is specified, the event is
discarded immediately, unless this activity has
already been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
570
| Chapter 14
Rendezvous Palette
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. This is because 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 Rendezvous Message activity proceeds.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
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 569 for an example of using
the Candidate Event Key field with the key
input item.
processTimeout
integer
The time (in milliseconds) to wait for the
incoming message. An error is returned if the
message is not received in this time limit.
Output Editor
The Output Editor tab allows you to define a custom schema for the body of the
TIBCO Rendezvous message. See Appendix A, Specifying Data Schema, on
page 729 for a complete description of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
sendSubject
string
The subject of the received message.
replySubject
string
The reply subject of the TIBCO
Rendezvous message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Wait for Rendezvous Message 571
|
Output Item
Datatype
Description
certifiedSender
string
This element is only available when
RVCM transports are used. This
element contains the CM name of
the message sender.
certifiedSequenceNumber
integer
This element is only available when
RVCM transports are used. This
element contains the sequence
number of the message.
body
complex
The body of the TIBCO Rendezvous
message. The elements contained in
this element are specified on the
Configuration tab.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ActivityTimedOutException
A timeout has been reached.
TIBCO ActiveMatrix BusinessWorks Palette Reference
572
| Chapter 14
Rendezvous Palette
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 573
Chapter 15
RMI Palette
Remote Method Invocation (RMI) is a protocol for calling operations on remote
Java objects. TIBCO ActiveMatrix BusinessWorks can act as server for incoming
RMI calls, or TIBCO ActiveMatrix BusinessWorks can use RMI to retrieve a
remote object. For client interactions, either a remote Java object on an RMI server
or an Enterprise Java Bean (EJB) can be retrieved. For server interactions, a client
can make an RMI call to TIBCO ActiveMatrix BusinessWorks that initiates a
process instance.
This chapter assumes that you are familiar with the RMI protocol. For more
information, see: http://java.sun.com/docs/books/tutorial/rmi/index.html.
Topics
•
RMI Overview, page 574
•
RMI Lookup, page 576
•
RMI Server, page 578
TIBCO ActiveMatrix BusinessWorks Palette Reference
574
| Chapter 15
RMI Palette
RMI Overview
You can use the resources in the RMI palette to either retrieve a remote Java object
or to create a process definition that starts a process instance for each incoming
RMI call. This section describes the uses of the resources in the RMI palette.
Using RMI to Call a Remote Object
The RMI Lookup activity allows you to use a registry server to retrieve a Java
object that implements a client stub of a remote object. You can then pass the
object to a Java Code or Java Method activity and invoke methods on the object.
Figure 27 illustrates using the RMI Lookup activity to obtain a client stub for a
remote Java object and then mapping that object to an input parameter for the
Java Code activity.
Figure 27 Using the RMI Lookup activity
The object obtained by the lookup activity is an instance of the server's stub class
for the actual server object interface. To call methods on this object with a Java
Code activity, use the stub class interface to cast the object before making the calls.
Similarly, the Java Method activity should specify the stub class interface in its
Class field. The generated client stub’s .jar file must be either in the TIBCO
ActiveMatrix BusinessWorks classpath or in an AliasLibrary resource before it can
be used by the Java Method activity.
Acting as a RMI Server
The RMI Server process starter registers the specified object name with the
specified registry server. Then, requests from RMI clients for the object are
directed to the RMI Server process starter. A new process instance is created to
handle each incoming request.
TIBCO ActiveMatrix BusinessWorks Palette Reference
RMI Overview 575
|
The RMI Server process starter can output two Java objects, one for the request
and one for the reply. Either the request or reply objects can be nil. Optionally, you
can also specify an output schema in the Output Editor tab of the RMI Server
process starter. This allows you to specify fields that are expected in the request
object and the data from the request object is used to populate the desired output
schema. You can then process the request based on the specified output schema,
and you can also access the actual request object by passing it to a Java Code or
Java Method activity.
When the client is expecting a reply, you can use the Java Code or Java Method
activities to invoke the appropriate methods on the reply object.
Figure 28 illustrates using the RMI Server process starter.
Figure 28 Using the RMI Server process starter
TIBCO ActiveMatrix BusinessWorks Palette Reference
576
| Chapter 15
RMI Palette
RMI Lookup
Activity
The RMI Lookup activity retrieves a reference to a remote object from
the specified registry server. The object reference output by this
activity can be passed to a Java Code or Java Method activity to invoke
methods on the remote object.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Alias Library
No
Use this field to specify an AliasLibrary resource
that is used to locate the Java class files. See
TIBCO Designer Palette Reference for more
information about AliasLibrary resources.
Remote Object
Name
Yes
Name of the remote object you wish to retrieve.
Registry Host
Name
Yes
Host name of the registry server. The registry
server provides the remote object reference for
making the call to the remote object.
Registry Server
Port
Yes
Port number for the registry server.
Description
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
RMI Lookup 577
|
The input for the activity is the following.
Input Item
Datatype
Description
remoteObjectName
string
Name of the remote object whose client
stub you wish to retrieve. The value
specified in this element overrides any
value specified in the Remote Object Name
field on the Configuration tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
object
Java
Object
An object reference for the specified remote
Java object.
TIBCO ActiveMatrix BusinessWorks Palette Reference
578
| Chapter 15
RMI Palette
RMI Server
Process Starter
The RMI Server process starter registers the specified remote object
name with the specified registry server and then creates process
instances to handle incoming requests for the object. The process
definition acts as the implementation of the specified object.
You can specify an output schema on the Output editor tab to extract expected
fields from the incoming request object. The data in the output schema is then
available to subsequent activities in the process definition. The request and reply
Java objects are also output and available to activities that can accept Java objects
as input (for example, Java Code or Java Method). You can send a reply to the
client by invoking the appropriate methods on the reply object, if the client
requires a reply.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Alias Library
No
Use this field to specify an AliasLibrary resource
that is used to locate the Java class files. See
TIBCO Designer Palette Reference for more
information about AliasLibrary resources.
Remote Object
Name
Yes
Name of the Java object that this process
definition implements.
Registry Host
Name
Yes
Host name of the registry server with which you
wish to register the specified object.
Registry Server
Port
Yes
Port number for the registry server.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Description
RMI Server 579
|
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output Editor
The Output Editor tab allows you to define a custom schema for expected fields in
the request object. See Appendix A, Specifying Data Schema, on page 729 for a
complete description of using the Output Editor tab.
Output
The output for the activity is the following.
Output Item
Datatype
Description
request
Java
Object
An object reference to the request object sent
in the RMI request. The client might not send
any data in the request, and in that case, this
element will be nil.
reply
Java
Object
An object reference to the reply object
required by the client. The client might not
require a reply, and in that case, this element
will be nil.
TIBCO ActiveMatrix BusinessWorks Palette Reference
580
| Chapter 15
RMI Palette
Output Item
Datatype
Description
<data>
varies
The output schema specified on the Output
Editor tab. Data from the request object is
extracted into the elements of this output
schema. This allows you to easily access data
from the request object without passing the
object to a Java Code or Java to XML activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 581
Chapter 16
Service Palette
The Service palette contains resources for implementing Services. Services
implement a set of interfaces and expose one or more endpoints. Services provide
an abstraction so that you can implement a more generic service-oriented
architecture (SOA). This allows you to decouple a service from its underlying
transport and implementation.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about services.
Topics
•
Context Resource, page 582
•
Get Context, page 583
•
Invoke Partner, page 584
•
Partner Link Configuration, page 586
•
Receive Partner Notification, page 592
•
Service, page 595
•
Set Context, page 615
TIBCO ActiveMatrix BusinessWorks Palette Reference
582
| Chapter 16
Service Palette
Context Resource
Shared Configuration
The Context Resource shared configuration resource allows you to
specify a schema to hold context data from an incoming request or
outgoing replies to a service. This allows you to pass on data, such
as the username and password sent by the requesting application,
to operation implementations without requiring the implementations to be aware
of which transport the request was bound to. Also, you can pass data from the
process that implements an operation back to the Service for any outgoing reply
message. The Context Resource can also be used to store SOAP headers or
message attachments.
For example, your operation implementation may require the user ID of the
requestor or the public certificate of the user making the request. Also, you may
wish to set outgoing reply header values based on data from the process that
implements the operation.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about context separation for Service resources and operation implementations.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the shared resource.
Schema
The Schema tab allows you to define a custom schema to hold the data of the
context. You can define your own datatype on this tab, and you can reference an
XML schema stored in the project. See Appendix A, Specifying Data Schema, on
page 729 for a description of how to define a schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Get Context 583
|
Get Context
Activity
The Get Context activity retrieves the value of the specified Context
Resource. This is useful if your process definition requires some
context information from an incoming request.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more
information about context separation for Service resources and operation
implementations.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Context
Configuration
No
The Context Resource whose value you would
like to retrieve.
Description
Output
The output for the activity is the following.
Output Item
Datatype
Description
<schema>
varies
The value of the context resource
specified in the Context Configuration
field of the Configuration tab is the
output for this activity. The schema for
the output is determined by the
schema specified for the context
resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
584
| Chapter 16
Service Palette
Invoke Partner
Activity
The Invoke Partner activity can be used in a BusinessWorks Process
Definition to invoke external services over SOAP.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more
information about services, partners and invoking partner services.
Configuration
The Configuration tab has the following fields
Field
Global
Var?
Name
No
The name to appear as the label for the invoke
partner activity in the process definition.
Description
No
Short description of the activity.
Partner
No
The partner whose service is to be invoked by
the activity. You can select the partner from the
drop down menu that lists all the available
partners in the process.
Operation
No
Select the operation that is to be invoked from
the drop down menu. The drop down menu
lists all the available operations for the selected
partner.
Description
Input
The input for the invoke partner service has the following fields
Input Item
Datatype
Description
input message
complex
The input message of the operation. This
element contains all the input message
parts for the operation.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Invoke Partner 585
|
Output
The output for the invoke partner service has the following fields
Output Item
Datatype
Description
output message
complex
The output message for the operation.
This element contains all the output
message parts for the operation.
Error Output
The Error Output tab lists the possible SOAP Fault messages that can be thrown
by the invoked operation on the selected external service. These SOAP Fault
messages are defined in the abstract WSDL. If no SOAP fault messages are
defined in the abstract WSDL, there will be no exceptions or fault messages listed
in the error output tab.
See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about
error codes and corrective action to take.
Unlike the SOAP Request Reply activity where you can define dynamic endpoint
URL, you cannot define dynamic endpoint URL for the invoke partner activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
586
| Chapter 16
Service Palette
Partner Link Configuration
Shared Resource
The Partner Link Configuration associates abstract partner
portTypes with concrete port bindings. This allows you to easily link
to new partner services without changing processes that invoke the
partners.
See Partners on page 3 for more information about partners and
Partner Link Configuration resources.
Configuration
The Configuration tab has the following fields.
Field
Description
Name
The name to appear as the label for the resource.
Description
Short description of the resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Partner Link Configuration 587
|
Field
Description
Partner Links
Use the + button to add partner links to the list, use
the X button to delete partner links from the list, use
the arrow buttons to move partner links in the list.
Specify the following in the columns of the table for
each partner:
•
Name — Double click on this field to specify a
name for the partner.
•
Timeout (seconds) — Double click on this field to
specify a timeout in seconds for invocations of
this partner. By default, the timeout is zero (0)
which provides an unlimited amount of time for
invocations.
•
Service Endpoint — The endpoint of the service.
You can use concrete WSDL resources with port
bindings or you can specify local service
resources with Local specified in the endpoint
binding.
•
Attachment Style — Specifies the attachment
style for requst messages with attachments. The
default attachment style is SwA. If the referenced
concrete WSDL uses SOAP 1.1, only SwA style is
available. When using SOAP 1.2, SwA and
MTOM styles are available.
Additional Configuration for HTTP Endpoints
Use HTTP Proxy
Specifies to use a proxy server to gain access outside
of a firewall.
Proxy Name
Host name or IP address of the proxy server.
Use Basic
Authentication
Specifies that the invocation of the service must
provide authentication to the service.
Identity
When basic authentication (username and password)
is required, provide an Identity resource in this field
that contains the appropriate username and
password.
See TIBCO Designer Palette Reference for more
information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
588
| Chapter 16
Service Palette
Field
Description
SSL
When SSL is required for authentication to the
service, click the Configure SSL button to supply the
appropriate properties. See HTTP SSL Configuration
Fields on page 588 information more information.
HTTP SSL Configuration Fields
Trusted Certificates
Folder
Folder in the project containing one or more
certificates from trusted certificate authorities. This
folder is checked when an invocation is made to the
partner service to ensure that the server is trusted.
This prevents connections to rogue servers.
Identity
This is an identity resource that contains the clients’s
digital certificate and private key.
See TIBCO Designer Palette Reference for more
information.
Strong Cipher Suites
Only
Specifies that only cipher suites with strong
encryption should be used, if they are available on
the host you are connecting to.
Additional Configuration for JMS Endpoints
JNDI Tab
Context URL
JNDI Tab
User Name
JNDI Tab
Password
JNDI Tab
SSL
TIBCO ActiveMatrix BusinessWorks Palette Reference
URL for the JNDI connection to the JMS server
(javax.naming.Context.PROVIDER_URL).
User name for logging into the JNDI server
(javax.naming.Context.SECURITY_PRINCIPAL). If
the JNDI provider does not require access control,
this field can be empty.
Password for logging into the JNDI server
(javax.naming.Context.SECURITY_CREDENTIALS).
If the JNDI provider does not require access control,
this field can be empty.
When SSL is required for authentication to the
service, click the Configure SSL button to supply the
appropriate SSL information. See JMS SSL
Configuration Fields on page 590 for more
information.
Partner Link Configuration 589
|
Field
Description
JNDI Tab
Some application servers store the security context on
the thread used to establish the JNDI connection (at
the time of this release, only the WebLogic
application server does this). In that case, the first
activity to use this resource establishes the security
context, then subsequent activities use the same
security context, unless this field is checked.
Checking this field ensures that each activity that
uses this resource examines the security context to
determine if the activity uses the same security
context as the security context established on the
thread. If they are different, the activity’s configured
security context is used.
Validate Security
Context
Checking this field causes additional overhead for
activities that use this resource. Therefore, only check
this field when necessary.
JMS Tab
User name to use when logging into the JMS server.
User Name
If the JMS provider does not require access control,
this field can be empty.
JMS Tab
Password to use when logging into the JMS server.
Password
If the JMS provider does not require access control,
this field can be empty.
JMS Tab
The delivery mode of the message. Can be one of the
following:
Delivery Mode
• Persistent — signifies the messages are stored and
forwarded.
• Non-Persistent — messages are not stored and may
be lost due to failures in transmission.
• TIBCO EMS Reliable— this mode is only available
when using TIBCO Enterprise Message Service. See
the TIBCO Enterprise Message Service
documentation for more information about this
mode.
TIBCO ActiveMatrix BusinessWorks Palette Reference
590
| Chapter 16
Service Palette
Field
Description
JMS Tab
Corresponds to JMSExpiration property that specifies
how long the message can remain active (in seconds).
If set to 0, the message does not expire.
Expiration
This field is set in seconds, but the JMSExpiration
property is displayed in milliseconds.
JMS Tab
Priority
Priority of the message. You may set the priority to a
value from 0-9. The default value is 4.
JMS SSL Configuration Fields
Basic Tab
Trusted Certificates
Folder
Basic Tab
Identity
Folder in the project containing one or more
certificates from trusted certificate authorities. This
folder is checked when an invocation is made to the
partner service to ensure that the server is trusted.
This prevents connections to rogue servers.
This is an identity resource that contains the clients’s
digital certificate and private key.
See TIBCO Designer Palette Reference for more
information.
Advanced Tab
Trace
Advanced Tab
Debug Trace
TIBCO ActiveMatrix BusinessWorks Palette Reference
Specifies whether SSL tracing should be enabled
during the connection. If checked, the SSL connection
messages are logged and sent to the console.
Specifies whether SSL debug tracing should be
enabled during the connection. Debug tracing
provides more detailed messages than standard
tracing.
Partner Link Configuration 591
|
Field
Description
Advanced Tab
This field specifies to check the host name of the
server 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.
Verify Host Name
If the host name specified in the endpoint binding is
not an exact match to the host name specified in the
server’s digital certificate, the connection is refused.
Note: If an equivalent host name (for example, an IP
address) is specified in the endpoint binding, but the
name is not an exact match of the hostname in the
host’s digital certificate, the connection is refused.
Advanced Tab
Expected Host Name
Specifies the name of the host you are expecting to
connect to. This field is only relevant if the Verify
Host Name field is also checked.
If the name of the host in the host’s digital certificate
does not match the value specified in this field, the
connection is refused.
This prevents hosts from attempting to impersonate
the host you are expecting to connect to.
Advanced Tab
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified
with the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
592
| Chapter 16
Service Palette
Receive Partner Notification
Activity
The Receive Partner Notification activity can be used in an
ActiveMatrix BusinessWorks Process Definition to invoke
notification services over SOAP. The notification service sends a
message that is received by the invoker.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more
information about services, partners and invoking partner services.
The Receive Partner Notification activity supports only SOAP over JMS messages.
Configuration
The Configuration tab has the following fields
Field
Global
Var?
Description
Name
No
The name to appear as the label for the receive
partner notification activity in the process
definition.
Description
No
Short description of the activity.
Partner
No
The partner whose service is to be invoked by
the activity.
The drop down menu lists all the partners with
port types having atleast one notification
service i.e., OUT-only MEP.
Operation
No
TIBCO ActiveMatrix BusinessWorks Palette Reference
Select the operation that is to be invoked from
the drop down menu. The drop down menu
lists all the available OUT only operations for
the selected partner.
Receive Partner Notification 593
|
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the receive partner notification activity is the following:
Output Item
Datatype
Description
output
message
complex
The output message for the operation contains
the output message parts as defined for the
selected operation.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity.
See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about
error codes and corrective action to take.
Exception
Thrown When...
InvalidEnvelopeException
The incoming message contains an
invalid envelope.
TIBCO ActiveMatrix BusinessWorks Palette Reference
594
| Chapter 16
Service Palette
Exception
Thrown When...
InternalException
There is an error during the internal
processing.
ConfigurationException
There is an error in the configuration.
DeserializationException
The incoming message cannot be
deserialized.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 595
|
Service
Shared Configuration
A Service shared configuration resource describes an interface and its
associated operations. The also specifies a set of endpoint bindings that
expose the service to potential clients over specific transports.
The user interface for the Service shared configuration resource can change
depending upon the additional products you have installed. For example, the
TIBCO BusinessWorks BPEL Extension offers more options when configuring the
Service resource. When you install a product that extends the Service resource, a
new field named Implementation Type appears that allows you to specify the
type of service you wish to configure depending upon the product you select. See
the documentation for the products you have installed for more information
about configuring a Service resource using those products. This section describes
the base TIBCO ActiveMatrix BusinessWorks Service resource.
Before creating a Service resource, you will need to create the following resources:
•
A WSDL file that contains an abstract interface description. The interface can
include one or more operations.
•
Process definitions will provide the implementation for each operation in the
service’s interface. You can specify the same process definition for more than
one operation.
•
Either an HTTP Connection or JMS Connection shared configuration resource
that specifies the transport used by clients of the service.
•
If you wish to pass context information from the incoming request (for
example, user name or security certificate), create a Context Resource that
specifies the context data you wish to use.
During deployment, Service resources must be added to a Process Archive.
Although it is possible to add a Service resource to a Shared archive, the resource
will not properly function when located in a Shared Archive. Add your Service
resources only to Process Archives.
Also when creating your enterprise archive file, the menu item Tools > Create
Project EAR only adds processes with process starters to the Process Archive for
the project. You must add any Service resources to the Process Archive by
selecting the Processes tab and clicking the Add a Process Starter to this archive
button.
To define a Service resource, follow this general procedure:
TIBCO ActiveMatrix BusinessWorks Palette Reference
596
| Chapter 16
Service Palette
1. Provide an abstract WSDL file (see WSDL on page 698) that describes the
interface to the service.
2. For each operation in the interface, specify a process definition that
implements the operation.
3. Specify one or more endpoint bindings to expose the service to potential
clients.
4. For each endpoint binding, specify a transport configuration (either HTTP
Connection or JMS Connection).
5. Specify any transport-specific information, such as endpoint URL for HTTP
transports or JMS Destination Name for JMS transports.
6. Specify any SOAP details, such as SOAP Version or encoding for each
operation.
7. Specify attachments, headers, or context information for input and output
messages, if necessary.
Only Bytes Message must be used when using MTOM attachments.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about services.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the resource.
Description
No
Short description of the resource.
Implementation
No
This field allows you to add abstract WSDL files
that describe the service. Click the + button to
add a WSDL file. Click the X button to remove a
WSDL file. Click the Rename Current Service
Port to change the name of the currently selected
service port.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 597
|
Field
Global
Var?
Description
Service Port Sub-Tabs
Each service port will have a sub-tab containing the configuration for the
service port.
Interface
Namespace
No
Namespace for the interface file of the service.
You can click the Go To Referenced Resource to
view the interface file.
Operations Sub-Tab
This sub-tab contains a table of all operations defined in the interface file. This
table allows you to specify the resource that implements each operation.
Operation
Name
No
Name of the operation. This column is a
read-only list of operations contained in the
interface file.
Operation
Implementation
No
Double click on this field and use the Browse
button to locate the resource that implements
each operation. Process definitions that
implement an operation must have an input,
output, and error schemas that match the input,
output, and fault messages of the operation.
You can leave the implementation for an
operation unspecified. In this case, an exception
is thrown when a client attempts to invoke the
unimplemented operation.
Note: You can drag and drop a process definition
from the project tree to the operation
implementation cell. If the signature of the
operation matches the process definition, the
process be inserted. If the process definition or
the WSDL changes, the icon for the process
definition in the cell changes to a warning
triangle indicating the operation and
implementation signatures no longer match.
TIBCO ActiveMatrix BusinessWorks Palette Reference
598
| Chapter 16
Service Palette
Field
Global
Var?
Description
Endpoint Bindings Sub-Tab
This sub-tab allows you to specify one or more endpoints that expose the
service as well as the transport bindings for each endpoint.
Use the + button to add endpoints, use the X button to delete endpoints, and
use the arrow buttons to move the selected endpoint in the list.
Endpoint Name
No
Specify a name for the endpoint in this field.
Endpoint Type
No
Specify the type of endpoint by selecting from
the list of types.
•
Local — A local endpoint is available to
consumers within the same process engine.
This type of endpoint provides a highly
efficient way for local services to invoke each
other without incurring the overhead of
using a network transport.
•
SOAP — A SOAP endpoint is used to expose
the service by way of the SOAP protocol to
other partner services or web clients
Transport Sub-Tab
Transport
No
Use the Browse button to select a transport. In
this release, HTTP Connection or JMS
Connection resources can be used as transports.
Use Basic
Authentication
Yes
This field is available when an HTTP transport is
selected.
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 in the domain using
TIBCO Administrator).
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 599
|
Field
Global
Var?
Description
Endpoint URI
No
This field is available when an HTTP transport is
selected.
This field specifies the Endpoint URI that clients
can use to access the service.
JMS Destination
No
This field is available when a JMS transport is
selected.
This field specifies the name of the destination
for incoming JMS messages for this service. The
syntax of the destination name is specific to the
JMS provider you are using. See your JMS
provider documentation for more information
about destination names.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field.
The Browse button displays a list of configured
destinations in the JMS server that are
appropriate for this activity.
JMS Destination
Type
No
This field is available when a JMS transport is
selected.
This field specifies whether the JMS Destination
is a Topic or a Queue.
JMS Message
Type
No
This field is available when a JMS transport is
selected.
This field specifies the type of incoming
messages on the specified destination. Can be
either Text Message or Bytes message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
600
| Chapter 16
Service Palette
Field
Global
Var?
Description
Acknowledge
Mode
No
This field is available when a JMS transport is
selected.
This field specifies the acknowledgement mode
to use for incoming messages. Can be one of the
following:
TIBCO ActiveMatrix BusinessWorks Palette Reference
•
Auto — the message is automatically
acknowledged when it is received.
•
Client — the message will be acknowledged
when the process implementing the
operation ends successfully.
•
Dups OK — the message is acknowledged
automatically when it is received. JMS
provides this mode for lazy
acknowledgement, but TIBCO ActiveMatrix
BusinessWorks acknowledges messages
upon receipt.
•
TIBCO EMS Explicit Client Acknowledge —
this mode behaves exactly the same as the
Client mode, except the session is not
blocked and one session can handle all the
incoming messages.
Service 601
|
Field
Global
Var?
Description
Max Sessions
No
This field is available when a JMS transport is
selected and Client is selected as the
Acknowledge Mode. If the JMS Destination Type
is Topic, this field is read-only. If the JMS
Destination Type is Queue, the value of this field
can be altered.
This field specifies the maximum number of JMS
sessions to create for incoming queue messages.
When a JMS queue message is received, the
session is blocked until the message is
acknowledged. Because the acknowledgement
can comes at a later time when the process ends,
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.
Operations
No
This field is available when a JMS transport is
selected and Topic is selected as the JMS
destination type.
SOAP Details Sub-Tab
Default Style
No
The SOAP binding style for operations that do
not explicitly set their binding style. You can
specify either Document or RPC style.
SOAP Version
No
Specify either SOAP 1.1 or SOAP 1.2 for the
version of the SOAP specification to which
incoming messages should comply.
See SOAP Specification Compliance on page 618
for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
602
| Chapter 16
Service Palette
Field
Global
Var?
Description
Operations
No
Select each operation from the drop down list to
specify the SOAP Action, Style, or Encoding for
the operation.
SOAP Action
No
The soapAction that is expected from incoming
SOAP requests. This field is required, and by
default, the operation name is used as the
soapAction. Each operation in an interface must
have a unique value for SOAP Action.
See the SOAP specification for more information
about soapAction.
Style
No
The SOAP binding style for the selected
operation. You can specify either Document or
RPC style, or you can specify that the value in the
Default Style field should be used.
Encoding
No
The encoding type for the body of the SOAP
input and output messages. This can be either
literal or encoded.
Encoded messages support more complex
datatypes such as SOAP arrays.
When encoded is specified, you can optionally
specify the namespace for input, output, and
fault messages.
Input Message
Namespace
No
The namespace for input messages.
Output Message
Namespace
No
The namespace for output messages.
Fault Message
Namespace
No
The namespace for fault messages.
Advanced SOAP Settings
For each operation, you can specify advanced configuration options. To access the
advanced configuration options, perform the following:
1. Click the Endpoint Bindings Tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 603
|
2. Select the desired endpoint and click the SOAP Details sub-tab.
3. Select the operation in the Operations field.
4. Click the Advanced button next to the operation name.
The Advanced SOAP Settings dialog appears. The following sections describe
the tabs on this dialog.
Input Attachments
See Messages With Attachments on page 653 for more information about message
attachments.
The Input Attachments tab has the following fields.
Field
Description
Mime Content Type
The table containing this column allows you to
specify the mime content type of each message
part. This is especially useful for describing
parts that contain attachments. See the mime
specification for more information on the valid
syntax of the content type.
If specified, the content type appears in the
WSDL for the specified part.
Use the X, +, and arrow keys to delete, add, and
move parts in the list.
Message Part
The message part that you would like to specify
the content type for. This field is a drop down
list of message parts.
TIBCO ActiveMatrix BusinessWorks Palette Reference
604
| Chapter 16
Service Palette
Field
Description
Write to File
Checking this field specifies that incoming
messages whose attachments exceed the
specified threshold size should be written to a
file instead of stored in memory. This allows you
to accept large incoming attachments without
consuming a great deal of memory. When this
field is checked, the Directory and Threshold
Size fields appear.
Leaving this field unchecked specifies that
attachments of incoming messages should be
kept in memory.
Once written, the files created by using this
option are not deleted automatically. You must
manage the storage used by these files and
delete them when they are no longer used.
Note: The Write to File field and it’s related
fields, Directory and Threshold Size, are not
applicable to MTOM attachments.
Directory
This field only appears when the Write to File
field is checked.
The directory to write attachments that are
above the specified threshold. The process
engine does not attempt to create the directory if
the specified directory does not exist. Therefore,
create the directory before starting the process
engine.
Note: This field is not applicable to MTOM
attachments.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 605
|
Field
Description
Threshold Data Size (bytes)
This field only appears when the Write to File
field is checked.
The maximum size (in bytes) of an incoming
message attachment that can be kept in memory.
Attachments larger than the specified size are
written to a file in the specified directory. The
file’s name is output so that subsequent
activities in the process definition can access the
file and read its contents.
Specifying zero (0) in this field causes all
incoming messages to be saved to a file.
Note: This field is not applicable to MTOM
attachments.
Input Headers
The Input Headers tab allows you to specify a SOAP message parts used for any
SOAP headers expected in the incoming request. The specified input headers are
also included in the concrete bindings in the generated WSDL file.
Use the +, X, and arrow keys to add, delete and move the input header messages
in the list.
The Input Headers tab has the following fields.
Field
Description
Message Name
The message in a WSDL file to use as the input
header for the incoming SOAP request. This
WSDL file does not have to be the same as the
file used for output headers or the file used to
configure the port type and operation of the
incoming request.
Use the Browse button in this field to search for
valid WSDL File resources and to select the
desired message in the WSDL File.
Part Name
This field contains a drop down list with all
parts of the specified SOAP message. You can
specify a namespace or encoding for the part, if
applicable.
TIBCO ActiveMatrix BusinessWorks Palette Reference
606
| Chapter 16
Service Palette
Field
Description
Namespace
Namespace for the selected input header
message.
Encoding
Encoding to use for the selected input header
message.
Output Attachments
See Messages With Attachments on page 653 for more information about message
attachments.
The Output Attachments tab has the following fields.
Field
Description
Attachment Style
This field allows you to choose the attachment
style for the outbound/response messages. Two
attachment styles are available: SwA and
MTOM. The attachment style MTOM is
available only if the activity uses SOAP 1.2 and
is not displayed when SOAP 1.1 is used.
Attachments
Mime Content Type
The table containing this column allows you to
specify the mime content type of each message
part. This is especially useful for parts that
contain attachments. See the mime specification
for more information on the valid syntax of the
content type.
If specified, the content type appears in the
WSDL for the specified part.
Use the X, +, and arrow keys to delete, add, and
move parts in the list.
Message Part
TIBCO ActiveMatrix BusinessWorks Palette Reference
The message part that you would like to specify
the content type for. This field is a drop down
list of message parts.
Service 607
|
Output Headers
The Output Headers tab allows you to specify a SOAP message parts used for any
SOAP headers expected in the outgoing reply. The specified output headers are
also included in the concrete bindings in the generated WSDL file.
Use the +, X, and arrow keys to add, delete and move the input header messages
in the list.
The Output Headers tab has the following fields.
Field
Description
Message Name
The message in a WSDL file to use as the output
header for the SOAP request. This WSDL file
does not have to be the same as the file used for
input headers or the file used to configure the
port type and operation of the incoming request.
Use the Browse button in this field to search for
valid WSDL File resources and to select the
desired message in the WSDL File.
Part Name
This field contains a drop down list with all
parts of the specified SOAP message. You can
specify a namespace or encoding for the part, if
applicable.
Input Context
The Input Context tab allows you to specify a Context Resource that contains
transport-specific data. The data you provide to the context resource is available
to the process definition that implements the operation.
The Input Context tab has the following fields.
Field
Description
Shared Context
The Context Resource that specifies the schema
you wish to use. The schema of this resource
should include elements for each data element
from the transport information you wish to
provide to a process definition that implements
the operation.
TIBCO ActiveMatrix BusinessWorks Palette Reference
608
| Chapter 16
Service Palette
Field
Description
Expose Security Context
This field is available for either HTTP or JMS
transports. This field is only available when a
Context resource is specified in the Shared
Context field.
Places the information from the user’s security
context (either authentication or SSL certificate
information) into the Context/SecurityContext
element of the Input Context.
This is a fairly expensive operation and SSL
certificates can consume memory resources, so
check this option only if you require
information from the user’s security context for
later use in your process definition.
Mapping Panel
The mapping panel is similar to the mapping
panel provided in the Input tab of activities.
This panel allows you to map transport-specific
information from the incoming request to the
data elements of the specified Context Resource.
The mapping panel appears only when a
Context resource is specified in the Shared
Context field.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
mapping and transforming input data.
When the Expose Security Context field is checked, the following schema is
available in the Mapping Panel field.
Element
Datatype
Description
Context
complex
This element holds the optional
SecurityContext element and the
RemoteAddress and RemoteHost
elements described below.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 609
|
Element
Datatype
Description
SecurityContext
complex
This output element is only available
when the Expose Security Context field
is checked on the Configuration tab. This
element contains information about the
requestor’s authentication or certificate
information, depending upon the
security scheme used. See the
description of the following elements
contained in the SecurityContext
element for more information.
Transport
complex
This element is only available when
HTTP is the transport, this element is not
available when JMS is the transport.
This element contains the transport-level
security context. This includes the
following:
WSSE
complex
•
CertificateToken— complex element
containing the subject, issuer, serial
number, fingerprint, and X509
certificate.
•
UsernameToken — complex element
containing the username, password,
and nonce (random number, if one is
set by the calling application).
This element contains the WSS policy
security context. This includes the
Authentication and Signature elements.
See the description of these elements
below.
TIBCO ActiveMatrix BusinessWorks Palette Reference
610
| Chapter 16
Service Palette
Element
Datatype
Description
Authentication
complex
This element contains the authentication
information from the client. The type of
information in this elements depends
upon how the client authenticated. This
element can contain one of the following:
Signature
RemoteAddress
complex
String
•
UsernameToken — complex element
containing the username, password,
and nonce (random number, if one is
set by the calling application).
•
KeyInfo — the client’s public key.
This element contains information from
the user’s digital signature. This element
contains the following:
•
Value — this element contains the
raw signature sent by the client.
•
Token — either a UsernameToken or
a KeyInfo element. A
UsernameToken element contains
the username, password, and nonce,
if available. A KeyInfo element
contains information about the
client’s digital certificate or public
key.
IP address of the remote host that sent
the HTTP request.
This element is only available when
HTTP is the specified transport. This
element is not available for the JMS
transport.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 611
|
Element
Datatype
Description
RemoteHost
String
Host name of the remote host that sent
the HTTP request. This element is only
available when the Enable DNS Lookups
field is checked on the Advanced tab of
the HTTP Connection used by this
activity.
This element is only available when
HTTP is the specified transport. This
element is not available for the JMS
transport.
Output Context
The Output Context tab allows you to specify a Context Resource that contains
data the process definition implementing the operation has provided. The data
can then be mapped to Headers of the output message returned to the client.
The Output Context tab has the following fields.
Field
Description
Shared Context
The Context Resource that specifies the schema
you wish to use. The schema of this resource
should include elements for each data element
you wish to provide to the output Headers for
the message.
Mapping Panel
The mapping panel is similar to the mapping
panel provided in the Input tab of activities.
This panel allows you to map data provided by
the implementation of the operation to the
transport-specific headers of the reply message
sent to the client. The mapping panel appears
only when a Context resource is specified in the
Shared Context field.
See TIBCO ActiveMatrix BusinessWorks Process
Design Guide for more information about
mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
612
| Chapter 16
Service Palette
Partner Binding
The Partner Binding tab allows you to bind partners invoked by all operations in
a service on the Partner Binding tab of the Service. Only partners that require
binding appear on this tab. The Partner Binding tab has the following fields:
Field
Description
Partner Bindings
The Partner Bindings field allows you to specify
binding information for partner definitions. The
Partner Name and Process fields in the table are
non-editable.
Partner Name - name of the partner as specified
in the Process Definition.
Process - The process in which the partner is
declared.
PortType Namespace - This is a non-editable
field displaying the PortType Namespace
corresponding to the Port Type selected.
Partner Link - the partner link configuration for
the partner. This field can optionally be
specified by double-clicking on the field and
browsing the list of available partner link
resources in the project.
Dynamic Call Processes
The Dynamic Call Processes field allows you to
specify a list of processes that can be
dynamically invoked by processes invoked by
all operations in the service. You can add or
remove processes from the list.
Processes declared in the Dynamic Call Processes field are automatically included
in Enterprise Archive (EAR) files.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Service 613
|
WSDL Source
The WSDL Source tab displays the concrete WSDL interface file that is generated
based on the information specified on the Configuration tab of this resource. This
tab has the following fields.
Field
Global
Var?
Service URI
No
Description
The Service URI portion of the URL that can be used
to retrieve the WSDL file. For clients to retrieve
WSDL files from TIBCO ActiveMatrix
BusinessWorks, you must define a process definition
that accepts HTTP requests and uses the Retrieve
Resources activity to generate the WSDL file. See
Using Retrieve Resources on page 620 for more
information.
The URL to retrieve WSDL files is the following:
http://<host>:<port>/<serviceURI>?wsdl
where <serviceURI> is the value in this field.
Target
Namespace
No
Target namespace of the Service.
Embed In
WSDL
No
Check one or more of the following to embed the
selected item(s) in the concrete WSDL file instead of
using import statements:
•
Interface — When checked, specifies that all
referenced WSDL files should be included inline
in the concrete WSDL file. Otherwise, all
referenced WSDL files are imported.
•
Types — When checked, specifies that all
referenced XSD files should be included inline in
the concrete WSDL file. Otherwise, all referenced
XSD files are imported.
•
JNDI Properties — When checked, specifies that
JDNI properties should be included inline in the
service specification in the WSDL Source tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
614
| Chapter 16
Service Palette
Field
Global
Var?
Description
WSDL Code
No
This field displays the concrete WSDL file that
describes this service.
Click the Save WSDL File button to save the concrete
WSDL file to disk, if desired.
Overview
The Overview tab provides a tree view of the service that you can expand and
collapse to view the exposed endpoints and operations for the service.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Set Context 615
|
Set Context
Activity
The Set Context activity allows you to set the value of a Context
Resource shared configuration resource. This is useful if you wish to
supply data from the process definition implementing an operation to
the service agent. For example, you may wish to set some headers of
the outgoing reply message.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about context separation for Service resources and operation implementations.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity
in the process definition.
Description
No
Short description of the activity.
Context
Configuration
No
The Context Resource whose value you would
like to change.
Output New
Value
No
When checked, the new value of the context
resource is placed into this activity’s output.
The value is then available to subsequent
activities in the process definition.
Description
If not checked, this activity has no output.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
616
| Chapter 16
Service Palette
The input for the activity is the following.
Input Item
Datatype
Description
<schema>
varies
The schema of the context resource
specified in the Context
Configuration field on the
Configuration tab is the input
schema for this activity.
Output
The output for the activity is the following.
Output Item
Datatype
Description
<schema>
varies
When the Output New Value field on
the Configuration tab is unchecked,
this activity has no output. When the
field is checked, the new value of the
context resource is output. The schema
for the output is determined by the
schema specified for the context
resource.
or no output
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 617
Chapter 17
SOAP Palette
Simple Object Access Protocol (SOAP) is a lightweight, XML-based protocol for
the exchange of information between applications. The SOAP palette, along with
the WSDL Palette allow you to implement web services. The SOAP palette allows
you do the following:
•
create web services by using process definitions
•
generate WSDL files for web service clients
•
invoke one-way, request/reply web services
•
use either HTTP or JMS as the transport for web services
•
send or receive SOAP requests with attachments
•
SOAP Specification Compliance, page 618
•
SOAP Event Source, page 627
•
SOAP Event Source, page 627
•
SOAP Request Reply, page 645
•
SOAP Send Fault, page 662
•
SOAP Send Reply, page 665
•
SOAP Messages Over the JMS Transport, page 667
•
MimeParser, page 671
Topics
TIBCO ActiveMatrix BusinessWorks Palette Reference
618
| Chapter 17
SOAP Palette
SOAP Specification Compliance
The SOAP specification is maintained by the World Wide Web Consortium
(W3C). You can find the SOAP specification at www.w3.org/TR/SOAP. TIBCO
ActiveMatrix BusinessWorks can send and receive messages that comply with
either the 1.1 or 1.2 version of the SOAP specification. For SOAP 1.2 messages, not
all of the features described in the specification are available in TIBCO
ActiveMatrix BusinessWorks.
Receiving SOAP Messages with the SOAP Event Source
The SOAP Event Source process starter can be configured to receive either SOAP
1.1 or 1.2 compliant messages. You specify the version of the incoming messages
in the SOAP Version field on the Configuration tab of the SOAP Event Source.
SOAP Reply and SOAP Fault activities in the same process definition will use the
same SOAP message version as specified in the SOAP Event Source. SOAP Event
Source can handle inbound SOAP messages with attachments with either SwA or
MTOM attachment styles.
Using the SOAP Request/Reply Activity
The SOAP Request/Reply activity sends either a SOAP 1.1 or 1.2 compliant
message depending upon the SOAP version specified in the WSDL file. If a SOAP
1.2 message is required, TIBCO ActiveMatrix BusinessWorks sends a message
that complies with the SOAP 1.2 specification. When the SOAP server returns a
Fault message, the SOAP 1.2 fault message is mapped to the TIBCO ActiveMatrix
BusinessWorks fault schema as described in Fault Schemas on page 618.
Fault Schemas
The specification of the schema for SOAP Fault messages has changed between
release 1.1 and 1.2 of the SOAP specification. TIBCO ActiveMatrix BusinessWorks
uses the same schema for SOAP Fault messages regardless of the version of the
specification. Because of this, the content of Fault messages that comply with
SOAP 1.2 is mapped to the TIBCO ActiveMatrix BusinessWorks SOAP Fault
schema.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Specification Compliance 619
|
Table 11 describes the relationship of the data elements between the TIBCO
ActiveMatrix BusinessWorks SOAP Fault schema and the SOAP Fault 1.1 and 1.2
schemas..
Table 11 SOAP Fault schema relationship
TIBCO ActiveMatrix
BusinessWorks SOAP
Fault Schema Element
SOAP Fault Schema
Element 1.1
SOAP Fault Schema
Element 1.2
faultcode
faultcode
Code/Value
Note: Code/Subcode
will not be present.
faultstring
faultstring
Reason/Text[1]
Note: There will be only
one Text element within
the Reason element.
faultfactor
faultfactor
Role
detail
detail
Detail
TIBCO ActiveMatrix BusinessWorks Palette Reference
620
| Chapter 17
SOAP Palette
Retrieve Resources
Activity
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
ActiveMatrix BusinessWorks process definition. The client can then use the
WSDL file to invoke the web service.
The Retrieve Resources activity can also be used to retrieve any other resources,
including XSDs and WSIL.
Using Retrieve Resources
This activity is normally used in conjunction with an HTTP Receiver process
starter and a Send HTTP Response activity. The HTTP Receiver process starter
can receive an HTTP request and pass it along to the Retrieve Resources activity.
When a request is made to retrieve a WSDL file for a process definition that has a
SOAP Event Source process starter, Retrieve Resources creates a WSDL file
dynamically. This file contains the concrete service definition of the specified
BusinessWorks process definition. The WSDL file or other requested resources are
then placed into the output for this activity.
You can then pass the output of the Retrieve Resources activity to the Send HTTP
Response activity to send the response back to the requestor.
Figure 29 illustrates a process definition using the Retrieve Resources activity.
Figure 29 Process definition using the Retrieve Resources activity
The HTTP Receiver process starter can be configured to use the HTTPS protocol
for SSL communication when retrieving resources. See HTTP Receiver on
page 222 for more information.
When sending the HTTP response, set the Headers/Content-Type item on the
Input tab to the appropriate type for the type of resource retrieved. Use
"text/xml" when this activity is used to retrieve a WSDL file. See Format of URLs
for HTTP Requests on page 621 for more information on the format of the URL for
the HTTP request for retrieving resources.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Retrieve Resources 621
|
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.
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
ActiveMatrix BusinessWorks Process Design Guide.
Format of URLs for HTTP Requests
To use the Retrieve Resources activity, the HTTP request must have one of the
following forms:
•
http://<host>:<port>/<path>/<resourceName>?wsdl
•
http://<host>:<port>/<path>/<resourceName>
•
http://<host>:<port>/inspection.wsil
Option
Description
<host>
Host name of the machine that is listening for the HTTP
request.
<port>
Port is the port number on the machine for incoming
HTTP requests. This is specified on the Configuration tab
of the HTTP Receiver process starer.
<path>
The location of the resource in the TIBCO ActiveMatrix
BusinessWorks project tree.
Note: Any special characters in the path or resource
name (such as &, =, or space) are mangled in the
generated WSDL file. It is a good idea to avoid special
characters in the folder and resource names.
<resourceName>
The name of the resource to retrieve.
If you are retrieving a WSDL file for a process definition,
use the name of the process definition followed by ?wsdl.
If you are retrieving other resources (such as XSD files,
images, and so on), specify the name of the resource, such
as mySchema.xsd, myProcess.process, or myImage.gif.
Note: Use resourceName.serviceagent to reference a Receive
Partner Notification resource
TIBCO ActiveMatrix BusinessWorks Palette Reference
622
| Chapter 17
SOAP Palette
Option
Description
inspection.wsil
Used to 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 in the project will be contained in
the WSIL file.
Examples
The following is an HTTP request that retrieves the WSDL file for the process
named GetPurchaseOrder stored in the folder Purchasing:
http://purch:8877/Purchasing/GetPurchaseOrder?wsdl
The following is an HTTP request that retrieves a WSIL file containing all process
definitions with SOAP Event Source process starters:
http://purch:8877/inspection.wsil
The following is an HTTP request that retrieves the PurchaseOrder.xsd file:
http://purch:8877/Purchasing/Schemas/PurchaseOrder.xsd
The following is an HTTP request that retrieves the WSDL file for the Service
resource named BuyerService :
http://server:8877/BuyerService.serviceagent?wsdl
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Description
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Retrieve Resources 623
|
The input for the activity is the following.
Input Item
Datatype
Description
resourcePath
string
The resource name (and its location in the
project tree) that you wish to retrieve.
This overrides to the <path> and
<resourceName> portion of the incoming HTTP
request that is used to retrieve TIBCO
ActiveMatrix BusinessWorks resources. See
Format of URLs for HTTP Requests on
page 621 for a description of the URL format
for HTTP requests.
filter
string
This overrides the query string of the
incoming HTTP request to specify the type of
filter to use when retrieving resources. The
only available filter is "wsdl" to retrieve the
concrete WSDL for a process definition that
implements a SOAP service.
You can use this input element to allow
incoming HTTP requests to omit the query
string when retrieving concrete WSDL files.
You can specify an XPath expression in this
element that examines the incoming request
and sets this element to "wsdl" when the
incoming request matches a process
definition name.
hostname
string
The hostname to specify for the concrete
service endpoint in the dynamically
generated WSDL file.
Note: This value is used when creating the
import statements (WSDL descriptions,
WSIL, and XSDs).
port
string
The port number to specify for the concrete
service endpoint in the dynamically
generated WSDL file.
Note: This value is used when creating the
import statements (WSDL descriptions,
WSIL, and XSDs).
TIBCO ActiveMatrix BusinessWorks Palette Reference
624
| Chapter 17
SOAP Palette
Output
The output for the activity is the following.
Output Item
Datatype
Description
outputClass
complex
The root class for the output of the
Retrieve Resources activity. This
class contains all output items for
the activity.
resourceData
string
The resource 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 a Send
HTTP Response activity and
binding this value to the
asciiContent of the response.
resourceBytes
binary
The retrieved resource as binary
data. This is useful if binary data,
such as an image, is part of the
resource.
If the retrieved resource is only
binary data, the resourceData
string element is not available.
You can pass this data back to the
HTTP requestor by using an HTTP
Send Response activity and
binding this value to the
binaryContent of the response.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ServerException
An error occurred and the resource could
not be sent to the client.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Retrieve Resources 625
|
Built-in Resource Provider
TIBCO ActiveMatrix BusinessWorks provides an alternative way to retrieve
resources using a feature called Built-in Resource Provider.
This feature enables the BusinessWorks engine to listen on a configured port and
retrieve resources such as a WSDL file, XSD file, Process file, Image file, etc. This
out-of-the-box solution performs tasks similar to that of the Retrieve Resource
activity, but eliminates the need to create a process definition to use the Retrieve
Resource activity. Refer to Figure 29, Process definition using the Retrieve
Resources activity, on page 620 for details about the process definition.
Since the feature works the same as Retrieve Resource activity, the client side
functionalities with respect to Retrieve Resource activity remain the same.
However, the only exception is that this feature does not support Client
authentication for SSL.
TIBCO BusinessWorks provides parameters to enable or disable the feature, and
override the defaults configuration. You can set these values in the bwengine.xml
to be reflected in the TIBCO Administrator after deploying the project.
bw.platform.services.retreiveresources.Enabled
This property specifies whether the Built-in Resource Provider feature is enabled
or not. Setting it to true enables the feature. By default it is set to false.
bw.platform.services.retreiveresources.Httpport
This property specifies the port number that is configured to listen for incoming
HTTP requests. This property is set to 8010 by default.
bw.platform.services.retreiveresources.isSecure
This property specifies if the incoming requests must use the HTTPS (secure
socket layer) protocol. The HTTPS protocol authenticates the server to the client.
By default, this property is set to false.
bw.platform.services.retreiveresources.enableLookups
This property, when set to true, enables the HTTP client to look up a Domain
Name System and resolve the IP address to a DNS Name.
Setting this property to true adversely affects the throughput. Hence this property
can be enabled only when required. By default, this property is set to false.
TIBCO ActiveMatrix BusinessWorks Palette Reference
626
| Chapter 17
SOAP Palette
bw.platform.services.retreiveresources.defaultEncoding
This property specifies the encoding to use for the URL if no charset is specified in
the Content Type header of the message. By default, this property is set to
ISO-8859-1.
bw.platform.services.retreiveresources.identity
This property specifies the Identity resource that contains the HTTP Server’s
digital certificate and private key. This property is available when the
bw.platform.services.retreiveresources.isSecure property is set to true.
bw.platform.services.retreiveresources.Hostname
This property specifies the hostname to which the request will be sent. It is useful
to identify the exact host in a multi-host configuration to whom the request will
be sent.By default, this property is set to localhost.
When an Enterprise Archive file, generated with TIBCO BusinessWorks 5.4.x or
earlier versions, is deployed in TIBCO Administrator, the built-in resource
provider parameters are not available in TIBCO Administrator.
To enable specifying the built-in resource provider parameters, recreate the
Enterprise Archive file with TIBCO ActiveMatrix BusinessWorks 5.6.0 and deploy
in TIBCO Administrator.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 627
|
SOAP Event Source
Process Starter
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 a web service
using process definitions.
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 file is retrieved, the
client can perform a SOAP request to invoke the web service.
WSDL File and SOAP Event Source
A WSDL File specifies the characteristics (input message, output message, fault
message, and so on) of a web service. The SOAP Event Source process starter
configuration determines the concrete WSDL file that describes the web service
that the process definition implements.
The Configuration tab of this process starter requires that you specify a Port Type.
This port type is taken from a WSDL file resource. Instead of creating a new
WSDL File resource, you can use an existing concrete service description.
However, the concrete description of the service will be generated based on the
configuration of this process starter.
Only Bytes Message must be used when using MTOM attachments.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
TIBCO ActiveMatrix BusinessWorks Palette Reference
628
| Chapter 17
SOAP Palette
Field
Global
Var?
Description
Port Type
No
The Port Type field is a two-part field. The first
part is the namespace of the stored WSDL file that
contains the service description. This is specified
or imported as a WSDL File resource. See
Chapter 20, WSDL Palette, on page 697 for more
information about specifying abstract and
concrete service descriptions.
The second part of the Port Type field is the name
of the port type in the WSDL file that contains the
operation you wish to implement with this
process definition. This is a drop down list that is
populated after the WSDL file is specified.
Operation
No
The operation that this process definition
implements.
The drop down list in this field is populated with
the operations contained in the specified port type
in the specified WSDL.
You can choose one operation to implement per
process definition. If you wish to implement
multiple operations, you must create a process
definition for each.
Transport
No
The transport used by the incoming SOAP
request. The transport can be one of the following:
•
HTTP — specify a HTTP Connection shared
configuration resource.
•
JMS — specify a JMS Connection shared
configuration resource
Both HTTP and JMS allow you to use the SSL
protocol for secure connections.
SOAP Version
No
Specify either SOAP 1.1 or SOAP 1.2 for the
version of the SOAP specification to which
incoming messages should comply.
See SOAP Specification Compliance on page 618
for more information.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 629
|
Field
Global
Var?
Description
Expose Security
Context
No
Places the information from the user’s security
context (either authentication or SSL certificate
information) into the Context/SecurityContext
output element.
This is a fairly expensive operation and SSL
certificates can consume memory resources, so
check this option only if you require information
from the user’s security context for later use in
your process definition.
Transport Details
The Transport Details tab allows you to specify additional configuration
information based on the type of transport used for the SOAP request. See SOAP
Messages Over the JMS Transport on page 667 for more information about SOAP
over the JMS transport.
The Transport Details tab contains the following fields:
Field
Global
Var?
Description
No
When checked, this field specifies that incoming
SOAP requests must supply a valid username and
password.
HTTP Transport
Use Basic
Authentication
The user name and password specified in the
incoming request must exist in the domain (users
are created and managed in the domain using
TIBCO Administrator).
TIBCO ActiveMatrix BusinessWorks Palette Reference
630
| Chapter 17
SOAP Palette
Field
Global
Var?
Description
No
Name of the JMS destination for incoming
requests.
JMS Transport
JMS
Destination
The syntax of the destination name is specific to
the JMS provider you are using. See your JMS
provider documentation for more information
about destination names.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field and a
destination type in the JMS Destination Type field.
The Browse button displays a list of configured
destinations in the JMS server that are of the
specified type.
JMS
Destination
Type
No
Specify either Queue or Topic as the destination
type.
Durable
Subscription
No
This field is only available when Topic is selected
in the JMS Destination Type field.
This field 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
No
This field is only available when Topic is selected
in the JMS Destination Type field.
This field specifies the subscription name
registered with the JMS application for durable
subscriptions. This field is only available when the
Durable subscription field is checked.
Once a durable subscription is created, it can only
be removed by accessing the administration tool
of the JMS provider. See the documentation of
your JMS provider for more information about
managing durable subscriptions.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 631
|
Field
Global
Var?
Description
JMS Message
Type
Yes
The type of the message. This can be one of the
following:
Acknowledge
Mode
Yes
•
Bytes Message — A stream of bytes.
•
Text Message — The message is a
java.lang.String.
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. If
the message is not confirmed before the
process instance ends, the message is
redelivered. Ensure that your process
definition confirms the message when using
this acknowledge mode.
•
Dups OK — the message is acknowledged
automatically when it is received. JMS
provides this mode for lazy
acknowledgement, but TIBCO ActiveMatrix
BusinessWorks acknowledges messages upon
receipt.
•
TIBCO EMS Explicit Client Acknowledge —
(only available for TIBCO EMS) the message
will be acknowledged at a later point by using
the Confirm activity. The session is not blocked
and one session handles all incoming
messages for each process instance. If a
message is not confirmed before the process
instance ends, all messages received in the
same session are redelivered.
TIBCO ActiveMatrix BusinessWorks Palette Reference
632
| Chapter 17
SOAP Palette
Field
Global
Var?
Description
Max Sessions
No
This field is available when Client is selected as
the Acknowledge Mode. If the JMS Destination
Type is Topic, this field is read-only. If the JMS
Destination Type is Queue, the value of this field
can be altered.
This field specifies the maximum number of JMS
sessions to create for incoming queue messages.
When a JMS queue message is received, the
session is blocked until the message is
acknowledged. Because the acknowledgement can
comes at a later time when the process ends, 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.
Messages With Attachments
SOAP messages can have message parts that contain attachments. For a message
part to contain an attachment, specify the Special Type in the Type field of the Part
Details section of the Message resource when creating a WSDL file configuration.
See Chapter 20, WSDL Palette, on page 697 for more information about creating
WSDL files.
Depending on the SOAP version being used, messages with attachments can
conform to one of the following styles:
•
Messages with Attachments (SwA) - available with SOAP version 1.1 and 1.2.
•
Message Transmission Optimization Mechanism (MTOM) - available only
with SOAP 1.2.
Messages with Attachments (SwA)
SOAP clients that send messages with attachments in the SwA style must
conform to the SOAP Messages with Attachments specification
(http://www.w3.org/TR/SOAP-attachments).
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 633
|
The output schema element for a message part that contains an attachment will
hold the content ID of the attachment instead of holding the actual attachment
data. The actual data for attachments is always contained within the
mimeEnvelopeElement of the output schema for this resource. This element
contains a repeating element named mimePart that holds the list of attachments
in the SOAP message. The attachment list can be correlated to the message parts
containing the attachments by using the content-id mimeHeader element.
Message Transmission Optimization Mechanism (MTOM)
Message Transmission Optimization Mechanism (MTOM) provides another way
of sending binary content or attachment processing by serializing SOAP messages
with attachments. Optimization is only available for element content that is in a
canonical lexical representation of xs:base64Binary data type. MTOM conforms
to the specification http://www.w3.org/TR/soap12-mtom.
For an outbound SOAP Message with MTOM attachments sent by SOAP Request
Reply or SOAP Send Reply activities, any element of type xs:base64Binary (or
an extension of xs:base64Binary) in the SOAP response message is treated as an
MTOM attachment and appears as a separate MIME part on the wire.
For an inbound SOAP Message with MTOM attachments received by the SOAP
Event Source or SOAP Request Reply activities, the SOAP message will have a
XOP include reference to the attachment. Any XOP include reference in the SOAP
message will be replaced by the corresponding attachment’s content encoded in
Base64. Any MIME attachment that is not referenced from the SOAP Message
using XOP include reference will be ignored by the MTOM Processing layer.
Note that the attachment is a part of the SOAP Infoset.
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about MTOM.
Advanced
The Advanced tab contains the following fields:
Field
Description
General Sub-Tab
SOAP Action
The soapAction that is expected from incoming SOAP
requests. See the SOAP specification for more
information about soapAction.
TIBCO ActiveMatrix BusinessWorks Palette Reference
634
| Chapter 17
SOAP Palette
Field
Description
WSDL Namespace
The namespace for the concrete WSDL file specified
by this activity.
Style
The SOAP binding style. You can specify either
Document or RPC style.
Encoding
The encoding type for the body of the SOAP input
and output messages. This can be either literal or
encoded.
Encoded messages support more complex datatypes
such as SOAP arrays.
When encoded is specified, you can optionally specify
the namespace for input, output, and fault messages.
Input Message
Namespace
The namespace for input messages.
Output Message
Namespace
The namespace for output messages.
Fault Message
Namespace
The namespace for fault messages.
Embed Interface
When checked, specifies that all referenced WSDL
files should be included inline in the concrete WSDL
file. Otherwise, all referenced WSDL files are
imported.
Embed Types
When checked, specifies that all referenced XSD files
should be included inline in the concrete WSDL file.
Otherwise, all referenced XSD files are imported.
Embed JNDI
Properties
When checked, specifies that JDNI properties should
be included inline in the service specification in the
WSDL Source tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 635
|
Field
Description
Input Attachments Binding Sub-Tab
Mime Content Type
The table containing this column allows you to
specify the mime content type of each message part.
This is especially useful for describing parts that
contain attachments. See the mime specification for
more information on the valid syntax of the content
type.
If specified, the content type appears in the WSDL for
the specified part.
Use the X, +, and arrow keys to delete, add, and move
parts in the list.
Message Part
The message part that you would like to specify the
content type for. This field is a drop down list of
message parts.
Write to File
Checking this field specifies that incoming messages
whose attachments exceed the specified threshold
size should be written to a file instead of stored in
memory. This allows you to accept large incoming
attachments without consuming a great deal of
memory. When this field is checked, the Directory and
Threshold Size fields appear.
Leaving this field unchecked specifies that
attachments of incoming messages should be kept in
memory.
Once written, the files created by using this option are
not deleted automatically. You must manage the
storage used by these files and delete them when they
are no longer used.
Note: The Write to File field and it’s related fields,
Directory, Create Non-Existing Directories, and
Threshold Size, are not applicable to MTOM
attachments.
TIBCO ActiveMatrix BusinessWorks Palette Reference
636
| Chapter 17
SOAP Palette
Field
Description
Directory
The directory to write attachments that are above the
specified threshold. The process engine does not
attempt to create the directory if the specified
directory does not exist. Therefore, create the
directory before starting the process engine.
Note: This field is not applicable to MTOM
attachments.
Create Non-Existing
Directories
When checked, all directories in the path specified in
the Directory field are created, if they do not already
exist.
If this field is unchecked and there are one or more
directories in the specified path in the Directory field
that do not exist, an exception is raised.
Note: This field is not applicable to MTOM
attachments.
Threshold Data Size
(bytes)
The maximum size (in bytes) of an incoming message
attachment that can be kept in memory. Attachments
larger than the specified size are written to a file in the
specified directory. The file’s name is output so that
subsequent activities in the process definition can
access the file and read its contents.
Specifying zero (0) in this field causes all incoming
messages to be saved to a file.
Note: This field is not applicable to MTOM
attachments.
Output Attachments Binding Sub-Tab
Attachment Style
TIBCO ActiveMatrix BusinessWorks Palette Reference
This field allows you to choose the attachment style
for the outbound/response messages. Two
attachment styles are available: SwA and MTOM. The
attachment style MTOM is available only if the
activity uses SOAP 1.2 and is not displayed when
SOAP 1.1 is used.
SOAP Event Source 637
|
Field
Description
Mime Content Type
The table containing this column allows you to
specify the mime content type of each message part.
This is especially useful for parts that contain
attachments. See the mime specification for more
information on the valid syntax of the content type.
If specified, the content type appears in the WSDL for
the specified part.
Use the X, +, and arrow keys to delete, add, and move
parts in the list.
Message Part
The message part that you would like to specify the
content type for. This field is a drop down list of
message parts.
Input Headers Sub-Tab
The Input Headers sub-tab allows you to specify a SOAP message parts used
for any SOAP headers expected in the incoming request. The specified input
headers are also included in the concrete bindings in the generated WSDL file.
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.
Use the +, X, and arrow keys to add, delete and move the input header
messages in the list.
Message Name
The message in a WSDL file to use as the input header
for the incoming SOAP request. This WSDL file does
not have to be the same as the file used for output
headers or the file used to configure the port type and
operation of the incoming request.
Use the Browse button in this field to search for valid
WSDL File resources and to select the desired
message in the WSDL File.
Part Name
This field contains a drop down list with all parts of
the specified SOAP message. You can specify a
namespace or encoding for the part, if applicable.
Binding
Binding used for the part. This field must be "soap".
TIBCO ActiveMatrix BusinessWorks Palette Reference
638
| Chapter 17
SOAP Palette
Field
Description
Ouput Headers Sub-Tab
The Output Headers sub-tab allows you to specify a SOAP message parts used
for any SOAP headers expected in the outgoing reply. The specified output
headers are also included in the concrete bindings in the generated WSDL file.
Use the +, X, and arrow keys to add, delete and move the input header
messages in the list.
Message Name
The message in a WSDL file to use as the output
header for the SOAP request. This WSDL file does not
have to be the same as the file used for input headers
or the file used to configure the port type and
operation of the incoming request.
Use the Browse button in this field to search for valid
WSDL File resources and to select the desired
message in the WSDL File.
Part Name
This field contains a drop down list with all parts of
the specified SOAP message. You can specify a
namespace or encoding for the part, if applicable.
Binding
Binding used for the part. This field must be "soap".
WSDL Source
This tab displays the WSDL file that can be used to call the web service
implemented by this process definition. 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.
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 639
|
Misc
The Misc tab contains the following fields:
Field
Description
Sequencing Key
This field can contain an XPath expression that
specifies which processes should run in order. Process
instances with sequencing keys that evaluate to the
same value will be executed sequentially in the order
the process instance was created.
See TIBCO ActiveMatrix BusinessWorks Process Design
Guide for more information about controlling the
execution order of process instances and about XPath
expressions.
Custom Id
This field can contain an XPath expression that
specifies a custom ID for the process instance. This ID
is displayed in the View Service dialog of TIBCO
Administrator, and it is also available in the
$_processContext process variable.
Output
The output for the activity is the following.
Output Item
Datatype
Description
inputMessage or
<operationName>
depends
upon
type
specified
in WSDL
The message parts specified in the
WSDL file for the incoming SOAP
request.
The incoming request could contain
multiple parts and attachments, and
each part would be a message defined
in the WSDL file.
In case of MTOM attachments, the
attachments appear embedded in the
message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
640
| Chapter 17
SOAP Palette
Output Item
Datatype
Description
mimeEnvelopeElement
complex
This element contains the message
attachments when MIME attachments
with SwA style are used. This element
contains a repeating element named
mimePart that contains each MIME
attachment.
mimeHeaders
complex
This element contains the mime header
for each mimePart. Mime headers can
contain the following information:
•
content-disposition
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
Note: When the content type is
specified as "text/*" (for example,
"text/xml"), the attachment content is
expected to be in either the textContent
output element or the file name storing
the attachment is expected to be in the
fileName output element. When the
content type is anything other than
"text/*", the attachment content is
expected to be in either the
binaryContent output element or the
file name storing the attachment is
expected to be in the fileName output
element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Event Source 641
|
Output Item
Datatype
Description
binaryContent |
textContent | fileName
choice
This element contains the mime
attachment. The element can be one of
the following:
•
binaryContent — content of the
attachment when the attachment is
binary data.
•
textContent — content of the
attachment when the attachment is
text data.
•
fileName — the file name of the
attachment when the Write to File
field is checked on the Input
Attachment Bindings sub-tab of the
Advanced tab.
headers
complex
The header data supplied by the SOAP
request. The structure of this input item
is defined by the schema on the Input
Headers sub-tab of the Advanced tab.
Header.<partName>
complex
Headers can contain multiple parts. The
headers element contains all header
parts supplied by the incoming SOAP
request. These parts are specified on the
Input Headers sub-tab of the Advanced
tab. The header parts are stored in an
element named Header.<partName>
where <partName> is the name of the part
specified on the Input Headers tab.
Each Header.<partName> element also
contains an attribute named
@mustUnderstand. This boolean value
is set to true in the incoming request if
the client specifies that the server must
understand the header part.
Context
complex
This element holds the optional
SecurityContext element and the
RemoteAddress and RemoteHost
elements described below.
TIBCO ActiveMatrix BusinessWorks Palette Reference
642
| Chapter 17
SOAP Palette
Output Item
Datatype
Description
SecurityContext
complex
This output element is only available
when the Expose Security Context field
is checked on the Configuration tab.
This element contains information
about the requestor’s authentication or
certificate information, depending upon
the security scheme used. See the
description of the following elements
contained in the SecurityContext
element for more information.
Transport
complex
This element is only available when
HTTP is the transport, this element is
not available when JMS is the transport.
This element contains the
transport-level security context. This
includes the following:
WSSE
TIBCO ActiveMatrix BusinessWorks Palette Reference
complex
•
CertificateToken— complex element
containing the subject, issuer, serial
number, fingerprint, and X509
certificate.
•
UsernameToken — complex
element containing the username,
password, and nonce (random
number, if one is set by the calling
application).
This element contains the WSS policy
security context. This includes the
Authentication and Signature elements.
See the description of these elements
below.
SOAP Event Source 643
|
Output Item
Datatype
Description
Authentication
complex
This element contains the
authentication information from the
client. The type of information in this
elements depends upon how the client
authenticated. This element can contain
one of the following:
Signature
RemoteAddress
complex
String
•
UsernameToken — complex
element containing the username,
password, and nonce (random
number, if one is set by the calling
application).
•
KeyInfo — the client’s public key.
This element contains information from
the user’s digital signature. This
element contains the following:
•
Value — this element contains the
raw signature sent by the client.
•
Token — either a UsernameToken or
a KeyInfo element. A
UsernameToken element contains
the username, password, and nonce,
if available. A KeyInfo element
contains information about the
client’s digital certificate or public
key.
IP address of the remote host that sent
the HTTP request.
This element is only available when
HTTP is the specified transport. This
element is not available for the JMS
transport.
TIBCO ActiveMatrix BusinessWorks Palette Reference
644
| Chapter 17
SOAP Palette
Output Item
Datatype
Description
RemoteHost
String
Host name of the remote host that sent
the HTTP request. This element is only
available when the Enable DNS
Lookups field is checked on the
Advanced tab of the HTTP Connection
used by this activity.
This element is only available when
HTTP is the specified transport. This
element is not available for the JMS
transport.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 645
|
SOAP Request Reply
Activity
The SOAP Request Reply activity performs a request on the
specified web service and optionally expects a reply from the web
service. You can invoke both document and RPC web services
with this activity.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Service
No
This two-part field specifies the namespace and
the name of the web service. The service specified
must be a concrete service that has a binding to an
actual network endpoint.
Description
You can use the Browse 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 Port, Operation, and
Endpoint URL fields will then be populated by the
choices made in this dialog.
Port
No
The port in the WSDL file containing the desired
operation. The drop down list in this field is
populated based on the specified service.
Operation
No
The operation that this activity invokes. This field
is automatically populated when an operation is
selected using the Select a Resource dialog (see the
Service field for more information).
SOAP Action
Yes
The soapAction header for the operation. See the
SOAP specification for more information about
soapAction.
TIBCO ActiveMatrix BusinessWorks Palette Reference
646
| Chapter 17
SOAP Palette
Field
Global
Var?
Description
Timeout (secs)
Yes
The time to wait (in seconds) for the operation to
complete.
Attachment
Style
No
This field allows you to choose the attachment
style. Two attachment styles are available: SwA
and MTOM. The attachment style MTOM is
available only if the activity uses SOAP 1.2 and is
not displayed when SOAP 1.1 is used.
Reload Button
The Reload Button reloads the WSDL file. If the WSDL file has changed since it
was last loaded, the configuration, input, output, and error output are updated
with the changes.
Test Transport Connection
The Test Transport Connection button is only available when the transport is JMS.
This button tests the connection to the JMS server.
Transport Details
The Transport Details tab allows you to specify additional configuration
information based on the type of transport used for the SOAP request. When
HTTP is the transport, the HTTP sub-tab appears on this tab. When JMS is the
transport, the JNDI and JMS sub-tabs appear. See SOAP Messages Over the JMS
Transport on page 667 for more information about SOAP over the JMS transport.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 647
|
The Transport Details tab contains the following fields:
Field
Global
Var?
Description
HTTP Sub-Tab
Endpoint URL
Yes
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 SSL field becomes enabled.
Use HTTP
Proxy
No
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
No
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 233 for more information.
Use Basic
Authentication
No
When checked, this field specifies that you wish to
authenticate when connecting to the SOAP server.
The Identity field appears when this field is
enabled.
Identity
No
Allows you to specify an Identity resource for
authenticating with the SOAP server. See TIBCO
Designer Palette Reference for more information
about configuring an Identity resource.
TIBCO ActiveMatrix BusinessWorks Palette Reference
648
| Chapter 17
SOAP Palette
Field
Global
Var?
Description
Yes
This is the URL to the JNDI service provider
(javax.naming.Context.PROVIDER_URL). The
value for this field is taken from the WSDL file, if
it is available in the <jndi:context> element in
the service specification. You can override the
supplied value, if you wish to use a different JNDI
service provider.
JNDI Sub-Tab
Context URL
See your JNDI provider documentation for the
syntax of the URL.
User Name
Yes
User name to use when logging into the JNDI
server (javax.naming.Context.SECURITY_
PRINCIPAL). If the JNDI provider does not require
access control, this field can be empty.
Password
Yes
Password to use when logging into the JNDI
server (javax.naming.Context.SECURITY_
CREDENTIALS). If the JNDI provider does not
require access control, this field can be empty.
Context Factory
Yes
The initial context factory class for accessing JNDI
(javax.naming.Context.INITIAL_CONTEXT_
FACTORY). The value for this field is taken from the
WSDL file, if it is available in the <jndi:context>
element in the service specification. You can
override the supplied value, if you wish to use a
different context factory.
Note: TIBCO ActiveMatrix 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 649
|
Field
Global
Var?
Description
Connection
Factory
Yes
The QueueConnectionFactory object stored in
JNDI. This object is used to create a queue
connection with a JMS application. The value for
this field is taken from the WSDL file, if it is
available in the <jms:connectionFactory>
element in the service specification. You can
override the supplied value, if you wish to use a
different connection factory.
See your JNDI provider documentation for more
information about creating and storing
QueueConnectionFactory objects.
SSL
No
Specifies whether you wish to use SSL for the
connection to the JNDI server. SSL is used when
the Use SSL? checkbox is checked. Click the
Configure SSL button to configure the SSL
connection parameters. See Configure SSL on
page 652 for more information.
SSL Password
Yes
Password to use during the SSL connection.
Validate
Security
Context
Yes
Checking this field ensures that the security
context provided on this tab is the one used to
connect to the JNDI server.
Some application servers store the security context
on the thread used to establish the JNDI
connection. Therefore the first activity to use this
resource will establish the security context, and
then subsequent activities will use the same
security context, unless this field is checked.
Checking this field ensures that each activity that
uses this resource examines the security context to
determine if the activity uses the same security
context as the security context established on the
thread. If they are different, the activity’s
configured security context is used.
Checking this field causes additional overhead for
activities that use this resource. The only
supported application server that requires this
field to be checked is WebLogic.
TIBCO ActiveMatrix BusinessWorks Palette Reference
650
| Chapter 17
SOAP Palette
Field
Global
Var?
Description
Properties
No
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.
JMS Sub-Tab
User Name
Yes
User name to use to authenticate to the JMS server.
Password
Yes
Password to use to authenticate to the JMS server.
JMS
Destination
Yes
Name of the JMS destination for the SOAP
request.
The syntax of the destination name is specific to
the JMS provider you are using. See your JMS
provider documentation for more information
about destination names.
Note: If you are using TIBCO Enterprise Message
Service as your JMS provider, you can use the
Browse button next to this field after specifying a
valid connection in the JMS Connection field. The
Browse button displays a list of configured
destinations in the JMS server that are appropriate
for this activity.
Message Type
Yes
TIBCO ActiveMatrix BusinessWorks Palette Reference
The type of the message. This can be one of the
following:
•
Bytes Message — A stream of bytes.
•
Text Message — The message is a
java.lang.String.
SOAP Request Reply 651
|
Field
Global
Var?
Description
Delivery Mode
Yes
The delivery mode of the message. Can be one of
the following:
Expiration
Yes
•
PERSISTENT — signifies the messages are
stored and forwarded.
•
NON_PERSISTENT — messages are not
stored and may be lost due to failures in
transmission.
•
EMS_RELIABLE_DELIVERY — this mode is
only available when using TIBCO Enterprise
Message Service. See the TIBCO Enterprise
Message Service documentation for more
information about this mode.
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
Yes
Priority of the message. You may set the priority to
a value from 0-9. The default value is 4.
Use Shared JMS
Configuration
No
Check this field if you wish to specify a JMS
Connection shared configuration resource to
override the JMS transport parameters in the
concrete WSDL. When checked, this JMS
Connection field appears.
JMS
Connection
No
This field only appears when the Use Shared JMS
Configuration field is checked. This field allows
you to specify a JMS Connection shared
configuration resource that contains the
connection information you wish to use to
override the JMS transport parameters in the
concrete WSDL.
TIBCO ActiveMatrix BusinessWorks Palette Reference
652
| Chapter 17
SOAP Palette
Configure SSL
This button allows you to configure the SSL connection parameters for connecting
to the SOAP server. This button brings up a dialog with the following fields:
Field
Description
Trusted Certificates
Folder
Folder in the project containing one or more
certificates from trusted certificate authorities. This
folder is checked when connecting to a server to
ensure that the connection is to a server that is
trusted. This prevents connections to rogue servers
that attempt to impersonate trusted servers.
Identity
This is an Identity resource that contains the client’s
digital certificate and private key.
See TIBCO Designer Palette Reference for more
information.
Verify Host Name
This field specifies that the host name of the SOAP
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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 653
|
Field
Description
Strong Cipher Suites
Only
When checked, this field specifies that the minimum
strength of the cipher suites used can be specified
with the
bw.plugin.security.strongcipher.minstrength
custom engine property. See TIBCO ActiveMatrix
BusinessWorks Administration for more information
about this property. The default value of the property
disables cipher suites with an effective key length
below 128 bits.
When this field is unchecked, only cipher suites with
an effective key length of up to 128 bits can be used.
Messages With Attachments
SOAP messages can have message parts that contain attachments. For a message
part to contain an attachment, specify the Special Type in the Type field of the Part
Details section of the Message resource when creating a WSDL file configuration.
See Chapter 20, WSDL Palette, on page 697 for more information about creating
WSDL files.
Depending on the SOAP version being used, messages with attachments can
conform to one of the following styles:
•
Messages with Attachments (SwA) - available with SOAP version 1.1 and 1.2.
•
Message Transmission Optimization Mechanism (MTOM) - available only
with SOAP 1.2.
Messages with Attachments (SwA)
SOAP clients that send messages with attachments in the SwA style must
conform to the SOAP Messages with Attachments specification
(http://www.w3.org/TR/SOAP-attachments).
The input or output schema element for a message part that contains an
attachment holds the content ID of the attachment instead of holding the actual
attachment data. The actual data for attachments is always contained within the
mimeEnvelopeElement of the output schema for this resource. This element
contains a repeating element named mimePart that holds the list of attachments
in the SOAP message. The attachment list can be correlated to the message parts
containing the attachments by using the content-id mimeHeader element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
654
| Chapter 17
SOAP Palette
Message Transmission Optimization Mechanism (MTOM)
Message Transmission Optimization Mechanism (MTOM) provides another way
of sending binary content or attachment processing by serializing SOAP messages
with attachments. Optimization is only available for element content that is in a
canonical lexical representation of xs:base64Binary data type. MTOM conforms
to the specification http://www.w3.org/TR/soap12-mtom.
Any element of type xs:base64Binary (or an extension of xs:base64Binary) in
the SOAP response message is treated as an MTOM attachment and appears as a
separate MIME part on the wire. The SOAP message will have a XOP include
reference to the attachment. Any XOP include reference in the SOAP message will
be replaced by the corresponding attachment’s content encoded in Base64. Any
MIME attachment that is not referenced from the SOAP Message using XOP
include reference will be ignored by the MTOM Processing layer. Note that the
attachment is a part of the SOAP Infoset. See TIBCO ActiveMatrix BusinessWorks
Process Design Guide for more information about MTOM.
Advanced
The Advanced tab is used to specify the behavior of attachment for the reply
message. This is useful if large messages are sent and you wish to write them to
files instead of storing them in memory. The Advanced tab has the following
fields.
Field
Description
Write to File
Checking this field specifies that incoming messages
whose attachments exceed the specified threshold
size should be written to a file instead of stored in
memory. This allows you to accept large incoming
attachments without consuming a great deal of
memory. When this field is checked, the Directory and
Threshold Size fields appear.
Leaving this field unchecked specifies that
attachments of incoming messages should be kept in
memory.
Note: Once written, the files created by using this
option are not deleted automatically. You must
manage the storage used by these files and delete
them when they are no longer used.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 655
|
Field
Description
Directory
The directory to write attachments that are above the
specified threshold. The process engine does not
attempt to create the directory if the specified
directory does not exist. Therefore, create the
directory before starting the process engine.
Create Non-Existing
Directories
When checked, all directories in the path specified in
the Directory field are created, if they do not already
exist.
If this field is unchecked and there are one or more
directories in the specified path in the Directory field
that do not exist, an exception is raised.
Threshold Size (bytes)
The maximum size (in bytes) of an incoming message
attachment that can be kept in memory. Attachments
larger than the specified size are written to a file in the
specified directory. The file’s name is output so that
subsequent activities in the process definition can
access the file and read its contents.
Specifying zero (0) in this field causes all incoming
messages to be saved to a file.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
inputMessage or
<operationName>
complex
The root class for the input of the SOAP
Request Reply activity. This class
contains all input items for the 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.
TIBCO ActiveMatrix BusinessWorks Palette Reference
656
| Chapter 17
SOAP Palette
Input Item
Datatype
Description
mimeEnvelopeElement
complex
This element contains the message
attachments when mime attachments
are used. This element contains a
repeating element named mimePart
that contains each mime attachment.
mimeHeaders
complex
This element contains the mime header
for each mimePart. Mime headers can
contain the following information:
•
content-disposition
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
Note: When the content type is
specified as "text/*" (for example,
"text/xml"), the attachment content is
expected to be in either the textContent
input element or the file name storing
the attachment is expected to be in the
fileName input element. When the
content type is anything other than
"text/*", the attachment content is
expected to be in either the
binaryContent input element or the file
name storing the attachment is
expected to be in the fileName input
element.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 657
|
Input Item
Datatype
Description
binaryContent |
textContent | fileName
choice
This element contains the mime
attachment. The element can be one of
the following:
•
binaryContent — content of the
attachment when the attachment is
binary data.
•
textContent — content of the
attachment when the attachment is
text data.
•
fileName — the file name of the
attachment when the attachment is
stored in the file system.
_configData
complex
Specifies the values to use to override
transport-specific configuration values,
if desired. The content of the
_configData element depends upon the
type of transport used.
endpointURL
string
Available only when HTTP is the
transport. Specifies the Endpoint URL
of the service. Specifying a value in this
input item overrides any value
specified in the Endpoint URL field on
the Configuration tab.
host
string
Available only when HTTP is the
transport. Specifies the host machine
where the SOAP service resides as
host:port. This should be used when
sending a message through a tunnel.
JMSTargetDestination
string
Available only when JMS is the
transport. Specifies the JMS destination
(queue) name used to send messages.
JMSPriority
number
Available only when JMS is the
transport. Specifies the priority of the
message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
658
| Chapter 17
SOAP Palette
Input Item
Datatype
Description
JMSExpiration
number
Available only when JMS is the
transport. Corresponds to
JMSExpiration property that specifies
how long the message can remain
active (in seconds).
soapAction
string
Specifies the soapAction header for
the operation. See the SOAP
specification for more information
about soapAction.
Specifying a value in this input item
overrides any value specified in the
Action field on the Configuration tab.
headers
complex
Any input headers defined in the
WSDL file. The headers are stored in an
element named Header.<partName>
where <partName> is the element name
of the input header schema.
The Header.<partName> element also
contains an item named
@mustUnderstand. Set this boolean
value to true if you wish to specify that
the SOAP server must understand the
header.
timeout
number
The time to wait (in seconds) for the
operation to complete.
JMSReplyDestination
string
Available only when JMS is the
transport. Specifies the JMS destination
(queue) name used to send the reponse.
The JMSReplyDestination specified has
to be unique for every message. Set the
JMSReplyDestination to a non-static
variable such as Job-Id to use the same
JMSReplyDestination multiple times.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Request Reply 659
|
Output
The output for the activity is the following.
Output Item
Datatype
Description
outputMessage or
complex
The root class for the output of the
SOAP Request Reply activity. This
class contains all output items for the
activity.
<operationName>Response
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.
headers
complex
Any output headers defined in the
WSDL file. The headers are stored in
an element named Header.<partName>
where <partName> is the element name
of the output header schema.
The Header.<partName> element also
contains an item named
@mustUnderstand. This boolean value
is set to true if the server specifies that
the SOAP client must understand the
header.
mimeEnvelopeElement
complex
This element contains the reply
message attachments when mime
attachments are used. This element
contains a repeating element named
mimePart that contains each mime
attachment.
TIBCO ActiveMatrix BusinessWorks Palette Reference
660
| Chapter 17
SOAP Palette
Output Item
Datatype
Description
mimeHeaders
complex
This element contains the mime
header for each mimePart. Mime
headers can contain the following
information:
•
content-disposition
•
content-type
•
content-transfer-encoding
•
content-id
•
other mime header information
Note: When the content type is
specified as "text/*" (for example,
"text/xml"), the attachment content is
expected to be in either the
textContent output element or the file
name storing the attachment is
expected to be in the fileName output
element. When the content type is
anything other than "text/*", the
attachment content is expected to be in
either the binaryContent output
element or the file name storing the
attachment is expected to be in the
fileName output element.
binaryContent |
textContent | fileName
TIBCO ActiveMatrix BusinessWorks Palette Reference
choice
This element contains the mime
attachment. The element can be one of
the following:
•
binaryContent — content of the
attachment when the attachment is
binary data.
•
textContent — content of the
attachment when the attachment is
text data.
•
fileName — the file name of the
attachment when the Write to File
field is checked on the Output
Attachment Bindings tab.
SOAP Request Reply 661
|
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
defaultFaultElement
The server returned a default SOAP fault.
ActivityTimedOutException
The activity reached the specified
timeout and a response has not been
received from the server.
<customFault>
The SOAP server has returned a custom
fault. These faults are defined in the
WSDL file and are listed as a choice
element.
Errors when HTTP is the transport
HttpClientException
The SOAP server has reported a client
error.
HttpServerException
The SOAP server has reported an internal
error.
HttpCommunicationException
An HTTP communications error
occurred.
Errors when JMS is the transport
JMSMessageCreateExpcetion
An error occurred when creating the
request message.
JMSSessionCreteException
An error occurred when creating the JMS
session to send the request message.
JMSSendException
An error occurred when attempting to
send the JMS message.
JMSReceiveException
An error occurred when attempting to
receive the JMS reply message.
TIBCO ActiveMatrix BusinessWorks Palette Reference
662
| Chapter 17
SOAP Palette
SOAP Send Fault
Activity
The SOAP Send Fault activity sends a SOAP fault to the client if an
error occurs during processing of a SOAP request.
This activity is used when the SOAP Event Source process starter
handles incoming SOAP requests. The WSDL file for the request can have one or
more fault messages defined for an operation (see Chapter 20, WSDL Palette, on
page 697 for a description of creating fault schemas for operations). 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.
SOAP faults are required to send the fault code and the fault string. These values
are required input items on the Input tab. For example, "Client" can be used for
client faults and "Server" can be used for server faults. See the SOAP specification
at www.w3.org/TR/SOAP for more information about the syntax of SOAP fault
codes.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Reply To
No
The SOAP Event Source process starter.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Send Fault 663
|
Field
Global
Var?
Description
Fault Details
No
The name of the fault message to send. This field
provides a drop down list of the fault messages
defined in the WSDL file specified for the SOAP
Event Source process starter.
You must select one of the fault messages to return
to the client, and that message 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 message.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
TIBCO ActiveMatrix BusinessWorks uses the same schema for Fault messages
regardless of the version of the SOAP protocol. See SOAP Specification
Compliance on page 618 for more information.
The input for the activity is the following.
Input Item
Datatype
Description
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 string message
to pass back to the client describing
the fault.
TIBCO ActiveMatrix BusinessWorks Palette Reference
664
| Chapter 17
SOAP Palette
Input Item
Datatype
Description
faultactor
string
The faultactor element is intended
to provide information about who
caused the fault to happen in 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
ActiveMatrix BusinessWorks
process generated the fault.
detail
complex
The fault message specified by the
Fault Details field on the
Configuration tab. This message is
used to pass application-specific
data back to the client in the event
of a fault.
Output
The activity has no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ServerException
An error occurred and the fault could not
be sent to the client.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Send Reply 665
|
SOAP Send Reply
Activity
The SOAP Send Reply activity sends a reply to an application that
sent a SOAP request. This activity is primarily used in 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
The Configuration tab has the following fields.
Field
Global
Var?
Description
Name
No
The name to appear as the label for the activity in the
process definition.
Description
No
Short description of the activity.
Reply To
No
The SOAP Event Source process starter that received
the request.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
outputMessage or
<operationName>
Datatype
Description
The output schema of the operation for
the selected SOAP request. Each of the
schema elements are available in this
dialog for mapping.
TIBCO ActiveMatrix BusinessWorks Palette Reference
666
| Chapter 17
SOAP Palette
Input Item
Datatype
Description
Header.<headerPart>
complex
Headers can contain multiple parts. The
headers element contains all header parts
required in a SOAP reply. These parts are
specified on the Output Headers tab of
the SOAP Event Source activity. The
header parts are stored in an element
named Header.<partName> where
<schema-name> is the name of the schema
specified on the Output Headers tab.
Each Header.<partName> element also
contains an item named
@mustUnderstand. This boolean value is
set to true in the outgoing reply if you
require that the client must understand
the header part.
Output
The activity has no output.
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information
about error codes and corrective action to take.
Exception
Thrown When...
ServerException
An error occurred and the reply could
not be sent to the client.
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Messages Over the JMS Transport 667
|
SOAP Messages Over the JMS Transport
The HTTP transport does not provide guaranteed message delivery. The SOAP
protocol is not specific to any transport, so SOAP messages in theory can be
bound to any transport. JMS provides a highly reliable transport that can
guarantee message delivery. TIBCO ActiveMatrix BusinessWorks supports
sending and receiving SOAP messages over the HTTP and JMS transports.
As of Release 5.3.0, there is no standard specification for SOAP messages over
JMS. TIBCO has proposed a specification with the following features:
•
one-way and request/response operations
•
the support is based on SOAP 1.1, SOAP 1.2, and WSDL 1.1
What's in the JMS Message
The following sections describe the content of the JMS message containing a
SOAP request.
TIBCO ActiveMatrix BusinessWorks Palette Reference
668
| Chapter 17
SOAP Palette
JMS Header
Table 12 describes the JMS headers.
Table 12 JMS headers for SOAP messages
JMS Header
Description
Content_Type
This header must be one of the following:
•
application/xml
for SOAP 1.1 or SOAP 1.2 without
attachments
•
multipart/related
for SOAP 1.1 or SOAP 1.2
Note: Content type parameters are also allowed, for
example, charset=utf-8.
Mime_Version
Must be the string "1.0".
SoapAction
SOAPAction value as defined in the WSDL.
JMSDestination
This contains the destination name.
JMSReplyTo
This contains the reply to address to be used by service
provider to return data.
Currently, only temporary queues can be used for reply
messages.
JMSMessageID
This contains a message ID generated by the JMS provider.
JMS Body
The JMS message body contains a binary representation of the actual SOAP
message. Below is an example of a SOAP message.
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV=
"http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body SOAP-ENV:encodingStyle=
"http://schemas.xmlsoap.org/soap/encoding/">
<ns0:getCatalog xmlns:xs=
"http://www.w3.org/2001/XMLSchema"
xmlns:soap-enc=
"http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ns0="http://InputMessageNamespace"/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
TIBCO ActiveMatrix BusinessWorks Palette Reference
SOAP Messages Over the JMS Transport 669
|
WSDL Extensions
The following sections describe extensions to the WSDL standard to support the
JMS protocol.
WSDL Binding
The WSDL Binding for SOAP over JMS varies only slightly from the SOAP over
HTTP binding. The transport attribute under soap:binding indicates that JMS is
being used. The attribute must have the value:
http://www.tibco.com/namespaces/ws/2004/soap/binding/JMS.
For example:
<soap:binding style="document"
transport="http://www.tibco.com/namespaces/ws/2004/soap/binding
/JMS"/>
In addition to the soap:binding transport information, there must be a JMS
binding element that describe the message type used for transmission. Currently,
the only supported message types are ByteMessage and TextMessage. This looks
like the following:
<jms:binding messageFormat="bytes"/>
An example of the complete WSDL binding section is show below.
<wsdl:binding name="RetailJMSBinding" type="tns:RetailerPortType">
<soap:binding style="document" transport=
"http://www.tibco.com/namespaces/ws/2004/soap/binding/JMS"/>
<jms:binding messageFormat="bytes"/>
<wsdl:operation name="getCatalog">
<wsdl:documentation>The operation has no documentation</wsdl:documentation>
<soap:operation style="document" soapAction="RetailGetCatalog"/>
<wsdl:input>
<soap:body use="encoded"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
namespace="http://InputMessageNamespace" parts=""/>
</wsdl:input>
<wsdl:output>
<soap:body use="encoded"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
namespace="http://OutputMessageNamespace" parts="return"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
WSDL Service
The service section of the WSDL also contains extensions to support SOAP over
JMS. The extension is defined with the following form where '?' means optional.
<wsdl:service>
<jndi:context />?
TIBCO ActiveMatrix BusinessWorks Palette Reference
670
| Chapter 17
SOAP Palette
<jms:connectionFactory />?
<wsdl:port>
<jndi:context />?
<jms:connectionFactory />?
<jms:targetAddress />
</wsdl:port>
</wsdl:service>
In this definition, both jndi:context and jms:connectionFactory elements
can possibly appear at two locations and they must appear at least once. When
they appear under wsdl:service, the definition applies to all ports inside the
service. When they appear under wsdl:port, the definition applies to only that
port and it overrides the definitions that appear at the service level if it exists. If
they do not appear at the service level, then each port must define them.
The jms:connectionFactory element is the JMS connection factory name that is
used to connect with JMS service, using the JNDI context supplied in the
jndi:context element. Below is an example of using TIBCO Enterprise Message
Service as the JMS provider.
<jms:connectionFactory>QueueConnectionFactory
</jms:connectionFactory>
In a simple configuration, the jms:connectionFactory is the same for both the
Service Provider and the Service Clients. However, both provider and clients can
use different connection factories, provided that they all create connections to the
same JMS provider instance.
The jms:targetAddress element contains address information which the service
provider is going to listen for messages. Below is an example of using TIBCO
Enterprise Message Service as the JMS provider with a queue name of MyQueue.
<jms:targetAddress destination="queue">MyQueue</jms:targetAddress>
The jndi:context element holds one or more jndi:property elements. Each of
the jndi:property elements describes a JNDI name/value pair. For example,
<jndi:context>
<jndi:property name="java.naming.factory.initial"
type="java.lang.String">
com.tibco.tibjms.naming.TibjmsInitialContextFactory
</jndi:property>
<jndi:property name="java.naming.provider.url"
type="java.lang.String">
tibjmsnaming://localhost:7222
</jndi:property>
</jndi:context>
MimeParser
TIBCO ActiveMatrix BusinessWorks Palette Reference
MimeParser 671
|
MimeParser
Activity
This activity is responsible for parsing the MTOM messages
into a SOAP message that contains the binary attachments as
an inline data of the SOAP message. The output can be either
in a Text or a Binary format.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in
the process definition.
Description
No
Short description of the activity.
Input Style
No
The Input message format. (Currently only
MTOM is available)
Output Style
No
The Output message format. You can choose
either Text or Binary format for the output
messages.
Description
Advanced
The Advanced tab contains the following field:
Field
GenerateStrictP
arsingErrors
Global
Var?
No
Description
When checked, this field generates strict parsing
validation errors.
TIBCO ActiveMatrix BusinessWorks Palette Reference
672
| Chapter 17
SOAP Palette
Input
The Input tab contains the following fields:
Input Item
Datatype
Description
MimeBinaryData
Binary
Incoming binary data
Output
The Output for the activity is the following.
Output Item
Datatype
Description
soapMessage
Binary or
String
Depends upon the type specified in the
Output Style format
StrictValidationErrors
Complex
This appears only when the
GenerateStrictParsingErrors checkbox
is selected.
ErrorString
String
Shows strict parsing validation error
logs.
SOAPOutput
Error Output
The Error Output tab lists the possible exceptions that can be thrown by this
activity.
Exception
Thrown When...
XOPParseException
Specifies XOP related exceptions found
in the input.
MimeParseException
Specifies MIME related exceptions found
in the input.
InvalidXMLException
Specifies invalid xml related exception
found in the input.
TIBCO ActiveMatrix BusinessWorks Palette Reference
| 673
Chapter 18
TCP/IP Palette
This chapter describes the resources in the TCP/IP palette.
Topics
•
Overview of the TCP/IP Palette, page 674
•
Read TCP Data, page 675
•
TCP Close Connection, page 678
•
TCP Connection, page 679
•
TCP Open Connection, page 681
•
TCP Receiver, page 683
•
Wait for TCP Request, page 685
•
Write TCP Data, page 687
TIBCO ActiveMatrix BusinessWorks Palette Reference
674
| Chapter 18
TCP/IP Palette
Overview of the TCP/IP Palette
The TCP/IP palette provides activities and resources that can send and receive
data using the TCP/IP protocol. TCP/IP is often the underlying communication
layer for higher-level protocols such as HTTP or FTP. You could use the resources
in the TCP palette to communicate with HTTP or FTP severs, but the activities in
the HTTP Palette or FTP Palette are best suited for this purpose. This palette is
intended for use when communicating with TCP/IP and there is no
corresponding TIBCO ActiveMatrix BusinessWorks palette for the protocol. For
example, you may have a custom application that communicates with other
applications by way of TCP/IP. You could use the TCP/IP palette to handle
incoming and outgoing data from this application.
Using the TCP/IP Palette Activities
The general sequence of events when using the TCP/IP palette resources is the
following:
1. Create a TCP Connection shared configuration resource that describes the
connection information.
2. One of the following occurs depending upon whether the process definition is
a TCP/IP client or server:
a. When a process definition acts as a TCP/IP client communicating with a
TCP/IP server, a connection must be opened using the TCP Open
Connection activity.
b. When a process definition acts as a TCP/IP server waiting for incoming
TCP/IP requests, the process either starts with a TCP Receiver process
starter or has a Wait for TCP Request activity that waits for an incoming
connection request.
3. In the process definition the Read TCP Data and Write TCP Data activities are
used to read and write data to the TCP connection.
4. Once all processing is complete, the TCP Close Connection activity is used to
close the TCP connection.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Read TCP Data 675
|
Read TCP Data
Activity
The Read TCP Data activity reads data from an open TCP connection.
The connection must be opened by an activity or process starter that
executed previously in the process definition. Activities that can open
a TCP connection are: TCP Receiver, TCP Open Connection, and Wait
for TCP Request. The activity that opens a TCP connection places a handle to the
open connection in its connectionKey output element. The connectionKey is
mapped to this activity’s input.
Configuration
The Configuration tab has the following fields.
Field
Global
Var?
Name
No
The name to appear as the label for the activity in the
process definition.
Description
No
Short description of the activity.
Type
No
Type of data to be read. This can be either Text or
Binary. When Text is specified, the Separator, User
Defined Separator, and Encoding fields appear.
When Binary is specified, the Bytes to Read field
appears.
Separator
Yes
The type of separator. This activity reads data from
the TCP connection until the separator or the end of
the data stream is encountered.
User Defined
Separator
Yes
When User-defined separator is chosen from the list
in the Separator field, this field appears. This field
specifies the separator character to use.
Description
When Binary is selected in the Type field, a
user-defined separator can be a string representation
of a single byte value or it can be comma-separated
byte values (for example, 0x0a, 0x0b, 0x0c). For valid
string representations of byte values, refer to the Java
documentation for the decode(String n) method
of java.lang.Byte.
TIBCO ActiveMatrix BusinessWorks Palette Reference
676
| Chapter 18
TCP/IP Palette
Field
Global
Var?
Description
Encoding
Yes
When text data is specified, this field determines the
character encoding of the text data.
Bytes to Read
Yes
When binary data is specified, this field specifies the
number of bytes that should be read by this activity.
If this field is left blank, then the activity reads until
the end of the data stream is encountered.
Timeout
Yes
The time to wait (in milliseconds) for this activity to
complete.
Input
See TIBCO ActiveMatrix BusinessWorks Process Design Guide for more information
about mapping and transforming input data.
The input for the activity is the following.
Input Item
Datatype
Description
connection
binary
The handle to the connection that you
wish to read data from. This connection is
obtained from a previously executed
activity in the process definition that
opened the connection.
encoding
String
When text data is being read, this
specifies the character encoding of the
text. This value overrides the value
specified in the Encoding field on the
Configuration tab.
separator
String
When text data is being read, this
specifies the separator to write after the
body element is written to the TCP
connection. This value overrides the
value specified on the Configuration tab.
TIBCO ActiveMatrix BusinessWorks Palette Reference
Read TCP Data 677
|
Input Item
Datatype
Description
bytesToRead
number
When binary data is being read, this
specifies the number of bytes that should
be read. This value overrides the value
specified in the Bytes to Read field on the
Configuration tab.
timeout
number
Time to wait (in milliseconds) for this
activity to complete.
Output
The output for the activity is the following.
Output Item
Datatype
Description
data
String
When text data is specified, this output
element contains the text read from the
TCP connection. The separator character,
if specified, is not included in the output.
binaryData
binary
When binary data is specified, this
output element contains the binary data
read from the TCP connection.
endOfStreamReached
boolean
This element is set to true when the end
of the data stream has been reached.