TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes

TIBCO ActiveMatrix BusinessWorks™
Bindings and Palettes Reference
Software Release 6.4.2
November 2017
Two-Second Advantage®
2
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR
PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE
EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY
OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE
CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD
OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)
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.
ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDER
SEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,
THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITH
TIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,
AND INDEMNITIES. DOWNLOAD AND USE THESE ITEMS IS SOLELY AT YOUR OWN
DISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDING
TO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THE
FOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.
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.
TIBCO, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Enterprise Message Service,
TIBCO Business Studio, TIBCO Enterprise Administrator, TIBCO ActiveSpaces, TIBCO Runtime Agent,
TIBCO Designer, and Two-Second Advantage are either registered trademarks or trademarks of TIBCO
Software Inc. in the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise
Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of
Oracle Corporation in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT
ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED
AT THE SAME TIME. SEE THE README 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
3
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 © 2001-2017 TIBCO Software Inc. All rights reserved.
TIBCO Software Inc. Confidential Information
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
4
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Changing Help Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Basic Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Critical Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Local Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
For Each . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Iterate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Repeat on Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
While . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Compensate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Get Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Rethrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Set Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Set EPR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Throw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Engine Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
REST Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Rest Service Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
SOAP Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
SOAP Service Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Generating Concrete WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Operation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
5
Request Message Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Response Message Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Fault Operation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Context Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Service Binding - Request Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Service Binding- Response Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Fault Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
SOAP Reference Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Operation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Request Message Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Response Message Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Fault Operation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Context Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Reference Binding - Request Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Reference Binding - Response Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Fault Context (Fault) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
File Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Copy File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Remove File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Create File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
File Poller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
List Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Read File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Wait for File Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Write File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
FTL Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
FTL Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
FTL Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
FTL Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
FTL Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
FTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
FTP Change Default Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
FTP Delete File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
FTP Dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
FTP Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
FTP Get Default Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
FTP Make Remote Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
FTP Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
6
FTP Quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
FTP Remove Remote Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
FTP Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
FTP SYS Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
General Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Call Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Checkpoints and Confirm Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
External Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
Get Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Inspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Set Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Wait for Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
On Notification Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Receive Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
HTTP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
Send HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Wait for HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Sending Data in the HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Send HTTP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
JAVA Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Configuring JAVA in BusinessWorks Application Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Converting JAVA Class to XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Creating Custom XPath Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Using Custom XPath Function at Design Time and Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Deleting Custom XPath Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Java Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Java Process Starter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Java To XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
XML To Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
7
JDBC Call Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
JDBC Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
JDBC Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
SQL Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
JMS Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
Common JMS Properties and Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Get JMS Queue Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
JMS Receive Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
JMS Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
JMS Send Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Reply to JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Wait for JMS Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Mail Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Receive Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Send Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Parse Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
MimeParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Parse Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Render Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Rendezvous Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Datatype Conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Field Names in Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Globalization Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Rendezvous Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Rendezvous Reply To Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Rendezvous Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Rendezvous Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Wait for Rendezvous Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
REST and JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
BW JSON Utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Invoke REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .278
Restrictions on XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Parse JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Render JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Policy Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Basic Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Basic Credential Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
WSS Consumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
WSS Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
8
Shared Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
FTL Realm Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
FTP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
HTTP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Persistent Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
HTTP Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Identity Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
JMS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
JNDI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Java Global Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Keystore Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
LDAP Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Rendezvous Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
SMTP Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
SSL Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
SSL Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Subject Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
TCP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Trust Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
WSS Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
XML Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
Notify Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
TCP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Using the TCP Palette Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Read TCP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
TCP Close Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
TCP Open Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
TCP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Wait for TCP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Write TCP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Thread Pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
XML Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Parse XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Render XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Transform XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Activity Icons Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .361
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
9
Figures
Parsing a Text String into a Data Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
10
TIBCO Documentation and Support Services
How to Access TIBCO Documentation
Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainly
in HTML and PDF formats.
The TIBCO Product Documentation website is updated frequently and is more current than any other
documentation included with the product. To access the latest documentation, visit https://
docs.tibco.com.
Product-Specific Documentation
Documentation for TIBCO products is not bundled with the software. Instead, it is available on the
TIBCO Documentation site. To directly access documentation for this product, double-click the
following file:
TIBCO_HOME/release_notes/TIB_BW_version_docinfo.html
The following documents for this product can be found on the TIBCO Documentation site:
●
Concepts
●
Installation
●
Getting Started
●
Application Development
●
Administration
●
Bindings and Palettes Reference
●
Samples
●
Error Codes
●
Migration
●
Performance Benchmarking and Tuning Guide
●
API Reference
●
REST Reference
How to Contact TIBCO Support
You can contact TIBCO Support in the following ways:
●
For an overview of TIBCO Support, visit http://www.tibco.com/services/support.
●
For accessing the Support Knowledge Base and getting personalized content about products you are
interested in, visit the TIBCO Support portal at https://support.tibco.com.
●
For creating a Support case, you must have a valid maintenance or support contract with TIBCO.
You also need a user name and password to log in to https://support.tibco.com. If you do not have a
user name, you can request one by clicking Register on the website.
How to Join TIBCO Community
TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matter
experts to share and access their collective experience. TIBCO Community offers access to Q&A forums,
product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, and
tools that extend and enable customers to gain full value from TIBCO products. In addition, users can
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
11
submit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to
https://community.tibco.com.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
12
Changing Help Preferences
By default, documentation access from TIBCO Business Studio™ is online, through the TIBCO Product
Documentation site (Doc site) at https://docs.tibco.com/ which contains the latest version of the
documentation. Check the Doc site frequently for updates. To access the product documentation offline,
download the documentation to a local directory or an internal web server and then change the help
preferences in TIBCO Business Studio.
Prerequisites
Before changing the help preferences to access documentation locally or from an internal web server,
download the documentation from https://docs.tibco.com/.
1. Go to https://docs.tibco.com/
2. In the Search field, enter ActiveMatrix
BusinessWorks
and press Enter.
3. Select the TIBCO ActiveMatrix BusinessWorks™ product from the list. This opens the product
documentation page for the latest version.
4. Click Download All.
5. A zip file containing the latest documentation downloads to your web browser's default download
location. Copy the zip file to a local directory or to an internal web server and unzip the file.
To point to a custom location:
Procedure
1. In TIBCO Business Studio, click Window > Preferences. On Mac OS X, click TIBCO Business
Studio > Preferences.
2. In the Preferences dialog, click BusinessWorks > Help.
3. Click Custom Location then Browse to select the html directory in the folder where you unzipped
the documentation, or provide the URL to the html directory on your internal web server.
4. Click Apply then OK.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
13
Basic Activities Palette
Basic activities are a simple means of interacting with a service, manipulating the passing data, or
handling exceptions. They also contain Loops that are Groups with Conditions, which follow a pattern
at run time such as, initialize the loop, update the loop at each iteration, and test conditions for the loop
to stop iterating.
The available types of loops are:
●
Local Transaction
●
For Each
●
Iterate
●
Repeat
●
Repeat On Error
●
Scope
●
While
Critical Section
Critical Section groups are used to synchronize process instances. At runtime multiple process
instances can be executed concurrently. You can use Critical Section groups to synchronize the set of
actions performed in the process across multiple process instances. Only one process instance can
execute the critical section group and its contents at any specified time. Other concurrently running
process instances that are associated with the corresponding critical section group wait at the start of
the critical section group, until the process instance that is currently executing complete the critical
section group.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the group in the process.
Group Type
The type of the group. The default is Critical Section.
Timeout
The maximum time (in milliseconds) that a process instance waits at the start
of the critical section group while another process instance is executing the
critical section. When a timeout occurs, the process instance that is waiting to
execute the critical section fails with an Activity Timeout Exception.
The timeout field can be used to avoid deadlock situations.
Shared Lock
Select this check box to synchronize multiple critical section groups that use
the same shared variable as a lock.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
14
Field
Description
Shared Variable
Type
The Shared Lock option can be defined using a Module Shared Variable or a
Job Shared Variable. When a module shared variable is used against job
shared variable to define Shared Lock, it has different implications.
●
Module Shared Variable: provides a shared lock to synchronize process
instances from different processes that are within a module. Using a
module shared variable, you can synchronize multiple Critical Section
groups that can be part of different process instances.
These Critical Section groups can be in the same process or in another
process, provided all processes are contained within a ActiveMatrix
BusinessWorks™ module.
●
Shared Variable
Job Shared Variable: provides a shared lock to synchronize within a job.
Using a job shared variable, you can synchronize multiple Critical Section
groups that are part of the same job. These Critical Section groups can be
in the same process or in an another process, provided all process instances
are part of the same job.
Name of the Module Shared Variable or Job Shared Variable.
Description
Provide a short description for the group in this field.
Variables
The Variables tab provides a way to declare variables that are only limited to the scope of this group.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
●
Date&Time
Fault
The Fault tab lists the possible exceptions thrown by this activity. See the Error Codes guide for more
information about error codes and the corrective action to take.
Fault
Thrown When..
ActivityTimedOutException
The specified timeout is attained.
Local Transaction
Use Local Transaction group for multiple activities to be part of a local transaction. A local transaction
group ensures that all participants of the transaction are rolled back together. However, the local
transaction is not equivalent to an XA transaction and does not use a transaction coordinator. Instead, a
single resource performs all its transaction work.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
15
Not all ActiveMatrix BusinessWorks™ activities can participate in the local transaction. The following
core activity types have local transactional capabilities:
●
JMS
●
JDBC
A Local Transaction group has to be further configured as a specific type of a Local Transaction or
Transaction Transport. The Transaction Transport type determines the activities that can participate in
this local transaction group. For example, "JDBC" transaction transport only provides transaction
support for certain JDBC activities.
If a Call Process activity is used within the local transaction group, then the direct subprocesses called
are also part of the local transaction . See Call Process for more details.
General
The General tab has the following fields.
Name
Description
Name
The name to be displayed as the label for the activity in the process.
Transaction
Transport
The transport type. Select from the following available transaction transport
types:
●
None
●
JMS: To configure a JMS local transaction, select JMS as the transaction
type of the group.
●
JDBC: To configure a JDBC transaction, select JDBC as the transaction
type of the group.
JMS
JMS activities participate in a transaction using the JMS local transaction. A JMS session, when specified
as transacted, supports a single series of JMS operations. The local transaction group enlists a set of
produced messages and a set of consumed messages into a unit of work. JMS local transactions use the
underlying JMS sessions to group together all the activities that are part of the transaction group into
one unit of work.
All activities using the same JMS connection are part of one transaction. If a transaction group contains
activities that use more than one JMS connection, for example, a JMS Send Message activity using
connection 1 and another JMS Send Message activity using connection 2, there are two underlying
transactions created.
Furthermore, activities must use the same messaging styles to be in the same transaction.
Possible deadlock situation: A deadlock situation arises if you have a JMS Send Message and a Get
JMS Queue Message activities performing JMS operations on the same queue. A message not sent out
until a commit is performed, keeps Get JMS Queue Message activity waiting indefinitely. It is
recommended not to have a design which sends and receives messages on the same destination using
the same session in a single transaction.
When a transaction commits, its input is acknowledged and the associated output is sent. When a
transaction rollback is done, all the produced messages (output stream) are destroyed and the
consumed messages (input stream) are automatically recovered. You can use the JMS sender activities
with the JMS local transaction. At run time, the underlying JMS activities use the same transacted JMS
session to provide transaction semantics for messages sent and received by the JMS activities. For more
information on JMS palette and activities, refer to JMS Palette.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
16
JDBC
Using the JDBC transaction and multiple JDBC activities, you can access the same database connection
to participate in a transaction. Only JDBC activities that use the same JDBC Connection participate in
this transaction type. However, other activities can be part of the transaction group. If the transaction
commits, all JDBC activities using the same JDBC connection in the transaction group commit. If the
transaction rolls back, all JDBC activities using the same JDBC connection in the transaction group roll
back.
The transaction group commits automatically, if all activities in the group complete the transaction and
a non-error transition is taken out of the transaction group. If any error occurs while processing the
activities in the group, including errors in non-JDBC activities, it rolls back the transaction and returns
an error. Individual JDBC activities can override the default transaction behavior and commit
separately. For more information on JDBC palette and activities, refer to JDBC Palette.
For Each
The For Each group is a loop element that can be used for iterating through array elements. The For
Each activity is very useful to determine these array elements dynamically at run time.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Group Type
The type of group. The default is For Each.
Counter Name
The name of the counter or Index variable.
Selecting the Global check-box makes the index variable available
for the activities outside the loop.
Start Counter Value
The start value for the counter ($index) which is specified through an XPath
expression. This can be a literal value.
Final Counter Value
The final value of the counter which is set using an XPath expression. This
value is obtained by the count of the number of elements of a specific type in
the request message.
Accumulate Output
Select this check-box to accumulate the output of one of the activities in a
group.
The output of the selected activity is accumulated each time the activity is
executed.
Output Activity
Select the activity from the group of activities for an output reference when
executing the loop.
Output Name
The name of the list of the accumulated output of the selected activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
17
Field
Description
Reset Variables
The variable to be reset during each iteration of the For Each group.
Click the Add
icon, and select the variable to be reset.
To delete the variable, click the variable in the Reset Variables field. The
Remove
the Remove
icon with a tooltip 'Remove <variable name>'' is displayed. Click
icon to remove the variable from the Reset Variables field.
Description
Provide a short description for the activity in this field.
Variables
A group of shared variables. Depending on the group selected in Group Type, Container displays the
group. For example, if the For Each group is selected in the Group Type field, it displays For Each in
Container. You can add multiple complex or simple types variables.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
●
Date&Time
Iterate
An Iterate group repeats the series of grouped activities once for every item in an existing sequence or
list. The list can be items of any datatype. The loop executes for the number of iterations specified.
This process performs the following operations:
1. A JDBC Query activity (CustomerQuery) is used to query a database and populate a list of
customer records. The customer records are then passed to a group containing the Log activity.
2. The Log activity writes the name and address of each customer to a log and appends to the log as
each record is written.
3. The group iterates once for every customer record returned by the CustomerQuery activity.
4. The process then reads the log that was written for its data to be available to the process, and then
transitions to a SendMail activity to send the contents of the customer list through email.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
18
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Group Type
The type of group. The default is Iterate.
Index Name
The index name.
Selecting the Global check-box makes the index variable available
for the activities outside the loop.
Variable List
This field is an XPath expression. XPath is used to specify the schema element
you want to refer to.
Click the Edit XPath Expression
XPath Builder wizard.
icon to specify a value for this field in the
You can use a simple expression containing a complete list, or a more complex
one and only process certain items in the list.
Iteration Element
Provide a name for a process variable containing the current iteration element
in this field.
Global
When this check-box is selected, the output is available for the activities outside
the loop.
Accumulate
Output
Select this check-box to accumulate the output of one of the activities in a
group.
The output of the selected activity is accumulated each time the activity is
executed.
Output Activity
Select the activity from the group of activities for an output reference when
executing the loop.
Output Name
The name of the list of the accumulated output of the selected activity.
Reset Variables
The variable to be reset during each iteration of the Iterate group.
Click the Add
icon, and select the variable to be reset.
To delete the variable, click the variable in the Reset Variables field. The
Remove
icon with a tooltip 'Remove <variable name> 'is displayed. Click
the Remove
icon to remove the variable from the Reset Variables field.
Description
Provide a short description for the activity in this field.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
19
Variables
A group of shared variables. Depending on the group selected in Group Type, Container displays the
group. For example, if the Iterate group is selected in the Group Type field, it displays Iterate in
Container. You can add multiple variables of complex or simple type.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
●
Date&Time
Repeat
The Repeat group activity is responsible for repeating the series of grouped activities until the specified
condition evaluates to true. The activities are always executed once before checking whether the
condition is true. After executing the series of activities, the initial evaluation of the condition is done,
and it repeats when the condition evaluates as true. The Repeat activity evaluates the loop's
conditional statement to determine whether or not more iterations of the loop are required.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Group Type
The type of group. The default is Repeat.
Index Name
Use this field to specify a name for the index variable.
Selecting the Global check-box makes the index variable available for
the activities outside the loop.
Condition
The condition ($index) is specified through an XPath expression which can be a
literal value. Click the Edit XPath Expression button to set an XPath expression.
Accumulate
Output
Select this check-box to accumulate the output of one of the activities in a group.
The output of the selected activity is accumulated each time the activity is
executed.
Output Activity
Select the activity from the group of activities for an output reference when
executing the loop.
Output Name
The name of the list of the accumulated output of the selected activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
20
Field
Description
Reset Variables
The variable to be reset during each iteration of the Repeat group.
Click the Add
icon, and select the variable to be reset.
To delete the variable, click the variable in the Reset Variables field. The
Remove
icon with a tooltip 'Remove <variable name> ' is displayed. Click the
Remove
icon to remove the variable from the Reset Variables field.
Description
Provide a short description for the group in this field.
Variables
A group of shared variables. The Container displays the group. This depends on the group selected in
Group Type. For example, if the Repeat group is selected in the Group Type field, it displays Repeat in
Container. You can add multiple variables of complex or simple type.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
●
Date&Time
Repeat on Error
Using the Repeat on Error group, you can repeat a series of activities when an unmanageable error
occurs. The activities in this group are executed once. If there are no unmanageable errors, the loop
terminates. If an error occurs for which there is no error transition, the condition of the loop is
evaluated. If the condition is true, the loop terminates. If the condition is false, the loop repeats until
there is no error or the condition is true.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Group Type
The type of group. The default is Repeat on Error.
Index Name
Use this field to specify a name for the index variable.
Stop Repeat
Condition
The condition specifies that the activities inside the Repeat On Error are performed
repeatedly until the condition evaluates to false.
Description
Provide a short description for the group in this field.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
21
Variables
A group of shared variables. Depending on the group selected in the Group Type, the Container
displays the group. For example, if Repeat on Error group is selected in the Group Type field, it
displays RepeatOnError in Container. You can add multiple variables of complex or simple type.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
●
Date&Time
Scope
The Scope group comprises a collection of nested activities. Scope group is shared by all the nested
activities. You can use a Scope to contain a unit of work, by making it easy to manage, execute, and
revert. For example, if a customer cancels an online order, the money must be returned and the online
order canceled, without affecting other orders. You can use a Scope to manage these activities as a unit.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Group Type
The type of group. The default is Scope.
Description
Provide a short description for the group.
Variables
A group of shared variables. Depending on the group selected in the Group Type, the Container
displays the group. For example, if the Scope group is selected in the Group Type field, it displays
Scope in Container. You can add multiple variables of complex or simple type.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
●
Date&Time
While
The While activity repeats the series of grouped activities if the specified condition evaluates as true.
The condition is evaluated when the group is enters. If the condition evaluates to false, the activities
within the group are not executed.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
22
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Group Type
The type of group. The default is While.
Index Name
Use this field to specify a name for the index variable.
Selecting the Global check-box makes the index variable available
for the activities outside the loop.
Condition
The condition ($index) is specified through an XPath expression which can be a
literal value. Click the Edit XPath Expression button to set an XPath
expression.
Accumulate
Output
Select this check-box to accumulate the output of one of the activities in a
group.
The output of the selected activity is accumulated each time the activity is
executed.
Output Activity
Select the activity from the group of activities for an output reference when
executing the loop.
Output Name
The name of the list of the accumulated output of the selected activity.
Reset Variables
The variable to be reset during each iteration of the While group.
Click the Add
icon, and select the variable to be reset.
To delete the variable, click the variable in the Reset Variables field. The
Remove
icon with a tooltip 'Remove <variable name> ' is displayed. Click
the Remove
icon to remove the variable from the Reset Variables field.
Description
Provide a short description for the group.
Variables
A group of shared variables. Depending on the group selected in the Group Type, Container displays
the group. For example, if the Scope group is selected in the Group Type field, it displays Scope in
Container. You can add multiple variables of complex or simple type.
You can select from the following available Variable Type options:
●
String
●
Integer
●
Decimal
●
Boolean
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
23
●
Date&Time
Constructor
You must use the constructor for each class to instantiate that class.
Compensate
Compensate activity is executed only from the compensation handlers when a fault is encountered
outside a scope (this scope will have compensation handler defined). This activity triggers
compensation handler for a scope present only on the same level. All activities present in scope get
executed successfully.
The compensation handlers are defined per scope. The compensation handlers of scopes that are
directly enclosed by the scope and contain Compensate activity, can be executed. The handlers execute
in reverse order, so the handler of the last completed scope is executed first. The compensation handlers
can only be defined on scope level.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Description
Provide a short description for the activity.
Empty
An Empty activity denotes an activity with no action to be performed. You can specify the Name and
Description, but there is no input or output for this activity.
This activity is useful if you want to join multiple transition flows. For example, there are multiple
transitions out of an activity and each transition takes a different path in the process. In this scenario
you can create a transition from the activity at the end of each path to an Empty activity to resume a
single flow of execution in the process.
Exit
Exit activity is a synchronous activity that cancels any asynchronous activities that are in a waiting state
and terminate the process instance. You can specify the Name and Description, but there is no input or
output for this activity.
Get Context
Get Context activity retrieves the value of the specified context parameter. This is useful if your process
requires some context information from a request or a response.
GetContext activity must be placed after Invoke or Receive activity.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
24
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Use Shared
Context
Select the check box to use a job shared variable to share the context.
Shared
Context
This field is displayed when the Use Shared Context field is selected. Select the Go
Direction
Select from the following available options to specify from where the context
information should be fetched:
to
icon to locate the required job shared variable.
●
Receive Service: pulls context information from a service request. Selecting this
option displays the Service field.
●
Return from Reference: pulls context information from a reference response.
Selecting this option displays the Reference field.
●
Fault from Reference: pulls context information from a reference fault response.
Service/
Reference
Select the targeted portType and operation from where the context information is to
be picked.
Fault
This field is displayed when Fault from Reference option is selected in the
Direction field.
Description
Provide a short description for the activity.
Output
The following is the output for the activity.
Output Item
Datatype
Description
<schema>
varies
The value of the context resource specified in the
Direction field of the General tab is the output for this
activity. The schema for the output is determined by the
schema specified for the context resource.
Invoke
Invoke activity is an asynchronous activity that calls an operation of a process reference. The process
reference can be configured to invoke another process (subprocess) or invoke an external service
through a binding such as SOAP.
The Call Process activity serves a similar purpose as the Invoke activity. The Call Process activity only
calls non-WSDL-based subprocesses, or direct subprocesses, and the Invoke activity only calls WSDLbased subprocesses, or service subprocesses.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
25
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Service
Select the service for which to specify an operation.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following field.
Input item
Activity
Timeout
(seconds)
Literal
Value/
Module
Property?
Yes
Description
The Invoke activity timeout in seconds. You can either select a preset
timeout (Default Timeout, 30, 60,or 120 seconds) or specify a custom
timeout in seconds.
If the Invoke activity is configured to be Default Timeout,
then the timeout value equates to "3" minutes by default.
However this default value (3 minutes) can be modified to
be a different value by setting the AppSpace config.ini
property bw.engine.activity.async.waitTime.
When the Invoke activity timeouts, the in-line subprocess
instance called by the Invoke activity can be cancelled
before the subprocess instance completes. Hence, the
business logic in the cancelled process instance may not be
executed to its entirety.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Input
The following is the input for the activity.
Input item
Datatype
Description
input message
complex
The input message of the operation. This element contains all
the input message parts for the operation.
Output
The following is the output for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
26
Output item
Datatype
Description
output message
complex
The output message for the operation. This element contains all
the output message parts for the operation.
Fault
Click on this tab to view faults that might be thrown by the activity when it is executed at runtime.
Rethrow
Rethrow activity is used within an exception-handling routine to throw the caught error again. This is
useful if you want to perform some processing within an error-handling routine, and also send it to the
next higher scope.
Receive
Receive activity initiates the process execution based on the receipt of a request message for an
operation of the process service. The Receive activity can be configured to act as a process starter or a
signal-in activity.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Create Instance
Select this check box if you want to start a process.
Service
Select the process service and the operation from which to receive the request.
Description
Provide a short description for the activity.
Output Editor
The schema of the process variable must match the schema of the output of the activity shown on the
Output tab.
Output
Output Item
Datatype
Description
output
varies
The output of this activity is the incoming message from the
calling client or service. The structure of the message is
determined by the schema of the input message for the selected
operation on the General tab.
Reply
Reply activity is a synchronous activity that sends a message in response to a request message that was
received for an operation of a process service. This activity can be used to send a reply or a fault.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
27
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity.
Service
Select the process and the operations for which to send a response.
Reply With
Select from the following available options to send the reply message:
●
Output Message
●
Undeclared Fault
Description
Provide a short description for the activity.
Input Editor
The schema of the process variable must match the schema of the input for the activity shown on the
Input tab.
Input
Input Item
Datatype
Description
input
varies
The reply message to send. The schema depends on the output
message of the operation for this reply.
Set Context
Set Context activity can be used to set the value of a context information resource.
SetContext activity must be placed before Invoke or Receive activity.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Direction
Select from the following available options to specify where the context
information should be supplied:
●
Invoke Reference: Selecting this option displays the Reference tab.
●
Reply to Service: sends context information to a service. Selecting this option
displays the Service field.
●
Reply to Service with Fault: sends context information for a service fault
reply.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
28
Field
Description
Use Shared
Context
Select the check box to use a job shared variable to share the context.
Shared Context
This field is displayed when the Use Shared Context field is selected. Select the
Go to
icon to locate the required job shared variable.
Service/
Reference
Select the targeted portType and operation where you want to supply the context
information.
Fault
This field is displayed when Reply to Service with Fault option is selected in the
Direction field.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
input message
complex
The input message of the operation. This element contains all
input message parts for the operation.
Set EPR
Set EPR activity is a dynamic alternative to the static service element defined in the WSDL. To use an
incoming message, define the EPR schema as a part of the message in the WSDL.
An endpoint reference (EPR) combines web services elements that define the address for a resource in a
SOAP header. If you use an incoming message, an EPR schema should be defined as a part of the
message in WSDL.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity.
Dynamic
Reference
The name of the dynamic target interface for which this task is supplying the
service name and namespace
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
29
Input Item
Description
SimpleEndpointReference
Contains endpoint address information for the destination of the
outgoing message
Output
The following is the output for the activity.
Output Item
Description
EndpointReference
Contains the following elements:
●
Address: Endpoint address
●
Interface: The name of the dynamic target interface for which this task
is supplying the service name and namespace
Throw
Throw activity throws the specified fault and the control is passed to any error-handling routine
defined to handle the error. This activity is useful in a group or in a called process. You can use this
activity to catch and raise your own error conditions. The Throw activity is useful if an error in the
business logic occurs during processing.
General
The General has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Default Fault
This field displays if you are using the Throw activity in a service
process or a service subprocess.
Select this check-box if you want the default message text and error code for
the error message.
This is reflected in the Input Editor and Input for this activity.
Fault Schema
This field displays if you are using the Throw activity in a direct
subprocess.
Select a fault schema to send to the parent process. In a direct subprocess, fault
schemas are defined on the Fault Editor tab of the End activity.
If you select the - Default - option, the $_error process variable is propagated.
Description
Provide a short description for the activity.
Input Editor
Selecting the Default Fault check-box displays the message and msgCode elements in the Input Editor.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
30
Input
The following is the input for the activity.
Input Item
Datatype
Description
message
string
The text of the generated error message.
msgCode
string
The error code of the error message. This is used as an identifier
for the error for the applications to test for an error.
Fault
This activity does not produce any fault. Click on this tab to view fault schemas specified on the Input
tab.
Start
The Start activity is the first activity, and acts as the starter activity, in a direct subprocess definition. A
direct subprocess can be called from a parent process, and the Start activity is used to define the input
expected by the process.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Description
Provide a short description for the activity.
Output Editor
Use the Output Editor tab to define data for the subprocess to use as input. Any process that calls this
process definition must supply the data specified on the Output Editor tab. You can define your own
datatype on this tab, and can reference an XML schema stored in the project. Once defined, the data
specified on the Output Editor tab becomes the output schema of the Start activity. This data then
becomes available to other activities in the process definition.
From the Select Schema Element Declaration window, select Include WSLD Inline Schemas to display
inline schemas from the WSDLs in the module.
Output
The output for the activity is defined by the specified data elements on the Output Editor tab.
End
The End activity is the last activity in a direct subprocess definition. When a direct subprocess is called
from another process, the direct subprocess provides output data to the calling process. You can map
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
31
data from other activities in the process to an output schema specified on the End activity. This becomes
the output of the process.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Description
Provide a short description for the activity.
Input Editor
Use the Input Editor tab to define ouput data for the subprocess. Any process that calls this process
definition receives this data after the process call completes.
You can define your own datatype on this tab, and reference an XML schema stored in the project. Once
defined, the data specified on the Input Editor tab becomes the input schema of the End activity. You
can then map data from other activities in the process to the End activity’s input, and this becomes the
output of the process when the process completes.
From the Select Schema Element Declaration window, select Include WSLD Inline Schemas to display
inline schemas from the WSDLs in the module.
Input
The input for the activity is defined by the specified data elements on the Input tab.
Fault Editor
Use the Fault Editor tab to specify possible faults for the direct subprocess to throw.
Engine Command
The Engine Command activity allows you to retrieve statistics and information about process
definitions, process instances, and activities for the application and the appnode that is executing the
command. This activity also lets you perform job maintenance, such as suspending and resuming the
process instances.
Some commands require memory and processor overhead for gathering statistics for retrieving
information on the current state of the process. Because of the performance implications, certain
instrumentation is disabled by default.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as label of the activity in the process
definition.
Command To Execute
The command to execute.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
32
Field
Description
Process Definition Name
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
●
GetProcessDefinitionStats
●
GetProcessInstanceInfo
●
ResumeProcessStarter
●
SuspendProcessStarter
If the Process Definition name is not defined in either the
General tab or in the Input field, the command is executed for
all processes in the application.
Description
Provide a short description of the activity here.
Input
The input for the activity is the following.
Field
Description
Name
The input for this activity varies depending upon the command selected
in the Command to Execute field on the Configuration tab. See
Commands more information about the input for each command.
Output
The output for the activity is the following.
Field
Description
Name
The output for this activity varies depending upon the command
selected in the Command to Execute field on the Configuration tab. See
Commands for more information about the input for each command.
Commands
The following commands can be executed by the Engine Command activity.
GetActivityStats
Retrieves information about the activities that have been executed for a given process definition from
the time the process instrumentation statistics have been turned on. The process instrumentation
statistics can be turned on in any of the following ways:
●
using the StartStatsCollection command
●
from the command line using the enablestats command
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
33
●
from the Admin UI to set the Process Instrumentation property
For information on using the command line and the Admin UI refer to "Enabling and Disabling Process
Statistics" in the Administration guide.
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.
If the Process Definition Name is not defined in either the General tab or in the Input field, the
command is executed for all processes in the application.
Input Item
Datatype
Description
ProcessDefinition
Name
string
Name of the process definition.
Specifying a value for this element overrides the process definition
specified on the General tab.
Output Item
Datatype
Description
ProcessDefinitionName
string
Name of the process definition.
ActivityName
string
Name of the activity.
ExecutionCount
long
Number of times the activity has been executed.
ElapsedTime
long
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
long
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.
ErrorCount
long
Total number of executions of the activity that have
returned an error.
LastReturnCode
string
Status code returned by most recent execution of this
activity.
MinElapsedTime
long
Elapsed clock time (in milliseconds) of the activity
execution that has completed in the shortest amount of
elapsed time.
MaxElapsedTime
long
Elapsed clock time (in milliseconds) of the activity
execution that has completed in the longest amount of
elapsed time.
MinExecutionTime
long
Execution time (in milliseconds) of the activity execution
that has completed in the shortest amount of execution
time.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
34
Output Item
Datatype
Description
MaxExecutionTime
long
Execution time (in milliseconds) of the activity execution
that has completed in the longest amount of execution
time.
MostRecentElapsedTime
long
Elapsed clock time (in milliseconds) of the most recently
completed activity execution.
MostRecentExecutionTime
long
Execution time (in milliseconds) of the most recently
completed activity execution.
ExecutionCountSinceReset
long
Number of times the activity has been executed since the
last reset of the statistics.
GetProcessDefinitionStats
Retrieves information about process definitions. The process instrumentation statistics can be turned on
in any of the following ways:
●
using the StartStatsCollection command
●
from the command line using the enablestats command
●
from the Admin UI to set the Process Instrumentation property
For information on using the command line and the Admin UI refer to "Enabling and Disabling Process
Statistics" in the Administration guide.
If the Process Definition Name is not defined in either the General tab or in the Input field, the
command is executed for all processes in the application.
Input Item
Datatype
Description
ProcessDefinitionName
string
Name of the process definition. Specifying a value for this
element overrides the process definition specified on the
General tab.
Output Item
Datatype
Description
ProcessDefinitionName
string
Name of the process definition.
NumberCreated
long
Number of process instances created for this process
definition.
NumberSuspended
long
Number of times process instances have been
suspended.
NumberAborted
long
Number of times process instances have been aborted.
NumberCompleted
long
Number of process instances that have successfully
completed.
TotalExecutionTime
long
Total execution time (in milliseconds) for all
successfully completed process instances.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
35
Output Item
Datatype
Description
AverageExecutionTime
decimal
Average execution time (in milliseconds) for all
successfully completed process instances.
TotalElapsedTime
long
Total elapsed time (in milliseconds) for all successfully
completed process instances.
AverageElapsedTime
decimal
Average elapsed clock time (in milliseconds) for all
successfully completed process instances.
MinElapsedTime
long
Elapsed clock time (in milliseconds) of the process
instance that has completed in the shortest amount of
elapsed time.
MaxElapsedTime
long
Elapsed clock time (in milliseconds) of the process
instance that has completed in the longest amount of
elapsed time.
MinExecutionTime
long
Execution time (in milliseconds) of the process
instance that has completed in the shortest amount of
execution time.
MaxExecutionTime
long
Execution time (in milliseconds) of the process
instance that has completed in the longest amount of
execution time.
MostRecentExecutionTime
long
Execution time (in milliseconds) of the most recently
completed process instance.
MostRecentElapsedTime
long
Elapsed clock time (in milliseconds) of the most
recently completed process instance.
NumberCompletedSinceReset
long
Number of process instances that have completed
since the last reset of the statistics.
GetProcessInstanceInfo
The values of the input elements for this command specify for which process instances you want 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.
If the Process Definition Name is not defined in either the General tab or in the Input field, the
command is executed for all processes in the application.
Input Item
Datatype
Description
ProcessId
string
ID for the process instance.
ProcessDefinitionName
string
Name of the process definition. Specifying a value for this
element overrides the process definition specified on the
General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
36
Input Item
Datatype
Description
MinimumDuration
string
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
string
ID for the process instance.
ProcessDefinitionName
string
Name of the process definition.
Status
string
Status of the process.
StartTime
string
Time (in milliseconds) when the process instance started.
ElapsedTimeSinceStarted
long
Elapsed clock time (in milliseconds) since the process
instance started.
MainProcessName
string
Name of the main process definition. If the process is a
regular process, or a spawned subprocess, the name of the
process is returned. If the process is an in-line subprocess,
the name of the root process that initiated the subprocess
call is returned.
ParentProcessName
string
Name of the parent process. If the process is a regular
process, or a spawned subprocess, the parent process name
is null. If the process is an inline-subprocess, the name of
the immediate parent process is returned.
SubProcessName
string
Name of the subprocess. If the process is a regular process,
or a spawned subprocess, the subprocess name is null. If
the process is an inline-subprocess, the name of the
subprocess is returned.
GetRecoverableProcesses
Retrieves the process instances that can be recovered. Use the returned process ID in the
RestartRecoverableProcess or RemoveRecoverableProces commands.
Output Item
Datatype
Description
ProcessId
string
ID for the process instance.
ProcessDefinitionName
string
Name of the process definition.
Status
string
Status of the process.
KillProcessInstance
Kills the specified process instance. The process instance is stopped immediately and permanently
removed from the engine.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
37
Input Item
Datatype
Description
ProcessId
string
Process ID of the process instance you want to kill.
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 can no longer be recovered.
Input Item
Datatype
Description
ProcessId
string
Process ID of the checkpointed process instance you want to
remove.
Obtain the process ID of the recoverable process with the
GetRecoverableProcesses command.
RestartRecoverableProcess
Restarts the specified recoverable process instance.
Input Item
Datatype
Description
ProcessId
string
Process ID of the checkpointed process instance you want to restart.
Obtain the process ID of the recoverable process with the
GetRecoverableProcesses command.
ResumeProcessInstance
Resumes the specified process instance.
Input Item
Datatype
Description
ProcessId
string
Process ID of the process instance you want to resume.
ResumeProcessStarter
Resumes the specified process starter.
If the Process Definition Name is not defined in either the General tab or in the Input field, the
command is executed for all process starters in the application.
Input Item
Datatype
Description
ProcessDefinitionName
string
The name of the process definition whose process starter you
want to resume.
Specifying a value for this element overrides the process
definition specified on the General tab.
StartStatsCollector
Enables process instrumentation statistics for the application in the current appnode.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
38
StopStatsCollector
Disables process instrumentation statistics for the application in the current appnode.
StopApplication
Gracefully stops the application.
SuspendProcessInstance
Suspends the specified process instance.
Input Item
Datatype
Description
ProcessId
string
Process ID of the process instance you want to suspend.
SuspendProcessStarter
Suspends the specified process starter.
If the Process Definition Name is not defined in either the General tab or in the Input field, the
command is executed for all process starters in the application.
Input Item
Datatype
Description
ProcessDefinitionName
string
The name of the process definition whose process starter you
want to suspend.
Specifying a value for this element overrides the process
definition specified on the General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
39
Binding
Binding is used to establish a connection between SOA Services and their consumers. They are
communication gateways to connect to the external world. They follow a well-known communication
protocol that both client and service are aware of.
The two types of binding components are:
●
Service Binding: used to create and expose a service to the external world. The service can contain
one or more operations. Once exposed, the service can be consumed by its clients.
●
Reference Binding: used to create a client that can connect and communicate to an external service.
TIBCO Business Studio supports REST as well as SOAP bindings.
REST Binding
REST Binding provides external connectivity for REST over HTTP. You can specify custom HTTP
headers and parameters using REST binding. It supports POST, GET, PUT, PATCH, and DELETE HTTP
methods. It also supports JSON, XML, and plain text message types.
Binding
This section has the following fields.
Field
Description
Resource
The name of the resource.
Resource
Service
Path
Specify the path to the Service Resource.
Define parameters in the resource service path by enclosing each parameter in { }
brackets. For example, to define the path parameter isbn for a book resource, specify
the resource path as follows:
/book/{isbn}
In this example, the client would invoke this service using the URL http:/<host>:<port>/
book/<isbn>.
Path parameters that are not immediately enclosed in forward slashes are
supported. For example, the parameter authorName('{isbn}') in the
resource service path /book/authorName('{isbn}')/ is not directly
contained by forward slashes, but will still successfully pass.
If an application contains multiple REST bindings, ensure that the location of the path
parameters is unique for each REST binding.
An example is that of one REST binding using the /book/{isbn} path and another
REST binding is using the /book/{authorid} path. Since {isbn} and {authorid} are
defined at the same location in the URI , one of these services will not function as
expected.
In addition to path parameters, the path in a REST binding can also contain query
parameters. For example,
/resource/path/{pathparam}? query={queryparam}
or /resource/path/
{pathparam}?{ queryparam}
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
40
Field
Description
HTTP
Connector
Name
The name of the HTTP Connector.
Click on the HTTP Connector Name field to display details about the HTTP
Connector resource.
By default, a new HTTP Connector Shared Resource is created when you create a new
REST Service binding. Change the field value type to Module Property to specify a
module property that has been defined as an HTTP Connector Shared Resource.
Response
Client
Format
The type of response message format.
Enforce
BW
Service
Response
Select the check box to set the response preference to BW Service Response.
The supported response message formats are: JSON or XML.
By default, the check box is not selected, and the response preference is set to the
Accept Header response. For additional details, refer to the section, "Accept Header
Responses" in the REST Reference guide.
Imported projects display the Authenticate check box under the Binding section if the check box was
selected in a previous version TIBCO ActiveMatrix BusinessWorks™ 6.x. Authentication also remains
enabled on the REST Service Binding if you do not deselect the check box. Deselecting the
Authenticate check box causes a warning message to be displayed prompting you for confirmation.
Clicking OK causes the Authenticate check box to no longer display and removes authentication from
REST Service Binding . Click Cancel to retain the Authenticate check box, and to continue enforcing
authentication on the binding.
To enforce authentication on the REST Service Binding, use the authorization header or associate the
binding with a Basic Authentication policy. For additional details, refer to the section, "Enforcing Basic
Authentication " in the Application Development guide.
Operations
This section shows the following details.
Field
Description
Name
The name of the HTTP method used, for example, POST, GET, PUT, PATCH,
and DELETE.
Nickname
The specified name of the service, for example, getBooks.
Operation Details
This section has the following tabs.
Summary tab
Field
Description
Summary
The summary of the REST resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
41
Field
Description
HTTP Method
Displays the HTTP Method specified in the Operations section. These are the
available HTTP methods:
Notes
●
POST
●
GET
●
PUT
●
DELETE
●
PATCH
Additional information about REST resource.
Request tab
Field
Description
Use Null for Empty Values
Select the check box to set NULL values instead
of empty values in JSON. i.e use NULL instead
of [] brackets. By default, the check box is not
selected.
Format
Supported formats for REST service request are:
●
JSON
●
XML
●
Text
JSON Definition Style
Specifies whether the request item is a Single
Element or an Anonymous Array.
Request
Data type of the Payload. It can be one of the
following:
●
XSD Elelment...
●
String
●
Integer
●
Boolean
●
Form Data - Tag/Value (application/x-wwwform-urlencoded)
●
Form Data - Multipart (application/formdata)
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
42
Field
Description
Form Parameters
The user can add, remove, scroll up and scroll
down form parameters. This pane has 4
columns:
●
Parameter Name
Name of the parameter. Users can edit the
parameter name by clicking on the parameter
added.
●
Type
Data type of the parameter. It can be:
●
—
String
—
Integer
—
Long
—
Float
—
Double
—
Boolean
—
Byte
—
Binary
—
Date
—
Date Time
—
Password
Repeating
This field can be toggleed to Yes and No.
●
Required
This field can be toggleed to Yes and No.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
43
Field
Description
Query and Header Parameters
The user can perform following operations:
●
Add Query Parameter
●
Add Header Parameter
●
Remove Parameter
●
Scroll Up
●
Scroll Down
This pane has 4 columns:
●
Parameter Name
Name of the parameter. Users can edit the
parameter name by clicking on the parameter
added.
●
Type
Data type of the parameter. It can be:
●
—
String
—
Integer
—
Long
—
Float
—
Double
—
Boolean
—
Byte
—
Binary
—
Date
—
Date Time
—
Password
Repeating
This field can be toggleed to Yes and No.
●
Required
This field can be toggleed to Yes and No.
Response tab
Field
Description
Use HTTP Headers
Selecting this check box includes the response
headers element. Response headers are not
commonly used, so select this check box only
when you need to include response headers.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
44
Field
Description
Use Custom Status Line
You can specify a custom status line (status code
and reason phrase) to the outgoing message. The
codes used must be defined in the configuration
under the Response Status tab.
Response with Status Code Only
The operation returns a status code as response,
when this check box is selected. Message body is
not required. For example, using a POST
operation returns a 201 status code which means
"Created" and responds with the resource URL.
Use Empty Values for Null
Select the check box to set empty values instead
of NULL values in JSON. i.e use [] brackets
instead of NULL. By default, the check box is not
selected.
Format
Supported formats for REST service request are:
●
JSON
●
XML
●
Text
JSON Definition Style
Specifies whether the request item is a Single
Element or an Anonymous Array.
Resource Schema
Displays the schema selected. This option is not
available when the Use Custom Status Line and
Response with Status Code Only check boxes
are selected. These are the available options:
●
String
●
Integer
●
Boolean
●
XSD element: Selecting this option to either
select the XSD schema element available
under the Schemas folder of your project or a
create new XML schema resource. Click
Create New Schema to a create new XML
schema resource using the Simplified Schema
Editor wizard.
Ensure the schema resource you
select does not contain cyclic
dependencies on other schemas ,
or a type that has two child
members with the same local
name, but different namespaces.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
45
Field
Description
Header Parameters
This field is enabled only when Use HTTP
Headers check box is selected.
The user can perform following operations:
●
Add Header Parameter
●
Remove Parameter
●
Scroll Up
●
Scroll Down
This pane has 4 columns:
●
Parameter Name
Name of the parameter. Users can edit the
parameter name by clicking on the parameter
added.
●
Type
Data type of the parameter. It can be:
●
—
String
—
Integer
—
Long
—
Float
—
Double
—
Boolean
—
Byte
—
Binary
—
Date
—
Date Time
—
Password
Repeating
This field can be toggleed to Yes and No.
●
Required
This field can be toggleed to Yes and No.
Response Status tab
Column Name
Description
Code
These are unique numbers. Click on the error
code to customize it.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
46
Column Name
Description
Type
Data type of the error code. Following types are
supported:
●
XSD Element...
Select this option to either select the XSD
schema element available under the Schemas
folder of your project or create a new XML
schema resource.
●
String
●
Integer
●
Boolean
The default type is String.
Reason Phrase
Description of the error code. Click on the value
to customize the description.
Path Parameters
This section shows the following details.
Parameter Name
Type
Parameter name of the operation
used
The parameter type. It can be any one of the following:
●
String
●
Integer
●
Boolean
●
Long
●
Float
●
Double
●
Byte
●
Binary
●
Date
●
DateTime
●
Password
Policies
To associate a new or existing policy with the REST binding, click Policies node under the RestService
to create a new policy. To edit an existing policy details, click the policy
tree, then click Add Policy
name and edit any of the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
47
Field
Description
Policy Name
The name of the policy.
Policy Type
The type of policy associated with the binding. The REST binding can support
the Basic Authentication policy.
Description
A description of the policy.
Rest Service Wizard
Rest Service Wizard is used to create a new Rest Resource or add Rest Services to an existing resource
in TIBCO Business Studio.
The Rest Service Wizard has the following fields:
Field
Description
Resource Name
The name of the REST Resource.
Summary
The summary or description of the REST Resource.
Resource Service
Path
The relative path for this REST Service Resource.
If an application contains multiple REST bindings, ensure that the location
of the path parameters is unique for each REST binding.
For example, one REST binding is using the paths /book/{isbn} and
another REST binding is using the path /book/{authorid}. Since {isbn}
and {authorid} are defined at the same location in the URI , one of these
services will not function correctly.
In addition to path parameters, the path in a REST binding can also contain
query parameters. For example,
/resource/path/{pathparam}? query={queryparam}
or /resource/
path/{pathparam}?{ queryparam}
Resource Definition
The XSD schema element to be used for creating the REST resource.
You can also use this to create the input and output of each operation
defined. You can override this on the next screen if required, for each
operation.
Operations
These are the HTTP methods implemented by this REST Service.
Currently only POST, GET, PUT, PATCH, and DELETE methods are
supported for users to implement.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
48
Field
Description
Implementation Data
The implementation data field can be Structured or Opaque.
●
Structured: The XSD element structure is preserved for the input and
output of every operation. You need not manually parse the payload to
generate the actual element to be used in the process.
●
Opaque: Use this mode to apply the pass through mechanism. A user
gets a messageBody element in the input or output of every operation
and needs to use either Parse activities for JSON or XML to get a
structured output for the payload.
To add additional services to a process, click Create A Rest Service
canvas.
on the top left of the process
Re-creating a component containing a REST binding after deleting the component is not supported. To
add the REST binding, in the process editor, right click on the service without a binding. Go to
Components > [componentware] > Create REST Binding. A binding is created for the service. The
binding will have to be re-configured as the previous configurations will be lost.
SOAP Binding
You can use SOAP binding to create service providers and service consumers, based on the SOAP
protocol. ActiveMatrix BusinessWorks 6.x supports SOAP 1.1 and SOAP 1.2 protocol. Messages created
by SOAP binding can either use HTTP or JMS transport for communication. Depending upon whether
you want to create a service provider or a service consumer, there are two types of SOAP bindings:
SOAP Service Binding and SOAP Reference Binding.
SOAP operations ActiveMatrix BusinessWorks support the following Message Exchange Patterns:
●
One-Way
●
Two-Way (request-response)
●
Two-Way with Fault
Terminology
ActiveMatrix BusinessWorks uses specific terminology to identify the purpose of the message, that is
exchanged between a service provider and a service consumer.
Terms Used for SOAP Messages
The following table describes the terms used to describe a SOAP message.
Term
Description
ServiceRequest
A request message received by a service provider
ServiceReply
The response message sent by a service provider
ReferenceRequest
A request message generated by a service consumer
ReferenceReply
A response message received by a service consumer
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
49
SOAP Headers
Refer to the following table for the terminology used to described different configurations that can be
used to create a SOAP Header.
Term
Description
Described
Described denotes that the WSDL message definition used to create a SOAP
header is available in the concrete WSDL.
Undescribed
Undescribed denotes that the WSDL message definition used to create a
SOAP header is not available in the concrete WSDL.
Bound
Specifies that the SOAP header definition is the part of the same WSDL
message, that is also used to create a SOAP body. In such cases, a WSDL
message contains multiple parts. Some parts are defined to describe SOAP
headers and others are defined to describe the SOAP body.
Unbound
Specifies that the SOAP header definition is not a part of the same WSDL
message, that is also used to create a SOAP body
Based on the definitions in the SOAP Headers table, SOAP headers can be categorized into any of the
following three types of configurations:
●
Described bound headers
●
Described unbound headers
●
Undescribed unbound headers
SOAP Attachments
Refer to the following table for SOAP attachment types and their relevant description.
SOAP Attachment
Types
Description
Described Bound
Attachments
In this configuration, a part of the input or output WSDL message of type
base64binary is configured as an attachment. In a concrete WSDL, the
attachment is described as a mime part of the multipart message.
Undescribed
Unbound
Attachments
None of the parts of the WSDL input or output message is configured to be
an attachment. The concrete WSDL does not indicate whether an attachment
is in the input or output message.
Attachment mapping is done at the Binding Configuration under Context
Mapping (Request/Response)
SOAP Service Binding
Using SOAP service binding you can create a service provider through the SOAP protocol.
Binding
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
50
Field
Description
Name
The name of the service binding.
Description
A short description of the service getting exposed.
Target Namespace
The Target Namespace of the service.
Generate Concrete WSDL
The SOAP service binding helps you to create the concrete WSDL using Concrete WSDL Generation
Wizard. See Generating Concrete WSDL for more details.
SOAP Default Configuration
This section has the following fields.
Field
Description
SOAP Version
The version of the SOAP specification: 1.1 or 1.2. The default is 1.1.
Style
The default SOAP binding style for all operations. Specify either
Document or RPC style.
Encoding
Encoding is literal.
Attachment Style
Select the default attachment style for all the binding operations. Can be
overidden at the operations level for each operation.
The following attachment styles are available:
●
SwA - Supports both, Bound and Unbound Attachments
●
MTOM
The MTOM attachment style is available only if SOAP 1.2 specification is
used.
Transport Configuration
This section has the following fields.
Field
Literal Value/
Module
Property
Description
Transport
Type
None
The transport over which SOAP message is sent. The HTTP and
JMS transports are supported.
Connector
Name
None
The name of the shared resource. This points to either the HTTP
or JMS shared transport configuration.
Configuration for HTTP Transport
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
51
Literal Value/
Module
Property
Description
HTTP
Connector
Name
None
Name of the HTTP Connector resource.
Endpoint URI
Yes
Field
Click on the HTTP Connector Name field to display
details about the HTTP Connector resource.
The endpoint URI for the service.
Configuration for JMS Transport
JMS
Connection
Name
None
The name of the JMS Connector resource.
Click on the JMS Connection Name field to display
details about the JMS connector resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
52
Field
Acknowledge
Mode
Literal Value/
Module
Property
None
Description
The acknowledge mode for service request messages. It can be
one of the following:
●
Auto: The message is acknowledged when it is received by a
SOAP Service Binding.
●
Client: The message is not acknowledged when it is received
by the SOAP Service Binding. You can confirm the message
by using the Confirm activity in the BusinessWorks process
that is configured as an operation implementation. If the
Confirm activity is not used, the message is automatically
acknowledged by the SOAP Service Binding while sending
the service reply.
●
Dups OK:The message is acknowledged automatically when
it is received by a SOAP Service Binding. JMS provides this
mode for lazy acknowledgment , but ActiveMatrix
BusinessWorks acknowledges messages upon receipt.
●
Tibco EMS Explicit: (only available for TIBCO Enterprise
Message Service™)
The message is not acknowledged when it is received by a
SOAP service binding. You can confirm the message by using
the Confirm activity in the ActiveMatrix BusinessWorks
process that is configured as the operation implementation.
If the Confirm activity is not used, then the message is
automatically acknowledged by the SOAP Service Binding
while sending the service reply.
The session is not blocked and one session handles all
incoming messages for each process instance.
●
Tibco EMS Explicit Dups OK: (only available for TIBCO
Enterprise Message Service)
The message is not acknowledged when it is received by a
SOAP service binding. You can confirm the message by using
the Confirm activity in the Activematrix BusinessWorks
process that is configured as the operation implementation.
If the Confirm activity is not used, the message is
automatically acknowledged by SOAP Service Binding while
sending the service reply.
The session is not blocked and one session handles all the
incoming messages for each process instance. The messages
however, are lazily acknowledged.
Delivery
Mode
(Response)
No
The delivery mode of messages.
●
Persistent Messages are stored and forwarded.
●
Non-Persistent Messages are not stored and can be lost due
to failure.
The default mode is Persistent.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
53
Field
Literal Value/
Module
Property
Message Type
None
Specifies the type of the service request messages. It can be either
Text message or Bytes message.
Messaging
Style
None
Specifies the style of the service request messages. It can be
Generic, Queue, or Topic.
JMS
Destination
Yes
Specifies the name of the destination for the service request
messages. The syntax of the destination name is specific to the
JMS provider you are using.
JMS
Application
Properties
None
User-defined JMS Properties expected to be available in the
service request messages.
JMS
Application
Properties
(Response)
None
Max Sessions
None
Description
NOTE: JMS Application properties should be defined in a
schema only through a complex type. Also, all JMS Application
properties should be direct child of this complex type.
User-defined JMS Properties expected to be sent in the the
service response messages.
NOTE: JMS Application properties should be defined in a
schema only through a complex type. Also all JMS Application
properties should be direct child of this complex type.
When the Acknowledge Mode field is set to Client, this field
configures the maximum number of JMS sessions that is created
for the service request messages.
When a message is received, the session is blocked until the
message is acknowledged in the process. If acknoledgement is
not done at process level then it is automatically acknowleged
when the SOAP Service Binding sends a service reply.
After reaching the maximum number of sessions, no new
incoming messages can be processed. Once any one of the
messages is processed ,the total number of active sessions
decreases and then another incoming message can be processed.
Operations
None
This field is available only when Topic is selected in the JMS
Destination Type field.
Operation Name - Specifies the operation name.
Durable Subscription - Set to true if the client is a durable
subscriber.
Subscription Name - Specify the Subscription Name if Durable
Subscription is set to true.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
54
Imported projects display the HTTP Authentication check box under the Transport Configuration
section if the check box was selected in a previous version TIBCO ActiveMatrix BusinessWorks 6.x.
Authentication remains enabled on the SOAP Service Binding if you do not clear the check box. If you
clear the Authentication check box, a warning message is displayed prompting you to confirm your
action. To remove authentication from the binding, click OK. Once you have removed authentication
from the SOAP Service Binding, you can reapply it using the Basic Authentication policy. For
additional details, refer to the sections "Enforcing Basic Authentication" and "Enforcing WSS Provider"
in the TIBCO ActiveMatrix BusinessWorks Application Development guide.
Persistence Configuration
This section has the following fields.
Field
Literal
Value/
Module
Property
Persistence Type
None
Description
Select any one from the available Persistence configuration
types. They are NONE and File.
Selecting the File option displays the Directory, Create
Directories, and Threshold Size fields.
Directory
Yes
The directory where attachments will be serialized.
Create
Directories
Yes
Creates new directories if not present on the disk.
Threshold Size
Yes
The maximum size of the attachment that can be kept in
memory. Attachments larger than the specified size will be
written to the disk.The file name generated for serialization is
random except when the Content-disposition header is available
for the attachment. Here, the name is the same as the contentdisposition header value.
You can configure the size to Bytes, KB or MB.
Threading Policy Details
The following are the details for the SOAP Service Binding threading policy.
Activity Type
MultiThreaded?
Default Thread Count
Thread Count Configuration
Transport: HTTP
ProcessStarter
Yes
●
Minimum thread pool
threads = 10
●
Maximum thread pool
threads = 75
It can be configured on the HTTP
Connector shared resource using the
following fields:
●
Minimum QTP threads
●
Maximum QTP threads
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
55
Add Binding
You can add a binding. Click the Add Binding icon
to add a binding.
Delete Binding
You can delete a binding. Click the Delete Binding icon
to delete a binding.
Policy
Bindings that support policies will display the Policy field. To associate a new or existing policy with
the SOAP HTTP Binding, click the Add Policy
The Policy section has the following fields.
icon. To edit policy details, click Policy Name.
Field
Description
Policy Name
The name of the policy.
Policy Type
The type of policy associated with the binding. The SOAP HTTP Service
Binding can support the following policies:
Description
●
Basic Authentication
●
WSS Provider
A description of the policy.
Generating Concrete WSDL
The SOAP service binding helps you to create the concrete WSDL using Concrete WSDL Generation
Wizard.
Generate Concrete WSDL
To generate the WSDL, do the following.
1. Click Generate Concrete WSDL.
2. In the Concrete WSDL Generation Wizard, the Location field shows Workspace and File System
tabs.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
56
3. Click the Workspace tab to create the WSDL in your workspace and specify a location where WSDL
is to be created.
4. To select location:
a.
Click the Workspace tab if you want to create the WSDL in your workspace and select a
location. It is recommended to select the Service Descriptor folder to contain all project related
WSDLs.
b.
Click File System tab if you want to save the concrete WSDL on a disk location other than the
workspace.
Click Finish if you want to generate WSDL with default settings.
5. The File Name field shows the name of the WSDL, for example BooksService_gen.wsdl. Override
it as per requirement.
6. Click Next.
7. Select the Embed Abstract WSDL and Embed Schema check boxes on the next screen. (The
following image is of SOAP over HTTP binding.)
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
57
By default the Embed Abstract WSDL and Embed Schema check boxes are selected.
With Embed Abstract WSDL check box selected, the concrete WSDL generated has an abstract
WSDL content in it.
In this case, the namespace of the concrete WSDL is the same as that of an abstract WSDL. If the
check box is not selected, then the namespace of the concrete WSDL is different than that of the
abstract WSDL.
When you select Embed Schema check box, the concrete WSDL generated has the schema definition
(mentioned in the abstract WSDL) in it. Schema with no target namespace is not supported.
To avoid any namespace resolution error in the application module: If the concrete
WSDL is placed in a workspace location (as mentioned in the earlier step), clear the
Embed Abstract WSDL check box.
8. For advance configuration of the concrete WSDL such as Namespace URI, Service Name, Host, and
Port (for SOAP over HTTP), click the Advance tab. Override them as per requirement.
9. Click Finish.
Operation Configuration
Operation configuration enables you to set configurations at the operation level.
This section has the following fields.
Field
Description
Operation Name
The name of the operation component.
SOAP Action
Specifies the soap action for this operation. By default it is the operation
name
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
58
Field
Description
Style
The SOAP binding style. Specify either Default Document or RPC style.
Configurations made at the binding level can be overidden here.
Attachment Style
Select the attachment style for the operations.
The default configurations for each operation can be overridden here.
The following attachment styles are available:
●
Default - The attachment style configured at the binding level.
●
SwA
●
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.
Request Message Configuration
Request Message Configuration can be used to configure request message contents like SOAP
header,SOAP body, and attachments.
Message Part Configuration
You can configure the WSDL Input message parts as body, header (bound) or attachment for a service
request.
The Attachment option, configures a SwA attachment (bound) . This is available only for WSDL
message parts that are of type base64binary.
This section has the following fields:
Field
Description
Part Name
Specifies the part name of the WSDL message as configured in the
WSDL.
Part Type
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header.
●
Body - Configures the WSDL part as SOAP Body.
●
Attachment - Configures the WSDL part as a SwA attachment.
Unbound Header Configuration
You can configure SOAP Headers for service requests in this section . The WSDL message's part, other
than the input WSDL message, can be configured as a SOAP header. The WSDL messages can be in an
external WSDL.
Configurations done here will appear in the Concrete WSDL in the SOAP header element.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
59
Select Unbound Header
Use the Add icon
part.
to select and add this configuration. Select the WSDL, the message and then the
This section has the following fields:
Field
Description
Message
Specifies the WSDL message name as configured in the WSDL.
Part
Specifies the part name of the WSDL message as configured in the
WSDL.
Delete Unbound Header
To delete an unbound header, select the required row and click the
icon.
Undescribed Header Configuration
You can configure SOAP Headers for service requests in this section.The WSDL message's part, other
that the input WSDL message, can be configured as SOAP header here. The WSDL messages can be in
an external WSDL. These headers are undescribed headers and will not appear in the Concrete WSDL.
Add Undescribed Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
Field
Description
Header Name
Specifies the WSDL message name as configured in the WSDL.
Header Part
Specifies the part name of the WSDL message as configured in the
WSDL
Cardinality
Configure the cardinality of the configured SOAP header as one of the
following:
●
Optional(?) - The SOAP header is optional.
●
Required - The SOAP Header is required and must be supplied when
the process is called.
●
Repeating (*) - Zero or more SOAP headers must be supplied are
present when the process is called.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
60
Delete Undescribed Header
You can delete an undescribed header. Select the required binding and click the Delete Binding icon
.
Attachment Configuration
If a part is configured as an attachement in the Message Configuration section, then the attachement's
content type is configured here. This section has the following fields:
Field
Description
Part
Specifies the WSDL message name as configured in the WSDL.
This corresponds to the part that is configured as an attachment in the
Message Part Configuration section.
Content Type
Indicates the media type of the attachment received. An example of the
media type is text/html.
Response Message Configuration
Response Message Configuration enables you to configure response message contents like the SOAP
header, SOAP body, and attachments.
Message Part Configuration
This section has the following fields:
Field
Description
Part Name
Specifies the part name of the WSDL message as configured in the
WSDL.
Part Type
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header
●
Body - Configures the WSDL part as SOAP Body
●
Attachment - Configures the WSDL part as a SwA attachment.
Unbound Header Configuration
You can configure SOAP Headers in this section. The WSDL message part, other than the input WSDL
message, can be configured as a header here. The WSDL messages can be in an external WSDL.
Configurations done here will appear in the Concrete WSDL in the SOAP header element.
Add Unbound Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
61
Field
Description
Message
Specifies the part name of the WSDL message as configured in the
WSDL.
Part
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header
●
Body - Configures the WSDL part to SOAP Body
●
Attachment -Configures the WSDL part as a SwA attachment.
Delete Unbound Header
You can delete an unbound header. Select the required header and click the
icon.
Undescribed Header Configuration
You can configure SOAP Headers in this section. WSDL message's part, other that the input wsdl
message, can be configured as soap header here. The WSDL messages can be in an external WSDL.
These headers are undescribed headers and will not appear in the Concrete WSDL.
Add Undescribed Header
to select and add this configuration. Click the icon and select the WSDL, the
Use the Add icon
message and then the part.
This section has the following fields:
Field
Description
Header Name
Specifies the message name.
Header Part
Specifies the message part.
Cardinality
Configure the cardinality of the configured SOAP header as one of the
following:
●
Optional(?) - The SOAP header is optional.
●
Required - The Soap Header is required and must be supplied when
the process is called.
●
Repeating (*) - Zero or more SOAP headers must be supplied are
present when tha process is called.
Delete Undescribed Header
You can delete an undescribed header. Select the required header and click the
icon.
Attachment Configuration
This section has the following fields:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
62
Field
Description
Part
Specifies the WSDL message name as configured in the WSDL.
This corresponds to the part that is configured as an attachment in the
Message Part Configuration section.
Content Type
Indicates the media type of the entity body sent to the receiver. An
example of the media type is text/html.
Fault Operation Configuration
Fault Operation Configuration enables you to configure fault messages.
Message Part Configuration
This section has the following fields.
Field
Description
Part Name
Specifies the part name of the WSDL message.
Part Type
The body of the SOAP message.
Unbound Header Configuration
You can configure SOAP Headers in this section. The WSDL message part, other than the input WSDL
message, can be configured as a header here. The WSDL messages can be in an external WSDL.
Configurations done here will appear in the Concrete WSDL in the SOAP header element.
Add Unbound Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
Field
Description
Message
Specifies the part name of the WSDL message as configured in the
WSDL.
Part
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header
●
Body - Configures the WSDL part to SOAP Body
●
Attachment -Configures the WSDL part as a SwA attachment.
Delete Unbound Header
You can delete an unbound header. Select the required header and click the
icon.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
63
Context Mapping
Using Context Mapping you can map data between the context activities used in a process, and the
request response or fault message.
Transport headers are supported when mapping the fault context for a SOAP Service Binding, and
undescribed headers are supported when mapping the fault context for a SOAP Reference Binding.
Service Binding - Request Context
Using Request Context you can map data from the Request Message to the Get Context Activity used
in the process.
Data Source
Displays the data source schema tree for the input context parameters. All elements in this tree are
available to drag and drop into the XPath Expression field. The following elements are populated from
the request message:
Elements of Request
Message
Transport Properties
Description
Transport related information for HTTP headers when the
Transport is HTTP, or JMS properties when the Transport is JMS,
are populated from the request message.
●
method: The method specified in the request. For example,
GET and POST.
●
requestURI: The address portion of the request. This is the
portion before the question mark (?).
●
httpversion: Version field of the HTTP request.
●
querystring: The query string portion of the request. This is the
portion after the question mark (?).
●
header: The header of the HTTP request.
●
protocol: Can be either HTTP or HTTPS depending upon the
protocol used by the request.
●
port: Port number on which the request was received.
●
remoteAddress: The IP address of the client that submitted the
HTTP request.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
64
Elements of Request
Message
Description
Headers
Headers from the request message.
●
accept: 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: 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: 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: 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: This field indicates the size of the entity body
(in decimal number of OCTETs) sent to the receiver.
●
connection:Use this field to specify options required for this
connection. For example, the close option specifies that you
want the connection to be closed when the request is complete.
●
pragma: 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.
This field takes into account the encoding of the message body.
Dynamic Headers
The dynamic header is an additional header parameter to add
runtime headers to the outgoing HTTP messages. The
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
Headers
The header of the request.
Undescribed Headers
Undescribed headers from the request message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
65
Elements of Request
Message
mimeEnvelopeElement
Description
Information about the attachements that are present in the request
message. Individual attachment information is populated under
one mimepart element.
Note: If the attachment size increases the threshold value
configured at the binding level, the file name of the serialized
attachment is populated.
mimeHeader
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
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 written to the disk.
Service Binding- Response Context
Response Context enables you to map data from the Set Context Activity to the response message.
Data Source
Displays the data source schema tree for the output context parameters. All elements in this tree are
available to drag and drop into the XPath Expression field.
The following are the response message entities:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
66
Elements of Set Context/
Response Message
Description
Headers
Headers of the response message.
Dynamic Headers
●
pragma: 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: 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.
The dynamic header is an additional header parameter to add
runtime headers to the outgoing HTTP messages. The
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
Headers
The fields of the header specified on the Input Headers tab.
Undescribed Headers
Undescribed headers of the response message.
mimeEnvelopeElement
Information about the attachements that are present in the
response message. Individual attachment information is populated
under one mimepart element. All attachments are configured as
SwA unbound attachments.
Note: If the attachment size increases the threshold value
configured at the binding level, the file name of the serialized
attachment will be populated.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
67
Elements of Set Context/
Response Message
mimeHeader
Description
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
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 written to the disk.
Fault Context
Fault Context enables you to configure the SOAP Fault data.
Data Source
Displays the data source schema tree for the SOAP fault message. All elements in this tree are available
to drag and drop into the XPath Expression field. The following elements are the fault message entities:
Elements of Fault Message
Description
SOAPFaultContext
The SOAP fault schema describes information about the fault sent
back to the user.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
68
Functions
Displays the available XPath functions. These are categorized into groups and each function can be
dragged from the function list into the XPath Expression field.
When the function is placed into the XPath Expression, placeholders are displayed for the function’s
parameters. You can drag and drop schema elements from the Data Source tab into the function’s
placeholders.
Filter
Use this field for a refined function search in the mapper. Clicking the Functions tab displays the Filter
field. For example, type "time" in the Filter field to obtain consolidated results relating to "time"
function.
Constants
Displays the constants available for use in XPath expressions. These are categorized into groups and
each constant can be dragged from the constants list into the XPath Expression field. Constants are
useful for inserting special characters, such as quotes, symbols, and so on, into XPath formulas.
Constants are also defined for commonly used items, such as date/time formats.
Constants can also be used for inserting TIBCO BW Predefined Module Properties, such as Activity
Name, Application Name, Domain Name, and so on.
XPath Expression
Displays the XPath formula you want to create. You can drag and drop items from the Data Source tab
or the Functions tab to create the formula.
SOAP Reference Binding
Using SOAP reference binding you can create a service consumer using SOAP protocol.
It is recommended to use the HTTP Client Shared Resource when configuring SOAP Reference
Binding. Response received for a transport communication error might be different if compared with
response received using the HTTP Client shared resource.
Binding
This section has the following fields.
Field
Description
Name
The name of the reference binding.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
69
Field
Description
Description
A short description of the HTTP reference binding.
WSDL Service
Specifies the service name and its target namespace.
WSDL Port
Specifies the binding implemented by the service. If more than one
implementation is available in concrete WSDL, select an appropriate
implementation.
SOAP Version
The version of the SOAP specification: 1.1 or 1.2.
Attachment Style
The attachment style for the incoming and outgoing messages. The
following attachment styles are available:
●
SwA
●
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.
Enable
DefaultFaultElement
Select the check box to enable the fault DefaultFaultElement on the Invoke
activity.
By default the check box is not selected.
Ignore
mustUnderstand
Select this check box to ignore the value of the mustUnderstand attribute, in
the incoming request, when the attribute is set to true.
By default the check box is not selected.
Transport Configuration
This section has the following fields.
Field
Literal Value/Module Property
Description
Transport
Type
None
The transport over which the SOAP
message is sent. HTTP and JMS transports
are supported.
Application for HTTP Transport
Default Host/
Port
None
Specifies the default host and port
configuration available in the concrete
WSDL.
HTTP Client
Name
Yes
Name of the HTTP Client resource.
Click the
icon to select a
shared resource for the HTTP
client.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
70
Field
Literal Value/Module Property
Description
Endpoint URI
Yes
The endpoint of the service through which
SOAP clients can access the service.
Application for JMS Transport
JMS
Connection
Name
None
Name of the JMS Connector resource
JMS
Destination
Yes
Specifies the name of the destination for
the incoming JMS messages. The syntax of
the destination name is specific to the JMS
provider you are using.
Messaging
Style
None
Specifies the style of the incoming
messages on the specified destination. It
can be Generic, Queue, or Topic.
Message Type
None
Specifies the type of the incoming
messages on the specified destination. It
can be either Text Message or Bytes
Message.
Delivery
Mode
No
The delivery mode of messages.
●
Persistent Messages are stored and
forwarded.
●
Non-Persistent Messages are not
stored and can be lost due to failure.
The default is Persistent.
Expiration
Yes
The length of time a message can remain
active. 0 means that the message does not
expire.
Priority
Yes
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).
The default is 4.
JMS
Application
Properties
None
The user-defined JMS Properties required
to be available in the incoming message.
JMS
Application
Properties(Re
sponse)
None
The user-defined JMS Properties required
to be sent in the outgoing message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
71
Persistence Configuration
This section has the following fields.
Field
Literal
Value/
Module
Property
Persistence Type
None
Description
Select any one from the available persistence configuration
types.
●
None
●
File
Selecting the File option displays the Directory, Create
Directories, and Threshold Size fields.
Directory
Yes
The directory to write attachments that exceed the specified
threshold size.
Create
Directories
Yes
Creates new directories if not already present on the disk.
Threshold Size
Yes
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 name is the output, so that subsequent activities in the
process can access the file and read its contents.
Threading Policy Details
The following are the details about the SOAP Reference Binding threading policy.
Activity Type
MultiThreaded?
Default Thread
Count
Thread Count Configuration
Transport: HTTP
Asynchronous
Yes
●
Core pool size = 5
●
Max pool size =10
You can either configure it by using the
Thread Pool shared resource or by
providing it in the config.ini using the
following properties:
●
com.tibco.bw.palette.http.reques
tresponse.threadpool.coresize
●
com.tibco.bw.palette.http.reques
tresponse.threadpool.maxsize
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
72
Policy
Bindings that support policies will display the Policy field. To associate a new or existing policy with
the SOAP HTTP Reference Binding, click the Add Policy
Name. The Policy section has the following fields.
icon. To edit policy details, click Policy
Field
Description
Policy Name
The name of the policy.
Policy Type
The type of policy associated with the binding. The SOAP HTTP Reference
Binding can support the WSS Consumer policy.
Description
A description of the policy.
Operation Configuration
Operation configuration enables you to set configurations at the operation level.
This section has the following fields.
Field
Description
Operation Name
The name of the operation component.
SOAP Action
Specifies the soap action for this operation. By default it is the operation
name
Style
The SOAP binding style. Specify either Default Document or RPC style.
Configurations made at the binding level can be overidden here.
Attachment Style
Select the attachment style for the operations.
The default configurations for each operation can be overridden here.
The following attachment styles are available:
●
Default - The attachment style configured at the binding level.
●
SwA
●
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.
Request Message Configuration
Request Message Configuration can be used to configure request message contents like SOAP
header,SOAP body, and attachments.
Message Part Configuration
You can configure the WSDL Input message parts as body, header (bound) or attachment for a service
request.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
73
The Attachment option, configures a SwA attachment (bound) . This is available only for WSDL
message parts that are of type base64binary.
This section has the following fields:
Field
Description
Part Name
Specifies the part name of the WSDL message as configured in the
WSDL.
Part Type
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header.
●
Body - Configures the WSDL part as SOAP Body.
●
Attachment - Configures the WSDL part as a SwA attachment.
Unbound Header Configuration
You can configure SOAP Headers for service requests in this section . The WSDL message's part, other
than the input WSDL message, can be configured as a SOAP header. The WSDL messages can be in an
external WSDL.
Configurations done here will appear in the Concrete WSDL in the SOAP header element.
Select Unbound Header
Use the Add icon
part.
to select and add this configuration. Select the WSDL, the message and then the
This section has the following fields:
Field
Description
Message
Specifies the WSDL message name as configured in the WSDL.
Part
Specifies the part name of the WSDL message as configured in the
WSDL.
Delete Unbound Header
To delete an unbound header, select the required row and click the
icon.
Undescribed Header Configuration
You can configure SOAP Headers for service requests in this section.The WSDL message's part, other
that the input WSDL message, can be configured as SOAP header here. The WSDL messages can be in
an external WSDL. These headers are undescribed headers and will not appear in the Concrete WSDL.
Add Undescribed Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
74
Field
Description
Header Name
Specifies the WSDL message name as configured in the WSDL.
Header Part
Specifies the part name of the WSDL message as configured in the
WSDL
Cardinality
Configure the cardinality of the configured SOAP header as one of the
following:
●
Optional(?) - The SOAP header is optional.
●
Required - The SOAP Header is required and must be supplied when
the process is called.
●
Repeating (*) - Zero or more SOAP headers must be supplied are
present when the process is called.
Delete Undescribed Header
You can delete an undescribed header. Select the required binding and click the Delete Binding icon
.
Attachment Configuration
If a part is configured as an attachement in the Message Configuration section, then the attachement's
content type is configured here. This section has the following fields:
Field
Description
Part
Specifies the WSDL message name as configured in the WSDL.
This corresponds to the part that is configured as an attachment in the
Message Part Configuration section.
Content Type
Indicates the media type of the attachment received. An example of the
media type is text/html.
Response Message Configuration
Response Message Configuration enables you to configure response message contents like the SOAP
header, SOAP body, and attachments.
Message Part Configuration
This section has the following fields:
Field
Description
Part Name
Specifies the part name of the WSDL message as configured in the
WSDL.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
75
Field
Description
Part Type
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header
●
Body - Configures the WSDL part as SOAP Body
●
Attachment - Configures the WSDL part as a SwA attachment.
Unbound Header Configuration
You can configure SOAP Headers in this section. The WSDL message part, other than the input WSDL
message, can be configured as a header here. The WSDL messages can be in an external WSDL.
Configurations done here will appear in the Concrete WSDL in the SOAP header element.
Add Unbound Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
Field
Description
Message
Specifies the part name of the WSDL message as configured in the
WSDL.
Part
You can configure the WSDL message part as any of the following:
●
Header - Configures the WSDL part as a SOAP Header
●
Body - Configures the WSDL part to SOAP Body
●
Attachment -Configures the WSDL part as a SwA attachment.
Delete Unbound Header
You can delete an unbound header. Select the required header and click the
icon.
Undescribed Header Configuration
You can configure SOAP Headers in this section. WSDL message's part, other that the input wsdl
message, can be configured as soap header here. The WSDL messages can be in an external WSDL.
These headers are undescribed headers and will not appear in the Concrete WSDL.
Add Undescribed Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
76
Field
Description
Header Name
Specifies the message name.
Header Part
Specifies the message part.
Cardinality
Configure the cardinality of the configured SOAP header as one of the
following:
●
Optional(?) - The SOAP header is optional.
●
Required - The Soap Header is required and must be supplied when
the process is called.
●
Repeating (*) - Zero or more SOAP headers must be supplied are
present when tha process is called.
Delete Undescribed Header
You can delete an undescribed header. Select the required header and click the
icon.
Attachment Configuration
This section has the following fields:
Field
Description
Part
Specifies the WSDL message name as configured in the WSDL.
This corresponds to the part that is configured as an attachment in the
Message Part Configuration section.
Content Type
Indicates the media type of the entity body sent to the receiver. An
example of the media type is text/html.
Fault Operation Configuration
Fault Operation Configuration enables you to configure fault messages.
Message Part Configuration
This section has the following fields.
Field
Description
Part Name
Specifies the part name of the WSDL message.
Part Type
The body of the SOAP message.
Undescribed Header Configuration
You can configure SOAP Headers in this section. WSDL message's part, other that the input wsdl
message, can be configured as soap header here. The WSDL messages can be in an external WSDL.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
77
Add Undescribed Header
Use the Add icon
to select and add this configuration. Click the icon and select the WSDL, the
message and then the part.
This section has the following fields:
Field
Description
Header Name
Specifies the message name.
Header Part
Specifies the message part.
Cardinality
Configure the cardinality of the configured SOAP header as one of the
following:
●
Optional(?) - The SOAP header is optional.
●
Required - The Soap Header is required and must be supplied when
the process is called.
●
Repeating (*) - Zero or more SOAP headers must be supplied are
present when tha process is called.
Delete Undescribed Header
You can delete an undescribed header. Select the required header and click the
icon.
Context Mapping
Using Context Mapping you can map data between the context activities used in a process, and the
request response or fault message.
Transport headers are supported when mapping the fault context for a SOAP Service Binding, and
undescribed headers are supported when mapping the fault context for a SOAP Reference Binding.
Reference Binding - Request Context
Using Request Context you can map data from the Request Message to the Get Context Activity used
in the process.
Data Source
Displays the data source schema tree for the input context parameters. All elements in this tree are
available to drag and drop into the XPath Expression field. The following elements are populated from
the request message:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
78
Elements of Request
Message
Transport Properties
Headers
Description
Transport related information for HTTP headers when the
Transport is HTTP, or JMS properties when the Transport is JMS,
are populated from the request message.
●
host:The host machine name or IP address to send the request
to. For example, www.tibco.com.
●
port: Port number on which the request was received.
●
endpointURI: The address portion of the request. This is the
portion before the question mark (?).
Headers from the request message.
●
accept: 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: 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: 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.
●
pragma: 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.
This field takes into account the encoding of the message body.
Dynamic Headers
The dynamic header is an additional header parameter to add
runtime headers to the outgoing HTTP messages. The
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
Headers
The header of the request.
Undescribed Headers
Undescribed headers from the request message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
79
Elements of Request
Message
mimeEnvelopeElement
Description
Information about the attachements that are present in the request
message. Individual attachment information is populated under
one mimepart element.
Note: If the attachment size increases the threshold value
configured at the binding level, the file name of the serialized
attachment is populated.
mimeHeader
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
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 written to the disk.
Reference Binding - Response Context
Response Context enables you to map data from the Set Context Activity to the response message.
Data Source
Displays the data source schema tree for the output context parameters. All elements in this tree are
available to drag and drop into the XPath Expression field.
The following are the response message entities:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
80
Elements of Set Context/
Response Message
Description
Transport Properties
Headers of the response message.
Dynamic Headers
●
allow:This field lists the set of methods supported by the
resource identified by Request URI.
●
content-type: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:This field indicates the size of the entity body
(in decimal number of OCTETs) of the response message.
●
content-encoding: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:The date and time when the response message was sent.
●
pragma: 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: 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.
The dynamic header is an additional header parameter to add
runtime headers to the outgoing HTTP messages. The
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
Headers
The fields of the header specified on the Input Headers tab.
Undescribed Headers
Undescribed headers of the response message.
mimeEnvelopeElement
Information about the attachements that are present in the
response message. Individual attachment information is populated
under one mimepart element. All attachments are configured as
SwA unbound attachments.
Note: If the attachment size increases the threshold value
configured at the binding level, the file name of the serialized
attachment will be populated.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
81
Elements of Set Context/
Response Message
mimeHeader
Description
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
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 written to the disk.
Fault Context (Fault)
Fault Context enables you to configure the SOAP Fault data.
Data Source
Displays the data source schema tree for the SOAP fault message. All elements in this tree are available
to drag and drop into the XPath Expression field. The following elements are the fault message entities:
Elements of Fault Message
Description
HTTPReferenceInputContext/
The reference input context depending on the transport selected.
JMSReferenceInputContext
SOAPFaultContext
The SOAP fault schema describes information about the fault sent
back to the user.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
82
Functions
Displays the available XPath functions. These are categorized into groups and each function can be
dragged from the function list into the XPath Expression field.
When the function is placed into the XPath Expression, placeholders are displayed for the function’s
parameters. You can drag and drop schema elements from the Data Source tab into the function’s
placeholders.
Filter
Use this field for a refined function search in the mapper. Clicking the Functions tab displays the Filter
field. For example, type "time" in the Filter field to obtain consolidated results relating to "time"
function.
Constants
Displays the constants available for use in XPath expressions. These are categorized into groups and
each constant can be dragged from the constants list into the XPath Expression field. Constants are
useful for inserting special characters, such as quotes, symbols, and so on, into XPath formulas.
Constants are also defined for commonly used items, such as date/time formats.
Constants can also be used for inserting TIBCO BW Predefined Module Properties, such as Activity
Name, Application Name, Domain Name, and so on.
XPath Expression
Displays the XPath formula you want to create. You can drag and drop items from the Data Source tab
or the Functions tab to create the formula.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
83
File Palette
The File palette is used to read, write, delete, or create files. You can use the process starter present in
this palette to poll for files and start a process based on the available file.
Copy File
The Copy File is a synchronous activity that you can use to copy files and directories to a new location.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property
Name
None
The name to be displayed as the label of the activity in the
process.
From Filename
Yes
The path and name of the file or directory to copy.
Description
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 c:\myDirectory.
To copy all text files in a directory, specify c:\myDirectory
\*.txt.
To Filename
Yes
The destination for the copy operation. This must be an
absolute path.
Do not use wildcard characters in this element.
Overwrite
Literal Value
Select this check box to overwrite the existing file with the
same name, if it exists.
The activity raises an exception if the specified file or
directory exists and this check box is not selected.
Create NonExisting Directories
Literal Value
When this check box is selected, the activity creates all
directories in the specified path, if they do not already exist.
If this check box is not selected with non-existing one or
more directories in the specified path, it throws an exception.
Include SubDirectories
Literal Value
Includes all sub-directories in the source directory, when the
source to copy is a directory.
Description
Provide a short description for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
84
Input
The following is the input for the activity.
Input Item
Datatype
Description
fromFilename
string
The path and name of the file or directory to copy.
For directories, specify an absolute path. You may use
wildcards when specifying files within a directory. For
example:
toFilename
string
●
To copy a directory, specify c:\myDirectory.
●
To copy all text files in a directory, specify c:
\myDirectory\*.txt.
The destination for the copy operation. This must be an
absolute path and wildcards cannot be used in this
element.
The Input field always takes precedence for all File palette activities with respect to the field equivalent
on the General tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist. The source file or the destination is
not found and the Create Non-Existing Directories check
box is not selected on the General tab.
IllegalCopyException
The destination exists but its type is different than the type
of the specified source.
For example, in the activity input, fromFileName is a
directory and toFileName is a file.
FileAlreadyExistsException
The file already exists at the destination where you are
attempting to copy the file and the Overwrite field is not
selected on the General tab.
FileIOException
There is an input/output error. For example, the file or
directory already exists and it is write-protected.
Remove File
The Remove File activity file is a synchronous activity that removes the specified files from the
directory. If the specified directory is not empty, it throws an exception.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
85
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name of the file to be displayed as the label of the activity in the
process.
fileName
Yes
The path and name of the file to be removed from the directory.
Description
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
fileName
string
The path and name of the file to be removed from the directory.
Output
The following is the output for the activity.
Output Item
Datatype
Description
fileInfo
complex
This element contains the fullName, fileName, location, type,
readProtected, writeProtected, size, and lastModified data.
fullName
string
The name of the file (or empty directory) and the file path
information.
fileName
string
The name of the file (or empty directory) without file path
information.
location
string
The path to the file or the empty directory.
ConfiguredFile
Name
string
An optional element. This element is not populated by this activity.
type
string
The file type.
readProtected
boolean
Signifies whether the file or (or empty directory) is protected from
reading
writeProtected
boolean
Signifies whether the file or (or empty directory) is protected from
writing
size
integer
The size of file in bytes.
lastModified
string
The timestamp indicating when the file was last modified.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
86
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist.
FileIOException
An input/output exception occurs, when trying to
remove the file or empty directory.
Create File
The Create File is a synchronous activity that creates a new file or directory with the specified name.
When creating a file, you can also provide the file contents.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Filename
Yes
The path and name of the file to create.
Description
Select the Is a Directory check box on the General tab to
specify the name of the directory to create.
Overwrite
None
Overwrites the existing file with the same name, if it exists.
The activity throws an exception, if the specified file exists
and this check box is not selected.
Is a Directory
None
When this check box is selected, the activity creates a
directory instead of a file.
Create NonExisting Directories
None
When this check box is selected, the activity creates all
directories in the specified path, if they do not already exist.
If this check box is not selected and one or more directories
in the specified path do not exist, it throws an exception.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
87
Input Item
Datatype
Description
fileName
string
The path and name of the file to create.
Select the Is a Directory field check box on the General tab to specify
the name of the directory to create.
Output
The following is the output for the activity.
Output Item
Datatype
Description
fileInfo
complex
The element containing fullName, fileName, location,
configuredFileName, type, readProtected, writeprotected,
size, and lastModified
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 type of the file
readProtected
boolean
Signifies whether the file or directory is protected from reading
writeProtected
boolean
Signifies whether the file or directory is protected from writing
size
integer
The size of the file (in bytes)
lastModified
string
The time stamp indicating when the file was last modified
Fault
The Fault tab lists the possible exceptions thrown by this activity. See the Error Codes guide for more
information about error codes and the corrective action to take.
Fault
Thrown When..
FileAlreadyExistsException
The file already exists at the destination where you are
attempting to copy the file. The Overwrite check box is
not selected on the General tab.
FileIOException
There is an Input/Output error. For example, the file or
directory already exists and is write-protected.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
88
File Poller
The File Poller activity is a process starter activity that polls for files or directories with the specified
name and starts a process, when a change (creation, modification, or deletion) is detected.
General
The General tab has the following fields.
Field
Literal
Value/
Process
Property/
Module
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
Filename
Yes
The path and name of the file or directory to monitor.
You can also use wildcard characters to monitor a directory for files
that match the provided specification. For example, C:\files
\*.log must match any change to a file in the files directory with
an extension of .log.
Polling
Interval(sec)
Yes
The polling interval (in seconds) to check for the specified file.
Include
Existing Files
None
Check for the specific file among the files that existed before the
process engine starts.
●
When selected - the existing file matching the specification in
the Filename field creates a new process instance, when a
process engine starts.
●
When not selected - any existing file matching the specification
in the Filename field is ignored, unless there is a change in the
file.
Exclude File
Content
None
Specifies not to load the data from the file into this activity’s output.
If selected, the contents of the file are not available to the
subsequent activities in the process.
Content as
Yes
The type of content in the file which can be either Text or Binary.
Encoding
Yes
The character encoding for the file (when Text is specified in the
Content as field).
Description
Provide a short description of the activity.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
89
Field
Description
Sequence 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
instance was created.
Custom Job Id
This field can contain an XPath expression that specifies a custom ID for
the process instance.
Poll for Create Events
Select this check box to start a new process when a file or directory
matching the specification in the Filename field is created.
If not selected, the newly created files or directories are ignored.
Poll for Modify Events
Select this check box to start a new process when a file or directory
matching the specification in the Filename field is modified.
If not selected, the modifications to the files or directories are ignored.
Poll for Delete Events
Select this check box to start a new process when a file or directory
matching the specification in the Filename field is deleted.
If not selected, deletions of files or directories are ignored.
Include SubDirectories
Select this check box to enable monitoring of the events that occur in
subdirectories of the specified directory.
If not selected, only the directory is monitored and subdirectories are
ignored.
Mode
Sort by
Select the type of polling to perform from the following modes in the dropdown list:
●
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 the files should be processed, if more than one
file is detected. You can sort by File Name, Date Modified, or None.
The files are processed as the polling interval occurs. Hence, the Sort By
field applies to all files that have changed since the last polling interval.
The field is useful for processing the files in a specific order when the
process engine starts and the Include Existing Files field is selected (then
all existing files are processed in the specified order).
The File Poller activity starts process instances based on the
specified Sort By order, but the process instances may not
complete in the same order. If you want to guarantee that
processes start and complete in a specified order, specify Max
Jobs = 1, and set the engine persistence mode to group or
datastore.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
90
Field
Description
Sort Order
Specifies whether the order specified in the Sort By field is Ascending or
Descending. This field is only applicable if the Filename or Date Modified
is selected in the Sort By field.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Output
The following is the output for the activity.
Output item
Datatype
Description
action
string
The occurred event to trigger the File Poller activity. The possible
values are: create, remove, or modify.
timeOccured
integer
The time when the File Poller activity detected the change in the file.
The time is defined as the amount of time in milliseconds. For
example, since midnight, January 1, 2013 UTC.
fileInfo
complex
This element contains 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.
configuredFile
Name?
string
The name of the file or directory this activity is configured to operate
on.
type
string
The file type.
readProtected
boolean
Signifies whether the file or directory is protected from reading
writeProtected
boolean
Signifies whether the file or directory is protected from writing
size
integer
The size of the file in bytes.
lastModified
string
The timestamp indicating when the file was last modified.
fileContent
complex
The element containing the textContent and binaryContent data.
textContent
string
The content of the file (text files), if the Exclude File Contents check
box is not selected on the General tab.
binaryContent
binary
The content of the file (binary files), if the Exclude File Contents
check box is not selected on the General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
91
Output item
Datatype
Description
encoding
string
The character encoding for the file.
List Files
The List Files activity is a synchronous activity that returns information about files or directories, or a
listing of all the files in the specified directory.
General
The General tab has the following fields.
Field
Literal
Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Filename
Yes
The path and name of the file or directory to monitor.
Description
You can also use wildcard characters to monitor a directory for
files that match the provided specification. For example, C:\files
\*.log must match any change to a file in the files directory with
an extension of .log.
Mode
None
The type of listing you want to retrieve. You can select from the
following options:
●
Only Files
●
Only Directories
●
Files and Directories
Description
Provide a short description for this activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
92
Input Item
Datatype
Description
fileName
string
The path and name of the directory with files or subdirectories to list.
Providing a file or directory name returns the information about that
file or directory. You can use wildcards to list files or directories that
match the provided specification. For example:
●
C:\files\*.log
extension.
●
lists any file in the files directory that have a .log
C:\files\mylogs\*.*
lists all files in the directory mylogs.
Output
The following is the output of the activity.
Output Item
Datatype
Description
fileInfo
complex
Element containing the fullName, fileName, location,
configuredFileName, type, readProtected, writeProtected,
size, and lastModified data.
This is a repeating element. Each item in the element is a file or
directory included in the specified directory matching the
provided criteria.
fullName
string
The name of the file, including the path information.
fileName
complex
The name of the file without the path information.
location
string
The name of the file or directory this activity is configured to
operate on.
configuredFileName
string
The path to the file.
type
string
The type of the file.
readProtected
boolean
Signifies whether the file or directory is protected from reading
writeProtected
boolean
Signifies whether the file or directory is protected from writing
size
integer
The size of the file in bytes.
lastModified
string
The timestamp indicating when the file was last modified. You
can compare values in this element using the comparedateTime() XPath function.
For example, compare-dateTime($List-Files/
ListFilesActivityOutput/files/
fileInfo[fileName="myFile.txt"]/
lastModified,current-dateTime())
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
93
Fault
Thrown When..
FileNotFoundException
The file does not exist and the specified path is either incorrect
or not found..
Read File
The Read File activity is a synchronous activity that is used to read a file and place its contents into the
output of the activity.
General
The General tab has the following fields.
Field
Literal
Value/
Process
Property/
Module
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
Filename
Yes
The name of the file.
Exclude File
Content
None
Specifies not to load the data from this file into the output of the
activity.
If selected, the contents of this file are not available to the
subsequent activities in the process.
Read as
Literal Value
This field is available only if the Exclude File Content check box is
not selected.
The type of the content in the file. It can be either Text or Binary.
Description
Provide a short description about the activity.
Input
The following is the input of the activity.
Input Item
Datatype
Description
fileName
string
The name and path of the file to read.
encoding
string
The character encoding of the text files.
This element is available only when the Read as field on the General tab
is set to Text.
You can specify the encoding names supported by Java in this element. If
this element is not specified, the default encoding of the Java Virtual
Machine used by the process engine is used.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
94
Output
The following is the output of the activity.
Output Item
Datatype
Description
fileInfo
complex
This element contains fullName, fileName, location, type,
readProtected, writeProtected, size, and lastModified data.
fullName
string
The name of the file with the path information.
fileName
string
The name of the file without the path information.
location
string
The path to the file.
configuredFile
Name
string
An optional element. It is not populated by this activity.
type
string
The file type.
readProtected
boolean
Signifies whether the file or directory is protected from reading
writeProtected
boolean
Signifies whether the file or directory is protected from writing
size
integer
The size of the file in bytes.
lastModified
string
The timestamp indicating when the file was last modified.
fileContent
complex
The element containing the textContent data.
textContent
string
The content of the file (text files), if the Exclude File Content check
box is not selected on the General tab.
binaryContent
binary
The content of the file (binary files), if the Exclude File Content check
box is not selected on the General tab.
encoding
string
The character encoding for the file when the value specified in the
Read as field in the General tab is Text.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist.
UnsupportedEncodingException
The content of the text file is invalid, and the content of the
file is read into the process data.
FileIOException
An input/output exception occurred when trying to read the
file.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
95
Rename File
The Rename File activity is a synchronous activity that is used to rename or move files. This activity
can also rename directories. However, you cannot use this activity to move the directory to a new
location.
General
The General tab consists of the following fields.
Field
Literal
Value/
Process
Property/
Module
Property?
Description
Name
None
The name to be displayed as a label of the activity in the process.
From Filename
Yes
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.
To Filename
Yes
The new name and location of the file or directory. The files can be
moved to a new location, but the directory location remains
unchanged.
The value of this element must be an absolute path.
Overwrite
None
Select this check box to overwrite the existing file with the same
name when renaming or moving.
If not selected, the activity raises an exception, if the specified file
or directory exists.
Create NonExisting
Directories
None
When this check box is selected, the activity creates all directories
in the specified path, if they do not already exist.
If not selected and one or more directories in the specified path do
not exist, it throws an exception.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
96
Input Item
Datatype
Description
toFileName
string
The new name and location of the file or directory. The files can be
moved to a new location, but the directory location remains
unchanged.
The value of this element must be an absolute path.
Output
The following is the output for the activity.
Output Item
Datatype
Description
fileInfo
complex
This element contains the fullName, fileName, location, type,
readProtected, writeProtected, size, and lastModified 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 the directory.
configuredFile
Name
string
An optional element. This element is not populated by this
activity.
type
string
The file type.
readProtected
boolean
Signifies whether the file or directory is protected from reading
writeProtected
boolean
Signifies whether the file or directory is protected from writing
size
integer
The size of file in bytes.
lastModified
string
The timestamp indicating when the file was last modified.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
97
Fault
Thrown When..
FileIOException
An input/output exception occurred when trying to rename
the file or directory.
This exception is also encountered while attempting to move
a directory.
Wait for File Change
The Wait for File Change activity is a signal-in activity that waits for a file creation, modification, or
deletion event to occur during the process execution. When this activity is executed, the process
instance suspends and waits for the specified change to occur before resuming.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Filename
Yes
The name and path of the file to poll for. Use
existing file.
Description
to locate an
You can also use wildcards to monitor a directory for files that
match the applied specification. For example, C:\files\*.log
matches any change to a file in the files directory with an
extension of .log.
Polling
Interval (sec)
Yes
The polling interval (in seconds) to verify the changes in the
specified file.
Include
Existing Files
None
Select this check box so that you can select the file among the files
that existed prior to the starting of process engine.
Exclude File
Content
None
●
When selected: if an existing file matches the specification in
the Filename field on process engine start, the Wait for File
Change activity accepts the file as changed and proceeds to
the next activity.
●
When not selected: any existing file with matching
specification in the Filename field is ignored, until there are
changes in the file.
Specifies not to load the data from the file into the output of the
activity.
If this field is selected, the contents of the file are not available to
the subsequent activities in the process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
98
Field
Literal Value/
Process
Property/
Module
Property?
Description
Content as
Literal Value
The type of the content in the file. It can be either Text or Binary.
Encoding
Yes
The character encoding of the file.
This field is available only when Text is specified in the Content
as field.
Description
Provide a short description for the activity.
Event
The Event tab has the following fields.
Field
Description
Event Timeout (sec)
This field specifies the amount of time in seconds. 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.
Activity 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.
Conversations
You can initiate or join the conversation here. To initiate multiple conversations, click the Add New
Conversation
button.
button. To join multiple conversations, click the Join Existing Conversation
For details about conversations, refer to Application Development guide.
Output
The following is the output for this activity.
Output Item
Datatype
Description
action
string
The occurred event to trigger the File Poller activity. The
possible values are: create, remove, or modify.
timeOccured
integer
The time when the Wait for File Change activity detected
the change in the file.
The time is defined as the amount of time in milliseconds.
For example, since midnight, January 1, 2013 UTC.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
99
Output Item
Datatype
Description
fullName
string
The name of the file, including the path information.
fileName
string
The file name without the path information.
location
string
The path to the file.
configuredFileName
string
An optional element. This element is not populated by this
activity.
type
string
The type of the file.
readProtected
boolean
Specifies whether the file is read-protected.
writeProtected
boolean
Specifies whether the file is write-protected.
size
integer
The size of the file in bytes.
lastModified
string
The timestamp indicating when the file was last modified.
fileContent
complex
The element containing the textContent data.
textContent
string
The content of the file (text files), if the Exclude File
Contents check box is not selected on the General tab.
binaryContent
binary
Contents of the file (binary files), if the Exclude File
Contents check box is not selected on the General tab.
encoding
string
The character encoding for the file.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
ActivityTimedOutException
The timeout is attained.
Write File
The Write File activity is a synchronous activity that writes content to the specified file.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
100
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Filename
Yes
The path and name of the file.
Description
Wildcards are not permitted in this field.
Append
None
Appends the contents to an existing file. Not selecting this check
box overwrites the file.
Write as
Literal Value
Specify whether Text or Binary.
Create NonExisting
Directories
None
When selected, the activity creates all directories in the specified
path, if they do not already exist.
Compress
None
If this check box is not selected with one or more non-existing
directories in the specified path, it throws an exception.
This field 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, rename the file to use
the .gz suffix and use gunzip to decompress the file.
Description
Provide a short description for this activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
fileName
string
The path and name of the file.
Wildcards are not permitted in this field.
textContent
string
The contents of the file (text files).
addLineSeparator
boolean
This specifies whether to add a carriage return after each
input line.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
101
Input Item
Datatype
Description
encoding
string
The character encoding for text files.
This element is available only when Text is specified in the
Write as field on the General tab.
You can specify encoding names supported by Java in this
element. If this element is not specified, the default encoding
of Java Virtual Machine is used.
Output
The following is the output for the activity.
Output Item
Datatype
Description
fileInfo
complex
This element contains 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
An optional element. This element is not populated by this
activity.
type
string
The file type.
readProtected
boolean
Signifies whether the file or directory is protected from
reading
writeProtected
boolean
Signifies whether the file or directory is protected from
writing
size
integer
The size of the file in bytes.
lastModified
string
The timestamp indicating when the file was last modified.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist.
UnsupportedEncodingException
The encoding is not valid.
FileIOException
An input/output exception occurs when trying to write to the
file.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
102
FTL Palette
ActiveMatrix BusinessWorks™ applications can use FTL palette to send and receive messages. TIBCO
FTL transfers messages from publishers to subscribers over transports. TIBCO FTL offers different
types of transports. TIBCO FTL uses the concept of an endpoint to abstract the transports details,
thereby insulating the application program from the complexity of transport details.
You must install TIBCO FTL, if you want to use the FTL palette features. Ensure that FTL_HOME
environment variable is set. Read the TIBCO FTL Concepts manual to understand general FTL concepts.
You must also install FTL client libraries. Refer to "Integrating with TIBCO FTL" in the Installation
guide for additional details.
FTL Publisher
FTL Publisher is a synchronous activity that publishes (sends) a message over a transport that is
abstracted through a TIBCO FTL application endpoint. The transport details are not configured in the
FTL Publisher activity, instead it is configured in TIBCO FTL Realm Server.
Ensure you have installed FTL client libraries. Refer to "Integrating with TIBCO FTL" in the Installation
guide for additional details.
General
The General tab has the following fields.
Field
Literal Value/
Module
Property
Name
No
The name to be displayed as label of the activity in the
application.
FTL Realm Server
Connection
Yes
The shared resource containing information for connecting to
TIBCO FTL Realm Server. See FTL Realm Server Connection
for more details.
Endpoint
Yes
TIBCO FTL application endpoint which is an abstraction for
the underlying transports on which the FTL Publisher
activity sends messages. The endpoint can have more than
one transport.
Description
Click the Browse button to locate the endpoints defined on
the TIBCO FTL Realm Server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
103
Field
Literal Value/
Module
Property
Format
No
Format Name
Description
Defines the set of fields in the message that is sent by the FTL
Publisher activity. The form of each FTL message (its field
names and their value datatypes) is governed by a format.
The supported formats are:
Yes
●
Custom: can be defined by using the Input Editor. The
Input Editor is enabled only for the Custom format
option.
●
Keyed Opaque: is a built-in format that contains a text
key field and a binary (opaque) data field.
●
Opaque: is a built-in format that contains a binary
(opaque) data field.
●
Predefined: is already defined in the TIBCO FTL Realm
Server for the FTL application. The Predefined format
requires a format name and this can be obtained from the
TIBCO FTL Realm Server using the Browse button.
The name of the Predefined or Custom format.
This field is displayed when the Custom or Predefined
format is selected.
In addition, selecting the Predefined format enables the
Browse button. Click the Browse button to obtain the
predefined formats from the TIBCO FTL Realm Server.
Description
Provide a short description of the activity here.
Input Editor
The Input Editor gets enabled only when Custom format is chosen in the General tab. The schema
must match the schema of the input for the activity shown on the Input tab.
Input Item
Datatype
Description
MessageType
complex
The message type used in the application.
From the Schemas folder, drag the Message :
element on to the process editor.
MessageType
Input
The input for the activity depends on the Format you select in the General tab. If you select the Custom
format, the input is a data element defined in the Input Editor tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
104
Fault
Thrown when...
FTLPublisherActivityFault
FTL Publisher fails to publish a message due to a runtime error.
FTLCreateMessageFault
The FTL message could not be created.
FTLSendMessageFault
The FTL message could not be published.
FTL Reply
FTL Reply is a synchronous activity that can send reply to message received through the FTL
Subscriber activity.
Ensure you have installed FTL client libraries. Refer to "Integrating with TIBCO FTL" in the Installation
guide for additional details.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as label of the activity in the application.
Reply For
Specifies the FTL Reply message for FTL Subscriber.
Format
Defines the set of fields in the message that is sent by the FTL Reply
activity. The form of each FTL message (its field names and their value
datatypes) is governed by a format. The supported formats are:
Format Name
●
Custom: can be defined by using the Input Editor. The Input Editor
is enabled only for the Custom format option.
●
Keyed Opaque: a built-in format that contains a text key field and a
binary (opaque) data field.
●
Opaque: a built-in format that contains a binary (opaque) data field.
●
Predefined: is already defined in the TIBCO FTL Realm Server for
the FTL application. The Predefined format requires a format name
and this can be obtained from the TIBCO FTL Realm Server using
the Browse button.
The name of the Predefined or Custom format.
This field is displayed when the Custom or Predefined format is
selected.
In addition, selecting the Predefined format enables the Browse button.
Click the Browse button to obtain the predefined formats from the
TIBCO FTL Realm Server.
Description
Provide a short description of the activity here.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
105
Input Editor
The Input Editor gets enabled only when you select Custom format in the General tab. The schema
must match the schema of the input for the activity shown on the Input tab.
Input Item
Datatype
Description
MessageType
complex
The message type used in the application.
From the Schemas folder, drag the Message :
element on to the process editor.
MessageType
Input
The input for the activity depends on the Format chosen by the user in the General tab. If you select the
Custom format, the input is a data element defined in the Input Editor tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown when...
FTLReplyActivityFault
The FTL Reply activity fails to reply due to a runtime error.
FTLCreateReplyMessageFault
The FTL reply message could not be created.
FTLSendReplyMessageFault
The FTL reply message is not published.
FTL Request Reply
FTL Request Reply is an asynchronous activity that is used to send a request to an FTL application
endpoint and wait for a response.
Ensure you have installed FTL client libraries. Refer to "Integrating with TIBCO FTL" in the Installation
guide for additional details.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property
Name
No
The name to be displayed as label of the activity in the
application.
FTL Realm Server
Connection
Yes
The shared resource containing information for connecting to
TIBCO FTL Realm Server. See FTL Realm Server Connection
for more details.
Description
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
106
Field
Literal
Value/
Module
Property
Endpoint
Yes
Description
TIBCO FTL application endpoint which is an abstraction for
the underlying transports on which the FTL Request Reply
activity sends messages. The endpoint can have more than one
transport.
Click the Browse button to locate the endpoints defined on the
TIBCO FTL Realm Server.
Request Format
No
Defines the set of fields in the message that is sent by the FTL
Request Reply activity. The form of each FTL message (its field
names and their value datatypes) is governed by a format. The
supported formats are:
●
Custom: can be defined by using the Input Editor. The
Input Editor is enabled only for the Custom format option.
●
Predefined: is already defined in the TIBCO FTL Realm
Server for the FTL application. The Predefined format
requires a format name and this can be obtained from the
TIBCO FTL Realm Server using the Browse button.
Selecting the Custom field, enables the Input Editor.
Request Format
Name
Yes
Reply Format
Yes
The name of the Predefined or Custom format.
In addition, selecting the Predefined format enables the
Browse button. Click the Browse button to obtain the
predefined formats from the TIBCO FTL Realm Server.
Defines the set of fields in the message that is sent by the FTL
Request Reply activity. The form of each FTL message (its field
names and their value datatypes) is governed by a format. The
supported formats are:
●
Custom: can be defined by using the Input Editor. The
Input Editor is enabled only for the Custom format option.
●
Keyed Opaque: is a built-in format that contains a text key
field and a binary (opaque) data field.
●
Opaque: is a built-in format that contains a binary (opaque)
data field.
●
Predefined: is already defined in the TIBCO FTL Realm
Server for the FTL application. The Predefined format
requires a format name and this can be obtained from the
TIBCO FTL Realm Server using the Browse button.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
107
Field
Reply Format
Name
Literal
Value/
Module
Property
Description
Yes
The name of the Predefined or Custom format.
This field is displayed when the Custom or Predefined format
is selected.
In addition, selecting the Predefined format enables the
Browse button. Click the Browse button to obtain the
predefined formats from TIBCO FTL Realm Server.
Description
Provide a short description of the activity here.
Advanced
The Advanced tab has the following field.
Field
Activity Timeout
(msec)
Literal Value/
Process
Property/
Module
Property
Yes
Description
It is the amount of time FTL Request Reply activity waits to
get the reply from the FTL Subscriber.
If the FTL Request Reply activity is configured to
be Default Timeout, then the timeout value
equates to "3" minutes by default. However this
default value (3 minutes) can be modified to be a
different value by setting the AppSpace
config.ini property
bw.engine.activity.async.waitTime.
When the FTL Request Reply activity timesout,
the in-line subprocess instance called by the FTL
Request Reply activity can be cancelled before the
subprocess instance completes. Hence, the
business logic in the cancelled process instance
may not be executed to its entirety.
Input Editor
The Input Editor gets enabled only when Custom format is chosen in the General tab. The schema
must match the schema of the input for the activity shown on the Input tab.
Output Editor
The Output Editor tab defines the schema to use for reply messages. This tab gets enabled only when
you select the Custom format.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
108
Input
The input for the activity depends on the Format you select in the General tab. If you select Custom
format, the input is a data element defined in the Input Editor tab.
Output
Shows the output reply message. For example, if you select Predefined as a Reply Format, the output
shows the Predefined message with the message metadata and reply message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When...
FTLRequestReplyActivityFault
The FTL Request Reply activity fails due to a runtime error.
FTLCreateRequestMessageFault
The FTL request message could not be created.
FTLSendRequestMessageFault
The FTL request message could not be published.
FTLProcessReplyMessageFault
The FTL reply message could not be processed.
ActivityTimedOutException
The timeout is reached.
FTL Subscriber
The FTL Subscriber is a process starter activity that starts the process based on the receipt of a message
over a transport that is abstracted through a TIBCO FTL application endpoint. The transport details are
not configured in the FTL Subscriber activity, instead it is configured in TIBCO FTL Realm Server.
Ensure you have installed FTL client libraries. Refer to "Integrating with TIBCO FTL" in the Installation
guide for additional details.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property
Name
No
The name to be displayed as the label of the activity in
the application.
FTL Realm Server
Connection
Yes
The shared resource containing information for
connecting to an FTL Realm Server and creating a
Realm object. See FTL Realm Server Connection for
more details.
Description
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
109
Field
Literal Value/
Process
Property/
Module
Property
Endpoint
Yes
Description
TIBCO FTL application endpoint which is an
abstraction for the underlying transports on which the
FTL Subscriber activity receives messages. The
endpoint can have more than one transport.
Click the Browse button to locate the endpoints defined
on the TIBCO FTL Realm Server.
Content Matcher
Yes
Specifies FTL Subscriber activity's interest in messages
based on their content. The syntax for example is, {"MyLong":123}.
A content matcher selects a subset of messages from a
message stream according to the fields and values in
those messages.
Format
Format Name
No
Defines the set of fields in the message that is sent by
the FTL Publisher activity. The form of each FTL
message (its field names and their value datatypes) is
governed by a format. The supported formats are:
Yes
●
Custom: can be defined by using the Input Editor.
The Input Editor is enabled only for the Custom
format option.
●
Keyed Opaque: is a built-in format that contains a
text key field and a binary (opaque) data field.
●
Opaque: is a built-in format that contains a binary
(opaque) data field.
●
Predefined: is already defined in the TIBCO FTL
Realm Server for the FTL application. The
Predefined format requires a format name and this
can be obtained from the TIBCO FTL Realm Server
using the Browse button.
The name of the format of the FTL Subscriber message.
In addition, selecting the Predefined format enables the
Browse button. Click the Browse button to obtain the
predefined formats from the TIBCO FTL Realm Server.
Description
Provide a short description of the activity here.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
110
Field
Literal Value/
Process
Property/Module
Property
Subscriber Name
Yes
Specify the name of the subscriber on the TIBCO FTL
Realm Server.
Durable Name
Yes
Specify the durable name that will enable the FTL
Subscriber to dynamically create a durable listener.
Acknowledge Mode
Yes
The acknowledge mode for subscriber messages. It can
be one of the following:
Description
●
Auto: When this mode is used, the FTL library
automatically acknowledges the message when the
application callback returns.
●
Explicit: When this mode is used, the user needs to
use a Confirm activity in the ActiveMatrix
BusinessWorks™ process to explicitly acknowledge
the message.
FTL Queue
Dispatcher Threads
Yes
Specifies the number of threads to use for dispatching
events from the FTL event queue.
FTL Queue Size
Yes
Size of FTL event queue.
FTL Queue Overflow
Policy
Yes
This field is enabled when the queue size is greater
than zero. Select any one from the following available
options:
Activity Worker
Threads
Yes
●
Discard None
●
Discard New
●
Discard Old
Must be greater than zero. By default, the equivalent of
half of the ActiveMatrix BusinessWorks™ engine
thread pool is created.
For example, if the ActiveMatrix BusinessWorks™
engine thread pool is set to eight, then the FTL
Subscriber activity creates four threads for processing
the incoming FTL message.
Sequence Key
No
This field can contain an XPath expression that
specifies which processes should run in sequence.
Process instances with sequencing keys that evaluate
to the same value are executed sequentially as the
process instance was created.
Custom Job Id
No
This field can contain an XPath expression that
specifies a custom ID for the process instance.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
111
Output Editor
The Output Editor tab defines the schema to use for incoming messages. This tab gets enabled only
when you select the Custom format.
Conversations
You can initiate the conversation here. Click the Add New Conversation
button to initiate multiple
conversations. Refer to Application Development guide for more information on conversations.
Output
The output for the activity depends on the Format you select in the General tab. If you select the
Custom format, the output is a data element defined in the Output Editor tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
112
FTP Palette
The FTP palette is used to issue FTP commands.
FTP Change Default Directory
FTP Change Default Directory is a synchronous activity that changes the current default directory on
the remote machine to the specified directory path.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, port, username, and password.
Quit (postcommand)
None
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP Connection remains open, if this check box in not
selected. As a result, all the 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.
Description
Provide a short description of the activity.
Input
The Input tab has the following fields.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
The port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
Username
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
113
Input Item
Datatype
Description
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
NewDefaultDir
string
The 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 property.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred while executing the FTP command.
ConnectionErrorException
An error occured while connecting to the FTP server.
FTP Delete File
FTP Delete File is a synchronous activity that issues an FTP delete or mdelete command to delete one
or more files from the remote server.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
Quit (postcommand)
None
Select this check box to specify that the FTP Connection should be
closed after completing this command.
The FTP connection remains open, if this check box in not selected.
As a result all the 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™ Bindings and Palettes Reference
114
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
The port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
RemoteDirectory
string
An optional element. The path to the directory containing the files
to be deleted.
This element is concatenated with the RemoteFileName element to
provide the complete path to the files to be deleted.
RemoteFileName
string
The path and name of the file to delete on the remote server. This
field permits wildcards (? for any one character, * for one or more
characters).
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 in the user’s home directory, if
RemoteDirectory is null.
Timeout
integer
This timeout is used, when the FTP server places the FTP
Connection used by this activity, into a waiting state.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occured when executing the FTP command.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
115
Fault
Thrown When..
ConnectionErrorException
An error occured when connecting to the FTP server.
FTP Dir
FTP Dir is a synchronous activity that provides a sequential list of files in the specified directory of the
FTP server.
General
The Genaral tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
Quit (postcommand)
None
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP connection remains open, if this check box in not selected.
As a result, 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
None
Selecting this check box specifies to use the NLST command instead
of the DIR command.
The DIR command produces verbose output including the file size,
modification time, and permissions.
NLST produces only a list of file names.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
116
Input Item
Datatype
Description
Port
integer
The port number for the incoming FTP requests on the FTP
server.
This overrides the value specified in the FTP Connection
property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
DirParameters
string
The command parameters to pass to the DIR or NLST command.
Directory
string
An optional parameter. The path to the directory in which you
want to list the files.
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
property.
Output
The following is the output of the activity.
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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When...
CommandExecutionException
An error occurred while executing the FTP command.
ConnectionErrorException
An error occured while connecting to the FTP server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
117
FTP Get
FTP Get is a synchronous activity that issues an FTP get or mget command to the specified server. The
content of the remote files can be placed in the output of the activity or written directly to the local
storage. If you select to place the contents of a remote file into the output of the activity, you can only
retrieve one remote file (FTP get command) and the file’s content is stored in memory as part of the
output of the activity. If you write the contents of the retrieved files to the local storage, you can retrieve
one or more files (FTP get or mget commands).
General
The General tab has the following fields.
Field
Literal Value/
Module
Property/
Process
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
FTP Connection
Yes
The path to the shared configuration resource containing the
user information such as host name, username, and
password.
Quit (postcommand)
None
Select this check box to specify that the FTP connection
should be closed after completing this command.
Description
The FTP connection remains open, if this check box in not
selected. All the FTP activities that specify the same FTP
session (that is, the same host, port, username, and
password), can share the FTP session until the connection is
closed.
Use Process Data
None
Specifies to write contents of the file retrieved from the FTP
server to the process data.
The output of the activity includes an element that contains
the remote file’s contents, and the data can be used by
subsequent activities in the process.
Do not use this option if you are retrieving multiple
files. You can only write one files's contents to this
output of the activity. Selecting this check box with
wildcards specified in the RemoteFileName input
element, returns an error.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
118
Field
Literal Value/
Module
Property/
Process
Property?
Binary
None
Description
Specifies whether to retrieve the file content in binary or
ASCII mode (selected signifies binary).
Using ASCII mode automatically handles the differences in
line endings between the FTP server and the machine
executing the FTP command.
The ASCII mode implies text data. This text data can be
encoded in a character encoding other than ASCII (such as
UTF-8 or Latin-1).
Overwrite
Existing File
None
This check box if selected, and the Use Process Data check
box not selected, overwrites any existing local files, if the FTP
command returns the files with same names.
If this check box is not selected, any attempt to write a file to
the disk with the same name as an existing file, results in an
exception.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
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.
Do not specify wildcards for this element, if Use Process
Data check box is selected.
LocalFileName
string
This input item is available only if the Use Process Data check box
on the General tab is not selected and only one remote file is
retrieved.
This input item specifies the name and path of the local file for the
contents of the retrieved file to be written.
If more than one remote file is retrieved, the local files are named
to match the remote file names.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
119
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
The port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
Username
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Encoding
string
When the retrieved file is not binary and the Use Process Data
check box on the General tab is selected, 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.
Output
The following is the output for this activity.
Output Item
Datatype
Description
FileTransferred
complex
When one or more remote files are retrieved and written to the local
storage, this element contains a list of the retrieved remote
filenames. This element contains the following two elements:
●
Name
●
NumOfBytes
If an error occurs while retrieving the files, the activity output is not
available. However, the Fault tab lists the successfully transferred
files and the files that failed to be transferred.
Name
string
The name of the retrieved remote file.
NumOfBytes
integer
The number of bytes comprised in the associated file name.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
120
Fault
The Fault tab lists the following possible exceptions thrown by this activity. See Error Codes for more
information about error codes and the corrective actions to take.
Fault
Thrown When..
GetFilesException
An error occurred during the FTP get 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 is timed out before the
command execution is complete.
FTP Get Default Directory
FTP Get Default Directory is a synchronous activity that 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.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
Quit (postcommand)
None
Select this check box to specify that the FTP Connection should
be closed after completing this command.
Description
The FTP connection remains open if this check box in not selected.
All the FTP activities that specify the same FTP session (that is,
the same host, port, username, and password), can share the FTP
session until the connection is closed.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
121
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
The port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
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 property.
Output
The following is the output for the activity.
Output Item
Datatype
Description
CurrentDirectory
string
The directory currently set on the remote FTP server.
By default, this directory is set by the FTP server. However, you
can use the FTP Quote activity to issue an FTP command to change
to another directory.
Fault
The Fault tab lists the following possible exceptions thrown by this activity. See Error Codes for more
information about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred when executing the FTP command.
ConnectionErrorException
The connection to the FTP server is timed out before the
command execution is complete.
FTP Make Remote Directory
FTP Make Remote Directory is a synchronous activity that creates the specified directory on the
remote server.
General
The General tab consists of the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
122
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
Quit (postcommand)
None
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP connection remains open, if you do not select this check
box. All the FTP activities that specify the same FTP session (that is,
the same host, port, username, and password), can share the FTP
session until the connection is closed.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
The port number for the incoming FTP requests on the FTP
server.
This overrides the value specified in the FTP Connection
property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
RemoteSITECommand
string
An optional element. This is a system-specific command to
execute before creating the directory.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
123
Input Item
Datatype
Description
ParentRemoteDirectory
string
An optional element. The 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.
RemoteDirName
string
The name of the remote directory to create.
You can optionally include the complete path of the
directory to create.
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
property.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred when executing the FTP command.
ConnectionErrorException
An error occurred when connecting to the FTP server.
FTP Put
FTP Put is a synchronous activity that issues an FTP put or mput command to the specified server. You
can use the process data as the file content to send to the remote server or send the files to the local disk
storage. Select Use Process Data to place only one file on the remote server (FTP put command). To use
locally stored files for placing more than one files on the remote server (FTP mput command).
General
The General tab has the following fields.
Field
Literal Value/
Module
Property/
Process
Property?
Name
None
Description
The name to be displayed as the label for the activity in the
process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
124
Field
Literal Value/
Module
Property/
Process
Property?
FTP Connection
Yes
The path to the shared configuration resource containing
the user information such as host name, username, and
password.
Quit (postcommand)
None
Select this check box to specify that the FTP connection
should be closed after completing this command.
Description
The FTP connection remains open, if you do not select this
check box. All the FTP activities that specify the same FTP
session (that is, the same host, port, username, and
password), can share the FTP session until the connection is
closed.
Use Process Data
None
Specifies to use the process data as the file content to place
on the remote server.
Select this check box to place only one file on the remote
server.
Binary
None
Specifies whether to send the file content in binary or ASCII
mode (selected signifies binary).
When ASCII mode is used, the differences in line-endings
between the FTP server and the machine executing the FTP
command are automatically handled. This mode also
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
None
Selecting this check box overwrites any existing files on the
FTP server, if the FTP command sends files with the same
names.
If this check box is not selected, any attempt to send a file to
the remote server with the same name as an existing file,
results in an exception.
Append
None
This element specifies whether to append the data to an
existing file. Select this checkbox to append the data to the
file, if the specified file exists on the FTP server.
If not selected, the file is overwritten if it exists on the FTP
server.
Timeout (msec)
None
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
property.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
125
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
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 element is available only if the Use Process Data field is not
selected.
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
The port number for the incoming FTP requests on the FTP
server.
This overrides the value specified in the FTP Connection
property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
The password for logging into the FTP Server.
This overrides the value specified in the FTP Connection
property.
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
property.
Output
The following is the output for this activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
126
Output Item
Datatype
Description
FileTransferred
string
A repeating string element containing a list of names of files that
were transferred. This element contains the following two elements:
●
Name
●
NumOfBytes
If an error occurs while transferring files, the activity output is not
available. However, the Fault tab lists the successfully transferred
files and the files that failed to be transferred.
Name
string
The name of the retrieved remote file.
NumOfBytes
integer
The number of bytes comprised in the associated file name.
Fault
The Fault tab lists the following possible exceptions thrown by this activity. See Error Codes for more
information about error codes and the corrective actions to take.
Fault
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 is timed out before the
command execution is complete.
FTP Quote
FTP Quote is a synchronous activity that sends an arbitrary command to the FTP server. FTP
commands vary by their operating system, FTP version, and configuration. Before using this activity,
check for the availability of the commands on the remote server.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as label of the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
127
Field
Quit (postcommand)
Literal
Value/
Module
Property/
Process
Property?
Description
None
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP connection remains open, if you do not select this check
box. All the FTP activities that specify the same FTP session (that
is, the same host, port, username, and password), can share the
FTP session until the connection is closed.
Has Socket
Data
None
If selected, the FTP server returns the data as a result of executing
the command.
Description
Provide a short description of this activity.
Input
The following is the input for this activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
The port number for the incoming FTP requests on the FTP
server.
This overrides the value specified in the FTP Connection
property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
RemoteSITECommand
string
Optional. The system-specific command to be executed
before the executing the specified command.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
128
Input Item
Datatype
Description
ValidReturnCodes
string
The optional list of valid return codes to validate 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,
the activity raises an exception.
RemoteCommand
string
The command to be executed on the remote 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
property.
Output
The following is the output for this activity.
Output Item
Datatype
Description
CommandItems
string
Each element in this repeating element is a returned value from
the command executed on the remote server.
Fault
The Fault tab lists the following possible exceptions thrown by this activity. See Error Codes for more
information about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred when executing the FTP command.
ConnectionErrorException
An error occurred when connecting to the FTP server.
FTP Remove Remote Directory
FTP Remove Remote Directory is a synchronous activity that deletes the specified directory from the
remote FTP server.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
129
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as label of the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
Quit (postcommand)
None
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP connection remains open, if you do not select this check
box. All the FTP activities that specify the same FTP session (that
is, the same host, port, username, and password), can share the
FTP session until the connection is closed.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
The port number for the incoming FTP requests on the FTP
server.
This overrides the value specified in the FTP Connection
property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
ParentRemoteDirectory
string
An optional element. The path to the remote directory you
want to remove.
This element is concatenated with the RemoteDirName
element to provide the complete path to the directory to
remove.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
130
Input Item
Datatype
Description
RemoteDirName
string
The name of the remote directory you want 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
property.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred when executing the FTP command.
ConnectionErrorException
An error occurred when connecting to the FTP server.
FTP Rename File
FTP Rename File is a synchronous activity that renames the specified file on the remote FTP server.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as label of the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
131
Field
Quit (postcommand)
Literal
Value/
Module
Property/
Process
Property?
Description
None
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP connection remains open, if you do not select this check
box. All the FTP activities that specify the same FTP session (that
is, the same host, port, username, and password), can share the
FTP session until the connection is closed.
Description
Provide a short description of the activity.
Input
The following is the input for this activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
The port number for the incoming FTP requests on the
FTP server.
This overrides the value specified in the FTP Connection
property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
OldRemoteDirectory
string
An optional element. The path to the remote file you want
to rename.
This element is concatenated with the
OldRemoteFileName element to provide the complete
path to the file to rename.
OldRemoteFileName
string
The name of the remote file you want to rename.
You can optionally include the complete path of the file to
rename.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
132
Input Item
Datatype
Description
NewRemoteDirectory
string
An optional element. The 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.
NewRemoteFileName
string
The new name for the remote file.
You can optionally include the complete path of the file.
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
property.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred when executing the FTP command.
ConnectionErrorException
An error occurred when connecting to the FTP server.
FTP SYS Type
FTP Sys Type is a synchronous activity that retrieves the operating system of the FTP server.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as label of the activity in the process.
FTP
Connection
Yes
The path to the shared configuration resource containing the user
information such as host name, username, and password.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
133
Field
Quit (postcommand)
Literal
Value/
Module
Property/
Process
Property?
None
Description
Select this check box to specify that the FTP connection should be
closed after completing this command.
The FTP connection remains open, if you do not select this check
box. All the FTP activities that specify the same FTP session (that is,
the same host, port, username, and password), can share the FTP
session until the connection is closed.
Description
Provide a short description of the activity.
Input
The following is the input for this activity.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
The port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
The username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
The password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Timeout
string
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 property.
Output
The following is the output for this activity.
Output Item
Datatype
Description
SystemType
string
The FTP server type.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
134
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occurred when executing the FTP command.
ConnectionErrorException
An error occurred when connecting to the FTP server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
135
General Activities
General Activities palette comprises various general purpose activities and process starters. For
example, Timer, a process starter activity, is used to start a process at a specific time.
Assign
Assign is a synchronous activity. You can use this activity to assign a value to a process-defined
variable. The Assign activity is used to assign a value to the process-defined as well as scope-defined
variables. Ensure to set all the essential values when using the Assign activity to set a process variable.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Process Variable to
Set
A drop-down list of the available user-defined process variables for the
process.
Select any user-defined process variable to modify.
Description
Provide a short description of the activity.
Input
Input Item
Description
<schema>
The specified data schema for the user-defined process variable selected on
the General tab.
Output
The schema for the output is determined by the schema specified for the process variable.
Call Process
The Call Process activity calls and executes an existing direct subprocess. Input data specified on the
called subprocess is used by the Call Process activity.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
136
Field
Process Name
Description
The subprocess you want to call. Click the Look Up
icon or the Go To
icon to select a direct subprocess.
An alternative way to call a subprocess contained in the same
project, enter the name of the package and the name of the
subprocess, separated by a period, in this field. In this example,
<PackageA> is the name of the package, and <Process1> is the
name of the subprocess.
<PackageA>.<SubProcess1>
To call a subprocess in a separate project, enter the name of the
project, the name of the package, and the name of the
subprocess, separated by periods, in this field. In this example,
the name of the project is<ProjectB>, the name of the package
is <PackageB>, and the name of the subprocess is
<SubProcess2>.
<ProjectB>.<PackageB>.<SubProcess2>
Process Name
Dynamic override
Configuring this field is optional. Use this field to dynamically determine
the subprocess to call when the process instance is running. Click the Edit
XPath Expression
icon to specify a value for this field in the XPath
Builder wizard. For additional details, refer to Dynamically Determining
the Process to Call.
Spawn
Optional. If you select the Spawn check box, the parent process does not
wait for the called subprocess to complete, the subprocess is executed in a
separate process instance, and the parent process cannot access the output
of the called process.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
input
varies
The input to the called process is defined in the Output
Editor tab of the Start activity of the called process.
Output
The following is the output for the activity.
Output Item
Datatype
Description
output
varies
The output of the called process is defined in the Input
Editor tab of the End activity of the called process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
137
Fault
The Fault tab lists faults that the called subprocess might throw with a Throw activity. To deal with
these faults, add a Catch Specific, or Catch All block to the Call Process activity.
Dynamically Determining the Process to Call
You can use the Process Name Dynamic Override field on the General tab to specify an XPath
expression that determines which direct subprocess to call. This is useful for calling a different direct
subprocess 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 want to call a direct subprocess that includes activities in the
Manual Work palette to obtain the proper approvals. For orders under $10,000, you want to call a direct
subprocess that handles the order automatically. You can create the following expression that resolves
to the proper direct subprocess name for each type of order:
if($IncomingOrer/orderAmount > 10000) then
then 'MyProject.manualApproval' else
'MyProject.processOrder'
Use the full path and name of the direct subprocess file as stored in the project directory.
When you use the Process Name Dynamic Override field, you must also specify a direct subprocess to
call in the Process field. The input, output, and error definitions of the specified direct subprocess must
be the same as any direct subprocess 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 direct subprocess
named orderProcessOrApprove. The only purpose of this direct subprocess is for specifying the input,
output, and error schemas. Place this direct subprocess in the Process Name field of the General tab of
the Call Process activity. Then, create the manualApproval and processOrder process definitions as
copies of the orderProcessOrApprove direct subprocess. The Call Process activity then has the correct
input, output, and error schemas for all direct subprocesses that can be called.
To dynamically call a direct subprocess, that has been created inside of a Shared Module, from an
Application Module, use the following syntax:
'SM_Name/Package_Name.SubProcess_Name
When the Call Process activity is in a local JDBC or JMS transaction, and the Spawn check box is not
selected, the direct sub processes called by the Call Process in the Local Transaction are also a part of
the same local transaction.
Checkpoint
Checkpoint is an asynchronous activity that executes a checkpoint in a running process instance. A
checkpoint saves the current process data that can be recovered, if the event fails. If a process engine
fails, all the process instances can be recovered and resume the execution of their last checkpoint in the
process. Configuring the process engine to checkpoint data for the failed process helps optionally, to
recover the process instance at a later stage. This happens if the process fails due to an exception that
cannot be handled or terminated manually.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
138
Field
Description
Timeout
This field specifies the amount of time (in milliseconds) to wait before and
after the checkpoint. If a process engine fails, all the process instances can
be recovered. These recovered process instances resume the execution of
their last checkpoint in the process.
Duplicate Key
A key value that is used to compare with other process instances to
determine whether another process instance with the same duplicateKey
value already exists.
Description
Provide a short description for the activity.
Checkpoints and Confirm Activity
In the case of confirmable messages (for example, a confirmable TIBCO Rendezvous® is received),
consider the consequences of performing a checkpoint before or after a Confirm activity.
If the checkpoint is taken before the Confirm activity, 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 performs to determine when a checkpoint is
appropriate if your process receives confirmable messages.
Confirm
Confirm is a synchronous activity that confirms any confirmable message received by the process
instance.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
ConfirmEvent
The message you want to confirm.
This is a drop-down list of any process starter or activity awaiting an
incoming event in the current process.
You can confirm messages only from the reliable sources, for example, 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
139
Description
Provide a short description for the activity.
External Command
External Command is a synchronous activity that executes the command on the operating system. This
activity waits for the command to complete before transition to the next activity. Optionally, the
command output and errors can be included in this activity's output schema, written to a file, or both.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as a label for the activity in a
process.
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.
Description
You cannot specify more than one command by piping
output from one command to another (for example, ls
more is not allowed).
Provide
Command
Output
None
|
Selecting this check box specifies that the output sent to the
standard output and standard error by command is
available in the output schema of this activity.
Do not select the check box for the commands
that produce a large amount of output. Instead,
write the output to a file. This saves memory and
youYou can use other activities, such as Read
File and Parse Data, to handle the output file
more efficiently.
Remove
Parameter Quotes
Yes
If this check box is selected, the quotes surrounding the
parameters are removed. The quotes are removed even if
the parameter contains space(s).
By default, this check box is not selected.
Output Filename
Yes
The 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
140
Field
Output Line
Splitting
Literal Value/
Process
Property/
Module
Property?
Description
None
Controls whether the command output and errors are split
into multiple strings.
Select any one from the following available options:
●
None: This activity produces a single string containing
the command’s output or errors. This string includes
line end characters.
●
At Operating System Line End: This 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.
Description
Provide a short description of the activity.
Input
The following is input for this activity.
Input Item
Datatype
Description
command
string
The command to execute, including any input or commandline arguments.
Specifying this input item overrides the command specified
on the General tab.
input
string
An input string to supply to the command’s standard input.
This schema item attains the same result as entering the
command from a command prompt and then typing the input
without specifying a carriage return.
outputFile
string
The file containing the output produced by the command for
sending it to stdout.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
141
Input Item
Datatype
Description
environment
string
The environment variable settings used to run the command.
This element is specified as a comma-separated list of
<name>=<value> pairs where:
●
<name> is the name of the environment variable
●
<value> is the value of the environment variable
If no value is specified for this element, the command is
executed with the environment variable settings specified in
the login scripts, for the user account used to execute the
process engine.
If a value is specified, the value of this element replaces any
environment settings for the user account used to run the
process engine.
That is, the user environment is ignored and this element’s
value is used instead.
workingDirectory
string
The working directory for the command process.
If not specified, the command process inherits its working
directory from the process engine.
Output
The following is the output for the activity.
Output Item
Datatype
Description
returnCode
integer
The numeric return code returned by the command.
Typically, a value of 0 (zero) in this element signifies a successful
command execution.
A non-zero value usually indicates termination of the command
due to an error.
output
string
Any output produced by the command and sent to stdout. This
output item is available only when you select the Provide
Command Output check box on the General tab.
This is a repeating element, 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 you select the Provide Command
Output check box on the General tab.
This is a repeating element, if the line split configuration setting
causes the command’s output to be split into several lines.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
142
Fault
Thrown When..
CommandExecutionError
The command could not be executed.
FileIOError
There was an error when attempting to write the output to a
file.
Ensure that the user running the ActiveMatrix
BusinessWorks™ engine, has the write permission to the
output file.
An error in the activity’s configuration or input mapping
prevents the command from being executed.
InvalidInputException
Get Shared Variable
Get Shared Variable is a synchronous activity that retrieves the current value of a module shared
variable or job shared variable. To use this activity to retrieve the value of a shared variable, use a
Critical Section group to ensure that no other process instances alter the value of the shared variable at
the same time.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Shared Variable Type
Specify the type of shared variable (Module Shared Variable or Job Shared
Variable).
Shared Variable
Name
The module shared variable or job shared variable whose value you want to
retrieve.
Description
Provide a short description here.
Output
The following is the output for the activity.
Output Item
Description
schema
The value of the shared variable specified in the Shared Variable field of
the General 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™ Bindings and Palettes Reference
143
Inspector
Inspector activity is used to write the output of any or all activities and module properties to a file or
stdout. This is particularly useful when debugging processes and you want 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 module properties in the
current process. Activities and module properties 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
want to obtain the output from one or more activities or module properties in a subprocess, place the
Inspector activity in the process of the subprocess.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Inspect
The output of the processes you want. Select any one from available items on
the drop-down list to output.
●
All
●
ModuleProperties
●
_processContext
Only activities that have output and are executed prior to the Inspector
activity are visible in the drop-down list.
Stdout
Specifies whether the output of this activity should be sent to stout (standard
output). Select this check box to send the output to stdout.
If this check box is not selected, the output is not sent to stdout.
Append to File
Select this check box to specify that the output is appended to the file
specified in this activity’s input.
Not selecting this check box overwrites any file that exists with the specified
name.
Suppress Header
Select this check box to suppress the output of header information, such as the
process instance ID and the timestamp.
If this check box is not selected, the header information for the current process
instance is written before the output of the activity or module property.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
144
Input Item
Datatype
Description
fileName
string
The absolute path to the file you want to write. This file
contains the output of the specified activity or module
property.
Output
The following is the output of this activity.
Output Item
Datatype
Description
output
string
The output of the module property or activity specified
on the General tab in string form.
You can 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.
Log
Log is a synchronous activity that writes a message to the log. For each AppNode and application,
there is a log file.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Logger Name
Specifies the name of a message category. The value of the logger-name is
case-sensitive and can be a single name or a hierarchical name.
Log Level
Select one of the following log levels recognized by the process engine.
Suppress Job Info
●
Error: logs error conditions and messages.
●
Warning: is the warning message of an unexpected error in the process.
●
Info: logs informational messages highlighting the application/engine
progress.
●
Debug: can be used for debug-level messages.
If selected, no additional information is added to the log entry.
If not selected, each log message prepends JobId, ProcessInstanceId, Activity
Name, Document Update: December 2014 and Version, Deployment Unit
Name, and Version name to the message text.
Description
Provide a short description of the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
145
Input
The following is the input for the activity.
Input Iten
Datatype
Description
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.
loggerName
string
The name of a message category specified in the Logger Name field
in the General tab.
logLevel
string
The log level specified in the Log Level field in the General tab.
message
string
The message to be displayed in the log.
When the message contains non-ASCII data, the default
encoding of the Java Virtual Machine used by the process
engine is used for text encoding, when writing to the log
file.
Mapper
Mapper is a synchronous activity that adds a new process variable to the process. This variable can be
an inline schema, primitive element, or a complex element. You can map the data values from the
current list of process variables to the elements of the variable with the Mapper activity.
General
Specify the name of the activity here.
Description
A short description of the activity.
Input Editor
The Input Editor tab defines the structure of the process variable to add to the process. You can use a
simple datatype, or you can define a group of data elements on this tab.
You can also reference an XML schema stored in the project. The data specified here becomes the input
and output schema of the Mapper activity. This data is then available to other activities in the process.
Input
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 Output Editor tab.
Notify
The Notify activity allows a process instance to send data to a corresponding process instance
containing a Wait for Notification activity or the Receive Notification process starter. The Notify
Configuration resource and the key specified on the General tab, create the relationship between the
Notify activity and the corresponding Wait for Notification activity or Receive Notification activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
146
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Shared
Configuration
The Shared Configuration resource that defines a data schema for this activity.
Key
The key that coordinates a Notify activity with the corresponding Wait for
Notification or Receive Notification activity.
Notification
Timeout (msec)
The timeout (number of milliseconds) to keep the information for this Notify
activity.
The Shared Configuration resource is required, but the schema can be empty if
you do not want to pass data between processes.
Description
Provide a short description of the activity.
Input
This activity contains an input only if there is a schema defined on the Notify Configuration shared
resource.
Output Item
Datatype
Description
schema
complex
The schema specified by the Notify Configuration shared
resource on the General tab.
This schema is used to pass data from the process instance
containing the Notify activity into the process instance containing
the related Wait for Notification activity or Receive Notification
activity.
Output
This activity produces no output.
Set Shared Variable
Set Shared Variable is a synchronous activity that you can use to change the value of a shared variable.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
147
Field
Description
Shared Variable
Type
Specify the type of the shared variable (Module Shared Variable or Job
Shared Variable).
Shared Variable
Name
The module shared variable or job shared variable whose value you want to
retrieve.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item
Description
schema
The value of the shared variable specified in the Shared Variable field of
the General tab is the input for this activity.
The schema for the input is determined by the schema specified for the
shared variable.
Output
The following is the output for the activity.
Output Item
Description
schema or no output
The value of the shared variable specified in the Shared Variable field of
the General tab is the output for this activity.
The schema for the output is determined by the schema specified for the
shared variable.
Sleep
Sleep is an asynchronous activity that suspends the process on the current transition for the specified
time. For a process with multiple control flows, only the current execution branch of the process is
suspended.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Description
Provide a short description for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
148
Input
The following is the input for the activity.
Input Item
Datatype
Description
IntervalInMillisec
integer
The amount of time interval, in milliseconds, to suspend the
current branch of the process. The default time interval is 3
minutes.
Threading Policy Details
The following are the details about the Sleep activity threading policy.
Activity Type
MultiThreaded?
Default Thread
Count
Thread Count Configuration
Asynchronous
No
1
Not applicable.
The activity does not create simultaneous
process instances due to the single threading
mechanism. You cannot alter the default
thread count for this activity.
Timer
Timer is a process starter activity that starts the process at a specific time. You can also specify the
processes to be started periodically.
General
The General tab has the following fields.
Field
Literal Value/
Module
Property/
Process
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Start Time
Yes
The day and time to start the process. To run the process
periodically, the start time indicates the first time to run the
process.
Description
The local machine’s time zone is used to determine the process
start. If the project is running on machines in different time zones,
the time zone of the machine where the project was saved, is
used. Use a process property in this field to provide start times
relative to the time zone where the project is deployed. If you
provide a process property for this field, the format of the
specified time must be: yyyy MMM dd HH:mm:ss z
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
149
Field
Literal Value/
Module
Property/
Process
Property?
Run Once
None
Description
Indicates this process should be run only once on the day and
time indicated by the Start Time field.
If you do not select this check box, the Time Interval and Interval
Unit fields are displayed that you can use to specify the frequency
of the process.
Time
Interval
Yes
The 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.
Using Literal Value, Module Property, and Process
Property in this field, specifies the time interval in
milliseconds and the Interval Unit field is not
displayed.
Interval Unit
None
The 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, and Year.
End After
None
Specify the number of occurrences or the end time here. Select
from the following available options:
●
Never: Click the Never radio button if you want to
continuously execute the process instance. For example, if the
Time Interval value specified is 5 and the Interval Unit
specified is Second, the process instance executes every 5
seconds.
●
Occurrences: Clicking the Occurrences radio button displays
the Occurrences field. Specify the number of occurrences of
the process instance execution. This field can be configured
with Literal Value, Module Property, and Process Property.
●
End Time: Clicking the End Time radio button displays the
End Time field. Specify the end time and date when you want
the process to end. This field can be configured with Literal
Value, Module Property, and Process Property.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
150
Description
Provide a short description of the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Sequencing Key
This field contains an XPath expression that specifies which processes should
run in sequence. Process instances with sequencing keys evaluating to the same
value, are executed sequentially in the sequence the process instance was
created.
Custom Job Id
This field contains an XPath expression that specifies a custom job ID for every
job in the process instance.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Output
The following is the output of the activity.
Output Item
Description
TimerOutputSchema
The time the process instance started.
The time is represented by several items in the output schema indicating:
●
Now
●
Hour
●
Minute
●
Second
●
Week
●
Month
●
Year
●
Date
●
Time
●
DayOfMonth
Each of these items uses the appropriate datatype.
Threading Policy Details
The following are the details about the Timer activity threading policy.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
151
Activity Type
MultiThreaded?
Default Thread
Count
Thread Count Configuration
ProcessStarter
No
1
Not applicable.
The Timer process starter does not generate
multiple events concurrently. You cannot alter
the default thread count for this activity.
Wait for Notification
The Wait for Notification 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
General tab and the Notify Configuration resource, creates a relationship between the Wait for
Notification activity and the corresponding Notify activity.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as a label for the activity in the process.
Shared
Configuration
The shared configuration resource that defines a data schema for this activity.
Key
The key to coordinate a Wait for Notification activity with the corresponding
Notify activity.
Activity Timeout
(msec)
The timeout (number of milliseconds) for this Wait for Notification activity.
The shared configuration resource is required, but the schema can be empty if
you do not want to pass data between processes.
Description
Provide a short description of the activity.
Input
This activity has no input.
Output
This activity contains an output only if there is a schema defined on the Notify Configuration shared
resource.
The following is the output for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
152
Output Item
Datatype
Description
schema
complex
The schema specified by the Notify Configuration shared
resource on the General tab.
This schema is used to pass data from the process instance
containing the related Notify activity into the process instance
containing the related Wait for Notification activity.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
ActivityTimedOutException
A timeout has been reached.
On Notification Timeout
The On Notification Timeout process starter specifies a process to execute, when a timeout is reached
for storing notification data for a Notify activity.
You can specify an On Notification Timeout process for a specific shared configuration resource. The
process with the On Notification Timeout process starter executes, when a Notify activity with a
matching shared configuration undergoes a timeout.
It is recommended that you do not create more than one process for the same shared configuration
resource. If a Notify activity experiences a timeout of it's stored notification information, that timeout
can only apply to one On Notification Timeout process.
When the notification expires on timeout, the On Notification Timeout process starter is not triggered
immediately. A background thread runs at a regular interval, and checks for expired messages. This
thread runs at the default time interval of 30 minutes. To change this default time interval, which is
specified in minutes, change the value in the optional property
bw.engine.activity.signalin.eventTimeout.purge.interval=30
If the engine is running in memory mode, set the interval time to be between one to five minutes. If the
engine is running in datastore mode, set the interval time to be anywhere from five to thirty minutes.
To change the default value, uncomment the property in the AppSpace config.ini file or pass it as a
VM argument in TIBCO Business Studio.
You can also specify the On Notification Timeout process to apply to any Notify activity experiencing
a timeout. If there is no On Notification Timeout specified for the shared configuration resource of the
Notify activity, the process engine calls the On Notification Timeout process with the Any Notify
Config field selected.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
153
Field
Description
Any Notify Config
Selecting this checkbox disables the Shared Configuration field.
When the check box is selected, notifications from any Notify activity,
associated with any shared configuration trigger the On Notification
Timeout process starter.
When this check box is not selected, notifications from any Notify activity
associated with the same shared configuration as specified on the activity
triggers the On Notification Timeout process starter.
Do not select this check box, if you want to specify a process for a specific
shared configuration resource.
Shared
Configuration
This field is enabled only when the Any Notify Config check box is not
selected.
This field allows you to specify the shared configuration that this process
applies to. Only timeouts for Notify activities with a matching shared
configuration will start a process instance.
Only one On Notification Timeout process can correspond to any shared
configuration. You cannot create multiple processes using the same shared
configuration.
Description
Provide a short description for the activity.
Output
The following is the output for the activity.
Output Item
Datatype
Description
notificationOutput
object
This element contains the schema specified in the shared
configuration of the Notify activity that has timed out.
Receive Notification
This is a process starter activity. The Receive Notification activity starts a process when another process
executes a Notify activity with a matching key and a shared configuration resource.
The key specified in the Key field of the General tab creates a relationship between the Receive
Notification process starter and the corresponding Notify activity. The same shared configuration
(Notify Configuration) resource must be specified by the corresponding Receive Notification and
Notify activities to pass the data from the process containing the Notify activity to the process started
with Receive Notification. The schema in the shared configuration resource however can be empty, if
you do not want to pass data between processes.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
154
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Shared
Configuration
The shared configuration resource that defines a data schema for this activity.
Key
The key that coordinates a Receive Notification process starter with the
corresponding Notify activity.
The shared configuration resource is required, but the schema can be empty if
you do not want to pass data between processes.
The key must be a fixed string.
Description
Provide a short description of the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Sequencing Key
This field contains an XPath expression that specifies which processes should
run in order. Process instances with sequencing keys evaluating to the same
value, are executed sequentially in the order the process instance was created.
Custom Job Id
This field contains an XPath expression that specifies a custom job ID for every
job in the process instance.
Output
The following is the output for the activity.
Output Item
Datatype
Description
schema
complex
The schema specified in the Shared Configuration field on the
General tab.
This schema is used to pass data from the process instance
containing the Notify activity into this process instance.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
155
HTTP Palette
Using the HTTP Palette you can send and receive HTTP requests.
HTTP Receiver
HTTP Receiver is a process starter activity that starts the process based on the receipt of an HTTP
request.
When configuring an HTTP activity, configuring an HTTPConnector Shared Resource as the value for a
module property is not supported. Configure a literal value instead.
General
The General tab has the following fields.
Field
Literal Value/
Module
Property/
Process
property?
Name
None
The name to be displayed as the label for the activity in the
process.
HTTP
Connection
Yes
The HTTP Connector resource describes the characteristics of
the connection used to receive incoming HTTP requests.
Description
See HTTP Connector for more information about specifying
shared resources.
Context Path
Yes
Path Spec
This is the prefix of a URL path that is used to select the
contexts to which an incoming request is passed.
You can either specify both Context Path and Path Spec, any,
or none of these elements. For example, the path displays as
the http://hostname.com/contextPath/pathSpec format.
If the Context Path is not specified, the context path is
referred to as the root context.
Output Style
None
The type of output. It can be either String or Binary.
Parse Post
Method Data
None
Specifies to parse the message body of the HTTP request into
a schema for the output of the activity.
When this check box is selected, the parameters specified in
the Parameters field are used to validate the incoming request
and parse it into the output schema.
For an incoming GET request, there is no message
body, hence this field has no effect on the incoming
GET requests.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
156
Field
Literal Value/
Module
Property/
Process
property?
Description
Parameters
None
The parameters of the incoming HTTP request.
If you specify parameters in this table, the incoming request is
parsed and represented as a schema in this output of the
activity. For each parameter, you must provide a name,
datatype, and whether the field is Optional, Required, or
Repeating.
buttons to the right of the parameter table
Use the
and
to add and remove parameters.
Specifying parameters in this field parses the query
string of the request into the output schema,
regardless of whether the Parse Post Method Data
check box is selected. Selecting the Parse Post
Method Data check box and specifying parameters
here is required to parse the message body along
with the query string of the request.
Expose Security
Context
None
Places the information from the user’s security context (either
authentication or SSL certificate information) into the Context
or SecurityContext output element.
This is a fairly expensive operation and SSL certificates can
consume memory resources. Hence, select this option only if
you require information from the user’s security context for
later use in your process.
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
Connector shared resource, the Default Encoding parameter
specified here applies to the contentType alone and not to the
URIEncoding property.
Imported projects display the HTTP Authentication check box under the General section if the check
box was selected in a previous version TIBCO ActiveMatrix BusinessWorks™ 6.x. Authentication
remains enabled on the HTTP Reciever activity if you do not clear the check box. If you clear the
Authentication check box, a warning message is displayed prompting you to confirm your action. To
remove authentication from the activity, click OK. Once you have removed authentication from the
HTTP Reciever activity, you can reapply it using the Basic Authentication policy.
Description
Provide a short description for the activity in this field.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
157
Field
Process
Property/
Module
Property?
Write to File
None
Description
Select this check box to write incoming requests that exceed
the specified threshold size to a file instead of storing the
request in memory. You can accept large incoming requests
without consuming a great deal of memory. Selecting this
check box displays the Directory, Creating Non-Existing
Directories, and Threshold Data Size(bytes) fields.
This option is not intended to be used with the
Parse Post Method Data option on the General
tab. When you select Write to File, the PostData
output element becomes a choice element
containing either the output FileName or the
PostData. This depends upon whether the data
exceeds the size specified in the Threshold Data
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.
Not selecting this field keeps the incoming requests in
memory.
After writing, the files created 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
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 NonExisting
Directories
None
When this check box is selected, all directories in the path
specified in the Directory field are created, if they do not
already exist.
If this check box is not selected and there are one or more
directories in the specified path in the Directory field that
do not exist, an exception is raised.
Threshold Data
Size(bytes)
Yes
The maximum size (in bytes) of an incoming request that
can be kept in the 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 can access the file and read its contents.
Specify zero (0) in this field for all incoming requests to be
saved to a file.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
158
Field
Process
Property/
Module
Property?
Sequence Key
None
This field can contain an XPath expression that specifies
which processes should run in sequence. Process instances
with sequencing keys that evaluate to the same value are
executed sequentially in the sequence the process instance
was created.
Custom Job Id
None
This field can contain an XPath expression that specifies a
custom ID for the process instance.
Description
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 check box is not selected on the General
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 in the PostData output element, and that
element would display as follows:
name=John Smith&address=500 1/2 Main Street
The sequence of the parameters may not be the same in the PostData output element as the sequence in
the original HTTP request sent by the client when the message body is parsed.
The PostData output element can contain different data and be a different length depending upon
whether the message body is parsed. Hence, ensure that you obtain data from the parameters output
element when the message body is parsed.
Output Editor
The Output Editor 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.
The 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 an HTTP request. You can obtain this
specification at www.w3.org.
Output Header
Element
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, it is assumed that the
client accepts all media types.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
159
Output Header
Element
Datatype
Description
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, it is assumed that the
client accepts any character set.
AcceptEncoding
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. 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 for more
information on when the message body is URL encoded.
Connection
string
Using this field the requestor can specify options required 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.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Output
The following is the output for the activity.
Output Item
Datatype
Description
Method
string
The method specified in the request. For example, GET or
POST.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
160
Output Item
Datatype
Description
RequestURI
string
The address portion of the request. This is the portion
before the question mark (?).
HTTPVersion
string
The 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 General tab.
The content of this element will be PostData if the Output
Style field selected is of type String, and the element will be
BinaryContent if the Output Style field selected is of type
Binary.
See Special Characters in HTTP Requests for more
information.
If the Write to File field is selected on the Advanced tab,
and the incoming message exceeds the specified threshold
size, the PostData field can also contain the file name of the
file containing the message.
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
This can be HTTP or HTTPS depending upon the protocol
used by the request.
Port
string
The port number on which the request was received. This is
the port number configured in the HTTP Connector
resource.
Headers
complex
The fields of the header specified on the Output Editor tab.
See the description of the Output Editor tab for more
information about these items.
Parameters
complex
The parameters for the incoming request. These parameters
are configured in the Parameters field on the General tab.
When the Parse Post Method Data check box on the
General tab is selected, the parameters include the
parameters in the query string and message body of the
incoming HTTP request.
When the Parse Post Method Data check box is not
selected, the parameters include only the query string of the
incoming request.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
161
Output Item
Datatype
Description
DynamicHeaders
complex
The dynamic header is an additional header parameter to
receive header parameters from incoming HTTP requests.
This element is specified in the Output Editor tab. The
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
The following overriding conditions can be considered:
●
Overrides the value of HeaderName with the value
found in DynamicHeaders, if it is a non-repeating
header. If more than one occurrence of this header is
found under DynamicHeaders, it throws the "The
header [ headerName ] is defined as nonRepeating Header in Input Headers. This header
cannot have multiple occurences in
DynamicHeaders."
mimeEnvelopeElement
complex
exception.
●
If it is a repeating element, add the respective name
value pairs under dynamic headers, which is added to
the existing list maintained for this element.
●
For a repeating element, if the new header name is not
found under the "Headers" section declared through
TIBCO Business Studio™, the following is added into
the HTTP Headers.
—
Shows only one value, if found once in
DynamicHeaders.
—
Shows array of values, if found repeating in
DynamicHeaders.
This element contains the message attachments.
This element contains a repeating element named
mimePart that contains each mime attachment.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
162
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.
HTTP servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
●
any element
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
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
Context
choice
This element contains the mime attachment.
The element can be one of the following:
complex
●
binaryContent: content of the attachment 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 written to the
disk.
Contains information about the client’s environment.
This element holds the optional RemoteAddress element.
RemoteAddress
string
The IP address of the client that submitted the HTTP
request.
Threading Policy Details
The following are the details about the HTTP Receiver activity threading policy.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
163
Activity Type
MultiThreaded?
ProcessStarter
Yes
Default Thread Count
●
Minimum QTP
Threads = 10
●
Maximum QTP
Threads = 75
Thread Count Configuration
It can be configured on the HTTP
Connector shared resource using the
following fields:
●
Minimum QTP threads
●
Maximum QTP threads
Policy
Activities that support policies will display the Policy tab. To associate a new or existing policy with the
HTTP Receiver activity, click the Add Policy to Activity
selected Policy
icon. To edit policy details, click Go to
icon. The Policy tab has the following fields.
Field
Description
Name
The name of the policy.
Type
The type of policy associated with the activity. The HTTP Receiver activity
can support the Basic Authentication policy.
Description
A description of the policy.
Send HTTP Request
Send HTTP Request is an asynchronous activity that sends an HTTP request and waits for a response
from the web server. This activity sends a request to a server that is compliant with either the HTTP 1.1
or 1.0 specification. ActiveMatrix BusinessWorks automatically sends the request using the correct
version based on the version supported by the HTTP server. Therefore, do not specify the HTTP version
of the server you are sending the request to.
When configuring an HTTP activity, configuring an HTTPConnector Shared Resource as the value for a
module property is not supported. Configure a literal value instead.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
HTTP Client
Specifies the HTTP Client shared resource. For details, refer to HTTP Client.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
164
Field
Description
Parameters
The parameters of the HTTP request. For each parameter, you must provide:
●
Parameter Name
●
Parameter Type as string
●
Parameter Cardinality as Optional, Required, or Repeating
These parameters are specified in the parameters element on the General tab.
Post Data Type
The body of the HTTP message. You can select either String or Binary format.
Description
Provide a short description of the activity.
Advanced
The Advanced tab has the following fields.
Field
Literal Value/
Module
Property?
Write to File
None
Description
Select this check box to write the incoming requests that
exceed the specified threshold size to a file instead of storing
the request in memory. You can accept large incoming
requests without consuming a great deal of memory.
Selecting this check box displays the Directory and
Threshold Data Size fields.
To keep the incoming requests in memory, do not
select this check box.
The files created using this option after writing are
not deleted automatically. You must manage the
storage used by these files. Delete these files when
they are no longer in use.
Directory
Yes
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.
Creating NonExisting
Directories
No
Selecting this check box creates all directories in the path
specified in the Directory field, if they do not already exist.
Not selecting this check box with one or more non-existing
directories in the specified path in the Directory field, raises
an exception.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
165
Field
Threshold Data
Size(bytes)
Literal Value/
Module
Property?
Yes
Description
The maximum size (in bytes) of an incoming request to be
kept in memory. Requests larger than the specified size are
written to a file in the specified directory. The file’s name is
the output so that subsequent activities in the process can
access the file and read its contents.
Specifying zero (0) in this field causes all incoming requests
to be saved to a file.
Input Editor
Input Editor comprises the data structure of the headers of the HTTP request and HTTP reply message.
You can either use the default structure or modify the structure, if the outgoing request or the reply to
the request has a specific data structure for the header.
Input Header
Datatype
Description
Accept
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, all media types are
acceptable on the server.
Accept-Charset
string
This field specifies the character sets that are acceptable for
response messages for the request. For example,
iso-8859-5, unicode-1-1. The character sets are described
in the HTTP specification.
If no Accept-Charset header is specified, any character set is
acceptable on the server.
Accept-Encoding
string
This field specifies the content-coding values that are
acceptable for response messages. For example, compress
and gzip. See HTTP specification (http://www.w3.org/
Protocols/Specs.html) for more information about this
header field.
Content-Type
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.
Cookie
string
A name and value pair (also known as a cookie) containing
information that the HTTP server may be expecting. You can
set the cardinality for this element to Repeating (*) to specify
more than one cookie. You can also specify multiple name or
value pairs in a single non-repeating element by separating
each pair with a comma (for example, "name1=value1,
name2=value2").
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
166
Input Header
Datatype
Description
Pragma
string
This field is used to include implementation-specific
directives that might apply to the receiver. See the HTTP
specification (http://www.w3.org/Protocols/Specs.html) for
more information about using this field.
Output Editor
Output Editor comprises the data structure of the headers of the HTTP request and HTTP reply
message. You can either use the default structure or modify the structure, if the outgoing request or the
reply to the request has a specific data structure for the header.
The 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 an HTTP request. You can obtain this
specification at http://www.w3.org/.
Output Header
Datatype
Description
Allow
string
This field lists the set of methods supported by the resource
identified by RequestURI.
Content-Type
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
string
This field indicates the size of the entity body (in decimal
number of OCTETs) of the response message.
Content-Encoding
string
This field is used as a modifier to the content-type. When
present, its value indicates what additional content encoding
has been applied to the entity-body. Also, what decoding
mechanisms must be applied 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
string
The date and time when the response message was sent.
Location
string
This field is used to redirect the receiver to a location other
than RequestURI for completion of the request or for
identification of a new resource.
Set-Cookie
string
If you want to receive more than one cookie, set the
cardinality for this field to Repeating (*).
See the HTTP specification for more information about this
field.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
167
Output Header
Datatype
Description
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
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
The HTTP host you want to connect to. Specifying a
value for this input item overrides any value specified on
the General tab.
Port
string
The port number that the HTTP server uses for incoming
requests. Specifying a value for this input item overrides
any value specified on the General 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 ActiveMatrix BusinessWorks
automatically uses the CONNECT method when
connecting through 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.
For details on this input element, refer to Sending Data
in the HTTP Request
QueryString
string
The query string portion of the request. This is the part
after the question mark (?).
For details on this input element, refer to Sending Data
in the HTTP Request
Timeout
integer
The amount of time (in milliseconds) to wait for a
response from the HTTP server.
Headers
complex
The header fields to send for the request. When this
element is specified on the Input Editor tab, you can use
this input item to provide values for the header when
sending the request.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
168
Input Item
Datatype
Description
DynamicHeaders
complex
The dynamic header is an additional header parameter
to add runtime headers to the outgoing HTTP messages.
This element is specified in the Input tab.
You can use only US-ASCII characters in
DynamicHeaders.
The DynamicHeaders consists of the following
information:
●
Name: the name of the header
●
Value: the value of the header
You can consider the following overriding conditions.
●
Overrides the value of HeaderName with the value
found in DynamicHeaders if it is a non-repeating
header. If more than one occurrence of this header is
found under DynamicHeaders, it throws the
following exception.
The header [ headerName ] is defined as nonRepeating Header in Input Headers. This
header cannot have multiple occurences in
DynamicHeaders.
mimeEnvelopeElement
complex
●
If it is a repeating element, add the respective name
value pairs under dynamic headers, which is then
added to the existing list maintained for this element.
●
For a repeating element, if the new header name is
not found under the "Headers" section declared
through TIBCO Business Studio, the following is
added into HTTP Headers.
—
Shows only one value, if found once in
DynamicHeaders.
—
Shows an array of values, if found repeating in
DynamicHeaders.
This element contains the message attachments.
This element contains a repeating element named
mimePart that contains each mime attachment.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
169
Input Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for each
mimePart. mimeHeaders can contain the following
information:
●
content-disposition: To suggest a filename for an
attachment, use "*;filename=<filename>" in this
element.
The HTTP servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is in either the textContent
input element or the file name storing the
attachment is in the fileName input element.
When the content type is anything other than
"text/*", the attachment content is in either
the binaryContent input element or the file
name storing the attachment is in the fileName
input element.
binaryContent |
choice
This element contains the mime attachment.
The element is binaryContent: the content of the
attachment when the attachment is binary data.
Output
The following is the output of the activity.
Input Item
Datatype
Description
Header
complex
The fields of the header specified on the Output Editor
tab. See the description of the Output Editor tab for more
information about these items.
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 the HTTP responses.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
170
Input Item
Datatype
Description
httpVersion
string
The HTTP method to use for the request. All HTTP 1.1
methods are supported, but the connect method is
unnecessary because ActiveMatrix BusinessWorks
automatically uses the CONNECT method when
connecting through a proxy server.
If no method is specified in this element, by default the
GET method is used.
statusCode
string
The address portion of the request. This is the portion of
the URI before the question mark (?).
reasonPhrase
string
The message body of the HTTP request. Do not specify
this element when the method of the request is GET.
For details on this input element, refer to Sending Data
in the HTTP Request
binaryContent
string
The binary content of the response to the request from
the HTTP server.
asciiContent
integer
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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
171
Input Item
Datatype
Description
DynamicHeaders
complex
The dynamic header is an additional header parameter
to add runtime headers to the outgoing HTTP messages.
This element is specified in the Input tab.
You can use only US-ASCII characters in
DynamicHeaders.
The dynamic headers consist of the following
information:
●
Name: the name of the header
●
Value: the value of the header
You can consider the following overriding conditions.
●
Overrides the value of HeaderName with the value
found in DynamicHeaders if it is a non-repeating
header. If more than one occurrence of this header is
found under DynamicHeaders, it throws the
following exception.
The header [ headerName ] is defined as nonRepeating Header in Input Headers. This
header cannot have multiple occurences in
DynamicHeaders.
mimeEnvelopeElement
complex
●
If it is a repeating element, add the respective name
or value pairs under DynamicHeaders, which is
added to the existing list maintained for this element.
●
For a repeating element, if the new header name is
not found under the "Headers" section declared
through TIBCO Business Studio, the following is
added into HTTP Headers.
—
Shows only one value, if found once in
DynamicHeaders.
—
Shows an array of values, if found repeating in
DynamicHeaders.
This element contains the message attachments.
This element contains a repeating element named
mimePart that contains each mime attachment.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
172
Input Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for each
mimePart. mimeHeaders can contain the following
information:
●
content-disposition: to suggest a filename for an
attachment, use "*;filename=<filename>" in this
element.
The HTTP servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
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 in either the
binaryContent input element or the file name
storing the attachment is 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 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 written to
the disk.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective actions to take.
Fault
Thrown When..
ActivityTimedOutException
The timeout for the activity is attained.
HttpClientException
The HTTP server responds with a message containing the 4XX
status code.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
173
Fault
Thrown When..
HttpServerException
The HTTP server responds with a message containing the 5XX
status code.
HttpCommunicationException
An HTTP exception occurred while executing the specified
method, or when trying to read the response.
Threading Policy Details
The following are the details about Send HTTP Request activity threading policy.
Activity Type
MultiThreaded?
Default Thread
Count
Asynchronous
Yes
Dynamic
Thread Count Configuration
You can configure it by using the Thread
Pool shared resource.
Policy
Activities that support policies will display the Policy tab. To associate a new or existing policy with the
Send HTTP Request activity, click the Add Policy to Activity
Go to selected Policy
icon. To edit policy details, click
icon. The Policy tab has the following fields.
Field
Description
Name
The name of the policy.
Type
The type of policy associated with the activity. The Send HTTP Request
activity can support the Basic Credential Mapping policy.
Description
A description of the policy.
Wait for HTTP Request
Wait for HTTP Request is a signal-in activity that waits for an incoming HTTP request in a process.
The process instance suspends until the incoming HTTP request is received.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property
Name
None
Description
The name to be displayed as the label for the activity in the
process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
174
Field
HTTP
Connection
Literal Value/
Process
Property/
Module
Property
Yes
Description
HTTP Connector shared resource that describes the host name
and the port number on which the process waits for the
incoming message.
See HTTP Connector for more information about specifying
shared resources.
Context Path
Yes
Path Spec
This is the prefix of a URL path used to select the contexts to
which an incoming request is passed.
You can either specify both Context Path and Path Spec, any, or
none of these elements. For example, the path displays in
http://hostname.com/contextPath/pathSpec format.
If the Context Path is not specified, the context path is referred
to as the root context.
Output Style
None
The output message format. You can select either Text or
Binary format for the output messages.
Parse Post
Method Data
None
Specifies whether the message body of the HTTP request
should be parsed into a schema for the out of the activity.
When you select this check box, the parameters specified in the
Parameters field are used to validate the incoming request and
parse it into the output schema.
For an incoming GET request, there is no message
body, so this field has no effect on the incoming GET
message body requests.
Parameters
None
The parameters of the incoming HTTP request. You can specify
parameters in this table for the incoming request to be parsed
and represented as a schema in this output of the activity. For
each parameter, you must provide a name, datatype, and
whether the field is Required, Optional, or Repeating.
Use the
button to add parameters and
button to remove
parameters. Use the up and down arrows to move parameters
to new positions in the table.
Specifying parameters in this field parses the query
string of the request into the output schema,
regardless of whether the Parse Post Method Data
check box is selected. Selecting the Parse Post
Method Data check box and specifying the
parameters in this field is required to parse the
message body along with the query string of the
request.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
175
Field
Literal Value/
Process
Property/
Module
Property
Description
Expose
Security
Context
None
Select this check box meant for Security Context Propagation
and Security Context, to make it available as a transport data in
the mapping panel.
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.
Imported projects display the HTTP Authentication check box under the General section if the check
box was selected in a previous version ActiveMatrix BusinessWorks™ 6.x. Authentication remains
enabled on the Wait for HTTP Request activity if you do not clear the check box. If you clear the
Authentication check box, a warning message is displayed prompting you to confirm your action. To
remove authentication from the activity, click OK. Once you have removed authentication from the
Wait for HTTP Request activity, you can reapply it using the Basic Authentication policy. For
additional details, refer to the section "Enforcing Basic Authentication" in the Application Development
guide.
Description
Provide a short description for the activity in this field.
Event
Field
Description
Event Timeout
(seconds)
This field specifies the amount of time (in seconds) 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.
Activity 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.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
176
Field
Process
Property/
Module
Property?
Write to File
None
Description
Select this check box to specify that the incoming messages whose
body and attachments exceed the specified threshold size, should
be written to a file instead of stored in memory. With this you can
accept large incoming messages without consuming a great deal
of memory.
Selecting this check box displays the Directory, Create NonExisting Directories, and Threshold Size fields. Keep this check
box clear if you want to keep the incoming messages in memory.
The files created using this option after they are
written, are not deleted automatically. You must
manage the storage used by these files and delete them
when they are no longer in use.
Directory
Yes
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 NonExisting
Directories
None
When you select this check box is, all directories in the path
specified in the Directory field are created, if they do not already
exist.
If you do not select check box and there are one or more
directories in the specified path in the Directory field that do not
exist, an exception is raised.
Threshold
Data
Size(bytes)
Yes
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 name of the file is
the output so that subsequent activities in the process can access
the file and read its contents.
Specifying zero (0) in this field causes all incoming messages to be
saved to a file.
Output Editor
Output Editor tab describes the data structure for the HTTP request headers. 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.
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. The media types are described in the HTTP specification.
If no Accept header field is present, the client accepts all media
types.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
177
Header
Datatype
Description
Accept-Charset
string
This field specifies the character sets that are acceptable for
response messages for the incoming request. For example,
iso-8859-5, and unicode-1-1. Character sets are described in
the HTTP specification.
If no Accept-Charset header is present, the client accepts any
character set.
AcceptEncoding
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. The 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. It also accounts for
encoding the message body. See Special Characters in HTTP
Requests for more information on when the message body is
URL encoded.
Connection
string
Use this field to specify options required for this connection. For
example, the close option specifies that you want 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.
Conversations
You can join the conversation here. Click the Joining existing conversation
conversations. For details about conversations, refer to Application Development.
button to join multiple
Output
The following is output for the activity.
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 part of the request. This is the part before
the question mark (?).
HTTP-Versions
string
The version field of the HTTP request.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
178
Output Item
Datatype
Description
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. The parsing behavior is controlled by the Parse
Post Method Data field on the General tab.
See Special Characters in HTTP Requests for more
information.
QueryString
string
The query string part of the request. This is the part after
the question mark (?).
Header
string
The header of the HTTP request.
Protocol
string
This can be either HTTP or HTTPS, depending upon the
protocol used by the request.
Port
string
The port number on which the request was received.
This is the port number configured in the HTTP
Connector shared resource.
DynamicHeaders
complex
The dynamic header is an additional header parameter
to add runtime headers to the outgoing HTTP Messages.
This element is specified in the Input tab.
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
You can consider the following overriding conditions:
●
Overrides the value of HeaderName with the value
found in DynamicHeaders if it is a non-repeating
header. If more than one occurrence of this header is
found under DynamicHeaders, it throws the
following exception: "The header [ headerName ]
is defined as non-Repeating Header in Input
Editor. This header cannot have multiple
occurences in DynamicHeaders."
●
If it is a repeating element, add the respective name
value pairs under DynamicHeaders. This is added to
the existing list maintained for this element.
●
For a repeating element, if the new header name is
not found under the "Headers" section declared
through TIBCO Business Studio, the following is
added to the HTTP Headers.
—
Shows only one value, if found once in
DynamicHeaders.
—
Shows array of values, if found repeating in
DynamicHeaders.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
179
Output Item
Datatype
Description
mimeEnvelopeElement
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.
HTTP servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
●
any element
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
When the content type is specified as
"text/*" (for example, "text/xml"), the
attachment content is in either the textContent
input element or the file name storing the
attachment is in the fileName input element.
When the content type is anything other than
"text/*", the attachment content is in either
the binaryContent input element or the file
name storing the attachment is in the fileName
input element.
binaryContent |
textContent | fileName
Context
complex
This element contains the mime attachment.
The element can be one of the following:
complex
●
binaryContent: content of the attachment 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 written to
the disk.
Contains information about the environment of the
client.
This element holds the optional RemoteAddress
element.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
180
Output Item
Datatype
Description
RemoteAddress
string
The IP address of the client that submitted the HTTP
request.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
ActivityTimedOutException
The timeout for the activity is attained.
Threading Policy Details
The following are the details about Wait for HTTP Request activity threading policy.
Activity Type
MultiThreaded?
Signal-in
Yes
Default Thread Count
●
Minimum QTP
Threads = 10
●
Maximum QTP
Threads = 75
Thread Count Configuration
It can be configured on the HTTP
Connector shared resource using the
following fields:
●
Minimum QTP threads
●
Maximum QTP threads
Policy
Activities that support policies will display the Policy tab. To associate a new or existing policy with the
Wait for HTTP Request activity, click the Add Policy to Activity
Go to selected Policy
icon. To edit policy details, click
icon. The Policy tab has the following fields.
Field
Description
Name
The name of the policy.
Type
The type of policy associated with the activity. The Wait for HTTP Request
activity supports the Basic Authentication policy.
Credentials authenticated on this activity are not used for
propagation during credential mapping.
Description
A description of the policy.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
181
Sending Data in the HTTP Request
You can use several HTTP methods 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 RequestURI to pass
parameter and value pairs. Other methods use the HTTP message body to send data in the request.
The Send HTTP Request activity has the following three input elements for sending data in a request:
●
Post Data: corresponds to the body of the HTTP message. All methods except the GET method
accept data in this element.
●
Query String: corresponds to the query string of the RequestURI. 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 the input parameters for the request until the activity executes.
●
Parameters: corresponds to the parameters defined in the Parameters field on the General tab. This
is useful if you have a fixed set of parameters to send with the request. For requests using the GET
method, these parameters are passed as the query string of the RequestURI. For requests using the
POST method, these parameters are usually sent as the body of the HTTP message. They can also be
included in the query string.
These input elements are mutually exclusive for some methods. For example, for POST requests, you
can either specify parameters on the General tab and in the parameters input element or you can
specify a PostData input element. However, do not specify both input elements. In the case of a POST
request, the PostData input element is ignored when you specify parameters on the General tab.
For GET requests, you can either specify the parameters on the General tab and in the parameters input
element or you can specify a QueryString input element. If you know the list of parameters for the
request, configure the parameters on the General tab. If the list of parameters is not known until the
activity executes, use the QueryString element. However, when you specify all parameters on the
General tab as Optional, you can use the QueryString input element instead of the parameters input
element. If any element in the parameters element contains 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 decodes the data. If this is the case and you want 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
General tab, encoding is done automatically.
For example, if you want to specify the following PostData:
name=John Smith&address=500 1/2 Main Street,
the PostData input element should result in the following string:
name=John%20Smith&address=500%201%2F2%20Main%20Street
For more information about the URL specification, see http://www.rfc-editor.org/rfc/rfc1738.txt.
Send HTTP Response
Send HTTP Response is a synchronous activity that sends a response to a previously received HTTP
request. This activity is used in conjunction with the HTTP Receiver process starter activity and the
Wait for HTTP Request activity. The default status line returned by this activity is "200 OK".
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
182
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Reply For
The Wait for HTTP Request activity or HTTP Receiver process starter activity
that received the request. This is a list of available activities that can receive
HTTP requests.
Flush Response
You can specify whether the response is to be flushed after each Send HTTP
Response activity.
By default, this property is not selected. This check box is useful when there are
a large number of Send HTTP Response activities in a job. In such cases, the
Close Connection check box is selected in the last activity to indicate the
response is complete.
However, selecting the Flush Response check box overrides this behavior and
causes the response to be flushed after each Send HTTP Response activity.
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 activities in a process
and each activity sends a part of the response to the client. All Send HTTP
Response activities in a process should have this check box clear, except the last
Send HTTP Response activity. Select this check box for the last Send HTTP
Response activity to indicate the response is complete.
Select this check box, if the entire response is sent by only one Send HTTP
Response activity in the process.
Description
Provide a short description for the activity.
Input Editor
Input Editor 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.
The 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 following are the default header fields.
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™ Bindings and Palettes Reference
183
Header
Datatype
Description
Content-Type
string
This field indicates the media type of the entity body sent to
the receiver. The 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 or html. If you are using
this activity and the Retrieve Resources activity to retrieve a
WSDL file, you should set the type to text or 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 RequestURI for the completion of the request or for
identifying a new resource.
Conversations
You can initiate the conversation here. Click the Add New Conversation
button to initiate multiple
conversations. For details about conversations, refer to Application Development.
Input
The following is the input for the activity.
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.
Headers
complex
The fields of the header specified on the Input Editor tab.
See the description of the Input Editor tab for more
information about these items.
Only the first Send HTTP Response activity in
the process can set the Headers element. If your
process contains multiple Send HTTP
Response activities, the headers are set by the
first activity and this element is ignored for all
subsequent activities.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
184
Input Item
Datatype
Description
DynamicHeaders
complex
The dynamic header is an additional header parameter to
add runtime headers to the outgoing HTTP messages.
This element is specified on the Input tab.
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
You can consider the following overriding conditions:
●
Overrides the value of the HeaderName with the
value found in the DynamicHeaders, if it is a nonrepeating header. If more than one occurrence of this
header is found under DynamicHeaders, it throws the
following exception: The header [ headerName ]
is defined as non-Repeating Header in Input
Editor. This header cannot have multiple
occurences in DynamicHeaders.
mimeEnvelopeElement
complex
●
If it is a repeating element, add the respective name
value pairs under DynamicHeaders. This is added to
the existing list maintained for this element.
●
For a repeating element, if the new header name is not
found under the "Headers" section in TIBCO Business
Studio, the following is added into the HTTP headers.
—
Shows only one value, if found once in the
DynamicHeaders.
—
Shows an array of values, if found repeating in
DynamicHeaders.
This element contains the message attachments.
This element contains a repeating element named
mimePart that contains each mime attachment.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
185
Input Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for each
mimePart. mimeHeaders can contain the following
information:
●
content-disposition: to suggest a filename for an
attachment, use "*;filename=<filename>" in this
element.
The HTTP servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
●
any element
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
When the content type is specified as "text/*"
(for example, "text/xml"), the attachment
content is either the textContent input element
or the file name storing the attachment is in the
fileName input element. When the content type
is anything other than "text/*", the
attachment content is in either the
binaryContent input element or the file name
storing the attachment is in the fileName input
element.
binaryContent
choice
This element is the content of the attachment when the
attachment is binary data.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
HttpCommunicationException
An HTTP exception occurred when sending the response.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
186
JAVA Palette
The Java palette has activities for executing Java code as well as converting between Java objects and
XML documents.
Configuring JAVA in BusinessWorks Application Module
To access JAVA code in TIBCO ActiveMatrix BusinessWorks , you need to configure the TIBCO
ActiveMatrix BusinessWorks application module with JAVA nature.
New Project
To configure a new project with JAVA nature:
Procedure
1. On the menu bar, click
icon.
This opens the New BusinessWorks Application Module wizard.
2. Specify Project name and select the Use Java configuration check box and click Finish.
In Project Explorer you see a JRE System Library <version> folder created in your project.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
187
Existing Project
To configure an existing project with JAVA nature:
1. In Project Explorer, right-click on the project and select Configure > Convert to Java
Project.
2. Import and execute the existing JAVA source (which resides in the JAR file) inside the same
application module.
3. In the TIBCO ActiveMatrix BusinessWorks 6 application module (which has java nature),
select the lib folder.
4. Right-click and select Import > Import > General > File System.
5. Click the Browse button of the From directory field and provide the location of jar file.
6. Now click the Browse button of the Info folder field and select the jar file you want to
import to the lib folder, and click Finish.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
188
This copies and places the jar file in the application module's lib directory and adds it to the
classpath.
Converting JAVA Class to XML Schema
This topic lists the rules that need to be followed when converting Java class to XML schema.
The Java class is converted to an XML schema using the following rules:
●
The Java class public member should not have the public getter and setter methods for it.
●
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.
●
The 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.
●
All Java primitive types are supported. Datatypes that extend java.util.Collections, are also
supported (for example, List, ArrayList, and Vectors). Arrays (for example, int[ ] and string[ ]) are
also supported.
●
Use Java generics and provide the type information while declaring and creating the collection for
example,
Instead of using List list = new ArrayList();
use generics: List<String> list = new ArrayList<String>();
●
The datatype java.util.Map or any types that extend java.util.Map are not supported. For
example, HashMap is not supported.
Creating Custom XPath Functions
This topic provides the detailed procedure of creating a custom XPath function group. You can use the
Custom XPath Function wizard to create your custom XPath function group. It uses the
com.tibco.xml.cxf.customXPathFunction extension.
Procedure
1. Launch TIBCO Business Studio and select File > New > Project.
2. In the New Project window, select Plug-in Project and click Next.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
189
3. Specify a name for the project that reflects the XPath functions, for example,
MyCustomXPathFunctions. Retain all other default selections and click Next.
4. On the Plug-in Content page, locate the Options group and ensure This plug-in will make
contributions to the UI is selected.
5. Accept all of the defaults and click Next.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
190
6. Select Custom XPath Function Wizard on the Templates page, and click Next.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
191
7. In the New Custom XPath Function Group plug-in project window provide values for the following
fields and click Next to continue.
●
Category: The name of the category that includes the custom XPath functions
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
192
●
Prefix: The prefix for the functions
●
Namespace: The namespace for the functions
●
Help Text: The description of the functions
8. Specify the XPath Function and XPath Function Parameters in the XPath Function Group Creation
Section dialog.
9. Click the Add button located on the right side of the XPath Functions table and provide values for:
●
Name: the name of the function
●
Return Type: the return type of the function
●
Description: the description of the function
10. Click the Add button located on the right side of the XPath Function Parameters table. Specify
values for the following parameters and click Finish:
●
Name: the name of the parameter
●
Type: the data type of the parameter
●
Optional: select the check box if the parameter is optional.
11. The Open Associated Perspective dialog displays. Click Yes.
TIBCO Business Studio opens in Plug-in and the Plug-in Development perspective.
12. Open the Java class in the newly created Custom XPath function plug-in and implement the Custom
XPath function.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
193
Now your Custom XPath function is ready for use at design time and run time.
Using Custom XPath Function at Design Time and Run Time
You can use the newly created Custom XPath functions at design time and run time.
Making Your Custom XPath Function Available at Design Time
Procedure
1. Right-click the Custom XPath Function Plug-in project and select Export from the menu. On the
Export window, select Plug-in Development > Deployable plug-ins and fragments and click Next.
2. Select the Install into host Repository radio button on the Deployable plug-ins and fragments
screen and click Finish.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
194
The Custom XPath function plug-in is exported into the TIBCO Business Studio instance to use at
design time.
3. You may be prompted with the following security warning message. Click OK.
4. Click Restart Now when the following window is displayed.
5. In TIBCO Business Studio, the Custom XPath function is available for use in any activity mapper in
a process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
195
Making Custom XPath Function Available at Run Time
●
After using the Custom XPath function in an activity in a process at design time, include the
Custom XPath function plug-in the application project.
●
After including the Custom XPath Function Plug-in in the application project, test it in the
Debugger and then, export it as an EAR, and deploy at run time.
Deleting Custom XPath Functions
This topic lists the steps to uninstall a Custom XPath function so that it is not visible in the mapper.
Procedure
1. On the menu bar, click Help > About TIBCO ActiveMatrix BusinessWorks. On Mac, this is located
under the "BusinessWorks" menu.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
196
2. Click Installation Details.
The following dialog box is displayed.
3. Select the Custom XPath function you want to uninstall, and click the Uninstall button.
4. Restart the workspace.
Java Invoke
Java Invoke is a synchronous activity that can be used to invoke a Java class method. You can construct
an instance of the specified Java class, if you invoke the constructor for the class.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
197
Field
Literal Value/
Module
Property
Name
None
The name to be displayed as the label for the activity in the
process.
Java Global
Instance
None
Specify the resource in this field to execute methods on shared
Java objects created by Java Global Instance resources.
Description
Refer to Java Global Instance for more information about the
shared Java objects created by Java Global Instance resources.
This disables the options on the Advanced tab. In the dropdown list in the Method field, you can select the method to
execute.
If the configuration of the Java Global Instance
resource changes, select and view any Java Invoke
activities in your process that reference the Java
Global Instance to automatically propagate the
changes. An exception is raised if you attempt to test
your process 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.
MultiOutput
None
Select this check box to specify multiple parameters in the Java
invoke method.
Class Name
None
The declared Java class whose method you want to execute.
Use the Browse A Class button to select the class, or use the
Java Global Instance field to specify a shared Java object.
Method
None
The method in the selected Java class you want to execute.
You can use the drop-down list to select a different method in
the selected Java class, if required.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
198
Field
Literal Value/
Module
Property
Parameters
None
Description
The parameters for the Java Invoke activity. This element is
available when the MultiOutput check box is selected.
This element contains a list of input and output parameters that
are required for the Java invoke. This element is not available
when the selected method has no parameters.
Each Input and Output parameter has the following fields.
●
Field Type: It can be either
●
Field Name: The name of the parameter. When creating a
new parameter, provide the name of the parameter. The
setter/getter methods get automatically generated for the
same, or select the options from the drop-down list of the
names of class member variables that have setter/getter
methods.
●
Type: The datatype of the parameter. The default is string.
Specify one of the supplied Java primitive types, or specify
Object Reference when accepting a Java object from another
Java activity as input.
●
Occurrence: Specify whether the parameter is Required,
Optional, or Repeating.
●
Click
to add the input parameter.
●
Click
to add the output parameter.
●
Click
to delete the parameter.
In
or Out.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
199
Field
Instantiate the
referenced class
Literal Value/
Module
Property
Description
None
This field controls one of the following:
●
The referenced class must be constructed when the activity
is executed,
●
An object reference must be supplied in the activity’s input
schema.
Select this check box, if you want to construct the referenced
class using the default constructor when the activity executes.
In this case, the referenced class is not included in the
activity’s input schema.
Do not select this check box, if you want to provide an object
reference for the class name specified on the General tab. The
object must be created and contained in the output schema of
a previously executed activity.
In this case, the referenced class is included in the activity’s
input schema.
This check box is not available when MultiOutput on the
General tab is selected.
Cache the object
None
This option is available only when the Instantiate the
referenced class check box is selected.
Select this check box to specify that all instances of this Java
Invoke activity share the instance of the instantiated
referenced class. A cached referenced object is kept in the
memory until the process engine terminates.
Not selecting this check box leads to each instance of this Java
Invoke activity creating its own copy of the referenced class.
Invoke Cleanup
Method
None
This check box is available only when the Cache the object
check box is selected.
When selected, you can invoke a method on the cached object
before the object is released from memory, when the process
engine terminates. You can perform cleanup activities, such as
closing connections, updating database tables, and so on.
Select this check box to display the Cleanup Method field.
Cleanup Method
None
This field is available only when the Invoke Cleanup Method
check box is selected.
Using this field you can 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
exceptions raised by the selected method are sent to the log.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
200
Input
The following is the input for the activity.
Input Item
Datatype
Description
Parameters
varies
This element contains a list of input parameters that are
required for the Java invoke Method selected on the General
tab.
This element is not available when the selected method has no
parameters.
Output
The following is the output of the activity.
Output Item
Datatype
Description
MethodReturnValue
varies
The Output tab has the return value specified for the Java
invoke Method selected on the General tab.
This element is not available for methods that return void.
Parameters
varies
The Output tab lists all output parameters specified on the
General tab.
Selecting MultiOutput on the General tab makes this output
item available.
Fault
The Fault tab lists the exceptions thrown by this activity. Selecting a method to invoke lists the
exceptions thrown by the method.
In theJava Invoke activity:
●
If MultiOutput is selected, the Fault tab throws the InvocationException exception with error
schema element as msg,msgCode,methodName,exceptionClassName,exceptionMessage.
●
If MultiOutput is not selected, the Fault tab shows the exceptions thrown by the method selected in
it with error schema elements as: 1:Java exception Object 2:exceptionClassName
3:exceptionMessage
●
If MultiOutput is not selected and method does not throw any exception, again the Fault tab shows
InvocationException with error schema element as msg, msgCode, methodName,
exceptionClassName, and exceptionMessage.
Error Schema Element
Datatype
Description
msg
string
The error message. For details, refer to Error Codes.
msgCode
string
The error code. For details, refer to Error Codes.
methodName
string
The name of the Java method that raised the exception.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
201
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
string
The exception message.
The value of this element is obtained by calling the
<exception>.getMessage() method.
Java Process Starter
Java Process Starter is a process starter activity. You can use this activity to create a custom starter
written in Java.
Java Process Starter Abstract Class
The JavaProcessStarter abstract class defines the interface of your Java Process Starter with the
ActiveMatrix BusinessWorks™ application. 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 Java global instance on the Advanced tab that
initializes resource connections. Java global instances are also loaded and initialized during
application 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 application to deactivate the process starter. This method
should deactivate any event notifier or resource observer code.
●
onShutdown(): this method is called by the application when the AppNode 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(): 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 want to place initialization code or
other shared information in a Java global resource instead of in the init() method of this class.
●
onError(): this method throws the exception specified in the input parameter. Use this method to
propagate an error to the ActiveMatrix BusinessWorks™ process instance when a listener or
resource observer fails to generate an event.
Passing Java Objects Between Java Activities
You can create instances of Java objects in Java Invoke activity or by using the Java Invoke or XML To
Java activities. These Java objects can be passed using an output parameter to another activity later in
the process definition. The Java Invoke activity receiving a Java object accepts the object into an input
parameter. Map the output Java object to the input object of the receiving Java Invoke object.
Any Java objects passed by input and output parameters between activities should have the capability
to serialize.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
202
General
The General tab has the following fields.
Field
Process
Property
Name
No
The name to be displayed as the label for the activity in the
process.
Class Name
No
The name of the compiled Java class that is implemented by
extending the JavaProcessStarter abstract class.
Description
Use the Browse a Class
button to select the class from the
specified class library. This shows the classes that extend from
the JavaProcessStarter abstract class.
Initialize with
Parameters
No
Selecting this check box displays the Init Method field and Init
Parameters table.
Init Method
No
Selecting the Initialize with Parameters check box displays this
field.
You can use the drop-down list, if required, to select a different
method in the selected Java class.
Init Parameters
No
Specify default values in this table for the input parameters of
the init() method. Each input parameter has three fields:
●
Parameter Name: the name of the parameter.
●
Parameter Type: the datatype of the parameter.
●
Parameter Value: specify a default value for the parameter. It
can be a string or a module property.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Sequence key
This field can contain an XPath expression that specifies which processes
should run in sequence. Process instances with sequencing keys that
evaluate to the same value are executed in the sequence the process
instance was created.
Custom Job Id
This field can contain an XPath expression that specifies a custom job ID for
the process instance.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
203
Field
Description
Java Global Instance
A Java global instance resource. Specify a value in this field to reference a
Java global instance resource in your JavaProcessStarter implementation
class. Refer to Java Global Instance for details.
You can use the getGlobalInstance() method to obtain a reference to the
Java global instance resource.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
For more information about conversations, refer to Application Development guide.
Output
The following is the output of the activity.
Output Item
Datatype
Description
javaObject
varies
The Java object that was passed to the onEvent() method.
By default, this element is a Java object reference.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Error Schema
Element
Datatype
Description
msg
string
The ActiveMatrix BusinessWorks™ error message. For details,
refer to Error Codes guide.
msgCode
string
The ActiveMatrix BusinessWorks™ error code. For details, refer
to Error Codes guide.
Java To XML
Java To XML is a synchronous activity. You can use this activity to convert Java object's data members
into an XML document.
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, an element
named ID in this activity’s output schema exists, but that element has no value because there is no
public mechanism for getting the data.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
204
Field
Module
Property?
Description
Name
No
The name to be displayed as the label for the resource.
Class Name
No
The class name in the Java schema to use.
Use the Browse button to bring up the dialog to select the Java
class.
Click the Reload button to regenerate the schema.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Instantiate the
referenced class
This field controls one of the following:
●
The referenced class must be constructed when the activity is
executed.
●
An object reference must be supplied in the activity’s input schema.
Select this check box to construct the referenced class using the default
constructor when the activity executes. In this case, the referenced class
is not included in the activity’s input schema.
Do not select this check box if you want to provide an object reference
for the class name specified on the General tab. The object must be
created and contained in the output schema of a previously executed
activity.
In this case, the referenced class is included in the activity’s input
schema.
Cache the object
This option is available only when you select the Instantiate the
referenced class check box.
Select this check box to specify that all instances of this Java Invoke
activity share the instance of the instantiated referenced class. A cached
referenced object is kept in the memory until the process engine
terminates.
Not selecting this check box leads to each instance of this Java To XML
activity creating its own copy of the referenced class.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
205
Input item
Datatype
Description
referenced class
Java Object
An object reference to the Class Name specified on the
General tab. This element is only available when you do not
select the Instantiate the referenced class check box on the
Advanced tab.
Output
The following is the output of the activity.
Output Item
Datatype
Description
XML Schema
varies
The output is the XML schema from the converted Java object.
The elements in the schema display in alphabetical order.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and possible the corrective actions to take.
Fault
Thrown When...
JavaToXMLConversionException
An error occurred when converting the Java object to XML.
XML To Java
XML to Java is a synchronous activity. You can use this activity to create an instance of a Java object
based on data from an XML document. The XML schema for providing the input to the Java object or
Java schema specified on the General 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 eligible to be serialized (that is, the class must implement or be a subclass of a
class that implements java.io.Serializable).
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. However, 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, 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. This is because there is no public mechanism for setting the data.
General
The General tab has the following fields.
Field
Module
Property?
Description
Name
No
The name to be displayed as the label for the resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
206
Field
Module
Property?
Description
Class Name
No
The class name in the Java schema to use.
Use the Browse button to bring up the dialog to select the Java
class.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
XML Schema
varies
The XML schema you want to convert to a Java object. The
content of this schema depends upon the Java class or Java
schema defined in the Class Name field on the General tab.
The elements in the schema display in an alphabetical order.
Output
The following is the output of the activity.
Output Item
Datatype
Description
referenced
class
Java Object
A Java object that is created out of the XML schema.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the possible corrective actions.
Fault
Thrown When..
XMLToJavaConversionException
An error occurred when converting the XML schema to a
Java object.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
207
JDBC Palette
The JDBC palette contains activities for querying, updating, or calling stored procedures in the
database.
JDBC Call Procedure
JDBC Call Procedure is an asynchronous activity that calls a database procedure or function 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.
To override the default behavior of transaction groups for certain JDBC activities in a transaction group,
select the Override Transaction Behavior check box 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.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
JDBC Shared
Resource
Yes
The path to the shared resource containing the JDBC
connection information.
Description
See JDBC Connection for more information about JDBC
resources.
Timeout
Yes
The time (in seconds) to wait for the procedure call to
complete. If the call does not complete in the specified time
limit, it returns an error.
Maximum Rows
Yes
The maximum number of rows to retrieve. To retrieve all
rows, specify 0.
Description
Provide a short description for the activity in this field.
Procedure
The Procedure tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
208
Field
Literal Value/
Process
Property/
Module
Property?
Schema
Yes
Description
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.
Configure the Schema field to use a Process Property or a Module
Property if a schema has been defined for the project, and you know
the schema name. To search for a schema, configure the field to use a
Literal Value , and click the Browse button to select a schema from
the database that is using the specified JDBC Connection.
Catalog or
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 selected procedures with the same name.
Configure the Catalog or Package field to use a Process Property or
a Module Property if a catalog or package has been defined for the
project, and you know their names. To search for a catalog or
package, configure the field to use a Literal Value , click the Browse
button, and select 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.
This field is only applicable to databases with more than one catalog
and package. See your database documentation for more
information about catalogs and packages.
Procedure /
Function
No
The name of the database procedure or user-defined function to call.
Click the Browse button to select the database for available
procedures or functions after specifying the JDBC Connection field.
Click the Refresh button to retrieve the changes from the database, if
you change the parameters or signatures while editing your project.
The list of available procedures and functions is limited by the
values supplied in the Schema and Catalog or Package fields.
Parameters
No
This field displays the parameters for the procedure and you can
override the data type (IN, OUT, IN/OUT) for each parameter in the
Direction column.
The parameters listed in the table show the Parameter Name, Data
Type, and the Direction (IN, OUT, IN/OUT) of the each parameter.
All IN and IN/OUT parameters listed in the Parameters table are
shown in the Input tab of the activity for the user to provide values.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
209
Field
Description
ThreadPool
SharedResource
Specifies a queue of threads available to run a queue of tasks. Thread pools
are used to improve performance when executing large numbers of
asynchronous tasks by reducing per task invocation overhead, provide a
means of bounding, and managing the resources consumed when executing
a collection of tasks.
Override Transaction
Behavior
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.
Select this check box to specify that this activity is not part of the transaction
group and is committed when it completes. Also, select this check box to use
a separate database connection to perform the activity and commit the SQL
statement.
Override JDBC
Connection
Selecting this option overrides the default datasource connection, and allows
for SQL queries to be executed against the optional datasource.
After selecting this option, the sharedResourceName field is enabled under
the Input > Data Source tab. From the sharedResourceName field, type the
complete path with the name of the optional datasource, which can be found
under the Resources folder. For example, if a JDBC shared resource is
located at Resources > Package_Name > JDBC_SR_Name, then the value
you enter should be Package_Name.JDBC_SR_Name. The value you enter
in the XPath Expression field is case sensitive and must be a string.
To avoid mapping issues, ensure the optional datasource maintains a
structure that is identical to the default database, and that both datasources
are using the same datatypes.
Transactions between multiple datasources is not supported.
Interpret Empty
String as Null
Specifies how empty strings in the activity’s input elements should be
handled. Selecting this check box sends the nulls to the database where
empty strings are supplied.
Empty strings are treated as zero-length strings, if this check box is not
selected. Whether you use this option or not, you can still use XPath to set
input elements explicitly to null.
ResultSets Use
Schema
Specifies that the design-time must try to fetch the schema when a resultset
is expected from a stored procedure call.
When selected, TIBCO Business Studio tries to invoke the stored procedure
with default values and get the metadata for the resultset.
If the check box is not selected, or if TIBCO Business Studio does not get any
metadata, the results are displayed as ’unknown resultsets’.
Interpret Invalid
XML Chars
Specifies how invalid characters should be handled. If the check box is not
selected and invalid characters are sent from the database to ActiveMatrix
BusinessWorks, the call procedure execution will fail.
On the other hand if invalid characters are sent, and the check box is
selected, ActiveMatrix BusinessWorks will execute it successfully.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
210
Input
The input for this activity is dependent upon the input parameters of the database procedure.
Input Item
Datatype
Description
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.
The IN and IN/OUT parameters displayed in the Parameters
table on the Procedure tab are displayed here for the user to
set values.
ServerTimeZone
string
Specifies the time zone for the database server.
timeout
number
The time (in seconds) to wait for the procedure call to
complete. The call if not completed in the specified time limit,
returns an error.
maxRows
number
The maximum number of rows to retrieve. To retrieve all
rows, specify 0.
Output
The output of the activity is depends 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.
UnresolvedResult
Sets
string
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, and then use the Parse XML activity to parse the XML
based on the schema. You can then use the parsed output in
subsequent activities.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the possible corrective action to take.
Fault
Thrown When..
JDBCConnectionNotFoundException
An error occurred when attempting to connect
to the specified database.
InvalidTimeZoneException
An invalid time zone was specified.
JDBCSQLException
An SQL error occurred.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
211
Fault
Thrown When..
LoginTimedOutException
A timeout occurred while attempting to
connect to the database.
ActivityTimedOutException
The operation times out.
JDBC Query
JDBC Query is an asynchronous activity that 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.
If you want to override the default behavior of transaction groups for certain JDBC activities in a
transaction group, you can select the Override Transaction Behavior check box 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.
General
The General tab has the following fields.
Field
Literal Value/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
JDBC Shared
Resource
Yes
The path to the shared configuration resource containing the
JDBC connection information. For details, refer to JDBC
Connection
Timeout(sec)
Yes
The 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.
Maximum rows
Yes
The maximum number of rows to retrieve. To retrieve all
rows, specify 0.
Description
Description
Provide a short description for the activity.
Statement
The Statement tab has the following fields.
Field
Description
Statement
This is the SQL SELECT statement to perform in the database. You can use a
SQL Builder wizard to build the query for the desired database.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
212
Field
Description
Prepared Statement
The Prepared Statement contains the Parameter Name and Data Type fields.
All the parameters defined in the Prepared Statement table are shown in the
Input tab of the activity for the user to provide values.
Each prepared statement corresponds to the question mark in the same
position in the SQL statement. That is, the first prepared statement in the list
corresponds to the first question mark, the second prepared statement in the
list corresponds to the second question mark, and so on. The warning is for
the purpose of information only. Ensure that the parameters in this field
correctly correspond to the statement.
You can optionally specify names for each prepared parameter. By default, the prepared statements are
named Parameter1, Parameter2, and so on. You must supply the datatype of each parameter to the SQL
statement, and this data type is used in the input schema for the statement.
Execute the Query Button
Runs the JDBC Select statement entered in the Statement field and shows the results in the Results
View. These results are persisted in the workspace.
SQL Button
Launch Eclipse SQL Builder. For more information on using the SQL Builder to visually build queries,
go to: http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.datatools.sqltools.doc.user%2Fdoc
%2Fhtml%2Fasc1229700427574.html
Fetch Button
Using the Fetch button on this activity, you can synchronize the activity with the contents of the
database. When you first configure a JDBC activity, click the Fetch button to retrieve the schema for the
output result set before applying your changes by saving your project.
After you have configured your activity, the Fetch button is useful when you make a change to the
database while editing a process containing this activityActiveMatrix BusinessWorks . The Fetch button
synchronizes with the database and changes the output schema, if necessary.
Advanced
The Advanced tab has the following fields.
Field
Description
ThreadPool
SharedResource
Specifies a queue of threads available to run a queue of tasks. Thread pools
are used to improve performance when executing large numbers of
asynchronous tasks by reducing per task invocation overhead, provide a
means of bounding, and managing the resources consumed when executing a
collection of tasks.
Override
Transaction
Behavior
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.
This activity is not part of the transaction group and is committed when it
completes, when this check box is selected. Selecting this option uses a
separate database connection to perform the activity and commit the SQL
statement.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
213
Field
Description
Override JDBC
Connection
Selecting this option overrides the default datasource connection, and allows
for SQL queries to be executed against the optional datasource.
After selecting this option, the sharedResourceName field is enabled under
the Input > Data Source tab. From the sharedResourceName field, type the
complete path with the name of the optional datasource, which can be found
under the Resources folder. For example, if a JDBC shared resource is located
at Resources > Package_Name > JDBC_SR_Name, then the value you enter
should be Package_Name.JDBC_SR_Name. The value you enter in the
XPath Expression field is case sensitive and must be a string.
To avoid mapping issues, ensure the optional datasource maintains a
structure that is identical to the default database, and that both datasources
are using the same datatypes.
Transactions between multiple datasources is not supported.
Use Nil
Specifies whether NULLs are represented as optional schema elements or
whether each item that can contain a NULL has subitems.
Interpret Empty
String as Null
Specifies how empty strings in the activity’s input elements should be
handled. Selecting this check box sends the nulls to the database where
empty strings are supplied. Empty strings are treated as zero-length strings,
when this check box is not selected. Whether you use this field or not, you
can still use XPath to set input elements explicitly to null.
Many databases treat empty strings and nulls as the same, so this
field does not affect how the database interprets empty strings.
Process In Subsets
Selecting this check box specifies that you want to process the result set in
smaller batches rather than processing the entire result set at once. When this
check box is selected, the subsetSize input element is displayed for you to
specify the size of each batch of records you want to process. Also, the
lastSubset output element is displayed and is set to true when the last batch
of records is being processed.
Not selecting this check box returns the whole result set.
Override SQL
Statements
Selecting this check box overrides the SQL SELECT statement specified on
the Statement tab, and enables you to add a new SQL statement on the Input
tab.
To connect to another database that has a schema with the same
table structure, select the Override JDBC Connection check box.
After doing this, go to the Input tab, and specify a Shared Resource
at sharedResourceName.
Input
The following is the input for the activity.
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
214
Input Item
Datatype
Description
timeout
number
The 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.
SqlStatement
string
Displays after the Override SQL Statement check box on the
Advanced tab has been selected. This is the SQL SELECT
statement to perform in the database. You can use a SQL
Builder wizard to build the query for the desired database. You
can also use a module property here.
If you create a new SQL statement, ensure the new
statement does not differ from the output schema
specified on the Output tab. If the new SQL
statement does not match the output schema, an error
is thrown at run time. The output schema is
determined from the original SQL statement on the
Statement tab.
Output
The following is the output of the activity.
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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. Refer to the Error Codes guide for
more information about error codes and the corrective action to take.
Fault
Thrown When..
JDBCConnectionNotFoundException
An error occurred when attempting to connect to the
specified database.
InvalidTimeZoneException
An invalid time zone was specified.
JDBCSQLException
An SQL error occurred.
LoginTimedOutException
A timeout has occurred while attempting to connect to
the database.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
215
Fault
Thrown When..
InvalidSQLTypeException
A parameter’s datatype does not match the datatype of
the table column.
DuplicatedFieldNameException
A duplicate field name was specified.
ActivityTimedOutException
The operation has timed out.
JDBC Update
JDBC Update is an asynchronous activity that 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.
If you want to override the default behavior of transaction groups for certain JDBC activities in a
transaction group, you can select the Override Transaction Behavior check box 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 SQL statement is committed after the activity completes.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
JDBC Shared
Resource
Yes
The path to the shared resource containing the JDBC connection
information.
Description
For details, refer to JDBC Connection.
Timeout
Yes
The 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
Provide a short description for the activity.
Statement
The Statement tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
216
Field
Description
Statement
This is an SQL INSERT UPDATE OR DELETE statement to perform in the
database. You can use the SQL Builder wizard to build the query for the
desired database.
Prepared Statement
The Prepared Statement contains the Parameter Name and Datatype fields.
All the parameters defined in the Prepared Statement table are shown in the
Input tab of the activity for the user to provide values.
Each prepared statement corresponds to the question mark in the same
position in the SQL statement. That is, the first prepared statement in the list
corresponds to the first question mark, the second prepared statement 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 statement.
Advanced
The Advanced tab has the following fields.
Field
Description
ThreadPool
SharedResource
Specifies a queue of threads available to run a queue of tasks. Thread pools
are used to improve performance when executing large numbers of
asynchronous tasks by reducing per task invocation overhead, provide a
means of bounding, and managing the resources consumed when executing a
collection of tasks.
Insert if record
doesn't exist
Select this check box to insert the record if it does not exist in the database.
Override
Transaction
Behavior
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 you select this check box, this activity is not part of the transaction group
and is committed when it completes. Selecting this option uses a separate
database connection to perform the activity and commit the SQL statement.
Override JDBC
Connection
Selecting this option overrides the default datasource connection, and allows
for SQL queries to be executed against the optional datasource.
After selecting this option, the sharedResourceName field is enabled under
the Input > Data Source tab. From the sharedResourceName field, type the
complete path with the name of the optional datasource, which can be found
under the Resources folder. For example, if a JDBC shared resource is located
at Resources > Package_Name > JDBC_SR_Name, then the value you enter
should be Package_Name.JDBC_SR_Name. The value you enter in the
XPath Expression field is case sensitive and must be a string.
To avoid mapping issues, ensure the optional datasource maintains a
structure that is identical to the default database, and that both datasources
are using the same datatypes.
Transactions between multiple datasources is not supported.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
217
Field
Description
Interpret Empty
String as Null
Specifies how empty strings in the activity’s input elements should be
handled.
Selecting this check box sends the nulls to the database where empty strings
are supplied.
When the check box is not selected, empty strings are treated as zero-length
strings. Whether you use this check box option or not, you can still use XPath
to set input elements explicitly to null.
Many databases treat empty strings and nulls as the same, so this
check box does not affect how the database interprets empty
strings.
Batch Update
Selecting this check box signifies that you want 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.
If you do not select this check box, 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 following is the input for the activity.
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database server.
timeout
number
The 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.
Output
The following is the output for the activity.
Output Item
Datatype
Description
noOfUpdates
integer
The number of updates performed by the statement specified
on the General 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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
218
Fault
Thrown When..
JDBCConnectionNotFoundException
An error occurred when attempting to connect to the
specified database.
InvalidTimeZoneException
An invalid time zone was specified.
JDBCSQLException
An SQL error occurred.
LoginTimedOutException
A timeout has occurred while attempting to connect to the
database.
InvalidSQLTypeException
A parameter’s datatype does not match the datatype of the
table column.
ActivityTimedOutException
The operation has timed out.
SQL Direct
SQL Direct is an asynchronous activity that executes an SQL statement that you supply. With this
activity you can build an SQL statement dynamically using other activities, then pass the SQL
statement into this activity's input. You can use this activity to execute DDL SQL statements like
CREATE and DROP. You can also execute SQL statements that are not supported by other activities in
the JDBC palette.
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.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
JDBC Shared
Resource
Yes
The path to the shared resource containing the JDBC connection
information.
Description
For details, refer to JDBC Connection.
Timeout
Yes
The 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.
Maximum Rows
Yes
The maximum number of rows to retrieve. To retrieve all rows,
specify 0.
Description
Provide a short description for the activity in this field.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
219
Advanced
The Advanced tab has the following field.
Field
Description
ThreadPool
Sharedresource
Specifies a queue of threads available to run a queue of tasks. Thread pools
are used to improve performance when executing large numbers of
asynchronous tasks by reducing per task invocation overhead, provide a
means of bounding, and managing the resources consumed when executing
a collection of tasks.
Override Transaction
Behavior
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 you select this check box, this activity is not part of the transaction group
and is committed when it completes. Selecting this option uses a separate
database connection to perform the activity and commit the SQL statement.
Override JDBC
Connection
Selecting this option overrides the default datasource connection, and allows
for SQL queries to be executed against the optional datasource.
After selecting this option, the sharedResourceName field is enabled under
the Input > Data Source tab. From the sharedResourceName field, type the
complete path with the name of the optional datasource, which can be found
under the Resources folder. For example, if a JDBC shared resource is
located at Resources > Package_Name > JDBC_SR_Name, then the value
you enter should be Package_Name.JDBC_SR_Name. The value you enter
in the XPath Expression field is case sensitive and must be a string.
To avoid mapping issues, ensure the optional datasource maintains a
structure that is identical to the default database, and that both datasources
are using the same datatypes.
Transactions between multiple datasources is not supported.
Input
The following is the input for the activity.
Input Item
Datatype
Description
statement
string
The SQL statement you want to execute. You can use any
process variables to build the statement dynamically, if
required.
ServerTimeZone
string
Specifies the time zone for the database server.
timeout
number
The time (in seconds) to wait for the query to complete. If the
query does not complete in the specified time limit, an error is
returned.
maxRows
number
The maximum number of rows to retrieve. To retrieve all rows,
specify 0.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
220
Output
The following is the output of the activity.
Output Item
Datatype
Description
noOfUpdates
string
The number of updates performed by the statement specified
on the General 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.
unknownResult
Set
string
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 can 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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
JDBCConnectionNotFoundException
An error occurred when attempting to connect to the
specified database.
InvalidTimeZoneException
An invalid time zone was specified.
JDBCSQLException
An SQL error occurred.
LoginTimedOutException
A timeout has occurred while attempting to connect to the
database.
ActivityTimedOutException
The operation has timed out.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
221
JMS Palette
Java Message Service (JMS) is a specification about sending and receiving messages between two or
more applications in a Java environment. The JMS palette is used to send and receive JMS messages in
a process.
The models supported are:
●
Point-to-Point (queues): Message delivered to one recipient
●
Publish/Subscribe (topics): Message delivered to multiple recipients
JMS supports these two models by using distinct interfaces within the API for each messaging model.
Refer to the documentation of the JMS provider or JMS specifications for more information about JMS
and its message models.
Common JMS Properties and Headers
JMS properties comprise message headers and message properties. MessageHeader properties are set
by the JMS client sending the message. You can view these after the message is received. You can also
set MessageProperties on the outgoing messages on the Input tab of the activity that sends messages.
Message Headers
The following table describes the messages headers.
MessageHeaders
Property
Dataype
Description
JMSDestination
string
The destination where the message is sent.
JMSReplyTo
string
The JMS destination where the reply message should
be sent.
JMSDeliveryMode
string
The delivery mode of the message. Can be one of the
following:
●
PERSISTENT: signifies the messages are stored and
forwarded.
●
NON_PERSISTENT: messages are not stored and
may be lost due to failures in transmission.
JMSMessageID
string
The unique ID of the message.
JMSTimestamp
long
The time a message was handed off to a JMS provider
to be sent. The time is expressed as the amount of time,
in milliseconds, since midnight, January 1, 1970, UTC.
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.
JMSRedelivered
boolean
Typically this item is set when the JMS provider has
delivered the message at least once before.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
222
MessageHeaders
Property
Dataype
Description
JMSPriority
integer
The priority of the message. Priority is a value from 0-8.
Higher numbers signify a higher priority (that is, 7 is a
higher priority than 8).
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 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 the
JMS provider documentation for more information
about the use of this field.
Message Properties
The following table describes the messages properties.
MessageProperties
Dataype
Description
JMSXUserID
string
The ID of the user sending the message.
This property is optionally set on incoming messages
by the JMS application. This property is not set on
outgoing messages.
JMSXAppID
string
The ID of the application sending the message.
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
223
MessageProperties
Dataype
Description
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.
Get JMS Queue Message
Get JMS Queue Message is an asynchronous activity that retrieves a message from the specified
queue. You can use this activity 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.
You can use the Message Selector field on the Advanced tab to retrieve a specific queue message from
the queue.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
JMS Connection
Literal Value
The JMS connection. For details refer to, JMS Connection.
Description
Module
Property
Destination
Yes
The name of the queue from which to retrieve the message.
The syntax of the destination name is specific to the JMS
provider you are using. See the JMS provider
documentation for more information about queue names.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
224
Field
Literal Value/
Process
Property/
Module
Property?
Description
Message Type
Yes
The type of the message which can be one of the following:
●
Text: The message is a java.lang.String.
●
Bytes: A stream of bytes.
●
Map: A set of name or value pairs. The names are
strings, and the values are simple datatypes (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 Java object that can be serialized.
●
Object Ref: An object reference to a Java object.
●
Simple: A message with no body part.
●
Stream: A stream of Java primitives, strings, or arrays
of bytes. Each value must be read sequentially.
●
XML Text: The message is XML text.
Description
Provide a short description for the activity here.
Advanced
The Advanced tab has the following fields.
Field
Literal Value/
Process
Property?
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 (where message properties are used
instead of table column names).
See the JMS provider documentation for more information
and syntax for a message selector string.
Application
Properties Type
None
The type of application-specific message properties that is
part of the message.
Output Editor
The Output Editor tab defines the schema to use for messages of type Map, Stream, or XML Text. Map
messages are name or value pairs, and using this schema you can define the structure of the retrieved
destination queue message. The schema defined on the Output Editor tab becomes the body of the
message on the Output tab. For XML Text message type, select an XSD element. For Map and Stream
message types, select an XSD type in the Output Editor tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
225
Input
The following is the input for the activity.
Input Item
Datatype
Description
destinationQueue
string
The queue to which to send the request. This input item
overrides the Destination field on the General tab.
timeout
integer
Specifies the waiting period for a message in milliseconds. If
set to 0, the message does not expire.
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 the JMS provider documentation for more information
and syntax for a message selector string.
Output
The following is the output of the activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See Common JMS
Properties and Headers 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 Common JMS
Properties and Headers for more information about message
properties.
Only properties applicable to this type of message are displayed.
Body
as per
message
type
The body of the message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
226
Output Item
Datatype
Description
DynamicProperties
complex
Dynamic properties is an additional parameter to add runtime
property to the outgoing JMS messages that are specified in the
Input tab. This is an optional element with only one instance.
Dynamic property can have multiple property elements.
Each property element denotes a single dynamic property and
can contain the following elements:
Name - Required. Name of the property with one instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it will be
considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value of a
property (with the same name) added using the JMS
Application Property.
The DynamicProperties will be also added to the outgoing
message.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When..
JMSInvalidInputException
The 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 is attained and the activity has not
completed its execution.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
227
JMS Receive Message
JMS Receive Message is a process starter activity that starts the process based on the receipt of a
message for the specified JMS destination.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Messaging Style
Yes
Select from one of the following available messaging style
options:
Description
●
Generic: This options corresponds to an abstract JMS
Destination. If you are not sure whether your
destination is a Queue or Topic, select Generic.
●
Queue
●
Topic
JMS Connection
None
The JMS connection. See JMS Connection for more
information.
Destination
Yes
The JMS destination from where the process starter
receives the message.
Message Type
None
The type of the message. This can be one of the following:
●
Text: the message is a java.lang.String.
●
Byte: a stream of bytes.
●
Map: a set of name or value pairs. The names are
strings, and the values are simple datatypes (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 Java object that can be serialized.
●
Object Ref: an object reference to a Java object.
●
Simple: a message with no body part.
●
Stream: a stream of Java primitives, strings, or arrays of
bytes. Each value must be read sequentially.
●
XML Test: the message is XML text.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
228
Field
Literal Value/
Process
Property/
Module
Property?
Description
Durable Subscriber
Yes
Specifies a durable subscription.
You must specify a name in the Subscription Name field
that is registered with the JMS application as the durable
subscriber name. This field is only available if the
Messaging Style is Generic or Topic.
Subscription Name
Yes
The subscription name registered with the JMS application
for durable subscriptions. This field is only available when
you select the Durable Subscriber check box.
After creating a durable subscription you can only be
remove this by accessing the administration tool of the JMS
provider. See the documentation of the JMS provider for
more information about managing durable subscriptions.
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 the process publishes and subscribes to messages with
the same topic name, this option is useful if you want to
specify whether to receive messages sent by the same JMS
application that published the message.
Selecting this check box prevents the process from
receiving messages sent by the same connection.
Keep this check box clear to specify that the messages sent
by the same connection should be received.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
229
Field
Literal Value/
Process
Property/
Module
Property?
Acknowledge Mode
Yes
Max Sessions
Description
The acknowledge mode for incoming messages. It can be
one of the following:
No
●
Auto: the message is automatically acknowledged,
when it is received.
●
Client: the message is 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 confirms the message when using the
acknowledge mode.
●
Dups Ok: the message is acknowledged automatically
when it is received. JMS provides this mode for lazy
acknowledgment, but ActiveMatrix BusinessWorks™
acknowledges messages upon receipt.
●
TIBCO EMS Explicit Client: (only available for TIBCO
Enterprise Message Service) a message which is not
acknowledged using the Confirm activity before the
process instance ends, will be redelivered instead of all
messages in the session. The session is not blocked and
one session handles all incoming messages for each
process instance.
●
TIBCO EMS Explicit Client Dups OK: (only available
for TIBCO Enterprise Message Service) a message
which is not acknowledged using the Confirm activity
before the process instance ends, will be redelivered
instead of all messages in the session. The session is not
blocked and one session handles all the incoming
messages for each process instance. The messages
however, are lazily acknowledged.
●
TIBCO EMS No Acknowledge: messages delivered
using this mode do not require acknowledgment.
Therefore, messages in this mode are not redelivered
regardless of whether the delivery was successful.
Specifies the maximum number of client sessions that can
connect with the messaging server. This property is
enabled only when the Client ACK mode is used.
The default value is 1.
Description
Provide a short description for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
230
Advanced
The Advanced tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
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.
See the JMS provider documentation for more information
and syntax for a message selector string.
Application
Properties Type
None
Any application-specific message properties that is part of
the message. This is specified by the JMS application
properties shared configuration object.
Polling Interval (sec)
None
Specifies the polling interval to check for new messages. If
no value is specified for the property, the default polling
interval is two seconds.
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.
Sequence Key
None
This field can contain an XPath expression that specifies
which processes should run in sequence. Process instances
with sequencing keys that evaluate to the same value are
executed in the sequence the process instances were
created.
Custom Job Id
None
This field can contain an XPath expression that specifies a
custom ID for the process instance.
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 or value pairs, and you can use the schema to define the
structure of the incoming message. The schema on the Output Editor tab becomes the structure used
for the body of the message displayed on the Output tab. For XML Text message type, select an XSD
element. For Map and Stream message types, select an XSD type in the Output Editor tab.
Conversations
You can initiate and join the conversation here. Click the Add New Conversation
multiple conversations.
button to initiate
Output
The following is the output of this activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
231
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See Common
JMS Properties and Headers 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 Common JMS
Properties and Headers for more information about message
properties.
Only properties applicable to this type of message are
displayed.
Body
as per
message type
The body of the message.
DynamicProperties
complex
Dynamic properties is an additional parameter to add
runtime property to the outgoing JMS messages that are
specified in the Input tab. This is an optional element with
only one instance. Dynamic property can have multiple
property elements.
Each property element denotes a single dynamic property
and can contain the following elements:
Name - Required. Name of the property with one instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it will
be considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value of a
property (with the same name) added using the
JMS Application Property.
The DynamicProperties will be also added to the outgoing
message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
232
JMS Request Reply
JMS Request Reply is an asynchronous activity that is used to send a request to a JMS destination and
wait for a response from the JMS client.
This activity uses temporary destinations to ensure that reply messages are received only by the
process that sent the request. However, the user has the ability to use preexisting JMS destinations.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Messaging Style
Yes
Select from one of the following available options:
Description
●
Generic
●
Queue
●
Topic
JMS Connection
None
The JMS connection. See JMS Connection for more
information.
Destination
Yes
The name of the destination of the outgoing message.
Message Type
None
The type of the message. This can be one of the following:
●
Text: the message is a java.lang.String.
●
Byte: a stream of bytes.
●
Map: a set of name or value pairs. The names are
strings, and the values are simple datatypes (JAVA
primitives), an array of bytes (use the Binary datatype
when mapping this data), or a string. You can access
each item sequentially or by its name.
●
Object: a Java object that can be serialized.
●
Object Ref: an object reference to a Java object.
●
Simple: a message with no body part.
●
Stream: a stream of Java primitives, strings, or arrays of
bytes. Each value must be read sequentially.
●
XML Text: the message is XML text.
Description
Privide a short description for the activity here.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
233
Advanced
The Advanced tab has the following fields.
Field
Description
Reply To Destination
The destination to use for replies for this activity.
If more than one job has the same Reply To Destination, each job
may not receive the correct reply. Ensure to specify an expression
in this field that assigns a different Reply To Destination to each
process instance.
Deliver Mode
JMS
Expiration(msec)
The delivery mode of the message. Can be one of the following:
●
Persistent: signifies that the messages are stored and forwarded.
●
Non_Persistent: signifies that the messages are not stored and may be
lost due to transmission failure.
●
TIBCO_EMS_Reliable_Delivery: this mode is only available when using
TIBCO Enterprise Message Service. See the TIBCO Enterprise Message
Service documentation for more information.
Corresponds to the 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
The priority of the message. You may set the priority to a value from 0-8. The
default value is 4.
Type
The value to supply to the JMSType header property.
Application
Properties Type
Any application-specific message properties that is part of the message. This
is specified by the JMS application properties shared configuration object.
Input Editor and Output Editor
The Input Editor and Output Editor tabs define the schema to use for messages of type Map, Stream,
or XML Text. Map messages are name or value pairs, and you can use the schema 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. For XML Text message type, select an XSD
element. For Map and Stream message types, select an XSD type in the Input Editor or Output Editor.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
234
Input Item
Datatype
Description
Destination
string
The destination to which to send the request. This input
item overrides the Destination field on the General tab.
replyTo
string
The destination to use for replies for this activity.
If more than one job has the same Reply To
Destination, then each job may not receive the
correct reply. Ensure to specify an expression in
this field that assigns a different Reply To
Destination to each process instance.
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 that the messages are stored and
forwarded.
●
Non_Persistent: signifies that the messages are not
stored and may be lost due to transmission failure.
●
TIBCO_EMS_Reliable_Delivery: this mode is only
available when using TIBCO Enterprise Message
Service. See the TIBCO Enterprise Message Service
documentation for more information.
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. For details, refer to Common
JMS Properties and Headers.
Body
depends on the
message type
The body of the message.
requestTimeout
integer
This field specifies the amount of time (in milliseconds)
that the activity waits before it times out.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
235
Input Item
Datatype
Description
DynamicProperties
complex
Dynamic properties is an additional parameter to add
runtime property to the outgoing JMS messages that are
specified in the Input tab. This is an optional element
with only one instance. Dynamic property can have
multiple property elements.
Each property element denotes a single dynamic
property and can contain the following elements:
Name - Required. Name of the property with one
instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it
will be considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value
of a property (with the same name) added
using the JMS Application Property.
The DynamicProperties will be also added to the
outgoing message.
Output
The following is the output of this activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See Common
JMS Properties and Headers 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 Common JMS
Properties and Headers for more information about message
properties.
Only properties applicable to this type of message are
displayed.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
236
Output Item
Datatype
Description
Body
as per
message type
The body of the message.
DynamicProperties
complex
Dynamic properties is an additional parameter to add
runtime property to the outgoing JMS messages that are
specified in the Input tab. This is an optional element with
only one instance. Dynamic property can have multiple
property elements.
Each property element denotes a single dynamic property
and can contain the following elements:
Name - Required. Name of the property with one instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it will
be considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value of a
property (with the same name) added using the
JMS Application Property.
The DynamicProperties will be also added to the outgoing
message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
JMSInvalidInputException
The 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
237
Fault
Thrown When..
ActivityTimedOutException
The specified timeout has been attained and the activity has not
completed its execution.
JMS Send Message
JMS Send Message is a synchronous activity that sends a message to the specified JMS destination.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Messaging Style
None
Select from one of the following available options:
Description
●
Generic
●
Queue
●
Topic
JMS Connection
None
The JMS connection. See JMS Connection for more
information.
Destination
Yes
The name of the destination of the outgoing message.
Message Type
None
The type of the message. This can be one of the following:
●
Text: the message is a java.lang.String.
●
Byte: a stream of bytes.
●
Map: a set of name or value pairs. The names are strings,
and the values are simple datatypes (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 Java object that can be serialized.
●
Object Ref: an object reference to a Java object.
●
Simple: a message with no body part.
●
Stream: a stream of Java primitives, strings, or arrays of
bytes. Each value must be read sequentially.
●
XML Text: the message is XML text.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
238
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Reply To
Destination
The destination to use for replies for this activity.
Deliver Mode
The delivery mode of the message. Can be one of the following:
JMS
Expiration(msec)
If more than one job has the same Reply To Destination, each job
may not receive the correct reply. Ensure to specify an expression
in this field that assigns a different Reply To Destination to each
process instance.
●
Persistent: signifies that the messages are stored and forwarded.
●
Non_Persistent: signifies that the messages are not stored and may be lost
due to transmission failure.
●
TIBCO_EMS_Reliable_Delivery: this mode is only available when using
TIBCO Enterprise Message Service. See the TIBCO Enterprise Message
Service documentation for more information.
Corresponds to the 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.
Delivery
Delay(msec)
Delivery Delay feature, which is supported in EMS, is now supported in
TIBCO ActiveMatrix BusinessWorks™ 6.4.2.
It is the minimum length of time in milliseconds that must elapse after a
message is sent before the JMS provider may deliver the message to a
consumer.
Priority
The priority of the message. You may set the priority to a value from 0-8. The
default value is 4.
Type
The value to supply to the JMSType header property.
Application
Properties Type
Any application-specific message property that is part of the message. This is
specified by the JMS application properties shared configuration object.
Override
Transaction
Behavior
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 check box is selected, the JMS message does not participate in the
transaction.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
239
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 or value pairs, and you can use the schema to define the
structure of the outgoing message. After defining the schema on the Input Editor tab, it becomes the
structure used for the body of the message displayed on the Input tab. For the XML Text message type,
select an XSD element. For Map and Stream message types, select an XSD type in the Input Editor tab.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Destination
string
The destination to which to send the message. This input
item overrides the Destination field on the General tab.
replyTo
string
The destination to use for replies for this activity.
If more than one job has the same Reply To
Destination, each job may not receive the
correct reply. Ensure to specify an expression in
this field that assigns a different Reply To
Destination to each process instance.
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 that the messages are stored and
forwarded.
●
Non_Persistent: signifies that the messages are not
stored and may be lost due to transmission failure.
●
TIBCO_EMS_Reliable_Delivery: this mode is only
available when using TIBCO Enterprise Message
Service. See the TIBCO Enterprise Message Service
documentation for more information.
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. For details, refer to Common
JMS Properties and Headers.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
240
Input Item
Datatype
Description
Body
depends on the
message type
The body of the message.
DynamicProperties
complex
Dynamic properties is an additional parameter to add
runtime property to the outgoing JMS messages that are
specified in the Input tab. This is an optional element
with only one instance. Dynamic property can have
multiple property elements.
Each property element denotes a single dynamic
property and can contain the following elements:
Name - Required. Name of the property with one
instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it
will be considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value
of a property (with the same name) added
using the JMS Application Property.
The DynamicProperties will be also added to the
outgoing message.
Output
The following is the output of the activity.
Output Item
Datatype
Description
MessageID
string
The unique identifier of the message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
241
Fault
Thrown When..
JMSInvalidInputException
The 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.
Reply to JMS Message
Reply To JMS Message is a synchronous activity that sends a reply to a previously received JMS queue
or topic message. The Reply For Event field in the General tab lists the activities that can receive the
JMS message. The activity you select determines the response of the reply message.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label of the activity.
Reply For Event
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. The listed activity is WaitforJMSRequest.
Message Type
The type of the message. This can be one of the following:
●
Text: the message is a java.lang.String.
●
Byte: a stream of bytes.
●
Map: a set of name or value pairs. The names are strings, and the values are
simple datatypes (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 Java object that can be serialized.
●
Object Ref: an object reference to a Java object.
●
Simple: a message with no body part.
●
Stream: a stream of Java primitives, strings, or arrays of bytes. Each value
must be read sequentially.
●
XML Text: the message is XML text.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
242
Field
Description
Deliver Mode
The delivery mode of the message. This can be one of the following:
JMS
Expiration(msec)
●
Persistent: signifies that the messages are stored and forwarded.
●
Non_Persistent: signifies that the messages are not stored and may be lost
due to transmission failure.
●
TIBCO_EMS_Reliable_Delivery: this mode is only available when using
TIBCO Enterprise Message Service. See the TIBCO Enterprise Message
Service documentation for more information.
Corresponds to the 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
The priority of the message. You may set the priority to a value from 0-8. The
default value is 4.
JMSType
The value to supply to the JMSType header property.
Application
Properties Type
Any application-specific message property that is part of the message. This is
specified by the JMS application properties shared configuration object.
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 or value pairs, and you can use the schema to define the
structure of the outgoing message. After defining the schema on the Input Editor tab, it becomes the
structure used for the body of the message displayed on the Input tab. For XML Text message type,
select an XSD element. For Map and Stream message type, select an XSD Type in the Input Editor tab.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Destination
string
The destination to which to send the request. This input
item overrides the Destination field on the General tab.
replyTo
string
The destination to use for replies for this activity.
If more than one job has the same Reply To
Destination, each job may not receive the
correct reply. Ensure to specify an expression in
this field that assigns a different Reply To
Destination to each process instance.
JMSExpiration
integer
Specifies how long the message can remain active (in
seconds). If set to 0, the message does not expire.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
243
Input Item
Datatype
Description
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 that the messages are stored and
forwarded.
●
Non_Persistent: signifies that the messages are not
stored and may be lost due to transmission failure.
●
TIBCO_EMS_Reliable_Delivery: this mode is only
available when using TIBCO Enterprise Message
Service. See the TIBCO Enterprise Message Service
documentation for more information.
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. For details, refer to Common
JMS Properties and Headers.
Body
depends on the
message type
The body of the message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
244
Input Item
Datatype
Description
DynamicProperties
complex
Dynamic properties is an additional parameter to add
runtime property to the outgoing JMS messages that are
specified in the Input tab. This is an optional element
with only one instance. Dynamic property can have
multiple property elements.
Each property element denotes a single dynamic
property and can contain the following elements:
Name - Required. Name of the property with one
instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it
will be considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value
of a property (with the same name) added
using the JMS Application Property.
The DynamicProperties will be also added to the
outgoing message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
JMSInvalidInputException
The 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™ Bindings and Palettes Reference
245
Wait for JMS Request
Wait for JMS Request is a signal-in activity that waits for the receipt of a message for the specified JMS
destination.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Messaging Style
Yes
Select from one of the following available options:
Description
●
Generic
●
Queue
●
Topic
JMS Connection
None
The JMS connection. See JMS Connection for more
information.
Destination
Yes
The destination from which a reply to this message should
be received.
Message Type
None
The type of the message. This can be one of the following:
●
Text: the message is a java.lang.String.
●
Byte: a stream of bytes.
●
Map: a set of name or value pairs. The names are
strings, and the values are simple datatypes (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 Java object that can be serialized.
●
Object Ref: an object reference to a Java object.
●
Simple: a message with no body part.
●
Stream: a stream of Java primitives, strings, or arrays of
bytes. Each value must be read sequentially.
●
XML Test: the message is XML text.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
246
Field
Literal Value/
Process
Property/
Module
Property?
Description
Durable Subscriber
Yes
Specifies a durable subscription.
Specify a name in the Subscription Name field that is
registered with the JMS application as the durable
subscriber name. This field is only available, if the
Messaging Style is Generic or Topic.
Subscription Name
Yes
The subscription name registered with the JMS application
for durable subscriptions. This field is only available when
the Durable Subscriber check box is selected.
After a durable subscription is created, it can only be
removed by accessing the administration tool of the JMS
provider. See the documentation of the JMS provider for
more information about managing durable subscriptions.
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 publishes and subscribes to messages with
the same topic name, this option is useful if you want to
specify whether to receive messages sent by the same JMS
application that published the message.
Selecting this check box prevents the process from
receiving messages sent by the same connection.
Keep this check box clear to specify that the messages sent
by the same connection should be received.
Max Sessions
No
Specifies the maximum number of client sessions that can
connect with the messaging server. This property is
enabled only when the Client ACK mode is used.
The default value is 1.
Description
Provide a short description for the activity.
Event
The Event tab has the following fields.
Field
Description
Event Timeout
(seconds)
This field specifies the amount in seconds. 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
247
Field
Description
Activity Timeout
(msec)
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.
Advanced
The Advanced tab has the following fields.
Field
Description
Message Selector
A string to determine whether a message should be received. The syntax of
the message selector is determined by the JMS provider.
See the JMS provider documentation for more information and syntax for a
message selector string.
Application
Properties Type
Any application-specific message properties that is part of the message. This
is specified by the JMS application properties shared configuration object.
Output Editor
The Output Editor tab defines the schema to use for messages of type Map, Stream, or XML Text. Map
messages are name or value pairs, and using this schema you can 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.
Conversations
You can initiate and join the conversation here. Click the Joining existing conversation
join existing conversations.
button to
Output
The following is the output of this activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See Common
JMS Properties and Headers 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 Common JMS
Properties and Headers for more information about message
properties.
Only properties applicable to this type of message are
displayed.
Body
as per
message type
The body of the message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
248
Output Item
Datatype
Description
DynamicProperties
complex
Dynamic properties is an additional parameter to add
runtime property to the outgoing JMS messages that are
specified in the Input tab. This is an optional element with
only one instance. Dynamic property can have multiple
property elements.
Each property element denotes a single dynamic property
and can contain the following elements:
Name - Required. Name of the property with one instance.
Value - Required. Value of the property with one instance.
Type - Optional. Type of the property. If not provided, it will
be considered as string.
The following data types are supported:
●
string
●
boolean
●
short
●
integer
●
long
●
float
●
double
●
byte
The DynamicProperty will overwrite the value of a
property (with the same name) added using the
JMS Application Property.
The DynamicProperties will be also added to the outgoing
message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
ActivityTimedOutException
The specified timeout has been attained and the activity has not
completed its execution.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
249
Mail Palette
The Mail Palette is used to receive incoming emails or send outgoing emails.
Receive Mail
Receive Mail is a process starter activity that polls a POP3 mail server for the new mail. After detecting
and retrieving a new mail, the Receive Mail activity starts the process.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property
Name
None
The name to be displayed as the label for the activity in the
process.
Host
Yes
The host name or IP address for the mail server.
Port
Yes
The default port (110) used to connect to POP3 server.
User Name
Yes
The username for logging into the POP3 server.
Password
Yes
The password for logging into the POP3 server.
Polling Interval
(sec)
Yes
The polling interval (in seconds) to check for new mail. The
default is 5, if no polling interval is specified.
Delete Mail
None
Select this check box to delete the mail from the POP3 server
after process starter has retrieved it.
Description
To delete mail, place a Checkpoint activity
immediately after the Receive Mail process starter.
This ensures that the message is not lost in the event of
a machine failure.
Alternatively, you can leave this field clear.
Enable
Confidentiality
None
This check box specifies whether a Secure Sockets Layer (SSL)
Client should be used to specify the SSL configuration. When this
check box is selected, the SSL Client field displays.
SSL Client
Yes
The name of the resource. In the SslClientResource Resource
Template wizard, create a resource to connect to the SSL client.
Test Connection Button
The Test Connection button tests the connection to the specified mail server. Use this button to ensure
that your Receive Mail activity is properly configured to receive mail from the specified mail server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
250
This button is enabled only when the Host, User Name, and Password fields on the General tab are
populated.
Description
Provide a short description of the process in this field.
Advanced
The Advanced tab contains the following fields:
Field
Description
Sequencing
Key
Contains an XPath expression that specifies which process runs in a sequence.
Process instances with sequencing keys evaluating to the same value, are executed
in the sequence the process instance was created.
Custom Job id
This field can contain an XPath expression that specifies a custom ID for the process
instance.
Provide Raw
Message
When selected, this field specifies the whole message to be provided in the 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.
Select this check box to send the raw message to a Java Invoke 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, refer to the API documentation for javax.activation and
javax.mail.
You can also feed the binary message to the javax.mail.MimeMessage constructor
in the form of a java.io.InputStream to construct a MimeMessage object. The
default javax.mail API handler is used in such a case.
Write to File
Select this check box to specify that the incoming messages whose body and
attachments (or raw message size, if Provide Raw Message is selected) exceed the
specified threshold size, must be written to a file instead of being stored in memory.
You can accept large incoming messages without consuming more memory. The
incoming message is written to the file with mail headers when body and
attachment exceeds the specified size.
Selecting this check box displays the Directory, Creating Non-Existing Directories,
and Threshold Size fields.
Do not select to keep the incoming messages in memory.
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™ Bindings and Palettes Reference
251
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 NonExisting
Directories
The directory to write messages that are above the specified threshold.
If the specified directory does not exist, the process engine does not attempt to
create the directory. Therefore, select the check box to create the directory before
starting the process engine.
Not selecting this check box with one or more non-existing directories in the
specified path in the Directory field, raises an exception.
Threshold
Data Size
(bytes)
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 name is an output so that the subsequent activities in the process
properties can access the file and read its contents.
Specifying zero (0) in this field determines all incoming messages to be saved to a
file.
Output Editor
Incoming messages may contain custom headers. From the Output Editor tab, define a custom schema
for the headers of the incoming mail messages. You can also specify any standard header supported by
the javax.mail package. For example, X-Mailer or X-Priority. Values of headers in the incoming
message populates the corresponding defined output headers of the same name.
Conversations
You can initiate the conversation here. Click the Add New Conversation
button to initiate multiple
conversations. For details about conversations, refer to Application Development.
Output
The following is the output of the activity.
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™ Bindings and Palettes Reference
252
Output Item
Datatype
Description
Headers
complex
This element contains the schema you defined on the Output
Editor tab. You can specify custom headers that can be
included in the incoming mail messages.
bodyElement
string
Contains a choice element.
You can either provide the bodyText element or fileName
element.
mimeEnvelopeElement
complex
This field is available when the Provide Raw Message check
box on the Advanced tab is not selected.
Contains the message attachments. This element contains a
repeating element named mimePart that comprises each
mime attachment.
mimeHeaders
complex
This element contains the mime header for each mimePart.
mimeHeaders contain the following information:
●
content-disposition - To suggest a filename for an
attachment, use "*;filename=<filename>" in this
element.
E-mail servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
●
any element
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
When the contentType is specified as "text/*" (for
example, "text/xml"), specify the attachment
content in either the textContent input element or
the file name storing the attachment in the
fileName input element. When the contentType is
anything other than "text/*":
●
The attachment content must be in the
binaryContent input element.
●
The file name storing the attachment must be in
the fileName input element.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
253
Output Item
Datatype
Description
binaryContent |
fileName | textContent
choice
This element contains the mime attachment. It can be any of
the following:
●
binaryContent: the content of the attachment when the
attachment is binary data.
●
fileName: the file name of the attachment written on the
disk.
●
textContent: the content of the attachment when the
attachment is text data.
Send Mail
Send Mail is a synchronous activity that sends an email by way of an SMTP server.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
SMTP
Property
Yes
The property name of the SMTP server.
If your server is configured for using a different port, specify it in
this field.
Description
Provide a short description of the Send Mail activity here.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
254
Field
Description
Allow NonStandard Email
IDs
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.
Select this check box to specify email IDs that do not conform to the RFC 822
standard. This is useful for sending 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.
When this field is not selected, 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://
javamail.kenai.com/nonav/javadocs/javax/mail/internet/InternetAddress.html.
Input Editor
You may want to add custom headers to outgoing mail messages. From the Input Editor tab you can
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.
Input
The following is the input for the activity.
Input Item
Datatype
Description
username
string
The username to use when authenticating to the mail
server.
password
string
The 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. Use this repeatable element
to send mail to more than one recipient.
Provide a list of "to" recipients in a single string by using
either a comma or a semicolon (but not both in the same
string) as delimiters.
cc
string
The "cc" (carbon copy) list for the email. Use this repeatable
element to place more than one recipient on the "cc" list, if
required.
Provide a list of "cc" recipients in a single string by using
either a comma or a semicolon (but not both in the same
string) as delimiters.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
255
Input Item
Datatype
Description
bcc
string
The "bcc" (blind carbon copy) list for the email. Use this
repeatable element to place more than one recipient on the
"bcc" list.
Provide a list of "bcc" recipients in a single string by using
either a comma or a semicolon (but not both in the same
string) as delimiters.
replyTo
string
The "replyTo" list for the email. Use this repeatable element
to place more than one recipient on the "replyTo" list.
Provide a reply to list in a single string by using either a
comma or a semicolon (but not both in the same string) as
delimiters to separate the addresses in the list.
subject
string
The subject of the email.
sentDate
string
The date stamp for the email.
The email server provides the actual date stamp
for the email, so this input item is ignored. Do not
attempt to place a value in this input item.
bodyElement
complex
Contains a choice element.
You can either provide the bodyText element or fileName
element.
bodyText
string
The text of the email message.
fileName
string
The file name of the attachment written to the disk.
Headers
complex
Contains the schema you defined on the Input Editor tab.
Specify custom headers for the outgoing mail messages.
Specify any standard header supported by the
package. For example, X-Mailer or X-Priority.
javax.mail
To use attachments, specify the Content-Type header as
multipart/* (where * is a valid subtype of the multipart).
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.
mimeEnvelopeElement
complex
Contains the message attachments.
mimePart
complex
This repeating element comprises each mime attachment.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
256
Input Item
Datatype
Description
mimeHeaders
complex
This element contains the mime header for each mimePart.
mimeHeaders contain the following information:
●
content-disposition - To imply a filename for an
attachment, use "*;filename=<filename>" in this
element.
E-mail servers may alter or ignore the
suggested name.
●
content-type
●
content-transfer-encoding
●
content-id
●
any element
See http://www.faqs.org/rfcs/rfc2045.html for more
information about MIME headers and their syntax.
When the contentType is specified as "text/*"
(for example, "text/xml"), specify the attachment
content in either the textContent input element or
the file name storing the attachment in the
fileName input element. When the contentType is
anything other than "text/*":
●
The attachment content must be in the
binaryContent input element.
●
binaryContent |
fileName | textContent
choice
The file name storing the attachment must be
in the fileName input element.
This element contains the mime attachment. It can be any of
the following:
●
binaryContent: the content of the attachment when the
attachment is binary data.
●
fileName: the file name of the attachment written on the
disk.
●
textContent: the content of the attachment when the
attachment is text data.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
InvalidInputException
The input is not valid.
UnknownHostException
The mail server host name is not resolved.
The exception contains the name of the mail server host.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
257
Fault
Thrown When..
SendFailedException
The send operation failed for some reason.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
258
Parse Palette
The Parse palette provides shared configuration resources for parsing and rendering the
formatted text. This is useful if you want to transform the formatted lines of text into a data schema or
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.
MimeParser
This activity is responsible for parsing MTOM messages into a SOAP message that contains binary
attachments as an inline data of the SOAP message. The output can be either in a Text or a Binary
format.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Input Style
The input message format. (Currently only MTOM is available.)
Output Style
The output message format.
You can select either Text or Binary format for the output messages.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following.
Field
Description
Generate Strict Parsing
Errors
Select this check box to generate strict parsing validation errors.
Input
The following is the input for the activity.
Input Item
Datatype
Description
MimeBinaryData
Binary
This is the incoming binary data.
Output
The following is the output of the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
259
Output Item
Datatype
Description
soapMessage
Binary or String
Depends on the type selected in the Output Style format.
StrictValidation
Errors
Complex
This displays only when the Generate Strict Parsing Errors
check box is selected.
ErrorString
String
Shows strict parsing validation error logs.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown When...
XOPParseException
The input has XOP related exceptions.
MimeParseException
The input has MIME related exceptions.
InvalidXMLException
The input has invalid xml related exception.
Parse Data
The Parse Data activity takes a text string or input from a file and processes it by converting it
into a schema tree based on the specified Data Format shared resource.
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. You can also use this activity to specify a text file to read.
You can use this activity in various scenarios. For example, a user has a file comprising multiple lines
with comma-separated values (as in data obtained from a spreadsheet) and this data has to be inserted
into a database table. In such a scenario, read and parse the file into a data schema with the Parse Data
activity. Then, use JDBC Update activity to insert the data schema into a database table.
General
The General tab has the following fields.
Field
Module
Property?
Name
No
The name to be displayed as the label for the activity in the
process.
Data Format
No
The Data Format shared resource to use when parsing the text
input.
Input Type
No
Specify the type of input for this activity.
Description
Input can either be String or File. If the input is a text string,
provide the string to the text input item. If the input is a file,
provide the file name and location to the fileName input item.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
260
Field
Module
Property?
Description
Encoding
Yes
The encoding of the input file.
To enable this field, select the File option in the Input Type
field . Any valid Java encoding name can be used.
Skip Blank
Spaces
No
Select this check box to skip any empty records when parsing
the text input.
When this check box is not selected, parsing stops at the first
blank line encountered in the input.
Manually
Specify Start
Record
No
You can specify the record in the input where you want to start
parsing.
This is useful if you have a large number of records and you
want to read the input in parts (to minimize memory usage).
Selecting this check box displays the startRecord input item.
See Parsing a Large Number of Records for more information
on how to read the input stream in parts.
Strict Validation
No
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 check box is selected, 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.
When this check box is not selected, the Parse Data activity
quits parsing if an error is encountered while parsing the
records in the input.
Irrespective of whether this check box is selected or not, the
Parse Data activity quits when any data validation errors occur.
Input
The following is the input for the activity.
Input Item
Datatype
Description
text
string
The text string to parse.
This input item is available only when String is specified in
the Input Type field of the General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
261
Input Item
Datatype
Description
fileName
string
The location and name of the file to read. The file's content is
used as the input text string for this activity.
This input item is available only when File is specified in the
Input Type field of the General tab.
startRecord
number
The line number of the input stream to begin parsing. All
lines before the specified line are ignored. This input item is
available only if the Manual Specify Start Record check box
on the General tab is selected.
The input stream begins with the line number 1 (one). This is
useful for reading the input stream in parts to minimize
memory usage.
See Parsing a Large Number of Records for more information.
noOfRecords
number
The number of records to read from the input stream. Specify
-1 if you want to read all records in the input stream.
This is useful for reading the input stream in parts to
minimize memory usage.
See Parsing a Large Number of Records for more information.
SkipHeaderCharacters
integer
The number of characters to skip when parsing. You can skip
over any file headers or other unwanted information.
Output
The following is the output of the activity.
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
ErrorRows
complex
The schema containing the data from the parsed input text. This output
item contains zero or more parsed records.
This output item is available when you select Continue on Error, 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
262
Output
item
Datatype
Description
done
boolean
true
if no more records are available for parsing. false if there are
more records available.
This output item is useful to check whether there are no more records
in the input stream when reading the input in parts to preserve
memory.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
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.
When reading a large number of records from a file, the process may consume significant machine
resources. To avoid too much memory, you may want to read the input in parts, parsing and processing
a small set of records before moving on to the next set of records.
This procedure 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. If processing a large number
of records, do the following:
1. Select and drop the Parse Data activity on the process editor.
2. On the General tab, specify the fields and select the Manually Specify Start Record check box.
3. Select the Parse Data activity and click the group icon on the tool bar to create a group containing
the Parse Data activity.
4. Specify Repeat Until True Loop as the Group action, and specify an index name (for example, "i").
The loop must exit when the EOF output item for the Parse Data activity is set to true. For example,
the condition for the loop can be set to the following: string($ParseData/Output/done) =
string(true())
5. Set the noOfRecords input item for the Parse Data activity to the number of records you want to
process for each execution of the loop.
If you do not select the Manually Specify Start Record check box on the General 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 select the Manually Specify Start Record check box 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
263
Render Data
The Render Data activity takes an input of a data schema and renders it as a text string. The
schema processed is based on a specified Data Format shared resource.
You can use this activity in various scenarios, for example, retrieving a result set from a database table.
You may want 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.
●
Use the Render Data activity to render the data schema as a formatted text string.
●
Use the Write File activity to write the string to a file.
General
The General tab has the following fields.
Field
Module
Property?
Name
No
The name to be displayed as the label for the activity in the
process.
Data Format
No
The Data Format shared resource to use when rendering the text
output.
Description
Input
The following is the input for the activity.
Input Item
Datatype
Description
Rows
complex
The element containing the list of items to render.
root
complex
The complex element containing data schema (specified by the Data
Format shared resource) to render as a text string. This is a repeating
element which renders more than one output record.
Output
The following is the output of the activity.
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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
264
Fault
Thrown When..
BadDataFormatException
The output format is not valid.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
265
Rendezvous Palette
®
Using the Rendezvous palette you can send and receive TIBCO Rendezvous messages.
®
To run Rendezvous applications on UNIX, set the LD_LIBRARY_PATH variable and RV_HOME
specifying the RV lib path.
®
You must install Rendezvous if you want to use the Rendezvous palette features. Refer to the product
readme, readme.txt, for the supported versions.
Datatype Conversion
®
When sending or receiving Rendezvous messages, ActiveMatrix BusinessWorks™ converts the fields
®
of the message to the correct datatypes. Data in the incoming Rendezvous messages is converted to
ActiveMatrix BusinessWorks™ datatype (and represented in the activity’s output). Data in an outgoing
®
message is converted to Rendezvous datatypes.
The following tables describe the corresponding datatypes between ActiveMatrix BusinessWorks™ and
TIBCO Rendezvous, depending upon whether ActiveMatrix BusinessWorks™ is sending or receiving
the message.
®
Rendezvous to ActiveMatrix BusinessWorks™ Datatype Conversion
®
Rendezvous Datatype
XSD Dataype
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
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
266
®
ActiveMatrix BusinessWorks™ to Rendezvous Datatype Conversion
XSD Datatype
TIBCO Rendezvous Datatype
boolean
TIBRVMSG_BOOL
byte
TIBRVMSG_I8
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 or base64Binary,
depending upon what is defined in
the schema.
TIBRVMSG_OPAQUE
date
TIBRVMSG_DATETIME
dateTime
TIBRVMSG_DATETIME
time
TIBRVMSG_STRING
string
TIBRVMSG_STRING
Field Names in Messages
®
A Rendezvous message can contain field names that are not compliant with XML naming rules. For
example, XML element names can neither begin with a number, nor can they contain special characters,
such as # or ^. When activities in the Rendezvous palette send or receive messages, element names in
the input schemas or output schemas for the activity must comply with XML naming rules. Any
element in referenced schemas in the input schemas or output schemas is automatically altered to
comply with XML naming rules. From the XML-Compliant Field Names field, you can handle the
incoming or outgoing messages when the field names are not valid XML names.
When the XML-Compliant Field Names field is clear, any field name in the incoming or outgoing
messages not compliant with XML naming rules, is altered to comply with the rules. When this field is
selected, field names in the message are left unaltered.
When publishing a message with XML-Compliant Field Names field not selected, the field names in
the message sent over the transport to the receiving application are altered to comply with XML
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
267
naming rules. By selecting this field, you can 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 tab that contains invalid XML names. The receiving application receives the message with
the original field names, if the XML-Compliant Field Names field is not selected.
When receiving a message, not selecting the XML-Compliant Field Names field ensures that field
names in the incoming message are altered to comply with XML naming rules. If the message contains
fields that do not comply to XML naming rules, the output schema of the subscriber activity must
specify the correct altered name to match the altered name of the field in the incoming message.
Keeping the field clear leaves the field names of the message intact.
Not selecting 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 clear this field to improve performance.
Globalization Support
®
Rendezvous activities use bw.palette.messageEncoding property as the wire format encoding.
If this property is not set, the default wire format encoding value which supports all the character set, is
UTF-8. To change the wire format encoding other than UTF-8, set the bw.palette.messageEncoding
property to the required encoding. In design time, you can specify the property in VM arguments of
Debug/Run Configurations like -Dbw.palette.messageEncoding=ISO8859-1 in the Debug
Configrations dialog. See the following screenshot for reference.
ISO8859-1 supports English and other western European languages that belong to ISO Latin-1 character
set. UTF-8 can send and receive characters that are not in the ASCII and Latin-1 character set.
In run time, you can specify the property in the config.ini file of the AppNode. For details, refer to
Administration guide.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
268
Rendezvous Publisher
®
Rendezvous Publisher is a synchronous activity that publishes a Rendezvous message on the specific
subject with the specified message content.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Subject
Yes
The subject on which to publish the Rendezvous message. Specify
a subject on the Input tab to override this value.
Transport
Literal Value/
Module
Property
The Rendezvous transport parameters. These are specified as
Rendezvous Transport shared configuration resource.
Pre Register
Listener
Yes
When using TIBCO Rendezvous Certified Messaging (RVCM), this
field specifies the cmnames of the RVCM subscribers. The
publisher preregisters with any expected listeners. If multiple
cmnames are specified, separate each cmname with a comma.
Description
®
®
®
See the Rendezvous documentation for more information about
RVCM.
®
XML Format
None
If selected, the body of the 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.
XML
Compliant
Field Names
None
Specifies whether the field names of the outgoing message should
be altered so that they comply with XML naming rules.
Clear this check box to alter only the field names that do not
comply with XML naming rules. When selected, the field names
are left unaltered.
Description
Add a short description for the activity.
Input Editor
®
Define a schema element for the body of the Rendezvous message.
Input
The following is the input of this activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
269
Field
Data
Source
Description
subject
string
The subject of the Rendezvous message.
replySubject
string
The subject to send replies for this Rendezvous message. This is
useful if you want to use the Wait for Rendezvous Message
activity later in the process to receive replies to the message.
preRegisterListner
string
When using TIBCO Rendezvous Certified Messaging (RVCM),
this field specifies the cmnames of the RVCM subscribers. 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.
body
complex
The body of the Rendezvous message.
®
®
®
This field displays only when any schema is provided in the
Input Editor tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
TransportException
The transport cannot be created.
SerializationException
The message cannot be serialized.
RVPluginException
An error occurred when sending the message.
Rendezvous Reply To Request
Rendezvous Reply to Request is a synchronous activity that is used to send a reply to a received
®
Rendezvous message.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
Description
The name to be displayed as the label for the activity in the
process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
270
Field
Literal Value/
Process
Property/
Module
Property?
Reply to
None
Description
The TIBCO Rendezvous activity or process starter that received
the request. This is a selection list of the following available
®
activities that can receive Rendezvous messages.
●
RendezvousSubscriber
●
WaitForRendezvousMessage
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.
XML
Compliant
Field Names
None
Select this check box to specify whether the field names of the
outgoing message should be altered so that they comply with the
XML naming rules.
Clear this check box to alter only the field names that do not
comply with XML naming rules. When selected, the field names
are left unaltered.
Description
Provide a short description for the activity.
Input Editor
®
Use the Input Editor tab to define a custom schema for the body of the Rendezvous message.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Input
The following is the input for the activity.
Input Item
Datatype
Description
replySubject
string
The reply subject of the Rendezvous message.
®
Fault
The Fault tab lists the possible exceptions thrown by this activity. See the Error Codes guide for more
information about error codes and the corrective action to take.
Fault
Thrown When..
RVPluginException
An error occurred when sending the reply message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
271
Rendezvous Subscriber
®
Rendezvous Subscriber is a process starter activity that creates a process when a Rendezvous
message on the specified subject is received.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Subject
Yes
The subject on which to listen for the Rendezvous message.
Transport
Literal Value/
Module
Property
The Rendezvous transport parameters. These are specified as a
Rendezvous Transport shared resource.
XML Format
None
If you select this check box, the body of the incoming
®
Rendezvous message is a single field named "xml". This field is a
byte array containing the body of the message.
Description
®
®
ActiveMatrix BusinessWorks™ automatically deserializes the xml
field and represents the message as a schema tree in this activity’s
output.
When selected, the Need Input Filteration check box
gets disabled.
Need Output
Filteration
None
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 saves memory, and consequently improves
the performance.
This option is valid, only when the XML Format check
box is not selected. Do not select this check box when
the XML Format check box is also selected.
XML
Compliant
Field Names
None
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 check box is
not selected. When selected, field names are left unaltered.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
272
Field
Raw-RVObject Mode
Literal Value/
Process
Property/
Module
Property?
Description
None
Selecting this check box disables XML Format, Needs Output
Filtration, and XML-Compliant Field Names check boxes.
Select this check box to specify that the body of the RV message is
the output as a Java object reference. A subsequent Java Invoke
activity in the process can accept the reference as an input
parameter and then construct the RV message from the object. To
use the Java object, the Java Invoke 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 Invoke
activity that is mapped to the object reference of the object
®
containing the Rendezvous message.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Sequence Key
This field can contain an XPath expression that specifies which processes should
run in a sequence. Process instances with sequence keys that evaluate to the
same value, are executed sequentially in the sequence the process instance was
created.
Custom Job Id
This field can contain an XPath expression that specifies a custom job ID for the
process instance.
Output Editor
®
Use the Output Editor tab to define a custom schema for the body of the Rendezvous message.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Output
The following is the output of the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
273
Output Item
Datatype
Description
sendSubject
string
The subject of the received message.
replySubject
string
The reply subject of the Rendezvous message.
®
Rendezvous Request Reply
®
Rendezvous Request Reply is an asynchronous activity that publishes a Rendezvous message on the
specified subject with the specified message content. A reply to the message on the specified reply
subject and with the specified reply message content is received by this activity. 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.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Subject
Yes
The subject on which to publish the Rendezvous message. You
can override this value by specifying a subject on the Input tab.
Transport
Yes
The TIBCO Rendezvous transport parameters. These are
specified as a Rendezvous Transport shared configuration
resource.
Request Timeout
(msec)
Yes
The length of time to wait (in milliseconds) for a reply to the
®
Rendezvous message. If no reply is received in the specified
time limit, it returns an error.
Pre-register
Listener
Yes
When using TIBCO Rendezvous Certified Messaging (RVCM),
this field specifies the cmnames of the RVCM subscribers. The
sender can preregister 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
None
®
If this check box selected, the body of the Rendezvous request
and reply messages is sent as a single field named "xml". This
field is a byte array containing the body of the message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
274
Field
Needs Output
Filtration
Literal Value/
Process
Property/
Module
Property?
None
Description
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 saves memory, and consequently improves
performance.
This option is only valid when the XML Format
check box is not selected.
XML Compliant
Field Names for
Input
None
Specifies whether the field names of the input message should
be altered so that they comply with XML naming rules. Only
field names that do not comply with XML naming rules are
altered when this check box is not selected.
Select this check box if you want the field names to be
unaltered.
XML Compliant
Field Names for
Output
None
Specifies whether the field names of the outgoing message
should be altered so that they comply with XML naming rules.
Only field names that do not comply with XML naming rules
are altered when this check box is not selected.
Select this check box if you want the field names to be
unaltered.
Description
Provide a short description for the activity in this field.
Input Editor
®
In the Input Editor tab you can define custom schemas for the body of the outgoing Rendezvous
®
request and body of the incoming Rendezvous response.
Output Editor
®
In the Output Editor tab you can define custom schemas for the body of the outgoing Rendezvous
®
request and body of the incoming Rendezvous response.
Input
The following is the input for this activity.
Input Item
Datatype
Description
subject
string
The subject of the Rendezvous message.
®
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
275
Input Item
Datatype
Description
replySubject
string
The reply subject for this activity.
timeout
number
The amount of time to wait (in milliseconds) for a reply to the
®
Rendezvous message. If no reply is received in the given time
limit, an error is returned.
Output
The following is the output of this activity.
Output Item
Datatype
Description
ReplySubject
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.
Fault
The Fault tab lists the possible exceptions that can be thrown by this activity. See the Error Codes guide
for more information about error codes and the corrective action to take.
Fault
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.
Wait for Rendezvous Message
®
Wait for Rendezvous Message activity waits to receive a Rendezvous message with the specified
subject.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
Description
The name to be displayed as the label for the activity in the
process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
276
Field
Literal Value/
Process
Property/
Module
Property?
Description
Subject
Yes
The subject on which to listen for the Rendezvous message.
Transport
Yes
The Rendezvous transport parameters. These are specified as a
Rendezvous Transport shared configuration resource.
XML Format
None
If this check box is selected, the body of the incoming
®
Rendezvous message is expected to be a single field named
"xml". This field is a byte array containing the body of the
message.
®
®
TIBCO ActiveMatrix BusinessWorks automatically deserializes
the xml field and represents the message as a schema tree in
this activity’s output.
Needs Output
Filtration
None
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.
XML-Compliant
Field Names
None
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 naming rules are altered when you clear this
check box.
Select this check box to leave the field names unaltered.
Description
Provide a short description for the activity.
Event
The Event tab has the following fields.
Field
Description
Event Timeout (seconds)
A message may arrive before this activity is executed. This field
specifies the amount of time (in seconds) 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.
Activity Timeout (msec)
Specify the amount of time (in milliseconds) for an activity to wait
before it is executed.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
277
Output Editor
®
From the Output Editor tab you can define custom schemas for the body of the outgoing Rendezvous
®
request and body of the incoming Rendezvous response.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
Output
The Output tab has the following fields.
Output Item
Datatype
Description
sendSubject
string
The subject of the received message
replySubject
string
The reply subject of the Rendezvous message
®
Fault
The Fault tab lists the possible exceptions that can be thrown by this activity. See the Error Codes guide
for more information about error codes and the corrective action to take.
Fault
Thrown When..
ActivityTimedOutException
A timeout has been reached.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
278
REST and JSON
The activities of REST and JSON Palette can be used to invoke RESTful web services and expose
processes as RESTful web services. The activities in this group can also be used to convert data between
JSON format and XML format.
BW JSON Utils
BW JSON utils provide an easier way to create XML schema (XSD files) from JSON payload or SQL
statements.
Create XSD Schema from JSON payload
To create schema from an available JSON payload:
1. From the Project Explorer pane, right-click on the Schemas folder and click New > XML Schema
File from JSON Payload.
2. In the JSON to Schema Wizard, enter a schema file name in the Schema File Name field.
3. Enter the JSON payload, to be used during the conversion, in the JSON Sample field, and click
Next.
A validation error displays in TIBCO Business Studio if any values from the JSON payload
are not valid.
If the conversion is successful, the message JSON payload parsed successfully...Created
<Name>.xsd displays in the JSON to Schema Wizard window, and you can close the wizard.
schema
Create Schema from an SQL String
To create SQL schema, do the following:
1. In the Process package, click Resources > JDBC Connection Resource and verify whether the JDBC
connection is able to connect to the database successfully.
2. Right-click the fully configured JDBC Connection Resource > BW JSON Utils > Create Schema
from SQL.
3. In the SQL Query Builder, provide the query statement to fetch the required information and click
OK.
4. A "Schema has been
message is displayed.
created successfully under the Schemas folder with <Name>.xsd."
Invoke REST API
Invoke REST API asynchronous activity invokes RESTful web services and receives responses from the
service provider.
For the Invoke REST API activity to work, an HTTP Client shared resource is required. In the HTTP
Client shared resource, make sure Apache HttpComponents (Supported by HTTP and REST) is
selected as the Implementation Library in the HTTP Client section.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
279
Field
Module
Property
Name
No
The name to be displayed as the label for the activity in the
process.
HTTP Client
Yes
The HTTP client resource.
Resource Path
No
The resource of the REST service.
Description
Spaces and special characters are not supported in
the path and query parameter name.
HTTP Method
No
The REST methods used for the requests.
Select from one of the following available methods:
Request Type
Response Type
No
No
●
POST
●
GET
●
PUT
●
DELETE
●
PATCH
The value of the Content-Type header set while invoking the
REST operation.
●
JSON: the service provider returns the data in the JSON
format.
●
XML: the service provider returns the data in the XML
format.
●
Custom: to override the Content-Type value in the Input
tab, select CUSTOM and provide the value in the Input
tab.
The value of the Accept header set while invoking the REST
Operation.
●
JSON: the service provider returns the data in the JSON
format.
●
XML: the service provider returns the data in the XML
format.
●
Custom: to override the Accept header value in the Input
tab, select CUSTOM and provide the value in the Input
tab.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
280
Field
Description
Output HTTP Response
Headers
Request Entity Processing
This field has two values:
●
BUFFERED: the request entity is buffered in memory to determine
the content length that is sent as a Content-Length header in the
request.
●
CHUNKED: the entity is sent as chunked encoded (no ContentLength is specified, entity is streamed). The Transfer-Encoding
header is set to Chunked.
The default value is Chunked.
Input
The following is the input for the activity.
Input Item
Datatype
Message Body
asciiContent
Description
The body of the HTTP request message.
string
The ASCII content (ASCII content of the request like POST or
PUT to the server) of the request to the HTTP server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
281
Input Item
Datatype
Description
HttpHeaders
string
The header of the HTTP request. The 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 an HTTP request.
DynamicHeaders
complex
●
Accept: specifies the 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.
●
Accept-Charset: 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.
●
Accept-Encoding: specifies the content-coding values that
are acceptable for response messages. For example,
compress, gzip.
●
Content-Type: the media type of the entity body sent to
the receiver. Media types are described in the HTTP
specification.
●
Content-Length: indicates the size of the entity body sent
to the receiver.
●
Connection: the requestor can 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: See the HTTP specification for more information
about this field.
●
Pragma: is used to include implementation-specific
directives that might apply to the receiver. See the HTTP
specification for more information about using this field.
The dynamic header is an additional header parameter to
add runtime headers to the outgoing HTTP messages. The
DynamicHeaders consists of the following information:
●
Name: the name of the header
●
Value: the value of the header
Output
The Output tab has the following fields.
Output Item
Description
StatusCode
The HTTP Response Code.
ReasonPhrase
ReasonPhrase is intended for giving a short textual description of
StatusCode.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
282
Output Item
Description
mesageBody
The body of the response message. This is asciiContent.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown when...
HttpCommunicationException
An HTTP exception occurred when trying to execute the
specified method, or when trying to read the response.
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.
Support for Path and Query Parameters
Invoke REST API activity supports both Path and Query parameters. For Path Parameters, enclose
each path parameter in { } brackets. For example, if the resource path is set as /books/{isbn}, a
PathParameters element is added to the activity input.
Multiple path parameters can be defined in a similar way. The activity also supports static URL content
mixed with path parameters, for example, /books/{isbn}/events/{author}.
Query parameters are defined using the pattern /staticUrl?Param1&Param2.
A QueryParameters element is added to the Input tab of the activity with each of the parameter listed.
For example, if the resource path is set as /books?isbn&author, a QueryParamters element is added to
the activity input.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
283
Policy
Activities that support policies will display the Policy tab. To associate a new or existing policy with the
Invoke REST API activity, click the Add Policy to Activity
selected Policy
icon. To edit policy details, click Go to
icon. The Policy tab has the following fields.
Field
Description
Name
The name of the policy.
Type
The type of policy associated with the activity. The Invoke REST API activity
can support the Basic Credential Mapping policy.
Description
A description of the policy.
Restrictions on XML Schema
This topic lists the restrictions on XML Schema.
General Restrictions
●
No wildcards or attribute wildcards. For example, any element and any attribute is not supported.
●
Complex types may not contain both an attribute and a child element with the same local name.
●
Complex types may not be of the pattern "simple type plus attributes".
●
Complex types may not contain mixed content.
●
Attributes that are not part of the default(empty) namespace, cannot be used for Complex Elements.
●
The 'choice' and 'sequence' compositors may not have maxOccurs
'all' in the schema specification).
●
Substitution groups are not supported.
●
Element of simple type with an attribute is not supported.
●
The elementFormDefault can only be qualified for schemas used by REST binding and JSON
activities.
●
Schemas should not contain cyclic dependencies on other schemas
●
Schemas should not have a type that has two child members with the same local name, but different
namespaces.
> 1
(same as the restriction on
Restrictions on JSON
●
Arrays must have homogeneous content.
●
Arrays cannot directly contain arrays ( [ [ ... ], [ ... ] ] )
●
Null type properties throw the XSD schema conversion error in TIBCO Business Studio™. To create
a REST Service or REST Binding edit the input JSON file and change the data type from null to
string.
Not currently supported
●
Binary content in JSON as a special case
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
284
Parse JSON
Parse JSON activity takes the JSON data, processes it, and converts it into XML data.
General
The General tab has the following fields.
Field
Literal
Value/
Process
Property/
Module
Property
Description
Name
None
The name to display as the label for the activity in the process.
Schema Type
None
Specifies the mode for the output data. The following are the
supported schema types:
●
Generic: converts a JSON string to an XML string
●
XSD: converts a JSON string to an XML document defined
using a schema specified in the Output Editor.
The default value in this field is the XSD schema type.
Ensure the schema resource you select does not
contain cyclic dependencies on other schemas , or a
type that has two child members with the same local
name, but different namespaces.
Badgerfish
Input Json Style
Use Null For
Empty Values
None
None
None
Specifies the following conversion rules:
●
Select this check box for converting JSON data to XML data
with the mapping of XML namespace, XML attribute,
CDATA, and so on.
●
Do not select this check box if you want normal conversion
rules for mapping data from JSON to XML.
Specifies the method to parse the data.
●
None : Select this option to exclude the root element in the
Json string.
●
Json with Root : Select this option to include the root
element in the input Json string.
●
Anonymous Array : Select this option to accept a Json array
without the parent element, where the root element has
exactly one child of the type Array.
Select the check box to use null in the place of empty values in
the JSON. This option is applicable only for Objects and Arrays.
This has no effect on primitive types. By default, the check box
is not selected.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
285
Description
Provide a short description for the activity.
Output Editor
From the Output Editor you can define or reference an XML schema for the activity output. You can
use the BW JSON Utils tool to generate an XML schema file with a specified JSON file. Refer to BW
JSON Utils for more information.
Input
The Input tab has the following fields.
Field
Description
json string
The input JSON data for translation.
Output
The output for the Parse JSON activity varies depending on the data schema you specified in the
Schema Type field on the General tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown when...
JSONParserException
An exception occurred when parsing the JSON data.
Render JSON
Render JSON activity takes XML data and renders it as a JSON string.
General
The General tab has the following fields.
Field
Literal
Value/
Process
Property/
Module
Property
Name
None
Description
The name to be displayed as the label for the activity in the
process.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
286
Field
Literal
Value/
Process
Property/
Module
Property
Schema Type
None
Description
Specifies a schema type for the output data. The following are the
supported schema types:
●
Generic : converts an XML string to a JSON string
●
XSD : converts an XML string to a JSON document defined
using a schema specified in the Output Editor.
The default value in this field is the XSD schema type.
Badgerfish
Output Json
Style
Use Empty
Values For Null
None
None
None
Specifies the following conversion rules:
●
Select this check box for converting JSON data to XML data
with the mapping of XML namespace, XML attribute,
CDATA, and so on.
●
Do not select this check box if you want normal conversion
rules for mapping data from JSON to XML.
Specifies the method to render the data.
●
None : Select this option to exclude the root element in the
Json string.
●
Json with Root : Select this option to include the root element
in the input Json string.
●
Anonymous Array : Select this option to return a Json array
without the parent element, where the root element has
exactly one child of the type Array.
Select the check box to use empty values in the place of null in
JSON. This option is applicable only for Objects and Arrays. This
has no effect on primitive types. By default, the check box is not
selected.
Description
Provide a short description for the activity.
Input Editor
From the Input Editor tab, you can define or reference an XML schema for the activity input. You can
also use the BW JSON Utils tool to generate an XML schema file with a specified JSON file. See BW
JSON Utils for more information.
Input
The input data for the Render JSON activity is in the XML format. The schema type of the XML data
varies depending on the schema type you specified in the Schema Type field on the General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
287
Output
The Output tab contains the following field.
Field
Description
jsonString
The translated data in JSON string format.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more information
about error codes and the corrective action to take.
Fault
Thrown when...
JSONRendererException
An exception occurred when rendering the data.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
288
Policy Resources
Policies are resources which you can define and configure in TIBCO Business Studio. You can define a
policy and then reference it from multiple activities or binding in the same or different process. For
example, you can define a Basic Authentication policy, and refer to the policy from an HTTP Receiver
Activity in one process and a Send HTTP Request Activity in a separate process.
Basic Authentication Policy
Applying this policy ensures that users cannot access your application unless their credentials are
verified.
Basic Authentication
The Basic Authentication policy resource provides options you can configure when you set up a basic
authentication security policy.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
Service Provider Details
The service provider you select authenticates user name and password credentials. The Service
Provider Details section has the following fields.
Field
Description
Select
Authentication
Type
Select a way to authenticate user credentials:
●
LDAP Authentication
●
XML File Authentication
LDAP Resource
Create a new LDAP Authentication resource, or specify an existing LDAP
Authentication resource. The Basic Authentication policy references the
LDAP Authentication resource you select.
XML File Resource
Create a new XML Authentication resource, or specify an existing XML
Authentication resource. The Basic Authentication policy references the XML
Authentication resource you select.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
289
Basic Credential Mapping
Configure the Basic Credential Mapping policy resource to set up a basic credential mapping security
policy.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
Credential Mapping
You can choose to enforce either Fixed credential mapping or Conditional credential mapping.
Fixed
Select this option to ensure that a fixed set of credentials is applied to all users regardless of their user
type or role. The Fixed section has the following fields:
Field
Description
Identity Provider
Select an Identity Provider to authenticate user credentials
Conditional
Select Conditional credential mapping to enforce credential mapping for authenticated users and
anonymous users. Credentials are mapped for authenticated users if the request comes from an
authenticated service. Credentials are mapped for anonymous users if the request comes from an
unathenticated service.
The Conditional section has the following fields:
Field
Description
Role based Identity
Providers
Type roles for authenticated users and associate an Identity Provider with
each role. You can reuse the same Identity Provider for multiple roles.
Authenticated
Identity Provider
Select an Identity Provider shared resource for authenticated users.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
290
Field
Description
Anyonymous
Identity Provider
To allow anonymous users access to your secure application, specify an
Identity Provider. To not allow anonymous users access, do not specify an
Identity Provider .
Application logic can also affect how credentials are mapped for
anonymous users. For example, application logic might dictate that
anonymous requests are redirected to specific entry points. If an
anonymous request is directed to an enforced entry point, the
request is rejected.
WSS Consumer
Configure the WSS Consumer policy to enforce confidentiality, integrity, and timestamping, and
credential mapping.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A description of the policy resource.
Shared Resource for WSS Processing
The Shared Resource for WSS Processing section has the following fields.
Field
Description
WSS
Authentication
The WSS Authentication shared resource that the WSS Consumer policy
references.
Service Provider Details
The Service Provider Details section comprises of the Confidentiality tab, the Integrity tab, the
Timestamp tab, and the Credential Mapping tab.
Confidentiality
To maintain confidentiality, the policy can be configured for an outbound request to be encrypted and
an inbound response to be decrypted at its endpoint. The Confidentiality tab has the following fields:
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
291
Field
Description
Encrypt Request
Specify the following fields:
1. Trust Provider: Select a Trust Provider shared resource.
2. Key Alias: Specify a Key Alias.
3. Algorithm Suite: Specifies the algorithm suite required for performing
cryptographic operations with symmetric or asymmetric key based
security tokens. An algorithm suite specifies actual algorithms and
allowed key lengths. The default selection is Basic128. You can select a
different algorithm suite from the drop-down menu.
4. Encrypt: Specify to Encrypt Parts or to Encrypt Elements of the message.
Decrypt Response
a.
Encrypt Parts: Select this option to encrypt the Body, Header, or both
parts of the message.
b.
Encrypt Elements: Select this option to encrypt elements in the
request message. When specifying the Element, ensure you also
specify the Namespace of the element, and Prefix of the element if it
has one.
No additional configuration required.
Integrity
To maintain integrity, the outbound request can be signed and the signature verified in the inbound
response. The Integrity tab has the following fields:
Field
Description
Sign Request
Specify the following fields:
1. Subject Provider: Select a Subject Provider shared resource.
2. Digest Algorithm for Signature: The algorithm takes as input a message
of arbitrary length and produces as output a 128-bit "fingerprint" or
"message digest" of the input. Default type is SHA-256. You can select a
different type from the drop-down menu.
3. Algorithm Suite: Specifies the algorithm suite required for performing
cryptographic operations with symmetric or asymmetric key based
security tokens. An algorithm suite specifies actual algorithms and
allowed key lengths. Default type is Basic128. You can select a different
algorithm suite from the drop-down menu.
4. Sign: Specify to Sign Parts or to Sign Elements.
a.
Sign Parts: Select this option to sign the Body, Header, or both parts
of the message.
b.
Sign Elements: Select this option to sign elements in the request
message. When specifying the Element, ensure you also specify the
Namespace of the element, and Prefix of the element if it has one.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
292
Field
Description
Verify Signature on
Response
Select from the following options from the drop-down menu Verify parts that
are signed :
1. Entire message
2. Message header
3. Message body
Timestamp
Under the Timestamp tab, configure the following fields to insert a timestamp in an outbound request
and verify a timestamp in the inbound response.
Field
Description
Set Timestamp on
Request
Specify time-to-live in seconds.
Verify Timestamp
on Response
No additional configuration required.
Credential Mapping
Under the Credential Mapping tab, select either Username Token credential mapping or SAML Token
credential mapping to map credentials to the outbound request.
Field
Description
No Credentials
Select this option to ensure credential mapping is not enforced.
Username Token
based Credential
Mapping
Select Fixed or Conditional:
●
If you select Fixed, specify an Identity Provider resource in the Identity
Provider field.
●
If you select Conditional, specify the types of users your application will
map credentials for. You can choose to map credentials for authenticated
users with roles, authenticated users, and anonymous users. Refer to Basic
Credential Mapping for configuration details. .
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
293
Field
Description
SAML Token based
Credential
Mapping
Configure the following fields:
1. SAML Token Profile: Select a token type. Specify either SAML 1.1 Token
1.1 or SAML 2.0 Token 1.1 .
2. Sign SAML Assertion: If you select this option, specify a Subject
Provider, a Digest Algorithm for Signature, and an Algorithm Suite.
3. SAML Issuer Name: Type a SAML issuer name.
4. SAML Assertion Validity: Select SAML Assertion Validity (forever) to
ensure that the SAML assertion is valid indefinitely. Optionally, you can
select Specify Validity Period (sec) to specify the number of seconds the
SAML assertion is valid .
WSS Provider
The WSS Provider policy acts on the server side to ensure that the confidentiality, integrity, and
timestamp of a request remains secure.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
Shared Resource for WSS Processing
The Shared Resource for WSS Processing section has the following fields.
Field
Description
WSS
Authentication
The WSS Authentication shared resource that the WSS Provider policy
references.
Service Provider Details
The Service Provider Details section comprises of the Authentication tab, Confidentiality tab, the
Integrity tab, and the Timestamp tab.
Authentication
The Authentication tab has the following fields that you can enable to enforce authentication on a
request message.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
294
Field
Description
No Verification
Select this option to ensure that credentials are not authenticated through
user name token or SAML token.
Verify username
token
Select this option to authenticate user credentials through user name token. If
you select this option, ensure you have configured the User Authentication
tab on the WSS Authentication Shared Resource.
Verify SAML token
Select this option to authenticate user credentials through SAML token.
Select one of the following confirmation methods:
1. Bearer
2. Holder of Key
3. Sender Vouches
Select one of the following security token types:
1. SAML 1.1 Token 1.1
2. SAML 2.0 Token 1.1
Specify Issuer Name
Confidentiality
An inbound request can be decrypted and an outbound response can be encrypted to maintain
confidentiality. The Confidentiality tab has the following fields:
Field
Description
Decrypt Request
No additional configuration required.
Encrypt Response
Specify the following fields:
1. Trust Provider: Select a Trust Provider shared resource.
2. Key Alias: Specify a Key Alias.
3. Algorithm Suite: Specifies the algorithm suite required for performing
cryptographic operations with symmetric or asymmetric key based
security tokens. An algorithm suite specifies actual algorithms and
allowed key lengths. The default selection is Basic128. You can select a
different algorithm suite from the drop-down menu.
4. Encrypt: Specify to Encrypt Parts or to Encrypt Elements of the message.
a.
Encrypt Parts: Select this option to encrypt the Body, Header, or both
parts of the message.
b.
Encrypt Elements: Select this option to encrypt elements in the
response message. When specifying the Element, ensure you also
specify the Namespace of the element, and Prefix of the element if it
has one.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
295
Integrity
Maintain integrity by verifying the signature on an inbound request and signing an outbound response.
The Integrity tab has the following fields:
Field
Description
Verify Signature on
Request
Select from the following options from the drop-down menu Verify parts that
are signed :
1. Entire message
2. Message header
3. Message body
Sign Response
Specify the following fields:
1. Subject Provider: Select a Subject Provider shared resource.
2. Digest Algorithm for Signature: The algorithm takes as input a message
of arbitrary length and produces as output a 128-bit "fingerprint" or
"message digest" of the input. Default type is SHA-256. You can select a
different type from the drop-down menu.
3. Algorithm Suite: Specifies the algorithm suite required for performing
cryptographic operations with symmetric or asymmetric key based
security tokens. An algorithm suite specifies actual algorithms and
allowed key lengths. Default type is Basic128. You can select a different
algorithm suite from the drop-down menu.
4. Sign: Specify to Sign Parts or to Sign Elements of the message.
a.
Sign Parts: Select this option to sign the Body, Header, or both parts
of the message.
b.
Sign Elements: Select this option to sign elements in the response
message. When specifying the Element, ensure you also specify the
Namespace of the element, and Prefix of the element if it has one.
Timestamp
To track the time of the request, a timestamp is inserted in the request. The Timestamp tab has the
following fields:
Field
Description
Verify Timestamp
on Request
No additional configuration required.
Set Timestamp on
Response
Specify the time-to-live in seconds.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
296
Shared Resources
Shared resources are used to define a resource that contains configuration data that can be referenced
from multiple processes.
You can define a shared resource and then reference it from multiple activities in the same or different
process. For example, you can define a JDBC Connection resource and then use it in any of the JDBC
activities in your process to connect to the database.
Shared resources such as JDBC Connection, JMS Connection, HTTP Connection, and so on are
available at design-time. At runtime, the referencing activities and event sources have full access to
their instances and configuration. Shared resources can be grouped in packages, similar to the way
process packages and Java packages are presented in the file system.
When defined in an application module, shared resources are not visible outside the application
module. However, when defined in a shared module, they are visible outside the shared module.
For more information refer to "General Concepts" in the Concepts guide.
Data Format
The Data Format shared resource contains the specification for parsing or rendering a text string using
the Parse Data and Render Data activities. This resource specifies the type of formatting for the text
(delimited columns or fixed-width columns), the column separator for delimited columns, the line
separator, the fill character, and field offsets for fixed-width 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. The following figure illustrates
how an input text string is parsed into a specified data schema.
Parsing a Text String into a Data Schema
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 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
297
Data Format Editor
This editor contains General, Data Format Configuration, Data Format Editor, and Field Offsets
sections.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the data format.
Data Format Configuration
You can define the structure of the data file using the Data Format Configuration.
Field
Description
Format Type
The Type of formatting for the text. The text can be either Delimiter separated or
Fixed format.
When you select the Delimiter separated option, the text in 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.
When Fixed format option is selected, the text in 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.
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 ":;" displays
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
rules specified in the Col Separator Parse Rule field to determine how to parse the
data.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
298
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 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 specified as a potential column separator
Any of the characters will act as a column separator. For example, if the
specified Col Separator is ":;" Apple;Orange:Pear is treated as three columns.
Line
Separator
Specifies the character(s) that determine the end of each line. Available Line
Separator characters are:
●
New Line
●
Carriage Return
●
Carriage Return/Line Feed(windows)
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.
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 field is only available
when you select the Fixed format option in the Format Type field. The fill character
is used only by the Render Data activity.
You can select any one from the following available options:
●
Space: fills with a space
●
Dash: fills with a dash
●
Others: 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.
Data Format Editor
You can define a custom schema for the text in the Data Format Editor. You can define your own
datatype here. After defining the data type, the data specified here is used to parse a text string into the
specified schema or render the specified schema as a text string. The Header element contains the
following:
●
@attribute
●
(any element)
●
primitive
●
(any element)
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
299
Field Offsets
When processing fixed format text, you must specify the line length and the column offsets. This
enables the Parse Data or Render Data activity to determine where columns and lines begin and end.
You can specify the format of fixed-width text using the Field Offsets.
The line length is the total length of input lines, including the line separator characters. Include the
appropriate number of characters for the selected line separator in the Data Format Configuration to
the total length of each line.
The column offset is the starting and ending character position on each line for the column. Each line
starts at 0 (zero). For each column of the line, you must specify the name of the data item associated
with this column(this is the same name you specified for the corresponding elements in the data
schema), the starting offset for the column, and the ending offset for the column.
Each column offset can begin where the last column offset ended. Many fixed format data files are used
by databases or are generated by automated processes. These files have rigid file record formats and
may not have additional padding space between the columns. When you define each column offset to
begin where the last column offset ends, you can read the data more quickly. This is because you can
read sequentially the bytes of the input reords.
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
01234567890123456789012345678901234567890123456789012345678
57643
Smith
Chris
Account
57644
Jones
Pat
Marketing
57645
Walker
Terry
Development
Delimeter 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.
In some situations, you may not be able to choose a column separator character that does not display 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 (" "). You can also use double quote to include
leading and trailing spaces as well as line breaks in a field. If you want to display a double quote 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 , "State: 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", Development, "Statement: May goal si 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.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
300
FTL Realm Server Connection
The FTL Realm Server Connection shared resource describes the connection parameters for connecting
to a Realm server and creation of the Realm object to be used by the FTL palette activities. Use this
shared resource when configuring activities in the FTL palette.
Ensure you have installed FTL client libraries. Refer to "Integrating with TIBCO FTL" in the Installation
guide for additional details.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the resource package.
Name
The name to be displayed as the label for the resource.
Description
A short description of the resource.
FTL Realm Server Connection Configuration
This section has the following fields.
Field
Literal
Value/
Module
Property
Description
FTL Realm Server URL
Yes
The URL of the FTL realm server.
FTL Secondary Realm
Server URL
Yes
The URL of the backup FTL realm server.
FTL Application Name
Yes
The name of the FTL application, which includes a set of
endpoints and formats as configured in the realm server.
The Browse button can be used to browse the FTL
applications defined on the Realm server.
FTL Application
Instance ID
Yes
The ID of the FTL application instance.
Username
Yes
The username of the FTL realm server.
Password
Yes
The password of the FTL realm server.
Realm Server Trust File
Yes
Provide the path to the ftl-trust.pem file that is located
in the ftl-rs folder. For more details about the trust file
that is generated, refer to the Trust File topic in the TIBCO
FTL® Administration guide.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
301
Test Connection
When you click the Test Connection button, the activity connects to the remote FTL Realm server on
the specified port using the specified username and password. You can use this button to determine
whether the specified connection configuration is correct.
FTP Connection
FTP Connection shared resource describes a connection to an FTP server. Use the FTP connections
when configuring activities in the FTP palette.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the activity.
FTP Connection
This section has the following fields.
Field
Literal
Value/
Module
Property?
Description
Host
Yes
The host name or IP address of the FTP server.
Port
Yes
The 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
Yes
The user name to use when logging into the FTP server.
Password
Yes
The password to use when logging into the FTP server.
Mode
Yes
Specify whether you want to use Active or Passive mode to
connect to the FTP server.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
302
Field
Connection
Timeout (msec)
Literal
Value/
Module
Property?
Yes
Description
The timeout specified in this field (in milliseconds) applies to
the following scenarios:
●
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 the data sockets
The default is 60000 milliseconds.
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.
Remote Filename
Encoding
None
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 engine
is running.
Firewall
Yes
Specifies whether the FTP host resides outside of a firewall.
Selecting this checkbox enables the Proxy Host, Proxy Port,
and Proxy User Name fields. If this check box is selected, 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 required.
Proxy Host
Yes
Specifies the host name or IP address of the firewall server.
This is used when the remote FTP server is outside of a
firewall.
Proxy Port
Yes
Specifies the port number of the firewall server. This is used
when the remote FTP server is outside of a firewall.
Proxy User Name
Yes
Specifies the user name to use to connect to the proxy server, if
necessary. This is used when the remote FTP server is outside
of a firewall.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
303
Field
Literal
Value/
Module
Property?
Proxy Password
Yes
Description
Specifies the password to use for the specified user name when
connecting to the proxy server, if necessary. This is used when
the remote FTP server is outside of a firewall.
Test Connection
When you click the Test Connection button, the activity 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 whether the specified connection configuration is correct.
Available Commands
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. Use this button to determine the available commands on
the remote FTP server before attempting to execute them with the FTP Quote activity.
Security
Select the Confidentiality check box to display the SSL Client field.
Field
Description
SSL Client
The name of the resource.
In the SslClientResource Resource Template wizard, create a resource to
connect to the SSL client.
HTTP Client
The HTTP Client resource template represents an outgoing HTTP connection.
General
The General section has the following fields.
Field
Description
Package
The name of the package
Name
The name to be displayed as the label for the resource
Description
A short description of the shared resource
HTTP Client
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
304
Field
Implementation
Library
Literal Value/
Module
Property?
Description
No
Specifies the implementation library to be used:
●
Apache Commons(Supported by HTTP and SOAP): must
be used for SOAP binding.
●
Apache HttpComponents(Supported by HTTP and REST):
must be used for REST binding, when the Invoke REST API
activity needs to be used.
The default is Apache Commons(Supported by HTTP and
SOAP).
The HTTP palette activities work with both Apache
Commons and Apache HttpComponents.
Basic credential mapping is not supported with the Apache
Commons(Supported by HTTP and SOAP) library. To enforce
basic credential mapping on REST or HTTP activities, you must
select Apache HttpComponents(Supported by HTTP and
REST) library.
Disable
Connection
Pooling
Yes
Maximum Total
Connections
Yes
Indicates whether to use the single or multi-threaded
connection manager.
The default value is False.
Specifies the maximum number of concurrent, active HTTP
connections allowed by the resource instance to be opened with
the target service. This property is enabled only if connection
pooling is enabled (the Disable Connection Pooling parameter is
unchecked).
The default value is 200. For applications that create many longlived connections, increase the value of this parameter.
Idle Connection
Timeout(ms)
Yes
Keep-alive time (in milliseconds) for idle HTTP connection in
the Persistent Connection Pool.
Maximum Total
Connections Per
Host/Route
Yes
Specifies the maximum number of concurrent, active HTTP
connections allowed by the resource instance to the same host
or route. This property is enabled only if connection pooling is
enabled (the Disable Connection Pooling parameter is
unchecked).
This number cannot be greater than Maximum Total
Connections. Every connection created here also
counts into Maximum Total Connections.
The default value is 20.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
305
Field
Literal Value/
Module
Property?
Stale Check
Yes
Selecting this check box determines whether the stale
connection check is to be used. Disabling the stale connection
check can result in slight performance improvement at the risk
of getting an I/O error, when executing a request over a
connection that has been closed at the server side.
Default Host
Yes
The name of the host that accepts the incoming requests.
Description
For machines that have only one network card, the default value
localhost specifies the current machine. For machines with
more than one network card, this field specifies the host name
of the card used to accept the incoming HTTP requests.
The default is localhost.
Default Port
Yes
The port number on which to invoke outgoing HTTP requests.
The default is 80.
Cookie Policy
No
Specifies the Cookie Policy to use:
Ensure you have selected Apache HttpComponents
(Supported by HTTP and REST) as the
Implementation Library when selecting a Cookie
Policy.
●
BROWSER_COMPATIBILITY: Choose this option to select
a cookie policy that is compatible with the common cookie
management practices, including those that are not fully
standards compliant.
●
NETSCAPE: Select this option to use the Netscape cookie
draft compliant policy. When you select this option, Cookie2
headers are not sent in the request message.
●
RFC_2109: Select this option to use the RFC2109 compliant
policy. This policy is supported for HTTP palette activities.
If this policy is selected for the Invoke API
activity or the REST Reference Binding, the
BEST_MATCH policy is selected instead.
●
IGNORE_COOKIES: Select this option if cookies sent by
the server need be disabled.
●
BEST_MATCH: This is the default selection. Select this
option to choose the BEST_MATCH Cookie Policy.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
306
Field
Literal Value/
Module
Property?
Description
Thread Pool
No
Specifies a queue of threads available to run a queue of tasks.
Thread pools are used to improve performance when executing
large numbers of asynchronous tasks by reducing per task
invocation overhead, provide a means of bounding, and
managing the resources consumed when executing a collection
of tasks.
You can optionally create this client thread pool to route
messages to the target service. The thread pool resource can be
created by either selecting a thread pool resource template or
creating a new one. See Thread Pool for more information.
Advanced
This section has the following fields.
Field
Literal Value/
Module
Property?
Socket Timeout
Yes
Description
Specifies the number of milliseconds to wait for data before the
connection is severed.
The value 0 is interpreted as an infinite timeout and is used
when no socket timeout is set in the HTTP method parameters.
Connection
Timeout
Yes
Specifies the number of milliseconds to wait while a connection
is being established.
The value 0 is interpreted as no timeout.
Accept Redirect
Yes
Indicates whether the HTTP method should automatically
follow HTTP redirects.
This option is used when client connection receives the redirect
responses from server like Moved Permanently, Moved
Temporarily, Temporary Redirect and so on.
The default value is False.
Retry Count
Yes
Specifies the maximum number of retry attempts for connecting
to the server if an exception occurs.
The default value is 3.
Use Single
Cookie Header
Yes
Select this check box if multiple name/value pairs must be sent
in a single non-repeating Cookie header element for outgoing
HTTP requests.
The default value is False.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
307
Field
Literal Value/
Module
Property?
Description
Use NonPreemptive
Authentication
Yes
Select this check box if you want to use non-preemptive
authentication.
Log Request/
Response Time
Yes
Select this check box to log the time required for sending and
receiving the HTTP response in the Send HTTP Request
activity.
HTTP Proxy
No
Specifies the HTTP proxy server to be used to gain access
outside of a firewall. The Proxy Configuration shared
configuration resource specifies the configuration of the proxy
server. See Proxy Configuration for more information.
Security
Security can include any combination of the following characteristics:
Field
Description
Authentication
To be included when the messages must be authenticated. Authentication
can be performed with user names and passwords.
Identity Provider : Provides user name and password credentials
encapsulated in an identity provider resource. Selecting this check box
activates the Identity Provider field.
You can enforce authentication on requests by selecting the
Authentication check box, or by associating the Basic Credential
Mapping policy with REST or HTTP activities. If you choose to
use the policy, ensure the Authentication check box on the HTTP
Client resource is not selected.
Kerberos
Authentication
Selecting this check box will enable Kerberos Authentication.
Kerberos Authentication requires a few additional configurations. See the
section "Kerberos Authentication Configuration" for more information on
these configurations.
Kerberos authentication is not supported with the Apache
Commons(Supported by HTTP and SOAP) library. To enforce
Kerberos authentication on REST binding, you must select Apache
HttpComponents (Supported by HTTP and REST) library.
Username
Enter the Active Directory user name to be used for the Kerberos
authentication.
This field is enabled only when the Kerberos Authentication field is
selected.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
308
Field
Description
Password
Enter the password for the specified user name.
This field is enabled only when the Kerberos Authentication field is
selected.
Default
Confidentiality
Select the check box when encrypting or decrypting messages.
Selecting this check box will enable the SSL with default configuration. For
details, refer to SSL Client Configuration.
If you select Default Confidentiality, there is no need to create a
shared resource. SSL is enabled with Default Configuration. If
custom configurations for SSL are required, select Confidentiality.
When using Default Confidentiality ensure that the correct root
certificates are present at the <TIBCO_HOME>
\tibcojre64\1.8.0\lib\security\cacerts trust store.
Confidentiality
Select the check box when encrypting or decrypting messages.
Selecting this check box displays the SSL Client Configuration field. For
details, refer to SSL Client Configuration.
Kerberos Authentication Configuration
The krb5.conf and login.conf files are present under the config folder at the location,BW Home/
config. We recommend that the configurations in the login.conf file should not be changed.
However, values in the krb5.conf file can be changed according to the Kerberos environment you are
working in.
You can configure the following values in the krb5.conf file:
●
libdefaults
●
realms
●
domain_realm
Persistent Connections
Persistent connections maintain a pool of connections that can be reused by Send HTTP Request
activities to avoid opening and closing the connection. Persistent Connection Manager is created by
HTTP Client shared resource. Hence, each HTTP Client shared resource has its own persistent
connection pool.
A Send HTTP Request activity requires a connection to the HTTP server. The activity exclusively uses
the connection until the HTTP server sends the response message. If you have many process instances
connecting to a HTTP server, each Send HTTP Request activity opens a connection, holds the
connection until the activity completes, and then closes the connection. Opening and closing a large
number of connections causes a significant overhead. Persistent connections play a significant role in
such scenarios.
Not all HTTP servers support the use of persistent connections. To determine whether the HTTP server
supports the use of persistent connections, read the documentation of that HTTP server.
Using persistent connection manager you can specify the total number of connections and the
maximum number of connections per HTTP server. The total number of connections signify the
aggregate connections to all HTTP servers handled by that connection pool.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
309
HTTP Connector
HTTP Connector resource describes the characteristics of the connection used to receive incoming
HTTP requests. This resource is used when the process requires an HTTP request on a specific port
where the HTTP server is running. For example, the process starter HTTP Receiver and the signal-in
Wait for HTTP Request activity receiving HTTP requests.
There can be only one process with an HTTP Receiver or Wait for HTTP Request activity that uses the
same HTTP Connection resource. With this restriction the HTTP server listening for the incoming
requests dispatches the request to the correct process.
General
The General section has the following fields.
Field
Module
Property
Description
Package
No
The name to be displayed as the label of the resource package.
Name
No
The name to be displayed as the label for the resource.
Description
No
A short description of the activity.
Basic Configuration
The Basic Configuration section has the following fields.
Field
Module
Property
Host
Yes
Description
Do not change the value for this property. By default, it
is set to the BW.HOST.NAME module property.
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
listen for incoming HTTP requests on the specified port.
When using local host for the system property, use the full name
of your machine as the host in the client.
You can start more than one HTTP server on a single
port by using Context and Path fields on HTTP
Receiver and Wait for HTTP activities. Ensure that
you use a different port, if different Context or Path
are not specified.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
310
Field
Module
Property
Port
Yes
Description
Specifies the port number on which to listen for incoming HTTP
requests.
Do not use port 7777. It is reserved for internal use.
Accept Queue
Size
Yes
Specifies the number of connection requests to be queued before
the operating system starts sending rejections. The default values
are: -1 and 0.
These default values signify that the queue size is 50 or OSspecific.
Acceptor
Threads
Yes
Specifies the number of acceptor threads. Acceptor threads are
HTTP socket threads for an HTTP connector resource that accept
the incoming HTTP requests.
The default value is 1.
Advanced Configuration
The Advanced Configuration section has the following fields.
Field
Module
Property
Description
Header Buffer Size
(B)
Yes
Specify to set the size of the buffer for request headers. An idle
connection at most has one buffer of this size allocated. The
default is 4K.
Use Non-Blocking
IO Sockets
Yes
Select this check box to use non-blocking threading model for
NIO buffers.
Use this connector when there are many connections with idle
periods. The default is true.
Request Buffer
Size (B)
Yes
Specify to set the size of the content buffer for receiving
requests. These buffers are used only for active connections
that have requests with bodies that do not fit within the header
buffer. The default is 8K.
Use Direct Buffers
Yes
Specify to determine whether direct byte buffers are used or
not. The default is True.
Response Buffer
Size (B)
Yes
Specify to set the size of the content buffer for sending
responses. These buffers are used only for active connections
that are sending responses with bodies that will not fit within
the header buffer. The default is 24K.
URI Encoding
Yes
Specifies the character encoding used to decode the URI bytes.
If you do not set any value for uriEncoding, the default UTF-8
is used.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
311
Field
Max Idle Time
(ms)
Module
Property
Yes
Description
Specify to set the maximum idle time for a connection. The
Max Idle Time is applied in the following cases:
●
When waiting for a new request to be received on a
connection; when reading the headers and content of a
request
●
When writing the headers and content of a response
Jetty interprets this value as the maximum time between the
progress made on the connection. The timeout is reset if
implemented by jetty if a single byte is read or written.
Enable DNS
Lookups
Yes
Selecting this check box 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 the throughput. This
check box is not selected as default. Select this check box only
when required.
The default is False.
Low Resource Max
Idle Time (ms)
Yes
Compression
Yes
Specifies to set the period in ms for the connection to be idle.
This results in the server rapidly closing idle connections to
gracefully handle high load situations.
Specifies if the output of the HTTP Connection is compressed
using the HTTP/1.1 GZIP compression.
The acceptable values for this field are: True or False
The default is False.
Linger Time (ms)
Yes
Specifes to set the LINGER_TIME on the connection socket.
This setting affects only the close connection socket.
Compressible
Mime Types
Yes
Specifies the list of MIME types for which HTTP compression
may be used. The default value for this comma separated list
istext/html, text/xml, text/plain.
Session Timeout
(s)
Yes
The timeout (in seconds) for the HTTP session to expire after
inactivity.
Max Post Size
Yes
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.
Reverse Proxy
Host
Yes
Specifies the name of the reverse proxy host that accepts the
incoming requests.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
312
Field
Module
Property
Max Save Post Size
Yes
Description
Specifies the maximum size in bytes of the POST that the
container can save/buffer during FORM or CLIENT-CERT
authentication.
●
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.
●
CLIENT-CERT authentication: the request message is
buffered for the entire duration of the SSL handshake. After
processing the request, the buffer is emptied.
However, in both the cases the buffering happens before the
user authentication. 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.
Reverse Proxy Port
Yes
The reverse proxy port number on which to listen for the
incoming HTTP requests.
Minimum QTP
Threads
Yes
The Queued Thread Pool (QTP) uses the default job queue
configuration to The QTP threads accept the requests from the
acceptor threads.
This field specifies the minimum number of QTP threads
available for the incoming HTTP requests. The HTTP server
creates the number of threads specified by this parameter
when it starts up. The default value is 10.
Maximum QTP
Threads
Yes
Enable Access
Logs
Yes
Select the Enable Access Logs check box to print the HTTP
access logs.
Disable HTTP
Methods
Yes
Disable specific HTTP methods by adding the required
methods to the field list.
This field specifies the maximum number of threads available
for the incoming HTTP requests. The HTTP server does not
create more than the number of threads specified by this
parameter. The default value is 75.
To add a method to the list, click the Add icon
. To remove
a method from the list, select the required method and click the
delete icon
.
The first time you click the Add icon
, by
default the TRACE method is selected and added to
the list of methods to be disabled.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
313
Field
Share Across
Applications
Module
Property
Yes
Description
Select the Share Across Applications check box to share the
same HTTP Connector shared resource across several
application modules.
This check box is applicable if the HTTP Connector
shared resource is present in the shared module. It
will not be applicable if the HTTP Connector shared
resource is present in the application module.
Security
Security can include any combination of the following characteristics:
Field
Description
Confidentiality
To be included when encrypting or decrypting the messages.
Selecting this check box displays the SSL Server Configuration field. Use
this field to specify the SSL parameters for the HTTP Connector shared
resource. For details, refer to SSL Server Configuration.
Imported projects display the Authentication check box under the Security section if the check box was
selected in a previous version ActiveMatrix BusinessWorks™ 6.x. Authentication remains enabled on
the HTTP Connector resource if you do not clear the check box. If you clear the Authentication check
box, a warning message is displayed prompting you to confirm your action. To remove authentication
from the resource, click OK.
Once you have removed authentication from the resource, you can reapply it using the Basic
Authentication policy. For additional details, refer to the section "Enforcing Basic Authentication" in the
Application Development guide.
Identity Provider
Identity Provider shared resource provides user name and password credentials.
General
The General section has the following fields.
Field
Description
Name
The name of a Identity Provider shared resource.
Description
A short description of the shared resource.
Identity Provider
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
314
Field
Description
Username
Enter a user name.
Password
Enter a password.
JDBC Connection
JDBC Connection resource describes a JDBC connection. JDBC connections are used when specifying
activities from the JDBC palette.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the shared resource
Description
A short description of the shared resource
JDBC Connection
This section has the following fields.
Field
Literal
Value/
Module
Property?
Description
Connection Type
None
Specifies the kind of JDBC connection you want to create.
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.
Login Credentials
Yes
The user name used to connect to the database.
The password used to connect to the database.
JDBC Drivers
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
315
Field
Literal
Value/
Module
Property?
Database Driver
Yes
Description
The name of the JDBC driver class. If you select a supported
driver from a list of supported drivers, the Database URL
field is populated with a template for the URL of the driver.
The following drivers are packaged:
●
PostgreSQL
●
Microsoft SQL Server
In addition, the JDBC palette also supports the MySQL,
Oracle, and DB2, and MariaDB database.
When editing this field, you can also specify for the JDBC
Palette to use a custom JDBC driver. For instructions on how
to do this, refer to the section Using Custom Drivers.
Custom drivers must be compliant with the JDBC
4.0 API Specification.
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 (<>).
Login Timeout
Yes
The length of time (in seconds) to wait for a successful
database connection.
Only JDBC drivers that support connection timeouts can use
this field. If the JDBC driver does not support connection
timeouts, the value of this field is ignored. Most JDBC drivers
support connection timeouts.
Test Connection
Click the Test Connection button to test whether the specified configuration fields result in a valid
connection to a database.
Installing Supported Drivers for Run Time
If you want to use other databases, other than PostgreSQL or Microsoft SQL Server, you must add them
separately. This is a one time process for every installation of ActiveMatrix BusinessWorks ™. Open the
README.txt in the respective database shells at BW_HOME/config/drivers/shells/ for details on
what JAR files to download, and where to add them.
To add the drivers at run time for Oracle, MySQL, DB2, or MariaDB, run the bwinstall command from
BW_HOME/6.x/bin. Ensure that you run bwinstall with no arguments to access the help and
instructions to add the driver to the run time.
The script creates driver bundles and adds it to that specific ActiveMatrix BusinessWorks ™
environment. Any AppNodes that are created and started in that ActiveMatrix BusinessWorks ™
environment include the drivers automatically.
Since the drivers are part of the system and not part of each application, all the applications on a
particular AppNode use the same drivers. However, this is not true for AppSpaces. The drivers belong
to an AppNode and not an AppSpace.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
316
Supported Drivers
The following database drivers are supported:
●
com.mysql.jdbc.Driver
●
orga.postgresql.Driver
●
oracle.jdbc.OracleDriver
●
com.microsoft.sqlserver.jdbc.SQLServerDriver
●
com.ibm.db2.jcc.DB2Driver
●
org.mariadb.jdbc.Driver
The following Data Direct Drivers are supported:
●
tibcosoftwareinc.jdbc.postgresql.PostgreSQLDriver
●
tibcosoftwareinc.jdbc.mysql.MySQLDriver
●
tibcosoftwareinc.jdbc.sqlserver.SQLServerDriver
●
tibcosoftwareinc.jdbc.db2.DB2Driver
●
tibcosoftwareinc.jdbc.oracle.OracleDriver
Using Custom Drivers
Installing custom drivers comprises of three parts:
1. Enabling the JDBC palette to use custom drivers.
2. Configuring the JDBC Connection Shared Resource to use a custom driver.
3. Setting up drivers for run time.
Enabling Custom Drivers
In TIBCO Business Studio™ , you can enable the JDBC palette to use custom drivers. Before you do this,
ensure that you place the drivers at the <BW_Home>/config/design/thirdparty location.
1. Click Click Here to Set Preferences. Optionally, go to Windows > Preferences > BusinessWorks >
Palettes > JDBC.
2. Select the Allow use of custom driver check-box and click Apply.
3. Click OK and restart TIBCO Business Studio™ for this configuration to take effect.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
317
Configuring Use for a Custom Driver
Follow these steps to configure the JDBC Shared Resource to use a custom driver:
1. Open the JDBC Connection Shared Resource from the Project Explorer.
2. Click in the Database Driver field, and select the custom.jdbc.driver option from the drop-down
menu.
3. Edit the following fields that display under the Login Timeout (sec) field:
●
Database Driver: Type the name of the driver class to use.
●
Database Name: Type the name of the database to connect to. If the database name is the name
of a schema, type the schema to connect to.
●
Jar File: Type the name of the Jar archive file stored at BW_HOME/config/design/thirdparty.
This file to create the driver. If you are adding multiple Jar files, separate the file names with
commas.
To ensure that TIBCO Business Studio™ creates a driver bundle for the application at
run time, confirm that the Jar archive file is stored under the third party folder at
<BW_Home>/config/design/thirdparty.
4. Click Test Connection. If you have entered the correct database connection details, and have
already created a plugin project to support the custom driver, TIBCO Business Studio™ confirms
that you have successfully connected to the database.
If you are unable to connect to the database you specified, check the configurations you
made to the JDBC Connection Shared Resource. The database connection field can also
fail if you have not created a plug-in project to support the custom driver at run time. In
this case, TIBCO Business Studio™ displays a warning message indicating that it does not
recognize the custom driver you selected. Click OK and complete step 5.
5. Optional. Follow these steps:
a.
In the Create New Plug-in Project wizard that displays, enter a name in the Project name field,
accept the default selections, and click Next.
b.
In the Content pane, accept the default values, and click Next.
c.
In the Custom Driver Properties pane, edit the following fields:
Refer to your JDBC driver documentation for additional details.
●
Datasource Class: Type the name of the class that ActiveMatrix BusinessWorks™ will use to
establish a connection data source between the JDBC Connection Shared Resource and the
database.
●
Pooled Datasource Class: Type the name of the class that ActiveMatrix BusinessWorks will
use to create a pooled connection data source data source between the JDBC Connection
Shared Resource and the database.
d.
Click Finish, and the newly created plug-in project displays on the Project Explorer pane. Click
the custom plug-in project to expand it.
e.
Click the src folder to display the java file, and double-click the java file to edit it. Locate the
following instructions in the Java file, and follow them to import packages that contain the
datasource and pooldatacourse classes:
/****************************** TODO************************************
* Import the packages from jar that contain the data source and drivers *
* by hovering over the data source class name with your mouse and
*
* select the import option
*
*************************************************************************/
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
318
f.
Edit the methods and properties provided in the template file, or add your own.
Methods with the @Override annotation can be modified. Whether you edit @Override
methods, do not remove them from the template file.
Setting up Custom Drivers for Run Time
Follow these steps to set up custom drivers for run time:
1. Export the custom driver JAR file by right-clicking on the Plugin-Project from the Project Pane and
clicking Export > Plug-in Development > Deployable plug-ins and fragments.
2. In the Export wizard, complete the following steps:
a.
Select a plug-in project.
b.
On the Destination tab, and specify <BW_HOME>/system/shared as the target directory to
export the runtime bundle.
3. Click Finish to export the plug-in project as a JAR file. The JAR file is exported to the plugins folder
at <BW_HOME>/system/shared/plugins.
The plugins folder is automatically generated after you export the JAR file, but you can
delete this folder after moving the JAR file to the shared folder at <BW_HOME>/system/
shared.
Uninstalling Drivers for Run Time
To uninstall the drivers at run time for Oracle, MySQL, DB2, and MariaDB, run the bwuninstall
command from <BW_Home>/6.x/bin. Ensure that you run bwuninstall with no arguments to access
the help and instructions to uninstall the driver at run time.
JMS Connection
JMS Connection resource describes a JMS connection. This resource is used to specify activities on the
JMS palette.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource
Description
A short description of the shared resource
Basic Configuration
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
319
Field
Description
Connection
Factory Type
A connection factory is the object used by a client to create a connection to a
provider. Select from one of the following available options:
Messaging Style
●
JNDI: select to look up the connection factory object. Selecting this option
displays the Queue Connection Factory and Topic Connection Factory
fields, when the Messaging Style selected is Queue/Topic.
●
Direct: select if you want to connect to the JMS server using a URL.
Selecting this option displays the Provider URL field and the Supports XA
Transactions check box. Ensure to select the Queue/Topic in the Message
Style.
The available messaging style options are:
●
Generic:
●
Queue/Topic:
You can combine these styles in a single application or the application can use
any one of these messaging styles.
Queue Connection
Factory
This field is available when you select JNDI in the Connection Factory Type
field and Queue/Topic in the Message Style field.
The QueueConnectionFactory object stored in JNDI is used to create a queue
connection with a JMS application.
See the JNDI provider documentation for more information about creating
and storing QueueConnectionFactory objects.
Topic Connection
Factory
This field is available only when you select JNDI in the Connection Factory
Type field and Queue/Topic in the Message Style field.
The TopicConnectionFactory object stored in JNDI. This object is used to
create a topic connection with a JMS application.
See the JNDI provider documentation for more information about creating
and storing TopicConnectionFactory objects.
Connection
Factory JNDI
Name
This field is available only when you select the JNDI in the Connection
Factory Type field and Generic in the Message Style field.
JNDI
Configuration
A JNDI Configuration shared configuration object that specifies the JNDI
connection information. For details refer to, JNDI Configuration.
The GenericConnectionFactory object stored in JNDI is to create connection
with JMS server.
The New button is used to create a New JNDI Configuration Shared
Resource using the preferences set by the user.
Provider URL
This field is available only when you select Direct in the Connection Factory
Type field.
The URL to the JNDI service provider, for example,tcp://<host>:<port>.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
320
Field
Description
Use UFO
Use this checkbox when using EMS Unshared State Failover factories. Refer to
the TIBCO Enterprise Message Service User's Guide for details on Unshared State
Failover.
This field appears only when the option Direct is selected in the Connection
Factory field.
When using Unshared failover setup, if a connection loss is detected to server
(A), TIBCO ActiveMatrix BusinessWorks will try to connect to server (B) as
defined in the connection factory configuration.
After enabling this checkbox you can pass the provider URL in the form of
UFO. For example: tcp://serverA:7222+tcp://serverB:7222, where
serverA and serverB are two EMS servers configured for the Unshared State
Failover.
Unsupported Features and Activities
●
●
JMS Palette
—
JMS Queue Requestor
—
JMS Topic Requestor
—
Any other Requestor activity
SOAP Palette
—
●
Service Palette
—
●
All Activities
All activities
AE Adaptor
—
All activities
Looking up factories using JNDI is not supported
●
UFO factories cannot be retrieved through JNDI directly.
Test Connection
Click the Test Connection button to test the connection specified in the configuration of this resource.
Using Third Party JMS Drivers
ActiveMatrix BusinessWorks™ currently packages EMS drivers. In addition, the JMS palette also
supports the IBM Websphere MQ and JBoss JMS drivers.
Adding Drivers for Runtime
If you want to use other JMS servers, other than the JMS servers mentioned in the section, Using Third
Party JMS Drivers you must add them separately, for run time. This is a one time process for every
installation of ActiveMatrix BusinessWorks™. To add the JMS drivers at run time for IBM Websphere
MQ, or JBoss run the bwinstall command from <BW_Home>/6.x/bin. Ensure that you run bwinstall
with no arguments to access the help and instructions to add the driver to the run time.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
321
The script creates driver bundles and adds it to the specific ActiveMatrix BusinessWorks™
environment. Any AppNodes that are created and started in that ActiveMatrix BusinessWorks™
environment includes the drivers automatically. Since the drivers are a part of the system and not part
of each application, all the applications on a particular AppNode use the same drivers.
However, this is not true of App Spaces. The drivers belong to an AppNode and not an AppSpace.
To use another location for the drivers, a preference is provided in TIBCO Business Studio™ which can
be updated for the JMS palette to use drivers at design time.
To change the Directory Preference in TIBCO Business Studio™, navigate to Windows > Preferences >
BusinessWorks > Palettes > JMS
If you have changed the preferences and want to use other databases with the JMS palette at design
time, place the drivers at <BW_Home>/6.x/config/design/thirdparty location.
Field
Description
One click JNDI Resource
name
The name of JNDI Connection shared resource which is auto created
when you click the New button. This is used only if the shared resource
uses JNDI and not Direct.
Default JNDI Naming
URL
The default URL to be added in the JNDI Connection shared resource
when a new resource is created.
Generic Connection
Factory Name
The value to be added in the Generic Connection Factory field when a
new JMS Connection Shared Resource is created.
Queue Connection
Factory Name
The value to be added in the Queue Connection Factory field when a
new JMS Connection shared resource is created.
Topic Connection
Factory Name
The value to be added in the Topic Connection Factory field when a
new JMS Connection shared resource is created.
Directory Preferences
Click the Browse button and navigate to the location where the driver
libraries are stored.
While testing the JMS connection for JMS drivers other than EMS, ensure that only the jars related to
the selected third party JMS driver are present in the location specified in the directory preference.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
322
Uninstalling Drivers for Run Time
To uninstall the drivers at run time for IBM MQ or JBOSS, run the bwuninstall command from
<BW_Home>/6.x/bin. Ensure that you run bwuninstall with no arguments to access the help and
instructions to uninstall the driver at run time.
Security
Security section has the following field.
Field
Description
Login Credentials
The login credentials to log on to the JMS server. Click the Username
+Password radio button, if you want to use this option for a secure login. This
displays the Username and Password fields.
Advance Configuration
This section has the following fields.
Field
Description
Auto-generate
Client-ID
Select this check box if you want to automatically generate the client ID if no
client ID is specified or if the specified ID is already in use.
When this check box is selected, a value cannot be specified for the clientID.
When an automatically generated client ID is required, the following format is
used for the client ID:
BW-<projectName>-<topic or queue>-<engineName>-<timestamp>
Do not select this check box if you do not want to use the value specified in the
Client ID field. If no value is specified in the Client ID field, no client ID is set.
If the value specified in the Client ID field is already in use, it throws an
exception.
Selecting the Auto-generate Client-ID check box generates a new
Client ID every time a connection is made to the JMS Server. If you
are using Durable Subscribers, manually set the client ID for the
JMS Connection.
Client ID
The client ID for the connection. The JMS providers have a provider-specific
format for client IDs.
See the JMS provider’s documentation for more information about client IDs.
Each connection must use a unique client ID. If you do not specify a value in
this field, ActiveMatrix BusinessWorks™ ensures the uniqueness of the client
ID for each connection.
SSL
Select the Confidentiality check box to configure the SSL connection parameters.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
323
Field
Description
SSL Client
Specify an SSL Client Shared Resource. Refer to SSL Client for more details on
how to configure the Shared Resource .
Connection
Factory SSL
Password
This field is only available if you select the Confidentiality check box.
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.
JNDI Configuration
JNDI Configuration shared resource provides a way to configure the JNDI configuration that can be
shared with other activities. This resource can be specified in any resource that permits JNDI
connections. For example, JDBC Connection and JMS Connection can use JNDI connections.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the shared resource
Description
A short description of the shared resource
JNDI Connection
This section has the following fields.
Field
Literal Value/
Module
Property?
Description
JNDI Provider
No
The name of the JNDI connection.
Initial Context
Factory
Yes
The initial context factory class for accessing JNDI.
(com.tibco.tibjms.naming.TibjmsInitialContextFa
ctory).
Naming Providing
URL
Yes
The name of the JNDI provider URL. For example,
tibjmsnaming://localhost:7222.
Security
This section has the following field.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
324
Field
Description
Login Credentials
The login details to access the JNDI connection. Select any one of the
following options.
●
None: Selecting this radio button will not display the Username
+Password option.
●
Username+Password: Valid username and password to access the JNDI
connection.
Java Global Instance
You can use Java Global Instance shared configuration resource to specify a Java object to be shared
across all process instances in a Java Virtual Machine (JVM).
When the 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. The object is released
before the engine shuts down. Any Java Invoke activity can be configured to access the shared Java
global instance when the process engine runs. Any Java Invoke 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 want 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.
General
The General field has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource
Description
A short description of the resource
Java Global Instance
The section has the following fields.
Field
Description
Class
Use the Browse a Class button to locate the class you want to use.
Method
Select a constructor from the drop-down list of constructors available for this
class. This is used to construct the class when the engine is started.
This field displays only the default 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 nonprimitive type for a parameter.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
325
Field
Description
Parameter Input
The input parameters for the constructor selected in the Method field. Each
input parameter has the following three fields:
●
Parameter: the name of the parameter
●
Type: the datatype of the parameter
●
Value: specify a value for the parameter in this field
When string is the datatype for the parameter, do not use quotes
around the string when specifying the value.
Advanced Configuration
This section has the following fields.
Field
Description
Invoke Cleanup
Method
Selecting this check box signifies that you want to invoke a method on the
object before the object is released from memory when the engine
terminates. You can perform cleanup activities, such as closing connections,
releasing resources, and so on.
Selecting this check box enables the Cleanup Method field.
Cleanup Method
This field is only available when you select the Invoke Cleanup Method
check box.
You can 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.
Keystore Provider
Keystore Provider shared resource provides an access to a keystore.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the keystore provider resource.
Description
A short description of the resource.
Keystore
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
326
Field
Literal Value/
Module
Property?
Provider
None
Description
The name of the keystore provider. Select from the following
available options:
●
SUN
●
IBMJCE
Default: Empty. The first matching provider supporting the
format is selected.
URL
Yes
The location of the external keystore.
Password
Yes
The password for the keystore.
Type
None
The type of the keystore: JCEKS, JKS, PKCS#12.
Default: JKS
Refresh Interval
Yes
Refresh interval, greater than 0. If the keystore provider is
accessed after the refresh interval has expired:
●
The refresh timer is reset to zero.
●
The operations on the keystore provider are performed on
the refreshed copy.
The default value is 3600000.
LDAP Authentication
An LDAP Authentication shared resource represents configuring the connection to an LDAP server.
This connection is used by component implementations to look up names in an LDAP directory server.
LDAP authentication is primarily used for HTTP basic authentication in ActiveMatrix BusinessWorks™
6.x and the fields largely used are:
●
Server URL: LDAP Server Location, such as, ldap://10.107.170.145:389
●
User Search Expression: search expression for the user, such as (&(cn={0])(objectclass=user))
●
User DN Template: user distinguished name template, such as
cn={0},cn=users,dc=na,DC=tibco,DC=com
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the shared resource package.
Name
The name of the LDAP authentication resource.
Description
A short description of the shared resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
327
LDAP Authentication
The LDAP authentication comprises Connection, Users and Groups, Search, Advanced, and Test
Configuration.
Connection
The Connection tab has the following fields.
Field
Literal Value/
Module
Property
Server URL
Yes
Description
The URL with the host and port number on which the LDAP
server is listening for connections.
The default is ldap://localhost:389
User Search
Expression
Yes
The length of time to search for connection on the LDAP
directory server.
The default is 0.
Admin User
Credential
None
The username and password in LDAP format such as
cn={0},CN=Users,DC=ce,DC=na,DC=tibco,DC=com.
Create a
limited or restricted user that can only search your tree.
Selecting this check box displays the Credentials Provider
option.
Credential
Provider
None
The name of the credential provider. In the UserIdResource
Resource Template wizard, create a resource to connect to the
SSL client.
User Search
Base DN
Yes
The LDAP user search expression to be used for performing the
user search. Leave this field blank to start search from the top
level element in the directory.
The search expression used is (&(cn={0})
(objectclass=user)).
User Search
Scope
None
This specifies the number of levels in the directory server that is
searched for a matching user profile. Select any from the
following available options:
●
Subtree: indicates all the sub-entries (all lower levels)
●
One level: indicates all entries immediately (one level)
The default is Subtree.
SSL
Configuration
None
Select this check box to configure an SSL Client.
SSL Client
None
The name of the resource. In the SslClientResource Resource
Template wizard, create a resource to connect to the LDAP
server over SSL using SSL client shared resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
328
Users and Groups
The Users and Groups tab has the following fields.
Field
Literal
Value/
Module
Property
Description
User's name
Yes
The name of the user in the LDAP directory.
Additional user
attributes to
retrieve
Yes
The field specifies the LDAP attribute used to search and retrieve the
user profile. For example, using a different attribute in your directory
server such as the given name.
Group
Indication
None
Specifies the following groups:
●
No Group Info
●
User Attributes Indicates Group: used for grouping the user that
matches the specified attribute. When selected, displays the User
Attribute Group Name field.
●
User DN Indicates Group: group of user DN. When selected,
displays the User Attribute Group Name field.
●
Search Groups:
Selecting the Search Groups option displays the following groups:
●
Group Root DN
●
Group Search Expression
●
Group Attribute User Names
●
Group Attribute Group Name
●
Group Attribute Subgroup Name
Search
The Search tab has the following fields.
Field
User Search
Scope
Literal
Value/
Module
Property
None
Description
This specifies the number of levels in the directory server that is
searched for a matching user profile. Select any from the following
available options:
●
Subtree: indicates all the sub-entries (all lower levels)
●
One level: indicates all entries immediately (one level)
The default is Subtree.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
329
Literal
Value/
Module
Property
Description
Group Root
DN
Yes
The root distinguished name (DN) group name.
Group Search
Scope
None
Provides the search scope option, true or false.
Field
Group Search
Expression
Yes
●
Select true, if you want to scan the entire LDAP tree beneath the
DN (subtree scope).
●
Select false, if you want to scan only direct children of that DN
(one-level scope).
The group search expression property
Advanced
The Advanced tab has the following fields.
Field
Literal
Value/
Module
Property
Description
Follow
Referrals
None
When you select this check box, the LDAP server does not return
results. Instead it returns a reference (a referral) to another LDAP
server which may contain additional information such as the names
and locations of other objects.
Connection
Pool
Yes
Specify the number of the connections in this field. The default is 10.
Search
Timeout
(milliseconds)
Yes
All activities that are part of the same transaction, 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.
Specifies the timeout for LDAP search. The default is -1.
Click the Test button to start testing the LDAP search operation.
Test Configuration
The Test Configuration tab has the following fields.
Field
Description
Search Results
Shows the search results returned by the LDAP search operation.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
330
Proxy Configuration
Proxy Configuration shared resource is used to specify a proxy HTTP server when HTTP requests are
sent outside of a firewall.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the shared resource.
Proxy Connection Configuration
This section has the following fields.
Field
Literal Value/
Module
Property?
Description
Host
Yes
The host name or IP address of the proxy server.
Port
Yes
The port number of the proxy host.
Security
This section has the following fields.
Field
Description
Authentication
Select the check box to specify the authentication to be used.
Identity Provider
Create a UserId resource in the UserIdResource Resource Template wizard.
This provides access to the username and password credentials to access the
proxy connection.
Rendezvous Transport
®
Rendezvous Transport shared resource describes a Rendezvous transport. This resource is used to
specify activities from the Rendezvous palette.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the shared resource.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
331
Rendezvous Transport Configuration
This section has the following fields.
Field
Literal
Value/
Module
Property?
Daemon
Yes
Description
If Rendezvous is running on a different machine, the Daemon
field is specified as the remote host name followed by the
socket number.
For example: ssl:acct:5785
®
If Rendezvous daemon is running on the same machine
where ActiveMatrix BusinessWorks™ engine is also running,
do not specify this field.
Network
Yes
This field contains the host name, IP address, network name,
or interface name. For example, ;224.34.103.4.
Service
Yes
TIBCO Rendezvous service name in one of the following
formats: <service name>
or <port
number>
Security
This section has the following fields.
Field
Description
Confidentiality
Select the Confidentiality check box to display the SSL Client field.
SSL Client
The name of the resource. In the SslClientResource Resource Template
wizard, create a resource to connect to the SSL client.
Authentication
Select the Authentication check box to display the Identity Provider field.
Identity Provider
Create a UserId resource in the UserIdResource Resource Template wizard.
This provides access to the username and password credentials to access the
proxy connection.
Advanced Configuration
Here you can specify the RV type.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
332
Field
Description
RV Type
The type of Rendezvous connection to use.
®
●
Reliable: standard RV transport
●
Certified: RVCM
●
Distributed Queue: RVCMQ
SMTP Resource
An SMTP shared resource template represents a connection to an SMTP server. Using the SMTP
Resource, you can transfer e-mail messages between servers. The SMTP communications are
transported by TCP to ensure end-to-end transport.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the activity.
SMTP
This section has the following fields.
Field
Literal
Value/
Module
Property?
Machine Name
Yes
The name of the host that accepts the incoming requests. The
default value is localhost.
Port
Yes
The port number on which you can listen for SMTP requests.
The default value is 25.
Timeout (ms)
Yes
The waiting time for a response from the server. The timeout
must be greater than 0. A timeout of zero is interpreted as an
infinite timeout.
Username
Yes
The valid username used to authenticate connections to the
server.
Password
Yes
The valid password used to authenticate connections to the
server.
Enable
STARTTLS
Module
Property
Select the Enable STARTTLS check box to use SMTP over SSL.
Description
This checkbox is selected by default.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
333
Security
Select the Confidentiality check box to display the SSL Client field.
Field
Description
SSL Client
The name of the resource. In the SslClientResource Resource Template
wizard, create a resource to connect to the SSL client.
SSL Server Configuration
You can specify SSL parameters for the HTTP connection here.
The following are the fields in the SSL Server Configuration for the HTTP connector.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the SSL server configuration
shared resource.
Description
A short description of the SSL server configuration shared resource.
Basic SSL Server Configuration
This contains the following fields.
Module
Property
Description
Identity Store
Provider
No
Used to provide identity store.
Key Alias Name
Yes
The name of the alias used to access the identity.
Key Alias Password
Yes
The password for the alias.
Enable Mutual
Authentication
No
Indicates whether the client in the SSL connection
authenticates to the server. Selecting this check box displays
the identity fields.
Client Auth Type
No
Select the type of client authentication from the drop-down
list. The available types are:
Field
Keystore Provider
as Trustore
No
●
optional
●
required
The name of a keystore provider resource instance that
maintains a keystore that confirms an identity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
334
Advanced SSL Server Configuration
Use the following fields for advanced SSL server configuration.
Module
Property
Description
SSL Security
Provider
Yes
Optional. The SSL security provider.
SSL Protocol
No
Field
This is the name for the JSSE's cryptographic
provider implmenting SSLContext. If you are
using non-default providers, such as PDCS#11
ones, you might want to override it.
The SSL protocol to use in the SSL connection. Select from
the following options:
●
TLSv1
●
TLSv1.1
●
TLSv1.2
●
SSLv3 – Use of this protocol is discouraged.
The default is TLSv1.
Selecting a protocol implies the support of higher versions
as well.
SSL Cipher Class
No
The number of bits in the key used to encrypt data:
●
No Exportable Ciphers
●
All Ciphers
●
At Least 128 Bit
●
More Than 128 Bit
●
At Least 256 Bit
●
FIPS Ciphers
●
Explicit Ciphers
Explicit Cipher List
Yes
A list of ciphers. Enabled when SSL Cipher Class is set to
Explicit Ciphers. Use the JSSE format for ciphers names.
Verify Remote Host
Name
No
Indicates whether the name on the server's certificate must
be verified against the server's host name.
If the server's host name is different than the name on the
certificate, the SSL connection fails. You can verify the name
on the certificate against another name by specifying
Expected Remote Hostname.
Selecting this check box displays the Expected Remote
Hostname field.
Default: This check box is clear.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
335
Field
Expected Remote
Hostname
Module
Property
Description
Yes
Optional. The expected name of the remote host.
The default is None.
SSL Client Configuration
You can specify SSL parameters for the HTTP client shared resource here.
SSL Client Configuration
The General section in the SSL Client Configuration has the following fields.
Field
Description
Name
The name to be displayed as the label of the SSL Client resource.
Description
A short description of the SSL client resource.
Basic SSL Client Configuration
This section has the following fields.
Field
Module Property
Description
Keystore
Provider As
Trust Store
No
The name of a keystore provider resource
instance that maintains a keystore that
confirms an identity.
Enable
Mutual
Authenticat
ion
No
Indicates whether the client in the SSL
connection authenticates to the server. Select
this check box to enable the identity fields.
Identity
Store
Provider
No
The name of keystore provider resource that
maintains a keystore used to assert an identity.
Key Alias
Name
Yes
The name of the alias used to access the
identity.
Key Alias
Password
Yes
The password for the alias.
Advanced Client SSL Configuration
This section contains the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
336
Field
Module Property
Description
SSL
Security
Provider
Yes
Optional. The SSL security provider.
SSL
Protocol
No
This is the name for the JSSE's
cryptographic provider
implmenting SSLContext. If you are
using non-default providers, such
as PDCS#11, you might want to
override it.
The SSL protocol to use in the SSL connection:
●
TLSv1
●
TLSv1.1
●
TLSv1.2
●
SSLv3 - Use of this protocol is discouraged.
The default is TLSv1.
Selecting a protocol implies the support of
higher versions as well.
SSL Cipher
Class
No
The number of bits in the key used to encrypt
data:
●
No Exportable Ciphers
●
All Ciphers
●
At Least 128 Bit
●
More Than 128 Bit
●
At Least 256 Bit
●
FIPS Ciphers
●
Explicit Ciphers
The greater the number of bits in the key
(cipher strength), the more possible key
combinations and the longer it takes to break
the encryption.
The default is At
Explicit
Cipher List
Yes
Least 128 Bit.
A list of ciphers. Enabled when SSL Cipher
Class is set to Explicit Ciphers. Use the JSSE
format for ciphers names.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
337
Field
Module Property
Description
Verify
Remote
Host name
No
Indicates whether the name on the server's
certificate must be verified against the server's
host name. If the server's host name is
different than the name on the certificate, the
SSL connection fails. The name on the
certificate can be verified against another
name by specifying Expected Remote
Hostname.
Selecting this check box displays the Expected
Remote Hostname field.
Default: This check box is clear.
Expected
Remote
Hostname
Yes
Optional. The expected name of the remote
host.
The default is None.
Subject Provider
The Subject Provider resource provides support for authenticating user credentials through a Keystore
or Trust Store.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
Subject Provider
The Subject Provider section has the following fields.
Field
Literal
Value/
Module
Property?
Description
Credential
Provider for
Identity Store
None
Refers to a Keystore Provider resource. The Keystore Provider
maintains the keystore used to assert an identity.
Key Alias
Name
Yes
The name of the alias used to access the identity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
338
Literal
Value/
Module
Property?
Description
Key Alias
Password
Yes
The password for the alias.
Credential
Provider for
Trust Store
None
Optional. Select a Trust Provider resource.
Field
TCP Connection
The TCP Connection shared resource specifies the connection information for the TCP server. This
resource is used when a process acts as a TCP client connecting to a remote server or when a process
acts as a TCP server accepting incoming TCP.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the activity.
TCPConnection
This section has the following fields.
Field
Literal
Value/
Module
Property?
Host
Yes
Description
When a process acts as a client, this field specifies the host name
or host IP address of the TCP server to connect to.
When a process acts as a server, this field specifies the
hostname or IP address of the machine where the process
engine is running. You can specify "localhost" or if the machine
has more than one network interface card, you can specify the
IP address of the card you want to use to accept the TCP/IP
connections.
Port
Yes
This field specifies the port number on which a TCP server is
listening for requests.
Enable
Connection Pool
Yes
Selecting this check box enables the When Exhausted
Connections, Maximum Connections, Maximum Wait Time,
and Idle Timeout fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
339
Field
When Exhausted
Connections
Literal
Value/
Module
Property?
Yes
Description
When the connections are exhausted on the server, select
anyone from the following available options.
●
Block: the pool is blocked when the pool is exhausted (that
is, the maximum number of active objects has been reached)
until a connection is available, or the maximum wait time
has been reached.
●
Fail: when the pool is exhausted (that is, the maximum
number of connections have been consumed), it fails.
●
Grow: when this policy is selected a new connection is
created for every request of the client, therefore there is no
maximum connection limit.
Maximum
Connections
Yes
Specifies the maximum number of simultaneous client sessions
that can connect with the server. This parameter is enabled only
if connection pooling is enabled (the Enable Connection Pool
check box is selected). The default value is 10.
Maximum Wait
Time (msec)
Yes
Specifies the maximum wait time in milliseconds to connect to
the TCP server. This parameter is enabled only if connection
pooling is enabled (the Enable Connection Pool check box is
selected). The default value is 10000.
Idle Timeout
(msec)
Yes
Specify the idle timeout for the connections in milliseconds. The
default is -1.
Trust Provider
The Trust Provider resource maintains the identity of a trusted resource.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
Trust Configuration
The Trust Configuration section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
340
Field
Description
Credential Store
used for Trust
Refers to a Keystore Provider. The keystore is a trust store.
Enable Tust Store
Access
Select this option to enable acess to the specified trust store.
WSS Authentication
A WS-Security ASP resource template enables a connection to Web Services Security authentication
services.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
Basic Configuration
The Basic Configuration section has the following fields.
Field
Description
Security Token
Security Token is an online security credential that adds an extra layer of
identity protection.
X.509 token is the default selection. X.509 is an ITU-T standard for a public
key infrastructure (PKI) and Privilege Management Infrastructure (PMI).
Enable Signature
Verification
Select to indicate whether to verify the signatures. By default, this option is
not selected. If selected, it activates the Trust Provider field.
Enable Decryption
Select to indicate whether to enable decryption. By default, this option is not
selected. If selected, it activates the Subject Provider field.
Select both Enable Signature Verification and Enable Decryption
to activate the Subject Provider (with Trust Credential) field.
User Authentication
The User Authentication section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
341
Field
Description
Select the type of
authentication
Choose to authenticate users through XML File Authentication or LDAP
Authentication.
XML File Resource
The name of the XML Authentication shared resource used to authenticate
user credentials.
LDAP Resource
The name of the LDAP Authentication shared resource used to authenticate
user credentials.
XML Authentication
The XML Authentication resource provides support for XML file-based authentication.
General
The General section has the following fields.
Field
Description
Package
The name to be displayed as the label of the policy resource package.
Name
The name of the policy resource.
Description
A short description of the policy resource.
XML Authentication Configuration
The XML Authentication Configuration section has the following fields.
Field
Literal
Value/
Module
Property?
Description
XML File
Yes
The XML File containing user credentials.
Notify Configuration
The Notify Configuration specifies a schema to use for passing data between executing process
instances. The corresponding Receive Notification, Notify and Wait for Notification activities use the
same Nofity Configuration to define the data for inter-process communication. The schema can be
empty, if you do not want to pass data between processes.
General
The General tab has the following fields.
Field
Description
Package
The name to be displayed as the label of the configuration resource package.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
342
Field
Description
Name
The name of the configuration resource.
Description
A description of the configuration resource.
Notify Configuration Editor
The Notify Configuration Editor is used to define a custom schema. The schema can be empty, if you
do not want to pass data between processes.
You can define your own datatype on this tab, and you can reference XML schema or ActiveEnterpise
classes stored in the project. Once defined, the data specified on the tab appears on the Input or Output
tab of the Receive Notification, Wait for Notification or Notify activity where this shared configuration
resource is used.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
343
TCP Palette
The TCP palette provides activities and resources that can send and receive data using the TCP
protocol. TCP is often the inherent communication layer for high-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. Use this palette when
communicating with TCP, when there is no corresponding ActiveMatrix BusinessWorks™ palette for
the protocol. For example, using the TCP palette to handle the incoming and outgoing data from a
custom application that communicates with other applications by way of TCP.
Using the TCP Palette Activities
You can use the TCP palette activities to create a general sequence of events in a process.
Procedure
1. Create a TCP Connection shared configuration resource that describes the connection information.
2. Depending on whether the process is a TCP client or server, one of the following occurs:
a) A connection opens using the TCP Open Connection activity, when a process works as a TCP
client communicating with a TCP server.
b) The process starts either with a TCP Receiver process starter or has a Wait for TCP Request
activity that waits for an incoming connection request, when a process works as a TCP server
waiting for the incoming TCP requests.
3. Use the Read TCP Data and Write TCP Data activities to read and write data to the in process TCP
connection.
4. After the process is complete, close the TCP connection using the TCP Close Connection activity.
Read TCP Data
Read TCP Data is an asynchronous activity that reads data from an open TCP connection. The
connection must be opened by an activity or a process starter that executed previously in the process.
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.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
Type
None
Type of data to be read. This can be either Text or Binary.
Specifying Text in this field enables the Separator and Encoding
fields. When Binary is specified, the Bytes To Read field is enabled.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
344
Field
Literal
Value/
Module
Property/
Process
Property?
Separator
Yes
Description
The type of separator. This activity reads data from the TCP
connection until the separator or the end of the data stream is
encountered.
Select User-defined binary separator (specify comma-separated
byte values) from the drop-down list to enable the User Defined
Separator field.
User Defined
Separator
Yes
This field specifies the separator character to use.
When Binary is selected in the Type field, a user-defined separator
can be:
●
A string representation of a single byte, or
●
A comma-separated byte values (for example, 0x0a, 0x0b, 0x0c,
and so on).
For valid string representations of byte values, refer to the Java
documentation for the decode(String n) method of Java.lang.Byte.
Encoding
Yes
Specifying Text in the Type field, determines the character
encoding of the text data in this field.
Bytes To Read
Yes
Specify the number of bytes to be read by this activity.
This field is enabled when you select Binary in the Type field.
Leaving this field blank makes the activity read until the end of the
data stream is encountered.
Timeout
(msec)
Yes
The time to wait (in milliseconds) for this activity to complete.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
When Text is specified in the Type field, the Input tab displays connection, encoding, separator, and
timeout elements. Specifying Binary in the Type field displays connection, bytesToRead, and timeout
elements.
Input Item
Datatype
Description
connection
binary
The handle to the connection to read the data from.
This connection is obtained from a previously executed activity in
the process that opened the connection.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
345
Input Item
Datatype
Description
encoding
string
Specifies the character encoding of the text when reading the text
data.
This value overrides the value specified in the Encoding field in the
General tab.
separator
string
An optional element. Specifies the boundary between the body
elements after writing the body element to the TCP connection,
while reading the text data.
This element is available only when the User
option is selected on the General tab.
Defined Separator
This value overrides the value specified in the General tab.
bytesToRead
number
An optional element. Specifies the number of bytes to be read when
reading the binary data.
This value overrides the value specified in the Bytes To Read field
in the General tab.
timeout
number
An optional element. The time to wait (in milliseconds) for this
activity to complete.
Output
The following is the output of the activity.
Output Item
Datatype
Description
data?
string
When the data is specified as text, this output element contains
the text read from the TCP connection. The separator character
if specified, is not included in the output.
When the data is specified as binary, 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 is
reached.
This is useful when the activity is in an iteration loop and the
activity is configured to read a number of bytes with each
iteration. Use this element in the condition of the loop, to
determine when the last set of bytes was read.
TCP Close Connection
TCP Close Connection is a synchronous activity that closes a TCP connection opened by a previously
executed activity or a process starter.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
346
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
connection
binary
The handle to the connection that you want to close.
This value is obtained from a previously executed activity in the
process that opened the connection.
Output
The activity has no output.
TCP Open Connection
TCP Open Connection is a synchronous activity that opens a connection to a TCP server. After
establishing the connection, the activity places a handle to the open connection in the connection output
element. The subsequent activities in the process use this connection key for the TCP Connection to
read data from, write data to, or close the connection.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
TCP
Connection
Yes
The TCP Connection is a shared configuration resource that specifies
the connection information for the TCP server. Specify the required
value in the TCP connection property.
Local Host
None
Specifies the IP address on the local machine to be used as the TCP
client.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
347
Input Item
Datatype
Description
connection
complex
An optional element. This element contains the information about the
TCP server you want to connect to. It comprises host, port, and
localhost elements.
host
string
An optional element. The name or IP address of the TCP server you
want to connect to.
This value overrides the value specified by the TCP connection
property in the General tab.
port
number
An optional element. The port number on which the TCP server is
listening for requests.
This value overrides the value specified by the TCP connection
property in the General tab.
localhost
string
An optional element. The name or the IP address of the TCP client.
Output
The following is the output of the activity.
Output
Item
Datatype
Description
connection
binary
The handle to the open connection.
The subsequent activities in the process use this connection key to read
data from, write data to, or close the connection.
TCP Receiver
TCP Receiver is a process starter activity that starts the process when a client requests a TCP
connection. The connection element in the activity output contains the handle to the TCP connection.
The subsequent activities in the process can use this handle for the TCP connection to read data from,
write data to, or close the connection.
General
The General has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
Host
Yes
The hostname or the host IP address of the TCP server to connect
to.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
348
Field
Literal
Value/
Module
Property/
Process
Property?
Port
Yes
Specify the port number on which this TCP server is listening for
requests.
Enable DNS
Lookup
None
Select this check box to enable a domain name system (DNS)
lookup for resolving the IP address to a DNS name.
Description
Select this element only when required, as this may
adversely affect throughput.
Keep Alive
None
Select this check box to specify for the TCP connections to use the
keep alive feature of sockets.
Description
Provide a short description for the activity.
Advanced
The Advanced tab contains the following fields.
Field
Description
Sequencing Key
This field can contain an XPath expression that specifies which processes
should run in a specified order.
Process instances with sequencing keys evaluating to the same value are
executed sequentially in the order of the process instance creation.
Custom Job Id
This field can contain an XPath expression that specifies a custom ID for the
process instance.
Conversations
You can initiate the conversation here. Click the Add New Conversation
conversations.
button to initiate multiple
For details about conversations, refer to Application Development.
Output
The following is the output of the activity.
Output
Item
Datatype
Description
connection
binary
The handle to the open connection. This connection can be used by
subsequent activities in the process definition to specify the TCP
connection to write data to, read data from or close.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
349
Output
Item
Datatype
Description
IP
string
The IP address of the client sending the TCP request.
Host
string
The host name of the client sending the TCP request. This field is
available only when you select the Enable DNS Lookup field in the
General tab.
Port
integer
The port number of the client sending the TCP request.
Wait for TCP Request
Wait for TCP Request is a signal-in activity that waits for a TCP client connection request. When a
connection request occurs, the activity places a handle to the open connection in the connection output
element. The subsequent activities in the process use this connection key to read data from, write data
to, or close the connection.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
Host
Yes
The hostname or the host IP address of the TCP server to connect
to.
Port
Yes
Specify the port number on which this TCP server is listening for
requests.
Enable DNS
Lookup
None
Select this check box to enable a domain name system(DNS)
lookup for resolving the IP address to a DNS name.
Description
Select this element only when required, as this may
adversely affect throughput.
Keep Alive
None
Select this check box for the TCP connection to use the keep alive
feature of sockets.
TCP keep alive is different from HTTP keep alive.
Description
Provide a short description of the activity.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
350
Event
The Event tab has the following fields.
Field
Description
Event Timeout
(seconds)
A message may arrive before this activity is executed. Specify the amount of
time (in seconds) for a message to wait, if the message is received before
this activity is executed.
Activity Timeout
(msec)
Specify the amount of time (in milliseconds) for an activity to wait before it
is executed.
Conversations
You can initiate or join the conversation here. Click the Joining Existing Conversation
join multiple conversations. Click the Add New Conversation
button to
button to initiate conversations.
For details about conversations, refer to Application Development.
Output
The following is the output of the activity.
Output
Item
Datatype
Description
connection
binary
The handle to the open connection. This connection key can be used by
subsequent activities in the process definition to specify the TCP
connection to write data to, read data from, or close.
IP
string
The IP address of the client sending the TCP request.
Host
string
The host name of the client sending the TCP request. Select the Enable
DNS Lookup field in the General tab to enable this field.
Port
integer
The port number of the client sending the TCP request.
Write TCP Data
Write TCP Data is an asynchronous activity that sends data on the specified TCP connection. The
connection must be opened by an activity or process starter that executed previously in the process.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
351
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
Type
None
The type of the data to write. This can be either Text or Binary.
Specifying Text in this field displays the Separator and Encoding
fields.
Specifying Binary in this field displays the User Defined Separator
field.
Separator
Yes
The type of separator to use. The separator is written to the TCP
connection after the specified data is written.
Select User-defined separator from the drop-down list to enable the
User Defined Separator field.
User Defined
Separator
Yes
Encoding
Yes
This field specifies the separator character to use.
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 value, refer to the Java
documentation for the decode(String n) method of java.lang.Byte.
When text data is specified, this field determines the character
encoding to use for the text data.
Description
Provide a short description of the activity.
Input
The following is the input for activity.
Input Item
Datatype
Description
connection
binary
The handle to the connection that you want to write data to. This
connection is obtained from a previously executed activity in the
process that opened the connection.
data
string or
binary
The data to write to the TCP connection. The data type of this field is
either String or Binary, depending upon the data selected in the Type
field in the General tab.
encoding
string
An optional element. When writing text data, this specifies the
character encoding of the text. This value overrides the value specified
in the Encoding field in the General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
352
Input Item
Datatype
Description
separator
binary
An optional element. This is available only when you select the s
option on the General tab.
Output
This activity has no output.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
353
Thread Pool
The thread pool is a queue of threads available to run a collection of tasks. Thread pools are used to
improve performance when executing large numbers of asynchronous tasks by reducing per task
invocation overhead. This provides a means of bounding and managing the resources consumed when
executing a collection of tasks.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
A short description of the resource.
Thread Pool
This section has the following fields.
Field
Literal
Value/
Module
Property?
Description
Core Pool Size
Yes
Must be greater than or equal to zero. The default is 5.
Max Pool Size
Yes
The maximum number of threads in the pool. Must be greater
than zero and greater than or equal to core pool size.
The default is 10.
Keep Alive
Time (s)
Yes
The length of time an idle thread remains in the pool before being
reclaimed, if the number of threads in pool is more than core pool
size.
The default is 30 seconds.
Autostart Core
Threads
Yes
Indicates to create and start the core pool size threads when the
thread pool is created. Normally core threads are created and
started only when new tasks arrive.
Thread Pool
Name Prefix
Yes
A string prefixed to the name of each thread.
Daemon
Yes
Select the check box to specify whether the threads can be started
as a daemon or a user. The default is false.
Priority
Yes
The default priority of the threads in the pool. The default is 5.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
354
Field
Literal
Value/
Module
Property?
Description
Rejection Policy
No
The policy applied when no thread is available to run a task:
●
BLOCKING: the task is blocked until a thread from the thread
pool picks up this task.
●
CALLER RUNS: the task is run in the calling thread.
●
ABORT: the task is aborted and an exception is thrown.
The default is BLOCKING.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
355
XML Activities Palette
The XML Activities palette provides activities for parsing XML strings into schemas and rendering
schemas into XML strings.
Parse XML
Parse XML is a synchronous activity that takes a binary XML file or an XML string and converts it into
an XML schema tree based on the XSD specified.
Parsing Date and Datetime Strings
In XML documents parsed by the Parse XML activity, datetime values are read in accordance with the
ISO-8601 standard, as described in the XML Schema specification. For example, the value:
2002-02-10T14:55:31.112-08:00
is 55 minutes, 31 seconds, and 112 milliseconds after 2.00 p.m. on February 10th, 2002 in a time zone
that is 8 hours, 0 minutes behind UTC.
If no time zone field is present, the value is interpreted in the time zone of the machine that is
performing the parsing. This can lead to complications if you are processing XML from a different time
zone, so you are encouraged to always use a time zone.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Input Style
Can be binary, text, or dynamic.
In binary mode, the binary content is read. The encoding used for parsing the
content is either the value specified in the forceEncoding input item, the encoding
specified in the XML header or the xmlBinary input item, or UTF-8 (the default
encoding, if no encoding is specified).
In text mode, (the default and preferred choice) an XML string is passed as an
input item.
In dynamic mode, a choice is offered for input. You can either supply binary or
text input. You can use a choice statement and set substitution in the mapping to
supply the correct type of input at run time.
Validate
Output
When selected, specifies that the output of the activity should be validated against
the schema specified in the Output Editor tab.
Description
Provide a short description for the activity.
Output Editor
Use the Output Editor tab to define a schema for the XML output.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
356
Input
The following is the input for the activity.
Input Item
Datatype
Description
xmlString
string
The XML string to parse.
This input element is available when the Input Style field in the
General tab is set to text.
xmlBinary
complex
Available when you set the Input Style field in the General tab to
binary.
This input item contains a required bytes item for which you specify
the input XML bytes.
This input item also contains an optional forceEncoding item. This
specifies the encoding to use when parsing the XML. If this element is
not specified, the encoding specified in the XML header of the byte
element is used to parse the XML. If the encoding value is not specified
in the XML header, the default encoding (UTF-8) is used.
xmlBinary|
xmlString
choice
Available when the Input Style in the General field is set to dynamic.
You can specify a choice statement and set substitution and supply the
correct input type at run time.
Output
The following is the output of the activity.
Output Item
Datatype
Description
XML Schema
complex
The parsed XML schema is the output of this activity. The contents of
the schema are determined by the schema defined in the Output
Editor tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown when...
XMLParseException
An exception occurred when parsing the data.
UnsupportedEncodingException
An unsupported encoding was specified in the forceEncoding
input item.
MissingByteCountException
An exception occurred while parsing the data with an invalid
or missing byte count.
ValidationException
The file specifies a version of XML that the parser is not
prepared to handle.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
357
Render XML
Render XML is a synchronous activity that takes an instance of an XML schema element and renders it
as a stream of bytes containing XML or an XML string.
The Render XML activity takes an instance of an XML schema element and renders it as a stream of
bytes containing XML or an XML string. The schema is processed based on the XSD file specified.
Rendering Date and Datetime Strings
UTC time is used when datetime strings are generated. For example, the time 55 minutes, 31 seconds,
and 112 milliseconds after 2.00 p.m.on February 10th, 2002 would be represented by the Render XML
activity as 2002-02-10T14:55:31.112Z
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
No
The name to be displayed as the label for the activity in the
process.
Output Style
No
Specifies whether the output should be text or binary data.
Validate Input
No
When selected, specifies that the data input to the activity should
be validated against the schema specified in the Input Editor tab.
Format Using
Default
Namespace
Prefix
No
Prepends the namespace with the default namespace prefix.
Encoding
Yes
This field is available only when the Output Style field is set to
text. This field specifies the encoding value to place into the XML
header of the rendered XML data.
Description
You can specify any valid XML encoding value listed in IANACharsets.
Description
Provide a short description for the activity.
Advanced
Click the Advanced tab and specify which elements in the input schema can contain CDATA sections.
Using CDATA sections you can enclose text within an element that should not be treated as XML.
Click the + button to add elements of the input schema to the list. When you click the + button, a dialog
displays. Using this dialog locate and select the input schema by location in the project or by
namespace. Use the By Location tab if your input schema is located in the project directory. Use the By
Namespace tab if you constructed the input schema on the Input Editor tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
358
Use the X button to remove the elements from the list and the up and down arrows to move elements in
the list.
Input Editor
From the Input Editor tab you can define a schema for the incoming XML data you want to render.
Input
The following is the input for the activity.
Input Item
Type
Description
byteEncoding
string
This is only available when you set the Output Style field in the
General tab to binary.
This specified the encoding value to place into the XML header in the
rendered XML output. This is also the encoding used to encode the
binary data. If this item is not specified, the default encoding of the
java virtual machine used by the process engine is used to encode the
binary data. This value may not be a valid XML encoding.
You can specify any valid XML encoding value listed in IANACharset. See http://www.iana.org/assignments/character-sets for a
complete list. The encoding names are case sensitive.
XML Schema
string
The XML schema to render. The contents of the schema are
determined by the schema specified in the Input Editor tab.
Output
The following is the output of the activity.
Output
Item
Type
Description
xmlString
string
Available when text is selected in the Output Style field in the General
tab. This item contains a stream of bytes representing the rendered
XML.
xmlBytes
bytes
Available when binary is selected in the Output Style field in the
General tab. This item contains a stream of bytes representing the
rendered XML.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
XMLRenderException
An exception occurred when rendering the data.
UnsupportedEncodingException
An unsupported encoding was specified in the byteEncoding
input item.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
359
Fault
Thrown When..
MissingByteCountException
An exception occurred while rendering the data with an
invalid or missing byte count.
Transform XML
Transform XML is a synchronous activity that invokes the built-in XSLT processor to apply an XSLT
stylesheet to an XML source document and produce a result document.
Normally, transformation of data occurs by mapping process variables to an activity's input and
applying XPath expression to perform any transformation. If you have an XSLT file that you are using
for transformation, or if an outside source supplies an XSLT file, this activity helps you to use the XSLT
file instead of manually creating the mappings.
For more information about creating and editing XSLT files, see the XSLT specifications at http://
www.w3.org/TR/xslt.
General
The General tab has the following fields.
Field
Description
Name
The name to be displayed as the label for the activity in the process.
Stylesheet
The XSLT file shared configuration resource to use when transforming the XML.
You can also specify an XSLT stylesheet in the stylesheet input element, if desired.
Stylesheets specified in the activity input override the stylesheet specified in this
field.
Input and
Output Style
Specifies whether the input and output is binary data or text.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
xmlString
binary
The XML to transform. If the input/output style is set to binary,
this element is named xmlBytesIn. If the input/output style is set to
text, this element is named xmlString. If the input/output style is
set to tree, this element is named xmlTree.
styleSheet
string
This optional element contains the XSLT stylesheet to use to
transform the XML input. This stylesheet overrides the stylesheet
specified in the styleSheet field in the General tab.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
360
Input Item
Datatype
Description
parameter
complex
This repeating element contains the input parameters for the
stylesheet.
Each input parameter is specified as name/value pairs. The name is
a string that corresponds to the name of the parameter specified in
the XSLT stylesheet parameter list.
name
string
The name of the stylesheet input parameters.
value
string
The value to supply for the specified stylesheet input parameters.
isXMLDocument
boolean
Specifies whether the parameter is an XML document.
Output
The following is the output for the activity.
Output
Item
xmlString
Datatype
Description
text or
binary or
complex
A binary or text value or an XML tree containing the output schema
specified by the XSLT file.
The element is named xmlString and is of type text when you select
text for the input/output style on the General tab. The element is
named xmlOutput and is of type binary when binary is selected. The
element is named treeOutput and is a complex type when you select
tree.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
XMLTransformException
An exception occurred when transforming the data.
UnsupportedEncodingException
Data was supplied that is encoded in an unsupported
encoding.
MissingByteCountException
An exception occurred while transforming the data with an
invalid or missing byte count.
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
361
Activity Icons Reference
This section gives you a list of the palettes and activities available in TIBCO Business Studio.
Basic Activities Palette
Critical Section
For Each
Iterate
Scope
While
Throw
Repeat
Repeat on Error
Constructor
Compensate
Exit
Receive
Set EPR
Get Context
Reply
Empty
Invoke
Set Context
End
Rethrow
Start
Engine Command
File Palette
Copy File
Create File
File Poller
List Files
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
362
File Palette
Rename File
Read File
Remove File
Wait for File Change
Write File
FTL Palette
FTL Publisher
FTL Reply
FTL Request Reply
FTL Subscriber
FTP Palette
FTP Change Default
Directory
FTP Delete File
FTP Dir
FTP Get
FTP Get Default
Directory
FTP Make Remote
Directory
FTP Put
FTP Quote
FTP Remove Remote
Directory
FTP Rename File
FTP SYS Type
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
363
General Activities Palette
Assign
Call Process
Confirm
Get Shared Variable
Inspector
Log
Notify
.On Notification
Timeout
Receive Notification
Sleep
Timer
External Command
Mapper
Set Shared Variable
Wait For Notification
HTTP Palette
HTTP Receiver
Send HTTP Request
Send HTTP Response
Java Palette
JAVA Invoke
Java Process Starter
Java To XML
XML To Java
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
364
JDBC Palette
JDBC Call Procedure
JDBC Query
JDBC Update
SQL Direct
JMS Palette
Get JMS Queue
Message
JMS Request Reply
JMS Receive Message
JMS Send Message
Reply to JMS Message
Wait for JMS Request
Mail Palette
Receive Mail
Send Mail
Parse Palette
MimeParser
Parse Data
Render Data
Rendezvous Palette
Rendezvous Publisher
Rendezvous Reply To
Request
Rendezvous Request
Reply
Rendezvous
Subscriber
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
365
Rendezvous Palette
Wait for Rendezvous
Message
REST and JSON Palette
Invoke REST API
Parse JSON
Render JSON
TCP Palette
Read TCP Data
TCP Close Connection
Wait for TCP Request
Write TCP Data
TCP Open Connection
TCP Receiver
XML Activities Palette
Parse XML
Render XML
Transform XML
TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference
Download PDF
Similar pages